docs(eventual-send,pass-style): Add missing env var explanations #9233
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Deploying agoric-sdk with
|
| Latest commit: |
e757942
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://b7e4ec44.agoric-sdk.pages.dev |
| Branch Preview URL: | https://markm-update-env-md.agoric-sdk.pages.dev |
michaelfig
approved these changes
Apr 15, 2024
erights
added a commit
to endojs/endo
that referenced
this pull request
Jul 12, 2024
Closes: #XXXX Refs: Agoric/agoric-sdk#9233 ## Description Only removes TODO comment that was done in Agoric/agoric-sdk#9233
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
closes: #XXXX
refs: endojs/endo#2002 endojs/endo#1860
Description
Now that agoric-sdk depends on a version of endo that switches on these environment variables, it is time for
env.md, where we gather all such explanations, to explain these additional env vars.Security Considerations
none, since this PR only documents the existing situation.
For the environment variable sensitive behavior itself, I think none as well. We should examine more closely in general whether env var sensitivity in our code opens up any opportunity for attackers. We think not though, because attackers should only ever execute in environments where these are not set to non-defensive settings. And attackers should never be in a position to set these.
Scaling Considerations
none. But the new text does explain the existing scaling consideration around the
ONLY_WELL_FORMED_STRINGS_PASSABLEenvironment variable.Documentation Considerations
the point. Since we gather all these explanations in agoric-sdk's env.md file, there is an inter-repo coordination problem after introducing new env vars into endo.
Testing Considerations
none
Upgrade Considerations
none