이 페이지는 Apigee 및 Apigee Hybrid에 적용됩니다.
Apigee Edge 문서 보기
제목
클라이언트 또는 다른 시스템에서 수신한 JWS의 서명을 인증합니다. 또한 이 정책은 헤더를 컨텍스트 변수로 추출하여 이후 정책 또는 조건이 해당 값을 검사하여 승인 또는 라우팅을 결정할 수 있도록 합니다. 자세한 소개는 JWS 및 JWT 정책 개요를 참조하세요.
JWS가 인증되고 유효한 경우 요청을 진행할 수 있습니다. JWS 서명을 인증할 수 없거나 일부 유형의 오류로 인해 JWS가 유효하지 않은 경우 모든 처리가 중지되고 응답에서 오류가 반환됩니다.
이 정책은 확장 가능한 정책이며, 이 정책을 사용하면 Apigee 라이선스에 따라 비용 또는 사용률이 영향을 받을 수 있습니다. 정책 유형 및 사용 영향에 대한 자세한 내용은 정책 유형을 참조하세요.
JWS의 각 부분, 암호화, 서명 방법에 대한 자세한 내용은 RFC7515를 참조하세요.
동영상
짧은 동영상을 보고 JWS에서 서명을 인증하는 방법을 알아보세요. 이 동영상은 JWT를 인증하는 데만 해당하지만 대부분의 개념은 JWS와 동일합니다.
샘플
HS256 알고리즘으로 서명된 연결 JWS 인증
이 정책 예시에서는 SHA-256 체크섬을 사용하여 HS256 암호화 알고리즘인 HMAC로 서명된 연결 JWS를 확인합니다. JWS는 프록시 요청에서 JWS
라는 양식 매개변수를 사용하여 전달됩니다. 이 키는 private.secretkey
라는 변수에 포함됩니다.
연결 JWS에는 인코딩된 헤더, 페이로드, 서명이 포함됩니다.
header.payload.signature
정책 구성에는 Apigee가 JWS를 찾을 수 있는 위치(<Source>
요소에 지정된 흐름 변수), 필요한 서명 알고리즘, 보안 비밀 키를 찾을 수 있는 위치(예를 들어 Apigee KVM에서 검색할 수 있는 Apigee 흐름 변수에 저장된) 등 Apigee에서 JWS를 디코딩 및 평가하기 위해 필요한 정보가 포함됩니다.
<VerifyJWS name="JWS-Verify-HS256"> <DisplayName>JWS Verify HS256</DisplayName> <Algorithm>HS256</Algorithm> <Source>request.formparam.JWS</Source> <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables> <SecretKey> <Value ref="private.secretkey"/> </SecretKey> </VerifyJWS>
정책은 API 프록시의 후속 정책 또는 조건이 해당 값을 검사할 수 있도록 출력물을 컨텍스트 변수에 씁니다. 이 정책에 의해 설정된 변수 목록은 흐름 변수를 참조하세요.
RS256 알고리즘으로 서명된 분리 JWS 확인
이 예시 정책은 RS256 알고리즘으로 서명된 분리 JWS를 인증합니다. 확인하려면 공개 키를 제공해야 합니다. JWS는 프록시 요청에서 JWS
라는 양식 매개변수를 사용하여 전달됩니다. 공개 키는 이름이 public.publickey
인 변수에 포함되어 있습니다.
분리 JWS는 JWS에서 페이로드를 생략합니다.
header..signature
페이로드가 포함된 변수 이름을 <DetachedContent>
요소에 지정하여 VerifyJWS 정책에 페이로드를 전달할 수 있습니다. <DetachedContent>
에 지정된 콘텐츠는 JWS 서명이 생성될 때 원래 인코딩되지 않은 형식이어야 합니다.
<VerifyJWS name="JWS-Verify-RS256"> <DisplayName>JWS Verify RS256</DisplayName> <Algorithm>RS256</Algorithm> <Source>request.formparam.JWS</Source> <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables> <PublicKey> <Value ref="public.publickey"/> </PublicKey> <DetachedContent>private.payload</DetachedContent> </VerifyJWS>
정책은 API 프록시의 후속 정책 또는 조건이 해당 값을 검사할 수 있도록 출력물을 컨텍스트 변수에 씁니다. 이 정책에 의해 설정된 변수 목록은 흐름 변수를 참조하세요.
주요 요소 설정
JWS 인증 에 사용되는 키를 지정하는 데 사용하는 요소는 다음 표와 같이 선택한 알고리즘에 따라 다릅니다.
알고리즘 | 주요 요소 | |
---|---|---|
HS* |
<SecretKey> <Value ref="private.secretkey"/> </SecretKey> |
|
RS*, ES*, PS* | <PublicKey> <Value ref="rsa_public_key"/> </PublicKey> 또는 <PublicKey> <JWKS ref="jwks_val_ref_or_url"/> </PublicKey> |
|
*키 요구사항에 대한 자세한 내용은 서명 암호화 알고리즘 정보를 참조하세요. |
요소 참조
정책 참조는 JWS 정책 인증의 요소 및 속성을 설명합니다.
참고: 구성은 사용하는 암호화 알고리즘에 따라 다소 달라질 수 있습니다. 특정 사용 사례의 구성을 보여주는 예시는 샘플을 참조하세요.
S최상위 요소에 적용되는 속성
<VerifyJWS name="JWS" continueOnError="false" enabled="true" async="false">
다음 속성은 모든 정책 상위 요소에 공통적으로 적용됩니다.
속성 | 설명 | 기본 | Presence |
---|---|---|---|
이름 |
정책의 내부 이름입니다. 이름에 사용할 수 있는 문자는 A-Z0-9._\-$ % 로 제한됩니다. 그러나 Apigee UI는 영숫자가 아닌 문자를 자동으로 삭제하는 등 추가 제한사항을 적용합니다.
선택적으로 |
해당 사항 없음 | 필수 |
continueOnError |
정책이 실패할 경우 오류가 반환되도록 하려면 false 로 설정합니다. 이는 대부분의 정책에서 예상되는 동작입니다.
정책이 실패해도 흐름 실행이 계속되도록 하려면 |
false | 선택사항 |
사용 설정됨 | 정책을 시행하려면 true 로 설정합니다.
|
true | 선택사항 |
async | 이 속성은 지원이 중단되었습니다. | false | 지원 중단됨 |
<DisplayName>
<DisplayName>Policy Display Name</DisplayName>
이름 속성 외에도 이 요소를 사용하여 Apigee UI 프록시 편집기의 정책에 다른 자연어 이름으로 라벨을 지정합니다.
기본값 | 이 요소를 생략하면 정책 이름 속성 값이 사용됩니다. |
Presence | 선택사항 |
유형 | 문자열 |
<Algorithm>
<Algorithm>HS256</Algorithm>
토큰 서명을 위한 암호화 알고리즘을 지정합니다. RS*/PS*/ES* 알고리즘은 공개/보안 비밀 키 쌍을 사용하지만 HS* 알고리즘은 공유 보안 비밀을 사용합니다. 서명 암호화 알고리즘 정보도 참조하세요.
여러 값을 쉼표로 구분하여 지정할 수 있습니다. 예를 들면 'HS256, HS512' 또는 'RS256, PS256'입니다. 그러나 HS* 알고리즘은 다른 알고리즘이나 ES* 알고리즘과 결합할 수 없습니다. 이 경우 특정 키 유형이 필요합니다. RS* 및 PS* 알고리즘은 결합할 수 있습니다.
기본 | 해당 사항 없음 |
Presence | 필수 |
유형 | 쉼표로 구분된 |
유효한 값 | HS256, HS384, HS512, RS256, RS384, RS512, ES256, ES384, ES512, PS256, PS384, PS512 |
<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>
JWS 헤더에 지정된 추가 클레임 이름/값 쌍이 포함되어 있고 보장된 클레임 값이 일치하는지 확인합니다.
추가 클레임은 등록된 표준 JWS 클레임 이름이 아닌 다른 이름을 사용합니다. 추가 클레임 값은 문자열, 숫자, 부울, 지도, 배열일 수 있습니다. 지도는 단순히 이름/값 쌍의 조합입니다. 이러한 모든 유형의 클레임 값은 정책 구성에서 명시적으로 지정하거나 흐름 변수 참조를 통해 간접적으로 지정할 수 있습니다.
기본 | 해당 사항 없음 |
Presence | 선택사항 |
유형 |
문자열(기본값), 숫자, 부울 또는 맵입니다. 유형이 지정되지 않은 경우 유형은 기본적으로 문자열입니다. |
배열 | 값이 유형 배열인지 여부를 나타내기 위해 true로 설정합니다. 기본값: false |
유효한 값 | 추가 클레임에 사용할 모든 값입니다. |
<Claim>
요소는 다음 속성을 사용합니다.
- name - (필수) 클레임의 이름입니다.
- ref - (선택사항) 흐름 변수의 이름입니다. 이 이름이 있으면 정책에서는 이 변수의 값을 클레임으로 사용합니다. ref 속성 및 명시적 클레임 값이 모두 지정되면 명시적 값이 기본값이 되고 참조된 흐름 변수가 해결되지 않은 경우에 사용됩니다.
- type - (선택사항) 문자열(기본값), 숫자, 부울, 맵 중 하나입니다.
- array - (선택사항) 값이 유형의 배열인지 나타내려면 true로 설정합니다. 기본값은 false입니다.
<DetachedContent>
<DetachedContent>variable-name-here</DetachedContent>
콘텐츠 페이로드가 포함된 생성된 JWS는 다음과 같은 형식입니다.
header.payload.signature
GenerateJWS 정책을 사용하여 분리된 페이로드를 만드는 경우 생성된 JWS는 페이로드를 생략하고 다음과 같은 형식이 됩니다.
header..signature
분리된 페이로드의 경우 <DetachedContent>
요소를 사용하여 페이로드를 VerifyJWS 정책에 전달할 책임은 사용자에게 있습니다. 지정된 콘텐츠 페이로드는 JWS 서명이 생성될 때 원래 인코딩되지 않은 형식이어야 합니다.
다음과 같은 경우 정책에서 오류가 발생합니다.
- JWS가 분리된 콘텐츠 페이로드를 포함하지 않은 경우
<DetachedContent>
가 지정됩니다(결함 코드는steps.jws.ContentIsNotDetached
). <DetachedContent>
가 생략되고 JWS에는 분리된 콘텐츠 페이로드가 있습니다(결함 코드는steps.jws.InvalidSignature
).
기본값 | N/A |
Presence | 선택사항 |
유형 | 변수 참조 |
<IgnoreCriticalHeaders>
<IgnoreCriticalHeaders>true|false</IgnoreCriticalHeaders>
JWS의 crit 헤더에 나열된 헤더가 <KnownHeaders>
요소에 나열되지 않는 경우 정책에서 오류가 발생하도록 하려면 false로 설정합니다.
VerifyJWS 정책이 crit 헤더를 무시하도록 하려면 true로 설정합니다.
이 요소를 true로 설정하는 이유 중 하나는 테스트 환경에 있고 누락된 헤더로 인해 정책에 오류가 생기지 않도록 하기 위함입니다.
기본값 | false |
Presence | 선택사항 |
유형 | 부울 |
유효한 값 | true 또는 false |
<IgnoreUnresolvedVariables>
<IgnoreUnresolvedVariables>true|false</IgnoreUnresolvedVariables>
정책에 지정된 참조 변수를 해결할 수 없는 경우 정책에서 오류가 발생하게 하려면 false로 설정합니다. 해결할 수 없는 변수를 빈 문자열(null)로 취급하려면 true로 설정합니다.
기본 | false |
Presence | 선택사항 |
유형 | 부울 |
유효한 값 | true 또는 false |
<KnownHeaders>
<KnownHeaders>a,b,c</KnownHeaders> or: <KnownHeaders ref=’variable_containing_headers’/>
GenerateJWS 정책은 <CriticalHeaders>
요소를 사용하여 토큰의 crit 헤더를 입력합니다. 예:
{ “typ: “...”, “alg” : “...”, “crit” : [ “a”, “b”, “c” ], }
VerifyJWS 정책은 JWS에서 crit 헤더가 있는 경우 이를 검사하고 나열된 각 항목에 대해 <KnownHeaders>
요소에 해당 헤더가 나열되는지 확인합니다. <KnownHeaders>
요소에는 crit에 나열된 항목의 상위 집합이 포함될 수 있습니다.
crit에 나열된 모든 헤더만 <KnownHeaders>
요소에 나열되어야 합니다. 정책이 crit에서 발견하고 <KnownHeaders>
에도 나열되지 않는 모든 헤더는 VerifyJWS 정책에 오류를 발생시킵니다.
선택적으로 <IgnoreCriticalHeaders>
요소를 true
로 설정하여 crit 헤더를 무시하도록 VerifyJWS 정책을 구성할 수 있습니다.
기본값 | 해당 사항 없음 |
Presence | 선택사항 |
유형 | 쉼표로 구분된 문자열 배열 |
유효한 값 | 배열 또는 배열이 포함된 변수의 이름입니다. |
<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 중 하나인 경우에만 사용합니다.
인바운드 JWS가 JWKS 세트에 있는 키 ID를 보유하는 경우, 정책은 올바른 공개 키를 사용하여 JWS 서명을 인증합니다. 이 기능에 대한 자세한 내용은 JSON 웹 키 세트(JWKS)를 사용하여 JWS 인증을 참조하세요.
공개 URL에서 값을 가져오면 Apigee는 JWKS를 300초 동안 캐시합니다. 캐시가 만료되면 Apigee가 JWKS를 다시 가져옵니다.
기본 | 해당 사항 없음 |
현재 상태 | RSA 알고리즘을 사용하여 JWS를 인증하려면 JWKS 또는 값 요소를 사용해야 합니다. |
유형 | 문자열 |
유효한 값 | 흐름 변수, 문자열 값 또는 URL입니다. |
<PublicKey/Value>
<PublicKey> <Value ref="public.publickey"/> </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>
JWS에서 서명을 인증하는 데 사용되는 공개 키를 지정합니다. ref 속성을 사용하여 흐름 변수의 키를 전달하거나 PEM으로 인코딩된 키를 직접 지정합니다. 알고리즘은 RS256/RS384/RS512, PS256/PS384/PS512 또는 ES256/ES384/ES512 중 하나인 경우에만 사용합니다.
기본 | 해당 사항 없음 |
현재 상태 | RSA 알고리즘으로 서명된 JWS를 인증하려면 JWKS 또는 값 요소를 사용해야 합니다. |
유형 | 문자열 |
유효한 값 | 흐름 변수 또는 문자열입니다. |
<SecretKey>
<SecretKey encoding="base16|hex|base64|base64url" > <Value ref="private.your-variable-name"/> </SecretKey>
HS256, HS384 또는 HS512 중 하나의 대칭(HS*) 알고리즘을 사용하는 JWS를 확인할 때 사용할 보안 비밀 키를 지정합니다.
이 요소는 선택사항입니다. 그러나 <PublicKey>
또는 <SecretKey>
요소 중 하나가 정확하게 포함되어야 합니다.
알고리즘이 RS*, PS* 또는 ES*인 JWS를 확인할 때는 <PublicKey>
요소를 사용하고 알고리즘이 HS*인 JWS를 확인할 때는 <SecretKey>
요소를 사용합니다.
<SecretKey>
의 하위 요소
다음 표에서는 <SecretKey>
의 하위 요소와 속성에 대한 설명을 제공합니다.
하위 | Presence | 설명 |
---|---|---|
인코딩(속성) | 선택사항 | 참조된 변수에서 키가 인코딩되는 방법을 지정합니다. 기본적으로 <SecretKey encoding="base64" > <Value ref="private.secretkey"/> </SecretKey> 위의 예시에서는 인코딩이 |
값(요소) | 필수 | 인코딩된 보안 비밀 키 페이로드를 확인하는 데 사용할 보안 비밀 키를 지정합니다. <SecretKey> <Value ref="private.my-secret-variable"/> </SecretKey> Apigee는 HS256/HS384/HS512 알고리즘에 최소한의 키 안전성을 적용합니다. 최소 키 길이는 HS256의 경우 32바이트, HS384의 경우 48바이트, HS512의 경우 64바이트입니다. 낮은 안정성의 키를 사용하면 런타임 오류가 발생합니다. |
<Source>
<Source>JWS-variable</Source>
존재하는 경우 정책에서 JWS가 인증하기 위해 찾고자 하는 흐름 변수를 지정합니다.
기본값 | request.header.authorization (기본값에 관한 중요한 정보는 위 참고 사항을 확인하세요.) |
Presence | 선택사항 |
유형 | 문자열 |
유효한 값 | Apigee 흐름 변수 이름입니다. |
<Type>
<Type>type-string-here</Type>
허용된 값만 Signed
인 선택적 요소로, 정책이 서명된 JWS를 인증하도록 지정합니다. <Type>
은 GenerateJWT 및 VerifyJWT 정책의 해당 요소를 일치시키기 위해 제공됩니다(Signed
또는 Encrypted
값 중 하나에서 사용 가능).
기본값 | 해당 사항 없음 |
Presence | 선택사항 |
유형 | 문자열 |
유효한 값 | Signed |
Flow variables
Upon success, the Verify JWS and Decode JWS policies set context variables according to this pattern:
jws.{policy_name}.{variable_name}
For example, if the policy name is verify-jws
, then the policy will store
the algorithm specified in the JWS to this context variable:
jws.verify-jws.header.algorithm
Variable name | Description |
---|---|
decoded.header.name |
The JSON-parsable value of a header in the payload. One variable is set for
every header in the payload. While you can also use the header.name flow variables,
this is the recommended variable to use to access a header. |
header.algorithm |
The signing algorithm used on the JWS. For example, RS256, HS384, and so on. See (Algorithm) Header Parameter for more. |
header.kid |
The Key ID, if added when the JWS was generated. See also "Using a JSON Web Key Set (JWKS)" at JWT and JWS policies overview to verify a JWS. See (Key ID) Header Parameter for more. |
header.type |
The header type value. See (Type) Header Parameter for more. |
header.name |
The value of the named header (standard or additional). One of these will be set for every additional header in the header portion of the JWS. |
header-json |
The header in JSON format. |
payload |
The JWS payload if the JWS has an attached payload. For a detached paylod, this variable is empty. |
valid |
In the case of VerifyJWS, this variable will be true when the signature is verified, and
the current time is before the token expiry, and after the token notBefore value, if they
are present. Otherwise false.
In the case of DecodeJWS, this variable is not set. |
오류 참조
This section describes the fault codes and error messages that are returned and fault variables that are set by Apigee when this policy triggers an error. This information is important to know if you are developing fault rules to handle faults. To learn more, see What you need to know about policy errors and Handling faults.
Runtime errors
These errors can occur when the policy executes.
Fault code | HTTP status | Occurs when |
---|---|---|
steps.jws.AlgorithmInTokenNotPresentInConfiguration |
401 |
Occurs when the verification policy has multiple algorithms |
steps.jws.AlgorithmMismatch |
401 |
The algorithm specified in the header by the Generate policy did not match the one expected in the
Verify policy. The algorithms specified must match. |
steps.jws.ContentIsNotDetached |
401 |
<DetachedContent> is specified when the JWS does not contain a
detached content payload. |
steps.jws.FailedToDecode |
401 |
The policy was unable to decode the JWS. The JWS is possibly corrupted. |
steps.jws.InsufficientKeyLength |
401 |
For a key less than 32 bytes for the HS256 algorithm |
steps.jws.InvalidClaim |
401 |
For a missing claim or claim mismatch, or a missing header or header mismatch. |
steps.jws.InvalidCurve |
401 |
The curve specified by the key is not valid for the Elliptic Curve algorithm. |
steps.jws.InvalidJsonFormat |
401 |
Invalid JSON found in the JWS header. |
steps.jws.InvalidJws |
401 |
This error occurs when the JWS signature verification fails. |
steps.jws.InvalidPayload |
401 |
The JWS payload is invalid. |
steps.jws.InvalidSignature |
401 |
<DetachedContent> is omitted and the JWS has a detached content payload. |
steps.jws.KeyIdMissing |
401 |
The Verify policy uses a JWKS as a source for public keys, but the signed JWS does not
include a kid property in the header. |
steps.jws.KeyParsingFailed |
401 |
The public key could not be parsed from the given key information. |
steps.jws.MissingPayload |
401 |
The JWS payload is missing. |
steps.jws.NoAlgorithmFoundInHeader |
401 |
Occurs when the JWS omits the algorithm header. |
steps.jws.NoMatchingPublicKey |
401 |
The Verify policy uses a JWKS as a source for public keys, but the kid
in the signed JWS is not listed in the JWKS. |
steps.jws.UnhandledCriticalHeader |
401 |
A header found by the Verify JWS policy in the crit header is not
listed in KnownHeaders . |
steps.jws.UnknownException |
401 |
An unknown exception occurred. |
steps.jws.WrongKeyType |
401 |
Wrong type of key specified. For example, if you specify an RSA key for an Elliptic Curve algorithm, or a curve key for an RSA algorithm. |
Deployment errors
These errors can occur when you deploy a proxy containing this policy.
Error name | Occurs when |
---|---|
InvalidAlgorithm |
The only valid values are: RS256, RS384, RS512, PS256, PS384, PS512, ES256, ES384, ES512,
HS256, HS384, HS512 . |
|
Other possible deployment errors. |
Fault variables
These variables are set when a runtime error occurs. For more information, see What you need to know about policy errors.
Variables | Where | Example |
---|---|---|
fault.name="fault_name" |
fault_name is the name of the fault, as listed in the Runtime errors table above. The fault name is the last part of the fault code. | fault.name Matches "TokenExpired" |
JWS.failed |
All JWS policies set the same variable in the case of a failure. | jws.JWS-Policy.failed = true |
Example error response
For error handling, the best practice is to trap the errorcode
part of the error
response. Do not rely on the text in the faultstring
, because it could change.
Example fault rule
<FaultRules> <FaultRule name="JWS Policy Errors"> <Step> <Name>JavaScript-1</Name> <Condition>(fault.name Matches "TokenExpired")</Condition> </Step> <Condition>JWS.failed=true</Condition> </FaultRule> </FaultRules>