io.smallrye.jwt.build

Interface JwtEncryption

All Known Subinterfaces:

JwtEncryptionBuilder

public interface JwtEncryption

JWT JsonWebEncryption.

Method Summary

Modifier and Type	Method and Description
String	encrypt() Encrypt the claims or inner JWT with a key loaded from the location set with the "smallrye.jwt.encrypt.key-location" or "smallrye.jwt.encrypt.key.location" properties.
String	encrypt(PublicKey keyEncryptionKey) Encrypt the claims or inner JWT with PublicKey.
String	encrypt(SecretKey keyEncryptionKey) Encrypt the claims or inner JWT with SecretKey.
String	encrypt(String keyLocation) Encrypt the claims or inner JWT with a public or secret key loaded from the custom location which can point to a PEM, JWK or JWK set keys.
String	encryptWithSecret(String secret) Encrypt the claims or inner JWT with a secret key string.

Method Detail

encrypt

String encrypt(PublicKey keyEncryptionKey)
        throws JwtEncryptionException

Encrypt the claims or inner JWT with PublicKey. 'RSA-OAEP-256' and 'ECDH-ES+A256KW' key encryption algorithms will be used by default when public RSA or EC keys are used unless a different one has been set with JwtEncryptionBuilder. 'A256GCM' content encryption algorithms will be used unless a different one have been set with JwtEncryptionBuilder. A key of size 2048 bits or larger MUST be used with the 'RSA-OAEP' and 'RSA-OAEP-256' algorithms. Note: Setting 'RSA-OAEP-256' as a default key encryption algorithm when public RSA keys are used is deprecated. Future version of this API will set 'RSA-OAEP' by default.

Parameters:

keyEncryptionKey - the key which encrypts the content encryption key

Returns:

encrypted JWT token

Throws:

JwtEncryptionException - the exception if the encryption operation has failed

encrypt

String encrypt(SecretKey keyEncryptionKey)
        throws JwtEncryptionException

Encrypt the claims or inner JWT with SecretKey. 'A256KW' key and 'A256GCM' content encryption algorithms will be used unless different ones have been set with JwtEncryptionBuilder.

Parameters:

keyEncryptionKey - the key which encrypts the content encryption key

Returns:

encrypted JWT token

Throws:

JwtEncryptionException - the exception if the encryption operation has failed

encrypt

String encrypt(String keyLocation)
        throws JwtEncryptionException

Encrypt the claims or inner JWT with a public or secret key loaded from the custom location which can point to a PEM, JWK or JWK set keys. 'RSA-OAEP-256', 'ECDH-ES+A256KW' and 'A256KW' key encryption algorithms will be used by default when public RSA, EC or secret keys are used unless a different one has been set with JwtEncryptionBuilder. 'A256GCM' content encryption algorithms will be used unless a different one have been set with JwtEncryptionBuilder. A key of size 2048 bits or larger MUST be used with the 'RSA-OAEP' and 'RSA-OAEP-256' algorithms. Note: Setting 'RSA-OAEP-256' as a default key encryption algorithm when public RSA keys are used is deprecated. Future version of this API will set 'RSA-OAEP' by default.

Parameters:

keyLocation - the location of the keyEncryptionKey which encrypts the content encryption key

Returns:

encrypted JWT token

Throws:

JwtEncryptionException - the exception if the encryption operation has failed

encrypt

String encrypt()
        throws JwtEncryptionException

Encrypt the claims or inner JWT with a key loaded from the location set with the "smallrye.jwt.encrypt.key-location" or "smallrye.jwt.encrypt.key.location" properties. Note: "smallrye.jwt.encrypt.key-location" property is deprecated and will be removed in the next major release. 'RSA-OAEP-256', 'ECDH-ES+A256KW' and 'A256KW' key encryption algorithms will be used by default when public RSA, EC or secret keys are used unless a different one has been set with JwtEncryptionBuilder. 'A256GCM' content encryption algorithms will be used unless a different one have been set with JwtEncryptionBuilder. A key of size 2048 bits or larger MUST be used with the 'RSA-OAEP' and 'RSA-OAEP-256' algorithms. Note: Setting 'RSA-OAEP-256' as a default key encryption algorithm when public RSA keys are used is deprecated. Future version of this API will set 'RSA-OAEP' by default.

Returns:

encrypted JWT token

Throws:

JwtEncryptionException - the exception if the encryption operation has failed

encryptWithSecret

String encryptWithSecret(String secret)
                  throws JwtEncryptionException

Encrypt the claims or inner JWT with a secret key string. 'A256KW' key encryption algorithms will be used by default unless a different one has been set with JwtEncryptionBuilder. 'A256GCM' content encryption algorithms will be used unless a different one have been set with JwtEncryptionBuilder.

Parameters:

secret - the secret

Returns:

encrypted JWT token

Throws:

JwtEncryptionException - the exception if the encryption operation has failed