Index (42 REST Secure Spring Boot Starter 12.3.0 API)

A C D E F G H I L M N O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

AbstractRestAuthenticationSuccessHandler<T extends RegisteredUser> - Class in nl._42.restsecure.autoconfigure.authentication: Add an implementation of this class as @Bean to the ApplicationContext to be able to handle successful authentication.
AbstractRestAuthenticationSuccessHandler() - Constructor for class nl._42.restsecure.autoconfigure.authentication.AbstractRestAuthenticationSuccessHandler
AbstractUserDetailsService<T extends RegisteredUser> - Class in nl._42.restsecure.autoconfigure.authentication: Implement this abstract class to configure for local user authentication storage.
AbstractUserDetailsService() - Constructor for class nl._42.restsecure.autoconfigure.authentication.AbstractUserDetailsService
addArgumentResolvers(List<HandlerMethodArgumentResolver>) - Method in class nl._42.restsecure.autoconfigure.authentication.ArgumentResolverConfig
additionalAuthenticationChecks(UserDetails, UsernamePasswordAuthenticationToken) - Method in class nl._42.restsecure.autoconfigure.authentication.mfa.MfaAuthenticationProvider
afterPropertiesSet() - Method in class nl._42.restsecure.autoconfigure.authentication.mfa.MfaSetupRequiredFilter
ArgumentResolverConfig - Class in nl._42.restsecure.autoconfigure.authentication
ArgumentResolverConfig(UserResolver<RegisteredUser>) - Constructor for class nl._42.restsecure.autoconfigure.authentication.ArgumentResolverConfig
authenticate(HttpServletRequest, HttpServletResponse, RegisteredUser) - Method in class nl._42.restsecure.autoconfigure.authentication.AuthenticationController
AuthenticationAdapter - Class in nl._42.restsecure.autoconfigure.authentication: Authentication implementation that is based on a user object.
AuthenticationAdapter(RegisteredUser) - Constructor for class nl._42.restsecure.autoconfigure.authentication.AuthenticationAdapter: Create a new authentication based on a user.
AuthenticationController - Class in nl._42.restsecure.autoconfigure.authentication: This controller implements the default /authentication and /authentication/current endpoints.
AuthenticationController(AuthenticationResultProvider) - Constructor for class nl._42.restsecure.autoconfigure.authentication.AuthenticationController
authenticationManager(HttpSecurity) - Method in class nl._42.restsecure.autoconfigure.WebSecurityAutoConfig
AuthenticationResult - Interface in nl._42.restsecure.autoconfigure.authentication: Interface representing the json result object of the authentication endpoints.
authenticationResultProvider() - Method in class nl._42.restsecure.autoconfigure.WebSecurityAutoConfig: Adds an AuthenticationResultProvider to the ApplicationContext if no AuthenticationResultProvider bean is found already.
AuthenticationResultProvider<T extends RegisteredUser> - Interface in nl._42.restsecure.autoconfigure.authentication: Provide an implementation as Bean to the ApplicationContext to customize the returned JSON of the default authentication endpoints.

C

commence(HttpServletRequest, HttpServletResponse, AuthenticationException) - Method in class nl._42.restsecure.autoconfigure.errorhandling.RestAccessDeniedHandler: Handles authentication exception when trying to reach a restricted URL.
current(HttpServletRequest, HttpServletResponse, RegisteredUser) - Method in class nl._42.restsecure.autoconfigure.authentication.AuthenticationController
CurrentUser - Annotation Interface in nl._42.restsecure.autoconfigure.authentication: Use this annotation on a controller method parameter to resolve the current logged in user.
CurrentUserArgumentResolver - Class in nl._42.restsecure.autoconfigure.authentication
CurrentUserArgumentResolver(UserResolver<RegisteredUser>) - Constructor for class nl._42.restsecure.autoconfigure.authentication.CurrentUserArgumentResolver
customize(HttpSecurity) - Method in interface nl._42.restsecure.autoconfigure.HttpSecurityCustomizer
customize(AuthorizeHttpRequestsConfigurer.AuthorizationManagerRequestMatcherRegistry) - Method in interface nl._42.restsecure.autoconfigure.RequestAuthorizationCustomizer

D

