Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/steelcityamir/sts-proxy
STS Authentication Proxy for AWS
https://github.com/steelcityamir/sts-proxy
access-control authentication authorization aws aws-sts cloud-security iam java proxy security sts token-generator token-service
Last synced: 7 days ago
JSON representation
STS Authentication Proxy for AWS
- Host: GitHub
- URL: https://github.com/steelcityamir/sts-proxy
- Owner: steelcityamir
- License: mit
- Created: 2024-01-19T20:38:37.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-04-22T15:46:11.000Z (7 months ago)
- Last Synced: 2024-04-22T17:17:19.569Z (7 months ago)
- Topics: access-control, authentication, authorization, aws, aws-sts, cloud-security, iam, java, proxy, security, sts, token-generator, token-service
- Language: Java
- Homepage: https://stsproxy.com
- Size: 124 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
STSproxy
STSproxy is an AWS STS (Security Token Service) Authentication Proxy, providing a simple and secure way for you to provision temporary, limited-privilege AWS credentials for third-parties who need access to your AWS resource(s).
## 🌟 Use Case
Ideal for scenarios where a third-party vendor without an AWS account needs access to your AWS resources, ensuring secure and controlled access.
## 📋 What You Need to Get Started
- AWS account
- An IAM user with `sts:AssumeRole` permissions.
- An IAM role with the necessary permissions for the resources you want to grant access to (e.g. read-only access to an S3 bucket).
## 🛠️ Building the App from Source
#### Pre-requisites
- Java JDK 21
#### Clone the repository
```bash
git clone https://github.com/steelcityamir/sts-proxy.git
cd sts-proxy
```
#### Set environment variables
```bash
export ROLE_ARN= # arn:aws:iam::123456789012:role/S3Access
export AWS_ACCESS_KEY_ID=
export AWS_SECRET_ACCESS_KEY=
```
> [!NOTE]
> The `AWS_` prefixed variables are not needed if running on an EC2 instance with the required IAM role.
#### Run the application
```bash
./gradlew bootRun
```
#### Test the API
Use Swagger UI to test the API at http://localhost:8080/swagger-ui/index.html.
## 🚀 API usage
### POST /auth
#### Request body
```json
{
"username": "vendor",
"password": "password"
}
```
### Responses
``200 OK``
```json
{
"accessKeyId": "ASIA...",
"secretAccessKey": "+kd...",
"sessionToken": "IQo...",
"expiresOn": "2024-01-20T02:28:37Z"
}
```
``400 Bad Request``
- The request body was invalid or malformed.
``401 Unauthorized``
- The credentials were incorrect.
``503 Service Unavailable``
- Authentication was successful but the AWS client encountered an error.
## ⚙️ Configuration
The `application.properties` file contains several configuration options to tailor the behavior of the application.
These can be overridden using environment variables.
### AWS Role ARN
This is the Amazon Resource Name (ARN) of the role that the application will assume when interacting with AWS Security Token Service (STS).
- Environment variable: `ROLE_ARN`
- Application property: `aws.role.arn=${ROLE_ARN}`
> [!NOTE]
> Example ARN would be `arn:aws:iam::123456789012:role/S3Access`
### Session Lifetime
Specifies the duration, in seconds, for which the credentials should remain valid. The default and minimum value is 900 seconds (15 minutes). The maximum value is 43200 seconds (12 hours).
- Environment variable: `ROLE_SESSION_DURATION_SECONDS`
- Configuration property: `aws.role.session.duration.seconds=${ROLE_SESSION_DURATION_SECONDS:900}`
> [!TIP]
> The session duration should be long enough to perform the necessary tasks but short enough to maintain security.
### Proxy Username
This is the username for proxy authentication. Default value is `vendor`.
- Environment variable: `VENDOR_USERNAME`
- Application property: `vendor.username=${VENDOR_USERNAME:vendor}`
### Proxy Password
The bcrypt hash of the password used for proxy authentication. The default value hash corresponds to the password `password`.
- Environment variable: `VENDOR_PASSWORD`
- Application property: `vendor.password=${VENDOR_PASSWORD:{bcrypt}$2a$10$dXJ3SW6G7P50lGmMkkmwe.20cQQubK3.HZWzG3YB1tlRy.fqvM/BG}`
> [!TIP]
> It is highly recommended to change the default password. Use a bcrypt generator to create a new hash using 10 rounds.
## 🔒 Security Considerations for Production
### Use a TLS/SSL Certificate
Always use HTTPS with TLS/SSL certificates to secure data in transit. This protects sensitive data, such as authentication credentials and session tokens, from being intercepted.
### Secure Application Properties
Avoid storing sensitive information directly in `application.properties`.
### Role and Access Management
Apply the principle of least privilege for the AWS IAM roles. Ensure that the IAM role assumed by your application has only the necessary permissions and nothing more.
### Use Strong Complex Password for API Access
Enforce the following guidelines for the password:
- Minimum Length: Password should be at least 12 characters long.
- Complexity Requirements: Include a mix of uppercase and lowercase letters, numbers, and symbols.
- No Predictable Patterns: Avoid sequential characters (e.g., 1234, abcd) and repeated characters (e.g., aaaa, 1111).
### IP Whitelisting
Restrict access to authorized IP addresses for an additional layer of security.
## 📄 License
This project is licensed under the MIT License - see the LICENSE file for details.