VerifyJWT 정책

이 페이지는 Apigee 및 Apigee Hybrid에 적용됩니다.

대상

서명된 JWT를 확인하거나 클라이언트 또는 기타 시스템에서 수신된 암호화된 JWT를 복호화하고 확인합니다. 또한 이 정책은 클레임을 컨텍스트 변수로 추출하여 이후 정책 또는 조건이 해당 값을 검사하여 승인 또는 라우팅을 결정할 수 있도록 합니다. 자세한 소개는 JWS 및 JWT 정책 개요를 참조하세요.

이 정책은 표준 정책이며 모든 환경 유형에 배포할 수 있습니다. 정책 유형과 각 환경 유형에서의 가용성에 대한 자세한 내용은 정책 유형을 참조하세요.

이 정책이 실행되면 서명된 JWT의 경우 Apigee가 제공된 확인 키를 사용하여 JWT의 서명을 확인합니다. 암호화된 JWT의 경우 Apigee가 복호화 키를 사용하여 JWT를 복호화합니다. 두 경우 모두 Apigee는 JWT가 만료 시점 및 이전 아님 시간(있는 경우)에 따라 유효한지 확인합니다. 정책은 제목, 발급기관, 대상, 추가 클레임 값 등 JWT에서 특정 클레임 값을 선택적으로 확인할 수도 있습니다.

JWT가 확인되고 유효한 경우 JWT에 포함된 모든 클레임은 후속 정책 또는 조건에서 사용할 수 있도록 컨텍스트 변수로 추출되며 요청을 진행할 수 있습니다. JWT 서명을 확인할 수 없거나 타임스탬프 중 하나로 인해 JWT가 유효하지 않은 경우 모든 처리가 중지되고 응답에서 오류가 반환됩니다.

JWT의 부분과 암호화 및 서명 방법을 알아보려면 RFC7519를 참조하세요.

방법

정책이 서명된 JWT 또는 암호화된 JWT를 확인하는지 여부는 JWT를 확인하는 알고리즘을 지정하는 데 사용하는 요소에 따라 다릅니다.

<Algorithm> 요소를 사용하면 정책이 서명된 JWT를 확인합니다.
<Algorithms> 요소를 사용하면 정책이 암호화된 JWT를 확인합니다.

동영상

JWT에서 서명을 확인하는 방법을 알아보려면 짧은 동영상을 시청하세요.

서명된 JWT 확인

이 섹션에서는 서명된 JWT를 확인하는 방법을 설명합니다. 서명된 JWT의 경우 <Algorithm> 요소를 사용하여 키 서명 알고리즘을 지정합니다.

서명된 JWT 샘플

다음 샘플은 서명된 JWT를 확인하는 방법을 보여줍니다.

HS256 알고리즘

이 정책 예시에서는 SHA-256 체크섬을 사용하여 HS256 암호화 알고리즘인 HMAC로 서명된 JWT를 확인합니다. JWT는 프록시 요청에서 jwt라는 양식 매개변수를 사용하여 전달됩니다. 이 키는 private.secretkey라는 변수에 포함됩니다. 위의 동영상을 통해 정책에 대해 요청을 수행하는 방법을 포함한 전체 예시를 확인하세요.

정책 구성에는 Apigee가 JWT를 찾을 수 있는 위치(소스 요소에 지정된 흐름 변수), 필요한 서명 알고리즘, 보안 비밀 키를 찾을 수 있는 위치(예를 들어 Apigee KVM에서 검색할 수 있는 Apigee 흐름 변수에 저장된) 등 Apigee에서 JWT를 디코딩 및 평가하기 위해 필요한 정보가 포함됩니다.

<VerifyJWT name="JWT-Verify-HS256">
    <DisplayName>JWT Verify HS256</DisplayName>
    <Algorithm>HS256</Algorithm>
    <Source>request.formparam.jwt</Source>
    <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
    <SecretKey encoding="base64">
        <Value ref="private.secretkey"/>
    </SecretKey>
    <Subject>monty-pythons-flying-circus</Subject>
    <Issuer>urn://apigee-edge-JWT-policy-test</Issuer>
    <Audience>fans</Audience>
    <AdditionalClaims>
        <Claim name="show">And now for something completely different.</Claim>
    </AdditionalClaims>
</VerifyJWT>

정책은 API 프록시의 후속 정책 또는 조건이 해당 값을 검사할 수 있도록 출력물을 컨텍스트 변수에 씁니다. 이 정책에 의해 설정된 변수 목록은 흐름 변수를 참조하세요.

RS256 알고리즘

참고: 동일한 예시를 사용하여 PS256 또는 ES256 알고리즘의 JWT를 확인합니다. <Algorithm>RS256</Algorithm> 값을 PS256 또는 ES256으로 변경합니다. ES256의 경우 알고리즘과 호환되는 키를 지정해야 합니다. 키 요구사항에 대한 자세한 내용은 서명 암호화 알고리즘 정보를 참조하세요.

이 정책 예시에서는 RS256 알고리즘으로 서명된 JWT를 확인합니다. 확인하려면 공개 키를 제공해야 합니다. JWT는 프록시 요청에서 jwt라는 양식 매개변수를 사용하여 전달됩니다. 공개 키는 이름이 public.publickey인 변수에 포함되어 있습니다. 위의 동영상을 통해 정책에 대해 요청을 수행하는 방법을 포함한 전체 예시를 확인하세요.

이 샘플 정책의 각 요소에 대한 요구사항 및 옵션에 대한 자세한 내용은 요소 참조를 확인하세요.

<VerifyJWT name="JWT-Verify-RS256">
    <Algorithm>RS256</Algorithm>
    <Source>request.formparam.jwt</Source>
    <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
    <PublicKey>
        <Value ref="public.publickey"/>
    </PublicKey>
    <Subject>apigee-seattle-hatrack-montage</Subject>
    <Issuer>urn://apigee-edge-JWT-policy-test</Issuer>
    <Audience>urn://c60511c0-12a2-473c-80fd-42528eb65a6a</Audience>
    <AdditionalClaims>
        <Claim name="show">And now for something completely different.</Claim>
    </AdditionalClaims>
</VerifyJWT>

위 구성의 경우 다음 헤더

{
  "typ" : "JWT",
  "alg" : "RS256"
}

및 다음 페이로드

{
  "sub" : "apigee-seattle-hatrack-montage",
  "iss" : "urn://apigee-edge-JWT-policy-test",
  "aud" : "urn://c60511c0-12a2-473c-80fd-42528eb65a6a",
  "show": "And now for something completely different."
}

가 있는 JWT는 제공된 공개 키로 서명을 확인할 수 있다면 유효한 것으로 간주됩니다.

헤더가 있지만 다음 페이로드

{
  "sub" : "monty-pythons-flying-circus",
  "iss" : "urn://apigee-edge-JWT-policy-test",
  "aud" : "urn://c60511c0-12a2-473c-80fd-42528eb65a6a",
  "show": "And now for something completely different."
}

는 서명을 확인할 수 있어도 유효하지 않은 것으로 결정됩니다. JWT에 포함된 'sub' 클레임이 정책 구성에 지정된 'Subject' 요소의 필수 값과 일치하지 않기 때문입니다.

위 샘플에서는 <Algorithm> 요소를 사용하므로 서명된 JWT를 확인합니다. <PrivateKey> 요소는 JWT를 서명하는 데 사용되는 키를 지정합니다. 다른 주요 요소도 있습니다. 사용하는 요소는 다음 섹션에서 설명된 대로 <Algorithm> 값에 지정된 알고리즘에 따라 달라집니다.

서명된 JWT를 확인하도록 키 요소 설정

다음 요소는 서명된 JWT를 확인하는 데 사용되는 키를 지정합니다.

<SecretKey>
<PublicKey>

사용하는 요소는 다음 표와 같이 선택한 알고리즘에 따라 다릅니다.

