org.mitre.jwt.signer.service

Interface JWTSigningAndValidationService

All Known Implementing Classes:

DefaultJWTSigningAndValidationService

public interface JWTSigningAndValidationService

Method Summary

Modifier and Type	Method and Description
Map<String,com.nimbusds.jose.jwk.JWK>	getAllPublicKeys() Get all public keys for this service, mapped by their Key ID
Collection<com.nimbusds.jose.JWSAlgorithm>	getAllSigningAlgsSupported() Get the list of all signing algorithms supported by this service.
String	getDefaultSignerKeyId()
com.nimbusds.jose.JWSAlgorithm	getDefaultSigningAlgorithm() Get the default signing algorithm for use when nothing else has been specified.
void	signJwt(com.nimbusds.jwt.SignedJWT jwt) Called to sign a jwt in place for a client that hasn't registered a preferred signing algorithm.
void	signJwt(com.nimbusds.jwt.SignedJWT jwt, com.nimbusds.jose.JWSAlgorithm alg) Sign a jwt using the selected algorithm.
boolean	validateSignature(com.nimbusds.jwt.SignedJWT jwtString) Checks the signature of the given JWT against all configured signers, returns true if at least one of the signers validates it.

Method Detail

getAllPublicKeys

Map<String,com.nimbusds.jose.jwk.JWK> getAllPublicKeys()

Get all public keys for this service, mapped by their Key ID

validateSignature

boolean validateSignature(com.nimbusds.jwt.SignedJWT jwtString)

Checks the signature of the given JWT against all configured signers, returns true if at least one of the signers validates it.

Parameters:

jwtString - the string representation of the JWT as sent on the wire

Returns:

true if the signature is valid, false if not

Throws:

NoSuchAlgorithmException

signJwt

void signJwt(com.nimbusds.jwt.SignedJWT jwt)

Called to sign a jwt in place for a client that hasn't registered a preferred signing algorithm. Use the default algorithm to sign.

Parameters:

jwt - the jwt to sign

Throws:

NoSuchAlgorithmException

getDefaultSigningAlgorithm

com.nimbusds.jose.JWSAlgorithm getDefaultSigningAlgorithm()

Get the default signing algorithm for use when nothing else has been specified.

Returns:

getAllSigningAlgsSupported

Collection<com.nimbusds.jose.JWSAlgorithm> getAllSigningAlgsSupported()

Get the list of all signing algorithms supported by this service.

Returns:

signJwt

void signJwt(com.nimbusds.jwt.SignedJWT jwt,
             com.nimbusds.jose.JWSAlgorithm alg)

Sign a jwt using the selected algorithm. The algorithm is selected using the String parameter values specified in the JWT spec, section 6. I.E., "HS256" means HMAC with SHA-256 and corresponds to our HmacSigner class.

Parameters:

jwt - the jwt to sign

alg - the name of the algorithm to use, as specified in JWS s.6

getDefaultSignerKeyId

String getDefaultSignerKeyId()