• ID 토큰
  • 토큰 페이로드
• 수동 ID 토큰 인증
• HashiCorp Vault를 사용한 자동 ID 토큰 인증
  • 자동 ID 토큰 인증 구성
• 문제 해결
  • 400: missing token 상태 코드
    • GitLab::Ci::Jwt::NoSigningKeyError

OpenID Connect (OIDC)를 사용한 ID 토큰 인증

• GitLab 15.7에 도입되었습니다.

GitLab CI/CD의 ID 토큰을 사용하여 타사 서비스로 인증할 수 있습니다.

ID 토큰

ID 토큰은 GitLab CI/CD 작업에 추가할 수 있는 JSON Web Tokens (JWTs)입니다. 이 토큰은 타사 서비스와의 OIDC 인증에 사용되며, HashiCorp Vault와의 인증에 secrets 키워드에 의해 사용됩니다.

ID 토큰은 .gitlab-ci.yml에서 구성됩니다. 예를 들어:

job_with_id_tokens:
  id_tokens:
    FIRST_ID_TOKEN:
      aud: https://first.service.com
    SECOND_ID_TOKEN:
      aud: https://second.service.com
  script:
    - first-service-authentication-script.sh $FIRST_ID_TOKEN
    - second-service-authentication-script.sh $SECOND_ID_TOKEN

이 예에서 두 토큰은 다른 aud 클레임을 가지고 있습니다. 타사 서비스는 바인딩된 오디언스와 일치하지 않는 토큰을 거부하도록 구성될 수 있습니다. 이 기능을 사용하여 토큰이 인증할 수 있는 서비스의 수를 줄이세요. 이렇게 하면 토큰이 노출되었을 때 심각도가 낮아집니다.

토큰 페이로드

다음의 표준 클레임이 각 ID 토큰에 포함됩니다:

토큰에는 GitLab에서 제공하는 사용자 지정 클레임도 포함됩니다:

{
  "namespace_id": "72",
  "namespace_path": "my-group",
  "project_id": "20",
  "project_path": "my-group/my-project",
  "user_id": "1",
  "user_login": "sample-user",
  "user_email": "sample-user@example.com",
  "user_identities": [
      {"provider": "github", "extern_uid": "2435223452345"},
      {"provider": "bitbucket", "extern_uid": "john.smith"},
  ],
  "pipeline_id": "574",
  "pipeline_source": "push",
  "job_id": "302",
  "ref": "feature-branch-1",
  "ref_type": "branch",
  "ref_path": "refs/heads/feature-branch-1",
  "ref_protected": "false",
  "groups_direct": ["mygroup/mysubgroup", "myothergroup/myothersubgroup"],
  "environment": "test-environment2",
  "environment_protected": "false",
  "deployment_tier": "testing",
  "environment_action": "start",
  "runner_id": 1,
  "runner_environment": "self-hosted",
  "sha": "714a629c0b401fdce83e847fc9589983fc6f46bc",
  "project_visibility": "public",
  "ci_config_ref_uri": "gitlab.example.com/my-group/my-project//.gitlab-ci.yml@refs/heads/main",
  "ci_config_sha": "714a629c0b401fdce83e847fc9589983fc6f46bc",
  "jti": "235b3a54-b797-45c7-ae9a-f72d7bc6ef5b",
  "iss": "https://gitlab.example.com",
  "iat": 1681395193,
  "nbf": 1681395188,
  "exp": 1681398793,
  "sub": "project_path:my-group/my-project:ref_type:branch:ref:feature-branch-1",
  "aud": "https://vault.example.com"
}

ID 토큰은 RS256을 사용하여 인코딩되며 별도의 개인 키로 서명됩니다. 토큰의 만료 시간은 작업의 타임아웃이 지정된 경우 해당 시간으로 설정되거나 타임아웃이 지정되지 않은 경우 5분으로 설정됩니다.

수동 ID 토큰 인증

여러분은 ID 토큰을 사용하여 OIDC 인증을 위해 제3자 서비스에서 사용할 수 있습니다. 예를 들어:

manual_authentication:
  variables:
    VAULT_ADDR: http://vault.example.com:8200
  image: vault:latest
  id_tokens:
    VAULT_ID_TOKEN:
      aud: http://vault.example.com
  script:
    - export VAULT_TOKEN="$(vault write -field=token auth/jwt/login role=myproject-example jwt=$VAULT_ID_TOKEN)"
    - export PASSWORD="$(vault kv get -field=password secret/myproject/example/db)"
    - my-authentication-script.sh $VAULT_TOKEN $PASSWORD

HashiCorp Vault를 사용한 자동 ID 토큰 인증

secrets 키워드를 사용하여 HashiCorp Vault에서 비밀을 자동으로 가져오려면 ID 토큰을 사용할 수 있습니다.

이전에 CI_JOB_JWT를 사용하여 Vault에서 비밀을 가져왔다면, HashiCorp Vault 구성을 ID 토큰 사용으로 변경 튜토리얼에서 ID 토큰으로 전환하는 방법을 알아보세요.

자동 ID 토큰 인증 구성

하나의 ID 토큰이 정의된 경우, secrets 키워드는 자동으로 해당 토큰을 사용하여 Vault와 인증합니다. 예를 들어:

job_with_secrets:
  id_tokens:
    VAULT_ID_TOKEN:
      aud: https://vault.example.com
  secrets:
    PROD_DB_PASSWORD:
      vault: example/db/password # $VAULT_ID_TOKEN을 사용하여 인증
  script:
    - access-prod-db.sh --token $PROD_DB_PASSWORD

하나 이상의 ID 토큰이 정의된 경우, token 키워드를 사용하여 사용할 토큰을 지정합니다. 예를 들어:

job_with_secrets:
  id_tokens:
    FIRST_ID_TOKEN:
      aud: https://first.service.com
    SECOND_ID_TOKEN:
      aud: https://second.service.com
  secrets:
    FIRST_DB_PASSWORD:
      vault: first/db/password
      token: $FIRST_ID_TOKEN
    SECOND_DB_PASSWORD:
      vault: second/db/password
      token: $SECOND_ID_TOKEN
  script:
    - access-first-db.sh --token $FIRST_DB_PASSWORD
    - access-second-db.sh --token $SECOND_DB_PASSWORD

문제 해결

400: missing token 상태 코드

이 오류는 ID 토큰에 필요한 하나 이상의 기본 구성 요소가 누락되었거나 예상대로 구성되지 않았음을 나타냅니다.

문제를 찾기 위해 관리자는 해당 메소드에 대한 더 많은 세부 정보를 확인할 수 있도록 인스턴스의 exceptions_json.log에서 자세히 살펴봐야 합니다.

GitLab::Ci::Jwt::NoSigningKeyError

exceptions_json.log 파일에 있는 이 오류는 서명 키가 데이터베이스에 없어서 토큰을 생성할 수 없기 때문일 가능성이 높습니다. 문제를 확인하려면 인스턴스의 PostgreSQL 터미널에서 다음 쿼리를 실행하십시오:

SELECT encrypted_ci_jwt_signing_key FROM application_settings;

반환된 값이 비어 있다면, 아래의 Rails 스니펫을 사용하여 새 키를 생성하고 내부적으로 교체하십시오:

  key = OpenSSL::PKey::RSA.new(2048).to_pem

  ApplicationSetting.find_each do |application_setting|
    application_setting.update(ci_jwt_signing_key: key)
  end