알고리즘	주요 요소
HS*	<SecretKey encoding="base16\|hex\|base64\|base64url"> <Value ref="private.secretkey"/> </SecretKey>
RS, ES, PS*	<PublicKey> <Value ref="rsa_public_key_or_value"/> </PublicKey> 또는 <PublicKey> <Certificate ref="signed_cert_val_ref"/> </PublicKey> 또는 <PublicKey> <JWKS ref="jwks_val_or_ref"/> </PublicKey>
^*키 요구사항에 대한 자세한 내용은 서명 암호화 알고리즘 정보를 참조하세요.

알고리즘

주요 요소

HS*

<SecretKey encoding="base16|hex|base64|base64url">
  <Value ref="private.secretkey"/>
</SecretKey>

RS*, ES*, PS*

<PublicKey>
  <Value ref="rsa_public_key_or_value"/>
</PublicKey>

또는

<PublicKey>
  <Certificate ref="signed_cert_val_ref"/>
</PublicKey>

또는

<PublicKey>
  <JWKS ref="jwks_val_or_ref"/>
</PublicKey>

^*키 요구사항에 대한 자세한 내용은 서명 암호화 알고리즘 정보를 참조하세요.

암호화된 JWT 확인

이 섹션에서는 암호화된 JWT를 확인하는 방법을 설명합니다. 암호화된 JWT의 경우 <Algorithms> 요소를 사용하여 키 및 콘텐츠 서명 알고리즘을 지정합니다.

암호화된 JWT 샘플

다음 샘플은 암호화된 JWT(<Type>이 Encrypted로 설정된 경우)를 확인하는 방법을 보여줍니다.

키는 RSA-OAEP-256 알고리즘으로 암호화됩니다.
콘텐츠는 A128GCM 알고리즘으로 암호화됩니다.

<VerifyJWT name="vjwt-1">
  <Algorithms>
    <Key>RSA-OAEP-256</Key>
    <Content>A128GCM</Content>
  </Algorithms>
  <Type>Encrypted</Type> 
  <PrivateKey>
    <Value ref="private.rsa_privatekey"/>
  </PrivateKey>
  <Subject>subject@example.com</Subject>
  <Issuer>urn://apigee</Issuer>
  <AdditionalHeaders>
    <Claim name="moniker">Harvey</Claim>
  </AdditionalHeaders>
  <TimeAllowance>30s</TimeAllowance>
  <Source>input_var</Source>
</VerifyJWT>

위 샘플은 <Algorithms> 요소를 사용하므로 암호화된 JWT를 확인합니다. <PrivateKey> 요소는 JWT를 복호화하는 데 사용되는 키를 지정합니다. 다른 주요 요소도 있습니다. 사용하는 요소는 다음 섹션에서 설명된 대로 <Algorithms> 값에 지정된 알고리즘에 따라 달라집니다.

암호화된 JWT를 확인하기 위한 키 요소 설정

다음 요소는 암호화된 JWT를 확인하는 데 사용되는 키를 지정합니다.

<PrivateKey>
<SecretKey>
<PasswordKey>
<DirectKey>

사용하는 요소는 다음 표와 같이 선택한 키 암호화 알고리즘에 따라 다릅니다.

알고리즘	주요 요소
RSA-OAEP-256	<PrivateKey> <Value ref="private.rsa_privatekey"/> </PrivateKey> 참고: 지정하는 변수는 PEM 인코딩 형식의 RSA 비공개 키로 확인되어야 합니다.
ECDH-ES ECDH-ES+A128KW ECDH-ES+A192KW ECDH-ES+A256KW	<PrivateKey> <Value ref="private.ec_privatekey"/> </PrivateKey> 참고: 지정하는 변수는 PEM 인코딩 형식의 타원 곡선 비공개 키로 확인되어야 합니다.
A128KW A192KW A256KW A128GCMKW A192GCMKW A256GCMKW	<SecretKey encoding="base16\|hex\|base64\|base64url"> <Value ref="private.flow-variable-name-here"/> </SecretKey>
PBES2-HS256+A128KW PBES2-HS384+A192KW PBES2-HS512+A256KW	<PasswordKey> <Value ref="private.password-key"/> <SaltLength> <PBKDF2Iterations> </PasswordKey>
dir	<DirectKey> <Value encoding="base16\|hex\|base64\|base64url" ref="private.directkey"/> </DirectKey>

키 요구사항에 대한 자세한 내용은 서명 암호화 알고리즘 정보를 참조하세요.

요소 참조

정책 참조는 JWT 확인 정책의 요소 및 속성을 설명합니다.

참고: 구성은 사용하는 암호화 알고리즘에 따라 다소 달라질 수 있습니다. 특정 사용 사례의 구성을 보여주는 예시는 샘플을 참조하세요.

최상위 요소에 적용되는 속성

<VerifyJWT name="JWT" continueOnError="false" enabled="true" async="false">

다음 속성은 모든 정책 상위 요소에 공통적으로 적용됩니다.

속성	설명	기본	Presence
이름	정책의 내부 이름입니다. 이름에 사용할 수 있는 문자는 `A-Z0-9._\-$ %`로 제한됩니다. 그러나 Apigee UI는 영숫자가 아닌 문자를 자동으로 삭제하는 등 추가 제한사항을 적용합니다. 선택적으로 `<displayname></displayname>` 요소를 사용하여 관리 UI 프록시 편집기에서 다른 자연어 이름으로 정책에 라벨을 지정합니다.	해당 사항 없음	필수
continueOnError	정책이 실패할 경우 오류가 반환되도록 하려면 `false`로 설정합니다. 이는 대부분의 정책에서 예상되는 동작입니다. 정책이 실패해도 흐름 실행이 계속되도록 하려면 `true`로 설정합니다.	false	선택사항
사용 설정됨	정책을 시행하려면 `true`로 설정합니다. `false`로 설정하여 정책을 '사용 중지'합니다. 정책이 흐름에 연결되어 있어도 정책이 시행되지 않습니다.	true	선택사항
async	이 속성은 지원이 중단되었습니다.	false	지원 중단됨

<DisplayName>

<DisplayName>Policy Display Name</DisplayName>

이름 속성 외에도 이 요소를 사용하여 관리 UI 프록시 편집기에서 다른 자연어 이름으로 정책에 라벨을 지정합니다.

기본	이 요소를 생략하면 정책 이름 속성 값이 사용됩니다.
Presence	선택사항
유형	문자열

<Algorithm>

<Algorithm>HS256</Algorithm>

토큰을 확인하는 데 사용되는 암호화 알고리즘을 지정합니다. <Algorithm> 요소를 사용하여 서명된 JWT를 확인합니다.

RS*/PS*/ES* 알고리즘은 공개/보안 비밀 키 쌍을 사용하지만 HS* 알고리즘은 공유 보안 비밀을 사용합니다. 서명 암호화 알고리즘 정보도 참조하세요.

참고: <Algorithm> 및 <Algorithms> 요소 중 하나만 사용합니다.

여러 값을 쉼표로 구분하여 지정할 수 있습니다. 예를 들면 'HS256, HS512' 또는 'RS256, PS256'입니다. 그러나 HS* 알고리즘은 다른 알고리즘이나 ES* 알고리즘과 결합할 수 없습니다. 이 경우 특정 키 유형이 필요합니다. RS* 및 PS* 알고리즘은 결합할 수 있습니다.

기본	해당 사항 없음
Presence	필수
유형	쉼표로 구분된
유효한 값	HS256, HS384, HS512, RS256, RS384, RS512, ES256, ES384, ES512, PS256, PS384, PS512

<Algorithms>

<Algorithms>
    <Key>key-algorithm</Key>
    <Content>content-algorithm</Content>
</Algorithm>

<Algorithms> 요소를 사용하여 암호화된 JWT를 확인합니다. 이 요소는 암호화된 JWT가 생성될 때 사용되었어야 하는 키 암호화의 암호화 알고리즘을 지정합니다. 또한, 선택적으로 콘텐츠 암호화를 위한 알고리즘을 지정합니다.

