feign-aws-sigv4
Provides feign request interceptors to sign http requests using AWS Signature V4.
Usage with SDK V1
Include the following dependency in your project:
<dependency>
<groupId>de.darkatra</groupId>
<artifactId>feign-aws-sigv4-sdkv1</artifactId>
<version>2.0.0</version>
</dependency>
Kotlin
val awsCredentialsProvider = DefaultAWSCredentialsProviderChain()
val service = "execute-api"
val region = Region.getRegion(Regions.EU_CENTRAL_1)
val awsSignatureV4RequestInterceptor = AwsSignatureV4RequestInterceptor(awsCredentialsProvider, service, region)
Feign.builder()
.requestInterceptor(awsSignatureV4RequestInterceptor)
.target(YourClient::class.java, url)
Java
final AWSCredentialsProvider awsCredentialsProvider = new DefaultAWSCredentialsProviderChain();
final String service = "execute-api";
final Region region = Region.getRegion(Regions.EU_CENTRAL_1);
final RequestInterceptor awsSignatureV4RequestInterceptor = new AwsSignatureV4RequestInterceptor(awsCredentialsProvider, service, region);
Feign.builder()
.requestInterceptor(awsSignatureV4RequestInterceptor)
.target(YourClient.class, url);
Usage with SDK V2
Include the following dependency in your project:
<dependency>
<groupId>de.darkatra</groupId>
<artifactId>feign-aws-sigv4-sdkv2</artifactId>
<version>2.0.0</version>
</dependency>
Kotlin
val awsCredentialsProvider = DefaultCredentialsProvider.create()
val service = "execute-api"
val region = Region.of("eu-central-1")
val awsSignatureV4RequestInterceptor = AwsSignatureV4RequestInterceptor(awsCredentialsProvider, service, region)
Feign.builder()
.requestInterceptor(awsSignatureV4RequestInterceptor)
.target(YourClient::class.java, url)
Java
final AwsCredentialsProvider awsCredentialsProvider = DefaultCredentialsProvider.create();
final String service = "execute-api";
final Region region = Region.of("eu-central-1");
final RequestInterceptor awsSignatureV4RequestInterceptor = new AwsSignatureV4RequestInterceptor(awsCredentialsProvider, service, region);
Feign.builder()
.requestInterceptor(awsSignatureV4RequestInterceptor)
.target(YourClient.class, url);
How to build it locally
mvn clean install
How to execute Integration Tests locally
In order to run Integration Tests locally, you'll have to set up the necessary infrastructure in one of your AWS Accounts. This can be done by applying the Terraform CDK project found in integration-tests/infrastructure. Here's how you do it:
- Make sure that no state file exists in
/integration-tests/infrastructure. If it exists, see if the state file is empty. If so, delete it. Otherwise, perform Step 7 or 8. - Synthesize the Terraform CDK Stack by running:
# cd into /integration-tests/infrastructure cd integration-tests/infrastructure npm ci npm run synth - Obtain Credentials for your AWS Account. This step highly depends on how the AWS Account is set up. You'll need permissions for API Gateway, Lambda and IAM.
- Apply the synthesized Terraform CDK Stack by running:
# cd into /integration-tests/infrastructure/cdktf.out/stacks/feign-aws-sigv4-integration-tests cd cdktf.out/stacks/feign-aws-sigv4-integration-tests terraform init terraform apply - Confirm with
yesafter checking the Terraform Plan output. - Wait until everything is set up. This should only take a few seconds.
- Execute the Tests by running:
# cd back to / export API_GATEWAY_URL=$(terraform output -raw api-gateway-url) cd ../../../../.. mvn -B -ntp clean install failsafe:integration-test failsafe:verify -DapiGatewayUrl=$API_GATEWAY_URL - Clean up the necessary infrastructure by running:
# cd into /integration-tests/infrastructure/cdktf.out/stacks/feign-aws-sigv4-integration-tests cd integration-tests/infrastructure/cdktf.out/stacks/feign-aws-sigv4-integration-tests terraform destroy - Confirm with
yesafter checking the Terraform Destroy output.
4 Sep 20, 2022
2 Jul 16, 2021
18 Nov 26, 2022
0 Feb 17, 2022
0 May 2, 2022
2 Aug 7, 2022
0 Nov 7, 2021
2 Nov 25, 2022
1 Oct 13, 2022
36 Dec 29, 2022
2 Nov 29, 2022
2 May 4, 2022
5 Dec 7, 2022
4 Dec 17, 2022
285 Jan 3, 2023
2 Aug 8, 2022
1 Nov 27, 2021
23 Nov 28, 2022