Add new Identity interfaces #3773

gosar · 2023-02-17T22:25:54Z

Motivation and Context

As part of Smithy Reference Architecture, we are defining new Identity and Auth components. This changes adds the new Identity interfaces.

Modifications

This changes adds the new Identity interfaces and related changes to existing interfaces to be sub-types of the new interfaces, to maintain backwards compatibility.
Changes to ClientBuilders and other classes to use the new interfaces will be in separate PR next.

Testing

No specific new tests. Made sure build succeeds. ./mvnw clean install -pl :identity-spi,:auth -am

Screenshots (if appropriate)

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)

Checklist

I have read the CONTRIBUTING document
Local run of mvn install succeeds
My code follows the code style of this project
My change requires a change to the Javadoc documentation
I have updated the Javadoc documentation accordingly
I have added tests to cover my changes
All new and existing tests passed
I have added a changelog entry. Adding a new entry must be accomplished by running the scripts/new-change script and following the instructions. Commit the new file created by the script in .changes/next-release with your changes.
My change is to implement 1.11 parity feature and I have updated LaunchChangelog

License

I confirm that this pull request can be released under the Apache 2 license

core/auth/src/main/java/software/amazon/awssdk/auth/credentials/AwsCredentials.java

core/identity-spi/src/main/java/software/amazon/awssdk/identity/spi/AwsCredentialsIdentity.java

core/identity-spi/src/main/java/software/amazon/awssdk/identity/spi/TokenIdentity.java

core/auth/src/main/java/software/amazon/awssdk/auth/credentials/AwsCredentials.java

cenedhryn · 2023-03-01T01:08:19Z

...entity-spi/src/main/java/software/amazon/awssdk/identity/spi/AwsCredentialsIdentityImpl.java

