Política DecodeJWT

Política estándar

Esta página se aplica a Apigee y Apigee Hybrid.

Consulta la documentación de Apigee Edge.

La política de DecodeJWT decodifica un JWT sin verificar la firma en el JWT. Esto es más útil cuando se usa en conjunto con la política VerifyJWT, cuando se debe conocer el valor de una reclamación desde el JWT antes de verificar la firma del JWT.

La política de decodificación de JWT funciona sin importar el algoritmo que se usó para firmar el JWT. Consulta la descripción general de las políticas de JWS y JWT para obtener una introducción detallada.

Esta es una política estándar y se puede implementar en cualquier tipo de entorno. Para obtener información sobre los tipos de políticas y la disponibilidad con cada tipo de entorno, consulta Tipos de políticas.

Muestra: Decodifica un JWT

La política que se muestra a continuación decodifica un JWT que se encuentra en la variable de flujo var.jwt. Esta variable debe estar presente y contener un JWT viable (decodificable). La política puede obtener el JWT de cualquier variable de flujo.

<DecodeJWT name="JWT-Decode-HS256">
    <DisplayName>JWT Verify HS256</DisplayName>
    <Source>var.jwt</Source>
</DecodeJWT>

La política escribe su resultado en variables de contexto para que las políticas o condiciones posteriores en el proxy de API puedan examinar esos valores. Consulta Variables de flujo para obtener una lista de las variables que establece esta política.

Referencia del elemento para decodificación de JWT

La referencia de política describe los elementos y atributos de la política de decodificación de JWS.

Atributos que se aplican al elemento de nivel superior

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

Los siguientes atributos son comunes a todos los elementos superiores de la política.

Atributo	Descripción	Valor predeterminado	Presencia
name	El nombre interno de la política. Los caracteres que puede usar en el nombre están restringidos a: A-Z0-9._\-$ %. Sin embargo, la IU de Apigee aplica restricciones adicionales, como quitar automáticamente los caracteres que no son alfanuméricos. De forma opcional, usa el elemento <displayname></displayname> para etiquetar la política en el editor de proxy de IU de Apigee con un nombre de lenguaje natural diferente.	N/A	Obligatorio
continueOnError	Configúralo como false para devolver un error cuando una política falla. Este es el comportamiento previsto para la mayoría de las políticas. Configúralo como true para continuar con la ejecución del flujo incluso después de que una política falle.	falso	Opcional
habilitado	Configúralo como true para aplicar la política. Configúralo como false para “desactivar” la política. La política no se aplicará, incluso si permanece conectada a un flujo.	verdadero	Opcional
async	Este atributo dejó de estar disponible.	falso	Obsoleto

<DisplayName>

<DisplayName>Policy Display Name</DisplayName>

Además de usar el atributo de nombre para etiquetar la política en el editor de proxy de IU de Apigee con un nombre diferente y con lenguaje natural.

Valor predeterminado	Si omites este elemento, se usa el valor del atributo de nombre de la política.
Presencia	Opcional
Tipo	String

<Source>

<Source>jwt-variable</Source>

Si está presente, especifica la variable de flujo en la que la política espera encontrar el JWS que se decodificará.

Nota: Según la configuración predeterminada, el JWS se recupera de la variable request.header.authorization. En este caso, Apigee busca el JWT en el encabezado de autorización de la solicitud. Si pasas el JWT en el encabezado de autorización, no necesitas incluir el elemento de origen en la política. Sin embargo, debes incluir Portador en el encabezado de autenticación. Por ejemplo, debes transmitir el JWT en el encabezado de autorización de la siguiente manera:

curl -v http://52.200.92.187:9001/doctest-jwt/verify-rs256 -H "Authorization: Bearer <your JWT>"

Puedes configurar la política para recuperar el JWT desde una variable de parámetro de consulta o formulario, o cualquier otra variable. Si la variable no existe o si la política no puede encontrar el JWT, la política mostrará un error.

Valor predeterminado	request.header.authorization (consulta la nota anterior para obtener información importante sobre el valor predeterminado).
Presencia	Opcional
Tipo	String
Valores válidos	Un nombre de variable de flujo de Apigee.

Flow variables

