Index
All Classes and Interfaces|All Packages|Serialized Form
A
- AccessControl - Annotation Interface in org.sklsft.commons.rest.security.annotations
-
Used to indicates a rest controller method : which
AccessControlTypemust be considered by theAccessControlAspectwhichTokenExtractionModeto be used to get the tokens - AccessControlAspect - Class in org.sklsft.commons.rest.security.aspect
-
The aspect responsible for controlling the access to a RESTFul API
TheAccessControlTypeis declared with theAccessControlAnnotation
The access control is delegated to the @{link AccessController} - AccessControlAspect(AccessController) - Constructor for class org.sklsft.commons.rest.security.aspect.AccessControlAspect
- AccessController - Class in org.sklsft.commons.rest.security.access
-
This class will : Extract the token with @{link TokenExtractor} Give a security context with the
SecurityContextProvider - AccessController(SecurityContextProvider, SecurityContextProvider, String, String) - Constructor for class org.sklsft.commons.rest.security.access.AccessController
- AccessControlType - Enum Class in org.sklsft.commons.rest.security.access
-
Different Access control types provided by annotation
AccessControlPUBLIC : no control should be done ANONYMOUS : the only secretKey will be checked PRIVATE : both secretKey and token will be checked - AesJsonTokenDecoder<T> - Class in org.sklsft.commons.rest.security.tokens.encoder.impl
-
imlementation of a
TokenEncoderthat uses anAesJsonObjectEncoder - AesJsonTokenDecoder(ObjectMapper, AesKeyAccessor, Class<T>) - Constructor for class org.sklsft.commons.rest.security.tokens.encoder.impl.AesJsonTokenDecoder
- AesJsonTokenEncoder<T> - Class in org.sklsft.commons.rest.security.tokens.encoder.impl
-
imlementation of a
TokenEncoderthat uses anAesJsonObjectEncoder - AesJsonTokenEncoder(ObjectMapper, AesKeyAccessor) - Constructor for class org.sklsft.commons.rest.security.tokens.encoder.impl.AesJsonTokenEncoder
- ANONYMOUS - Enum constant in enum class org.sklsft.commons.rest.security.access.AccessControlType
B
- BasicJwtBody - Class in org.sklsft.commons.rest.security.tokens.jwt
- BasicJwtBody() - Constructor for class org.sklsft.commons.rest.security.tokens.jwt.BasicJwtBody
- BasicRsaJsonWebToken - Class in org.sklsft.commons.rest.security.tokens.jwt
- BasicRsaJsonWebToken() - Constructor for class org.sklsft.commons.rest.security.tokens.jwt.BasicRsaJsonWebToken
- BasicRsaJsonWebToken(RsaJwtHeader, BasicJwtBody) - Constructor for class org.sklsft.commons.rest.security.tokens.jwt.BasicRsaJsonWebToken
- BasicRsaJwtDecoder - Class in org.sklsft.commons.rest.security.tokens.encoder.impl
- BasicRsaJwtDecoder(ObjectMapper) - Constructor for class org.sklsft.commons.rest.security.tokens.encoder.impl.BasicRsaJwtDecoder
- BasicRsaJwtEncoder - Class in org.sklsft.commons.rest.security.tokens.encoder.impl
- BasicRsaJwtEncoder(ObjectMapper, RsaSigner, String, String) - Constructor for class org.sklsft.commons.rest.security.tokens.encoder.impl.BasicRsaJwtEncoder
- BasicRsaJwtVerifier - Class in org.sklsft.commons.rest.security.tokens.verification.impl
- BasicRsaJwtVerifier(RsaSignatureVerifier) - Constructor for class org.sklsft.commons.rest.security.tokens.verification.impl.BasicRsaJwtVerifier
- BasicSecurityContextProvider<C> - Class in org.sklsft.commons.rest.security.context.impl
- BasicSecurityContextProvider() - Constructor for class org.sklsft.commons.rest.security.context.impl.BasicSecurityContextProvider
- bindContext(Object) - Static method in class org.sklsft.commons.rest.security.context.SecurityContextHolder
C
- ContextConflictException - Exception Class in org.sklsft.commons.rest.security.exception
-
This exception is thrown if you try to bind a security context if there is already one
- ContextConflictException(String) - Constructor for exception class org.sklsft.commons.rest.security.exception.ContextConflictException
- ContextConflictException(String, Throwable) - Constructor for exception class org.sklsft.commons.rest.security.exception.ContextConflictException
- COOKIE - Enum constant in enum class org.sklsft.commons.rest.security.tokens.extraction.TokenExtractionMode
- CryptedTokenDecoder<T> - Class in org.sklsft.commons.rest.security.tokens.encoder.impl
-
imlementation of a
TokenEncoderthat uses anObjectEncoder - CryptedTokenDecoder(ObjectEncoder, Class<T>) - Constructor for class org.sklsft.commons.rest.security.tokens.encoder.impl.CryptedTokenDecoder
- CryptedTokenEncoder<T> - Class in org.sklsft.commons.rest.security.tokens.encoder.impl
-
imlementation of a
TokenEncoderthat uses anObjectEncoder - CryptedTokenEncoder(ObjectEncoder) - Constructor for class org.sklsft.commons.rest.security.tokens.encoder.impl.CryptedTokenEncoder
D
- decode(String) - Method in class org.sklsft.commons.rest.security.tokens.encoder.impl.CryptedTokenDecoder
- decode(String) - Method in class org.sklsft.commons.rest.security.tokens.encoder.impl.JwtDecoder
- decode(String) - Method in interface org.sklsft.commons.rest.security.tokens.encoder.TokenDecoder
E
- encode(T) - Method in class org.sklsft.commons.rest.security.tokens.encoder.impl.CryptedTokenEncoder
- encode(T) - Method in class org.sklsft.commons.rest.security.tokens.encoder.impl.JwtEncoder
- encode(T) - Method in interface org.sklsft.commons.rest.security.tokens.encoder.TokenEncoder
- extractContext(JsonWebToken<H, B>) - Method in class org.sklsft.commons.rest.security.credentials.extractor.impl.FromJwtContextExtractor
- extractContext(T) - Method in interface org.sklsft.commons.rest.security.credentials.extractor.SecurityContextExtractor
- extractToken(String) - Method in class org.sklsft.commons.rest.security.tokens.extraction.impl.TokenFromCookieExtractor
- extractToken(String) - Method in class org.sklsft.commons.rest.security.tokens.extraction.impl.TokenFromHeaderExtractor
- extractToken(String) - Method in interface org.sklsft.commons.rest.security.tokens.extraction.TokenExtractor
F
- FromBasicJwtContextExtractor - Class in org.sklsft.commons.rest.security.credentials.extractor.impl
- FromBasicJwtContextExtractor() - Constructor for class org.sklsft.commons.rest.security.credentials.extractor.impl.FromBasicJwtContextExtractor
- FromBasicRsaJwtSecurityContextProvider - Class in org.sklsft.commons.rest.security.context.impl
- FromBasicRsaJwtSecurityContextProvider(BasicRsaJwtDecoder, BasicRsaJwtVerifier, SecurityContextValidator<BasicJwtBody>) - Constructor for class org.sklsft.commons.rest.security.context.impl.FromBasicRsaJwtSecurityContextProvider
- FromCryptedTokenSecurityContextProvider<T> - Class in org.sklsft.commons.rest.security.context.impl
- FromCryptedTokenSecurityContextProvider(TokenDecoder<T>, SecurityContextValidator<T>) - Constructor for class org.sklsft.commons.rest.security.context.impl.FromCryptedTokenSecurityContextProvider
- FromJwtContextExtractor<H,
B> - Class in org.sklsft.commons.rest.security.credentials.extractor.impl - FromJwtContextExtractor() - Constructor for class org.sklsft.commons.rest.security.credentials.extractor.impl.FromJwtContextExtractor
- FromJwtSecurityContextProvider<T,
H, - Class in org.sklsft.commons.rest.security.context.implB> - FromJwtSecurityContextProvider(JwtDecoder<T, H, B>, TokenVerifier<JsonWebToken<H, B>>, SecurityContextValidator<B>) - Constructor for class org.sklsft.commons.rest.security.context.impl.FromJwtSecurityContextProvider
- FromKeySecurityContextProvider<C> - Class in org.sklsft.commons.rest.security.context.impl
- FromKeySecurityContextProvider(SecurityContextValidator<C>) - Constructor for class org.sklsft.commons.rest.security.context.impl.FromKeySecurityContextProvider
- FromSignedTokenSecurityContextProvider<T,
C> - Class in org.sklsft.commons.rest.security.context.impl -
Implementation of
SecurityContextProviderbased on the use of : aSecurityContextHolderwhich is based onThreadLocalaTokenDecoderaTokenVerifieraSecurityContextExtractoraSecurityContextValidator - FromSignedTokenSecurityContextProvider(TokenDecoder<T>, TokenVerifier<T>, SecurityContextExtractor<T, C>, SecurityContextValidator<C>) - Constructor for class org.sklsft.commons.rest.security.context.impl.FromSignedTokenSecurityContextProvider
G
- get(String) - Method in class org.sklsft.commons.rest.security.context.impl.FromKeySecurityContextProvider
- getAlgorithm() - Method in class org.sklsft.commons.rest.security.tokens.jwt.JwtHeader
- getApplication() - Method in class org.sklsft.commons.rest.security.tokens.jwt.BasicJwtBody
- getBody() - Method in class org.sklsft.commons.rest.security.tokens.jwt.JsonWebToken
- getContext() - Static method in class org.sklsft.commons.rest.security.context.SecurityContextHolder
- getContextOrNull() - Static method in class org.sklsft.commons.rest.security.context.SecurityContextHolder
- getExpiryDate() - Method in class org.sklsft.commons.rest.security.tokens.jwt.BasicJwtBody
- getHeader() - Method in class org.sklsft.commons.rest.security.tokens.jwt.JsonWebToken
- getPayload() - Method in class org.sklsft.commons.rest.security.tokens.jwt.JsonWebToken
- getPublicKeyId() - Method in class org.sklsft.commons.rest.security.tokens.jwt.JwtHeader
- getSignature() - Method in class org.sklsft.commons.rest.security.tokens.jwt.JsonWebToken
- getTokenExtractor(TokenExtractionMode) - Static method in class org.sklsft.commons.rest.security.tokens.extraction.impl.TokenExtractorFactory
- getType() - Method in class org.sklsft.commons.rest.security.tokens.jwt.JwtHeader
- getUser() - Method in class org.sklsft.commons.rest.security.tokens.jwt.BasicJwtBody
- getValidContext(String) - Method in class org.sklsft.commons.rest.security.context.impl.BasicSecurityContextProvider
- getValidContext(String) - Method in class org.sklsft.commons.rest.security.context.impl.FromCryptedTokenSecurityContextProvider
- getValidContext(String) - Method in class org.sklsft.commons.rest.security.context.impl.FromKeySecurityContextProvider
- getValidContext(String) - Method in class org.sklsft.commons.rest.security.context.impl.FromSignedTokenSecurityContextProvider
H
- handleHandshake(ProceedingJoinPoint) - Method in class org.sklsft.commons.rest.security.aspect.AccessControlAspect
- handshake(AccessControlType, TokenExtractionMode) - Method in class org.sklsft.commons.rest.security.access.AccessController
- HEADER - Enum constant in enum class org.sklsft.commons.rest.security.tokens.extraction.TokenExtractionMode
I
- InvalidTokenException - Exception Class in org.sklsft.commons.rest.security.exception
-
Thrown if your token does not enable to retrieve valid credentials
- InvalidTokenException(String) - Constructor for exception class org.sklsft.commons.rest.security.exception.InvalidTokenException
- InvalidTokenException(String, Throwable) - Constructor for exception class org.sklsft.commons.rest.security.exception.InvalidTokenException
J
- JsonWebToken<H,
B> - Class in org.sklsft.commons.rest.security.tokens.jwt - JsonWebToken() - Constructor for class org.sklsft.commons.rest.security.tokens.jwt.JsonWebToken
- JsonWebToken(H, B) - Constructor for class org.sklsft.commons.rest.security.tokens.jwt.JsonWebToken
- JwtDecoder<T,
H, - Class in org.sklsft.commons.rest.security.tokens.encoder.implB> - JwtDecoder(ObjectMapper, Class<T>, Class<H>, Class<B>) - Constructor for class org.sklsft.commons.rest.security.tokens.encoder.impl.JwtDecoder
- JwtEncoder<T> - Class in org.sklsft.commons.rest.security.tokens.encoder.impl
- JwtEncoder(ObjectMapper) - Constructor for class org.sklsft.commons.rest.security.tokens.encoder.impl.JwtEncoder
- JwtHeader - Class in org.sklsft.commons.rest.security.tokens.jwt
- JwtHeader() - Constructor for class org.sklsft.commons.rest.security.tokens.jwt.JwtHeader
N
- NoBoundContextException - Exception Class in org.sklsft.commons.rest.security.exception
-
If you try to access a security context and there is no one
- NoBoundContextException(String) - Constructor for exception class org.sklsft.commons.rest.security.exception.NoBoundContextException
- NoBoundContextException(String, Throwable) - Constructor for exception class org.sklsft.commons.rest.security.exception.NoBoundContextException
O
- org.sklsft.commons.rest.security.access - package org.sklsft.commons.rest.security.access
- org.sklsft.commons.rest.security.annotations - package org.sklsft.commons.rest.security.annotations
- org.sklsft.commons.rest.security.aspect - package org.sklsft.commons.rest.security.aspect
- org.sklsft.commons.rest.security.context - package org.sklsft.commons.rest.security.context
- org.sklsft.commons.rest.security.context.impl - package org.sklsft.commons.rest.security.context.impl
- org.sklsft.commons.rest.security.credentials.extractor - package org.sklsft.commons.rest.security.credentials.extractor
- org.sklsft.commons.rest.security.credentials.extractor.impl - package org.sklsft.commons.rest.security.credentials.extractor.impl
- org.sklsft.commons.rest.security.credentials.validator - package org.sklsft.commons.rest.security.credentials.validator
- org.sklsft.commons.rest.security.exception - package org.sklsft.commons.rest.security.exception
- org.sklsft.commons.rest.security.tokens.encoder - package org.sklsft.commons.rest.security.tokens.encoder
- org.sklsft.commons.rest.security.tokens.encoder.impl - package org.sklsft.commons.rest.security.tokens.encoder.impl
- org.sklsft.commons.rest.security.tokens.extraction - package org.sklsft.commons.rest.security.tokens.extraction
- org.sklsft.commons.rest.security.tokens.extraction.impl - package org.sklsft.commons.rest.security.tokens.extraction.impl
- org.sklsft.commons.rest.security.tokens.factory - package org.sklsft.commons.rest.security.tokens.factory
- org.sklsft.commons.rest.security.tokens.jwt - package org.sklsft.commons.rest.security.tokens.jwt
- org.sklsft.commons.rest.security.tokens.verification - package org.sklsft.commons.rest.security.tokens.verification
- org.sklsft.commons.rest.security.tokens.verification.impl - package org.sklsft.commons.rest.security.tokens.verification.impl
P
- PRIVATE - Enum constant in enum class org.sklsft.commons.rest.security.access.AccessControlType
- provideSecurityContext(String) - Method in class org.sklsft.commons.rest.security.context.impl.BasicSecurityContextProvider
- provideSecurityContext(String) - Method in interface org.sklsft.commons.rest.security.context.SecurityContextProvider
- PUBLIC - Enum constant in enum class org.sklsft.commons.rest.security.access.AccessControlType
R
- RsaJsonWebTokenFactory - Class in org.sklsft.commons.rest.security.tokens.factory
- RsaJsonWebTokenFactory() - Constructor for class org.sklsft.commons.rest.security.tokens.factory.RsaJsonWebTokenFactory
- RsaJwtHeader - Class in org.sklsft.commons.rest.security.tokens.jwt
- RsaJwtHeader() - Constructor for class org.sklsft.commons.rest.security.tokens.jwt.RsaJwtHeader
- RsaJwtHeader(RsaAlgorithms, String) - Constructor for class org.sklsft.commons.rest.security.tokens.jwt.RsaJwtHeader
- RsaJwtVerifier<H,
B> - Class in org.sklsft.commons.rest.security.tokens.verification.impl - RsaJwtVerifier(RsaSignatureVerifier) - Constructor for class org.sklsft.commons.rest.security.tokens.verification.impl.RsaJwtVerifier
S
- SecurityContextExtractor<T,
C> - Interface in org.sklsft.commons.rest.security.credentials.extractor -
Extracts context from the Token
- SecurityContextHolder - Class in org.sklsft.commons.rest.security.context
-
A security context is handled by a ThreadLocal
- SecurityContextHolder() - Constructor for class org.sklsft.commons.rest.security.context.SecurityContextHolder
- SecurityContextProvider - Interface in org.sklsft.commons.rest.security.context
-
Responsible for Providing a security context given a user token
- SecurityContextValidator<C> - Interface in org.sklsft.commons.rest.security.credentials.validator
-
Responsible for context validation.
- setAlgorithm(String) - Method in class org.sklsft.commons.rest.security.tokens.jwt.JwtHeader
- setApplication(String) - Method in class org.sklsft.commons.rest.security.tokens.jwt.BasicJwtBody
- setBody(B) - Method in class org.sklsft.commons.rest.security.tokens.jwt.JsonWebToken
- setExpiryDate(Date) - Method in class org.sklsft.commons.rest.security.tokens.jwt.BasicJwtBody
- setHeader(H) - Method in class org.sklsft.commons.rest.security.tokens.jwt.JsonWebToken
- setPayload(byte[]) - Method in class org.sklsft.commons.rest.security.tokens.jwt.JsonWebToken
- setPublicKeyId(String) - Method in class org.sklsft.commons.rest.security.tokens.jwt.JwtHeader
- setSignature(byte[]) - Method in class org.sklsft.commons.rest.security.tokens.jwt.JsonWebToken
- setType(String) - Method in class org.sklsft.commons.rest.security.tokens.jwt.JwtHeader
- setUser(String) - Method in class org.sklsft.commons.rest.security.tokens.jwt.BasicJwtBody
- sign(byte[]) - Method in class org.sklsft.commons.rest.security.tokens.encoder.impl.BasicRsaJwtEncoder
- sign(byte[]) - Method in class org.sklsft.commons.rest.security.tokens.encoder.impl.JwtEncoder
T
- TokenDecoder<T> - Interface in org.sklsft.commons.rest.security.tokens.encoder
-
used to decode a Token from a String
- TokenEncoder<T> - Interface in org.sklsft.commons.rest.security.tokens.encoder
-
used to encode a Token to a String
- TokenEncodingException - Exception Class in org.sklsft.commons.rest.security.exception
- TokenEncodingException(String) - Constructor for exception class org.sklsft.commons.rest.security.exception.TokenEncodingException
- TokenEncodingException(String, Throwable) - Constructor for exception class org.sklsft.commons.rest.security.exception.TokenEncodingException
- tokenExtractionMode() - Element in annotation interface org.sklsft.commons.rest.security.annotations.AccessControl
- TokenExtractionMode - Enum Class in org.sklsft.commons.rest.security.tokens.extraction
-
Different Token extraction modes provided by annotation
AccessControlHEADER : Token are passed through header (default mode) COOKIE : Token are given by cookies (useful for images to be displayed in html) - TokenExtractor - Interface in org.sklsft.commons.rest.security.tokens.extraction
-
To define an interface linked with a factory
TokenExtractorFactory - TokenExtractorFactory - Class in org.sklsft.commons.rest.security.tokens.extraction.impl
-
Chooses the correct tokens extractor depending on the
TokenExtractionMode - TokenExtractorFactory() - Constructor for class org.sklsft.commons.rest.security.tokens.extraction.impl.TokenExtractorFactory
- TokenFromCookieExtractor - Class in org.sklsft.commons.rest.security.tokens.extraction.impl
-
To extract tokens from Servlet request cookies
- TokenFromCookieExtractor(TokenFromHeaderExtractor) - Constructor for class org.sklsft.commons.rest.security.tokens.extraction.impl.TokenFromCookieExtractor
- TokenFromHeaderExtractor - Class in org.sklsft.commons.rest.security.tokens.extraction.impl
-
To extract tokens from Servlet request headers
- TokenFromHeaderExtractor() - Constructor for class org.sklsft.commons.rest.security.tokens.extraction.impl.TokenFromHeaderExtractor
- TokenNotFoundException - Exception Class in org.sklsft.commons.rest.security.exception
-
Thrown if your token does not enable to retrieve valid credentials
- TokenNotFoundException(String) - Constructor for exception class org.sklsft.commons.rest.security.exception.TokenNotFoundException
- TokenNotFoundException(String, Throwable) - Constructor for exception class org.sklsft.commons.rest.security.exception.TokenNotFoundException
- TokenVerifier<T> - Interface in org.sklsft.commons.rest.security.tokens.verification
U
- unbindContext() - Static method in class org.sklsft.commons.rest.security.context.SecurityContextHolder
V
- validateContext(C) - Method in interface org.sklsft.commons.rest.security.credentials.validator.SecurityContextValidator
- value() - Element in annotation interface org.sklsft.commons.rest.security.annotations.AccessControl
- valueOf(String) - Static method in enum class org.sklsft.commons.rest.security.access.AccessControlType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.sklsft.commons.rest.security.tokens.extraction.TokenExtractionMode
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class org.sklsft.commons.rest.security.access.AccessControlType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.sklsft.commons.rest.security.tokens.extraction.TokenExtractionMode
-
Returns an array containing the constants of this enum class, in the order they are declared.
- verifyBody(B) - Method in class org.sklsft.commons.rest.security.tokens.verification.impl.RsaJwtVerifier
- verifyBody(BasicJwtBody) - Method in class org.sklsft.commons.rest.security.tokens.verification.impl.BasicRsaJwtVerifier
- verifyToken(JsonWebToken<H, B>) - Method in class org.sklsft.commons.rest.security.tokens.verification.impl.RsaJwtVerifier
- verifyToken(T) - Method in interface org.sklsft.commons.rest.security.tokens.verification.TokenVerifier
-
Should be used for JWT signature verification.
All Classes and Interfaces|All Packages|Serialized Form