참고: <Algorithm> 및 <Algorithms> 요소 중 하나만 사용합니다.

기본	해당 사항 없음
Presence	암호화된 JWT를 확인할 때 필요
유형	단지

`<Algorithms>` 하위 요소

다음 표에서는 <Algorithms> 하위 요소를 간략하게 설명합니다.

하위 요소	필수 여부	설명
`<Key>`	필수	키의 암호화 알고리즘을 지정합니다.
`<Content>`	선택사항	콘텐츠의 암호화 알고리즘을 지정합니다.

다음과 같은 경우 인증에 실패합니다.

암호화된 JWT의 헤더에 있는 alg 속성에서 어설션된 알고리즘이 여기에 있는 <Key> 요소에 지정된 키 암호화 알고리즘과 다릅니다.
정책이 <Content> 요소를 지정하고 암호화된 JWT의 헤더에 있는 enc 속성에서 어설션된 알고리즘이 <Content> 요소에 지정된 알고리즘과 다릅니다.

예를 들어 암호화된 JWT를 확인하고, 키 알고리즘이 RSA-OAEP-256이며, 콘텐츠 알고리즘이 A128GCM인지 확인하려면 다음 안내를 따르세요.

  <Algorithms>
    <Key>RSA-OAEP-256</Key>
    <Content>A128GCM</Content>
  </Algorithms>

반대로 암호화된 JWT를 확인하고 키 알고리즘이 RSA-OAEP-256이고 콘텐츠 알고리즘에 제약조건을 적용하지 않으려면 다음 안내를 따르세요.

  <Algorithms>
    <Key>RSA-OAEP-256</Key>
  </Algorithms>

키 암호화 알고리즘

다음 표에는 키 암호화에 사용할 수 있는 알고리즘과 해당 키 암호화 알고리즘을 사용하여 JWT를 확인하기 위해 지정해야 하는 키 유형이 나와 있습니다.

`<Key>`의 값(키 암호화 알고리즘)	확인에 필요한 핵심 요소
dir	`<DirectKey>`
RSA-OAEP-256	`<PrivateKey>`
A128KW A192KW A256KW A128GCMKW A192GCMKW A256GCMKW	`<SecretKey>`
PBES2-HS256+A128KW PBES2-HS384+A192KW PBES2-HS512+A256KW	`<PasswordKey>`
ECDH-ES ECDH-ES+A128KW ECDH-ES+A192KW ECDH-ES+A256KW	`<PrivateKey>`

<PrivateKey> 요소를 사용하도록 키 암호화 알고리즘이 RSA-OAEP-256인 예시는 암호화된 JWT 확인을 참조하세요.

콘텐츠 암호화 알고리즘

VerifyJWT 정책에서는 콘텐츠 암호화 알고리즘을 지정할 필요가 없습니다. 콘텐츠 암호화에 사용되는 알고리즘을 지정하려면 <Algorithms> 요소의 <Content> 하위 요소를 사용하여 지정합니다.

키 암호화 알고리즘과 관계없이 다음 알고리즘(모두 대칭 및 AES 기반)이 콘텐츠 암호화에 지원됩니다.

A128CBC-HS256
A192CBC-HS384
A256CBC-HS512
A128GCM
A192GCM
A256GCM

<Audience>

<Audience>audience-here</Audience>

or:

<Audience ref='variable-name-here'/>

정책은 JWT의 대상 클레임이 구성에 지정된 값과 일치하는지 확인합니다. 일치하는 항목이 없다면 정책에 오류가 발생합니다. 이 클레임은 JWT가 대상인 수신자를 식별하며, RFC7519에 언급된, 등록된 클레임 중 하나입니다.

기본	해당 사항 없음
Presence	선택사항
유형	문자열
유효한 값	대상을 식별하는 흐름 변수 또는 문자열입니다.

<AdditionalClaims/Claim>

<AdditionalClaims>
    <Claim name='claim1'>explicit-value-of-claim-here</Claim>
    <Claim name='claim2' ref='variable-name-here'/>
    <Claim name='claim3' ref='variable-name-here' type='boolean'/>
</AdditionalClaims>

or:

<AdditionalClaims ref='claim_payload'/>

JWT 페이로드에 지정된 추가 클레임이 포함되어 있고 어설션된 클레임 값이 일치하는지 확인합니다.

<Claim> 요소는 메시지 템플릿이라는 동적 문자열 대체 기능을 지원합니다.

추가 클레임은 등록된 표준 JWT 클레임 이름이 아닌 이름을 사용합니다. 추가 클레임 값은 문자열, 숫자, 부울, 지도, 배열일 수 있습니다. 지도는 단순히 이름/값 쌍의 조합입니다. 이러한 모든 유형의 클레임 값은 정책 구성에서 명시적으로 지정하거나 흐름 변수 참조를 통해 간접적으로 지정할 수 있습니다.

기본	해당 사항 없음
Presence	선택사항
유형	문자열, 숫자, 부울 또는 지도
배열	값이 유형 배열인지 여부를 나타내기 위해 true로 설정합니다. 기본값: false
유효한 값	추가 클레임에 사용할 모든 값입니다.

<Claim> 요소는 다음 속성을 사용합니다.

name - (필수) 클레임의 이름입니다.
참고: 이 요소에 등록된 모든 클레임 이름은 사용하지 마세요. 등록된 클레임은 RFC7519에 지정되며, "iss", "sub", "aud", "iat", "exp", "nbf", "jti"가 포함됩니다.
ref - (선택사항) 흐름 변수의 이름입니다. 이 이름이 있으면 정책에서는 이 변수의 값을 클레임으로 사용합니다. ref 속성 및 명시적 클레임 값이 모두 지정되면 명시적 값이 기본값이 되고 참조된 흐름 변수가 해결되지 않은 경우에 사용됩니다.
type - (선택사항) 문자열(기본값), 숫자, 부울, 맵 중 하나입니다.
array - (선택사항) 값이 유형의 배열인지 나타내려면 true로 설정합니다. 기본값은 false입니다.

<Claim> 요소를 포함하면 정책을 구성할 때 클레임 이름이 정적으로 설정됩니다. 또는 JSON 객체를 전달하여 클레임 이름을 지정할 수 있습니다. JSON 객체는 변수로 전달되므로 클레임 이름은 런타임에 결정됩니다.

예를 들면 다음과 같습니다.

<AdditionalClaims ref='json_claims'/>

여기서 변수 json_claims에는 JSON 객체가 다음 형식으로 포함됩니다.

{
  "sub" : "person@example.com",
  "iss" : "urn://secure-issuer@example.com",
  "non-registered-claim" : {
    "This-is-a-thing" : 817,
    "https://example.com/foobar" : { "p": 42, "q": false }
  }
}

<AdditionalHeaders/Claim>

<AdditionalHeaders>
    <Claim name='claim1'>explicit-value-of-claim-here</Claim>
    <Claim name='claim2' ref='variable-name-here'/>
    <Claim name='claim3' ref='variable-name-here' type='boolean'/>
    <Claim name='claim4' ref='variable-name' type='string' array='true'/>
</AdditionalHeaders>

JWT 헤더에 지정된 추가 클레임 이름/값 쌍이 포함되어 있고 어설션된 클레임 값이 일치하는지 확인합니다.

<Claim> 요소는 메시지 템플릿이라는 동적 문자열 대체 기능을 지원합니다.

추가 클레임은 등록된 표준 JWT 클레임 이름이 아닌 다른 이름을 사용합니다. 추가 클레임 값은 문자열, 숫자, 부울, 지도, 배열일 수 있습니다. 지도는 단순히 이름/값 쌍의 조합입니다. 이러한 모든 유형의 클레임 값은 정책 구성에서 명시적으로 지정하거나 흐름 변수 참조를 통해 간접적으로 지정할 수 있습니다.

