Skip to content

Latest commit

 

History

History
59 lines (43 loc) · 3.85 KB

README.md

File metadata and controls

59 lines (43 loc) · 3.85 KB
Raw

About

This implements a AWS Lambda handler which takes a JWT-Token, validates it and then performs a Aws:Sts:AssumeRole based on preconfigured rules. It's similar to the existing (offical) TokenAuthorizer but allows more complexity in it's configuration.

Practical usage could e.g. allow to authenticate a Gitlab-CI pipeline through the CI_JOB_JWT token / id_tokens without requiring additional long-term authentication credentials. The claims within the token allow very fine-grained control which is not possible otherwise.

A alternative solution is the use of the AWS STS:AssumeRoleWithWebIdentity functionality, which has some benefits (glob patterns, official AWS API) and some drawbacks (fix certificate thumbprints).

Configuration

The lambda function is configured through environment variables, and a JSON document stored within S3. A list of rules is used to check whether the claims of a valid token match the criteria to allow granting a role.

Environment variables

  • CONFIG_BUCKET - (optional) the S3 bucket name which contains the related configuration object
  • CONFIG_KEY - (optional) the S3 object key which contains the JSON configuration
  • CONFIG_ROLEANNOTATIONSENABLED - (optional) Also fetch IAM Role tags with could contain rules
  • CONFIG_JWKSURL - (optional) URL which contains required JWKs key information
  • CONFIG_REGION - (optional) AWS Region
  • CONFIG_BOUND_ISSUER - (optional) Token issue expected from the tokens
  • CONFIG_BOUND_AUDIENCE - (optional) Token audience expected in the tokens
  • LOGLEVEL - (optional) loglevel - allowed values: Trace, Debug, Info, Warning, Error, Fatal and Panic

Please note: these settings must be either configured via an file in the S3 Bucket or via environment variables.

JSON configuration

{
    "jwks_url":"https://gitlab.com/-/jwks",                          // URL which contains required JWKs key information
    "role_annotations_enabled": true,                                // Also fetch IAM Role tags with could contain rules
    "role_annotation_prefix": "token_auth/",                         // IAM Role Tag-Prefix which is used for the embedded rules
    "bound_issuer": "",                                              // Token issue expected from the tokens
    "bound_audience": "",                                            // Token audience expected from the tokens
    "rules":[                                                        // List of rules which would allow the AssumeRole for certain tokens
        {
            "claim_values":{                                         // The required values which the token should present
                "namespace_id":"4"
            },
            "duration":1800,                                         // Duration of the created session
            "region":"us-east-1",
            "role":"arn:aws:iam::124567910112:role/some-role-arn"    // Arn of the role which we Assume for valid tokens
        }
    ]
}

Rule annotations

With role_annotations_enabled set to true, rules will also be fetched from IAM-Role tags. The related tags should be prefixed with role_annotation_prefix, the value of these tags should be the required claim values as base64 formatted JSON map.

Lambda IAM policy

The lambda itself also required some IAM configuration. It needs:

  • s3:GetObject permissions to read the configuration from the S3 bucket
  • iam:GetRole permissions on every role to read the roles tags - if role_annotations_enabled is true
  • it has to be part of the trust policy of the related roles which it should assume once the token is valid