IAP에서 맞춤 OAuth 클라이언트 사용

이 문서에서는 IAP (Identity-Aware Proxy)에 맞춤 OAuth 클라이언트를 사용하는 시기와 방법을 설명합니다.

기본적으로 IAP는 Google 관리 OAuth 클라이언트를 사용하여 사용자를 인증합니다. Google 관리 OAuth 클라이언트는 조직 내에 있는 내부 사용자의 액세스 권한을 관리하는 데만 사용할 수 있습니다.

다음을 수행하려면 커스텀 OAuth 구성을 사용해야 합니다.

  • 조직 외부의 외부 사용자가 IAP가 사용 설정된 애플리케이션에 액세스하도록 관리합니다.
  • Google Cloud 조직에 속하지 않는 프로젝트에 있는 웹 애플리케이션에 대한 액세스를 관리합니다.
  • 인증 중 동의 화면에 맞춤 브랜드 정보를 표시합니다.

IAP 또는 플랫폼에서 직접 맞춤 OAuth 클라이언트를 구성할 수 있습니다.

커스텀 OAuth 클라이언트를 사용하는 경우 OAuth 동의 화면을 구성해야 합니다. 동의 화면에 맞춤 브랜딩이 표시되려면 Google 인증을 위해 애플리케이션을 제출해야 합니다. 인증 절차에 대한 자세한 내용은 OAuth 동의 화면 설정을 참고하세요.

맞춤 OAuth 클라이언트를 구성할 때는 사용자 인증 정보를 생성하고 관리해야 합니다. 여기에는 클라이언트 보안 비밀을 안전하게 저장하고 필요한 경우 승인된 클라이언트와 공유하는 작업이 포함됩니다.

Google 관리 OAuth 클라이언트와 커스텀 OAuth 클라이언트 비교

Google 관리 OAuth 클라이언트는 IAP로 보호된 애플리케이션에 프로그래매틱 방식으로 액세스할 수 없습니다. 하지만 Google 관리 OAuth 클라이언트를 사용하는 IAP 보호 애플리케이션은 programmatic_clients 설정을 통해 구성된 별도의 OAuth 클라이언트 또는 서비스 계정 JWT를 사용하여 프로그래매틱 방식으로 액세스할 수 있습니다.

다음 표에서는 Google 관리 OAuth 클라이언트와 커스텀 OAuth 클라이언트를 비교합니다.

Google 관리 OAuth 클라이언트 맞춤 OAuth 클라이언트
사용자 내부 전용 내부 및 외부용
브랜드 Google Cloud brand 고객 소유 브랜드
OAuth 구성 Google 구성됨 고객 구성됨
OAuth 사용자 인증 정보 Google 관리 고객 관리
애플리케이션 액세스 브라우저 흐름만 해당 브라우저 흐름 및 프로그래매틱 액세스

브랜딩 페이지 구성

Google Cloud 콘솔을 사용하여 맞춤 브랜딩 페이지를 구성하려면 다음을 수행합니다.

  1. Google Cloud 콘솔에서 OAuth 브랜딩 페이지로 이동합니다.

    브랜딩으로 이동

  2. 시작하기를 클릭합니다.

  3. 앱 이름에 동의 화면의 애플리케이션 이름을 입력합니다.

  4. 사용자 지원 이메일에 지원을 위한 관리자 이메일 주소를 입력합니다.

  5. 잠재고객에서 내부를 선택하여 조직 내 사용자의 액세스를 제한하거나 외부를 선택하여 조직 외부 사용자의 액세스를 허용합니다.

  6. 연락처 정보에 OAuth 클라이언트로 보호되는 앱에 관해 문의할 관리자 이메일을 입력합니다. 나중 단계에서 OAuth 클라이언트를 구성합니다.

  7. OAuth 구성을 만들려면 만들기를 클릭합니다.

IAP에서 맞춤 OAuth 클라이언트 구성

이 섹션에서는 IAP에서 맞춤 OAuth 클라이언트를 설정하는 방법을 설명합니다.

맞춤 OAuth 클라이언트 만들기

이 섹션에서는Google Cloud 콘솔을 사용하여 커스텀 OAuth 클라이언트를 만드는 방법을 설명합니다. 리소스 계층 구조의 모든 수준에서 맞춤 IAP OAuth 클라이언트를 설정할 수 있습니다.