기본	해당 사항 없음
Presence	선택사항
유형	문자열(기본값), 숫자, 부울 또는 맵입니다. 유형이 지정되지 않은 경우 유형은 기본적으로 문자열입니다.
배열	값이 유형 배열인지 여부를 나타내기 위해 true로 설정합니다. 기본값: false
유효한 값	추가 클레임에 사용할 모든 값입니다.

<Claim> 요소는 다음 속성을 사용합니다.

name - (필수) 클레임의 이름입니다.
참고: 이 요소에 등록된 모든 클레임 이름은 사용하지 마세요. 등록된 클레임은 RFC7519에 지정되며, "iss", "sub", "aud", "iat", "exp", "nbf", "jti"가 포함됩니다.
ref - (선택사항) 흐름 변수의 이름입니다. 이 이름이 있으면 정책에서는 이 변수의 값을 클레임으로 사용합니다. ref 속성 및 명시적 클레임 값이 모두 지정되면 명시적 값이 기본값이 되고 참조된 흐름 변수가 해결되지 않은 경우에 사용됩니다.
type - (선택사항) 문자열(기본값), 숫자, 부울, 맵 중 하나입니다.
array - (선택사항) 값이 유형의 배열인지 나타내려면 true로 설정합니다. 기본값은 false입니다.

<CustomClaims>

참고: 현재 UI를 통해 새 GenerateJWT 정책을 추가하면 CustomClaims 요소가 삽입됩니다. 이 요소는 작동하지 않으며 무시됩니다. 대신 사용할 수 있는 올바른 요소는 <AdditionalClaims>입니다. 이 UI는 나중에 올바른 요소를 삽입하도록 업데이트됩니다.

<Id>

<Id>explicit-jti-value-here</Id>
 -or-
<Id ref='variable-name-here'/>
 -or-
<Id/>

JWT에 특정 jti 클레임이 있는지 확인합니다. 텍스트 값과 ref 속성이 모두 비어있으면 정책은 임의의 UUID를 포함하는 jti를 생성합니다. JWT ID(jti) 클레임은 JWT의 고유 식별자입니다. jti에 대한 자세한 내용은 RFC7519를 참조하세요.

기본	해당 사항 없음
Presence	선택사항
유형	문자열 또는 참조
유효한 값	문자열 또는 ID가 포함된 흐름 변수의 이름

<IgnoreCriticalHeaders>

<IgnoreCriticalHeaders>true|false</IgnoreCriticalHeaders>

JWT의 crit 헤더에 나열된 헤더가 <KnownHeaders> 요소에 나열되지 않는 경우 정책에서 오류가 발생하도록 하려면 false로 설정합니다. VerifyJWT 정책이 crit 헤더를 무시하도록 하려면 true로 설정합니다.

이 요소를 true로 설정하는 한 가지 이유는 테스트 환경을 사용 중이고 아직 누락된 헤더에 대한 오류를 처리할 준비가 되지 않은 경우입니다.

기본	false
Presence	선택사항
유형	부울
유효한 값	true 또는 false

<IgnoreIssuedAt>

<IgnoreIssuedAt>true|false</IgnoreIssuedAt>

JWT에 이후 시간을 지정하는 iat(발급 시점) 클레임이 포함된 경우 정책에서 오류를 발생시키려면 false(기본값)로 설정합니다. 확인 중 정책에서 iat를 무시하도록 하려면 true로 설정하세요.

기본	false
Presence	선택사항
유형	부울
유효한 값	true 또는 false

<IgnoreUnresolvedVariables>

<IgnoreUnresolvedVariables>true|false</IgnoreUnresolvedVariables>

정책에 지정된 참조 변수를 해결할 수 없는 경우 정책에서 오류가 발생하게 하려면 false로 설정합니다. 해결할 수 없는 변수를 빈 문자열(null)로 취급하려면 true로 설정합니다.

기본	false
Presence	선택사항
유형	부울
유효한 값	true 또는 false

<Issuer>

<VerifyJWT name='VJWT-29'>
  ...
  <!-- verify that the iss claim matches a hard-coded value -->
  <Issuer>issuer-string-here</Issuer>

  or:

  <!-- verify that the iss claim matches the value contained in a variable -->
  <Issuer ref='variable-containing-issuer'/>

  or:

  <!-- verify via a variable; fallback to a hard-coded value if the variable is empty -->
  <Issuer ref='variable-containing-issuer'>fallback-value-here</Issuer>

정책은 JWT의 발급기관(iss 클레임)이 구성 요소에 지정된 문자열과 일치하는지 확인합니다. iss 클레임은 IETF RFC 7519에 언급된, 등록된 클레임 중 하나입니다.

기본	해당 사항 없음
Presence	선택사항
유형	문자열 또는 참조
유효한 값	모두

<KnownHeaders>

<KnownHeaders>a,b,c</KnownHeaders>

or:

<KnownHeaders ref='variable_containing_headers'/>

GenerateJWT 정책은 <CriticalHeaders> 요소를 사용하여 토큰의 crit 헤더를 입력합니다. 예를 들면 다음과 같습니다.

{
  "typ": "...",
  "alg" : "...",
  "crit" : [ "a", "b", "c" ],
}

VerifyJWT 정책은 JWT의 crit 헤더(있는 경우)를 검사하고, 나열된 각 헤더에 대해 <KnownHeaders> 요소에 해당 헤더가 나열되어 있는지 확인합니다. <KnownHeaders> 요소에는 crit에 나열된 항목의 상위 집합이 포함될 수 있습니다. crit에 나열된 모든 헤더만 <KnownHeaders> 요소에 나열되어야 합니다. 정책이 crit에서 발견하고 <KnownHeaders>에도 나열되지 않는 모든 헤더는 VerifyJWT 정책에 오류를 발생시킵니다.

선택적으로 <IgnoreCriticalHeaders> 요소를 true로 설정하여 crit 헤더를 무시하도록 VerifyJWT 정책을 구성할 수 있습니다.

참고: VerifyJWT 정책은 실제로 <KnownHeaders> 요소로 나열된 헤더를 취급하거나 처리하지 않습니다. 나중에 프록시 또는 백엔드에서 실제로 이러한 헤더를 처리하도록 남아 있습니다.

기본	해당 사항 없음
Presence	선택사항
유형	쉼표로 구분된 문자열 배열
유효한 값	배열 또는 배열이 포함된 변수의 이름

<MaxLifespan>

  <VerifyJWT name='VJWT-62'>
  ...
  <!-- hard-coded lifespan of 5 minutes -->
  <MaxLifespan>5m</MaxLifespan>

  or:

  <!-- refer to a variable -->
  <MaxLifespan ref='variable-here'/>

  or:

  <!-- attribute telling the policy to use iat rather than nbf -->
  <MaxLifespan useIssueTime='true'>1h</MaxLifespan>

  or:

  <!-- useIssueTime and ref, and hard-coded fallback value. -->
  <MaxLifespan useIssueTime='true' ref='variable-here'>1h</MaxLifespan>
  ...

토큰의 수명이 지정된 임곗값을 초과하지 않도록 VerifyJWT 정책을 구성합니다. 초, 분, 시간, 일, 주를 나타내는 숫자와 문자를 사용하여 임곗값을 지정할 수 있습니다. 유효한 문자는 다음과 같습니다.

s - 초
m - 분
h - 시간
d - 일
w - 주

예를 들어 120s, 10m, 1h, 7d, 3w 중 하나를 지정할 수 있습니다.

이 정책은 만료 값 (exp)에서 이전 아님 값 (nbf)를 빼서 토큰의 실제 수명을 계산합니다. exp 또는 nbf가 누락되면 정책에서 오류가 발생합니다. 토큰 수명이 지정된 기간을 초과하면 정책에서 오류가 발생합니다.

토큰 수명을 계산할 때 nbf 값 대신 iat 값을 사용하도록 선택적 속성 useIssueTime을 true로 설정할 수 있습니다.

