Uses of Interface
org.forgerock.json.jose.jws.handlers.SigningHandler
-
Packages that use SigningHandler Package Description org.forgerock.json.jose.builders Classes and interfaces for builder to build JWTs using a fluent API.org.forgerock.json.jose.jwe Classes and interfaces for JWT encryption and JWEs.org.forgerock.json.jose.jws Classes and interfaces for JWT signing and JWS'.org.forgerock.json.jose.jws.handlers Signing Handler classes for each possible signing algorithm.org.forgerock.json.jose.tokenhandler JWT implementation(s) ofTokenHandler
. -
-
Uses of SigningHandler in org.forgerock.json.jose.builders
Methods in org.forgerock.json.jose.builders with parameters of type SigningHandler Modifier and Type Method Description SignedJwtBuilderImpl
JwtBuilderFactory. jws(SigningHandler signingHandler)
Creates a builder for building a signed JWT into a base64url UTF-8 encoded JWT string.SignedEncryptedJwtBuilder
EncryptedJwtBuilder. sign(SigningHandler signingHandler, JwsAlgorithm jwsAlgorithm)
Deprecated.EncryptedThenSignedJwtBuilder
EncryptedJwtBuilder. signedWith(SigningHandler signingHandler, JwsAlgorithm jwsAlgorithm)
Returns anEncryptedThenSignedJwtBuilder
that will build a signed JWT with this builder's encrypted JWT as its payload.Constructors in org.forgerock.json.jose.builders with parameters of type SigningHandler Constructor Description EncryptedThenSignedJwtBuilder(EncryptedJwtBuilder encryptedJwtBuilder, SigningHandler signingHandler, JwsAlgorithm jwsAlgorithm)
Constructs a new SignedEncryptedJwtBuilder that will use the given EncryptedJwtBuilder, to build the nested Encrypted JWT, and the private key and JwsAlgorithm to sign the outer JWT.SignedEncryptedJwtBuilder(EncryptedJwtBuilder encryptedJwtBuilder, SigningHandler signingHandler, JwsAlgorithm jwsAlgorithm)
Deprecated.Constructs a new SignedEncryptedJwtBuilder that will use the given EncryptedJwtBuilder, to build the nested Encrypted JWT, and the private key and JwsAlgorithm to sign the outer JWT.SignedJwtBuilderImpl(SigningHandler signingHandler)
Constructs a new SignedJwtBuilderImpl that will use the given private key to sign the JWT. -
Uses of SigningHandler in org.forgerock.json.jose.jwe
Methods in org.forgerock.json.jose.jwe with parameters of type SigningHandler Modifier and Type Method Description boolean
SignedThenEncryptedJwt. decryptAndVerify(Key decryptionKey, SigningHandler signingHandler)
Decrypts the outer JWT and then verifies the signature on the inner JWT.boolean
SignedThenEncryptedJwt. verify(SigningHandler signingHandler)
Verifies that the signature is valid on the nested signed JWT. -
Uses of SigningHandler in org.forgerock.json.jose.jws
Methods in org.forgerock.json.jose.jws that return SigningHandler Modifier and Type Method Description SigningHandler
SigningManager. newEcdsaSigningHandler(ECPrivateKey key)
Deprecated.useSigningManager.newEcdsaSigningHandler(SigningKey)
} insteadSigningHandler
SigningManager. newEcdsaSigningHandler(PrivateKey key)
Deprecated.useSigningManager.newEcdsaSigningHandler(SigningKey)
} insteadSigningHandler
SigningManager. newEcdsaSigningHandler(SigningKey key)
Constructs a new handler for signing ES256 signatures.SigningHandler
SigningManager. newEcdsaVerificationHandler(ECPublicKey key)
Deprecated.SigningHandler
SigningManager. newEcdsaVerificationHandler(VerificationKey key)
Constructs a new handler for verifying ES256 signatures.SigningHandler
SigningManager. newEdDsaSigningHandler(byte[] privateKey)
Deprecated.SigningHandler
SigningManager. newEdDsaSigningHandler(SigningKey signingKey)
Constructs a new handler for signing EdDSA signatures.SigningHandler
SigningManager. newEdDsaVerificationHandler(byte[] publicKey)
Deprecated.SigningHandler
SigningManager. newEdDsaVerificationHandler(VerificationKey verificationKey)
Constructs a new handler for verifying EdDSA signatures.SigningHandler
SigningManager. newHmacSigningHandler(byte[] sharedSecret)
Deprecated.useSigningManager.newHmacSigningHandler(SigningKey)
insteadSigningHandler
SigningManager. newHmacSigningHandler(SecretKey secretKey)
Deprecated.useSigningManager.newHmacSigningHandler(SigningKey)
insteadSigningHandler
SigningManager. newHmacSigningHandler(SigningKey key)
Constructs a new SecretHmacSigningHandler configured for signature validation.SigningHandler
SigningManager. newHmacVerificationHandler(VerificationKey key)
Constructs a new SecretHmacSigningHandler configured for signature validation.SigningHandler
SigningManager. newNopSigningHandler()
Deprecated.This method is inherently insecure and shouldn't be used.SigningHandler
SigningManager. newRsaSigningHandler(Key key)
Deprecated.SigningHandler
SigningManager. newRsaSigningHandler(SigningKey key)
Constructs a new SecretRSASigningHandler configured for signature validation.SigningHandler
SigningManager. newRsaVerificationHandler(VerificationKey key)
Constructs a new SecretRSASigningHandler configured for signature validation.SigningHandler
SigningManager. newSigningHandler(Key key)
Deprecated.UseSigningManager.newSigningHandler(SigningKey)
insteadSigningHandler
SigningManager. newSigningHandler(JWK jwk)
Returns the signing handler from the given JSON Web Key (JWK) which will be used to sign the JWT.SigningHandler
SigningManager. newSigningHandler(SigningKey key)
Returns the signing handler from the given SigningKey which will be used to sign the JWT.SigningHandler
SigningManager. newVerificationHandler(Key key)
Deprecated.SigningHandler
SigningManager. newVerificationHandler(JWK jwk)
Returns the signing handler from the given JSON Web Key (JWK) which will be used to verify the JWT.SigningHandler
SigningManager. newVerificationHandler(VerificationKey key)
Returns the signing handler from the given VerificationKey which will be used to verify the JWT.Methods in org.forgerock.json.jose.jws that return types with arguments of type SigningHandler Modifier and Type Method Description Promise<SigningHandler,NoSuchSecretException>
SigningManager. newSigningHandler(Purpose<SigningKey> purpose)
Constructs a new SigningHandler configured for signing with the provided secret purpose.Promise<SigningHandler,NoSuchSecretException>
SigningManager. newSigningHandler(SecretReference<SigningKey> secretReference)
Constructs a new SigningHandler configured for signing with the provided secret reference.Promise<SigningHandler,NeverThrowsException>
SigningManager. newVerificationHandler(Purpose<VerificationKey> purpose, String keyId)
Constructs a new SigningHandler configured for verifying with the provided secret purpose.Methods in org.forgerock.json.jose.jws with parameters of type SigningHandler Modifier and Type Method Description boolean
SignedJwt. verify(SigningHandler signingHandler)
Verifies that the JWS signature is valid for the contents of its payload.Constructors in org.forgerock.json.jose.jws with parameters of type SigningHandler Constructor Description EncryptedThenSignedJwt(JwsHeader header, EncryptedJwt nestedJwe, SigningHandler signingHandler)
Constructs a fresh, new SignedEncryptedJwt from the given JwsHeader and nested Encrypted JWT.SignedEncryptedJwt(JwsHeader header, EncryptedJwt nestedJwe, SigningHandler signingHandler)
Deprecated.Constructs a fresh, new SignedEncryptedJwt from the given JwsHeader and nested Encrypted JWT.SignedJwt(JwsHeader header, JwtClaimsSet claimsSet, SigningHandler signingHandler)
Constructs a fresh, new SignedJwt from the given JwsHeader and JwtClaimsSet.SignedJwt(JwsHeader header, Payload nestedPayload, SigningHandler signingHandler)
Constructs a fresh, new SignedJwt from the given JwsHeader and nested Encrypted JWT. -
Uses of SigningHandler in org.forgerock.json.jose.jws.handlers
Classes in org.forgerock.json.jose.jws.handlers that implement SigningHandler Modifier and Type Class Description class
ECDSASigningHandler
Deprecated.UseSecretECDSASigningHandler
insteadclass
EdDSASigningHandler
Deprecated.UseSecretEdDSASigningHandler
instead.class
HmacSigningHandler
Deprecated.UseSecretHmacSigningHandler
insteadclass
NOPSigningHandler
Deprecated.This algorithm is inherently insecure and shouldn't be used.class
RSASigningHandler
Deprecated.UseSecretRSASigningHandler
insteadclass
SecretECDSASigningHandler
Elliptic Curve Digital Signature Algorithm (ECDSA) signing and verification.class
SecretEdDSASigningHandler
Signing handler for Edwards Curve DSA (EdDSA) as defined in RFC 8037.class
SecretHmacSigningHandler
An implementation of the SigningHandler which can sign and verify using algorithms from the HMAC family.class
SecretRSASigningHandler
AnSecret
-based implementation of the SigningHandler which can sign and verify using algorithms from the RSA family.class
SecretSigningHandler
ProvidesSecret
-based signing and verification code base. -
Uses of SigningHandler in org.forgerock.json.jose.tokenhandler
Constructors in org.forgerock.json.jose.tokenhandler with parameters of type SigningHandler Constructor Description JwtTokenHandler(JweAlgorithm jweAlgorithm, EncryptionMethod jweMethod, KeyPair jweKeyPair, JwsAlgorithm jwsAlgorithm, SigningHandler jwsHandler)
Constructs a new JWT token handler that never expires.JwtTokenHandler(JweAlgorithm jweAlgorithm, EncryptionMethod jweMethod, KeyPair jweKeyPair, JwsAlgorithm jwsAlgorithm, SigningHandler jwsHandler, Optional<Long> tokenLifeTimeInSeconds, int tokenStatePaddingLength)
Constructs a new JWT token handler.
-