Disallow sensitive trait on members #1137
Merged
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
gosar
force-pushed
the
sensitive-idl-2.0
branch
from
529e4c7
to
55b2658
Compare
kstich
requested changes
Mar 21, 2022
smithy-jsonschema/src/test/java/software/amazon/smithy/jsonschema/JsonSchemaConverterTest.java
Outdated
Show resolved
Hide resolved
|
The spec probably needs to be updated to reflect this change. The selector shouldn't allow members for sensitive. Our implementation of Smithy will need to allow it since we support v1 and v2 simultaneously, but the extra validation we're doing will cover us to not actually allow it on members. |
gosar
force-pushed
the
sensitive-idl-2.0
branch
2 times, most recently
from
6c2fd9a
to
b8dd42c
Compare
kstich
reviewed
Mar 21, 2022
docs/source/1.0/spec/core/traits/documentation-traits.rst.template
Outdated
Show resolved
Hide resolved
Allowing @sensitive trait on members can lead to insecure usage patterns, like forgetting to put @sensitive on ALL members that target the same shape, which can lead to sensitive data not getting handled properly, e.g., not getting redacted from logs, etc. Instead marking the target shape as sensitive prevents modeling mistakes by ensuring every reference to data types that are inherently sensitive are always considered sensitive.
gosar
force-pushed
the
sensitive-idl-2.0
branch
from
b8dd42c
to
59df6f8
Compare
kstich
approved these changes
Mar 21, 2022
mtdowling
approved these changes
Mar 22, 2022
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.
Allowing @sensitive trait on members can lead to insecure usage
patterns, like forgetting to put @sensitive on ALL members that target
the same shape, which can lead to sensitive data not getting handled
properly, e.g., not getting redacted from logs, etc.
Instead marking the target shape as sensitive prevents modeling
mistakes by ensuring every reference to data types that are inherently
sensitive are always considered sensitive.
TODO: Doc updates. Currently
idl-2.0branch'sdocsstill references version 1.0 mostly. Will update docs separately later.By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.