Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Session tags and external id support for AWS Secrets #18813

Closed
wants to merge 7 commits into from

Commits on Aug 3, 2023

  1. Add Session tags and external id support for AWS Secrets

    It is now possible to set the AWS session tags and external id when assuming an IAM role
    via STS AssumeRole.
    
    Here's an example setup
    
    AWS Role - Trust relationship needs the `sts:TagSession` permission set as described in https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html#id_session-tags_permissions-required
    ```bash
    vault secrets enable aws
    vault write aws/config/root access_key=<key> secret_key=<secret> region=us-west-2
    vault write aws/roles/my-role credential_type=assumed_role max_sts_ttl=1h role_arns="arn:aws:iam::000000000000:role/test" session_tags="department=eng" session_tags="project=p1" external_id=123
    ```
    
    Read the role definition
    ```
    vault read  aws/roles/my-role
    Key                         Value
    ---                         -----
    credential_type             assumed_role
    default_sts_ttl             0s
    external_id                 123
    iam_groups                  <nil>
    iam_tags                    <nil>
    max_sts_ttl                 1h
    permissions_boundary_arn    n/a
    policy_arns                 <nil>
    policy_document             n/a
    role_arns                   [arn:aws:iam::000000000000:role/test]
    session_tags                map[department:eng project:p1]
    user_path                   n/a
    ```
    
    ```bash
    vault read  aws/sts/my-role
    Key               Value
    ---               -----
    access_key        XXXX
    arn               arn:aws:sts::000000000000:assumed-role/test/vault-token-my-role-1674516375-mBKZQssrwtP6gl3kbmWq
    secret_key        XXX
    security_token    XXX
    ttl               59m59s
    ```
    
    The cloudtrail for AssumeRole looks like
    ```
    	"userIdentity": {
            "type": "IAMUser",
            "principalId": "XXX",
            "arn": "arn:aws:iam::000000000000:user/vault-user",
            "accountId": "000000000000",
            "accessKeyId": "XXX",
            "userName": "vault-user"
        },
        "eventTime": "2023-01-23T23:31:12Z",
        "eventSource": "sts.amazonaws.com",
        "eventName": "AssumeRole",
        "awsRegion": "us-east-1",
        "sourceIPAddress": "XXX",
        "userAgent": "aws-sdk-go/1.44.128 (go1.19.5; darwin; arm64)",
        "requestParameters": {
            "roleArn": "arn:aws:iam::000000000000:role/test",
            "roleSessionName": "vault-token-my-role-1674516375",
            "durationSeconds": 3600,
            "tags": [
                {
                    "key": "department",
                    "value": "eng"
                },
                {
                    "key": "project",
                    "value": "p1"
                }
            ],
            "externalId": "123"
        },
    	...
    ```
    
    When using the creds are used for accessing an S3 resource with Attribute-based Access Control (ABAC), you can now see that only requests with principalTag project=p1 are allowed while requests to path p2 are denied.
    
    ```
    aws s3 cp a.txt s3://session-tags-test/p1/a.txt
    upload: ./a.txt to s3://session-tags-test/p1/a.txt
    ➜  ~ aws s3 cp a.txt s3://session-tags-test/p2/a.txt
    upload failed: ./a.txt to s3://session-tags-test/p2/a.txt An error occurred (AccessDenied) when calling the PutObject operation: Access Denied
    ```
    
    The IAM policy had the following block in the above case
    ```
    	{
                "Action": [
                    "s3:Describe*",
                    "s3:Get*",
                    "s3:List*",
                    "s3:PutObject*"
                ],
                "Effect": "Allow",
                "Resource": [
                    "arn:aws:s3:::session-tags-test/${aws:PrincipalTag/project}/*",
                    "arn:aws:s3:::session-tags-test/${aws:PrincipalTag/project}"
                ]
            }
    ```
    
    Troubleshooting:
    Error:
    ```
     Error assuming role: AccessDenied: User: arn:aws:iam::000000000000:user/vault-user is not authorized to perform: sts:TagSession on resource: arn:aws:iam::000000000000:role/test
    	status code: 403, request id: ba8ab60e-2fdf-4668-81ad-5fe83e9b898e
    ```
    
    Remedy: Assign the `sts:TagSession` permission to the `arn:aws:iam::000000000000:role/test`. See https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html#id_session-tags_permissions-required
    
    Error:
    ```
    * Error assuming role: AccessDenied: User: arn:aws:iam::000000000000:user/vault-user is not authorized to perform: sts:AssumeRole on resource: arn:aws:iam::000000000000:role/test
    	status code: 403, request id: c0117588-9c84-490d-9b36-91135545dec1
    ```
    Remedy: If the external ID is set, follow https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html to ensure that external ID matches the ID set on the role. If you have not added the externalID condition on the role, it would not affect the assume role operation when an external ID is set only in Vault.
    
    This change does not add support for transitive keys but it should be simple to add it in the future.
    
    Closes hashicorp#3790 hashicorp#7960
    harsimranmaan committed Aug 3, 2023
    Configuration menu
    Copy the full SHA
    8470de9 View commit details
    Browse the repository at this point in the history

Commits on Jun 26, 2024

  1. Configuration menu
    Copy the full SHA
    03583e9 View commit details
    Browse the repository at this point in the history
  2. Remove max tags check

    Prefer to let the AWS API enforce its own constraints. If the max number
    of tags is exceeded AWS will return an error.
    
    In addition, the check was never being enforced since it as conditional
    on an invalid config error.
    benashz committed Jun 26, 2024
    Configuration menu
    Copy the full SHA
    90769d2 View commit details
    Browse the repository at this point in the history
  3. Fix external_id description

    benashz committed Jun 26, 2024
    Configuration menu
    Copy the full SHA
    a39aa8a View commit details
    Browse the repository at this point in the history
  4. Add validation tests

    benashz committed Jun 26, 2024
    Configuration menu
    Copy the full SHA
    6dfb22a View commit details
    Browse the repository at this point in the history
  5. Add changelog

    benashz committed Jun 26, 2024
    Configuration menu
    Copy the full SHA
    017d562 View commit details
    Browse the repository at this point in the history
  6. Update API docs

    benashz committed Jun 26, 2024
    Configuration menu
    Copy the full SHA
    1bc35ee View commit details
    Browse the repository at this point in the history