aws-actions/configure-aws-credentials
1
0
Fork 0
mirror of https://github.com/aws-actions/configure-aws-credentials.git synced 2026-09-04 06:15:07 +09:00
Code Issues Packages Projects Releases Wiki Activity

chore: document forgejo compatibility (#1776)

Browse Source 
* chore: document forgejo compatibility

* chore: linting fixes
This commit is contained in:
Tom Keller
2026-05-13 15:49:18 -07:00
committed by GitHub
parent 3884f59ecd
commit f35a7d7d7e
1 changed files with 150 additions and 122 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+71 -43
View File
@@ -1,17 +1,16 @@
# Configure AWS Credentials # Configure AWS Credentials
Authenticate to AWS in GitHub Actions! Works especially well with Authenticate to AWS in GitHub Actions (and others)! Works especially well with
[AWS Secrets Manager][secretsmanager]. [AWS Secrets Manager][secretsmanager].
[secretsmanager]: [secretsmanager]: https://github.com/aws-actions/aws-secretsmanager-get-secrets
https://github.com/aws-actions/aws-secretsmanager-get-secrets
## Quick Start (OIDC, recommended) ## Quick Start (OIDC, recommended)
1. Create an IAM Identity Provider in your AWS account for GitHub OIDC. (See 1. Create an IAM Identity Provider in your AWS account for GitHub OIDC. (See
[OIDC configuration](#oidc-configuration-details) below for details.) [OIDC configuration](#oidc-configuration-details) below for details.)
2. Create an IAM Role in your AWS account with a trust policy that allows 2. Create an IAM Role in your AWS account with a trust policy that allows GitHub
GitHub Actions to assume it. (Expand the sections below) <details> Actions to assume it. (Expand the sections below) <details>
<summary>GitHub OIDC Trust Policy</summary> <summary>GitHub OIDC Trust Policy</summary>
```json ```json
@@ -69,9 +68,9 @@ Authenticate to AWS in GitHub Actions! Works especially well with
</details> </details>
That's it! Your GitHub Actions workflow can now access AWS resources using That's it! Your GitHub Actions workflow can now access AWS resources using the
the IAM Role you created. Other authentication scenarios are also supported IAM Role you created. Other authentication scenarios are also supported (see
(see below). below).
## Security Recommendations ## Security Recommendations
@@ -87,8 +86,8 @@ Authenticate to AWS in GitHub Actions! Works especially well with
of the credentials used in workflows. of the credentials used in workflows.
- Periodically rotate any long-lived credentials that you use. - Periodically rotate any long-lived credentials that you use.
- Store sensitive information in a secure way, such as using - Store sensitive information in a secure way, such as using
[AWS Secrets Manager](https://aws.amazon.com/secrets-manager/) or [AWS Secrets Manager](https://aws.amazon.com/secrets-manager/) or [GitHub
[GitHub Secrets][gh-secrets]. Secrets][gh-secrets].
- Be especially careful about running Actions in non-ephemeral environments, or - Be especially careful about running Actions in non-ephemeral environments, or
[triggering workflows on `pull_request_target`](https://docs.github.com/en/actions/reference/workflows-and-actions/events-that-trigger-workflows#pull_request_target) [triggering workflows on `pull_request_target`](https://docs.github.com/en/actions/reference/workflows-and-actions/events-that-trigger-workflows#pull_request_target)
events. events.
@@ -111,11 +110,12 @@ by specifying different inputs.
5. Use credentials stored in the Action environment to fetch temporary 5. Use credentials stored in the Action environment to fetch temporary
credentials via STS AssumeRole. credentials via STS AssumeRole.
Because we use the AWS JavaScript SDK, we always will use the Because we use the AWS JavaScript SDK, we always will use the [credential
[credential resolution flow for Node.js][cred-resolution]. resolution flow for Node.js][cred-resolution].
[cred-resolution]: [cred-resolution]:
https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/setting-credentials-node.html https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/setting-credentials-node.html
Depending on your inputs, the action might override parts of this flow. Depending on your inputs, the action might override parts of this flow.
<details> <details>
@@ -137,8 +137,8 @@ enabling this option._
Additionally, **`aws-region`** is always required. Additionally, **`aws-region`** is always required.
_Note: If you use GitHub Enterprise Server, you may need to adjust examples _Note: If you use GitHub Enterprise Server, you may need to adjust examples here
here to match your environment._ to match your environment._
## Additional Options ## Additional Options
@@ -151,7 +151,7 @@ detail.
<summary>Options list and descriptions</summary> <summary>Options list and descriptions</summary>
| Option | Description | Required | | Option | Description | Required |
| ----------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | | ----------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- |
| aws-region | Which AWS region to use | Yes | | aws-region | Which AWS region to use | Yes |
| aws-profile | Name of the AWS profile to configure. When provided, credentials are written to `~/.aws/credentials` and `~/.aws/config` files. This enables configuring multiple profiles in a single workflow. Name cannot contain whitespace, square brackets, or slashes. When set, credentials will not be exported as environment variables unless `output-env-credentials` is manually set to true. | No | | aws-profile | Name of the AWS profile to configure. When provided, credentials are written to `~/.aws/credentials` and `~/.aws/config` files. This enables configuring multiple profiles in a single workflow. Name cannot contain whitespace, square brackets, or slashes. When set, credentials will not be exported as environment variables unless `output-env-credentials` is manually set to true. | No |
| overwrite-aws-profile | Overwrite the given AWS profile if it already exists. When set to false or not set, an error will be thrown if the profile already exists. | No | | overwrite-aws-profile | Overwrite the given AWS profile if it already exists. When set to false or not set, an error will be thrown if the profile already exists. | No |
@@ -216,8 +216,8 @@ Profile names may not contain whitespace, square brackets, or forward or
backslashes. backslashes.
Writing to a profile will prevent credentials being written to the environment Writing to a profile will prevent credentials being written to the environment
by default. Use `output-env-credentials: true` if you would like the by default. Use `output-env-credentials: true` if you would like the credentials
credentials to also be exported as environment variables. to also be exported as environment variables.
By default, the action will not overwrite existing profiles. If you would like By default, the action will not overwrite existing profiles. If you would like
to overwrite a profile, set the `overwrite-aws-profile` input to `true`. to overwrite a profile, set the `overwrite-aws-profile` input to `true`.
@@ -232,8 +232,8 @@ extreme care to ensure that this is safe in your environment and you do not leak
valid credentials unintentionally. Writing to configuration files is intended valid credentials unintentionally. Writing to configuration files is intended
for unusual authentication scenarios._ for unusual authentication scenarios._
For using profiles with static IAM User Credentials or when using one For using profiles with static IAM User Credentials or when using one role to
role to assume another, role chaining is needed: assume another, role chaining is needed:
<details> <details>
@@ -254,9 +254,9 @@ specify the profile name as an environment variable in the job step:
AWS_PROFILE: MyProfile1 AWS_PROFILE: MyProfile1
``` ```
If you are using one role to assume another while using profiles, the If you are using one role to assume another while using profiles, the subsequent
subsequent steps must set `role-chaining: true` and specify the prior profile's steps must set `role-chaining: true` and specify the prior profile's name as
name as step environment variables: step environment variables:
```yaml ```yaml
- name: Configure AWS credentials - name: Configure AWS credentials
@@ -289,7 +289,7 @@ environment variable to `true`:
```yaml ```yaml
env: env:
AWS_SKIP_CLEANUP_STEP: 'true' AWS_SKIP_CLEANUP_STEP: "true"
``` ```
#### Use an HTTP proxy #### Use an HTTP proxy
@@ -322,11 +322,12 @@ HTTP_PROXY="http://companydomain.com:3128"
#### Special characters in AWS_SECRET_ACCESS_KEY #### Special characters in AWS_SECRET_ACCESS_KEY
Some edge cases are unable to properly parse an `AWS_SECRET_ACCESS_KEY` if it Some edge cases are unable to properly parse an `AWS_SECRET_ACCESS_KEY` if it
contains special characters. For more information, please see the contains special characters. For more information, please see the [AWS CLI
[AWS CLI documentation][aws-cli-troubleshooting]. documentation][aws-cli-troubleshooting].
[aws-cli-troubleshooting]: [aws-cli-troubleshooting]:
https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-troubleshooting.html#tshoot-signature-does-not-match https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-troubleshooting.html#tshoot-signature-does-not-match
If you set the `special-characters-workaround` option, this action will If you set the `special-characters-workaround` option, this action will
continually retry fetching credentials until we get one that does not have continually retry fetching credentials until we get one that does not have
special characters. This option overrides the `disable-retry` and special characters. This option overrides the `disable-retry` and
@@ -343,9 +344,8 @@ _Note: you might find it helpful to set the `role-session-name` to
`${{ github.run_id }}` so as to clarify in audit logs which AWS actions were `${{ github.run_id }}` so as to clarify in audit logs which AWS actions were
performed by which workflow run._ performed by which workflow run._
The session will be tagged with the following tags: (Refer to The session will be tagged with the following tags: (Refer to [GitHub's
[GitHub's documentation for `GITHUB_` environment variable documentation for `GITHUB_` environment variable definitions][gh-env-vars])
definitions][gh-env-vars])
[gh-env-vars]: [gh-env-vars]:
https://docs.github.com/en/actions/reference/workflows-and-actions/variables#default-environment-variables https://docs.github.com/en/actions/reference/workflows-and-actions/variables#default-environment-variables
@@ -363,10 +363,10 @@ overridden via `custom-tags`:
| Commit | GITHUB_SHA | | Commit | GITHUB_SHA |
| Branch | GITHUB_REF | | Branch | GITHUB_REF |
**Overrideable tags** are automatically added to the set of default session **Overrideable tags** are automatically added to the set of default session tags
tags but may be overridden via `custom-tags`. AWS has a maximum limit of 50 but may be overridden via `custom-tags`. AWS has a maximum limit of 50 session
session tags; tags from this list are dropped in reverse priority order if tags; tags from this list are dropped in reverse priority order if your
your `custom-tags` set plus the protected set exceeds this limit. `custom-tags` set plus the protected set exceeds this limit.
| Key | Value | Priority | | Key | Value | Priority |
| --------------- | ----------------------- | -------- | | --------------- | ----------------------- | -------- |
@@ -379,20 +379,24 @@ your `custom-tags` set plus the protected set exceeds this limit.
| Job | GITHUB_JOB | 7 | | Job | GITHUB_JOB | 7 |
| TriggeringActor | GITHUB_TRIGGERING_ACTOR | 8 | | TriggeringActor | GITHUB_TRIGGERING_ACTOR | 8 |
Tags whose source environment variable is unset are omitted (e.g., `BaseRef` Tags whose source environment variable is unset are omitted (e.g., `BaseRef` and
and `HeadRef` are only set on `pull_request` events). `HeadRef` are only set on `pull_request` events).
_Note: all tag values must conform to _Note: all tag values must conform to
[the tag requirements](https://docs.aws.amazon.com/STS/latest/APIReference/API_Tag.html). [the tag requirements][sts-tag-requirements].
Values longer than 256 characters will be truncated, and characters outside the Values longer than 256 characters will be truncated, and characters outside the
allowed set will be replaced with an underscore (`_`)._ allowed set will be replaced with an underscore (`_`).\_
[sts-tag-requirements]:
https://docs.aws.amazon.com/STS/latest/APIReference/API_Tag.html
The action will use session tagging by default unless you are using OIDC. The action will use session tagging by default unless you are using OIDC.
To [forward session tags to subsequent sessions in a role To [forward session tags to subsequent sessions in a role
chain][session-tag-chaining], you can use chain][session-tag-chaining], you can use
[session-tag-chaining]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html#id_session-tags_role-chaining [session-tag-chaining]:
https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html#id_session-tags_role-chaining
the `transitive-tag-keys` input to specify the keys of the tags to be passed. the `transitive-tag-keys` input to specify the keys of the tags to be passed.
@@ -566,11 +570,12 @@ aws iam create-open-id-connect-provider \
### Claims and scoping permissions ### Claims and scoping permissions
To align with the Amazon IAM best practice of To align with the Amazon IAM best practice of [granting least
[granting least privilege][least-privilege], privilege][least-privilege],
[least-privilege]: [least-privilege]:
https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#grant-least-privilege https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#grant-least-privilege
the assume role policy document should contain a the assume role policy document should contain a
[`Condition`](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_condition.html) [`Condition`](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_condition.html)
that specifies a subject (`sub`) allowed to assume the role. that specifies a subject (`sub`) allowed to assume the role.
@@ -594,11 +599,11 @@ action to your workflow to see the value of the subject (`sub`) key, as well as
other claims. other claims.
Additional claim conditions can be added for higher specificity as explained in Additional claim conditions can be added for higher specificity as explained in
the the [GitHub documentation][gh-oidc-hardening].
[GitHub documentation][gh-oidc-hardening].
[gh-oidc-hardening]: [gh-oidc-hardening]:
https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect
Due to implementation details, not every OIDC claim is presently supported by Due to implementation details, not every OIDC claim is presently supported by
IAM. IAM.
@@ -612,6 +617,28 @@ For further information on OIDC and GitHub Actions, please see:
- [GitHub docs: Configuring OpenID Connect in Amazon Web Services](https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-amazon-web-services) - [GitHub docs: Configuring OpenID Connect in Amazon Web Services](https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-amazon-web-services)
- [GitHub changelog: GitHub Actions: Secure cloud deployments with OpenID Connect](https://github.blog/changelog/2021-10-27-github-actions-secure-cloud-deployments-with-openid-connect/) - [GitHub changelog: GitHub Actions: Secure cloud deployments with OpenID Connect](https://github.blog/changelog/2021-10-27-github-actions-secure-cloud-deployments-with-openid-connect/)
## Compatibility with non-GitHub Actions environments
This action has been sucessfully tested with
Codeberg/[Forgejo Actions](https://forgejo.org/docs/next/user/actions/overview/)
and should be generally compatible with any CI/CD environment that sets the
correct `GITHUB_` environment variables. For use with Foregejo, please review
the
[runner differences with GitHub's action runners][forgejo-gh-differences].
[forgejo-gh-differences]:
https://forgejo.org/docs/next/user/actions/github-actions/#known-list-of-differences
The main difference to be aware of is that Forgejo uses the
`enable-openid-connect` flag to enable OIDC instad of GitHub's `id-token: write`
permission. Forgejo also uses a slightly different syntax for the workflow
definition file, omitting some subkeys.
For OIDC use, the issuer name for the IAM IdP for GitHub Actions is
`token.actions.githubusercontent.com`. For Forgejo Actions it is
`[foregejo instance url]/api/actions`. As an example, Codeberg would use
`codeberg.org/api/actions` as the issuer URL when configuring the IAM Identity
Provider. The audience would still be `sts.amazonaws.com` by default.
## Examples ## Examples
### AssumeRoleWithWebIdentity ### AssumeRoleWithWebIdentity
@@ -741,8 +768,8 @@ and passed to this action.
This example shows how to configure multiple named AWS profiles in a single This example shows how to configure multiple named AWS profiles in a single
workflow. When using the `aws-profile` input, credentials are written to workflow. When using the `aws-profile` input, credentials are written to
`~/.aws/credentials` and `~/.aws/config` files, allowing you to reference `~/.aws/credentials` and `~/.aws/config` files, allowing you to reference
different profiles using the `--profile` flag with AWS CLI, SDKs, CDK, and different profiles using the `--profile` flag with AWS CLI, SDKs, CDK, and other
other tools. tools.
Each profile is independent and can authenticate to different AWS accounts or Each profile is independent and can authenticate to different AWS accounts or
use different roles. This is particularly useful for multi-account deployments use different roles. This is particularly useful for multi-account deployments
@@ -755,6 +782,7 @@ Starting with version 5.0.0, this action uses semantic-style release tags and
[immutable-releases]: [immutable-releases]:
https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/immutable-releases https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/immutable-releases
A floating version tag (vN) is also provided for convenience: this tag will move A floating version tag (vN) is also provided for convenience: this tag will move
to the latest major version (vN -> vN.2.1, vM -> vM.0.0, etc.). to the latest major version (vN -> vN.2.1, vM -> vM.0.0, etc.).