com.hcl.domino.keep.security

Interface JwtManager

All Known Implementing Classes:

JwtManagerHolder

public interface JwtManager

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	JwtManager.JwtNotSetupException Manages our handling of JWT elements

Method Summary

Modifier and Type	Method and Description
io.vertx.core.Future<java.lang.String>	extractScopes(java.lang.String jwtToken) Extracts the Scope string a valid JWT Token might present,
default io.vertx.core.Future<java.util.Set<java.lang.String>>	extractScopeSet(java.lang.String jwtToken) Extracts the Scope as set a valid JWT Token might present,
io.vertx.core.Future<KeepUser>	extractUser(java.lang.String jwt) Extracts a Domino user with its information and permissions from a JWT Token.
default java.util.Optional<io.vertx.core.json.JsonObject>	extractUserUnverified(java.lang.String claim) Extracts the inherent claim in JWT Token without verifying the signature
io.vertx.ext.auth.jwt.JWTAuth	getAuthprovider()
default io.vertx.core.Future<io.vertx.core.json.JsonObject>	getTokenForUser(java.lang.String username, java.lang.String scopes)
java.util.Optional<io.vertx.core.json.JsonObject>	getTokenForUserSync(java.lang.String username, java.lang.String scopes)
default boolean	hasDecryptScope(java.lang.String claim) Checks if a user has the decrypt permission
io.vertx.core.Future<io.vertx.ext.auth.jwt.JWTAuth>	initializeAuthprovider(io.vertx.core.Vertx vertx, io.vertx.core.json.JsonObject config)
boolean	isAllowJwtMail()
void	setAuthProvider(io.vertx.ext.auth.jwt.JWTAuth newProvider) Replace the authentication provider, used for tests only
default long	timeToExpiry(java.lang.String claim)

Method Detail

extractScopes

io.vertx.core.Future<java.lang.String> extractScopes(java.lang.String jwtToken)

Extracts the Scope string a valid JWT Token might present,

Parameters:

jwtToken - The JWT Token

Returns:

the found claim or an empty String

extractScopeSet

default io.vertx.core.Future<java.util.Set<java.lang.String>> extractScopeSet(java.lang.String jwtToken)

Extracts the Scope as set a valid JWT Token might present,

Parameters:

jwtToken - The JWT Token

Returns:

the found claim or an empty String

extractUser

io.vertx.core.Future<KeepUser> extractUser(@Nonnull
                                           java.lang.String jwt)

Extracts a Domino user with its information and permissions from a JWT Token. Includes a lookup into the directory or eventually an ACL of an accessed database to get a full picture

Parameters:

jwt - the JWT Claim

Returns:

the KeepUser or a failure

extractUserUnverified

default java.util.Optional<io.vertx.core.json.JsonObject> extractUserUnverified(java.lang.String claim)

Extracts the inherent claim in JWT Token without verifying the signature

Parameters:

claim -

• jwt String

Returns:

Optional with a result

getAuthprovider

io.vertx.ext.auth.jwt.JWTAuth getAuthprovider()
                                       throws JwtManager.JwtNotSetupException

Returns:

the authentication provider if setup otherwise null

Throws:

JwtManager.JwtNotSetupException

getTokenForUser

default io.vertx.core.Future<io.vertx.core.json.JsonObject> getTokenForUser(java.lang.String username,
                                                                            java.lang.String scopes)

Parameters:

username -

scopes -

• scopes to access, null if default

Returns:

a Future with a qualified JWT Token in proper format or failed future

getTokenForUserSync

java.util.Optional<io.vertx.core.json.JsonObject> getTokenForUserSync(java.lang.String username,
                                                                      java.lang.String scopes)

Parameters:

username -

• Notes Name

scopes -

• scopes to access, null if default

Returns:

a qualified JWT Token or an empty Optional

hasDecryptScope

default boolean hasDecryptScope(java.lang.String claim)

Checks if a user has the decrypt permission

Parameters:

claim -

• encode JWT String

Returns:

true/false

initializeAuthprovider

io.vertx.core.Future<io.vertx.ext.auth.jwt.JWTAuth> initializeAuthprovider(io.vertx.core.Vertx vertx,
                                                                           io.vertx.core.json.JsonObject config)

Parameters:

vertx -

config -

Returns:

JWTAuth - a future with the auth provider

isAllowJwtMail

boolean isAllowJwtMail()

Returns:

Does the JWT Manager allow to extract the Mail info from JWT

setAuthProvider

void setAuthProvider(io.vertx.ext.auth.jwt.JWTAuth newProvider)

Replace the authentication provider, used for tests only

Parameters:

newProvider -

timeToExpiry

default long timeToExpiry(java.lang.String claim)

Parameters:

claim -

Returns:

Number of seconds a JWT claim has left in its life span or 1min if no expiration found