VerificationJWS politikası

Apigee Edge belgelerini görüntülüyorsunuz.
. Git: Apigee X belgeleri. bilgi

Ne?

İstemcilerden veya diğer sistemlerden alınan bir JWS'deki imzayı doğrular. Bu politika ayrıca sonraki politikaların veya koşulların inceleyebilmesi için başlıkları bağlam değişkenlerine çıkarır bu değerleri kullanarak yetkilendirme veya yönlendirme kararları verebilirsiniz. Ayrıntılı bilgi için JWS ve JWT politikalarına genel bakış sayfasına göz atın.

JWS doğrulanmış ve geçerliyse istek devam etmesine izin veriliyor. JWS imzası doğrulanamıyorsa veya JWS, imzası tüm işleme durur ve yanıtta bir hata döndürülür.

JWS'nin bölümleri ve bunların nasıl şifrelenip imzalandığı hakkında bilgi edinmek için şuraya bakın: RFC7515.

Video

JWS'de imzayı nasıl doğrulayacağınızı öğrenmek için kısa bir video izleyin. Bu video, JWT'nin doğrulanmasına özel olarak JWS'deki kavramların çoğu aynıdır.

Örnekler

HS256 ile imzalanmış ekteki bir JWS'yi doğrulayın algoritma

Bu örnek politika, HS256 şifreleme algoritması HMAC ile imzalanmış ekli bir JWS'yi doğrular sağlayabilir. JWS, proxy isteğinde JWS Anahtar, private.secretkey adlı bir değişkende yer alır.

Ekli bir JWS, kodlanmış başlığı, yükü ve imzayı içerir:

header.payload.signature

Politika yapılandırması, Edge'in JWS'nin kodunu çözmesi ve değerlendirmesi için ihtiyaç duyduğu bilgileri içerir. Örneğin, JWS'nin nerede bulunacağı (<Source> öğesinde belirtilen bir akış değişkeninde) gizli anahtarın nerede bulunacağını (Edge akış değişkeninde saklanan bir Edge akış değişkeninde Edge KVM'den alınmıştır).

<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>

Politika, çıktısını bağlam değişkenlerine yazar, böylece sonraki politikalar veya koşullar bu değerleri inceleyebilir. Ayrıntılı bilgi için Akış değişkenleri bu politika tarafından ayarlanan değişkenlerin listesini oluşturun.

RS256 ile imzalanmış ayrı bir JWS'yi doğrulayın algoritma

Bu örnek politika, RS256 algoritmasıyla imzalanmış ayrılmış bir JWS'yi doğrular. Doğrulamak için: ortak anahtarı sağlamanız gerekir. JWS, proxy isteğinde bir form parametresi kullanılarak iletilir JWS olarak adlandırıldı. Ortak anahtar, public.publickey adlı bir değişkende bulunur.

Çıkarılan JWS, yükü JWS'den çıkarır:

header..signature

Yükü içeren değişken adını <DetachedContent> öğesi. <DetachedContent> politikasında belirtilen içerik JWS imzasının oluşturulduğu orijinal kodlanmamış biçimde olması gerekir.

<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>

Politika, çıktısını bağlam değişkenlerine yazar, böylece sonraki politikalar veya koşullar bu değerleri inceleyebilir. Ayrıntılı bilgi için Akış değişkenleri bu politika tarafından ayarlanan değişkenlerin listesini oluşturun.

Temel öğeleri ayarlama

JWS'yi doğrulamak için kullanılan anahtarı belirtmek için kullandığınız öğeler, seçilen algoritmaya bağlı olarak değişir. aşağıdaki tabloda gösterildiği gibi):

Algoritma temel öğeler
HD* 
<SecretKey>
  <Value ref="private.secretkey"/>
</SecretKey>
RS*, İspanya*, PS* 
<PublicKey>
  <Value ref="rsa_public_key"/>
</PublicKey>

veya:

<PublicKey>
  <JWKS ref="jwks_val_ref_or_url"/>
</PublicKey>
*Temel şartlar hakkında daha fazla bilgi için İmza şifreleme algoritmaları hakkında.

Öğe referansı