MaxLifespan 요소 사용은 선택사항입니다. 이 요소를 사용하는 경우 한 번만 사용할 수 있습니다.

<PrivateKey>

이 요소를 사용하여 비대칭 알고리즘으로 암호화된 JWT를 확인하는 데 사용할 수 있는 비공개 키를 지정합니다. 다음은 가능한 하위 요소에 대한 설명입니다.

<Password>

<PrivateKey>
  <Password ref="private.privatekey-password"/>
</PrivateKey>

<PrivateKey> 요소의 하위 요소입니다. 필요한 경우 암호화된 JWT를 확인할 때 정책에서 비공개 키를 복호화하는 데 사용할 비밀번호를 지정합니다. ref 속성을 사용하여 흐름 변수의 비밀번호를 전달합니다.

기본	해당 사항 없음
Presence	선택사항
유형	문자열
유효한 값	흐름 변수 참조입니다. 참고: 흐름 변수를 지정해야 합니다. Apigee는 비밀번호가 일반 텍스트로 지정된 정책 구성을 유효하지 않다고 여겨 거부합니다. 흐름 변수에는 프리픽스 'private'이 있어야 합니다. 예를 들면 `private.mypassword`입니다.

<Value>

<PrivateKey>
  <Value ref="private.variable-name-here"/>
</PrivateKey>

<PrivateKey> 요소의 하위 요소입니다. 정책에서 암호화된 JWT를 확인하는 데 사용할 PEM 인코딩 비공개 키를 지정합니다. ref 속성을 사용하여 흐름 변수의 키를 전달합니다.

기본	해당 사항 없음
Presence	비대칭 키 암호화 알고리즘을 사용하여 암호화된 JWT를 확인하는 데 필요합니다.
유형	문자열
유효한 값	PEM 인코딩 RSA 비공개 키 값을 나타내는 문자열을 포함하는 흐름 변수입니다. 참고: 흐름 변수에는 프리픽스 'private'이 있어야 합니다. 예를 들면 `private.mykey`입니다.

<PublicKey>

비대칭 알고리즘으로 서명된 JWT를 확인하는 데 사용되는 공개 키의 소스를 지정합니다. 지원되는 알고리즘은 RS256/RS384/RS512, PS256/PS384/PS512 또는 ES256/ES384/ES512.입니다. 가능한 하위 요소에 대한 설명은 다음과 같습니다.

<Certificate>

<PublicKey>
  <Certificate ref="signed_public.cert"/>
</PublicKey>

-or-

<PublicKey>
  <Certificate>
-----BEGIN CERTIFICATE-----
cert data
-----END CERTIFICATE-----
  </Certificate>
</PublicKey>

<PublicKey> 요소의 하위 요소입니다. 공개 키의 소스로 사용되는 서명된 인증서를 지정합니다. ref 속성을 사용하여 흐름 변수에 서명된 인증서를 전달하거나 PEM으로 인코딩된 인증서를 직접 지정합니다.

기본	해당 사항 없음
Presence	선택사항. 비대칭 알고리즘으로 서명된 JWT를 확인하려면 `<Certificate>`, `<JWKS>` 또는 `<Value>` 요소를 사용하여 공개 키를 제공해야 합니다.
유형	문자열
유효한 값	흐름 변수 또는 문자열입니다.

<JWKS>

  <PublicKey>
    <JWKS …  > … </JWKS>
  </PublicKey>

<PublicKey> 요소의 하위 요소입니다. JWKS를 공개 키 소스로 지정합니다. 이는 IETF RFC 7517 - JSON 웹 키(JWK)에 설명된 형식을 따르는 키 목록입니다.

인바운드 JWT가 JWKS에 있는 키 ID를 가지고 있는 경우 정책은 올바른 공개 키를 사용하여 JWT 서명을 확인합니다. 이 기능에 대한 자세한 내용은 JSON 웹 키 세트(JWKS)를 사용하여 JWT 확인을 참조하세요.

공개 URL에서 값을 가져오면 Apigee는 JWKS를 300초 동안 캐시합니다. 캐시가 만료되면 Apigee가 JWKS를 다시 가져옵니다.

기본	해당 사항 없음
Presence	선택사항. 비대칭 알고리즘으로 서명된 JWT를 확인하려면 `<Certificate>`, `<JWKS>` 또는 `<Value>` 요소를 사용하여 공개 키를 제공해야 합니다.
유형	문자열
유효한 값	다음 4가지 방법 중 하나로 JWKS를 지정할 수 있습니다. 문자 그대로 텍스트 값으로 지정합니다. <PublicKey> <JWKS>{ "keys": [ {"kty":"RSA","e":"AQAB","kid":"b3918c88","n":"jxdm..."}, {"kty":"RSA","e":"AQAB","kid":"24f094d4","n":"kWRdbgMQ..."} ] } </JWKS> </PublicKey> 간접적으로 흐름 변수를 지정해서 `ref` 속성을 사용하여 지정합니다. <PublicKey> <JWKS ref="variable-containing-jwks-content"/> </PublicKey> 참조된 변수에는 JWKS를 나타내는 문자열이 포함되어야 합니다. `uri` 속성을 사용하여 정적 URI를 통해 간접적으로 지정합니다. <PublicKey> <JWKS uri="uri-that-returns-a-jwks"/> </PublicKey> `uriRef` 속성을 사용해서 동적으로 확인된 URI를 통해 간접적으로 지정합니다. <PublicKey> <JWKS uriRef="variable-containing-a-uri-that-returns-a-jwks"/> </PublicKey>

<Value>

<PublicKey>
  <Value ref="public.publickeyorcert"/>
</PublicKey>

-or-

<PublicKey>
  <Value>
-----BEGIN PUBLIC KEY-----
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAw2kPrRzcufvUNHvTH/WW
...YOUR PUBLIC KEY MATERIAL HERE....d1lH8MfUyRXmpmnNxJHAC2F73IyN
ZmkDb/DRW5onclGzxQITBFP3S6JXd4LNESJcTp705ec1cQ9Wp2Kl+nKrKyv1E5Xx
DQIDAQAB
-----END PUBLIC KEY-----
  </Value>
</PublicKey>

<PublicKey> 요소의 하위 요소입니다. 서명된 JWT에서 서명을 확인하는 데 사용할 공개 키를 지정합니다. ref 속성을 사용하여 흐름 변수의 키를 전달하거나 PEM으로 인코딩된 키를 직접 지정합니다.

기본	해당 사항 없음
Presence	선택사항. 비대칭 알고리즘으로 서명된 JWT를 확인하려면 `<Certificate>`, `<JWKS>` 또는 `<Value>` 요소를 사용하여 공개 키를 제공해야 합니다.
유형	문자열
유효한 값	흐름 변수 또는 문자열입니다.

<RequiredClaims>

<VerifyJWT name='VJWT-1'>
  ...
  <!-- Directly specify the names of the claims to require -->
  <RequiredClaims>sub,iss,exp</RequiredClaims>

  -or-

  <!-- Specify the claim names indirectly, via a context variable -->
  <RequiredClaims ref='claims_to_require'/>
  ...
</VerifyJWT>

<RequiredClaims> 요소는 선택사항입니다. JWT를 확인할 때 JWT 페이로드에 있어야 하는 클레임 이름의 쉼표로 구분된 목록을 지정합니다. 이 요소는 표시된 JWT에 필수 클레임이 포함되어 있는지 확인하지만 클레임의 콘텐츠는 검증하지 않습니다. 나열된 클레임이 없으면 런타임 시 VerifyJWT 정책이 오류를 발생시킵니다.

기본	해당 사항 없음
Presence	선택사항
유형	문자열
유효한 값	클레임 이름을 쉼표로 구분한 목록입니다.

<SecretKey>

<SecretKey encoding="base16|hex|base64|base64url" >
  <Value ref="private.your-variable-name"/>
</SecretKey>

