InfoGrab DocsInfoGrab Docs

외부 도구에서 시크릿에 접근

요약

Secrets Manager API를 사용하면 Kubernetes 애플리케이션이나 코드형 인프라 도구 같은 외부 애플리케이션과 도구에서 GitLab Secrets Manager 시크릿을 읽을 수 있습니다. 클라이언트가 액세스 토큰을 발급받은 뒤에는 GitLab 애플리케이션을 거치지 않고 OpenBao 백엔드에서 직접 시크릿을 읽습니다.

히스토리
  • GitLab 19.2에서 secrets_manager_api_access라는 플래그와 함께 도입되었습니다. 기본적으로 비활성화되어 있습니다.

Secrets Manager API를 사용하면 Kubernetes 애플리케이션이나 코드형 인프라 도구 같은 외부 애플리케이션과 도구에서 GitLab Secrets Manager 시크릿을 읽을 수 있습니다. CI/CD 작업에서 시크릿을 읽으려면 작업 스크립트에서 시크릿 사용을 참고합니다.

클라이언트가 액세스 토큰을 발급받은 뒤에는 GitLab 애플리케이션을 거치지 않고 OpenBao 백엔드에서 직접 시크릿을 읽습니다. 액세스 토큰을 발급받으려면 GitLab API가 필요합니다.

액세스 토큰 흐름#

  1. 클라이언트가 Secrets Manager API를 호출할 수 있는 토큰으로 GitLab에 인증합니다. 지원되는 토큰 유형은 사전 요구 사항을 참고합니다.
  2. 클라이언트가 Secrets Manager API를 호출해 수명이 짧은 액세스 토큰을 발급받습니다. 이 액세스 토큰은 GitLab 액세스 토큰이 아니라 OpenBao용 JSON 웹 토큰(JWT)입니다. 응답에는 JWT와 OpenBao 연결 정보가 포함됩니다.
  3. 클라이언트가 JWT를 OpenBao 토큰으로 교환한 다음, 그 OpenBao 토큰으로 시크릿 값을 읽습니다. 또는 인라인 인증을 사용해 요청마다 JWT를 보낼 수도 있습니다.

JWT와 OpenBao 토큰은 각각 5분 후에 만료됩니다. OpenBao는 Vault API를 구현하므로 HashiCorp Vault와 호환되는 모든 클라이언트를 사용할 수 있습니다.

모든 OpenBao 연결 정보는 발급 응답에서 얻으므로 네임스페이스, 마운트, 인증 경로를 직접 구성하지 않습니다.

사전 요구 사항#

  • GitLab Secrets Manager가 활성화되어 있어야 합니다.
  • Secrets Manager가 GitLab 19.2 이상에서 프로비저닝되었어야 합니다.
  • 다음 중 하나로 인증합니다.
  • 권한이 Reporter 이상이어야 합니다.
  • 값 읽기 권한이 있어야 합니다. 프로젝트 Owner(그룹 시크릿의 경우 그룹 Owner)가 이 권한을 부여할 수 있습니다. 시크릿 권한 관리를 참고합니다.
Note

GitLab 19.2 이전에 프로비저닝된 Secrets Manager는 외부 요청이나 서비스의 접근을 지원하지 않습니다. 외부 접근을 활성화하려면 외부 요청의 시크릿 접근 활성화를 참고합니다.

서비스 계정으로 인증#

사전 요구 사항:

  • 서비스 계정을 만들 수 있는 권한.
  • 시크릿 권한을 부여하기 위한 프로젝트 또는 그룹에 대한 Owner 권한.

서비스 계정으로 인증하려면 다음을 수행합니다.

  1. 서비스 계정을 만듭니다.
  2. 서비스 계정의 개인 액세스 토큰을 만듭니다. 범위는 api입니다.
  3. 서비스 계정을 Reporter 이상의 권한으로 프로젝트 또는 그룹에 추가합니다.
  4. 서비스 계정에 값 읽기 권한을 부여합니다.

시크릿 읽기#

