Skip to content

Commit c347826

Browse files
DarkAtraDarkAtra
committed
feat: feign request interceptor for aws signature v4 for sdk v2
0 parents  commit c347826

18 files changed

+768
-0
lines changed

‎.editorconfig

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
root = true
2+
3+
[*]
4+
charset = utf-8
5+
end_of_line = lf
6+
indent_size = 4
7+
indent_style = space
8+
insert_final_newline = true
9+
trim_trailing_whitespace = true
10+
max_line_length = 160
11+
tab_width = 4
12+
13+
[{*.yaml, *.yml, *.md}]
14+
indent_size = 2

‎.github/dependabot.yml

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: "maven"
4+
directory: "/"
5+
schedule:
6+
interval: "daily"
7+
8+
- package-ecosystem: "github-actions"
9+
directory: "/"
10+
schedule:
11+
interval: "daily"

‎.github/issue_template/bug_report.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: 'bug'
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
Steps to reproduce the behavior.
15+
16+
**Expected behavior**
17+
A clear and concise description of what you expected to happen.
18+
19+
**Additional context**
20+
Add any other context about the problem here.

‎.github/issue_template/feature_request.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: 'enhancement'
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

‎.github/pull_request_template.md

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Description
2+
3+
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required
4+
for this change.
5+
6+
Fixes # (issue)
7+
8+
## Type of change
9+
10+
Please delete options that are not relevant.
11+
12+
- [ ] Bug fix (non-breaking change which fixes an issue)
13+
- [ ] New feature (non-breaking change which adds functionality)
14+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
15+
- [ ] This change requires a documentation update
16+
17+
# Checklist:
18+
19+
- [ ] I hereby accept that the code I contributed is under the MIT license.
20+
- [ ] My code follows the style guidelines of this project
21+
- [ ] I have performed a self-review of my own code
22+
- [ ] I have made corresponding changes to the documentation
23+
- [ ] My changes generate no new warnings
24+
- [ ] I have added tests that prove my fix is effective or that my feature works
25+
- [ ] New and existing unit tests pass locally with my changes

‎.github/workflows/build.yml

+49
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
name: Build & Release
2+
on:
3+
workflow_dispatch:
4+
push:
5+
branches:
6+
- main
7+
- next
8+
paths:
9+
- '**/src/**'
10+
- '**/pom.xml'
11+
- 'pom.xml'
12+
13+
permissions:
14+
# used by semantic release
15+
contents: write
16+
issues: write
17+
pull-requests: write
18+
# used to publish the docker image
19+
packages: write
20+
# used by trivy
21+
security-events: write
22+
23+
jobs:
24+
build:
25+
name: Build & Release
26+
runs-on: ubuntu-latest
27+
steps:
28+
- uses: actions/checkout@v3
29+
with:
30+
fetch-depth: 0 # Shallow clones should be disabled for a better relevancy of analysis
31+
32+
- name: Set up JDK 11
33+
uses: actions/setup-java@v3
34+
with:
35+
java-version: '11'
36+
distribution: 'temurin'
37+
cache: 'maven'
38+
39+
- name: Run Tests
40+
run: mvn -B -ntp clean install
41+
42+
- name: Create new release
43+
uses: cycjimmy/semantic-release-action@v3
44+
with:
45+
extra_plugins: |
46+
@semantic-release/git
47+
@semantic-release/exec
48+
env:
49+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

‎.github/workflows/pull-request-lint.yml

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: Lint Pull Request
2+
on:
3+
pull_request_target:
4+
types:
5+
- opened
6+
- edited
7+
- synchronize
8+
9+
permissions:
10+
pull-requests: read
11+
12+
jobs:
13+
lint:
14+
runs-on: ubuntu-latest
15+
steps:
16+
- uses: amannn/action-semantic-pull-request@v5
17+
env:
18+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
19+
with:
20+
validateSingleCommit: true

‎.github/workflows/pull-request.yml

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: Verify Pull Request
2+
on:
3+
pull_request:
4+
paths:
5+
- '**/src/**'
6+
- '**/pom.xml'
7+
- 'pom.xml'
8+
9+
permissions:
10+
contents: read
11+
12+
jobs:
13+
verify:
14+
name: Verify Pull Request
15+
runs-on: ubuntu-latest
16+
steps:
17+
- uses: actions/checkout@v3
18+
with:
19+
fetch-depth: 0 # Shallow clones should be disabled for a better relevancy of analysis
20+
21+
- name: Set up JDK 11
22+
uses: actions/setup-java@v3
23+
with:
24+
java-version: '11'
25+
distribution: 'temurin'
26+
cache: 'maven'
27+
28+
- name: Run Tests
29+
run: mvn -B -ntp clean install

