在configure-aws-credentials中使用环境变量时OIDC认证失败的解决方案

问题背景

在使用GitHub Actions的aws-actions/configure-aws-credentials项目进行AWS凭证配置时，当工作流中指定了环境(environment)参数后，OpenID Connect(OIDC)认证会出现失败。具体表现为在执行AssumeRoleWithWebIdentity操作时返回"Not authorized"错误。

问题现象

用户在使用以下工作流配置时遇到了认证失败：

jobs:
  set-env:
    runs-on: ubuntu-latest
    permissions:
      id-token: write
      contents: read
    environment: develop  # 指定环境名称会导致OIDC失败
    steps:
      - name: Configure AWS credentials
        uses: aws-actions/configure-aws-credentials@v4
        with:
          aws-region: 'ap-northeast-1'
          role-session-name: samplerolesession
          role-to-assume: 'arn:aws:iam::xxxx:role/xxxxx'

当注释掉environment: develop这一行时，认证能够成功执行。

根本原因

这个问题的根源在于AWS IAM角色的信任策略配置不完整。当GitHub Actions工作流中指定了环境参数时，OIDC令牌中的sub声明(claim)会发生变化，格式变为：

repo:OWNER/REPOSITORY:environment:NAME

而不是没有环境参数时的简单格式：

repo:OWNER/REPOSITORY

如果IAM角色的信任策略中没有包含带环境名称的sub声明条件，AWS STS服务就会拒绝AssumeRoleWithWebIdentity请求。

解决方案

要解决这个问题，需要修改AWS IAM角色的信任策略，确保它包含带环境名称的sub声明条件。以下是正确的信任策略示例：

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Effect": "Allow",
      "Principal": {
        "Federated": "arn:aws:iam::ACCOUNT_ID:oidc-provider/token.actions.githubusercontent.com"
      },
      "Action": "sts:AssumeRoleWithWebIdentity",
      "Condition": {
        "StringLike": {
          "token.actions.githubusercontent.com:sub": [
            "repo:OWNER/REPOSITORY:*",
            "repo:OWNER/REPOSITORY:environment:DEVELOPMENT_ENV_NAME"
          ]
        }
      }
    }
  ]
}

最佳实践

1. 全面覆盖声明条件：在配置IAM信任策略时，应该考虑工作流可能使用的所有环境名称，或者使用通配符来匹配多个环境。

2. 最小权限原则：虽然可以使用通配符(*)来简化策略，但为了安全起见，建议明确列出允许的具体环境名称。

3. 环境命名规范：建立统一的环境命名规范，可以简化IAM策略的管理和维护。

4. 测试验证：在修改IAM策略后，应该使用实际的工作流进行测试，确保认证能够成功。

总结

在使用GitHub Actions的OIDC功能与AWS集成时，工作流中的环境参数会影响OIDC令牌的声明格式。开发人员需要确保AWS IAM角色的信任策略能够匹配这些变化的声明格式，特别是当工作流中包含环境参数时。通过正确配置信任策略，可以确保OIDC认证在各种工作流配置下都能正常工作。