com.sap.cloud.security.test

Class JwtGenerator

java.lang.Object

com.sap.cloud.security.test.JwtGenerator

public class JwtGenerator
extends Object

Jwt Token builder class to generate tokes for testing purposes.

Field Summary

Fields

Modifier and Type	Field and Description
static java.time.Instant	NO_EXPIRE_DATE

Method Summary

Modifier and Type	Method and Description
Token	createToken() Builds and signs the token using the the algorithm set via withSignatureAlgorithm(JwtSignatureAlgorithm) and the given key.
static JwtGenerator	getInstance(Service service, String clientId)
JwtGenerator	withAppId(String appId) This method does not actually set data on the token itself but sets the appId that is used by withLocalScopes(String...) to create the local scopes.
JwtGenerator	withClaimsFromFile(String claimsJsonResource) This method will fill the token with all the claims that are defined inside the given file.
JwtGenerator	withClaimValue(String claimName, JsonObject object) Sets the claim with the given name to the given string value.
JwtGenerator	withClaimValue(String claimName, String value) Sets the claim with the given name to the given string value.
JwtGenerator	withClaimValues(String claimName, String... values) Sets the claim with the given name to the given string values.
JwtGenerator	withExpiration(java.time.Instant expiration) Sets the expiration claim (exp) of the token to the given moment in time.
JwtGenerator	withHeaderParameter(String parameterName, String value) Sets the header parameter with the given name to the given string value.
JwtGenerator	withLocalScopes(String... scopes) Works like withScopes(String...)} but prefixes the scopes with "appId.".
JwtGenerator	withPrivateKey(PrivateKey privateKey) Sets the private key that is used to sign the token.
JwtGenerator	withScopes(String... scopes) Sets the roles as claim "scope" to the jwt.
JwtGenerator	withSignatureAlgorithm(JwtSignatureAlgorithm signatureAlgorithm) Sets the signature algorithm that is used to create the signature of the token.

Methods inherited from class java.lang.Object

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

Field Detail

NO_EXPIRE_DATE

public static final java.time.Instant NO_EXPIRE_DATE

Method Detail

getInstance

public static JwtGenerator getInstance(Service service,
                                       String clientId)

withHeaderParameter

public JwtGenerator withHeaderParameter(String parameterName,
                                        String value)

Sets the header parameter with the given name to the given string value.

Parameters:

parameterName - the name of the header parameter to be set.

value - the string value of the header parameter to be set.

Returns:

the builder object.

withClaimValue

public JwtGenerator withClaimValue(String claimName,
                                   String value)

Sets the claim with the given name to the given string value.

Parameters:

claimName - the name of the claim to be set.

value - the string value of the claim to be set.

Returns:

the builder object.

withClaimValue

public JwtGenerator withClaimValue(String claimName,
                                   JsonObject object)

Sets the claim with the given name to the given string value.

Parameters:

claimName - the name of the claim to be set.

object - the string value of the claim to be set.

Returns:

the builder object.

Throws:

JsonParsingException - if the given object does not contain valid json.

withClaimValues

public JwtGenerator withClaimValues(String claimName,
                                    String... values)

Sets the claim with the given name to the given string values.

Parameters:

claimName - the name of the claim to be set.

values - the string values of the claims to be set.

Returns:

the builder object.

withClaimsFromFile

public JwtGenerator withClaimsFromFile(String claimsJsonResource)
                                throws IOException

This method will fill the token with all the claims that are defined inside the given file. The file must contain a valid json object.

Parameters:

claimsJsonResource - the resource path to the file containing the claims in json format, e.g. "/claims.json"

Returns:

the builder object.

Throws:

JsonParsingException - if the file does not contain a valid json object.

IOException - when the file cannot be read or does not exist.

withExpiration

public JwtGenerator withExpiration(@Nonnull
                                   java.time.Instant expiration)

Sets the expiration claim (exp) of the token to the given moment in time.

Parameters:

expiration - the moment in time when the token will be expired.

Returns:

the builder object.

withSignatureAlgorithm

public JwtGenerator withSignatureAlgorithm(JwtSignatureAlgorithm signatureAlgorithm)

Sets the signature algorithm that is used to create the signature of the token.

Parameters:

signatureAlgorithm - the signature algorithm.

Returns:

the builder object.

withPrivateKey

public JwtGenerator withPrivateKey(PrivateKey privateKey)

Sets the private key that is used to sign the token.

Parameters:

privateKey - the private key.

Returns:

the builder object.

withScopes

public JwtGenerator withScopes(String... scopes)

Sets the roles as claim "scope" to the jwt. Consecutive calls of this method will overwrite the data that has previously been set. Calls of this method however do not overwrite the data set via withLocalScopes(String...)}. Note that this is specific to tokens of service type Service.XSUAA.

Parameters:

scopes - the scopes that should be part of the token

Returns:

the JwtGenerator itself

Throws:

IllegalArgumentException - if service is not Service.XSUAA

withLocalScopes

public JwtGenerator withLocalScopes(String... scopes)

Works like withScopes(String...)} but prefixes the scopes with "appId.". For example if the appId is "xsapp", the scope "Read" will be converted to "xsapp.Read". Make sure the appId has been set via withAppId(String) before calling this method. Consecutive calls of this method will overwrite the data that has previously been set. Calls of this method however do not overwrite the data set via withScopes(String...)}. Note that this is specific to tokens of service type Service.XSUAA.

Parameters:

scopes -

Returns:

the JwtGenerator itself

Throws:

IllegalStateException - if the appId has not been set via withAppId(String)

withAppId

public JwtGenerator withAppId(String appId)

This method does not actually set data on the token itself but sets the appId that is used by withLocalScopes(String...) to create the local scopes.

Parameters:

appId - the appId to be used for local scopes creation

Returns:

the JwtGenerator itself

createToken

public Token createToken()

Builds and signs the token using the the algorithm set via withSignatureAlgorithm(JwtSignatureAlgorithm) and the given key. By defaultJwtSignatureAlgorithm.RS256 is used.

Returns:

the token.