SecretKey 요소는 선택사항입니다. 이것으로 대칭(HS*) 알고리즘을 인증하는 서명된 JWT를 생성하거나 키 암호화에 대칭(AES) 알고리즘을 사용하는 암호화된 JWT를 인증할 때 사용할 보안 비밀 키를 지정합니다.

`<SecretKey>`의 하위 요소

다음 표에서는 <SecretKey>의 하위 요소와 속성에 대한 설명을 제공합니다.

자녀 Presence 설명

인코딩(속성)

선택사항

자녀	Presence	설명
인코딩(속성)	선택사항	참조된 변수에서 키가 인코딩되는 방식을 지정합니다. 기본적으로 `encoding` 속성이 없으면 키 인코딩이 UTF-8로 처리됩니다. 속성에 유효한 값은 16진수, base16, base64 또는 base64url입니다. 인코딩 값 16진수와 base16은 동의어입니다. <SecretKey encoding="hex" > <Value ref="private.secretkey"/> </SecretKey> 위의 예시에서는 인코딩이 `hex`이므로 변수 `private.secretkey`의 콘텐츠가 `494c6f766541504973`이면 키가 9바이트 집합으로 디코딩되며, 16진수로는 `49 4c 6f 76 65 41 50 49 73`가 됩니다. 참고: Apigee는 최소한의 키 안전성을 적용합니다. 자세한 내용은 `Value` 요소에 대한 문서를 참조하세요.
값(요소)	필수	인코딩된 보안 비밀 키 페이로드를 확인하는 데 사용되는 보안 비밀 키를 지정합니다. `ref` 속성을 사용하여 `private.secret-key`와 같은 변수를 통해 간접적으로 키를 제공합니다 . <SecretKey> <Value ref="private.my-secret-variable"/> </SecretKey> 참고: 위 예시와 같이 변수 이름에는 private 프리픽스가 포함되어야 합니다. Apigee는 HS256/HS384/HS512 알고리즘에 최소한의 키 안전성을 적용합니다. 최소 키 길이는 HS256의 경우 32바이트, HS384의 경우 48바이트, HS512의 경우 64바이트입니다. 낮은 안정성의 키를 사용하면 런타임 오류가 발생합니다.

참조된 변수에서 키가 인코딩되는 방식을 지정합니다. 기본적으로 encoding 속성이 없으면 키 인코딩이 UTF-8로 처리됩니다. 속성에 유효한 값은 16진수, base16, base64 또는 base64url입니다. 인코딩 값 16진수와 base16은 동의어입니다.

<SecretKey encoding="hex" >
  <Value ref="private.secretkey"/>
</SecretKey>

위의 예시에서는 인코딩이 hex이므로 변수 private.secretkey의 콘텐츠가 494c6f766541504973이면 키가 9바이트 집합으로 디코딩되며, 16진수로는 49 4c 6f 76 65 41 50 49 73가 됩니다.

참고: Apigee는 최소한의 키 안전성을 적용합니다. 자세한 내용은 Value 요소에 대한 문서를 참조하세요.

값(요소)

필수

인코딩된 보안 비밀 키 페이로드를 확인하는 데 사용되는 보안 비밀 키를 지정합니다. ref 속성을 사용하여 private.secret-key와 같은 변수를 통해 간접적으로 키를 제공합니다 .

<SecretKey>
  <Value ref="private.my-secret-variable"/>
</SecretKey>

Apigee는 HS256/HS384/HS512 알고리즘에 최소한의 키 안전성을 적용합니다. 최소 키 길이는 HS256의 경우 32바이트, HS384의 경우 48바이트, HS512의 경우 64바이트입니다. 낮은 안정성의 키를 사용하면 런타임 오류가 발생합니다.

<Source>

<Source>jwt-variable</Source>

존재하는 경우 정책에서 확인 대상 JWT를 찾을 흐름 변수를 지정합니다.

이 요소를 사용하면 양식 또는 쿼리 파라미터 변수나 기타 변수에서 JWT를 검색하도록 정책을 구성할 수 있습니다. 이 요소가 있으면 정책은 존재할 수 있는 Bearer 프리픽스를 제거하지 않습니다. 변수가 존재하지 않거나 정책이 지정된 변수에서 JWT를 찾지 못하면 정책이 오류를 반환합니다.

기본적으로 <Source> 요소가 없으면 정책은 request.header.authorization 변수를 읽고 Bearer 프리픽스를 제거하여 JWT를 검색합니다. JWT를 승인 헤더에서 Bearer 토큰(Bearer 프리픽스 포함)으로 전달하는 경우 정책 구성에서 <Source> 요소를 지정하지 마세요. 예를 들어 다음과 같이 승인 헤더에 JWT를 전달하는 경우 정책 구성에 <Source> 요소를 사용하지 않습니다.

curl -v https://api-endpoint/proxy1_basepath/api1 -H "Authorization: Bearer eyJhbGciOiJ..."

기본	`request.header.authorization` (기본값에 관한 중요한 정보는 위 참고 사항을 확인하세요.)
Presence	선택사항
유형	문자열
유효한 값	Apigee 흐름 변수 이름입니다.

<Subject>

<VerifyJWT name='VJWT-8'>
  ...
  <!-- verify that the sub claim matches a hard-coded value -->
  <Subject>subject-string-here</Subject>

  or:

  <!-- verify that the sub claim matches the value contained in a variable -->
  <Subject ref='variable-containing-subject'/>

  or:

  <!-- verify via a variable; fallback to a hard-coded value if the variable is empty -->
  <Subject ref='variable-containing-subject'>fallback-value-here</Subject>

정책은 JWT의 제목(sub 클레임)이 정책 구성에 지정된 문자열과 일치하는지 확인합니다. sub 클레임은 RFC7519에 설명된 등록된 클레임 중 하나입니다.

기본	해당 사항 없음
Presence	선택사항
유형	문자열
유효한 값	제목을 고유하게 식별하는 모든 값.

<TimeAllowance>

<VerifyJWT name='VJWT-23'>
  ...
  <!-- configure a hard-coded time allowance of 20 seconds -->
  <TimeAllowance>20s</TimeAllowance>

  or:

  <!-- refer to a variable containing the time allowance -->
  <TimeAllowance ref='variable-containing-time-allowance'/>

  or:

  <!-- refer to a variable; fallback to a hard-coded value if the variable is empty -->
  <TimeAllowance ref='variable-containing-allowance'>30s</TimeAllowance>

JWT의 발급기관과 확인자 간의 시계 보정값을 고려하기 위한 시간의 '유예 기간'입니다. 이는 만료(exp 클레임)와 이후 시간(nbf 클레임) 모두에 적용됩니다. 예를 들어 시간 허용이 30s로 구성된 경우 만료된 JWT는 적용된 만료 후 30초 동안 유효한 것으로 취급됩니다. 이후 시간은 비슷하게 평가됩니다.

기본	0초(유예 기간 없음)
Presence	선택사항
유형	문자열
유효한 값	기간 표현식 또는 표현식이 포함된 흐름 변수에 대한 참조. 기간은 다음과 같이 양의 정수와 시간 단위를 나타내는 문자 1개로 지정할 수 있습니다. s = 초 m = 분 h = 시간 d = 일

<Type>

<Type>type-string-here</Type>

정책이 서명된 JWT를 확인하는지 암호화된 JWT를 생성하는지 설명합니다. <Type> 요소는 선택사항입니다. 이를 통해 정책이 서명된 JWT 또는 암호화된 JWT를 생성하는지 여부를 구성의 리더에 알릴 수 있습니다.

<Type> 요소가 있는 경우:
- <Type> 값이 Signed이면 정책은 서명된 JWT를 확인하며 <Algorithm> 요소가 있어야 합니다.
- <Type> 값이 Encrypted인 경우 정책은 암호화된 JWT를 확인하며, <Algorithms> 요소가 있어야 합니다.
<Type> 요소가 없는 경우:
- <Algorithm> 요소가 있는 경우 정책은 <Type>이 Signed라고 가정합니다.
- <Algorithms> 요소가 있는 경우 정책은 <Type>이 Encrypted라고 가정합니다.
<Algorithm>과 <Algorithms>가 모두 없으면 구성이 유효하지 않습니다.

