-
Notifications
You must be signed in to change notification settings - Fork 218
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add SigV4 and SigV4A migration diff validation #2245
Merged
syall
merged 3 commits into
smithy-lang:main
from
syall:sigv4-backward-compatibility-diff-evaluator
Apr 23, 2024
Merged
Add SigV4 and SigV4A migration diff validation #2245
syall
merged 3 commits into
smithy-lang:main
from
syall:sigv4-backward-compatibility-diff-evaluator
Apr 23, 2024
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
syall
force-pushed
the
sigv4-backward-compatibility-diff-evaluator
branch
3 times, most recently
from
April 15, 2024 20:56
2d1c1ea
to
16e5520
Compare
kstich
reviewed
Apr 16, 2024
smithy-aws-traits/src/main/java/software/amazon/smithy/aws/traits/auth/diff/SigV4Migration.java
Outdated
Show resolved
Hide resolved
smithy-aws-traits/src/main/java/software/amazon/smithy/aws/traits/auth/diff/SigV4Migration.java
Outdated
Show resolved
Hide resolved
smithy-aws-traits/src/main/java/software/amazon/smithy/aws/traits/auth/diff/SigV4Migration.java
Outdated
Show resolved
Hide resolved
syall
force-pushed
the
sigv4-backward-compatibility-diff-evaluator
branch
9 times, most recently
from
April 17, 2024 15:01
0cd3d80
to
747dc12
Compare
syall
force-pushed
the
sigv4-backward-compatibility-diff-evaluator
branch
8 times, most recently
from
April 17, 2024 20:50
e928f91
to
2795d41
Compare
gosar
reviewed
Apr 17, 2024
smithy-model/src/main/resources/software/amazon/smithy/model/loader/prelude.smithy
Outdated
Show resolved
Hide resolved
smithy-model/src/main/resources/software/amazon/smithy/model/loader/prelude.smithy
Outdated
Show resolved
Hide resolved
gosar
reviewed
Apr 17, 2024
smithy-model/src/main/resources/software/amazon/smithy/model/loader/prelude.smithy
Outdated
Show resolved
Hide resolved
smithy-model/src/main/resources/software/amazon/smithy/model/loader/prelude.smithy
Outdated
Show resolved
Hide resolved
syall
force-pushed
the
sigv4-backward-compatibility-diff-evaluator
branch
2 times, most recently
from
April 18, 2024 23:21
346722b
to
f93db2a
Compare
gosar
reviewed
Apr 19, 2024
...ts/src/test/resources/software/amazon/smithy/aws/traits/diffs/sigv4-sigv4a-swap-order.events
Outdated
Show resolved
Hide resolved
.../test/resources/software/amazon/smithy/aws/traits/diffs/sigv4a-before-sigv4-migration.events
Outdated
Show resolved
Hide resolved
smithy-aws-traits/src/main/java/software/amazon/smithy/aws/traits/auth/diff/SigV4Migration.java
Outdated
Show resolved
Hide resolved
smithy-aws-traits/src/test/java/software/amazon/smithy/aws/traits/DiffTest.java
Show resolved
Hide resolved
syall
force-pushed
the
sigv4-backward-compatibility-diff-evaluator
branch
from
April 19, 2024 20:37
f93db2a
to
b131fcc
Compare
syall
force-pushed
the
sigv4-backward-compatibility-diff-evaluator
branch
6 times, most recently
from
April 20, 2024 01:27
3c0ac84
to
f19711c
Compare
syall
force-pushed
the
sigv4-backward-compatibility-diff-evaluator
branch
7 times, most recently
from
April 23, 2024 01:51
3ef3c2a
to
19bc39a
Compare
gosar
reviewed
Apr 23, 2024
smithy-aws-traits/src/main/java/software/amazon/smithy/aws/traits/auth/diff/SigV4Migration.java
Outdated
Show resolved
Hide resolved
smithy-rules-engine/src/main/java/software/amazon/smithy/rulesengine/language/Endpoint.java
Outdated
Show resolved
Hide resolved
smithy-rules-engine/src/main/java/software/amazon/smithy/rulesengine/language/Endpoint.java
Outdated
Show resolved
Hide resolved
...-rules-engine/src/main/java/software/amazon/smithy/rulesengine/language/EndpointRuleSet.java
Show resolved
Hide resolved
...c/test/resources/software/amazon/smithy/rulesengine/aws/diffs/sigv4-sigv4a-swap-order.events
Outdated
Show resolved
Hide resolved
...points/src/main/java/software/amazon/smithy/rulesengine/aws/diff/EndpointSigV4Migration.java
Outdated
Show resolved
Hide resolved
syall
force-pushed
the
sigv4-backward-compatibility-diff-evaluator
branch
4 times, most recently
from
April 23, 2024 19:39
50ffc8a
to
2f92200
Compare
syall
force-pushed
the
sigv4-backward-compatibility-diff-evaluator
branch
from
April 23, 2024 20:43
2f92200
to
2fbfc46
Compare
gosar
approved these changes
Apr 23, 2024
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.
Overview
Dependent on #2250, which is the first commit of this PRThese changes add SigV4 (
aws.auth#sigv4
,sigv4
) and SigV4A (aws.auth#sigv4a
,sigv4a
) migration diff validation.This is important since not all SigV4 credentials work with SigV4A, so migration from SigV4 to SigV4A is not backward compatible.
At the time of writing, it is uncertain whether migrating from SigV4A to SigV4 is backward compatible.
Simplified, the SigV4 migration validation events are emitted when:
aws.auth#sigv4
is replaced byaws.auth#sigv4a
, or vice versaaws.auth#sigv4
andaws.auth#sigv4a
is changed in the effective auth schemesaws.auth#sigv4a
is added before an existingaws.auth#sigv4
, or vice versaValidation Tables
Keywords:
sigv4
=aws.auth#sigv4
sigv4a
=aws.auth#sigv4a
+
= set addition,
= list addition (order matters)...
= set, e.g.any
,no sigv4
,with sigv4
For both
@auth
and@smithy.rules#endpointRuleSet
auth schemes, these are the following validations:SigV4Migration
checks for service and operation@auth
diffs.EndpointSigV4Migration
checks for service@auth
and@smithy.rules#endpointRuleSet
diffs.sigv4
also includessigv4-
sub-schemes exceptsigv4-s3express
.sigv4a
also includessigv4-s3express
.beta
auth schemes are not considered during SigV4 migration, and will have to manually be added.no sigv4
+no sigv4a
]any
]with sigv4
+no sigv4a
]no sigv4a
]with sigv4a
+no sigv4
]no sigv4
]with sigv4
,with sigv4a
]with sigv4
,with sigv4a
]with sigv4
+no sigv4a
]with sigv4a
+no sigv4
]sigv4a
replacedsigv4
, but not allsigv4
credentials are compatible withsigv4a
with sigv4a
+no sigv4
]with sigv4
+no sigv4a
]sigv4
replacedsigv4a
, but signing scope could be narrowed (typically from*
)with sigv4
+no sigv4a
]with sigv4
,with sigv4a
]sigv4
will still resolve beforesigv4a
with sigv4a
+no sigv4
]with sigv4a
,with sigv4
]sigv4a
will still resolve beforesigv4
with sigv4
+no sigv4a
]with sigv4a
,with sigv4
]sigv4a
will resolve beforesigv4
, but not allsigv4
credentials are compatible withsigv4a
with sigv4a
+no sigv4
]with sigv4
,with sigv4a
]sigv4
will resolve beforesigv4a
, but signing scope could be narrowed (typically from*
)with sigv4
,with sigv4a
]with sigv4a
,with sigv4
]sigv4
andsigv4a
order is changed, but not allsigv4
credentials are compatible withsigv4a
with sigv4a
,with sigv4
]with sigv4
,with sigv4a
]sigv4
andsigv4a
order is changed, but signing scope could be narrowed (typically from*
)Testing
Related
authSchemes
list property: https://smithy.io/2.0/additional-specs/rules-engine/specification.html#endpoint-authschemes-list-propertyBy submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.