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

feat: set_aws_env_vars #184

Merged
merged 6 commits into from
Dec 5, 2023
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions .circleci/test-deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,9 @@ jobs:
region:
type: string
default: ${AWS_DEFAULT_REGION}
set_aws_env_vars:
type: boolean
default: true
executor: <<parameters.executor>>
steps:
- aws-cli/setup:
Expand All @@ -70,16 +73,19 @@ jobs:
configure_default_region: <<parameters.configure_default_region>>
configure_profile_region: <<parameters.configure_profile_region>>
region: <<parameters.region>>
set_aws_env_vars: <<parameters.set_aws_env_vars>>
- run:
name: Test that paging is disabled
command: |-
set -x
# Test with aws command that would require paging if a pager is enabled
touch "${BASH_ENV}"
. "${BASH_ENV}"
aws --version
aws ec2 describe-images --profile << parameters.profile_name >> \
--owners amazon \
--filters "Name=platform,Values=windows" "Name=root-device-type,Values=ebs"
set +x
integration-test-role-arn-setup:
executor: docker-base
parameters:
Expand Down Expand Up @@ -170,7 +176,16 @@ workflows:
context: [CPE-OIDC]
executor: docker-base
role_session_name: "test-Sess!on Wi7h inv^l!d-characters that's longer than 64 chars"
set_aws_env_vars: false
post-steps:
- run:
name: Check for temporary file containing keys
command: |
if [ -f "/tmp/default.keys" ]; then
exit 0
else
exit 1
fi
brivu marked this conversation as resolved.
Show resolved Hide resolved
- run:
name: Check Values of Expanded Variables
command: |
Expand Down
11 changes: 10 additions & 1 deletion src/commands/assume_role_with_web_identity.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,13 +33,22 @@ parameters:
type: string
default: ${AWS_DEFAULT_REGION}

set_aws_env_vars:
description: |
Write AWS keys generated from OIDC to a temporary file.
Set to false if generating keys for multiple profiles.
By default, the keys are written to $BASH_ENV.
type: boolean
default: true

steps:
- run:
name: Generate shortlived AWS Keys using CircleCI OIDC token.
name: Generate short lived AWS Keys using CircleCI OIDC token.
environment:
AWS_CLI_STR_ROLE_ARN: <<parameters.role_arn>>
AWS_CLI_STR_ROLE_SESSION_NAME: <<parameters.role_session_name>>
AWS_CLI_INT_SESSION_DURATION: <<parameters.session_duration>>
AWS_CLI_STR_PROFILE_NAME: <<parameters.profile_name>>
AWS_CLI_STR_REGION: <<parameters.region>>
AWS_CLI_BOOL_SET_AWS_ENV_VARS: <<parameters.set_aws_env_vars>>
command: <<include(scripts/assume_role_with_web_identity.sh)>>
10 changes: 10 additions & 0 deletions src/commands/setup.yml
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,14 @@ parameters:
type: string
default: "3600"

set_aws_env_vars:
description: |
Write AWS keys generated from OIDC to a temporary file.
Set to false if generating keys for multiple profiles.
By default, the keys are written to $BASH_ENV.
type: boolean
default: true

steps:
- install:
version: <<parameters.version>>
Expand All @@ -111,6 +119,7 @@ steps:
session_duration: <<parameters.session_duration>>
profile_name: <<parameters.profile_name>>
region: <<parameters.region>>
set_aws_env_vars: <<parameters.set_aws_env_vars>>
- run:
name: Configure AWS Access Key ID
environment:
Expand All @@ -120,4 +129,5 @@ steps:
AWS_CLI_BOOL_CONFIG_DEFAULT_REGION: <<parameters.configure_default_region>>
AWS_CLI_BOOL_CONFIG_PROFILE_REGION: <<parameters.configure_profile_region>>
AWS_CLI_STR_REGION: <<parameters.region>>
AWS_CLI_BOOL_SET_AWS_ENV_VARS: <<parameters.set_aws_env_vars>>
command: <<include(scripts/configure.sh)>>
23 changes: 15 additions & 8 deletions src/scripts/assume_role_with_web_identity.sh
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,11 @@ AWS_CLI_STR_ROLE_ARN="$(echo "${AWS_CLI_STR_ROLE_ARN}" | circleci env subst)"
AWS_CLI_STR_PROFILE_NAME="$(echo "${AWS_CLI_STR_PROFILE_NAME}" | circleci env subst)"
AWS_CLI_STR_REGION="$(echo "${AWS_CLI_STR_REGION}" | circleci env subst)"
AWS_CLI_INT_SESSION_DURATION="$(echo "${AWS_CLI_INT_SESSION_DURATION}" | circleci env subst)"
AWS_CLI_BOOL_SET_AWS_ENV_VARS="$(echo "${AWS_CLI_BOOL_SET_AWS_ENV_VARS}" | circleci env subst)"