Politika referansında, JWS'yi Doğrulama politikasının öğelerini ve özellikleri açıklanmaktadır.

Not: Yapılandırma, şifrelemeye bağlı olarak biraz farklılık gösterir. belirlemektir. Aşağıdaki örnekler için Örnekler'e bakın: yapılandırmalarına yardımcı olur.

Proje hedefini üst düzey öğe

<VerifyJWS name="JWS" continueOnError="false" enabled="true" async="false">

Aşağıdaki özellikler tüm politika üst öğeleri için ortaktır.

Özellik Açıklama Varsayılan Bulunma
ad Politikanın dahili adı. Adda kullanabileceğiniz karakterler aşağıdakilerle sınırlıdır: A-Z0-9._\-$ % Bununla birlikte, Edge yönetim arayüzü, alfasayısal olmayan karakterlerin otomatik olarak kaldırılması gibi kısıtlamalara tabidir.

İsteğe bağlı olarak, <displayname></displayname> öğesini şunun için kullanın: yönetim arayüzü proxy düzenleyicisindeki politikayı farklı, doğal bir dille etiketleyin dokunun.

 Yok Zorunlu
continueOnError Bir politika başarısız olduğunda hata döndürmesi için false olarak ayarlayın. Bu beklenen bir durumdur çoğu politika için geçerli olur.

Akış yürütmenin bir politikadan sonra bile devam etmesi için true olarak ayarlayın başarısız olur.

 false İsteğe bağlı
etkin Politikayı uygulamak için true olarak ayarlayın.

"Kapat" için false olarak ayarlandı politika. Politika uygulanmayacak bir akışa bağlı kalsa bile uygulanabilir.

 true İsteğe bağlı
eş zamansız Bu özelliğin desteği sonlandırıldı. false Kullanımdan kaldırıldı

&lt;DisplayName&gt;

<DisplayName>Policy Display Name</DisplayName>

Yönetim kullanıcı arayüzü proxy düzenleyicisinde politikayı etiketlemek için ad özelliğine ek olarak kullanın doğal bir dille değiştirin.

Varsayılan Bu öğeyi çıkarırsanız politikanın ad özelliğinin değeri kullanılır.
Bulunma İsteğe bağlı
Tür Dize

&lt;Algorithm&gt;

<Algorithm>HS256</Algorithm>

Jetonu imzalamak için kullanılacak şifreleme algoritmasını belirtir. RS*/PS*/ES* algoritmaları bir ortak/gizli anahtar çifti kullanır, HS* algoritmaları ortak bir sır kullanır. Şu kaynakları da inceleyin: İmza şifreleme algoritmaları hakkında.

Virgülle ayırarak birden çok değer belirtebilirsiniz. Örneğin "HS256, HS512" veya "RS256, PS256". Ancak, HS* algoritmalarını diğer algoritmalarla veya ES* algoritmalarını başka algoritmalarla birleştiremezsiniz, çünkü belirli bir anahtar türü gerektirir. RS* ve PS* algoritmalarını birleştirebilirsiniz.

Varsayılan Yok
Bulunma Zorunlu
Tür Virgülle ayrılmış değerler dizesi
Geçerli değerler HS256, HS384, HS512, RS256, RS384, RS512, ES256, ES384, ES512, PS256, PS384, PS512

&lt;AdditionalHeaders/Claim&gt;

<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 başlığının belirtilen ek talep adı/değer çiftlerini içerdiğini ve bildirilen hak talebi değerlerinin eşleştiğini doğrular.

Ek hak taleplerinde, standart ve kayıtlı JWS hak talebi adlarından biri olmayan bir ad kullanılır. Ek bir talebin değeri bir dize, sayı, boole, harita veya dizi olabilir. Harita bir ad/değer çiftleri kümesidir. Bu türlerin herhangi birindeki bir hak talebinin değeri belirtilebilir doğrudan politika yapılandırmasında veya bir akış değişkenine referans vererek dolaylı şekilde değiştirebilirsiniz.

Varsayılan Yok
Bulunma İsteğe bağlı
Tür

Dize (varsayılan), sayı, boole veya eşleme.