Google Cloud 콘솔을 사용하여 리소스의 맞춤 OAuth 클라이언트를 만들려면 다음 단계를 따르세요.

  1. Google Cloud 콘솔에서 IAP 페이지로 이동합니다.

    IAP로 이동

  2. 애플리케이션 탭의 리소스 목록에서 구성하려는 리소스를 찾습니다.

    프로젝트 수준 리소스의 경우 다음을 수행합니다.

    • Google Cloud 콘솔을 사용하여 OAuth 클라이언트를 만듭니다.

      1. 작업 열에서 옵션 더보기 > 설정을 클릭합니다.

      2. 설정 대화상자에서 맞춤 OAuth를 선택합니다.

      3. 동의 화면을 구성하지 않은 경우 다음 단계를 따르세요.

        1. 동의 화면 구성을 클릭합니다.

        2. 이 문서의 앞부분에 제공된 안내에 따라 브랜딩 페이지를 구성합니다.

      4. IAP 설정 대화상자에서 Auto Generate Credentials를 클릭합니다. IAP는 이 리소스와 함께 사용할 새 OAuth 클라이언트와 비밀번호를 생성합니다. Google 인증 플랫폼의 승인된 리디렉션 URI 필드에는 다음 형식의 항목이 포함되어 있습니다.

        https://iap.googleapis.com/v1/oauth/clientIds/CLIENT_ID:handleRedirect

      5. 클라이언트 ID와 보안 비밀에 액세스하려면 사용자 인증 정보 다운로드를 클릭합니다. 사용자 인증 정보는 JSON 형식 파일에 저장됩니다. 이 파일에는 리소스에 액세스하기 위한 민감한 사용자 인증 정보가 포함되어 있으므로 파일이 보안 처리되었거나 삭제되었는지 확인하세요.

      6. IAP OAuth 구성을 저장하고 OAuth 클라이언트를 IAP에 적용하려면 저장을 클릭합니다.

IAP에 맞춤 OAuth 클라이언트 적용

이 섹션에서는 OAuth 클라이언트를 IAP에 적용하는 방법을 설명합니다. 플랫폼에 클라이언트를 직접 적용하는 대신 이 메서드를 사용할 수 있습니다.

  1. 맞춤 OAuth 클라이언트를 만들려면 이 문서의 앞부분에 제공된Google Cloud 콘솔 안내를 따르세요.

  2. 맞춤 OAuth 클라이언트를 적용합니다.

    gcloud

    gcloud CLI를 사용하여 맞춤 OAuth 클라이언트를 적용하려면 다음을 실행하세요.

    1. 설정 YAML 파일을 만듭니다.

      cat << EOF > iap-oauth.yaml
accessSettings:
oauthSettings:
  clientId: CLIENT_ID
  clientSecret: CLIENT_SECRET
EOF

      다음을 바꿉니다.

      • CLIENT_ID: 이전에 생성한 OAuth 사용자 인증 정보의 클라이언트 ID입니다.
      • CLIENT_SECRET: 이전에 생성한 OAuth 사용자 인증 정보의 클라이언트 보안 비밀번호입니다.

    2. OAuth 구성을 설정하려면 다음 중 하나를 수행하세요.

      • 프로젝트 수준에서 OAuth 구성을 설정하려면 다음 명령어를 실행합니다.
      gcloud iap settings set iap-oauth.yaml

      리소스 계층 구조의 다른 수준에서 구성을 설정하려면 --project 플래그 대신 다음 플래그 중 하나를 사용하세요. 리소스 계층 구조 수준에서 맞춤 OAuth 클라이언트를 설정하면 해당 수준 내에서 실행되는 모든 서비스에 동일한 맞춤 브랜딩이 제공됩니다.

      * <code>--folder=<var>FOLDER_ID</var></code>