기본	해당 사항 없음
Presence	선택사항
유형	문자열
유효한 값	`Signed` 또는 `Encrypted`

흐름 변수

성공하면 JWT 인증 및 JWT 디코딩 정책이 다음 패턴에 따라 컨텍스트 변수를 설정합니다.

jwt.{policy_name}.{variable_name}

예를 들어 정책 이름이 jwt-parse-token인 경우 정책은 JWT에 지정된 주체를 jwt.jwt-parse-token.decoded.claim.sub라는 컨텍스트 변수에 저장합니다. (이전 버전과의 호환성을 위해 jwt.jwt-parse-token.claim.subject에서도 사용할 수 있습니다.)

변수 이름	설명
`claim.audience`	JWT 잠재고객 클레임입니다. 이 값은 문자열이거나 문자열 배열일 수 있습니다.
`claim.expiry`	만료일/시간으로 에포크 이후 밀리초 단위로 표시됩니다.
`claim.issuedat`	토큰이 발행된 날짜로 에포크 이후 밀리초 단위로 표시됩니다.
`claim.issuer`	JWT 발급자 클레임입니다.
`claim.notbefore`	JWT에 nbf 클레임이 포함된 경우 에포크 이후 밀리초로 표시되는 값이 이 변수에 포함됩니다.
`claim.subject`	JWT 주체 클레임입니다.
`claim.name`	페이로드에 있는 명명된 클레임(표준 또는 추가) 값입니다. 이 중 하나가 페이로드의 모든 클레임에 설정됩니다.
`decoded.claim.name`	페이로드에 있는 명명된 클레임(표준 또는 추가)의 JSON 파싱 가능 값입니다. 페이로드의 모든 클레임에 하나의 변수가 설정됩니다. 예를 들어 `decoded.claim.iat`를 사용하여 JWT의 발급 시간을 에포크 이후의 초 단위로 검색할 수 있습니다. `claim.name` 흐름 변수를 사용할 수도 있지만 클레임에 액세스하는 데 권장되는 변수는 이 값입니다.
`decoded.header.name`	페이로드에 있는 헤더의 JSON 파싱 가능 값입니다. 페이로드의 모든 헤더에 하나의 변수가 설정됩니다. `header.name` 흐름 변수를 사용할 수도 있지만 헤더에 액세스하는 데 권장되는 변수는 이 값입니다.
`expiry_formatted`	만료일/시간으로 인간이 읽을 수 있는 문자열 형식입니다. 예: 2017-09-28T21:30:45.000+0000
`header.algorithm`	JWT에서 사용되는 서명 알고리즘입니다. 예를 들어 RS256, HS384 등입니다. 자세한 내용은 (알고리즘) 헤더 매개변수를 참조하세요.
`header.kid`	JWT가 생성될 때 추가된 경우, 키 ID입니다. JWT를 확인하려면 JWT 정책 개요의 'JSON 웹 키 세트(JWKS) 사용'을 참조하세요. 자세한 내용은 (키 ID)헤더 매개변수를 참조하세요.
`header.type`	`JWT`로 설정됩니다.
`header.name`	이름이 지정된 헤더 값(표준 또는 추가)입니다. 이 중 하나가 JWT의 헤더 부분에 있는 모든 추가 헤더에 설정됩니다.
`header-json`	JSON 형식의 헤더입니다.
`is_expired`	true 또는 false
`payload-claim-names`	JWT에서 지원되는 클레임 배열입니다.
`payload-json`	JSON 형식의 페이로드입니다.
`seconds_remaining`	토큰이 만료되기까지 걸리는 시간(초)입니다. 토큰이 만료된 경우 이 숫자는 음수입니다.
`time_remaining_formatted`	토큰이 만료되기까지 남은 시간으로 인간이 읽을 수 있는 문자열 형식입니다. 예: 00:59:59.926
`valid`	VerifyJWT의 경우 이 변수는 서명이 인증되고 현재 시간이 토큰 만료 전 및 토큰 notBefore 값(존재하는 경우) 이후일 때 true가 됩니다. 그렇지 않으면 false입니다. DecodeJWT의 경우 이 변수가 설정되지 않습니다.

오류 참조

이 섹션에서는 반환되는 오류 코드 및 오류 메시지와 이 정책이 오류를 트리거할 때 Apigee에서 설정한 오류 변수를 설명합니다. 오류를 처리하기 위해 오류 규칙을 개발 중인 경우, 이 정보는 중요합니다. 자세한 내용은 정책 오류에 대해 알아야 할 사항 및 오류 처리를 참조하세요.

런타임 오류

이러한 오류는 정책이 실행될 때 발생할 수 있습니다.

오류 코드	HTTP 상태	발생 상황
`steps.jwt.AlgorithmInTokenNotPresentInConfiguration`	`401`	확인 정책에 알고리즘이 여러 개 있으면 발생합니다.
`steps.jwt.AlgorithmMismatch`	`401`	`Generate` 정책에 지정된 알고리즘이 `Verify` 정책에 예상되는 알고리즘과 일치하지 않습니다. 지정된 알고리즘이 일치해야 합니다.
`steps.jwt.FailedToDecode`	`401`	정책이 JWT를 디코딩할 수 없습니다. JWT가 손상되었을 수 있습니다.
`steps.jwt.GenerationFailed`	`401`	정책이 JWT를 생성하지 못했습니다.
`steps.jwt.InsufficientKeyLength`	`401`	HS256 알고리즘은 32바이트 미만, HS386 알고리즘은 48바이트 미만, HS512 알고리즘은 64바이트 미만의 키일 때 발생합니다.
`steps.jwt.InvalidClaim`	`401`	소유권 클레임 누락 또는 소유권 클레임 불일치, 헤더 또는 헤더 불일치 누락일 때 발생합니다.
`steps.jwt.InvalidConfiguration`	`401`	`<Algorithm>` 및 `<Algorithms>` 요소가 모두 있습니다.
`steps.jwt.InvalidCurve`	`401`	키에서 지정한 곡선은 타원 곡선 알고리즘에 유효하지 않습니다.
`steps.jwt.InvalidIterationCount`	`401`	암호화된 JWT에 사용된 반복 수가 VerifyJWT 정책 구성에 지정된 반복 수와 동일하지 않습니다. 이는 `<PasswordKey>`를 사용하는 JWT에만 적용됩니다.
`steps.jwt.InvalidJsonFormat`	`401`	헤더 또는 페이로드에 잘못된 JSON이 있습니다.
`steps.jwt.InvalidKeyConfiguration`	`401`	`<PublicKey>` 요소의 `JWKS`이 잘못되었습니다. Apigee 인스턴스에서 JWKS URI 엔드포인트에 연결할 수 없기 때문일 수 있습니다. 패스 스루 프록시를 만들고 JWKS 엔드포인트를 대상으로 사용하여 엔드포인트에 대한 연결을 테스트합니다.
`steps.jwt.InvalidSaltLength`	`401`	암호화된 JWT에 사용된 솔트 길이가 VerifyJWT 정책 구성에 지정된 솔트 길이와 동일하지 않습니다. 이는 `<PasswordKey>`를 사용하는 JWT에만 적용됩니다.
`steps.jwt.InvalidPasswordKey`	`401`	지정된 키가 요구사항을 충족하지 않습니다.
`steps.jwt.InvalidPrivateKey`	`401`	지정된 키가 요구사항을 충족하지 않습니다.
`steps.jwt.InvalidPublicKey`	`401`	지정된 키가 요구사항을 충족하지 않습니다.
`steps.jwt.InvalidSecretKey`	`401`	지정된 키가 요구사항을 충족하지 않습니다.
`steps.jwt.InvalidToken`	`401`	이 오류는 JWT 서명 확인이 실패하면 발생합니다.
`steps.jwt.JwtAudienceMismatch`	`401`	토큰 확인 시 잠재 고객 소유권 주장이 실패했습니다.
`steps.jwt.JwtIssuerMismatch`	`401`	발급기관 클레임이 토큰 확인에 실패했습니다.
`steps.jwt.JwtSubjectMismatch`	`401`	주체 클레임이 토큰 확인에 실패했습니다.
`steps.jwt.KeyIdMissing`	`401`	`Verify` 정책은 JWKS를 공개 키의 소스로 사용하지만 서명된 JWT에는 헤더의 `kid` 속성이 포함되지 않습니다.
`steps.jwt.KeyParsingFailed`	`401`	지정된 키 정보에서 공개 키를 파싱할 수 없습니다.
`steps.jwt.NoAlgorithmFoundInHeader`	`401`	JWT에 알고리즘 헤더가 없으면 발생합니다.
`steps.jwt.NoMatchingPublicKey`	`401`	`Verify` 정책은 JWKS를 공개 키의 소스로 사용하지만 서명된 JWT의 `kid`가 JWKS에 나열되지 않습니다.
`steps.jwt.SigningFailed`	`401`	GenerateJWT에서, HS384 또는 HS512 알고리즘의 최소 크기보다 작은 키일 때 발생합니다.
`steps.jwt.TokenExpired`	`401`	정책이 만료된 토큰을 확인하려고 시도합니다.
`steps.jwt.TokenNotYetValid`	`401`	토큰이 아직 유효하지 않습니다.
`steps.jwt.UnhandledCriticalHeader`	`401`	`crit` 헤더의 JWT 인증 정책에서 찾은 헤더가 `KnownHeaders`에 표시되지 않습니다.
`steps.jwt.UnknownException`	`401`	알 수 없는 예외가 발생했습니다.
`steps.jwt.WrongKeyType`	`401`	잘못된 유형의 키가 지정되었습니다. 예를 들어 타원 곡선 알고리즘의 RSA 키를 지정하거나 RSA 알고리즘의 곡선 키를 지정하는 경우입니다.