DefaultAuthenticationResultProvider - Class in nl._42.restsecure.autoconfigure.authentication
DefaultAuthenticationResultProvider() - Constructor for class nl._42.restsecure.autoconfigure.authentication.DefaultAuthenticationResultProvider
DefaultLoginAuthenticationExceptionHandler - Class in nl._42.restsecure.autoconfigure.errorhandling
DefaultLoginAuthenticationExceptionHandler() - Constructor for class nl._42.restsecure.autoconfigure.errorhandling.DefaultLoginAuthenticationExceptionHandler
DefaultUserProvider - Class in nl._42.restsecure.autoconfigure.authentication
DefaultUserProvider() - Constructor for class nl._42.restsecure.autoconfigure.authentication.DefaultUserProvider
DETAILS_MFA_SETUP_REQUIRED - Static variable in class nl._42.restsecure.autoconfigure.authentication.mfa.MfaAuthenticationProvider
doAfterPropertiesSet() - Method in class nl._42.restsecure.autoconfigure.authentication.mfa.MfaAuthenticationProvider
doFilter(ServletRequest, ServletResponse, FilterChain) - Method in class nl._42.restsecure.autoconfigure.authentication.mfa.MfaSetupRequiredFilter
doFilterInternal(HttpServletRequest, HttpServletResponse, FilterChain) - Method in class nl._42.restsecure.autoconfigure.RestAuthenticationFilter
doHandle(HttpServletRequest, HttpServletResponse, T) - Method in class nl._42.restsecure.autoconfigure.authentication.AbstractRestAuthenticationSuccessHandler

E

equals(Object) - Method in record class nl._42.restsecure.autoconfigure.authentication.UserDetailsAdapter: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class nl._42.restsecure.autoconfigure.form.FormValues: Indicates whether some other object is "equal to" this one.

F

filterChain(HttpSecurity, LoginAuthenticationExceptionHandler, AuthenticationManager) - Method in class nl._42.restsecure.autoconfigure.WebSecurityAutoConfig
findUserByUsername(String) - Method in class nl._42.restsecure.autoconfigure.authentication.AbstractUserDetailsService
form() - Method in record class nl._42.restsecure.autoconfigure.form.FormValues: Returns the value of the form record component.
formJson() - Method in record class nl._42.restsecure.autoconfigure.form.FormValues: Returns the value of the formJson record component.
FormUtil - Class in nl._42.restsecure.autoconfigure.utils
FormValues<F extends LoginForm> - Record Class in nl._42.restsecure.autoconfigure.form
FormValues(String, F) - Constructor for record class nl._42.restsecure.autoconfigure.form.FormValues: Creates an instance of a FormValues record class.

G

generateQrCode(String, String) - Method in interface nl._42.restsecure.autoconfigure.authentication.mfa.MfaSetupService
generateQrCode(String, String) - Method in class nl._42.restsecure.autoconfigure.authentication.mfa.MfaSetupServiceImpl: Generates a new MFA QR code
generateSecret() - Method in interface nl._42.restsecure.autoconfigure.authentication.mfa.MfaSetupService
generateSecret() - Method in class nl._42.restsecure.autoconfigure.authentication.mfa.MfaSetupServiceImpl: Generates a new MFA secret The secret is to be stored in a secure way for the given user.
GenericErrorHandler - Class in nl._42.restsecure.autoconfigure.errorhandling: REST errorhandler that sets given http status and writes given errorCode as custom property in the RFC-7078 json object to the http response.
GenericErrorHandler(ObjectMapper) - Constructor for class nl._42.restsecure.autoconfigure.errorhandling.GenericErrorHandler
getAuthorities() - Method in interface nl._42.restsecure.autoconfigure.authentication.AuthenticationResult
getAuthorities() - Method in interface nl._42.restsecure.autoconfigure.authentication.RegisteredUser
getAuthorities() - Method in record class nl._42.restsecure.autoconfigure.authentication.UserDetailsAdapter
getFormFromRequest(HttpServletRequest, Class<T>) - Static method in class nl._42.restsecure.autoconfigure.utils.FormUtil
getMfaSecretKey() - Method in interface nl._42.restsecure.autoconfigure.authentication.RegisteredUser
getPassword() - Method in interface nl._42.restsecure.autoconfigure.authentication.RegisteredUser
getPassword() - Method in record class nl._42.restsecure.autoconfigure.authentication.UserDetailsAdapter
getUsername() - Method in interface nl._42.restsecure.autoconfigure.authentication.AuthenticationResult
getUsername() - Method in interface nl._42.restsecure.autoconfigure.authentication.RegisteredUser
getUsername() - Method in record class nl._42.restsecure.autoconfigure.authentication.UserDetailsAdapter
getVerificationCode() - Method in class nl._42.restsecure.autoconfigure.authentication.mfa.MfaAuthenticationToken