* <code>--organization=<var>ORGANIZATION_ID</var></code>
      • 특정 서비스의 구성을 설정하려면 다음 명령어를 실행합니다.
      gcloud iap settings set iap-oauth.yaml \
    --project=PROJECT_ID \
    --resource-type= RESOURCE_TYPE \
    --region=REGION \
    --service=SERVICE_NAME

      다음을 바꿉니다.

      • PROJECT_ID: 프로젝트 리소스의 ID입니다. 다른 수준에서 구성을 설정하려면 --project 플래그 대신 다음 플래그 중 하나를 사용하세요.

        • --folder=FOLDER_ID
        • --organization=ORGANIZATION_ID

      • RESOURCE_TYPE: 리소스에 따라 다음 리소스 유형 중 하나로 대체합니다.

        • app-engine
        • backend-services
        • cloud-run
        • compute
        • folder
        • forwarding-rule
        • iap_web
        • organization

      • REGION: Cloud Run 서비스를 실행하는 리전입니다.

      • SERVICE_NAME: 서비스 이름입니다.

    Terraform

    Terraform을 사용하여 맞춤 OAuth 클라이언트를 적용하려면 다음 단계를 따르세요.

    resource "google_iap_settings" "iap_settings" {
name = IAP_RESOURCE_NAME
access_settings {
  oauth_settings {
      oauth_client_id = CLIENT_ID
      oauth_client_secret = CLIENT_SECRET
  }
}
}

    다음을 바꿉니다.

    • IAP_RESOURCE_NAME: 서비스의 iap_settings 리소스 이름이며 형식은 projects/PROJECT_NUMBER/iap_web/REGION/services/SERVICE_NAME입니다.
    • CLIENT_ID: 이전에 생성한 OAuth 사용자 인증 정보의 클라이언트 ID
    • CLIENT_SECRET: 이전에 생성한 OAuth 사용자 인증 정보의 클라이언트 보안 비밀번호

    REST API

    1. 설정 JSON 파일을 만듭니다.

      cat << EOF > iap-oauth.json
{
"accessSettings": {
  "oauthSettings": {
    "clientId": "CLIENT_ID",
    "clientSecret": "CLIENT_SECRET"
  }
}
}
EOF

      다음을 바꿉니다.

      • CLIENT_ID: 이전에 생성한 OAuth 사용자 인증 정보의 클라이언트 ID입니다.
      • CLIENT_SECRET: 이전에 생성한 OAuth 사용자 인증 정보의 클라이언트 보안 비밀번호입니다.

    2. 설정 파일을 적용합니다.

      curl -X PATCH \
-H "Authorization: Bearer $(gcloud auth print-access-token)"
-H "Content-Type: application/yaml" \
"https://iap.googleapis.com/v1/projects/cb-managed-ingress-demo/iap_web/forwarding_rule-us-central1/services/psc-fr:iapSettings?update_mask=iapSettings.accessSettings.oauthSettings.oauthClientId,iapSettings.accessSettings.oauthSettings.oauthClientSecret" \
-d @iap-oauth.json

OAuth 클라이언트로 IAP에 의해 웹 애플리케이션이 보호되는지 테스트하려면 액세스 테스트를 참고하세요.

리소스의 맞춤 OAuth 클라이언트의 기존 구성

다음 섹션에서는 특정 리소스 유형의 IAP에서 맞춤 OAuth 클라이언트를 구성하는 기존 방법을 설명합니다. 이 문서의 앞부분에 설명된 방법을 사용한 경우 이 섹션을 건너뛸 수 있습니다.

App Engine

이 섹션에서는 App Engine에서 커스텀 OAuth 클라이언트를 사용 설정하는 방법을 설명합니다.

gcloud

프로젝트와 IAP를 설정하려면 최신 버전의 gcloud CLI가 필요합니다. gcloud CLI 설치 방법에 대한 자세한 내용은 gcloud CLI 설치를 참조하세요.

  1. 인증하려면 Google Cloud CLI를 사용하고 다음 명령어를 실행합니다. 
    gcloud auth login
  2. 로그인하려면 표시되는 URL을 따릅니다.
  3. 로그인한 후에는 표시된 확인 코드를 복사하고 이를 명령줄에 붙여넣습니다.
  4. 다음 명령어를 실행하여 IAP로 보호하려는 리소스가 포함된 프로젝트를 지정합니다. 
    gcloud config set project PROJECT_ID
  5. IAP용 OAuth 클라이언트 만들기의 안내에 따라 OAuth 동의 화면을 구성하고 OAuth 클라이언트를 만듭니다.
  6. OAuth 클라이언트 ID 및 보안 비밀을 저장합니다.
  7. IAP를 사용 설정하려면 다음 명령어를 실행하세요. 
    gcloud iap web enable \
    --oauth2-client-id=CLIENT_ID \
    --oauth2-client-secret=CLIENT_SECRET \
    --resource-type=app-engine

