l8w8jwt_decoding_params

Struct containing the parameters to use for decoding and validating a JWT.

Members

Variables

alg int alg;: The signature algorithm ID. [0;2] = HS256/384/512 | [3;5] = RS256/384/512 | [6;8] = PS256/384/512 | [9;11] = ES256/384/512 This affects what should be the value of {@link #verification_key}
exp_tolerance_seconds ubyte exp_tolerance_seconds;: Small inconsistencies in time can happen, or also latency between clients and servers. That's just life. You can forgive a few seconds of expiration, but don't exaggerate this! Only taken into consideration if {@link #validate_exp} is set to <code>1</code>.
iat_tolerance_seconds ubyte iat_tolerance_seconds;: The amount of seconds to subtract from the current time when comparing the "issued at" claim, to allow for a small tolerance time frame. Only taken into consideration if {@link #validate_iat} is set to <code>1</code>.
jwt char* jwt;: The token to decode and validate.
jwt_length size_t jwt_length;: The jwt string length.
nbf_tolerance_seconds ubyte nbf_tolerance_seconds;: The amount of seconds to subtract from the current time when comparing the "not before" claim, to allow for a small tolerance time frame. Only taken into consideration if {@link #validate_nbf} is set to <code>1</code>.
validate_aud char* validate_aud;: OPTIONAL The audience claim (who is the JWT intended for? Who is the intended JWT's recipient?). Set to <code>NULL</code> if you don't want to validate the audience. The JWT will only pass verification if its <code>aud</code> matches this string. @see https://tools.ietf.org/html/rfc7519#section-4.1.3
validate_aud_length size_t validate_aud_length;: validate_aud string length.
validate_exp int validate_exp;: Should the expiration claim be verified? If this is set to <code>1</code>, the <code>exp</code> claim will be compared to the current date and time + {@link #exp_tolerance_seconds}
validate_iat int validate_iat;: Should the "issued at" claim be verified? If this is set to <code>1</code>, the <code>iat</code> claim will be compared to the current date and time + {@link #iat_tolerance_seconds}
validate_iss char* validate_iss;: OPTIONAL The issuer claim (who issued the JWT?). Set to <code>NULL</code> if you don't want to validate the issuer. The JWT will only pass verification if its <code>iss</code> claim matches this string. @see https://tools.ietf.org/html/rfc7519#section-4.1.1
validate_iss_length size_t validate_iss_length;: validate_iss string length.
validate_jti char* validate_jti;: OPTIONAL The JWT ID. Provides a unique identifier for the token. Set to <code>NULL</code> if you don't want to validate the jti claim. The JWT will only pass verification if its <code>jti</code> matches this string. @see https://tools.ietf.org/html/rfc7519#section-4.1.7
validate_jti_length size_t validate_jti_length;: validate_jti claim length.
validate_nbf int validate_nbf;: Should the "not before" claim be verified? If this is set to <code>1</code>, the <code>nbf</code> claim will be compared to the current date and time + {@link #nbf_tolerance_seconds}
validate_sub char* validate_sub;: OPTIONAL The subject claim (who is the JWT about?). Set to <code>NULL</code> if you don't want to validate the subject claim. The JWT will only pass verification if its <code>sub</code> matches this string. @see https://tools.ietf.org/html/rfc7519#section-4.1.2
validate_sub_length size_t validate_sub_length;: validate_sub string length.
validate_typ char* validate_typ;: OPTIONAL The typ claim (what type is the token?). Set to <code>NULL</code> if you don't want to validate the "typ" claim.
validate_typ_length size_t validate_typ_length;: validate_typ string length.
verification_key ubyte* verification_key;: The key to use for verifying the token's signature (e.g. if you chose HS256 as algorithm, this will be the HMAC secret; for RS512 this will be the PEM-formatted public RSA key string, etc...).
verification_key_length size_t verification_key_length;: Length of the {@link #verification_key}

l8w8jwt_decoding_params

Members

Variables

Meta

Source