이 예시는 프로젝트의 액세스 토큰을 발급받고, OpenBao에 인증한 뒤 시크릿 값을 읽습니다. 그룹의 시크릿을 읽으려면 projects/<project_id> 대신 groups/<group_id>로 그룹 엔드포인트를 호출합니다.

  1. 액세스 토큰을 발급받습니다.

    RESPONSE=$(curl --silent --request POST \
      --header "PRIVATE-TOKEN: <your_access_token>" \
      --url "https://gitlab.example.com/api/v4/projects/<project_id>/secrets_manager/access_token")
    

    응답에는 expires_at 타임스탬프와, server, namespace, path, secrets_path, auth.jwt 정보가 있는 provider.vault 객체가 들어 있습니다. JWT는 provider.vault.auth.jwt.token에 있습니다.

  2. JWT를 OpenBao 토큰으로 교환한 다음 값을 읽습니다.

    SERVER=$(echo "$RESPONSE" | jq --raw-output .provider.vault.server)
    NAMESPACE=$(echo "$RESPONSE" | jq --raw-output .provider.vault.namespace)
    MOUNT=$(echo "$RESPONSE" | jq --raw-output .provider.vault.path)
    SECRETS_PATH=$(echo "$RESPONSE" | jq --raw-output .provider.vault.secrets_path)
    AUTH_PATH=$(echo "$RESPONSE" | jq --raw-output .provider.vault.auth.jwt.path)
    ROLE=$(echo "$RESPONSE" | jq --raw-output .provider.vault.auth.jwt.role)
    JWT=$(echo "$RESPONSE" | jq --raw-output .provider.vault.auth.jwt.token)
    
    # Exchange the JWT for a short-lived OpenBao token.
    VAULT_TOKEN=$(curl --silent --request POST \
      --header "X-Vault-Namespace: $NAMESPACE" \
      --data "{\"role\":\"$ROLE\",\"jwt\":\"$JWT\"}" \
      "$SERVER/v1/auth/$AUTH_PATH/login" | jq --raw-output .auth.client_token)
    
    # Read the secret value.
    curl --silent \
      --header "X-Vault-Token: $VAULT_TOKEN" \
      --header "X-Vault-Namespace: $NAMESPACE" \
      "$SERVER/v1/$MOUNT/data/$SECRETS_PATH/<secret_name>"
    

GitLab.com에서 server는 https://secrets.gitlab.com입니다. GitLab Self-Managed에서 server는 인스턴스에 구성된 OpenBao URL입니다.

전체 요청 및 응답 형식은 Secrets Manager API를 참고합니다.

Vault CLI와 함께 사용#

OpenBao는 Vault API를 구현하므로 응답의 값과 함께 Vault CLI를 사용할 수 있습니다.

export VAULT_ADDR="<server>"
export VAULT_NAMESPACE="<namespace>"

# Exchange the minted JWT for an OpenBao token.
export VAULT_TOKEN="$(vault write -field=token "auth/<auth_jwt_path>/login" role=<role> jwt=<auth_jwt_token>)"

# Read the secret value.
vault kv get -mount=<path> "<secrets_path>/<secret_name>"

External Secrets Operator와 함께 사용#

External Secrets Operator는 HashiCorp Vault 프로바이더를 통해 GitLab 시크릿을 Kubernetes 시크릿으로 동기화합니다. 클러스터의 CronJob 같은 워크로드가 Kubernetes 시크릿에 최신 액세스 토큰을 유지하고, 오퍼레이터가 그 토큰을 읽어 OpenBao에 인증합니다.

발급 응답을 SecretStore에 대응시키고, 각 시크릿은 <secrets_path>/<secret_name>으로 참조합니다.

apiVersion: external-secrets.io/v1
kind: SecretStore
metadata:
  name: gitlab-secrets-manager
  namespace: my-app
spec:
  provider:
    vault:
      server: https://secrets.gitlab.com     # provider.vault.server
      path: secrets/kv                        # provider.vault.path
      version: v2
      namespace: org_5/group_42/project_99    # provider.vault.namespace
      auth:
        jwt:
          path: api_jwt/cel                   # provider.vault.auth.jwt.path
          role: all_api                       # provider.vault.auth.jwt.role
          secretRef:
            name: gitlab-access-token         # Kubernetes secret holding the minted token
            key: token
---
apiVersion: external-secrets.io/v1
kind: ExternalSecret
metadata:
  name: my-secret
  namespace: my-app
spec:
  refreshInterval: 1m
  secretStoreRef:
    name: gitlab-secrets-manager
    kind: SecretStore
  target:
    name: synced-secret
  data:
    - secretKey: value
      remoteRef:
        key: explicit/<secret_name>           # <secrets_path>/<secret_name>
        property: value

액세스 토큰은 5분 후에 만료되므로 워크로드는 만료되기 전에 gitlab-access-token Kubernetes 시크릿을 갱신해야 합니다.

네이티브 Kubernetes 통합은 에픽 20382에서 제안되었습니다.

인증 흐름#

External Secrets Operator의 인증 흐름은 다음 다이어그램에서 확인할 수 있습니다.

Mermaid 다이어그램 (24줄)
소스 코드 보기
sequenceDiagram
    accTitle: Access token flow between Workload refresher, Secrets Manager API, ESO, and OpenBao
    accDescr: A workload refresher mints a short-lived access token and stores it in a Kubernetes secret. ESO reads the token, authenticates to OpenBao with it, reads the secret value, and writes it to a synced Kubernetes secret on each sync interval.
    participant W as Workload <br/> refresher
    participant API as Secrets Manager API
    participant KAuth as K8s Secret <br/> auth token
    participant ESO as ESO
    participant OB as OpenBao
    participant KApp as K8s Secret <br/> synced
W-&gt;&gt;API: Mint access token
API--&gt;&gt;W: Short-lived token
W-&gt;&gt;KAuth: Store token

loop Sync interval
    ESO-&gt;&gt;KAuth: Read token
    ESO-&gt;&gt;OB: JWT login
    OB--&gt;&gt;ESO: Client token
    ESO-&gt;&gt;OB: Read KV path
    OB--&gt;&gt;ESO: Secret value
    ESO-&gt;&gt;KApp: Write value
end

Note over W,API: Access token expires in 5 min</code></pre></details></div>

Terraform과 함께 사용#

Terraform 또는 OpenTofu 구성에서 GitLab 시크릿을 데이터 소스로 읽을 수 있습니다. Terraform은 액세스 토큰을 직접 발급받을 수 없으므로 external 데이터 소스가 Secrets Manager API를 호출하는 스크립트를 실행해 provider.vault 연결 정보를 반환합니다. 그런 다음 Vault 프로바이더가 발급받은 JWT로 인증하고 시크릿을 읽습니다.

스크립트는 토큰을 발급받고 연결 정보를 JSON으로 출력합니다. GitLab 토큰은 GITLAB_TOKEN 환경 변수에서 읽습니다. 그룹의 시크릿을 읽으려면 projects/<project_id> 대신 groups/<group_id>로 그룹 엔드포인트를 호출합니다.

#!/usr/bin/env bash
# scripts/mint_token.sh
set -euo pipefail
eval "$(jq --raw-output '@sh "PROJECT_ID=\(.project_id)"')"

curl --silent --request POST \
  --header "PRIVATE-TOKEN: ${GITLAB_TOKEN}" \
  --url "https://gitlab.example.com/api/v4/projects/${PROJECT_ID}/secrets_manager/access_token" \
  | jq '{
      server:       .provider.vault.server,
      namespace:    .provider.vault.namespace,
      mount:        .provider.vault.path,
      secrets_path: .provider.vault.secrets_path,
      auth_path:    .provider.vault.auth.jwt.path,
      role:         .provider.vault.auth.jwt.role,
      jwt:          .provider.vault.auth.jwt.token
    }'

external 데이터 소스에서 스크립트를 참조하고, Vault 프로바이더를 구성한 다음, 임시 리소스로 시크릿을 읽습니다.

data "external" "gitlab_secrets_token" {
  program = ["bash", "${path.module}/scripts/mint_token.sh"]

  query = {
    project_id = var.gitlab_project_id
  }
}

provider "vault" {
  address          = data.external.gitlab_secrets_token.result.server
  namespace        = data.external.gitlab_secrets_token.result.namespace
  skip_child_token = true

  auth_login_jwt {
    mount = data.external.gitlab_secrets_token.result.auth_path
    role  = data.external.gitlab_secrets_token.result.role
    jwt   = data.external.gitlab_secrets_token.result.jwt
  }
}

ephemeral "vault_kv_secret_v2" "my_secret" {
  mount = data.external.gitlab_secrets_token.result.mount
  name  = "${data.external.gitlab_secrets_token.result.secrets_path}/<secret_name>"
}

# Pass the value to a provider configuration or a write-only argument, for example:
# password_wo = ephemeral.vault_kv_secret_v2.my_secret.data["value"]

Vault 프로바이더에서 skip_child_token = true로 설정합니다. 기본적으로 프로바이더는 JWT 로그인으로 얻은 OpenBao 토큰으로 하위 토큰을 만들지만, 그 OpenBao 토큰은 하위 토큰을 만들 수 없습니다. 이 설정이 없으면 프로바이더가 403 오류와 failed to create limited child token 메시지와 함께 실패합니다.

임시 리소스에는 Terraform 1.10 이상 또는 OpenTofu 1.11 이상, 그리고 Vault 프로바이더 5.0 이상이 필요합니다. Terraform과 OpenTofu는 이 값을 상태 파일이나 플랜 파일에 저장하지 않습니다. 이전 버전에서는 대신 vault_kv_secret_v2 데이터 소스를 사용합니다. 데이터 소스는 시크릿 값을 상태에 평문으로 저장하므로 상태에 대한 접근을 제한합니다.

발급받은 JWT는 5분 동안 유효합니다.

  • Vault 프로바이더는 실행 시작 후 5분 이내에 시크릿을 읽어야 합니다. 프로바이더는 실행을 시작할 때가 아니라 시크릿을 처음 읽을 때 OpenBao에 인증합니다.
  • terraform plan -out으로 플랜을 저장했다면 5분 이내에 적용합니다. 적용하는 동안 Terraform은 플랜에 있는 JWT로 임시 리소스를 다시 읽습니다.

네이티브 GitLab Terraform 프로바이더 통합은 에픽 21177에서 제안되었습니다.

외부 도구에서 시크릿에 접근

GitLab v19.6
Tier: Premium, Ultimate
Offering: GitLab.com, GitLab Self-Managed
원문 보기

요약

Secrets Manager API를 사용하면 Kubernetes 애플리케이션이나 코드형 인프라 도구 같은 외부 애플리케이션과 도구에서 GitLab Secrets Manager 시크릿을 읽을 수 있습니다. 클라이언트가 액세스 토큰을 발급받은 뒤에는 GitLab 애플리케이션을 거치지 않고 OpenBao 백엔드에서 직접 시크릿을 읽습니다.

히스토리
  • GitLab 19.2에서 secrets_manager_api_access라는 플래그와 함께 도입되었습니다. 기본적으로 비활성화되어 있습니다.

Secrets Manager API를 사용하면 Kubernetes 애플리케이션이나 코드형 인프라 도구 같은 외부 애플리케이션과 도구에서 GitLab Secrets Manager 시크릿을 읽을 수 있습니다. CI/CD 작업에서 시크릿을 읽으려면 작업 스크립트에서 시크릿 사용을 참고합니다.

클라이언트가 액세스 토큰을 발급받은 뒤에는 GitLab 애플리케이션을 거치지 않고 OpenBao 백엔드에서 직접 시크릿을 읽습니다. 액세스 토큰을 발급받으려면 GitLab API가 필요합니다.

액세스 토큰 흐름#

  1. 클라이언트가 Secrets Manager API를 호출할 수 있는 토큰으로 GitLab에 인증합니다. 지원되는 토큰 유형은 사전 요구 사항을 참고합니다.
  2. 클라이언트가 Secrets Manager API를 호출해 수명이 짧은 액세스 토큰을 발급받습니다. 이 액세스 토큰은 GitLab 액세스 토큰이 아니라 OpenBao용 JSON 웹 토큰(JWT)입니다. 응답에는 JWT와 OpenBao 연결 정보가 포함됩니다.
  3. 클라이언트가 JWT를 OpenBao 토큰으로 교환한 다음, 그 OpenBao 토큰으로 시크릿 값을 읽습니다. 또는 인라인 인증을 사용해 요청마다 JWT를 보낼 수도 있습니다.

