Class JoseHeaderNames

java.lang.Object
org.springframework.security.oauth2.jwt.JoseHeaderNames

public final class JoseHeaderNames extends Object
The Registered Header Parameter Names defined by the JSON Web Token (JWT), JSON Web Signature (JWS) and JSON Web Encryption (JWE) specifications that may be contained in the JOSE Header of a JWT.
Since:
5.6
See Also:
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    alg - the algorithm header identifies the cryptographic algorithm used to secure a JWS or JWE
    static final String
    crit - the critical header indicates that extensions to the JWS/JWE/JWA specifications are being used that MUST be understood and processed
    static final String
    cty - the content type header is used by JWS/JWE applications to declare the media type of the secured content (the payload)
    static final String
    jku - the JWK Set URL header is a URI that refers to a resource for a set of JSON-encoded public keys, one of which corresponds to the key used to digitally sign a JWS or encrypt a JWE
    static final String
    jwk - the JSON Web Key header is the public key that corresponds to the key used to digitally sign a JWS or encrypt a JWE
    static final String
    kid - the key ID header is a hint indicating which key was used to secure a JWS or JWE
    static final String
    typ - the type header is used by JWS/JWE applications to declare the media type of a JWS/JWE
    static final String
    x5c - the X.509 certificate chain header contains the X.509 public key certificate or certificate chain corresponding to the key used to digitally sign a JWS or encrypt a JWE
    static final String
    x5t - the X.509 certificate SHA-1 thumbprint header is a base64url-encoded SHA-1 thumbprint (a.k.a.
    static final String
    x5t#S256 - the X.509 certificate SHA-256 thumbprint header is a base64url-encoded SHA-256 thumbprint (a.k.a.
    static final String
    x5u - the X.509 URL header is a URI that refers to a resource for the X.509 public key certificate or certificate chain corresponding to the key used to digitally sign a JWS or encrypt a JWE
  • Method Summary

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Field Details

    • ALG

      public static final String ALG
      alg - the algorithm header identifies the cryptographic algorithm used to secure a JWS or JWE
      See Also:
    • JKU

      public static final String JKU
      jku - the JWK Set URL header is a URI that refers to a resource for a set of JSON-encoded public keys, one of which corresponds to the key used to digitally sign a JWS or encrypt a JWE
      See Also:
    • JWK

      public static final String JWK
      jwk - the JSON Web Key header is the public key that corresponds to the key used to digitally sign a JWS or encrypt a JWE
      See Also:
    • KID

      public static final String KID
      kid - the key ID header is a hint indicating which key was used to secure a JWS or JWE
      See Also:
    • X5U

      public static final String X5U
      x5u - the X.509 URL header is a URI that refers to a resource for the X.509 public key certificate or certificate chain corresponding to the key used to digitally sign a JWS or encrypt a JWE
      See Also:
    • X5C

      public static final String X5C
      x5c - the X.509 certificate chain header contains the X.509 public key certificate or certificate chain corresponding to the key used to digitally sign a JWS or encrypt a JWE
      See Also:
    • X5T

      public static final String X5T
      x5t - the X.509 certificate SHA-1 thumbprint header is a base64url-encoded SHA-1 thumbprint (a.k.a. digest) of the DER encoding of the X.509 certificate corresponding to the key used to digitally sign a JWS or encrypt a JWE
      See Also:
    • X5T_S256

      public static final String X5T_S256
      x5t#S256 - the X.509 certificate SHA-256 thumbprint header is a base64url-encoded SHA-256 thumbprint (a.k.a. digest) of the DER encoding of the X.509 certificate corresponding to the key used to digitally sign a JWS or encrypt a JWE
      See Also:
    • TYP

      public static final String TYP
      typ - the type header is used by JWS/JWE applications to declare the media type of a JWS/JWE
      See Also:
    • CTY

      public static final String CTY
      cty - the content type header is used by JWS/JWE applications to declare the media type of the secured content (the payload)
      See Also:
    • CRIT

      public static final String CRIT
      crit - the critical header indicates that extensions to the JWS/JWE/JWA specifications are being used that MUST be understood and processed
      See Also: