VerifyJWT 정책

현재 Apigee Edge 문서가 표시되고 있습니다.
Apigee X 문서로 이동
정보

내용

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

이 정책이 실행되면 Edge는 JWT의 서명을 확인하고 JWT가 있는 경우 만료 전이 아닌 시간에 따라 유효한지 확인합니다. 정책은 제목, 발급기관, 대상, 추가 클레임 값 등 JWT에서 특정 클레임 값을 선택적으로 확인할 수도 있습니다.

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

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

동영상

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

샘플

HS256 알고리즘으로 서명된 JWT 확인

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

정책 구성에는 Edge가 JWT를 디코딩하고 평가하는 데 필요한 정보가 포함됩니다. 예를 들어 JWT를 찾을 위치 (소스 요소에 지정된 흐름 변수에서), 필수 서명 알고리즘, 보안 비밀 키를 찾을 위치 (예: Edge KVM에서 가져올 수 있는 Edge 흐름 변수에 저장됨), 필수 클레임 및 값 집합이 포함됩니다.

<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 알고리즘으로 서명된 JWT 확인

이 정책 예시에서는 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' 요소의 필수 값과 일치하지 않기 때문입니다.

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

주요 요소 설정

키를 지정하는 데 사용한 요소는 다음 표와 같이 선택한 알고리즘에 따라 JWT를 확인하는 데 사용됩니다.

알고리즘 주요 요소
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 확인 정책의 요소 및 속성을 설명합니다.

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

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

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

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

속성 설명 기본 Presence
이름 정책의 내부 이름입니다. 이름에 사용할 수 있는 문자는 A-Z0-9._\-$ %로 제한됩니다. 하지만 에지 관리 UI는 영숫자가 아닌 문자를 자동으로 삭제하는 등의 추가 제한사항을 적용합니다.

선택적으로 <displayname></displayname> 요소를 사용하여 관리 UI 프록시 편집기에서 다른 자연어 이름으로 정책에 라벨을 지정합니다.

N/A 필수
continueOnError 정책이 실패할 경우 오류가 반환되도록 하려면 false로 설정합니다. 이는 대부분의 정책에서 예상되는 동작입니다.

정책이 실패해도 흐름 실행이 계속되도록 하려면 true로 설정합니다.

false 선택사항
사용 설정됨 정책을 시행하려면 true로 설정합니다.

false로 설정하여 정책을 '사용 중지'합니다. 정책이 흐름에 연결되어 있어도 정책이 시행되지 않습니다.

true 선택사항
async 이 속성은 지원이 중단되었습니다. false 지원 중단됨

<DisplayName>

<DisplayName>Policy Display Name</DisplayName>

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

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

<Algorithm>

<Algorithm>HS256</Algorithm>

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

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

기본 N/A
Presence 필수
유형 쉼표로 구분된
유효한 값 HS256, HS384, HS512, RS256, RS384, RS512, ES256, ES384, ES512, PS256, PS384, PS512

<Audience>

<Audience>audience-here</Audience>

or:

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

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

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

<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 페이로드에 지정된 추가 클레임이 포함되어 있고 어설션된 클레임 값이 일치하는지 확인합니다.

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

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

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

  • name - (필수) 클레임의 이름입니다.
  • 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 헤더에 지정된 추가 클레임 이름/값 쌍이 포함되어 있고 어설션된 클레임 값이 일치하는지 확인합니다.

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

기본 N/A
Presence 선택사항
유형

문자열(기본값), 숫자, 부울 또는 맵입니다.

유형이 지정되지 않은 경우 유형은 기본적으로 문자열입니다.

배열 값이 유형 배열인지 여부를 나타내기 위해 true로 설정합니다. 기본값: false
유효한 값 추가 클레임에 사용할 모든 값입니다.

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

  • name - (필수) 클레임의 이름입니다.
  • 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를 참조하세요.

기본 N/A
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>

<Issuer ref='variable-name-here'/>
<Issuer>issuer-string-here</Issuer>

정책은 JWT의 발급기관이 구성 요소에 지정된 문자열과 일치하는지 확인합니다. iss라는 클레임은 JWT의 발급자를 식별하는 클레임이며, 이는 RFC7519에 언급된, 등록된 클레임 중 하나입니다.

기본 N/A
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 정책을 구성할 수 있습니다.

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

<PublicKey/Certificate>

<PublicKey>
   <Certificate ref="signed_public.cert"/>