H

handle(HttpServletRequest, HttpServletResponse, AccessDeniedException) - Method in class nl._42.restsecure.autoconfigure.errorhandling.RestAccessDeniedHandler: Handles URL authority matching failures.
handle(HttpServletRequest, HttpServletResponse, AuthenticationException) - Method in class nl._42.restsecure.autoconfigure.errorhandling.DefaultLoginAuthenticationExceptionHandler
handle(HttpServletRequest, HttpServletResponse, AuthenticationException) - Method in interface nl._42.restsecure.autoconfigure.errorhandling.LoginAuthenticationExceptionHandler
handlesAccessDeniedException(AccessDeniedException) - Method in class nl._42.restsecure.autoconfigure.errorhandling.WebMvcErrorHandler
hashCode() - Method in record class nl._42.restsecure.autoconfigure.authentication.UserDetailsAdapter: Returns a hash code value for this object.
hashCode() - Method in record class nl._42.restsecure.autoconfigure.form.FormValues: Returns a hash code value for this object.
HttpSecurityCustomizer - Interface in nl._42.restsecure.autoconfigure: Implement this interface and add it to the ApplicationContext to be able to customize the HttpSecurity object.

I

isAccountExpired() - Method in interface nl._42.restsecure.autoconfigure.authentication.RegisteredUser
isAccountLocked() - Method in interface nl._42.restsecure.autoconfigure.authentication.RegisteredUser
isAccountNonExpired() - Method in record class nl._42.restsecure.autoconfigure.authentication.UserDetailsAdapter
isAccountNonLocked() - Method in record class nl._42.restsecure.autoconfigure.authentication.UserDetailsAdapter
isCredentialsExpired() - Method in interface nl._42.restsecure.autoconfigure.authentication.RegisteredUser
isCredentialsNonExpired() - Method in record class nl._42.restsecure.autoconfigure.authentication.UserDetailsAdapter
isEnabled() - Method in interface nl._42.restsecure.autoconfigure.authentication.RegisteredUser
isEnabled() - Method in record class nl._42.restsecure.autoconfigure.authentication.UserDetailsAdapter
isMfaConfigured() - Method in interface nl._42.restsecure.autoconfigure.authentication.RegisteredUser
isMfaConfigured() - Method in record class nl._42.restsecure.autoconfigure.authentication.UserDetailsAdapter
isMfaMandatory() - Method in interface nl._42.restsecure.autoconfigure.authentication.RegisteredUser
isMfaMandatory() - Method in record class nl._42.restsecure.autoconfigure.authentication.UserDetailsAdapter

L

loadUserByUsername(String) - Method in class nl._42.restsecure.autoconfigure.authentication.AbstractUserDetailsService
logAuthenticationFailure(Logger, T, RuntimeException) - Static method in class nl._42.restsecure.autoconfigure.errorhandling.LogUtil
LOGIN_FORM_JSON - Static variable in class nl._42.restsecure.autoconfigure.RestAuthenticationFilter
LoginAuthenticationExceptionHandler - Interface in nl._42.restsecure.autoconfigure.errorhandling
loginExceptionHandler(GenericErrorHandler) - Method in class nl._42.restsecure.autoconfigure.WebSecurityAutoConfig
LoginForm - Class in nl._42.restsecure.autoconfigure.form
LoginForm() - Constructor for class nl._42.restsecure.autoconfigure.form.LoginForm
LogUtil - Class in nl._42.restsecure.autoconfigure.errorhandling

M