IAP를 사용 설정한 후 gcloud CLI를 사용하여 IAM 역할 roles/iap.httpsResourceAccessor를 사용하여 IAP 액세스 정책을 수정할 수 있습니다. 역할 및 권한 관리에 대해 자세히 알아보세요.

API

  1. IAP용 OAuth 클라이언트 만들기의 안내에 따라 OAuth 동의 화면을 구성하고 OAuth 클라이언트를 만듭니다.

  2. OAuth 클라이언트 ID 및 보안 비밀을 저장합니다.

  3. 다음 명령어를 실행하여 settings.json 파일을 준비합니다. 

    cat << EOF > settings.json
{
"iap":
  {
    "enabled": true,
    "oauth2ClientId": "CLIENT_ID",
    "oauth2ClientSecret":" CLIENT_SECRET"
  }
}
EOF

  4. 다음 명령어를 실행하여 IAP를 사용 설정합니다. 

    curl -X PATCH \
-H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d @settings.json \
"https://appengine.googleapis.com/v1/apps/PROJECT_ID?updateMask=iap"

IAP를 사용 설정한 후 Google Cloud CLI를 사용하여 IAM 역할 roles/iap.httpsResourceAccessor를 사용하여 IAP 액세스 정책을 수정할 수 있습니다. 역할 및 권한 관리에 대해 자세히 알아보세요.

GKE

이 섹션에서는 GKE에서 맞춤 OAuth 클라이언트를 사용 설정하는 방법을 설명합니다.

BackendConfig 구성

GKE 클러스터 버전 1.24 이상을 실행하는 경우 Kubernetes Gateway API를 사용하여 IAP와 GKE를 구성할 수 있습니다. 자세한 내용은 IAP 구성을 참고하세요.

  1. IAP용 OAuth 클라이언트 만들기의 안내에 따라 OAuth 동의 화면을 구성하고 OAuth 클라이언트를 만듭니다.

  2. OAuth 클라이언트를 래핑하는 Kubernetes 보안 비밀을 만듭니다. 

    kubectl create secret generic MY_SECRET --from-literal=client_id=CLIENT_ID \
  --from-literal=client_secret=CLIENT_SECRET
    다음을 바꿉니다.

    • MY_SECRET: 만들 보안 비밀의 이름
    • CLIENT_ID: OAuth 클라이언트 ID
    • CLIENT_SECRET: OAuth 클라이언트 보안 비밀번호

    다음 출력과 같이 Secret이 생성되었다는 확인 메시지가 표시됩니다. 

    secret "MY_SECRET" created

  3. BackendConfig에 OAuth 사용자 인증 정보를 추가합니다. 

    apiVersion: cloud.google.com/v1
kind: BackendConfig
metadata:
  name: CONFIG_DEFAULT
  namespace: my-namespace
spec:
iap:
  enabled: true
  oauthclientCredentials:
    secretName: MY_SECRET

  4. 서비스 포트를 BackendConfig와 연결하여 IAP를 사용 설정합니다. BackendConfig를 인그레스와 연결을 참고하세요. 이 연결을 만드는 한 가지 방법은 서비스의 모든 포트를 BackendConfig로 기본 설정하는 것입니다. 서비스 리소스에 다음 주석을 추가하여 수행할 수 있습니다. 

    metadata:
  annotations:
      beta.cloud.google.com/backend-config: '{"default": "CONFIG_DEFAULT"}}'

IAP를 사용 설정한 후 gcloud CLI를 사용하여 IAM 역할 roles/iap.httpsResourceAccessor를 사용하여 IAP 액세스 정책을 수정할 수 있습니다. 역할 및 권한 관리에 대해 자세히 알아보세요.

문제 해결