</PublicKey>
-or-
<PublicKey>
    <Certificate>
    -----BEGIN CERTIFICATE-----
    cert data
    -----END CERTIFICATE-----
    </Certificate>
</PublicKey>

JWT에서 서명을 확인하는 데 사용되는 서명된 인증서를 지정합니다. ref 속성을 사용하여 흐름 변수에 서명된 인증서를 전달하거나 PEM으로 인코딩된 인증서를 직접 지정합니다. 알고리즘은 RS256/RS384/RS512, PS256/PS384/PS512 또는 ES256/ES384/ES512 중 하나인 경우에만 사용합니다.

기본값 N/A
Presence RSA 알고리즘으로 서명된 JWT를 확인하려면 인증서, JWKS 또는 값 요소를 사용해야 합니다.
유형 문자열
유효한 값 흐름 변수 또는 문자열입니다.

<PublicKey/JWKS>

<!-- Specify the JWKS. -->
<PublicKey>
   <JWKS>jwks-value-here</JWKS>
</PublicKey>

or:

<!-- Specify a variable containing the JWKS. -->
<PublicKey>
   <JWKS ref="public.jwks"/>
</PublicKey>

or:

<!-- Specify a public URL that returns the JWKS.
The URL is static, meaning you cannot set it using a variable. -->
<PublicKey>
   <JWKS uri="jwks-url"/>
</PublicKey>

공개 키 집합이 포함된 JWKS 형식(RFC 7517)의 값을 지정합니다. 알고리즘이 RS256/RS384/RS512, PS256/PS384/PS512 또는 ES256/ES384/ES512 중 하나인 경우에만 사용합니다.

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

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

기본 N/A
현재 상태 RSA 알고리즘을 사용하여 JWT를 확인하려면 Certificate, JWKS 또는 Value 요소를 사용해야 합니다.
유형 문자열
유효한 값 흐름 변수, 문자열 값 또는 URL입니다.

<PublicKey/Value>

<PublicKey>
   <Value ref="public.publickeyorcert"/>
</PublicKey>
-or-
<PublicKey>
    <Value>
    -----BEGIN PUBLIC KEY-----
    MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAw2kPrRzcufvUNHvTH/WW
    Q0UrCw5c0+Y707KX3PpXkZGbtTT4nvU1jC0d1lHV8MfUyRXmpmnNxJHAC2F73IyN
    C5TBtXMORc+us7A2cTtC4gZV256bT4h3sIEMsDl0Joz9K9MPzVPFxa1i0RgNt06n
    Xn/Bs2UbbLlKP5Q1HPxewUDEh0gVMqz9wdIGwH1pPxKvd3NltYGfPsUQovlof3l2
    ALvO7i5Yrm96kknfFEWf1EjmCCKvz2vjVbBb6mp1ZpYfc9MOTZVpQcXSbzb/BWUo
    ZmkDb/DRW5onclGzxQITBFP3S6JXd4LNESJcTp705ec1cQ9Wp2Kl+nKrKyv1E5Xx
    DQIDAQAB
    -----END PUBLIC KEY-----
    </Value>
</PublicKey>

JWT에서 서명을 확인하는 데 사용되는 공개 키 또는 공개 인증서를 지정합니다. ref 속성을 사용하여 흐름 변수의 키/인증서를 전달하거나 PEM으로 인코딩된 키를 직접 지정합니다. 알고리즘은 RS256/RS384/RS512, PS256/PS384/PS512 또는 ES256/ES384/ES512 중 하나인 경우에만 사용합니다.

기본 N/A
Presence RSA 알고리즘으로 서명된 JWT를 확인하려면 인증서, JWKS 또는 값 요소를 사용해야 합니다.
유형 문자열
유효한 값 흐름 변수 또는 문자열입니다.

<SecretKey/Value>

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

HMAC 알고리즘으로 토큰을 확인하거나 서명하는 데 사용되는 보안 비밀 키를 제공합니다. 알고리즘이 HS256, HS384, HS512 중 하나인 경우에만 사용합니다.

기본 N/A
Presence HMAC 알고리즘에 필요합니다.
유형 문자열
유효한 값

encoding의 경우 유효한 값은 hex, base16, base64 또는 base64url입니다. 인코딩 값 hexbase16은 동의어입니다.

ref 속성을 사용하여 흐름 변수에 키를 전달합니다.