JWT와 OpenBao 토큰은 각각 5분 후에 만료됩니다. OpenBao는 Vault API를 구현하므로 HashiCorp Vault와 호환되는 모든 클라이언트를 사용할 수 있습니다.

모든 OpenBao 연결 정보는 발급 응답에서 얻으므로 네임스페이스, 마운트, 인증 경로를 직접 구성하지 않습니다.

사전 요구 사항#

  • GitLab Secrets Manager가 활성화되어 있어야 합니다.
  • Secrets Manager가 GitLab 19.2 이상에서 프로비저닝되었어야 합니다.
  • 다음 중 하나로 인증합니다.
  • 권한이 Reporter 이상이어야 합니다.
  • 값 읽기 권한이 있어야 합니다. 프로젝트 Owner(그룹 시크릿의 경우 그룹 Owner)가 이 권한을 부여할 수 있습니다. 시크릿 권한 관리를 참고합니다.
Note

GitLab 19.2 이전에 프로비저닝된 Secrets Manager는 외부 요청이나 서비스의 접근을 지원하지 않습니다. 외부 접근을 활성화하려면 외부 요청의 시크릿 접근 활성화를 참고합니다.

서비스 계정으로 인증#

사전 요구 사항:

  • 서비스 계정을 만들 수 있는 권한.
  • 시크릿 권한을 부여하기 위한 프로젝트 또는 그룹에 대한 Owner 권한.

서비스 계정으로 인증하려면 다음을 수행합니다.

  1. 서비스 계정을 만듭니다.
  2. 서비스 계정의 개인 액세스 토큰을 만듭니다. 범위는 api입니다.
  3. 서비스 계정을 Reporter 이상의 권한으로 프로젝트 또는 그룹에 추가합니다.
  4. 서비스 계정에 값 읽기 권한을 부여합니다.

시크릿 읽기#

이 예시는 프로젝트의 액세스 토큰을 발급받고, OpenBao에 인증한 뒤 시크릿 값을 읽습니다. 그룹의 시크릿을 읽으려면 projects/<project_id> 대신 groups/<group_id>로 그룹 엔드포인트를 호출합니다.

  1. 액세스 토큰을 발급받습니다.

    RESPONSE=$(curl --silent --request POST \
      --header "PRIVATE-TOKEN: <your_access_token>" \
      --url "https://gitlab.example.com/api/v4/projects/<project_id>/secrets_manager/access_token")
    

    응답에는 expires_at 타임스탬프와, server, namespace, path, secrets_path, auth.jwt 정보가 있는 provider.vault 객체가 들어 있습니다. JWT는 provider.vault.auth.jwt.token에 있습니다.

  2. JWT를 OpenBao 토큰으로 교환한 다음 값을 읽습니다.

    SERVER=$(echo "$RESPONSE" | jq --raw-output .provider.vault.server)
    NAMESPACE=$(echo "$RESPONSE" | jq --raw-output .provider.vault.namespace)
    MOUNT=$(echo "$RESPONSE" | jq --raw-output .provider.vault.path)
    SECRETS_PATH=$(echo "$RESPONSE" | jq --raw-output .provider.vault.secrets_path)
    AUTH_PATH=$(echo "$RESPONSE" | jq --raw-output .provider.vault.auth.jwt.path)
    ROLE=$(echo "$RESPONSE" | jq --raw-output .provider.vault.auth.jwt.role)
    JWT=$(echo "$RESPONSE" | jq --raw-output .provider.vault.auth.jwt.token)
    
    # Exchange the JWT for a short-lived OpenBao token.
    VAULT_TOKEN=$(curl --silent --request POST \
      --header "X-Vault-Namespace: $NAMESPACE" \
      --data "{\"role\":\"$ROLE\",\"jwt\":\"$JWT\"}" \
      "$SERVER/v1/auth/$AUTH_PATH/login" | jq --raw-output .auth.client_token)
    
    # Read the secret value.
    curl --silent \
      --header "X-Vault-Token: $VAULT_TOKEN" \
      --header "X-Vault-Namespace: $NAMESPACE" \
      "$SERVER/v1/$MOUNT/data/$SECRETS_PATH/<secret_name>"
    

