Class JwsHeader
java.lang.Object
org.springframework.security.oauth2.jwt.JwsHeader
The JSON Web Signature (JWS) header is a JSON object representing the header parameters
of a JSON Web Token, that describe the cryptographic operations used to digitally sign
or create a MAC of the contents of the JWS Protected Header and JWS Payload.
- Since:
- 5.6
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic JwsHeader.Builder
Returns a newJwsHeader.Builder
, initialized with the providedheaders
.Returns theJWA algorithm
used to digitally sign the JWS or encrypt the JWE.Returns the content type header that declares the media type of the secured content (the payload).Returns the critical headers that indicates which extensions to the JWS/JWE/JWA specifications are being used that MUST be understood and processed.<T> T
Returns the header value.Returns the headers.getJwk()
Returns the JSON Web Key which is the public key that corresponds to the key used to digitally sign the JWS or encrypt the JWE.Returns the JWK Set URL that refers to the resource of a set of JSON-encoded public keys, one of which corresponds to the key used to digitally sign the JWS or encrypt the JWE.getKeyId()
Returns the key ID that is a hint indicating which key was used to secure the JWS or JWE.getType()
Returns the type header that declares the media type of the JWS/JWE.Returns the X.509 certificate chain that contains the X.509 public key certificate or certificate chain corresponding to the key used to digitally sign the JWS or encrypt the JWE.Returns the X.509 certificate SHA-1 thumbprint that is a base64url-encoded SHA-1 thumbprint (a.k.a.Returns the X.509 certificate SHA-256 thumbprint that is a base64url-encoded SHA-256 thumbprint (a.k.a.Returns the X.509 URL that refers to the resource for the X.509 public key certificate or certificate chain corresponding to the key used to digitally sign the JWS or encrypt the JWE.static JwsHeader.Builder
with
(JwsAlgorithm jwsAlgorithm) Returns a newJwsHeader.Builder
, initialized with the providedJwsAlgorithm
.
-
Method Details
-
getAlgorithm
Returns theJWA algorithm
used to digitally sign the JWS or encrypt the JWE.- Returns:
- the
JwaAlgorithm
-
with
Returns a newJwsHeader.Builder
, initialized with the providedJwsAlgorithm
.- Parameters:
jwsAlgorithm
- theJwsAlgorithm
- Returns:
- the
JwsHeader.Builder
-
from
Returns a newJwsHeader.Builder
, initialized with the providedheaders
.- Parameters:
headers
- the headers- Returns:
- the
JwsHeader.Builder
-
getJwkSetUrl
Returns the JWK Set URL that refers to the resource of a set of JSON-encoded public keys, one of which corresponds to the key used to digitally sign the JWS or encrypt the JWE.- Returns:
- the JWK Set URL
-
getJwk
Returns the JSON Web Key which is the public key that corresponds to the key used to digitally sign the JWS or encrypt the JWE.- Returns:
- the JSON Web Key
-
getKeyId
Returns the key ID that is a hint indicating which key was used to secure the JWS or JWE.- Returns:
- the key ID
-
getX509Url
Returns the X.509 URL that refers to the resource for the X.509 public key certificate or certificate chain corresponding to the key used to digitally sign the JWS or encrypt the JWE.- Returns:
- the X.509 URL
-
getX509CertificateChain
Returns the X.509 certificate chain that contains the X.509 public key certificate or certificate chain corresponding to the key used to digitally sign the JWS or encrypt the JWE. The certificate or certificate chain is represented as aList
of certificate valueString
s. EachString
in theList
is a Base64-encoded DER PKIX certificate value.- Returns:
- the X.509 certificate chain
-
getX509SHA1Thumbprint
Returns the X.509 certificate SHA-1 thumbprint that 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 the JWS or encrypt the JWE.- Returns:
- the X.509 certificate SHA-1 thumbprint
-
getX509SHA256Thumbprint
Returns the X.509 certificate SHA-256 thumbprint that 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 the JWS or encrypt the JWE.- Returns:
- the X.509 certificate SHA-256 thumbprint
-
getType
Returns the type header that declares the media type of the JWS/JWE.- Returns:
- the type header
-
getContentType
Returns the content type header that declares the media type of the secured content (the payload).- Returns:
- the content type header
-
getCritical
Returns the critical headers that indicates which extensions to the JWS/JWE/JWA specifications are being used that MUST be understood and processed.- Returns:
- the critical headers
-
getHeaders
Returns the headers.- Returns:
- the headers
-
getHeader
Returns the header value.- Type Parameters:
T
- the type of the header value- Parameters:
name
- the header name- Returns:
- the header value
-