com.atlassian.jwt

Interface JwtService

public interface JwtService

Verifies incoming JWTs issued by linked applications and generates JWTs for use in outbound requests targeting linked applications.

Since:

1.3

Method Summary

Modifier and Type	Method and Description
String	issueJwt(String jsonPayload, String secret) Generate a JWT for the supplied payload, suitable for authenticating with the specified secret.
String	issueJwt(String jsonPayload, String secret, SigningAlgorithm algorithm) Generate a JWT for the supplied payload, suitable for authenticating with the specified secret.
Jwt	verifyJwt(String jwt, Map<String,? extends JwtClaimVerifier> claimVerifiers) Verify an incoming JWT.

Method Detail

issueJwt

@Nonnull
String issueJwt(@Nonnull
                         String jsonPayload,
                         @Nonnull
                         String secret)

Generate a JWT for the supplied payload, suitable for authenticating with the specified secret. This uses SigningAlgorithm.HS256 as the default signing algorithm. Use issueJwt(String, String, SigningAlgorithm) to create a JWT with a different algorithm

Parameters:

jsonPayload - a JSON payload

secret - the shared-secret or private-key used to sign

Returns:

the JWT string

Throws:

JwtSigningException - if a problem was encountered while generating the JWT

issueJwt

@Nonnull
String issueJwt(@Nonnull
                         String jsonPayload,
                         @Nonnull
                         String secret,
                         SigningAlgorithm algorithm)

Generate a JWT for the supplied payload, suitable for authenticating with the specified secret.

Parameters:

jsonPayload - a JSON payload

secret - the shared-secret or private-key used to sign

algorithm - the algorithm used to sign the JWT

Returns:

the JWT string

Throws:

JwtSigningException - if a problem was encountered while generating the JWT

verifyJwt

@Nonnull
Jwt verifyJwt(@Nonnull
                       String jwt,
                       @Nonnull
                       Map<String,? extends JwtClaimVerifier> claimVerifiers)
                throws JwtIssuerLacksSharedSecretException,
                       JwtParseException,
                       JwtUnknownIssuerException,
                       JwtVerificationException

Verify an incoming JWT.

Parameters:

jwt - a JWT extracted from an incoming request.

claimVerifiers - Map of claim-name to JwtClaimVerifier that will test its correctness

Returns:

the verified JWT if the verification was successful

Throws:

JwtIssuerLacksSharedSecretException - if the JWT issuer is known, but does not have a shared secret registered for it

JwtParseException - if the JWT is malformed

JwtVerificationException - if the JWT is well formed but failed verification

JwtUnknownIssuerException - if this server does not have a JWT relationship with the issuer indicated in the JWT. This will happen if the linked application's JWT credentials have been revoked, for example.