Add function to suppress parameter output of sensitive information #817
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
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.
What does this PR do?
Fixes #706 - I believe it would be good if secret information contained in the parameters was masked with a string like
******.Obfuscation of sensitive parameters
By applying this pull request, papermill will obfuscate the value stored in the injected-parameters cell and notebook metadata for parameters that contain strings like
tokenandsecret. I have not implemented obfuscation of these parameters in the output cell because it is not simple to do so and I assume it would have a significant impact.For security reasons, I considered that it would be better to enable obfuscation by default. So I added the option
--no-obfuscate-sensitive-parametersto turn it off.In addition, the parameters that should be marked as sensitive are listed in
papermill.utils.SENSITIVE_PARAMETER_PATTERNS. The--sensitive-parameter-patternsoption can be used to customize the list.