Repository navigation
Name the two server secrets after what they protect - #4
Merged
Merged
Conversation
CONNECTION_ENCRYPTION_KEY becomes AGORA_CONSOLE_ENCRYPTION_KEY: it only encrypts stored Agora Console tokens. SPACE_CHANNEL_SECRET becomes SPACES_SIGNALING_SECRET: it only derives spaces' Signaling channel names and keys. The old names are still read as fallbacks so existing deployments keep their data and private channels. 🤖 Built with SMT <smt@agora.build>
This file contains hidden or 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
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.
Why
The old names didn't say what each secret is for.
CONNECTION_ENCRYPTION_KEYis used only for Agora Console connections, andSPACE_CHANNEL_SECRETonly for spaces' Agora Signaling channels.What changes
CONNECTION_ENCRYPTION_KEYAGORA_CONSOLE_ENCRYPTION_KEYSPACE_CHANNEL_SECRETSPACES_SIGNALING_SECRET.env.example, the README anddocs/platform.mduse the new names.Verification
npm test: 296 pass, 0 fail, 1 skipped (PostgreSQL). New tests check each new name, the fallback, and that the new name wins.Generated with SMT smt@agora.build