참조한 secretName이 없거나 올바르게 구성되지 않은 경우 다음 오류 메시지 중 하나가 표시됩니다.

  • BackendConfig default/config-default is not valid: error retrieving secret "foo": secrets "foo" not found. 이 오류를 해결하려면 2단계에 설명된 대로 Kubernetes 보안 비밀을 올바르게 만들었는지 확인합니다.

  • BackendConfig default/config-default is not valid: secret "foo" missing client_secret data. 이 오류를 해결하려면 OAuth 사용자 인증 정보를 올바르게 만들었는지 확인합니다. 또한 올바른 client_id 및 client_secret 키를 참조했는지 확인합니다.

부하 분산기 백엔드 서비스

Compute Engine 및 Cloud Run 사용자의 경우 이 섹션에서는 부하 분산기 백엔드 서비스의 IAP에서 OAuth 클라이언트를 설정하는 방법을 설명합니다.

gcloud

프로젝트와 IAP를 설정하려면 최신 버전의 gcloud CLI가 필요합니다. gcloud CLI 설치 방법에 대한 자세한 내용은 gcloud CLI 설치를 참조하세요.

  1. 인증하려면 Google Cloud CLI를 사용하고 다음 명령어를 실행합니다. 
    gcloud auth login
  2. 로그인하려면 표시되는 URL을 따릅니다.
  3. 로그인한 후에는 표시된 확인 코드를 복사하고 이를 명령줄에 붙여넣습니다.
  4. 다음 명령어를 실행하여 IAP로 보호하려는 리소스가 포함된 프로젝트를 지정합니다. 
    gcloud config set project PROJECT_ID
  5. IAP용 OAuth 클라이언트 만들기의 안내에 따라 OAuth 동의 화면을 구성하고 OAuth 클라이언트를 만듭니다.
  6. OAuth 클라이언트 ID 및 보안 비밀을 저장합니다.
  7. IAP를 사용 설정하려면 전역 또는 리전 범위 명령어를 실행합니다.

    전역 범위 
    gcloud compute backend-services update BACKEND_SERVICE_NAME \
    --global \
    --iap=enabled,oauth2-client-id=CLIENT_ID,oauth2-client-secret=CLIENT_SECRET
    리전 범위
    gcloud compute backend-services update BACKEND_SERVICE_NAME \
    --region REGION_NAME \
    --iap=enabled,oauth2-client-id=CLIENT_ID,oauth2-client-secret=CLIENT_SECRET

IAP를 사용 설정한 후 gcloud CLI를 사용하여 IAM 역할 roles/iap.httpsResourceAccessor를 사용하여 IAP 액세스 정책을 수정할 수 있습니다. 역할 및 권한 관리에 대해 자세히 알아보세요.

API

  1. IAP용 OAuth 클라이언트 만들기의 안내에 따라 OAuth 동의 화면을 구성하고 OAuth 클라이언트를 만듭니다.

  2. OAuth 클라이언트 ID 및 보안 비밀을 저장합니다.

  3. 다음 명령어를 실행하여 settings.json 파일을 준비합니다. 

    cat << EOF > settings.json
{
"iap":
  {
    "enabled": true,
    "oauth2ClientId": "CLIENT_ID",
    "oauth2ClientSecret": "CLIENT_SECRET"
  }
}
EOF

  4. 다음 명령어를 실행하여 IAP를 사용 설정합니다. 

    curl -X PATCH \
-H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d @settings.json \
"https://compute.googleapis.com/compute/v1/projects/PROJECT_ID/REGION/backendServices/BACKEND_SERVICE_NAME"

IAP를 사용 설정한 후 gcloud CLI를 사용하여 IAM 역할 roles/iap.httpsResourceAccessor를 사용하여 IAP 액세스 정책을 수정할 수 있습니다. 역할 및 권한 관리에 대해 자세히 알아보세요.

액세스 테스트

커스텀 OAuth 클라이언트를 구성한 후 다음을 실행하여 IAP가 서비스를 보호하는 데 사용되는지 테스트할 수 있습니다.

  1. IAP 페이지의 애플리케이션 탭에서 IAP가 관리하는 애플리케이션을 확인합니다.

  2. 애플리케이션 중 하나의 URL에 액세스합니다. 동의 화면을 구성한 후 처음으로 애플리케이션에 액세스하는 경우 이전에 구성한 동의 화면이 표시됩니다.