Criterio DecodeJWS

Stai visualizzando la documentazione di Apigee Edge.
Consulta la documentazione di Apigee X. info

Cosa

Decodifica l'intestazione JWS senza verificare la firma sul JWS e scrive ogni intestazione in una variabile di flusso. Questo criterio è più utile se utilizzato insieme al criterio VerifyJWS, quando il valore di un'intestazione all'interno del JWS deve essere noto prima di verificare la firma del JWS.

Un JWS può avere un payload allegato, come nel modulo:

header.payload.signature

In alternativa, il JWS può omettere il payload, chiamato payload separato, e avere il seguente modulo:

header..signature

Il criterio DecodeJWS funziona con entrambi i moduli perché decodifica solo la parte dell'intestazione del JWS. Il criterio DecodeJWS funziona anche indipendentemente dall'algoritmo utilizzato per firmare il JWS.

Per un'introduzione dettagliata e una panoramica del formato di un JWS, consulta la panoramica dei criteri JWS e JWT.

Video

Guarda un breve video per scoprire come decodificare un JWT. Sebbene questo video sia specifico per un JWT, molti dei concetti sono gli stessi per JWS.

Esempio: decodificare un JWS

Il criterio mostrato di seguito decodifica un JWS trovato nella variabile di flusso var.JWS. Questa variabile deve essere presente e contenere un JWS valido (decodificabile). Il criterio può ottenere il JWS da qualsiasi variabile di flusso.

<DecodeJWS name="JWS-Decode-HS256">
    <DisplayName>JWS Verify HS256</DisplayName>
    <Source>var.JWS</Source>
</DecodeJWS>

Per ogni intestazione nella parte dell'intestazione del JWS, il criterio imposta una variabile di flusso denominata:

jws.policy-name.header.header-name

Se il JWS ha un payload allegato, imposta la variabile di flusso jws.policy-name.header.payload sul payload. Per un payload separato, payload è vuoto. Per un elenco completo delle variabili impostate da questo criterio, consulta Variabili di flusso.

Riferimento all'elemento per la decodifica di JWS

Il riferimento al criterio descrive gli elementi e gli attributi del criterio Decode JWS.

Attributi che si applicano all'elemento di primo livello

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

I seguenti attributi sono comuni a tutti gli elementi principali dei criteri.

Attributo Descrizione Predefinita Presenza
nome Il nome interno del criterio. I caratteri che puoi utilizzare nel nome sono limitati a: A-Z0-9._\-$ %. Tuttavia, l'interfaccia utente di gestione di Edge applica ulteriori restrizioni, ad esempio rimuovendo automaticamente i caratteri non alfanumerici.

(Facoltativo) Utilizza l'elemento <displayname></displayname> per etichettare il criterio nell'editor proxy dell'interfaccia utente di gestione con un nome diverso in linguaggio naturale.

 N/D Obbligatorio
continueOnError Imposta su false per restituire un errore quando un criterio non va a buon fine. Questo è il comportamento previsto per la maggior parte dei criteri.

Imposta su true per continuare l'esecuzione del flusso anche dopo che un criterio non va a buon fine.

 false Facoltativo
attivato Imposta su true per applicare il criterio.

Imposta su false per "disattivare" il criterio. Il criterio non verrà applicato anche se rimane collegato a un flusso.

 true Facoltativo
asinc Questo attributo è deprecato. false Deprecato

<DisplayName>

<DisplayName>Policy Display Name</DisplayName>

Utilizza questo attributo in aggiunta all'attributo name per etichettare il criterio nell'editor proxy dell'interfaccia utente di gestione con un nome diverso in linguaggio naturale.

Predefinita Se ometti questo elemento, viene utilizzato il valore dell'attributo name del criterio.
Presenza Facoltativo
Tipo Stringa

<Source>

<Source>JWS-variable</Source>

Se presente, specifica la variabile di flusso in cui il criterio prevede di trovare il JWS da decodificare.

Predefinita request.header.authorization (consulta la nota sopra per informazioni importanti sul valore predefinito).
Presenza Facoltativo
Tipo Stringa
Valori validi Un nome di variabile di flusso Edge

Variabili di flusso

Se l'operazione riesce, i criteri Verify JWS e Decode JWS sono stati impostati. variabili di contesto in base a questo pattern:

jws.{policy_name}.{variable_name}

