io.smallrye.jwt.build

Interface JwtSignature

All Known Subinterfaces:

JwtClaimsBuilder, JwtSignatureBuilder

public interface JwtSignature

JWT JsonWebSignature.

Method Summary

Modifier and Type	Method and Description
JwtEncryptionBuilder	innerSign() Sign the claims with a key loaded from the location set with the "smallrye.jwt.sign.key.location" or "smallrye.jwt.sign.key-location" properties and encrypt the inner JWT by moving to JwtEncryptionBuilder.
JwtEncryptionBuilder	innerSign(PrivateKey signingKey) Sign the claims with PrivateKey and encrypt the inner JWT by moving to JwtEncryptionBuilder.
JwtEncryptionBuilder	innerSign(SecretKey signingKey) Sign the claims with SecretKey and encrypt the inner JWT by moving to JwtEncryptionBuilder.
JwtEncryptionBuilder	innerSign(String keyLocation) Sign the claims with a private or secret key loaded from the custom location which can point to a PEM, JWK or JWK set keys and encrypt the inner JWT by moving to JwtEncryptionBuilder.
JwtEncryptionBuilder	innerSignWithSecret(String secret) Sign the claims with a secret key string and encrypt the inner JWT by moving to JwtEncryptionBuilder.
String	sign() Sign the claims with a key loaded from the location set with the "smallrye.jwt.sign.key.location" or "smallrye.jwt.sign.key-location" properties which can point to PEM, JWK or JWK set keys.
String	sign(PrivateKey signingKey) Sign the claims with PrivateKey.
String	sign(SecretKey signingKey) Sign the claims with SecretKey 'HS256' algorithm will be used unless a different algorithm has been set with JwtSignatureBuilder.
String	sign(String keyLocation) Sign the claims with a private or secret key loaded from the custom location which can point to a PEM, JWK or JWK set keys.
String	signWithSecret(String secret) Sign the claims with a secret key string.

Method Detail

sign

String sign(PrivateKey signingKey)
     throws JwtSignatureException

Sign the claims with PrivateKey. 'RS256' algorithm will be used unless a different algorithm has been set with JwtSignatureBuilder. A key of size 2048 bits or larger MUST be used with the 'RS256' algorithm.

Parameters:

signingKey - the signing key

Returns:

signed JWT token

Throws:

JwtSignatureException - the exception if the signing operation has failed

sign

String sign(SecretKey signingKey)
     throws JwtSignatureException

Sign the claims with SecretKey 'HS256' algorithm will be used unless a different algorithm has been set with JwtSignatureBuilder.

Parameters:

signingKey - the signing key

Returns:

signed JWT token

Throws:

JwtSignatureException - the exception if the signing operation has failed

sign

String sign(String keyLocation)
     throws JwtSignatureException

Sign the claims with a private or secret key loaded from the custom location which can point to a PEM, JWK or JWK set keys. 'RS256' algorithm will be used unless a different algorithm has been set with JwtSignatureBuilder. A key of size 2048 bits or larger MUST be used with the 'RS256' algorithm.

Parameters:

keyLocation - the signing key location

Returns:

signed JWT token

Throws:

JwtSignatureException - the exception if the signing operation has failed

sign

String sign()
     throws JwtSignatureException

Sign the claims with a key loaded from the location set with the "smallrye.jwt.sign.key.location" or "smallrye.jwt.sign.key-location" properties which can point to PEM, JWK or JWK set keys. Note: "smallrye.jwt.sign.key-location" property is deprecated and will be removed in the next major release. 'RS256' algorithm will be used unless a different algorithm has been set with JwtSignatureBuilder. A key of size 2048 bits or larger MUST be used with the 'RS256' algorithm.

Returns:

signed JWT token

Throws:

JwtSignatureException - the exception if the signing operation has failed

signWithSecret

String signWithSecret(String secret)
               throws JwtSignatureException

Sign the claims with a secret key string. 'HS256' algorithm will be used unless a different algorithm has been set with JwtSignatureBuilder.

Parameters:

secret - the secret

Returns:

signed JWT token

Throws:

JwtSignatureException - the exception if the signing operation has failed

innerSign

JwtEncryptionBuilder innerSign(PrivateKey signingKey)
                        throws JwtSignatureException

Sign the claims with PrivateKey and encrypt the inner JWT by moving to JwtEncryptionBuilder. 'RS256' algorithm will be used unless a different algorithm has been set with JwtSignatureBuilder. A key of size 2048 bits or larger MUST be used with the 'RS256' algorithm.

Parameters:

signingKey - the signing key

Returns:

JwtEncryption

Throws:

JwtSignatureException - the exception if the inner JWT signing operation has failed

innerSign

JwtEncryptionBuilder innerSign(SecretKey signingKey)
                        throws JwtSignatureException

Sign the claims with SecretKey and encrypt the inner JWT by moving to JwtEncryptionBuilder. 'HS256' algorithm will be used unless a different algorithm has been set with JwtSignatureBuilder.

Parameters:

signingKey - the signing key

Returns:

JwtEncryption

Throws:

JwtSignatureException - the exception if the inner JWT signing operation has failed

innerSign

JwtEncryptionBuilder innerSign(String keyLocation)
                        throws JwtSignatureException

Sign the claims with a private or secret key loaded from the custom location which can point to a PEM, JWK or JWK set keys and encrypt the inner JWT by moving to JwtEncryptionBuilder. 'RS256' algorithm will be used unless a different one has been set with JwtSignatureBuilder. A key of size 2048 bits or larger MUST be used with the 'RS256' algorithm.

Parameters:

keyLocation - the signing key location

Returns:

JwtEncryption

Throws:

JwtSignatureException - the exception if the inner JWT signing operation has failed

innerSign

JwtEncryptionBuilder innerSign()
                        throws JwtSignatureException

Sign the claims with a key loaded from the location set with the "smallrye.jwt.sign.key.location" or "smallrye.jwt.sign.key-location" properties and encrypt the inner JWT by moving to JwtEncryptionBuilder. Note: "smallrye.jwt.sign.key-location" property is deprecated and will be removed in the next major release. If no "smallrye.jwt.sign.key.location" or "smallrye.jwt.sign.key-location" properties and 'alg' algorithm header have been set then an insecure inner JWT with a "none" algorithm has to be created before being encrypted. Note: support for the "none" algorithm has been deprecated and will be removed in the next major release. A key of size 2048 bits or larger MUST be used with the 'RS256' algorithm.

Returns:

JwtEncryption

Throws:

JwtSignatureException - the exception if the inner JWT signing operation has failed

innerSignWithSecret

JwtEncryptionBuilder innerSignWithSecret(String secret)
                                  throws JwtSignatureException

Sign the claims with a secret key string and encrypt the inner JWT by moving to JwtEncryptionBuilder. 'HS256' algorithm will be used unless a different one has been set with JwtSignatureBuilder.

Parameters:

secret - the secret

Returns:

signed JWT token

Throws:

JwtSignatureException - the exception if the signing operation has failed