GitLab.com에서 server는 https://secrets.gitlab.com입니다. GitLab Self-Managed에서 server는 인스턴스에 구성된 OpenBao URL입니다.

전체 요청 및 응답 형식은 Secrets Manager API를 참고합니다.

Vault CLI와 함께 사용#

OpenBao는 Vault API를 구현하므로 응답의 값과 함께 Vault CLI를 사용할 수 있습니다.

export VAULT_ADDR="<server>"
export VAULT_NAMESPACE="<namespace>"

# Exchange the minted JWT for an OpenBao token.
export VAULT_TOKEN="$(vault write -field=token "auth/<auth_jwt_path>/login" role=<role> jwt=<auth_jwt_token>)"

# Read the secret value.
vault kv get -mount=<path> "<secrets_path>/<secret_name>"

External Secrets Operator와 함께 사용#

External Secrets Operator는 HashiCorp Vault 프로바이더를 통해 GitLab 시크릿을 Kubernetes 시크릿으로 동기화합니다. 클러스터의 CronJob 같은 워크로드가 Kubernetes 시크릿에 최신 액세스 토큰을 유지하고, 오퍼레이터가 그 토큰을 읽어 OpenBao에 인증합니다.

발급 응답을 SecretStore에 대응시키고, 각 시크릿은 <secrets_path>/<secret_name>으로 참조합니다.

apiVersion: external-secrets.io/v1
kind: SecretStore
metadata:
  name: gitlab-secrets-manager
  namespace: my-app
spec:
  provider:
    vault:
      server: https://secrets.gitlab.com     # provider.vault.server
      path: secrets/kv                        # provider.vault.path
      version: v2
      namespace: org_5/group_42/project_99    # provider.vault.namespace
      auth:
        jwt:
          path: api_jwt/cel                   # provider.vault.auth.jwt.path
          role: all_api                       # provider.vault.auth.jwt.role
          secretRef:
            name: gitlab-access-token         # Kubernetes secret holding the minted token
            key: token
---
apiVersion: external-secrets.io/v1
kind: ExternalSecret
metadata:
  name: my-secret
  namespace: my-app
spec:
  refreshInterval: 1m
  secretStoreRef:
    name: gitlab-secrets-manager
    kind: SecretStore
  target:
    name: synced-secret
  data:
    - secretKey: value
      remoteRef:
        key: explicit/<secret_name>           # <secrets_path>/<secret_name>
        property: value

액세스 토큰은 5분 후에 만료되므로 워크로드는 만료되기 전에 gitlab-access-token Kubernetes 시크릿을 갱신해야 합니다.

네이티브 Kubernetes 통합은 에픽 20382에서 제안되었습니다.

인증 흐름#

External Secrets Operator의 인증 흐름은 다음 다이어그램에서 확인할 수 있습니다.

Mermaid 다이어그램 (24줄)
소스 코드 보기
sequenceDiagram
    accTitle: Access token flow between Workload refresher, Secrets Manager API, ESO, and OpenBao
    accDescr: A workload refresher mints a short-lived access token and stores it in a Kubernetes secret. ESO reads the token, authenticates to OpenBao with it, reads the secret value, and writes it to a synced Kubernetes secret on each sync interval.
    participant W as Workload <br/> refresher
    participant API as Secrets Manager API
    participant KAuth as K8s Secret <br/> auth token
    participant ESO as ESO
    participant OB as OpenBao
    participant KApp as K8s Secret <br/> synced
W-&gt;&gt;API: Mint access token
API--&gt;&gt;W: Short-lived token
W-&gt;&gt;KAuth: Store token

loop Sync interval
    ESO-&gt;&gt;KAuth: Read token
    ESO-&gt;&gt;OB: JWT login
    OB--&gt;&gt;ESO: Client token
    ESO-&gt;&gt;OB: Read KV path
    OB--&gt;&gt;ESO: Secret value
    ESO-&gt;&gt;KApp: Write value
end

Note over W,API: Access token expires in 5 min</code></pre></details></div>

Terraform과 함께 사용#

