3장. 내부 OAuth 서버 구성
OpenShift Container Platform 컨트롤 플레인에는 사용자 인증을 위한 기본 제공 OAuth 서버가 포함되어 있습니다. 토큰 기간, 비활성 타임아웃을 구성하고 OAuth 서버 URL을 사용자 지정할 수 있습니다.
3.1. OpenShift Container Platform OAuth 서버 링크 복사링크가 클립보드에 복사되었습니다!
OpenShift Container Platform 컨트롤 플레인에는 내장 OAuth 서버가 포함되어 있습니다. 사용자는 API 인증을 위해 OAuth 액세스 토큰을 가져옵니다.
사용자가 새 OAuth 토큰을 요청하면 OAuth 서버는 구성된 ID 공급자를 사용하여 요청한 사람의 ID를 확인합니다.
그런 다음 해당 ID와 매핑되는 사용자를 결정하고 그 사용자를 위한 액세스 토큰을 만들어 제공합니다.
3.2. OAuth 토큰 요청 flows 및 응답 링크 복사링크가 클립보드에 복사되었습니다!
OAuth 서버는 WWW-Authenticate 챌린지와 함께 암시적 부여 흐름을 사용하는 토큰 요청에 대한 특정 서버 응답과 함께 표준 인증 코드 부여 및 암시적 부여 흐름을 지원합니다.
WWW-Authenticate challenges (예: openshift-challenging-client)를 요청하기 위해 구성된 client_id와 함께 암시적 부여 flow(response_type=token)를 사용하여 OAuth 토큰을 요청하는 경우, /oauth/authorize에서 제공 가능한 서버 응답 및 처리 방법은 다음과 같습니다.
| 상태 | 내용 | 클라이언트 응답 |
|---|---|---|
| 302 |
URL 조각에 |
|
| 302 |
|
실패, |
| 302 |
기타 | 리디렉션을 따르고 해당 규칙을 사용하여 결과를 처리하십시오. |
| 401 |
|
유형이 인식되면(예: |
| 401 |
| 인증할 수 있는 챌린지가 없습니다. 실패했으며 응답 본문(OAuth 토큰을 가져올 수 있는 링크 및 대체 방법에 대한 세부 사항이 포함될 수 있음)을 표시합니다. |
| 기타 | 기타 | 실패, 사용자에게 응답 본문을 선택적으로 표시합니다. |
3.3. 내부 OAuth 서버 옵션 링크 복사링크가 클립보드에 복사되었습니다!
내부 OAuth 서버는 토큰 기간 동안 구성 옵션을 제공하고 인증 동작을 제어하는 전략을 부여합니다.
3.3.1. OAuth 토큰 기간 옵션 링크 복사링크가 클립보드에 복사되었습니다!
내부 OAuth 서버는 두 종류의 토큰을 생성합니다.
| 토큰 | 설명 |
|---|---|
| 액세스 토큰 | API에 대한 액세스 권한을 부여하는 장기 토큰입니다. |
| 코드 인증 | 액세스 토큰으로 교환하는 용도로만 사용하는 단기 토큰입니다. |
두 가지 토큰 모두에 대해 기본 기간을 구성할 수 있습니다. 필요한 경우 OAuthClient 오브젝트 정의를 사용하여 액세스 토큰 지속 기간을 덮어쓸 수 있습니다.
3.3.2. OAuth 부여 옵션 링크 복사링크가 클립보드에 복사되었습니다!
OAuth 서버에서 사용자가 이전에 권한을 부여하지 않은 클라이언트에 대한 토큰 요청을 수신하는 경우, OAuth 서버에서 수행하는 조치는 OAuth 클라이언트의 권한 부여 전략에 따라 결정됩니다.
토큰을 요청하는 OAuth 클라이언트는 고유의 부여 전략을 제공해야 합니다.
다음과 같은 기본 방법을 적용할 수 있습니다.
| 부여 옵션 | 설명 |
|---|---|
|
| 부여를 자동 승인하고 요청을 다시 시도합니다. |
|
| 사용자에게 부여를 승인하거나 거부하도록 요청합니다. |
3.4. 내부 OAuth 서버의 토큰 기간 구성 링크 복사링크가 클립보드에 복사되었습니다!
기본 24시간 수명 이상으로 액세스 토큰 유효 기간을 연장하거나 줄이도록 내부 OAuth 서버를 구성합니다.
기본적으로 토큰은 24시간 동안만 유효합니다. 이 시간이 지나면 기존 세션이 만료됩니다.
기본 시간이 충분하지 않으면 다음 절차를 사용하여 수정할 수 있습니다.
절차
토큰 기간 옵션이 포함된 구성 파일을 만듭니다. 다음 파일에서는 이 값을 기본값의 두 배인 48시간으로 설정합니다.
apiVersion: config.openshift.io/v1 kind: OAuth metadata: name: cluster spec: tokenConfig: accessTokenMaxAgeSeconds: 172800다음과 같습니다.
spec.tokenConfig.accessTokenMaxAgeSeconds- 액세스 토큰의 수명을 초 단위로 지정합니다. 기본 수명은 24시간 또는 86400초입니다. 이 속성은 음수일 수 없습니다. 0으로 설정하면 기본 라이프사이클이 사용됩니다.
새 구성 파일을 적용합니다.
참고기존 OAuth 서버를 업데이트하므로
oc apply명령을 사용하여 변경 사항을 적용해야 합니다.$ oc apply -f </path/to/file.yaml>변경 사항이 적용되는지 확인합니다.
$ oc describe oauth.config.openshift.io/cluster출력 예
... Spec: Token Config: Access Token Max Age Seconds: 172800 ...
3.5. 내부 OAuth 서버에 대한 토큰 비활성 타임아웃 구성 링크 복사링크가 클립보드에 복사되었습니다!
설정된 비활성 기간이 지나면 자동으로 토큰을 만료하도록 내부 OAuth 서버를 구성하여 유휴 세션을 무효화하여 보안을 개선합니다.
기본적으로 토큰 비활성 타임아웃은 설정되어 있지 않습니다.
토큰 비활성 타임아웃이 OAuth 클라이언트에도 구성된 경우 해당 값은 내부 OAuth 서버 구성에 설정된 타임아웃을 덮어씁니다.
사전 요구 사항
-
cluster-admin역할의 사용자로 클러스터에 액세스할 수 있습니다. - IDP(ID 공급자)를 구성했습니다.
절차
OAuth구성을 업데이트하여 토큰 비활성 타임아웃을 설정합니다.OAuth오브젝트를 편집합니다.$ oc edit oauth clusterspec.tokenConfig.accessTokenInactivityTimeout필드를 추가하고 타임아웃 값을 설정합니다.apiVersion: config.openshift.io/v1 kind: OAuth metadata: ... spec: tokenConfig: accessTokenInactivityTimeout: 400s다음과 같습니다.
spec.tokenConfig.accessTokenInactivityTimeout-
적절한 단위를 사용하여 토큰 비활성 타임아웃을 지정합니다(예: 400초의 경우
400s, 30분 동안30m). 허용되는 최소 타임아웃 값은300s입니다.
- 파일을 저장하여 변경 사항을 적용합니다.
OAuth 서버 Pod가 다시 시작되었는지 확인합니다.
$ oc get clusteroperators authentication다음 출력에 표시된 것처럼
PROGRESSING이False로 표시될 때까지 다음 단계를 진행하지 마십시오.출력 예
NAME VERSION AVAILABLE PROGRESSING DEGRADED SINCE authentication 5.0.0 True False False 145m쿠버네티스 API 서버 pod의 새 버전이 출시되었는지 확인합니다. 이 작업에는 몇 분 정도 걸립니다.
$ oc get clusteroperators kube-apiserver다음 출력에 표시된 것처럼
PROGRESSING이False로 표시될 때까지 다음 단계를 진행하지 마십시오.출력 예
NAME VERSION AVAILABLE PROGRESSING DEGRADED SINCE kube-apiserver 5.0.0 True False False 145mPROGRESSING에True가 표시되면 몇 분 기다렸다가 다시 시도하십시오.
검증
- IDP의 ID로 클러스터에 로그인합니다.
- 명령을 실행하고 성공했는지 확인합니다.
- ID를 사용하지 않는 경우 구성된 타임아웃보다 대기 시간이 길어집니다. 이 절차의 예에서는 400초 이상 기다립니다.
동일한 ID의 세션에서 명령을 실행해 봅니다.
구성된 타임아웃보다 비활성 기간이 길어 토큰이 만료되므로 이 명령은 실패할 것입니다.
출력 예
error: You must be logged in to the server (Unauthorized)
3.6. 내부 OAuth 서버 URL 사용자 정의 링크 복사링크가 클립보드에 복사되었습니다!
클러스터 Ingress 구성 요소 경로를 구성하여 사용자 정의 호스트 이름 및 TLS 인증서를 사용하도록 내부 OAuth 서버 URL을 사용자 지정합니다.
내부 OAuth 서버 URL을 업데이트하는 경우 OAuth 액세스 토큰을 검색하기 위해 OpenShift Container Platform OAuth 서버와 통신해야 하는 클러스터의 구성 요소에서 신뢰를 중단할 수 있습니다. OAuth 서버를 신뢰해야 하는 구성 요소는 OAuth 엔드포인트를 호출할 때 적절한 CA 번들을 포함해야 합니다. 예를 들면 다음과 같습니다.
$ oc login -u <username> -p <password> --certificate-authority=<path_to_ca.crt>
+ 자체 서명된 인증서의 경우 ca.crt 파일에 사용자 정의 CA 인증서가 포함되어야 합니다. 그렇지 않으면 로그인에 실패합니다.
Cluster Authentication Operator는 openshift-config-managed 네임스페이스의 oauth-serving-cert 구성 맵에 OAuth 서버의 제공 인증서를 게시합니다. 구성 맵의 data.ca-bundle.crt 키에서 인증서를 찾을 수 있습니다.
사전 요구 사항
- 관리 권한이 있는 사용자로 클러스터에 로그인했습니다.
TLS 인증서 및 키가 포함된
openshift-config네임스페이스에 시크릿을 생성했습니다. 사용자 지정 호스트 이름 접미사가 클러스터 도메인 접미사와 일치하지 않는 경우 이 작업이 필요합니다. 접미사가 일치하는 경우 시크릿은 선택 사항입니다.작은 정보oc create secret tls명령을 사용하여 TLS 시크릿을 생성할 수 있습니다.
프로세스
클러스터
Ingress구성을 편집합니다.$ oc edit ingress.config.openshift.io cluster사용자 정의 호스트 이름과 서비스 인증서 및 키를 설정합니다.
apiVersion: config.openshift.io/v1 kind: Ingress metadata: name: cluster spec: componentRoutes: - name: oauth-openshift namespace: openshift-authentication hostname: <custom_hostname> servingCertKeyPairSecret: name: <secret_name>다음과 같습니다.
spec.componentRoutes.hostname- OAuth 서버의 사용자 지정 호스트 이름을 지정합니다.
spec.componentRoutes.servingCertKeyPairSecret.name-
TLS 인증서(
tls.crt) 및 키(tls.key)가 포함된openshift-config네임스페이스에 보안의 이름을 지정합니다. 사용자 지정 호스트 이름 접미사가 클러스터 도메인 접미사와 일치하지 않는 경우 이 작업이 필요합니다. 접미사가 일치하는 경우 시크릿은 선택 사항입니다.
- 파일을 저장하여 변경 사항을 적용합니다.
3.7. OAuth 서버 메타데이터 링크 복사링크가 클립보드에 복사되었습니다!
클러스터에서 실행되는 애플리케이션은 OAuth 2.0 인증 서버 메타데이터 끝점을 쿼리하여 OAuth 서버 엔드포인트를 동적으로 검색하고 지원되는 범위 및 자동화된 클라이언트 구성에 대한 유형을 부여할 수 있습니다.
클러스터 내에서 실행되는 모든 애플리케이션은 https://openshift.default.svc/.well-known/oauth-authorization-server 에 GET 요청을 발행하여 다음 정보를 가져올 수 있습니다.
{
"issuer": "https://<namespace_route>",
"authorization_endpoint": "https://<namespace_route>/oauth/authorize",
"token_endpoint": "https://<namespace_route>/oauth/token",
"scopes_supported": [
"user:full",
"user:info",
"user:check-access",
"user:list-scoped-projects",
"user:list-projects"
],
"response_types_supported": [
"code",
"token"
],
"grant_types_supported": [
"authorization_code",
"implicit"
],
"code_challenge_methods_supported": [
"plain",
"S256"
]
}
+ 위치:
issuer-
https체계를 사용하고 쿼리 또는 조각 구성 요소가 없는 URL인 권한 부여 서버의 발행자 식별자를 지정합니다. 권한 부여 서버에 대한 정보가 포함된.well-knownRFC 5785 리소스가 게시되는 위치입니다. authorization_endpoint- 권한 부여 서버의 권한 부여 끝점의 URL을 지정합니다.
token_endpoint- 권한 부여 서버의 토큰 끝점의 URL을 지정합니다.
scopes_supported- 이 권한 부여 서버에서 지원하는 OAuth 2.0 RFC 6749 범위 값 목록이 포함된 JSON 배열을 지정합니다. 지원되는 모든 범위 값이 제공되는 것은 아닙니다.
response_types_supported-
이 권한 부여 서버에서 지원하는 OAuth 2.0
response_type값 목록이 포함된 JSON 배열을 지정합니다. 사용된 배열 값은 RFC 7591의 OAuth 2.0 동적 클라이언트 등록 프로토콜에서 정의한response_types매개변수에 사용된 값과 동일합니다. grant_types_supported-
이 권한 부여 서버에서 지원하는 OAuth 2.0 권한 부여 유형 값 목록이 포함된 JSON 배열을 지정합니다. 사용된 배열 값은 RFC 7591의 OAuth 2.0 동적 클라이언트 등록 프로토콜에서 정의한
grant_types매개변수와 함께 사용되는 것과 동일합니다. code_challenge_methods_supported-
이 권한 부여 서버에서 지원하는 PKCE RFC 7636 코드 챌린지 방법 목록이 포함된 JSON 배열을 지정합니다. 코드 챌린지 메서드 값은 RFC 7636의 섹션 4.3에 정의된
code_challenge_method매개변수에 사용됩니다. 유효한 코드 챌린지 방법 값은 IANA PKCE Code Challenge Methods 레지스트리에 등록된 값입니다.
3.8. OAuth API 이벤트 문제 해결 링크 복사링크가 클립보드에 복사되었습니다!
API 서버가 디버그하기 어려운 예기치 않은 상태 오류를 반환할 때 서비스 계정 이벤트 메시지를 사용하여 OAuth 구성 문제를 진단합니다.
경우에 따라 API 서버는 API 마스터 로그에 직접 액세스하지 않고 디버그하기 어려운 예기치 않은 조건 오류 메시지를 반환합니다. 근본적인 오류 원인은 인증되지 않은 사용자에게 서버 상태에 대한 정보를 제공하지 않기 위해 의도적으로 숨겨져 있습니다.
이러한 오류 중 일부는 서비스 계정 OAuth 구성 문제와 관련이 있습니다. 이와 같은 문제는 관리자가 아닌 사용자가 볼 수 있는 이벤트에서 발견됩니다. OAuth 중에 unexpected condition 서버 오류가 발생하면 oc get events를 실행하여 ServiceAccount에서 해당 이벤트를 확인하십시오.
다음 예는 적절한 OAuth 리디렉션 URI가 없는 서비스 계정에 대해 경고합니다.
$ oc get events | grep ServiceAccount
출력 예
1m 1m 1 proxy ServiceAccount Warning NoSAOAuthRedirectURIs service-account-oauth-client-getter system:serviceaccount:myproject:proxy has no redirectURIs; set serviceaccounts.openshift.io/oauth-redirecturi.<some-value>=<redirect> or create a dynamic URI using serviceaccounts.openshift.io/oauth-redirectreference.<some-value>=<reference>
oc describe sa/<service_account_name>을 실행하면 지정된 서비스 계정 이름과 관련된 OAuth 이벤트가 보고됩니다.
$ oc describe sa/proxy | grep -A5 Events
출력 예
Events:
FirstSeen LastSeen Count From SubObjectPath Type Reason Message
--------- -------- ----- ---- ------------- -------- ------ -------
3m 3m 1 service-account-oauth-client-getter Warning NoSAOAuthRedirectURIs system:serviceaccount:myproject:proxy has no redirectURIs; set serviceaccounts.openshift.io/oauth-redirecturi.<some-value>=<redirect> or create a dynamic URI using serviceaccounts.openshift.io/oauth-redirectreference.<some-value>=<reference>
다음은 가능한 이벤트 오류 목록입니다.
리디렉션 URI 주석이 없거나 유효하지 않은 URI가 지정되었습니다
Reason Message
NoSAOAuthRedirectURIs system:serviceaccount:myproject:proxy has no redirectURIs; set serviceaccounts.openshift.io/oauth-redirecturi.<some-value>=<redirect> or create a dynamic URI using serviceaccounts.openshift.io/oauth-redirectreference.<some-value>=<reference>
잘못된 경로가 지정되었습니다
Reason Message
NoSAOAuthRedirectURIs [routes.route.openshift.io "<name>" not found, system:serviceaccount:myproject:proxy has no redirectURIs; set serviceaccounts.openshift.io/oauth-redirecturi.<some-value>=<redirect> or create a dynamic URI using serviceaccounts.openshift.io/oauth-redirectreference.<some-value>=<reference>]
유효하지 않은 참조 유형이 지정되었습니다
Reason Message
NoSAOAuthRedirectURIs [no kind "<name>" is registered for version "v1", system:serviceaccount:myproject:proxy has no redirectURIs; set serviceaccounts.openshift.io/oauth-redirecturi.<some-value>=<redirect> or create a dynamic URI using serviceaccounts.openshift.io/oauth-redirectreference.<some-value>=<reference>]
SA 토큰이 없습니다
Reason Message
NoSAOAuthTokens system:serviceaccount:myproject:proxy has no tokens