Refactor: add support for env variables in data migration #1198
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
github-actions
bot
added
back-end
angela-tran
commented
Jan 12, 2023
| verifier1 = EligibilityVerifier.objects.create( | ||
| name="OAuth claims via Login.gov", | ||
| oauth_claims_verifier = EligibilityVerifier.objects.create( | ||
| name=os.environ.get("OAUTH_VERIFIER_NAME", "OAuth claims via Login.gov"), |
There was a problem hiding this comment.
Not sure if we consider these names sensitive
| short_name="MST (sample)", | ||
| long_name="Monterey-Salinas Transit (sample)", | ||
| short_name=os.environ.get("MST_AGENCY_SHORT_NAME", "MST (sample)"), | ||
| long_name=os.environ.get("MST_AGENCY_LONG_NAME", "Monterey-Salinas Transit (sample)"), |
There was a problem hiding this comment.
These names don't seem sensitive IMO, but they do vary per environment.
| jws_signing_alg="RS256", | ||
| jwe_cek_enc=os.environ.get("COURTESY_CARD_VERIFIER_JWE_CEK_ENC", "A256CBC-HS512"), | ||
| jwe_encryption_alg=os.environ.get("COURTESY_CARD_VERIFIER_JWE_ENCRYPTION_ALG", "RSA-OAEP"), | ||
| jws_signing_alg=os.environ.get("COURTESY_CARD_VERIFIER_JWS_SIGNING_ALG", "RS256"), |
There was a problem hiding this comment.
Do we consider these sensitive? I erred on the side of caution here.
I think Kerckhoff's principle would say they are not sensitive (the security of data should not depend on the encryption method remaining a secret).
thekaveman
approved these changes
Jan 13, 2023
There was a problem hiding this comment.
This looks good, sets us up to be able to progress towards better management of these items.
I tested locally with the sample data file and it all worked as expected:
- Without any values in my
.env, every works like before - I was able to override a value via my
.env
9 tasks
This was referenced Feb 2, 2023
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.
Related to #1163
This PR modifies the sample data migration file to look for environment variables for sensitive values, falling back to defaults if an environment variable is not defined.
This is to help move us towards actually using this file for our deployment process. Note that these changes do not break any of the current set up in Azure (since it's not using the sample data) nor does it break local dev environments (no
.envfile required).To test
As an example, you could fill this out to specify real values and add to a
.envfile:Run
and you should then be able to go through the Login.gov flow without changing any of the data migration file.
You can use
unset(e.g.unset AUTH_PROVIDER_CLIENT_NAME) to delete an environment variable from your shell.For multi-line values in your .env file, you can wrap them in single quotes, e.g.