Amazon Neptune SigV4 Signer

A library for sending AWS Signature Version 4 signed requests over HTTP to Amazon Neptune. This package provides signers that can be used with various implementations of HttpRequests:

1. NeptuneApacheHttpSigV4Signer.java - provides an implementation for signing Apache Http Requests.
2. NeptuneNettyHttpSigV4Signer.java - provides an implementation for signing Netty Http requests
3. NeptuneJavaHttpSigV4Signer.java - provides an implementation for signing java.net.http.HttpRequest requests (the standard Java HTTP client)
4. NeptuneRequestMetadataSigV4Signer.java - provides an implementation for a generic Request object RequestMetadata. A user of this class can convert their native HttpRequest into a RequestMetadata object and pass it to this class to create the signature.

Usage

This library requires AWS SDK for Java v2 credentials. Use any AwsCredentialsProvider implementation from the SDK v2 auth module.

import software.amazon.awssdk.auth.credentials.DefaultCredentialsProvider;
import com.amazonaws.neptune.auth.NeptuneJavaHttpSigV4Signer;

// Create the signer
NeptuneJavaHttpSigV4Signer signer = new NeptuneJavaHttpSigV4Signer(
    "us-east-1",
    DefaultCredentialsProvider.create());

// Sign a java.net.http request
HttpRequest.Builder requestBuilder = HttpRequest.newBuilder()
    .uri(URI.create("https://your-neptune-endpoint:8182/sparql?query=..."))
    .GET();

signer.signRequest(requestBuilder);
HttpRequest signedRequest = requestBuilder.build();

Note: The JVM restricts setting the Host header by default. If needed, launch with -Djdk.httpclient.allowRestrictedHeaders=host.

Usage Examples

For examples of usage of this library refer to:

1. Connecting to Neptune Using Java and Gremlin with Signature Version 4 Signing
2. amazon-neptune-sparql-java-sigv4 - Contains examples for sending SigV4 signed requests with Apache HttpUriRequest objects.

For more documentation around IAM database authentication for Neptune refer to Identity and Access Management in Amazon Neptune

For the official Amazon Neptune page refer to: https://aws.amazon.com/neptune

License

This library is licensed under the Apache 2.0 License.