+
+@Immutable
+@SdkInternalApi
+final class AwsCredentialsIdentityImpl implements AwsCredentialsIdentity {


I haven't seen any mention in the design doc of a direct implementation of AwsCredentialsIdentity. Do we need this class?

This is to support the static create methods in AwsCredentialsIdentity which are called out in the design doc. Cannot use the existing AwsBasicCredentials as that would be a circular dependency, so defined copies of them here as @SdkInternalApi and package-private.

We're also discussing offline, but if we do decide to keep them they should be in an internal subpackage

I'd vote for removing those classes. They are implementation details and we'd need to maintain two copies of the same implementations. We could consider creating a factory class in auth module that makes it easier for people to create static credentials.

👍 removed for now.

core/identity-spi/src/main/java/software/amazon/awssdk/identity/spi/ResolveIdentityRequest.java

core/identity-spi/src/main/java/software/amazon/awssdk/identity/spi/TokenIdentity.java

core/identity-spi/src/main/java/software/amazon/awssdk/identity/spi/IdentityProvider.java

Was getting these errors otherwise: ``` [ERROR] Failed to execute goal com.github.siom79.japicmp:japicmp-maven-plugin:0.15.6:cmp (default) on project auth: There is at least one incompatibility: software.amazon.awssdk.auth.credentials.AwsCredentials.accessKeyId():METHOD_REMOVED,software.amazon.awssdk.auth.credentials.AwsCredentials.secretAccessKey():METHOD_REMOVED,software.amazon.awssdk.auth.token.credentials.SdkToken.expirationTime():METHOD_REMOVED,software.amazon.awssdk.auth.token.credentials.SdkToken.token():METHOD_REMOVED -> [Help 1] ```

sonarqubecloud · 2023-03-03T00:45:45Z

SonarCloud Quality Gate failed.

0 Bugs
0 Vulnerabilities
0 Security Hotspots
1 Code Smell

42.6% Coverage
0.0% Duplication

sugmanue · 2023-03-04T00:23:58Z

core/identity-spi/src/main/java/software/amazon/awssdk/identity/spi/ResolveIdentityRequest.java

+
+    @Override
+    public int hashCode() {
+        return 31 + Objects.hashCode(properties);


I think this should be 32 * Objects.hashCode(properties); instead.

Sorry, 31 * ..., i.e., not +.

Actually, I think since there is only 1 field in this class, I can just return Objects.hashCode(properties);. Will update in new PR as this is merged.

Updating in #3814

* Simplify hashCode and equals for ResolveIdentityRequest * Fix doc link about AWS access keys To match with updates to `AwsCredentials` in PR 3773.

gosar · 2023-10-11T07:37:12Z

pom.xml

@@ -630,6 +630,10 @@
                            <exclude>software.amazon.awssdk.core.signer.NoOpSigner</exclude>
                            <exclude>software.amazon.awssdk.auth.credentials.ProfileCredentialsProviderFactory</exclude>
                            <exclude>software.amazon.awssdk.utils.async.InputStreamSubscriber</exclude>
+
+                            <!-- Moving the interface methods to new SRA super interfaces causes japicmp to complain -->


the errors without this are:

[ERROR] Failed to execute goal com.github.siom79.japicmp:japicmp-maven-plugin:0.15.6:cmp (default) on project auth: There is at least one incompatibility: software.amazon.awssdk.auth.credentials.AwsCredentials.accessKeyId():METHOD_REMOVED,software.amazon.awssdk.auth.credentials.AwsCredentials.secretAccessKey():METHOD_REMOVED,software.amazon.awssdk.auth.token.credentials.SdkToken.expirationTime():METHOD_REMOVED,software.amazon.awssdk.auth.token.credentials.SdkToken.token():METHOD_REMOVED -> [Help 1]

Add new Identity interfaces

7a8f551

gosar commented Feb 17, 2023

View reviewed changes

gosar added 2 commits February 17, 2023 15:16

Move Impl classes to own files

04fd713

Add missing @immutable

b2a44e8

gosar requested a review from millems February 17, 2023 23:37

cenedhryn reviewed Mar 1, 2023

View reviewed changes

Address feedback - interface override and javadoc edits

444848d

cenedhryn reviewed Mar 1, 2023

View reviewed changes

core/identity-spi/src/main/java/software/amazon/awssdk/identity/spi/IdentityProvider.java Outdated Show resolved Hide resolved

gosar added 3 commits March 1, 2023 22:18

Mark the new interfaces @threadsafe

f03400a

Remove static create methods in AwsCredentialsIdentity and impls

acbd8bf

cenedhryn approved these changes Mar 3, 2023

View reviewed changes

gosar marked this pull request as ready for review March 4, 2023 00:02

gosar requested a review from a team as a code owner March 4, 2023 00:03

gosar merged commit ac838e0 into feature/master/sra-identity-auth Mar 4, 2023

sugmanue reviewed Mar 4, 2023

View reviewed changes

gosar mentioned this pull request Mar 6, 2023

Minor updates to PR #3773 #3814

Merged

12 tasks

gosar added a commit that referenced this pull request Mar 9, 2023

Minor updates to PR #3773 (#3814)

aa6afee

* Simplify hashCode and equals for ResolveIdentityRequest * Fix doc link about AWS access keys To match with updates to `AwsCredentials` in PR 3773.

gosar deleted the gosar/sra-ia-identity branch April 1, 2023 00:02

gosar commented Oct 11, 2023

View reviewed changes

peterzhuamazon mentioned this pull request Feb 19, 2025

Bump software.amazon.awssdk from 2.20.86 to 2.30.31 opensearch-project/OpenSearch#17396

Merged

Add new Identity interfaces #3773

Add new Identity interfaces #3773

Uh oh!

Conversation

gosar commented Feb 17, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Motivation and Context

Modifications

Testing

Screenshots (if appropriate)

Types of changes

Checklist

License

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sonarqubecloud bot commented Mar 3, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

gosar commented Feb 17, 2023 •

edited

Loading

sonarqubecloud bot commented Mar 3, 2023 •

edited

Loading