# Sanitise role session name
# Remove invalid characters
AWS_CLI_STR_ROLE_SESSION_NAME=$(echo "${AWS_CLI_STR_ROLE_SESSION_NAME}" | tr -sC 'A-Za-z0-9=,.@_\-' '-')
# Trim to 64 characters
AWS_CLI_STR_ROLE_SESSION_NAME=$(echo "${AWS_CLI_STR_ROLE_SESSION_NAME}" | cut -c -64)

if [ -z "${AWS_CLI_STR_ROLE_SESSION_NAME}" ]; then
echo "Role session name is required"
exit 1
Expand Down Expand Up @@ -40,17 +39,25 @@ $(aws sts assume-role-with-web-identity \
--output text)
EOF

temp_file="/tmp/${AWS_CLI_STR_PROFILE_NAME}.keys"
touch "$temp_file"

if [ -z "${AWS_ACCESS_KEY_ID}" ] || [ -z "${AWS_SECRET_ACCESS_KEY}" ] || [ -z "${AWS_SESSION_TOKEN}" ]; then
echo "Failed to assume role";
exit 1
elif [ "${AWS_CLI_BOOL_SET_AWS_ENV_VARS}" = 1 ]; then
{
echo "export AWS_CLI_STR_ACCESS_KEY_ID=\"${AWS_ACCESS_KEY_ID}\""
echo "export AWS_CLI_STR_SECRET_ACCESS_KEY=\"${AWS_SECRET_ACCESS_KEY}\""
echo "export AWS_CLI_STR_SESSION_TOKEN=\"${AWS_SESSION_TOKEN}\""
} >> "$BASH_ENV"

echo "AWS keys successfully written to BASH_ENV"
else
temp_file="/tmp/${AWS_CLI_STR_PROFILE_NAME}.keys"
touch "$temp_file"
{
echo "export AWS_CLI_STR_ACCESS_KEY_ID=\"${AWS_ACCESS_KEY_ID}\""
echo "export AWS_CLI_STR_SECRET_ACCESS_KEY=\"${AWS_SECRET_ACCESS_KEY}\""
echo "export AWS_CLI_STR_SESSION_TOKEN=\"${AWS_SESSION_TOKEN}\""
} >> "$temp_file"
echo "Assume role with web identity succeeded"
fi

echo "AWS keys successfully written to ${AWS_CLI_STR_PROFILE_NAME}.keys"
fi
7 changes: 5 additions & 2 deletions src/scripts/configure.sh
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,14 @@ AWS_CLI_STR_SECRET_ACCESS_KEY="$(echo "\$$AWS_CLI_STR_SECRET_ACCESS_KEY" | circl
AWS_CLI_STR_SESSION_TOKEN="$(echo "$AWS_CLI_STR_SESSION_TOKEN" | circleci env subst)"
AWS_CLI_STR_REGION="$(echo "$AWS_CLI_STR_REGION" | circleci env subst)"
AWS_CLI_STR_PROFILE_NAME="$(echo "$AWS_CLI_STR_PROFILE_NAME" | circleci env subst)"
AWS_CLI_BOOL_SET_AWS_ENV_VARS="$(echo "$AWS_CLI_BOOL_SET_AWS_ENV_VARS" | circleci env subst)"

if [ -z "$AWS_CLI_STR_ACCESS_KEY_ID" ] && [ -z "${AWS_CLI_STR_SECRET_ACCESS_KEY}" ]; then
if [ -z "$AWS_CLI_STR_ACCESS_KEY_ID" ] && [ -z "${AWS_CLI_STR_SECRET_ACCESS_KEY}" ] && [ "$AWS_CLI_BOOL_SET_AWS_ENV_VARS" = 0 ]; then
temp_file="/tmp/${AWS_CLI_STR_PROFILE_NAME}.keys"
. "$temp_file"
else
touch "${BASH_ENV}"
. "${BASH_ENV}"
fi

aws configure set aws_access_key_id \
Expand All @@ -33,4 +37,3 @@ if [ "$AWS_CLI_BOOL_CONFIG_PROFILE_REGION" -eq "1" ]; then
aws configure set region "$AWS_CLI_STR_REGION" \
--profile "$AWS_CLI_STR_PROFILE_NAME"
fi