MfaAuthenticationProvider - Class in nl._42.restsecure.autoconfigure.authentication.mfa: An DaoAuthenticationProvider that supports Multi-Factor authentication (MFA, 2FA) using Time-based One-Time-Password (TOTP).
MfaAuthenticationProvider() - Constructor for class nl._42.restsecure.autoconfigure.authentication.mfa.MfaAuthenticationProvider
MfaAuthenticationToken - Class in nl._42.restsecure.autoconfigure.authentication.mfa: An UsernamePasswordAuthenticationToken that also accepts a verification code (e.g. from an authenticator app).
MfaAuthenticationToken(Object, Object, String) - Constructor for class nl._42.restsecure.autoconfigure.authentication.mfa.MfaAuthenticationToken
MfaException - Exception in nl._42.restsecure.autoconfigure.authentication.mfa
MfaException(String, Exception) - Constructor for exception nl._42.restsecure.autoconfigure.authentication.mfa.MfaException
MfaSecurityAutoConfig - Class in nl._42.restsecure.autoconfigure: Auto-configures beans for MFA validation and configuration.
MfaSecurityAutoConfig() - Constructor for class nl._42.restsecure.autoconfigure.MfaSecurityAutoConfig
MfaSetupRequiredFilter - Class in nl._42.restsecure.autoconfigure.authentication.mfa: A GenericFilterBean that denies requests when the user is obliged to set up MFA but hasn't done so.
MfaSetupRequiredFilter() - Constructor for class nl._42.restsecure.autoconfigure.authentication.mfa.MfaSetupRequiredFilter
mfaSetupService(SecretGenerator, QrDataFactory, QrGenerator, String) - Method in class nl._42.restsecure.autoconfigure.MfaSecurityAutoConfig
MfaSetupService - Interface in nl._42.restsecure.autoconfigure.authentication.mfa
MfaSetupServiceImpl - Class in nl._42.restsecure.autoconfigure.authentication.mfa: Service which contains logic to set up MFA authentication
MfaSetupServiceImpl(SecretGenerator, QrDataFactory, QrGenerator, String) - Constructor for class nl._42.restsecure.autoconfigure.authentication.mfa.MfaSetupServiceImpl
MfaTotpVerificationCheck - Class in nl._42.restsecure.autoconfigure.authentication.mfa
MfaTotpVerificationCheck(MfaValidationService) - Constructor for class nl._42.restsecure.autoconfigure.authentication.mfa.MfaTotpVerificationCheck
mfaValidationService(CodeVerifier) - Method in class nl._42.restsecure.autoconfigure.MfaSecurityAutoConfig
MfaValidationService - Interface in nl._42.restsecure.autoconfigure.authentication.mfa
MfaValidationServiceImpl - Class in nl._42.restsecure.autoconfigure.authentication.mfa: Service which contains logic to validate MFA tokens.
MfaValidationServiceImpl(CodeVerifier) - Constructor for class nl._42.restsecure.autoconfigure.authentication.mfa.MfaValidationServiceImpl
MfaVerificationCheck - Interface in nl._42.restsecure.autoconfigure.authentication.mfa

N

nl._42.restsecure.autoconfigure - package nl._42.restsecure.autoconfigure
nl._42.restsecure.autoconfigure.authentication - package nl._42.restsecure.autoconfigure.authentication
nl._42.restsecure.autoconfigure.authentication.mfa - package nl._42.restsecure.autoconfigure.authentication.mfa
nl._42.restsecure.autoconfigure.errorhandling - package nl._42.restsecure.autoconfigure.errorhandling
nl._42.restsecure.autoconfigure.form - package nl._42.restsecure.autoconfigure.form
nl._42.restsecure.autoconfigure.utils - package nl._42.restsecure.autoconfigure.utils

O

onAuthenticationSuccess(HttpServletRequest, HttpServletResponse, Authentication) - Method in class nl._42.restsecure.autoconfigure.authentication.AbstractRestAuthenticationSuccessHandler

P

password - Variable in class nl._42.restsecure.autoconfigure.form.LoginForm
passwordEncoder() - Method in class nl._42.restsecure.autoconfigure.WebSecurityAutoConfig: Adds a BCryptPasswordEncoder to the ApplicationContext if no PasswordEncoder bean is found already.

R