Ad esempio, se il nome del criterio è verify-jws, verrà archiviato dall'algoritmo specificato nel JWS a questa variabile di contesto: jws.verify-jws.header.algorithm

Nome variabile Descrizione
decoded.header.name Il valore analizzabile in JSON di un'intestazione nel payload. È impostata una variabile per ogni intestazione nel payload. Puoi usare anche le variabili di flusso header.name, questa è la variabile consigliata per accedere a un'intestazione.
header.algorithm L'algoritmo di firma utilizzato nel JWS. Ad esempio, RS256, HS384 e così via. Per saperne di più, consulta Parametro intestazione(algoritmo).
header.kid L'ID della chiave, se aggiunto al momento della generazione del JWS. Consulta anche la sezione "Utilizzo di un set di chiavi web JSON (JWKS)" presso JWT e JWS panoramica dei criteri per verificare un JWS. Per saperne di più, consulta Parametro intestazione(ID chiave).
header.type Il valore del tipo di intestazione. Per saperne di più, consulta Parametro intestazione(Tipo).
header.name Il valore dell'intestazione denominata (standard o aggiuntiva). Una di queste sarà impostata su ogni intestazione aggiuntiva nella parte di intestazione del JWS.
header-json L'intestazione in formato JSON.
payload Il payload JWS se al JWS è collegato un payload. Per un payload scollegato, questa variabile è vuota.
valid Nel caso di VerifyJWS, questa variabile sarà true dopo la verifica della firma e l'ora corrente è precedente alla scadenza del token e dopo il valore notBefore del token, se sono presenti. In caso contrario, è false.

Nel caso di DecodeJWS, questa variabile non è impostata.

Messaggi di errore

Questa sezione descrive i codici e i messaggi di errore restituiti e le variabili di errore impostate da Edge quando questo criterio attiva un errore. Queste informazioni sono importanti per sapere se si stanno sviluppando regole di errore per gestire gli errori. Per scoprire di più, consulta gli articoli Cosa devi sapere sugli errori relativi alle norme e Gestione degli errori.

Errori di runtime

Questi errori possono verificarsi quando il criterio viene eseguito.

Codice di errore Stato HTTP Si verifica quando
steps.jws.FailedToDecode 401 Il criterio non è stato in grado di decodificare il JWS. Il JWS potrebbe essere danneggiato.
steps.jws.FailedToResolveVariable 401 Si verifica quando la variabile di flusso specificata nell'elemento <Source> del criterio non esiste.
steps.jws.InvalidClaim 401 Per una rivendicazione mancante o mancata corrispondenza di una rivendicazione oppure una mancata corrispondenza di intestazione o intestazione.
steps.jws.InvalidJsonFormat 401 JSON non valido trovato nell'intestazione JWS.
steps.jws.InvalidJws 401 Questo errore si verifica quando la verifica della firma JWS non va a buon fine.
steps.jws.InvalidPayload 401 Il payload JWS non è valido.
steps.jws.InvalidSignature 401 <DetachedContent> viene omesso e il JWS ha un payload di contenuti scollegato.
steps.jws.MissingPayload 401 Payload JWS mancante.
steps.jws.NoAlgorithmFoundInHeader 401 Si verifica quando il JWS omette l'intestazione dell'algoritmo.
steps.jws.UnknownException 401 Si è verificata un'eccezione sconosciuta.

Errori di deployment

Questi errori possono verificarsi quando esegui il deployment di un proxy contenente questo criterio.

Nome errore Si verifica quando
InvalidAlgorithm Gli unici valori validi sono: 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

 Altri possibili errori di deployment.

Variabili di errore

Queste variabili vengono impostate quando si verifica un errore di runtime. Per ulteriori informazioni, consulta Informazioni importanti sugli errori relativi alle norme.

Variabili Dove Esempio
fault.name="fault_name" fault_name è il nome dell'errore, come indicato nella tabella Errori di runtime sopra. Il nome dell'errore è l'ultima parte del codice dell'errore. fault.name Matches "TokenExpired"
JWS.failed Tutti i criteri JWS impostano la stessa variabile in caso di errore. jws.JWS-Policy.failed = true

Esempio di risposta di errore

Per la gestione degli errori, la best practice è intercettare la parte errorcode della risposta all'errore. Non fare affidamento sul testo in faultstring, perché potrebbe cambiare.

Esempio di regola di errore

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