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

[Feature] Synchronized version of AwsCrt4aSigningAdapter #782

Open
2 tasks
noCharger opened this issue Apr 26, 2024 · 2 comments
Open
2 tasks

[Feature] Synchronized version of AwsCrt4aSigningAdapter #782

noCharger opened this issue Apr 26, 2024 · 2 comments
Labels
feature-request A feature should be added or improved. p3 This is a minor priority issue

Comments

@noCharger
Copy link

Describe the feature

The feature request is for an implementation of the AwsCrt4aSigningAdapter that either uses synchronized signing method or employs non-daemon threads during signing operations.

https://github.com/aws/aws-sdk-java-v2/blob/80e1821456aea846fca72ee6d0ffdb8b82a3ea48/core/auth-crt/src/main/java/software/amazon/awssdk/authcrt/signer/internal/AwsCrt4aSigningAdapter.java#L48

Use Case

The current SigV4a signer is implemented asynchronously using CompletableFuture, which defaults to using daemon thread. However, in specific scenarios such as when Spark's ShutdownHookManager is active, these daemon threads can be prematurely interrupted, leading to potential issues.

Proposed Solution

An implementation of the AwsCrtV4aSigner that either uses synchronized signing method or employs non-daemon threads during signing operations.

Pseudo code

public class AwsSigner {
    private static final ThreadFactory nonDaemonThreadFactory = new ThreadFactory() {
        private final AtomicInteger threadCount = new AtomicInteger(0);

        @Override
        public Thread newThread(Runnable r) {
            Thread t = new Thread(r);
            t.setDaemon(false); // Set the thread as non-daemon
            t.setName("AwsSignerThread-" + threadCount.getAndIncrement());
            return t;
        }
    };

    /**
     * Signs an http request according to the supplied signing configuration
     * @param request http request to sign
     * @param config signing configuration
     * @return future which will contain the signed request
     */
    static public CompletableFuture<HttpRequest> signRequest(HttpRequest request, AwsSigningConfig config) {
        CompletableFuture<HttpRequest> future = new CompletableFuture<HttpRequest>();
        CompletableFuture<AwsSigningResult> result = AwsSigner.sign(request, config);

        result.whenCompleteAsync((res, throwable) -> {
            if (throwable != null) {
                future.completeExceptionally(throwable);
            } else {
                future.complete(res.getSignedRequest());
            }
        }, Executors.newSingleThreadExecutor(nonDaemonThreadFactory));
        return future;
    }
}

Other Information

No response

Acknowledgements

  • I may be able to implement this feature request
  • This feature might incur a breaking change
@noCharger noCharger added feature-request A feature should be added or improved. needs-triage This issue or PR still needs to be triaged. labels Apr 26, 2024
@bretambrose
Copy link
Contributor

bretambrose commented Apr 27, 2024

If you supply credentials in the configuration structure, signing is synchronous.

Beyond that, the threads used in CRT signing are not Java managed at all and likely never will be. It seems like the best bet is to use a Java SDK credentials provider (not a CRT credentials provider which is where the native threads are being used), acquire credentials and then sign using the resolved credentials synchronously.

@noCharger
Copy link
Author

If you supply credentials in the configuration structure, signing is synchronous.

Beyond that, the threads used in CRT signing are not Java managed at all and likely never will be. It seems like the best bet is to use a Java SDK credentials provider (not a CRT credentials provider which is where the native threads are being used), acquire credentials and then sign using the resolved credentials synchronously.

@bretambrose Thanks for the reply! Regarding the sigv4 use case, we currently utilize com.amazonaws.auth.AWSCredentialsProvider along with com.amazonaws.auth.AWS4Signer. For the sigv4a signer, however, the interface software.amazon.awssdk.authcrt.signer.AwsCrtV4aSigner is provided as SdkHttpFullRequest sign(SdkHttpFullRequest request, ExecutionAttributes executionAttributes);. Could you demonstrate how to incorporate credentials into the configuration structure? I am eager to develop a customized version of the AwsCrt4aSigningAdapter that directly interfaces with AwsSigner.

@jmklix jmklix added p3 This is a minor priority issue and removed needs-triage This issue or PR still needs to be triaged. labels Apr 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature-request A feature should be added or improved. p3 This is a minor priority issue
Projects
None yet
Development

No branches or pull requests

3 participants