Skip to content
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

misc: link documentation to fix sigv4a unsupported algorithm #1209

Merged
merged 10 commits into from
Feb 15, 2024

Conversation

0marperez
Copy link
Contributor

Issue #

closes #625

Description of changes

Adds a link to exception message on how to fix sigv4a unsupported signing algorithm

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@0marperez 0marperez added the no-changelog Indicates that a changelog entry isn't required for a pull request. Use sparingly. label Feb 9, 2024
Copy link

github-actions bot commented Feb 9, 2024

A new generated diff is ready to view.

  • No codegen difference in the AWS SDK

Copy link

github-actions bot commented Feb 9, 2024

A new generated diff is ready to view.

  • No codegen difference in the AWS SDK

Copy link

A new generated diff is ready to view.

  • No codegen difference in the AWS SDK

@0marperez 0marperez marked this pull request as ready for review February 13, 2024 16:43
@0marperez 0marperez requested a review from a team as a code owner February 13, 2024 16:43
Copy link

A new generated diff is ready to view.

  • No codegen difference in the AWS SDK

@@ -23,7 +23,11 @@ public class UnsupportedSigningAlgorithmInterceptor : HttpInterceptor {
context.response.exceptionOrNull()?.let {
if (it is UnsupportedSigningAlgorithmException && it.signingAlgorithm == AwsSigningAlgorithm.SIGV4_ASYMMETRIC) {
return Result.failure(
it, // TODO: Add a message and link pointing to AWS SDK for Kotlin developer guide.
UnsupportedSigningAlgorithmException(
"${it.message} For more information on how to enable it with the CRT signer, please refer to: https://docs.aws.amazon.com/sdk-for-kotlin/latest/developer-guide/use-services-s3-mrap.html#mrap-s3client-config",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: ${it.message.ensureSuffix(".")}

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

alternatively, ignore the it.message and just create your own message from scratch, since you know it will always be this:
SIGV4A support is not yet implemented for the default signer. For more information on how to enable it with the CRT signer, please refer to: https://docs.aws.amazon.com/sdk-for-kotlin/latest/developer-guide/use-services-s3-mrap.html#mrap-s3client-config

Copy link

A new generated diff is ready to view.

  • No codegen difference in the AWS SDK

Copy link

A new generated diff is ready to view.

  • No codegen difference in the AWS SDK

Copy link
Contributor

@aajtodd aajtodd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree with the suggestion by Matas to just ignore the original message and write your own here. Otherwise looks good, fix and ship.

Copy link

A new generated diff is ready to view.

  • No codegen difference in the AWS SDK

Copy link

Quality Gate Passed Quality Gate passed

Issues
0 New issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

Copy link

A new generated diff is ready to view.

  • No codegen difference in the AWS SDK

@0marperez 0marperez merged commit 014459a into main Feb 15, 2024
16 checks passed
0marperez added a commit that referenced this pull request Feb 15, 2024
@0marperez 0marperez deleted the mrap-link-docs branch February 15, 2024 21:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
no-changelog Indicates that a changelog entry isn't required for a pull request. Use sparingly.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

S3 MRAP Support
3 participants