X509Mutator (JJWT :: API 0.13.0 API)

Type Parameters:
T - the mutator subtype, for method chaining

All Known Subinterfaces:

AsymmetricJwkBuilder<K,J,T>, EcPrivateJwkBuilder, EcPublicJwkBuilder, JweHeaderMutator<T>, JwtBuilder.BuilderHeader, Jwts.HeaderBuilder, OctetPrivateJwkBuilder<K,L>, OctetPublicJwkBuilder<A,B>, PrivateJwkBuilder<K,L,J,M,T>, ProtectedHeaderMutator<T>, PublicJwkBuilder<K,L,J,M,P,T>, RsaPrivateJwkBuilder, RsaPublicJwkBuilder, X509Builder<T>
```
public interface X509Mutator<T extends X509Mutator<T>>
```
Mutation (modifications) of X.509-specific properties of an associated JWT Header or JWK, enabling method chaining.

Since:

0.12.0

Method Summary

Methods
Modifier and Type	Method and Description
`T`	`x509Chain(List<X509Certificate> chain)` Sets the `x5c` (X.509 Certificate Chain) of the associated JWT or JWK.
`T`	`x509Sha1Thumbprint(byte[] thumbprint)` Sets the `x5t` (X.509 Certificate SHA-1 Thumbprint) (a.k.a.
`T`	`x509Sha256Thumbprint(byte[] thumbprint)` Sets the `x5t#S256` (X.509 Certificate SHA-256 Thumbprint) (a.k.a.
`T`	`x509Url(URI uri)` Sets the `x5u` (X.509 URL) that refers to a resource containing the X.509 public key certificate or certificate chain of the associated JWT or JWK.

- Method Detail
  - x509Url
```
T x509Url(URI uri)
```
    Sets the x5u (X.509 URL) that refers to a resource containing the X.509 public key certificate or certificate chain of the associated JWT or JWK. A null value will remove the property from the JSON map.
    The URI MUST refer to a resource for an X.509 public key certificate or certificate chain that conforms to RFC 5280 in PEM-encoded form, with each certificate delimited as specified in Section 6.1 of RFC 4945. The key in the first certificate MUST match the public key represented by other members of the associated JWT or JWK. The protocol used to acquire the resource MUST provide integrity protection; an HTTP GET request to retrieve the certificate MUST use HTTP over TLS; the identity of the server MUST be validated, as per Section 6 of RFC 6125.
    - When set for a JwsHeader, the certificate or first certificate in the chain contains the public key complement of the private key used to digitally sign the JWS.
    - When set for JweHeader, the certificate or first certificate in the chain contains the public key to which the JWE was encrypted, and may be used to determine the private key needed to decrypt the JWE.
    - When set for an AsymmetricJwk, the certificate or first certificate in the chain MUST contain the public key represented by the JWK.
    Parameters:
    uri - the x5u (X.509 URL) that refers to a resource for the X.509 public key certificate or certificate chain associated with the JWT or JWK.
    
    Returns:
    the mutator/builder for method chaining.
    See Also:
    JWK x5u (X.509 URL) Parameter, JWS x5u (X.509 URL) Header Parameter, JWE x5u (X.509 URL) Header Parameter
  - x509Chain
```
T x509Chain(List<X509Certificate> chain)
```
    Sets the x5c (X.509 Certificate Chain) of the associated JWT or JWK. A null value will remove the property from the JSON map. The initial certificate MAY be followed by additional certificates, with each subsequent certificate being the one used to certify the previous one.
    - When set for a JwsHeader, the first certificate (at list index 0) MUST contain the public key complement of the private key used to digitally sign the JWS.
    - When set for JweHeader, the first certificate (at list index 0) MUST contain the public key to which the JWE was encrypted, and may be used to determine the private key needed to decrypt the JWE.
    - When set for an AsymmetricJwk, the first certificate (at list index 0) MUST contain the public key represented by the JWK.
    Parameters:
    chain - the x5c (X.509 Certificate Chain) of the associated JWT or JWK.
    
    Returns:
    the header/builder for method chaining.
    See Also:
    JWK x5c (X.509 Certificate Chain) Parameter, JWS x5c (X.509 Certificate Chain) Header Parameter, JWE x5c (X.509 Certificate Chain) Header Parameter
  - x509Sha1Thumbprint
```
T x509Sha1Thumbprint(byte[] thumbprint)
```
    Sets the x5t (X.509 Certificate SHA-1 Thumbprint) (a.k.a. digest) of the DER-encoding of the X.509 Certificate associated with the JWT or JWK. A null value will remove the property from the JSON map.
    Note that certificate thumbprints are also sometimes known as certificate fingerprints.
    - When set for a JwsHeader, it is the SHA-1 thumbprint of the X.509 certificate complement of the private key used to digitally sign the JWS.
    - When set for JweHeader, it is the thumbprint of the X.509 Certificate containing the public key to which the JWE was encrypted, and may be used to determine the private key needed to decrypt the JWE.
    - When set for an AsymmetricJwk, it is the thumbprint of the X.509 certificate containing the public key represented by the JWK.
    Parameters:
    thumbprint - the x5t (X.509 Certificate SHA-1 Thumbprint) (a.k.a. digest) of the DER-encoding of the X.509 Certificate associated with the JWT or JWK
    
    Returns:
    the header for method chaining
    See Also:
    JWK x5t (X.509 Certificate SHA-1 Thumbprint) Parameter, JWS x5t (X.509 Certificate SHA-1 Thumbprint) Header Parameter, JWE x5t (X.509 Certificate SHA-1 Thumbprint) Header Parameter
  - x509Sha256Thumbprint
```
T x509Sha256Thumbprint(byte[] thumbprint)
```
    Sets the x5t#S256 (X.509 Certificate SHA-256 Thumbprint) (a.k.a. digest) of the DER-encoding of the X.509 Certificate associated with the JWT or JWK. A null value will remove the property from the JSON map.
    Note that certificate thumbprints are also sometimes known as certificate fingerprints.
    - When set for a JwsHeader, it is the SHA-256 thumbprint of the X.509 certificate complement of the private key used to digitally sign the JWS.
    - When set for JweHeader, it is the SHA-256 thumbprint of the X.509 Certificate containing the public key to which the JWE was encrypted, and may be used to determine the private key needed to decrypt the JWE.
    - When set for a AsymmetricJwk, it is the SHA-256 thumbprint of the X.509 certificate containing the public key represented by the JWK.
    Parameters:
    thumbprint - the x5t (X.509 Certificate SHA-1 Thumbprint) (a.k.a. digest) of the DER-encoding of the X.509 Certificate associated with the JWT or JWK
    
    Returns:
    the header for method chaining
    See Also:
    JWK x5t#S256 (X.509 Certificate SHA-256 Thumbprint) Parameter, JWS x5t#S256 (X.509 Certificate SHA-256 Thumbprint) Header Parameter, JWE x5t#S256 (X.509 Certificate SHA-256 Thumbprint) Header Parameter

Interface X509Mutator<T extends X509Mutator<T>>

Method Summary

Method Detail

x509Url

x509Chain

x509Sha1Thumbprint

x509Sha256Thumbprint