Tür belirtilmezse tür varsayılan olarak Dize olur.
Dizi Değerin bir tür dizisi olup olmadığını belirtmek için true olarak ayarlayın. Varsayılan: yanlış
Geçerli değerler Ek bir hak talebi için kullanmak istediğiniz herhangi bir değer.

<Claim> öğesi şu özellikleri alır:

  • name - (Zorunlu) Hak talebinin adı.
  • ref - (İsteğe bağlı) Bir akış değişkeninin adı. Varsa politika, değişkeninin hak talebi olarak kabul edildiğini gösterir. Hem bir ref özelliği hem de açık bir hak talebi değeri belirtilirse açık değer varsayılan değerdir ve başvurulan akış değişkeni çözümlenmemişse kullanılır.
  • type - (İsteğe bağlı) Şunlardan biri: dize (varsayılan), sayı, boole veya harita
  • dizi - (İsteğe bağlı) Değerin bir tür dizisi olup olmadığını belirtmek için true olarak ayarlayın. Varsayılan: false (yanlış) değerini alır.

&lt;DetachedContent&gt;

<DetachedContent>variable-name-here</DetachedContent>

İçerik yükü olan, oluşturulmuş bir JWS şu biçimdedir:

header.payload.signature

Ayrılmış yük oluşturmak için GenerateJWS politikasını kullanırsanız oluşturulan JWS, yükü atlar ve şu biçimde olmalıdır:

header..signature

Ayrı bir yük için, <DetachedContent> öğesi. Belirtilen içerik yükü JWS imzasının oluşturulduğu orijinal kodlanmamış biçimde olması gerekir.

Politika aşağıdaki durumlarda hata verir:

  • JWS'de ayrılmış içerik olmadığında <DetachedContent> belirtilir yük (hata kodu: steps.jws.ContentIsNotDetached).
  • <DetachedContent> atlandı ve JWS'nin ayrılmış içerik yükü var (hata kodu: steps.jws.InvalidSignature).
Varsayılan N/A
Bulunma İsteğe bağlı
Tür Değişken referansı

&lt;IgnoreCriticalHeaders&gt;

<IgnoreCriticalHeaders>true|false</IgnoreCriticalHeaders>

JWS'nin crit üstbilgisi, <KnownHeaders> öğesinde listelenmiyor. VerifyJWS politikasının crit başlığını yoksaymasına neden olmak için değeri true olarak ayarlayın.

Bu öğeyi true (doğru) değerine ayarlamanın nedenlerinden biri, test ortamında politikanın başarısız olmasını istemezsiniz.

Varsayılan false
Bulunma İsteğe bağlı
Tür Boole
Geçerli değerler doğru veya yanlış

&lt;IgnoreUnresolvedVariables&gt;

<IgnoreUnresolvedVariables>true|false</IgnoreUnresolvedVariables>

Başvurulan herhangi bir değişken belirtildiğinde politikanın hata vermesini istiyorsanız false (yanlış) değerine ayarlayın bu politikada çözülemez. Çözümlenemeyen değişkenleri boş dize olarak ele almak için doğru değerine ayarlanır (boş).

Varsayılan false
Bulunma İsteğe bağlı
Tür Boole
Geçerli değerler doğru veya yanlış

&lt;KnownHeaders&gt;

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

or:

<KnownHeaders ref=’variable_containing_headers’/>

GenerateJWS politikası,<CriticalHeaders> crit üstbilgisini ekleyin. Örneğin:

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

VerifyJWS politikası, JWS'deki crit üstbilgisini (varsa ve listelenen her öğe için) inceler. <KnownHeaders> öğesinin bu başlığı da listeleyip listelemediğini kontrol eder. İlgili içeriği oluşturmak için kullanılan <KnownHeaders> öğesi, crit'te listelenen öğelerin üst kümesini içerebilir. crit'te listelenen tüm başlıkların <KnownHeaders> öğesi. Politikanın crit'te bulduğu herhangi bir başlık aynı zamanda <KnownHeaders> içinde de listelenmeyen bir uzantı, VerifyJWS politikasının başarısız olmasına neden olur.