배포 오류

이 오류는 이 정책이 포함된 프록시를 배포할 때 발생할 수 있습니다.

오류 이름	원인	해결
`InvalidNameForAdditionalClaim`	`<AdditionalClaims>` 요소의 하위 요소 `<Claim>`에 사용된 클레임이 다음 등록된 이름 `kid`, `iss`, `sub`, `aud`, `iat`, `exp`, `nbf` 또는 `jti` 중 하나인 경우 배포가 실패합니다.
`InvalidTypeForAdditionalClaim`	`<AdditionalClaims>` 요소의 하위 요소 `<Claim>`에 사용된 클레임 유형이 `string`, `number`, `boolean` 또는 `map` 유형이 아닌 경우 배포가 실패합니다.
`MissingNameForAdditionalClaim`	`<AdditionalClaims>` 요소의 하위 요소 `<Claim>`에서 클레임 이름이 지정되지 않으면 배포가 실패합니다.
`InvalidNameForAdditionalHeader`	`<AdditionalClaims>` 요소의 하위 요소 `<Claim>`에 사용된 클레임 이름이 `alg` 또는 `typ`인 경우 이 오류가 발생합니다.
`InvalidTypeForAdditionalHeader`	`<AdditionalClaims>` 요소의 하위 요소 `<Claim>`에 사용된 클레임 유형이 `string`, `number`, `boolean` 또는 `map` 유형이 아닌 경우 배포가 실패합니다.
`InvalidValueOfArrayAttribute`	이 오류는 `<AdditionalClaims>` 요소의 하위 요소 `<Claim>`에 있는 배열 속성 값이 `true` 또는 `false`로 설정되지 않은 경우 발생합니다.
`InvalidValueForElement`	`<Algorithm>` 요소에 지정된 값이 지원되는 값이 아니면 배포가 실패합니다.
`MissingConfigurationElement`	이 오류는 `<PrivateKey>` 요소가 RSA 계열 알고리즘에서 사용되지 않거나 `<SecretKey>` 요소가 HS 계열 알고리즘에 사용되지 않는 경우 발생합니다.
`InvalidKeyConfiguration`	하위 요소 `<Value>`가 `<PrivateKey>` 또는 `<SecretKey>` 요소에 정의되어 있지 않은 경우 배포가 실패합니다.
`EmptyElementForKeyConfiguration`	`<PrivateKey>` 또는 `<SecretKey>` 요소의 하위 요소 `<Value>`의 ref 속성이 비어 있거나 지정되지 않은 경우 배포가 실패합니다.
`InvalidConfigurationForVerify`	이 오류는 `<Id>` 요소가 `<SecretKey>` 요소 내에 정의된 경우에 발생합니다.
`InvalidEmptyElement`	이 오류는 JWT 확인 정책의 `<Source>` 요소가 비어 있는 경우에 발생합니다. 이 요소가 있는 경우 Apigee 흐름 변수 이름으로 정의해야 합니다.
`InvalidPublicKeyValue`	`<PublicKey>` 요소의 하위 요소 `<JWKS>`에 사용된 값이 RFC 7517에 지정된 유효한 형식을 사용하지 않는 경우 배포가 실패합니다.
`InvalidConfigurationForActionAndAlgorithm`	`<PrivateKey>` 요소가 HS 계열 알고리즘에서 사용되거나 `<SecretKey>` 요소가 RSA 계열 알고리즘에 사용되는 경우 배포가 실패합니다.

오류 변수

이러한 변수는 런타임 오류가 발생하면 설정됩니다. 자세한 내용은 정책 오류에 대해 알아야 할 사항을 참조하세요.

변수	장소	예
`fault.name="fault_name"`	`fault_name`은 위의 런타임 오류 표에 나열된 오류 이름입니다. 오류 이름은 오류 코드의 마지막 부분입니다.	`fault.name Matches "InvalidToken"`
`JWT.failed`	모든 JWT 정책은 오류 발생 시 동일한 변수를 설정합니다.	`JWT.failed = true`

오류 응답 예시

JWT 정책 오류 코드

오류 처리에서 권장사항은 오류 응답의 errorcode 부분을 트래핑하는 것입니다. 변경될 수 있으므로 faultstring의 텍스트에 의존하지 마세요.

오류 규칙 예시

    <FaultRules>
        <FaultRule name="JWT Policy Errors">
            <Step>
                <Name>JavaScript-1</Name>
                <Condition>(fault.name Matches "InvalidToken")</Condition>
            </Step>
            <Condition>JWT.failed=true</Condition>
        </FaultRule>
    </FaultRules>

VerifyJWT 정책

대상

방법

동영상

서명된 JWT 확인

서명된 JWT 샘플

HS256 알고리즘

RS256 알고리즘

서명된 JWT를 확인하도록 키 요소 설정

암호화된 JWT 확인

암호화된 JWT 샘플

암호화된 JWT를 확인하기 위한 키 요소 설정

요소 참조

최상위 요소에 적용되는 속성

<DisplayName>

<Algorithm>

<Algorithms>

<Algorithms> 하위 요소

키 암호화 알고리즘

콘텐츠 암호화 알고리즘

<Audience>

<AdditionalClaims/Claim>

<AdditionalHeaders/Claim>

<CustomClaims>

<Id>

<IgnoreCriticalHeaders>

<IgnoreIssuedAt>

<IgnoreUnresolvedVariables>

<Issuer>

<KnownHeaders>

<MaxLifespan>

<PrivateKey>

<Password>

<Value>

<PublicKey>

<Certificate>

<JWKS>

<Value>

<RequiredClaims>

<SecretKey>

<SecretKey>의 하위 요소

<Source>

<Subject>

<TimeAllowance>

<Type>

흐름 변수

오류 참조

런타임 오류

배포 오류

오류 변수

오류 응답 예시

오류 규칙 예시

`<Algorithms>` 하위 요소

`<SecretKey>`의 하위 요소