RegisteredUser - Interface in nl._42.restsecure.autoconfigure.authentication: Let your custom user object implement this interface.
rememberMe - Variable in class nl._42.restsecure.autoconfigure.form.LoginForm
RequestAuthorizationCustomizer - Interface in nl._42.restsecure.autoconfigure: Implement this interface and add it as Bean to the ApplicationContext to customize the auto configured url registry.
required() - Element in annotation interface nl._42.restsecure.autoconfigure.authentication.CurrentUser: Is the current user required, or can the user also be null.
resolve() - Method in class nl._42.restsecure.autoconfigure.authentication.UserResolver
resolveArgument(MethodParameter, ModelAndViewContainer, NativeWebRequest, WebDataBinderFactory) - Method in class nl._42.restsecure.autoconfigure.authentication.CurrentUserArgumentResolver
respond(HttpServletResponse, HttpStatus, String) - Method in class nl._42.restsecure.autoconfigure.errorhandling.GenericErrorHandler
RestAccessDeniedHandler - Class in nl._42.restsecure.autoconfigure.errorhandling: Handles all authentication- and authorization exceptions that can occur in the http web environment.
RestAccessDeniedHandler(GenericErrorHandler) - Constructor for class nl._42.restsecure.autoconfigure.errorhandling.RestAccessDeniedHandler
RestAuthenticationFilter - Class in nl._42.restsecure.autoconfigure: Handles the login POST request.
RestAuthenticationFilter(LoginAuthenticationExceptionHandler, SecurityContextRepository, AuthenticationManager) - Constructor for class nl._42.restsecure.autoconfigure.RestAuthenticationFilter: Creates an authentication filter with a default Ant path matcher on POST /authentication and a default ObjectMapper.
RestAuthenticationFilter(LoginAuthenticationExceptionHandler, SecurityContextRepository, AuthenticationManager, RequestMatcher) - Constructor for class nl._42.restsecure.autoconfigure.RestAuthenticationFilter: Creates an authentication filter where you can specify the request matcher and ObjectMapper.

S

securityContextRepository() - Method in class nl._42.restsecure.autoconfigure.WebSecurityAutoConfig
SERVER_ACCESS_DENIED_ERROR - Static variable in class nl._42.restsecure.autoconfigure.errorhandling.RestAccessDeniedHandler
SERVER_AUTHENTICATE_ERROR - Static variable in class nl._42.restsecure.autoconfigure.errorhandling.RestAccessDeniedHandler
SERVER_LOGIN_FAILED_ERROR - Static variable in class nl._42.restsecure.autoconfigure.errorhandling.DefaultLoginAuthenticationExceptionHandler
SERVER_MFA_CODE_REQUIRED_ERROR - Static variable in class nl._42.restsecure.autoconfigure.authentication.mfa.MfaAuthenticationProvider
SERVER_SESSION_INVALID_ERROR - Static variable in class nl._42.restsecure.autoconfigure.errorhandling.RestAccessDeniedHandler
setAuthCustomizer(RequestAuthorizationCustomizer) - Method in class nl._42.restsecure.autoconfigure.WebSecurityAutoConfig
setAuthenticationSuccessHandler(AbstractRestAuthenticationSuccessHandler<?>) - Method in class nl._42.restsecure.autoconfigure.RestAuthenticationFilter
setAuthenticationSuccessHandler(AbstractRestAuthenticationSuccessHandler<? extends RegisteredUser>) - Method in class nl._42.restsecure.autoconfigure.WebSecurityAutoConfig
setAuthProviders(List<AuthenticationProvider>) - Method in class nl._42.restsecure.autoconfigure.WebSecurityAutoConfig
setHttpCustomizer(HttpSecurityCustomizer) - Method in class nl._42.restsecure.autoconfigure.WebSecurityAutoConfig
setMfaValidationService(MfaValidationService) - Method in class nl._42.restsecure.autoconfigure.authentication.mfa.MfaAuthenticationProvider
setRememberMeServices(RememberMeServices) - Method in class nl._42.restsecure.autoconfigure.RestAuthenticationFilter
setRememberMeServices(RememberMeServices) - Method in class nl._42.restsecure.autoconfigure.WebSecurityAutoConfig
setUserDetailsService(AbstractUserDetailsService<? extends RegisteredUser>) - Method in class nl._42.restsecure.autoconfigure.WebSecurityAutoConfig
setVerificationChecks(List<MfaVerificationCheck>) - Method in class nl._42.restsecure.autoconfigure.authentication.mfa.MfaAuthenticationProvider
supports(Class<?>) - Method in class nl._42.restsecure.autoconfigure.authentication.mfa.MfaAuthenticationProvider
supportsParameter(MethodParameter) - Method in class nl._42.restsecure.autoconfigure.authentication.CurrentUserArgumentResolver