İsterseniz VerifyJWS politikasını, crit başlığını yoksayacak şekilde yapılandırabilirsiniz. <IgnoreCriticalHeaders> öğesi true olarak ayarlanıyor.

Varsayılan Yok
Bulunma İsteğe bağlı
Tür Virgülle ayrılmış dize dizisi
Geçerli değerler Bir dizi veya diziyi içeren bir değişkenin adı.

&lt;PublicKey/JWKS&gt;

<!-- 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>

Bir değeri JWKS biçiminde (RFC 7517) belirtir içeren bir dizi ortak anahtar içerir. Yalnızca algoritma RS256/RS384/RS512 değerlerinden biri olduğunda kullanın. PS256/PS384/PS512 veya ES256/ES384/ES512.

Gelen JWS, JWKS alırsa politika, JWS imzasını doğrulamak için doğru ortak anahtarı kullanır. Ayrıntılı bilgi bkz. JWS'yi doğrulamak için JSON Web Anahtarı Seti (JWKS) kullanma.

Değeri herkese açık bir URL'den getirirseniz Edge, JWKS'yi 300 saniyelik bir süre boyunca önbelleğe alır. Önbelleğin süresi dolduğunda Edge, JWKS'yi tekrar getirir.

Varsayılan Yok
Bulunma JWS'yi RSA algoritması kullanarak doğrulamak için JWKS veya Değeri öğesine dokunun.
Tür Dize
Geçerli değerler Bir akış değişkeni, dize değeri veya URL.

&lt;PublicKey/Value&gt;

<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'de imzayı doğrulamak için kullanılan ortak anahtarı belirtir. Şunlar için ref özelliğini kullanın: anahtarı bir akış değişkeninde geçirin veya PEM kodlu anahtarı doğrudan belirtin. Yalnızca RS256/RS384/RS512, PS256/PS384/PS512 veya ES256/ES384/ES512 olabilir.

Varsayılan Yok
Bulunma RSA algoritmasıyla imzalanmış bir JWS'yi doğrulamak için JWKS veya Değer öğeleri.
Tür Dize
Geçerli değerler Bir akış değişkeni veya dizesi.

&lt;SecretKey/Value&gt;

<SecretKey>
  <Value ref="private.your-variable-name"/>
</SecretKey>

HMAC algoritmasıyla jetonları doğrulamak veya imzalamak için kullanılan gizli anahtarı sağlar. Yalnızca kullanım olması gerekir. ref özelliğini kullanın anahtarı bir akış değişkeninde geçirecek.

Varsayılan Yok
Bulunma HMAC algoritmaları için gereklidir.
Tür Dize
Geçerli değerler Bir dizeyi ifade eden akış değişkeni.

Not: Akış değişkeni ise "private" ön ekine sahip olmalıdır. Örneğin, private.mysecret.

&lt;Source&gt;

<Source>JWS-variable</Source>

Varsa politikanın JWS'yi bulmayı beklediği akış değişkenini belirtir. doğrulayın.

Varsayılan request.header.authorization (Önemli bilgiler için yukarıdaki nota bakın. varsayılan değer hakkında).
Bulunma İsteğe bağlı
Tür Dize
Geçerli değerler Edge akış değişkeni adı.

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 payload, 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.

Hata referansı

This section describes the fault codes and error messages that are returned and fault variables that are set by Edge 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.

EmptyElementForKeyConfiguration

FailedToResolveVariable

InvalidConfigurationForActionAndAlgorithmFamily

InvalidConfigurationForVerify

InvalidEmptyElement

InvalidFamiliesForAlgorithm

InvalidKeyConfiguration

InvalidNameForAdditionalClaim

InvalidNameForAdditionalHeader

InvalidPublicKeyId

InvalidPublicKeyValue

InvalidSecretInConfig

InvalidTypeForAdditionalClaim

InvalidTypeForAdditionalHeader

InvalidValueForElement

InvalidValueOfArrayAttribute

InvalidVariableNameForSecret

MissingConfigurationElement

MissingElementForKeyConfiguration

MissingNameForAdditionalClaim

MissingNameForAdditionalHeader

 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>