Terraform 또는 OpenTofu 구성에서 GitLab 시크릿을 데이터 소스로 읽을 수 있습니다. Terraform은 액세스 토큰을 직접 발급받을 수 없으므로 external 데이터 소스가 Secrets Manager API를 호출하는 스크립트를 실행해 provider.vault 연결 정보를 반환합니다. 그런 다음 Vault 프로바이더가 발급받은 JWT로 인증하고 시크릿을 읽습니다.

스크립트는 토큰을 발급받고 연결 정보를 JSON으로 출력합니다. GitLab 토큰은 GITLAB_TOKEN 환경 변수에서 읽습니다. 그룹의 시크릿을 읽으려면 projects/<project_id> 대신 groups/<group_id>로 그룹 엔드포인트를 호출합니다.

#!/usr/bin/env bash
# scripts/mint_token.sh
set -euo pipefail
eval "$(jq --raw-output '@sh "PROJECT_ID=\(.project_id)"')"

curl --silent --request POST \
  --header "PRIVATE-TOKEN: ${GITLAB_TOKEN}" \
  --url "https://gitlab.example.com/api/v4/projects/${PROJECT_ID}/secrets_manager/access_token" \
  | jq '{
      server:       .provider.vault.server,
      namespace:    .provider.vault.namespace,
      mount:        .provider.vault.path,
      secrets_path: .provider.vault.secrets_path,
      auth_path:    .provider.vault.auth.jwt.path,
      role:         .provider.vault.auth.jwt.role,
      jwt:          .provider.vault.auth.jwt.token
    }'

external 데이터 소스에서 스크립트를 참조하고, Vault 프로바이더를 구성한 다음, 임시 리소스로 시크릿을 읽습니다.

data "external" "gitlab_secrets_token" {
  program = ["bash", "${path.module}/scripts/mint_token.sh"]

  query = {
    project_id = var.gitlab_project_id
  }
}

provider "vault" {
  address          = data.external.gitlab_secrets_token.result.server
  namespace        = data.external.gitlab_secrets_token.result.namespace
  skip_child_token = true

  auth_login_jwt {
    mount = data.external.gitlab_secrets_token.result.auth_path
    role  = data.external.gitlab_secrets_token.result.role
    jwt   = data.external.gitlab_secrets_token.result.jwt
  }
}

ephemeral "vault_kv_secret_v2" "my_secret" {
  mount = data.external.gitlab_secrets_token.result.mount
  name  = "${data.external.gitlab_secrets_token.result.secrets_path}/<secret_name>"
}

# Pass the value to a provider configuration or a write-only argument, for example:
# password_wo = ephemeral.vault_kv_secret_v2.my_secret.data["value"]

Vault 프로바이더에서 skip_child_token = true로 설정합니다. 기본적으로 프로바이더는 JWT 로그인으로 얻은 OpenBao 토큰으로 하위 토큰을 만들지만, 그 OpenBao 토큰은 하위 토큰을 만들 수 없습니다. 이 설정이 없으면 프로바이더가 403 오류와 failed to create limited child token 메시지와 함께 실패합니다.

임시 리소스에는 Terraform 1.10 이상 또는 OpenTofu 1.11 이상, 그리고 Vault 프로바이더 5.0 이상이 필요합니다. Terraform과 OpenTofu는 이 값을 상태 파일이나 플랜 파일에 저장하지 않습니다. 이전 버전에서는 대신 vault_kv_secret_v2 데이터 소스를 사용합니다. 데이터 소스는 시크릿 값을 상태에 평문으로 저장하므로 상태에 대한 접근을 제한합니다.

발급받은 JWT는 5분 동안 유효합니다.

  • Vault 프로바이더는 실행 시작 후 5분 이내에 시크릿을 읽어야 합니다. 프로바이더는 실행을 시작할 때가 아니라 시크릿을 처음 읽을 때 OpenBao에 인증합니다.
  • terraform plan -out으로 플랜을 저장했다면 5분 이내에 적용합니다. 적용하는 동안 Terraform은 플랜에 있는 JWT로 임시 리소스를 다시 읽습니다.

네이티브 GitLab Terraform 프로바이더 통합은 에픽 21177에서 제안되었습니다.