참고: 흐름 변수의 경우 프리픽스 'private'이 있어야 합니다. 예를 들면 private.mysecret입니다.

<Source>

<Source>jwt-variable</Source>

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

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

<Subject>

<Subject>subject-string-here</Subject>

정책은 JWT의 제목이 정책 구성에 지정된 문자열과 일치하는지 확인합니다. 이 클레임은 JWT의 제목을 식별하거나 설명합니다. 이는 RFC7519에 언급된, 표준 클레임 중 하나입니다.

기본 N/A
Presence 선택사항
유형 문자열
유효한 값 제목을 고유하게 식별하는 모든 값.

<TimeAllowance>

<TimeAllowance>120s</TimeAllowance>

시간의 '유예 기간'입니다. 예를 들어 시간 허용이 60초로 구성된 경우 만료된 JWT는 적용된 만료 후 60초 동안 유효한 것으로 취급됩니다. 이후 시간은 비슷하게 평가되며, 기본값은 0초입니다(유예 기간 없음).

기본 0초(유예 기간 없음)
Presence 선택사항
유형 문자열
유효한 값 값 또는 값을 포함하는 흐름 변수에 대한 참조입니다. 시간 스팬은 다음과 같이 지정할 수 있습니다.
  • s = 초
  • m = 분
  • h = 시간
  • d = 일

흐름 변수

성공하면 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의 경우 이 변수는 서명이 인증될 때 true가 되고, 현재 시간은 토큰 만료 전과 토큰 notBefore 값 이후(있는 경우)입니다. 그 이외의 경우는 false입니다.

DecodeJWT의 경우 이 변수가 설정되지 않습니다.

오류 참조

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

런타임 오류

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

오류 코드 HTTP 상태 발생 상황
steps.jwt.AlgorithmInTokenNotPresentInConfiguration 401 확인 정책에 알고리즘이 여러 개 있으면 발생합니다.
steps.jwt.AlgorithmMismatch 401 생성 정책에 지정된 알고리즘이 확인 정책에서 예상되는 알고리즘과 일치하지 않습니다. 지정된 알고리즘이 일치해야 합니다.
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.InvalidCurve 401 키에서 지정한 곡선은 타원 곡선 알고리즘에 유효하지 않습니다.
steps.jwt.InvalidJsonFormat 401 헤더 또는 페이로드에 잘못된 JSON이 있습니다.
steps.jwt.InvalidToken 401 이 오류는 JWT 서명 확인이 실패하면 발생합니다.
steps.jwt.JwtAudienceMismatch 401 토큰 확인 시 잠재 고객 소유권 주장이 실패했습니다.
steps.jwt.JwtIssuerMismatch 401 발급기관 클레임이 토큰 확인에 실패했습니다.
steps.jwt.JwtSubjectMismatch 401 주체 클레임이 토큰 확인에 실패했습니다.
steps.jwt.KeyIdMissing 401 인증 정책은 JWKS를 공개 키의 소스로 사용하지만 서명된 JWT의 헤더에 kid 속성이 포함되지 않습니다.
steps.jwt.KeyParsingFailed 401 주어진 키 정보에서 공개 키를 파싱할 수 없습니다.
steps.jwt.NoAlgorithmFoundInHeader 401 JWT에 알고리즘 헤더가 없으면 발생합니다.
steps.jwt.NoMatchingPublicKey 401 인증 정책은 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> 요소가 비어 있는 경우에 발생합니다. 있는 경우 에지 흐름 변수 이름으로 정의해야 합니다.
InvalidPublicKeyValue <PublicKey> 요소의 하위 요소 <JWKS>에 사용된 값이 RFC 7517에 지정된 유효한 형식을 사용하지 않으면 배포가 실패합니다.
InvalidConfigurationForActionAndAlgorithm <PrivateKey> 요소가 HS Family 알고리즘과 함께 사용되거나 <SecretKey> 요소가 RSA Family 알고리즘과 함께 사용되면 배포가 실패합니다.

오류 변수

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

변수 각 항목의 의미는 다음과 같습니다.
fault.name="fault_name" fault_name은 위의 런타임 오류 표에 나열된 오류 이름입니다. 오류 이름은 오류 코드의 마지막 부분입니다. fault.name Matches "TokenExpired"
JWT.failed 모든 JWT 정책은 오류 발생 시 동일한 변수를 설정합니다. JWT.failed = true

오류 응답 예시

JWT 정책 오류 코드

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

오류 규칙 예시

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