Package io.camunda.zeebe.auth.impl

Class JwtAuthorizationDecoder

java.lang.Object

io.camunda.zeebe.auth.impl.JwtAuthorizationDecoder

All Implemented Interfaces:

AuthorizationDecoder<Map<String,Object>>, JwtAuthorizationBuilder<JwtAuthorizationDecoder,com.auth0.jwt.algorithms.Algorithm,com.auth0.jwt.interfaces.DecodedJWT>

public class JwtAuthorizationDecoder
extends Object
implements JwtAuthorizationBuilder<JwtAuthorizationDecoder,com.auth0.jwt.algorithms.Algorithm,com.auth0.jwt.interfaces.DecodedJWT>, AuthorizationDecoder<Map<String,Object>>

Field Summary

Fields inherited from interface io.camunda.zeebe.auth.api.JwtAuthorizationBuilder

DEFAULT_AUDIENCE, DEFAULT_ISSUER, DEFAULT_SUBJECT

Constructor Summary

Constructors

Constructor	Description
JwtAuthorizationDecoder()
JwtAuthorizationDecoder(String jwtToken)

Method Summary

Modifier and Type	Method	Description
com.auth0.jwt.interfaces.DecodedJWT	build()	Validates the signature and decodes a provided JWT token.
Map<String,Object>	decode()	Returns an instance of containing the user's authorizations.
JwtAuthorizationDecoder	withAudience(String audience)	Sets the token audience.
JwtAuthorizationDecoder	withClaim(String claimName)	Sets the name of a JWT token claim expected to be part of the token.
JwtAuthorizationDecoder	withIssuer(String issuer)	Sets the token issuer.
JwtAuthorizationDecoder	withJwtToken(String token)	Sets the JWT token String that should be validated and decoded.
JwtAuthorizationDecoder	withSigningAlgorithm(com.auth0.jwt.algorithms.Algorithm signingAlgorithm)	Sets the signing algorithm for the token.
JwtAuthorizationDecoder	withSubject(String subject)	Sets the token subject.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

JwtAuthorizationDecoder

public JwtAuthorizationDecoder()

JwtAuthorizationDecoder

public JwtAuthorizationDecoder(String jwtToken)

Method Details

withSubject

public JwtAuthorizationDecoder withSubject(String subject)

Description copied from interface: JwtAuthorizationBuilder

Sets the token subject.

Specified by:

withSubject in interface JwtAuthorizationBuilder<JwtAuthorizationDecoder,com.auth0.jwt.algorithms.Algorithm,com.auth0.jwt.interfaces.DecodedJWT>

Parameters:

subject - - the subject String

Returns:

the builder instance

withIssuer

public JwtAuthorizationDecoder withIssuer(String issuer)

Description copied from interface: JwtAuthorizationBuilder

Sets the token issuer.

Specified by:

withIssuer in interface JwtAuthorizationBuilder<JwtAuthorizationDecoder,com.auth0.jwt.algorithms.Algorithm,com.auth0.jwt.interfaces.DecodedJWT>

Parameters:

issuer - - the issuer String

Returns:

the builder instance

withAudience

public JwtAuthorizationDecoder withAudience(String audience)

Description copied from interface: JwtAuthorizationBuilder

Sets the token audience.

Specified by:

withAudience in interface JwtAuthorizationBuilder<JwtAuthorizationDecoder,com.auth0.jwt.algorithms.Algorithm,com.auth0.jwt.interfaces.DecodedJWT>

Parameters:

audience - - the audience String

Returns:

the builder instance

withSigningAlgorithm

public JwtAuthorizationDecoder withSigningAlgorithm(com.auth0.jwt.algorithms.Algorithm signingAlgorithm)

Description copied from interface: JwtAuthorizationBuilder

Sets the signing algorithm for the token. The algorithm may depend on the token library.

Specified by:

withSigningAlgorithm in interface JwtAuthorizationBuilder<JwtAuthorizationDecoder,com.auth0.jwt.algorithms.Algorithm,com.auth0.jwt.interfaces.DecodedJWT>

Parameters:

signingAlgorithm - - the signing algorithm instance

Returns:

the builder instance

build

public com.auth0.jwt.interfaces.DecodedJWT build()

Validates the signature and decodes a provided JWT token. It is also possible to pass the names of the claims that are expected to be contained in the token.

Specified by:

build in interface JwtAuthorizationBuilder<JwtAuthorizationDecoder,com.auth0.jwt.algorithms.Algorithm,com.auth0.jwt.interfaces.DecodedJWT>

Returns:

a decoded JWT token

decode

public Map<String,Object> decode()

Description copied from interface: AuthorizationDecoder

Returns an instance of containing the user's authorizations.

Specified by:

decode in interface AuthorizationDecoder<Map<String,Object>>

withClaim

public JwtAuthorizationDecoder withClaim(String claimName)

Sets the name of a JWT token claim expected to be part of the token. This method can be called multiple times. The token will be validated agains all the added claims.

Parameters:

claimName - - the name of the claim

Returns:

the builder instance

withJwtToken

public JwtAuthorizationDecoder withJwtToken(String token)

Sets the JWT token String that should be validated and decoded.

Parameters:

token - - the JWT token String

Returns:

the builder instance