‎.gitignore

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
HELP.md
2+
target/
3+
!**/src/main/**/target/
4+
!**/src/test/**/target/
5+
.flattened-pom.xml
6+
7+
### STS ###
8+
.apt_generated
9+
.classpath
10+
.factorypath
11+
.project
12+
.settings
13+
.springBeans
14+
.sts4-cache
15+
16+
### IntelliJ IDEA ###
17+
.idea
18+
*.iws
19+
*.iml
20+
*.ipr
21+
22+
### NetBeans ###
23+
/nbproject/private/
24+
/nbbuild/
25+
/dist/
26+
/nbdist/
27+
/.nb-gradle/
28+
build/
29+
!**/src/main/**/build/
30+
!**/src/test/**/build/
31+
32+
### VS Code ###
33+
.vscode/

‎.releaserc.json

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
{
2+
"branches": [
3+
"main",
4+
{
5+
"name": "next",
6+
"prerelease": true
7+
}
8+
],
9+
"plugins": [
10+
"@semantic-release/commit-analyzer",
11+
"@semantic-release/release-notes-generator",
12+
[
13+
"@semantic-release/exec",
14+
{
15+
"prepareCmd": "mvn -B -ntp versions:set -DgenerateBackupPoms=false -DnewVersion=${nextRelease.version}",
16+
"publishCmd": "mvn -B -ntp clean deploy -DskipTests"
17+
}
18+
],
19+
[
20+
"@semantic-release/git",
21+
{
22+
"assets": [
23+
[
24+
"**/pom.xml",
25+
"!**/target/**/*"
26+
]
27+
]
28+
}
29+
],
30+
"@semantic-release/github"
31+
]
32+
}

‎LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2021 DarkAtra
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md

+56
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
[![Build](https://github.com/DarkAtra/feign-aws-sigv4/actions/workflows/build.yml/badge.svg)](https://github.com/DarkAtra/feign-aws-sigv4/actions/workflows/build.yml)
2+
3+
# feign-aws-sigv4
4+
5+
Provides feign request interceptors to sign http requests with [AWS Signature V4](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html).
6+
7+
| Artifact Id | AWS SDK Version | Status |
8+
|-------------------------|-----------------|---------------------|
9+
| `feign-aws-sigv4-sdkv1` | V1 | ❌ To be implemented |
10+
| `feign-aws-sigv4-sdkv2` | V2 | ✅ Fully implemented |
11+
12+
## Usage with SDK V2
13+
14+
Include the following dependency in your project:
15+
16+
```
17+
<dependency>
18+
<groupId>de.darkatra</groupId>
19+
<artifactId>feign-aws-sigv4-sdkv2</artifactId>
20+
<version>1.0.0</version>
21+
</dependency>
22+
```
23+
24+
### Kotlin
25+
26+
```kotlin
27+
val awsCredentialsProvider = DefaultCredentialsProvider.create()
28+
val service = "execute-api"
29+
val region = Region.of("eu-central-1")
30+
31+
val awsSignatureV4RequestInterceptor = AwsSignatureV4RequestInterceptor(awsCredentialsProvider, service, region)
32+
33+
Feign.builder()
34+
.requestInterceptor(awsSignatureV4RequestInterceptor)
35+
.target(YourClient::class.java, url)
36+
```
37+
38+
### Java
39+
40+
```java
41+
final AwsCredentialsProvider awsCredentialsProvider = DefaultCredentialsProvider.create();
42+
final String service = "execute-api";
43+
final Region region = Region.of("eu-central-1");
44+
45+
final RequestInterceptor awsSignatureV4RequestInterceptor = new AwsSignatureV4RequestInterceptor(awsCredentialsProvider, service, region);
46+
47+
Feign.builder()
48+
.requestInterceptor(awsSignatureV4RequestInterceptor)
49+
.target(YourClient.class, url);
50+
```
51+
52+
## How to build it locally
53+
54+
```
55+
mvn clean install
56+
```

0 commit comments

Comments
 (0)