T

toResult(HttpServletRequest, HttpServletResponse, RegisteredUser) - Method in class nl._42.restsecure.autoconfigure.authentication.DefaultAuthenticationResultProvider
toResult(HttpServletRequest, HttpServletResponse, T) - Method in interface nl._42.restsecure.autoconfigure.authentication.AuthenticationResultProvider: Translates the given RegisteredUser implementation to an AuthenticationResult.
toString() - Method in record class nl._42.restsecure.autoconfigure.authentication.UserDetailsAdapter: Returns a string representation of this record class.
toString() - Method in record class nl._42.restsecure.autoconfigure.form.FormValues: Returns a string representation of this record class.
toUser(Authentication) - Method in class nl._42.restsecure.autoconfigure.authentication.DefaultUserProvider
toUser(Authentication) - Method in interface nl._42.restsecure.autoconfigure.authentication.UserProvider

U

user() - Method in record class nl._42.restsecure.autoconfigure.authentication.UserDetailsAdapter: Returns the value of the user record component.
UserDetailsAdapter<T extends RegisteredUser> - Record Class in nl._42.restsecure.autoconfigure.authentication: Wraps the custom user object and will be available as principal on the Authentication in the SecurityContext.
UserDetailsAdapter(T) - Constructor for record class nl._42.restsecure.autoconfigure.authentication.UserDetailsAdapter: Creates an instance of a UserDetailsAdapter record class.
username - Variable in class nl._42.restsecure.autoconfigure.form.LoginForm
userProvider() - Method in class nl._42.restsecure.autoconfigure.WebSecurityAutoConfig: Adds an UserProvider to the ApplicationContext if no UserProvider bean is found already.
UserProvider - Interface in nl._42.restsecure.autoconfigure.authentication
UserResolver<T extends RegisteredUser> - Class in nl._42.restsecure.autoconfigure.authentication
UserResolver() - Constructor for class nl._42.restsecure.autoconfigure.authentication.UserResolver

V

validate(RegisteredUser, MfaAuthenticationToken) - Method in class nl._42.restsecure.autoconfigure.authentication.mfa.MfaTotpVerificationCheck
validate(RegisteredUser, MfaAuthenticationToken) - Method in interface nl._42.restsecure.autoconfigure.authentication.mfa.MfaVerificationCheck: Validates the MFA Authentication credentials for the given RegisteredUser.
verificationCode - Variable in class nl._42.restsecure.autoconfigure.form.LoginForm
verifyMfaCode(String, String) - Method in interface nl._42.restsecure.autoconfigure.authentication.mfa.MfaValidationService
verifyMfaCode(String, String) - Method in class nl._42.restsecure.autoconfigure.authentication.mfa.MfaValidationServiceImpl: Validates if the given MFA code is valid right now.

W

WebMvcErrorHandler - Class in nl._42.restsecure.autoconfigure.errorhandling: Default error handler that handles AccessDeniedException thrown when a method security check fails.
WebMvcErrorHandler() - Constructor for class nl._42.restsecure.autoconfigure.errorhandling.WebMvcErrorHandler
WebSecurityAutoConfig - Class in nl._42.restsecure.autoconfigure: Auto-configures Spring Web Security with a customized UserDetailsService for internal users storage or with crowd-integration-springsecurity for external crowd authentication.
WebSecurityAutoConfig(RestAccessDeniedHandler) - Constructor for class nl._42.restsecure.autoconfigure.WebSecurityAutoConfig
webSecurityCustomizer() - Method in class nl._42.restsecure.autoconfigure.WebSecurityAutoConfig

A C D E F G H I L M N O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form