Upon success, the Verify JWT and Decode JWT policies set context variables according to this pattern:

jwt.{policy_name}.{variable_name}

For example, if the policy name is jwt-parse-token , then the policy will store the subject specified in the JWT to the context variable named jwt.jwt-parse-token.decoded.claim.sub. (For backward compatibility, it will also be available in jwt.jwt-parse-token.claim.subject)

Variable name	Description
claim.audience	The JWT audience claim. This value may be a string, or an array of strings.
claim.expiry	The expiration date/time, expressed in milliseconds since epoch.
claim.issuedat	The Date the token was issued, expressed in milliseconds since epoch.
claim.issuer	The JWT issuer claim.
claim.notbefore	If the JWT includes a nbf claim, this variable will contain the value, expressed in milliseconds since epoch.
claim.subject	The JWT subject claim.
claim.name	The value of the named claim (standard or additional) in the payload. One of these will be set for every claim in the payload.
decoded.claim.name	The JSON-parsable value of the named claim (standard or additional) in the payload. One variable is set for every claim in the payload. For example, you can use decoded.claim.iat to retrieve the issued-at time of the JWT, expressed in seconds since epoch. While you can also use the claim.name flow variables, this is the recommended variable to use to access a claim.
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.
expiry_formatted	The expiration date/time, formatted as a human-readable string. Example: 2017-09-28T21:30:45.000+0000
header.algorithm	The signing algorithm used on the JWT. For example, RS256, HS384, and so on. See (Algorithm) Header Parameter for more.
header.kid	The Key ID, if added when the JWT was generated. See also "Using a JSON Web Key Set (JWKS)" at JWT policies overview to verify a JWT. See (Key ID) Header Parameter for more.
header.type	Will be set to JWT.
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 JWT.
header-json	The header in JSON format.
is_expired	true or false
payload-claim-names	An array of claims supported by the JWT.
payload-json	The payload in JSON format.
seconds_remaining	The number of seconds before the token will expire. If the token is expired, this number will be negative.
time_remaining_formatted	The time remaining before the token will expire, formatted as a human-readable string. Example: 00:59:59.926
valid	In the case of VerifyJWT, 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 DecodeJWT, this variable is not set.

Referencia de errores

En esta sección se describen los códigos de error y los mensajes de error que devuelve Apigee, así como las variables de error que define, cuando esta política activa un error. Es importante que conozcas esta información si vas a desarrollar reglas de errores para gestionarlos. Para obtener más información, consulta Qué debes saber sobre los errores de las políticas y Cómo gestionar los fallos.

Errores de tiempo de ejecución

Estos errores pueden producirse cuando se ejecuta la política.

Código de fallo	Estado de HTTP	Causa	Solucionar
steps.jwt.FailedToDecode	401	Se produce cuando la política no puede decodificar el JWT. Es posible que el JWT tenga un formato incorrecto, no sea válido o no se pueda decodificar.
steps.jwt.FailedToResolveVariable	401	Se produce cuando no existe la variable de flujo especificada en el elemento <Source> de la política.
steps.jwt.InvalidToken	401	Se produce cuando la variable de flujo especificada en el elemento <Source> de la política está fuera del ámbito o no se puede resolver.

Errores de implementación

Estos errores pueden producirse al implementar un proxy que contenga esta política.

Nombre del error	Causa	Solucionar
InvalidEmptyElement	Se produce cuando la variable de flujo que contiene el JWT que se va a decodificar no se especifica en el elemento <Source> de la política.

Variables de error

Estas variables se definen cuando se produce un error de tiempo de ejecución. Para obtener más información, consulta el artículo Información sobre los errores de las políticas.

Variables	Dónde	Ejemplo
fault.name="fault_name"	fault_name es el nombre del error, tal como se indica en la tabla Errores de tiempo de ejecución de arriba. El nombre del error es la última parte del código de error.	fault.name Matches "InvalidToken"
JWT.failed	Todas las políticas de JWT definen la misma variable en caso de error.	JWT.failed = true

Ejemplo de respuesta de error

Para gestionar los errores, la práctica recomendada es interceptar la parte errorcode de la respuesta de error. No te fíes del texto de faultstring, ya que podría cambiar.

Regla de error de ejemplo

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