Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- AbstractAccessTokenCookieConfigurationProperties - Class in io.micronaut.security.token.cookie
-
Base class for cookie configuration properties classes.
- AbstractAccessTokenCookieConfigurationProperties() - Constructor for class io.micronaut.security.token.cookie.AbstractAccessTokenCookieConfigurationProperties
- AbstractOutgoingRequestProcessorMatcher - Class in io.micronaut.security.token.propagation
-
Base implementation class for
OutgoingRequestProcessorMatcher. - AbstractOutgoingRequestProcessorMatcher() - Constructor for class io.micronaut.security.token.propagation.AbstractOutgoingRequestProcessorMatcher
- AbstractPrincipalArgumentBinder<A extends Principal> - Class in io.micronaut.security.authentication
-
Binds the authentication object to a route argument.
- AbstractPrincipalArgumentBinder(Class<A>) - Constructor for class io.micronaut.security.authentication.AbstractPrincipalArgumentBinder
- AbstractSecurityRule<T> - Class in io.micronaut.security.rules
-
A base
SecurityRuleclass to extend from that provides helper methods to get the roles from the claims and compare them to the roles allowed by the rule. - AbstractSecurityRule(RolesFinder) - Constructor for class io.micronaut.security.rules.AbstractSecurityRule
- AbstractTokenAuthenticationFactory<T> - Class in io.micronaut.security.token
-
Abstract implementation of
TokenAuthenticationFactorywhich creates an authentication for a set of claims. - AbstractTokenAuthenticationFactory(TokenConfiguration, RolesFinder) - Constructor for class io.micronaut.security.token.AbstractTokenAuthenticationFactory
- ACCESS_DENIED - Enum constant in enum class io.micronaut.security.errors.ObtainingAuthorizationErrorCode
- AccessRefreshToken - Class in io.micronaut.security.token.render
-
Stores the combination of access and refresh tokens.
- AccessRefreshToken(String, String, String, Integer) - Constructor for class io.micronaut.security.token.render.AccessRefreshToken
- accessRefreshTokenGenerator - Variable in class io.micronaut.security.token.bearer.AccessRefreshTokenLoginHandler
- accessRefreshTokenGenerator - Variable in class io.micronaut.security.token.cookie.TokenCookieLoginHandler
- AccessRefreshTokenGenerator - Interface in io.micronaut.security.token.generator
-
Contract to generate
AccessRefreshTokenfor a particular user. - AccessRefreshTokenLoginHandler - Class in io.micronaut.security.token.bearer
-
Implementation of
LoginHandlerfor Token Based Authentication. - AccessRefreshTokenLoginHandler(AccessRefreshTokenGenerator) - Constructor for class io.micronaut.security.token.bearer.AccessRefreshTokenLoginHandler
- accessTokenConfiguration - Variable in class io.micronaut.security.token.cookie.TokenCookieLoginHandler
- accessTokenConfiguration - Variable in class io.micronaut.security.token.generator.DefaultAccessRefreshTokenGenerator
- AccessTokenConfiguration - Interface in io.micronaut.security.token.generator
-
Configuration for access tokens.
- AccessTokenConfigurationProperties - Class in io.micronaut.security.token.generator
-
Access token configuration.
- AccessTokenConfigurationProperties() - Constructor for class io.micronaut.security.token.generator.AccessTokenConfigurationProperties
- accessTokenCookieConfiguration - Variable in class io.micronaut.security.token.cookie.CookieLoginHandler
- accessTokenCookieConfiguration - Variable in class io.micronaut.security.token.cookie.CookieTokenReader
- accessTokenCookieConfiguration - Variable in class io.micronaut.security.token.cookie.TokenCookieClearerLogoutHandler
- accessTokenCookieConfiguration - Variable in class io.micronaut.security.token.cookie.TokenCookieTokenReader
- AccessTokenCookieConfiguration - Interface in io.micronaut.security.token.cookie
-
Configuration for the access token cookie.
- accessTokenExpiration(Authentication) - Method in class io.micronaut.security.token.generator.DefaultAccessRefreshTokenGenerator
- accessTokenExpiration(Map<String, ?>) - Method in class io.micronaut.security.token.generator.DefaultAccessRefreshTokenGenerator
- AccessTokenGeneratedEvent - Class in io.micronaut.security.token.event
-
Triggered when a JWT access token is generated.
- AccessTokenGeneratedEvent(Object) - Constructor for class io.micronaut.security.token.event.AccessTokenGeneratedEvent
-
Triggered when a JWT access token is generated.
- accessTokenGeneratedEventPublisher - Variable in class io.micronaut.security.token.generator.DefaultAccessRefreshTokenGenerator
- ACCOUNT_EXPIRED - Enum constant in enum class io.micronaut.security.authentication.AuthenticationFailureReason
-
Failure when the cause is the user account expired.
- ACCOUNT_LOCKED - Enum constant in enum class io.micronaut.security.authentication.AuthenticationFailureReason
-
Failure when the cause is the user account was locked.
- addExtension(String, Object) - Method in class io.micronaut.security.endpoints.introspection.IntrospectionResponse
- ALL - Enum constant in enum class io.micronaut.security.config.AuthenticationStrategy
-
All authentication providers must return a successful response for authentication to succeed.
- ALL_CLAIMS - Static variable in interface io.micronaut.security.token.Claims
- ALLOWED - Enum constant in enum class io.micronaut.security.rules.SecurityRuleResult
-
The rule explicitly allows this request.
- ANY - Enum constant in enum class io.micronaut.security.config.AuthenticationStrategy
-
At least one authentication provider must return a successful response for authentication to succeed.
- ANYWHERE - Static variable in class io.micronaut.security.config.SecurityConfigurationProperties
- applyCookies(MutableHttpResponse<?>, List<Cookie>) - Method in class io.micronaut.security.token.cookie.CookieLoginHandler
- argumentType() - Method in class io.micronaut.security.authentication.AbstractPrincipalArgumentBinder
- audience() - Method in interface io.micronaut.security.token.claims.ClaimsAudienceProvider
- AUDIENCE - Static variable in class io.micronaut.security.endpoints.introspection.DefaultIntrospectionProcessor
- AUDIENCE - Static variable in interface io.micronaut.security.token.Claims
- authenticate(T, AuthenticationRequest<?, ?>) - Method in interface io.micronaut.security.authentication.AuthenticationProvider
-
Authenticates a user with the given request.
- authenticate(T, AuthenticationRequest<?, ?>) - Method in class io.micronaut.security.authentication.Authenticator
-
Authenticates the user with the provided credentials.
- Authentication - Interface in io.micronaut.security.authentication
-
Represents the state of an authentication.
- AUTHENTICATION - Static variable in class io.micronaut.security.filters.SecurityFilter
-
The attribute used to store the authentication object in the request.
- AuthenticationArgumentBinder - Class in io.micronaut.security.authentication
-
Binds the authentication object to a route argument.
- AuthenticationArgumentBinder() - Constructor for class io.micronaut.security.authentication.AuthenticationArgumentBinder
- AuthenticationException - Exception in io.micronaut.security.authentication
-
A runtime exception thrown when authentication fails.
- AuthenticationException() - Constructor for exception io.micronaut.security.authentication.AuthenticationException
-
No message.
- AuthenticationException(AuthenticationResponse) - Constructor for exception io.micronaut.security.authentication.AuthenticationException
-
Sets the message based on the response.
- AuthenticationException(String) - Constructor for exception io.micronaut.security.authentication.AuthenticationException
- AuthenticationExceptionHandler - Class in io.micronaut.security.authentication
-
Handles the server response when an
AuthenticationExceptionis thrown. - AuthenticationExceptionHandler(ErrorResponseProcessor<?>) - Constructor for class io.micronaut.security.authentication.AuthenticationExceptionHandler
- AuthenticationFailed - Class in io.micronaut.security.authentication
-
Signalises an authentication failure and stores the failure reason.
- AuthenticationFailed() - Constructor for class io.micronaut.security.authentication.AuthenticationFailed
-
Necessary for JSON Serialization.
- AuthenticationFailed(AuthenticationFailureReason) - Constructor for class io.micronaut.security.authentication.AuthenticationFailed
- AuthenticationFailed(String) - Constructor for class io.micronaut.security.authentication.AuthenticationFailed
- AuthenticationFailureReason - Enum Class in io.micronaut.security.authentication
-
Enums describes the different authentication failures.
- AuthenticationFetcher<T> - Interface in io.micronaut.security.filters
-
Describes a bean which attempts to read an
Authenticationfrom an HTTP Request being executed. - authenticationFetchers - Variable in class io.micronaut.security.filters.SecurityFilter
- AuthenticationMode - Enum Class in io.micronaut.security.authentication
-
Different authentication strategies shipped with Micronaut Security.
- AuthenticationModeCondition - Class in io.micronaut.security.authentication
-
A condition that matches a supplied list of authentication modes.
- AuthenticationModeCondition(List<AuthenticationMode>) - Constructor for class io.micronaut.security.authentication.AuthenticationModeCondition
- AuthenticationModeConfiguration - Interface in io.micronaut.security.config
-
Defines the Authentication mode being used.
- AuthenticationProvider<T> - Interface in io.micronaut.security.authentication
-
Defines an authentication provider.
- authenticationProviders - Variable in class io.micronaut.security.authentication.Authenticator
- AuthenticationRequest<T,
S> - Interface in io.micronaut.security.authentication -
Represents a request to authenticate.
- AuthenticationResponse - Interface in io.micronaut.security.authentication
-
The response of an authentication attempt.
- AuthenticationStrategy - Enum Class in io.micronaut.security.config
-
Options for how to handle multiple authentication providers.
- authenticator - Variable in class io.micronaut.security.endpoints.LoginController
- Authenticator<T> - Class in io.micronaut.security.authentication
-
An Authenticator operates on several
AuthenticationProviderinstances returning the first authenticatedAuthenticationResponse. - Authenticator(Collection<AuthenticationProvider<T>>, SecurityConfiguration) - Constructor for class io.micronaut.security.authentication.Authenticator
- AuthorizationException - Exception in io.micronaut.security.authentication
-
Exception thrown when access to a protected resource is denied.
- AuthorizationException(Authentication) - Constructor for exception io.micronaut.security.authentication.AuthorizationException
B
- BasicAuthAuthenticationConfiguration - Class in io.micronaut.security.authentication
-
Configuration for basic authentication.
- BasicAuthAuthenticationConfiguration() - Constructor for class io.micronaut.security.authentication.BasicAuthAuthenticationConfiguration
- BasicAuthAuthenticationFetcher - Class in io.micronaut.security.authentication
-
An implementation of
AuthenticationFetcherthat decodes a username and password from the Authorization header and authenticates the credentials against anyAuthenticationProviders available. - BasicAuthAuthenticationFetcher(Authenticator<HttpRequest<?>>) - Constructor for class io.micronaut.security.authentication.BasicAuthAuthenticationFetcher
- BasicAuthUtils - Class in io.micronaut.security.authentication
-
Utility class for Basic Auth.
- beanContext - Variable in class io.micronaut.security.token.generator.DefaultAccessRefreshTokenGenerator
- BEARER - Enum constant in enum class io.micronaut.security.authentication.AuthenticationMode
- BearerAccessRefreshToken - Class in io.micronaut.security.token.render
-
Encapsulates an Access Token response as described in RFC 6749.
- BearerAccessRefreshToken(String, Collection<String>, Integer, String, String, String) - Constructor for class io.micronaut.security.token.render.BearerAccessRefreshToken
- bearerTokenConfiguration - Variable in class io.micronaut.security.token.bearer.BearerTokenReader
- BearerTokenConfiguration - Interface in io.micronaut.security.token.bearer
-
Configuration for the
BearerTokenReader. - BearerTokenConfigurationProperties - Class in io.micronaut.security.token.bearer
-
Default implementation of
BearerTokenConfiguration. - BearerTokenConfigurationProperties() - Constructor for class io.micronaut.security.token.bearer.BearerTokenConfigurationProperties
- BearerTokenReader - Class in io.micronaut.security.token.bearer
-
Reads JWT token from
HttpHeaders.AUTHORIZATIONheader. - BearerTokenReader(BearerTokenConfiguration) - Constructor for class io.micronaut.security.token.bearer.BearerTokenReader
- BearerTokenRenderer - Class in io.micronaut.security.token.render
- BearerTokenRenderer() - Constructor for class io.micronaut.security.token.render.BearerTokenRenderer
- bind(ArgumentConversionContext<A>, HttpRequest<?>) - Method in class io.micronaut.security.authentication.AbstractPrincipalArgumentBinder
- build(String) - Static method in interface io.micronaut.security.authentication.Authentication
-
Builds an
Authenticationinstance for the user. - build(String, Collection<String>) - Static method in interface io.micronaut.security.authentication.Authentication
-
Builds an
Authenticationinstance for the user. - build(String, Map<String, Object>) - Static method in interface io.micronaut.security.authentication.Authentication
-
Builds an
Authenticationinstance for the user. - build(String, Collection<String>, Map<String, Object>) - Static method in interface io.micronaut.security.authentication.Authentication
-
Builds an
Authenticationinstance for the user.
C
- check(HttpRequest<?>, Authentication, ExecutableMethod<?, ?>) - Method in class io.micronaut.security.rules.SensitiveEndpointRule
-
Evaluate the Endpoint's method.
- check(HttpRequest<?>, Authentication) - Method in class io.micronaut.security.rules.ConfigurationInterceptUrlMapRule
-
If no configured pattern matches the request, return
SecurityRuleResult.UNKNOWN. - check(HttpRequest<?>, Authentication) - Method in class io.micronaut.security.rules.IpPatternsRule
- check(HttpRequest<?>, Authentication) - Method in class io.micronaut.security.rules.SecuredAnnotationRule
-
Returns
SecurityRuleResult.UNKNOWNif theSecuredannotation is not found on the method or class, or if the route match is not method based. - check(HttpRequest<?>, Authentication) - Method in class io.micronaut.security.rules.SensitiveEndpointRule
- check(T, Authentication) - Method in interface io.micronaut.security.rules.SecurityRule
-
Returns a publisher that is required to emit a single security result based on any conditions.
- checkNotSensitive(HttpRequest<?>, Authentication, ExecutableMethod<?, ?>) - Method in class io.micronaut.security.rules.SensitiveEndpointRule
-
Evaluates a non sensitive endpoint.
- checkRules(HttpRequest<?>, ServerFilterChain, Authentication) - Method in class io.micronaut.security.filters.SecurityFilter
-
Check the security rules against the provided arguments.
- checkSensitiveAnonymous(HttpRequest<?>, ExecutableMethod<?, ?>) - Method in class io.micronaut.security.rules.SensitiveEndpointRule
-
Evaluates a sensitive endpoint for an anonymous user.
- checkSensitiveAuthenticated(HttpRequest<?>, Authentication, ExecutableMethod<?, ?>) - Method in class io.micronaut.security.rules.SensitiveEndpointRule
-
Evaluates a sensitive endpoint for an authenticated user.
- Claims - Interface in io.micronaut.security.token
-
Authentication claims.
- ClaimsAudienceProvider - Interface in io.micronaut.security.token.claims
-
Identifies the recipients that the JWT is intended for.
- claimsGenerator - Variable in class io.micronaut.security.token.generator.DefaultAccessRefreshTokenGenerator
- ClaimsGenerator - Interface in io.micronaut.security.token.claims
- CLIENT_ID - Static variable in class io.micronaut.security.endpoints.introspection.DefaultIntrospectionProcessor
- ClientAuthentication - Class in io.micronaut.security.authentication
-
An implementation of the Authentication interface intended to be used by clients that deserialize token information into an authentication.
- ClientAuthentication(String, Map<String, Object>) - Constructor for class io.micronaut.security.authentication.ClientAuthentication
- compareRoles(List<String>, Collection<String>) - Method in class io.micronaut.security.rules.AbstractSecurityRule
-
Compares the given roles to determine if the request is allowed by comparing if any of the granted roles is in the required roles list.
- configuration - Variable in class io.micronaut.security.token.propagation.HttpHeaderTokenPropagator
- ConfigurationInterceptUrlMapRule - Class in io.micronaut.security.rules
-
A security rule implementation backed by the
SecurityConfiguration.getInterceptUrlMap(). - ConfigurationInterceptUrlMapRule(RolesFinder, SecurityConfiguration, InterceptUrlPatternModifier) - Constructor for class io.micronaut.security.rules.ConfigurationInterceptUrlMapRule
- configure(Cookie, HttpRequest<?>) - Method in class io.micronaut.security.errors.CookiePriorToLoginPersistence
-
Configure the cookie.
- contains(String) - Method in interface io.micronaut.security.token.Claims
- contains(String) - Method in class io.micronaut.security.token.MapClaims
- ControllerConfiguration - Interface in io.micronaut.security.endpoints
-
Base configuration for all controllers.
- convert(Map<String, Object>, Class<InterceptUrlMapPattern>, ConversionContext) - Method in class io.micronaut.security.config.InterceptUrlMapConverter
- COOKIE - Enum constant in enum class io.micronaut.security.authentication.AuthenticationMode
- CookieBasedAuthenticationModeCondition - Class in io.micronaut.security.authentication
-
It evaluates to true if micronaut.security.authentication is set to idtoken or cookie.
- CookieBasedAuthenticationModeCondition() - Constructor for class io.micronaut.security.authentication.CookieBasedAuthenticationModeCondition
- cookieDomain - Variable in class io.micronaut.security.token.cookie.AbstractAccessTokenCookieConfigurationProperties
- cookieHttpOnly - Variable in class io.micronaut.security.token.cookie.AbstractAccessTokenCookieConfigurationProperties
- CookieLoginHandler - Class in io.micronaut.security.token.cookie
-
Abstract class which defines an implementation of
RedirectingLoginHandlerwhere a redirect response is issued. - CookieLoginHandler(AccessTokenCookieConfiguration, RedirectConfiguration, RedirectService, PriorToLoginPersistence) - Constructor for class io.micronaut.security.token.cookie.CookieLoginHandler
- cookieMaxAge - Variable in class io.micronaut.security.token.cookie.AbstractAccessTokenCookieConfigurationProperties
- CookiePriorToLoginPersistence - Class in io.micronaut.security.errors
-
Stores the last unauthorized URL in a cookie to redirect back to after logging in.
- CookiePriorToLoginPersistence(TokenCookieConfiguration) - Constructor for class io.micronaut.security.errors.CookiePriorToLoginPersistence
- cookieSameSite - Variable in class io.micronaut.security.token.cookie.AbstractAccessTokenCookieConfigurationProperties
- cookieSecure - Variable in class io.micronaut.security.token.cookie.AbstractAccessTokenCookieConfigurationProperties
- CookieTokenReader - Class in io.micronaut.security.token.cookie
-
Reads the token from the configured io.micronaut.security.token.jwt.cookie.
- CookieTokenReader(AccessTokenCookieConfiguration) - Constructor for class io.micronaut.security.token.cookie.CookieTokenReader
- createAuthentication(Map<String, Object>) - Method in class io.micronaut.security.token.AbstractTokenAuthenticationFactory
- createAuthentication(HttpRequest<?>) - Method in class io.micronaut.security.x509.X509AuthenticationFetcher
-
Creates an
X509Authenticationfrom information in anX509Certificateif one is present in the request. - createAuthentication(T) - Method in interface io.micronaut.security.token.TokenAuthenticationFactory
- createIntrospectionResponse(Authentication, T) - Method in class io.micronaut.security.endpoints.introspection.DefaultIntrospectionProcessor
-
Creates an
IntrospectionResponsefor anAuthentication. - createKey(Authentication) - Method in interface io.micronaut.security.token.generator.RefreshTokenGenerator
- createMessage(AuthenticationFailureReason) - Method in class io.micronaut.security.authentication.AuthenticationFailed
-
Generates a Title Case string for give authentication Failure.
- createRefreshResponse(HttpRequest<?>) - Method in class io.micronaut.security.token.cookie.CookieLoginHandler
- createSuccessResponse(HttpRequest<?>) - Method in class io.micronaut.security.token.cookie.CookieLoginHandler
- createX509Authentication(X509Certificate) - Method in class io.micronaut.security.x509.X509AuthenticationFetcher
-
Creates an
X509Authenticationfrom information in anX509Certificate. - CREDENTIALS_DO_NOT_MATCH - Enum constant in enum class io.micronaut.security.authentication.AuthenticationFailureReason
-
Failure when the cause is the credentials don't match.
- CUSTOM - Enum constant in enum class io.micronaut.security.authentication.AuthenticationFailureReason
-
An custom failure.
D
- debug(Logger, String, Object...) - Static method in class io.micronaut.security.utils.LoggingUtils
-
Logs a message at the DEBUG level (only if it's enabled) according to the specified format and arguments.
- DEFAULT_AUTHENTICATION_STRATEGY - Static variable in class io.micronaut.security.config.SecurityConfigurationProperties
-
The default enable value.
- DEFAULT_COOKIENAME - Static variable in class io.micronaut.security.token.cookie.RefreshTokenCookieConfigurationProperties
-
The default cookie name.
- DEFAULT_COOKIENAME - Static variable in class io.micronaut.security.token.cookie.TokenCookieConfigurationProperties
-
The default cookie name.
- DEFAULT_COOKIEPATH - Static variable in class io.micronaut.security.token.cookie.RefreshTokenCookieConfigurationProperties
-
Default Cookie Path.
- DEFAULT_COOKIEPATH - Static variable in class io.micronaut.security.token.cookie.TokenCookieConfigurationProperties
-
Default Cookie Path.
- DEFAULT_COOKIESAMESITE - Static variable in class io.micronaut.security.token.cookie.AbstractAccessTokenCookieConfigurationProperties
-
The default same-site setting for the JWT cookie.
- DEFAULT_ENABLED - Static variable in class io.micronaut.security.authentication.BasicAuthAuthenticationConfiguration
-
The default enable value.
- DEFAULT_ENABLED - Static variable in class io.micronaut.security.config.RedirectConfigurationProperties
-
The default enable value.
- DEFAULT_ENABLED - Static variable in class io.micronaut.security.config.RedirectConfigurationProperties.ForbiddenRedirectConfigurationProperties
-
The default enabled value for forbidden.
- DEFAULT_ENABLED - Static variable in class io.micronaut.security.config.RedirectConfigurationProperties.RefreshRedirectConfigurationProperties
-
The default enabled value for forbidden.
- DEFAULT_ENABLED - Static variable in class io.micronaut.security.config.RedirectConfigurationProperties.UnauthorizedRedirectConfigurationProperties
-
The default enabled value for unauthorized.
- DEFAULT_ENABLED - Static variable in class io.micronaut.security.config.SecurityConfigurationProperties
-
The default enable value.
- DEFAULT_ENABLED - Static variable in class io.micronaut.security.endpoints.introspection.IntrospectionConfigurationProperties
-
The default enable value.
- DEFAULT_ENABLED - Static variable in class io.micronaut.security.endpoints.LoginControllerConfigurationProperties
-
The default enable value.
- DEFAULT_ENABLED - Static variable in class io.micronaut.security.endpoints.LogoutControllerConfigurationProperties
-
The default enable value.
- DEFAULT_ENABLED - Static variable in class io.micronaut.security.endpoints.OauthControllerConfigurationProperties
-
The default enable value.
- DEFAULT_ENABLED - Static variable in class io.micronaut.security.filters.SecurityFilterConfigurationProperties
-
The default enable value.
- DEFAULT_ENABLED - Static variable in class io.micronaut.security.token.bearer.BearerTokenConfigurationProperties
- DEFAULT_ENABLED - Static variable in class io.micronaut.security.token.config.TokenConfigurationProperties
-
The default enable value.
- DEFAULT_ENABLED - Static variable in class io.micronaut.security.token.cookie.RefreshTokenCookieConfigurationProperties
-
The default enable value.
- DEFAULT_ENABLED - Static variable in class io.micronaut.security.token.cookie.TokenCookieConfigurationProperties
-
The default enable value.
- DEFAULT_ENABLED - Static variable in class io.micronaut.security.token.propagation.HttpHeaderTokenPropagatorConfigurationProperties
-
The default enable value.
- DEFAULT_ENABLED - Static variable in class io.micronaut.security.token.propagation.TokenPropagationConfigurationProperties
-
The default enable value.
- DEFAULT_ENABLED - Static variable in class io.micronaut.security.x509.X509ConfigurationProperties
-
The default enabled value.
- DEFAULT_EXPIRATION - Static variable in class io.micronaut.security.token.generator.AccessTokenConfigurationProperties
-
The default expiration.
- DEFAULT_FORBIDDEN - Static variable in class io.micronaut.security.config.RedirectConfigurationProperties.ForbiddenRedirectConfigurationProperties
-
The default forbidden rejection target URL.
- DEFAULT_GETALLOWED - Static variable in class io.micronaut.security.endpoints.LogoutControllerConfigurationProperties
-
Default Get Allowed.
- DEFAULT_GETALLOWED - Static variable in class io.micronaut.security.endpoints.OauthControllerConfigurationProperties
-
Default Get Allowed.
- DEFAULT_HTTPONLY - Static variable in class io.micronaut.security.token.cookie.AbstractAccessTokenCookieConfigurationProperties
-
The default http only value.
- DEFAULT_INTERCEPT_URL_MAP_PREPEND_PATTERN_WITH_CONTEXT_PATH - Static variable in class io.micronaut.security.config.SecurityConfigurationProperties
-
The default value whether intercept url patterns should be prepended with the context path.
- DEFAULT_LOGIN_FAILURE - Static variable in class io.micronaut.security.config.RedirectConfigurationProperties
-
The default login failure target URL.
- DEFAULT_LOGIN_SUCCESS - Static variable in class io.micronaut.security.config.RedirectConfigurationProperties
-
The default login success target URL.
- DEFAULT_LOGOUT_URL - Static variable in class io.micronaut.security.config.RedirectConfigurationProperties
-
The default logout URL.
- DEFAULT_NAME_KEY - Static variable in interface io.micronaut.security.token.config.TokenConfiguration
- DEFAULT_PATH - Static variable in class io.micronaut.security.endpoints.introspection.IntrospectionConfigurationProperties
-
The default path.
- DEFAULT_PATH - Static variable in class io.micronaut.security.endpoints.LoginControllerConfigurationProperties
-
The default path.
- DEFAULT_PATH - Static variable in class io.micronaut.security.endpoints.LogoutControllerConfigurationProperties
-
The default path.
- DEFAULT_PATH - Static variable in class io.micronaut.security.endpoints.OauthControllerConfigurationProperties
-
The default path.
- DEFAULT_PATH - Static variable in class io.micronaut.security.token.propagation.TokenPropagationConfigurationProperties
-
The default path.
- DEFAULT_PRIOR_TO_LOGIN - Static variable in class io.micronaut.security.config.RedirectConfigurationProperties
-
The default behavior of redirect to the uri prior to login.
- DEFAULT_REFRESH_URL - Static variable in class io.micronaut.security.config.RedirectConfigurationProperties.RefreshRedirectConfigurationProperties
-
The default forbidden rejection target URL.
- DEFAULT_REJECT_NOT_FOUND - Static variable in class io.micronaut.security.config.SecurityConfigurationProperties
-
The default reject-not-found value.
- DEFAULT_ROLES_NAME - Static variable in interface io.micronaut.security.token.config.TokenConfiguration
- DEFAULT_ROLES_SEPARATOR - Static variable in interface io.micronaut.security.token.config.TokenConfiguration
- DEFAULT_SUBJECT_DN_REGEX - Static variable in class io.micronaut.security.x509.X509ConfigurationProperties
-
The default Subject Distinguished Name (DN) regex.
- DEFAULT_UNAUTHORIZED - Static variable in class io.micronaut.security.config.RedirectConfigurationProperties.UnauthorizedRedirectConfigurationProperties
-
The default unauthorized rejection target URL.
- DefaultAccessRefreshTokenGenerator - Class in io.micronaut.security.token.generator
-
Generates http responses with access and refresh token.
- DefaultAccessRefreshTokenGenerator(AccessTokenConfiguration, TokenRenderer, TokenGenerator, BeanContext, RefreshTokenGenerator, ClaimsGenerator, ApplicationEventPublisher<RefreshTokenGeneratedEvent>, ApplicationEventPublisher<AccessTokenGeneratedEvent>) - Constructor for class io.micronaut.security.token.generator.DefaultAccessRefreshTokenGenerator
- DefaultAuthorizationExceptionHandler - Class in io.micronaut.security.authentication
-
Provides the default behavior for responding to an
AuthorizationException. - DefaultAuthorizationExceptionHandler(ErrorResponseProcessor<?>, RedirectConfiguration, RedirectService, PriorToLoginPersistence) - Constructor for class io.micronaut.security.authentication.DefaultAuthorizationExceptionHandler
- DefaultInterceptUrlPatternModifier - Class in io.micronaut.security.config
-
Decorates a InterceptUrlPattern}.
- DefaultInterceptUrlPatternModifier(SecurityConfiguration, ServerContextPathProvider) - Constructor for class io.micronaut.security.config.DefaultInterceptUrlPatternModifier
- DefaultIntrospectionProcessor<T> - Class in io.micronaut.security.endpoints.introspection
-
Validates the
IntrospectionRequest.getToken()with the availableTokenValidator. - DefaultIntrospectionProcessor(Collection<TokenValidator<T>>, TokenConfiguration, RefreshTokenValidator) - Constructor for class io.micronaut.security.endpoints.introspection.DefaultIntrospectionProcessor
- DefaultRedirectService - Class in io.micronaut.security.config
-
Get redirection URLs combining context path and redirect configuration.
- DefaultRedirectService(RedirectConfiguration, ServerContextPathProvider) - Constructor for class io.micronaut.security.config.DefaultRedirectService
- DefaultRolesFinder - Class in io.micronaut.security.token
-
Default implementation of
RolesFinder. - DefaultRolesFinder(TokenConfiguration) - Constructor for class io.micronaut.security.token.DefaultRolesFinder
-
Constructs a Roles Parser.
- DefaultSecurityService - Class in io.micronaut.security.utils
-
Default implementation of
SecurityService. - DefaultSecurityService(RolesFinder) - Constructor for class io.micronaut.security.utils.DefaultSecurityService
- DefaultTokenResolver - Class in io.micronaut.security.token.reader
-
Default implementation of
TokenResolver. - DefaultTokenResolver(Collection<TokenReader<HttpRequest<?>>>) - Constructor for class io.micronaut.security.token.reader.DefaultTokenResolver
-
Deprecated, for removal: This API element is subject to removal in a future version.
- DefaultTokenResolver(List<TokenReader<HttpRequest<?>>>) - Constructor for class io.micronaut.security.token.reader.DefaultTokenResolver
-
Instantiates a
DefaultTokenResolverwith a list of availableTokenReader. - DENY_ALL - Static variable in interface io.micronaut.security.rules.SecurityRule
-
The token to represent no security roles are allowed.
- doFilter(HttpRequest<?>, ServerFilterChain) - Method in class io.micronaut.security.filters.SecurityFilter
- doFilter(MutableHttpRequest<?>) - Method in class io.micronaut.security.token.propagation.TokenPropagationHttpClientFilter
E
- echo(Authentication, HttpRequest<?>) - Method in class io.micronaut.security.endpoints.introspection.IntrospectionController
- emptyIntrospectionResponse(String) - Method in class io.micronaut.security.endpoints.introspection.DefaultIntrospectionProcessor
-
Empty response for introspection response.
- endpointMethods - Variable in class io.micronaut.security.rules.SensitiveEndpointRule
-
A map where the key represents the method of an endpoint and the value represents the endpoints sensitivity.
- endpointName(ExecutableMethod<?, ?>) - Method in class io.micronaut.security.rules.SensitiveEndpointRule
- equals(Object) - Method in class io.micronaut.security.authentication.AuthenticationFailed
- equals(Object) - Method in class io.micronaut.security.authentication.UsernamePasswordCredentials
- ErrorCode - Interface in io.micronaut.security.errors
-
OAuth 2.0.
- ErrorResponse - Interface in io.micronaut.security.errors
-
OAuth 2.0 Error Response.
- exception() - Static method in interface io.micronaut.security.authentication.AuthenticationResponse
- exception(AuthenticationFailureReason) - Static method in interface io.micronaut.security.authentication.AuthenticationResponse
- exception(String) - Static method in interface io.micronaut.security.authentication.AuthenticationResponse
- EXP - Static variable in class io.micronaut.security.endpoints.introspection.DefaultIntrospectionProcessor
- EXPIRATION_TIME - Static variable in interface io.micronaut.security.token.Claims
- extractName(X509Certificate) - Method in class io.micronaut.security.x509.X509AuthenticationFetcher
-
Extracts the name from the certificate using the subject DN regex.
- extractTokenFromAuthorization(String) - Method in class io.micronaut.security.token.propagation.HttpHeaderTokenPropagator
- extractTokenFromAuthorization(String) - Method in class io.micronaut.security.token.reader.HttpHeaderTokenReader
F
- failure() - Static method in interface io.micronaut.security.authentication.AuthenticationResponse
- failure(AuthenticationFailureReason) - Static method in interface io.micronaut.security.authentication.AuthenticationResponse
- failure(String) - Static method in interface io.micronaut.security.authentication.AuthenticationResponse
- fetchAuthentication(HttpRequest<?>) - Method in class io.micronaut.security.authentication.BasicAuthAuthenticationFetcher
- fetchAuthentication(HttpRequest<?>) - Method in class io.micronaut.security.token.TokenAuthenticationFetcher
- fetchAuthentication(HttpRequest<?>) - Method in class io.micronaut.security.x509.X509AuthenticationFetcher
- fetchAuthentication(T) - Method in interface io.micronaut.security.filters.AuthenticationFetcher
-
Attempts to read an
Authenticationfrom an HTTP Request being executed. - FIELDS_ATTRIBUTE_NAMES - Static variable in class io.micronaut.security.endpoints.introspection.DefaultIntrospectionProcessor
- findToken(HttpRequest<?>) - Method in class io.micronaut.security.token.cookie.CookieTokenReader
- findToken(HttpRequest<?>) - Method in class io.micronaut.security.token.cookie.TokenCookieTokenReader
- findToken(HttpRequest<?>) - Method in class io.micronaut.security.token.propagation.HttpHeaderTokenPropagator
-
Search for a JWT token in a HTTP request.
- findToken(HttpRequest<?>) - Method in interface io.micronaut.security.token.propagation.TokenPropagator
-
Attempts to retrieve a token in a request.
- findToken(HttpRequest<?>) - Method in class io.micronaut.security.token.reader.HttpHeaderTokenReader
-
Search for a JWT token in a HTTP request.
- findToken(T) - Method in interface io.micronaut.security.token.reader.TokenReader
-
Attempts to retrieve a token in a request.
- ForbiddenRedirectConfiguration - Interface in io.micronaut.security.config
-
Configuration about where to redirect if forbidden.
- ForbiddenRedirectConfigurationProperties() - Constructor for class io.micronaut.security.config.RedirectConfigurationProperties.ForbiddenRedirectConfigurationProperties
- forbiddenUrl() - Method in class io.micronaut.security.config.DefaultRedirectService
- forbiddenUrl() - Method in interface io.micronaut.security.config.RedirectService
G
- generate(Authentication) - Method in interface io.micronaut.security.token.generator.AccessRefreshTokenGenerator
- generate(Authentication) - Method in class io.micronaut.security.token.generator.DefaultAccessRefreshTokenGenerator
-
Generate an
AccessRefreshTokenresponse for the given user details. - generate(Authentication, String) - Method in interface io.micronaut.security.token.generator.RefreshTokenGenerator
- generate(String, Authentication) - Method in interface io.micronaut.security.token.generator.AccessRefreshTokenGenerator
- generate(String, Map<String, ?>) - Method in interface io.micronaut.security.token.generator.AccessRefreshTokenGenerator
- generate(String, Authentication) - Method in class io.micronaut.security.token.generator.DefaultAccessRefreshTokenGenerator
-
Generate a new access refresh token.
- generate(String, Map<String, ?>) - Method in class io.micronaut.security.token.generator.DefaultAccessRefreshTokenGenerator
-
Generate an
AccessRefreshTokenresponse for the given refresh token and claims. - generateClaims(Authentication, Integer) - Method in interface io.micronaut.security.token.claims.ClaimsGenerator
- generateClaimsSet(Map<String, ?>, Integer) - Method in interface io.micronaut.security.token.claims.ClaimsGenerator
-
Generate a claims set based on claims.
- generateJtiClaim() - Method in interface io.micronaut.security.token.claims.JtiGenerator
- generateRefreshToken(Authentication) - Method in interface io.micronaut.security.token.generator.AccessRefreshTokenGenerator
- generateRefreshToken(Authentication) - Method in class io.micronaut.security.token.generator.DefaultAccessRefreshTokenGenerator
-
Generates a refresh token and emits a
RefreshTokenGeneratedEvent. - generateToken(Authentication, Integer) - Method in interface io.micronaut.security.token.generator.TokenGenerator
- generateToken(Map<String, Object>) - Method in interface io.micronaut.security.token.generator.TokenGenerator
- get(String) - Method in interface io.micronaut.security.token.Claims
-
Retrieves a value from the claims for the given name.
- get(String) - Method in class io.micronaut.security.token.MapClaims
- getAccess() - Method in class io.micronaut.security.config.InterceptUrlMapPattern
-
access getter.
- getAccessToken() - Method in class io.micronaut.security.token.render.AccessRefreshToken
-
accessToken getter.
- getAttributes() - Method in interface io.micronaut.security.authentication.Authentication
-
In order to correctly implement the
Serializablespecification, this map should be Map<String, Serializable>, however that would place a burden on those not requiring serialization, forcing their values to conform to that spec. - getAttributes() - Method in class io.micronaut.security.authentication.ClientAuthentication
- getAttributes() - Method in class io.micronaut.security.authentication.ServerAuthentication
- getAud() - Method in class io.micronaut.security.endpoints.introspection.IntrospectionResponse
- getAuthentication() - Method in class io.micronaut.security.authentication.AuthenticationFailed
- getAuthentication() - Method in interface io.micronaut.security.authentication.AuthenticationResponse
- getAuthentication() - Method in exception io.micronaut.security.authentication.AuthorizationException
- getAuthentication() - Method in interface io.micronaut.security.config.AuthenticationModeConfiguration
- getAuthentication() - Method in class io.micronaut.security.config.SecurityConfigurationProperties
- getAuthentication() - Method in class io.micronaut.security.token.event.RefreshTokenGeneratedEvent
- getAuthentication() - Method in class io.micronaut.security.utils.DefaultSecurityService
-
Retrieves
Authenticationif authenticated. - getAuthentication() - Method in interface io.micronaut.security.utils.SecurityService
-
Retrieves
Authenticationif authenticated. - getAuthentication(String) - Method in interface io.micronaut.security.token.refresh.RefreshTokenPersistence
- getAuthenticationProviderStrategy() - Method in interface io.micronaut.security.config.SecurityConfiguration
- getAuthenticationProviderStrategy() - Method in class io.micronaut.security.config.SecurityConfigurationProperties
- getAuthenticationRequest() - Method in class io.micronaut.security.event.LoginFailedEvent
- getCertificate() - Method in class io.micronaut.security.x509.X509Authentication
- getClientId() - Method in class io.micronaut.security.endpoints.introspection.IntrospectionResponse
- getConfiguration() - Method in class io.micronaut.security.token.propagation.HttpHeaderTokenPropagator
- getCookieDomain() - Method in class io.micronaut.security.token.cookie.AbstractAccessTokenCookieConfigurationProperties
- getCookieMaxAge() - Method in class io.micronaut.security.token.cookie.AbstractAccessTokenCookieConfigurationProperties
- getCookieName() - Method in class io.micronaut.security.token.cookie.RefreshTokenCookieConfigurationProperties
- getCookieName() - Method in class io.micronaut.security.token.cookie.TokenCookieConfigurationProperties
- getCookiePath() - Method in class io.micronaut.security.token.cookie.RefreshTokenCookieConfigurationProperties
- getCookiePath() - Method in class io.micronaut.security.token.cookie.TokenCookieConfigurationProperties
- getCookies(Authentication, HttpRequest<?>) - Method in class io.micronaut.security.token.cookie.CookieLoginHandler
-
Return the cookies for the given parameters.
- getCookies(Authentication, HttpRequest<?>) - Method in class io.micronaut.security.token.cookie.TokenCookieLoginHandler
- getCookies(Authentication, String, HttpRequest<?>) - Method in class io.micronaut.security.token.cookie.CookieLoginHandler
-
Return the cookies for the given parameters.
- getCookies(Authentication, String, HttpRequest<?>) - Method in class io.micronaut.security.token.cookie.TokenCookieLoginHandler
- getCookies(AccessRefreshToken, HttpRequest<?>) - Method in class io.micronaut.security.token.cookie.TokenCookieLoginHandler
-
Return the cookies for the given parameters.
- getCookieSameSite() - Method in class io.micronaut.security.token.cookie.AbstractAccessTokenCookieConfigurationProperties
- getError() - Method in interface io.micronaut.security.errors.ErrorResponse
- getError() - Method in exception io.micronaut.security.errors.OauthErrorResponseException
- getErrorCode() - Method in interface io.micronaut.security.errors.ErrorCode
- getErrorCode() - Method in enum class io.micronaut.security.errors.IssuingAnAccessTokenErrorCode
- getErrorCode() - Method in enum class io.micronaut.security.errors.ObtainingAuthorizationErrorCode
- getErrorCodeDescription() - Method in interface io.micronaut.security.errors.ErrorCode
- getErrorCodeDescription() - Method in enum class io.micronaut.security.errors.IssuingAnAccessTokenErrorCode
- getErrorCodeDescription() - Method in enum class io.micronaut.security.errors.ObtainingAuthorizationErrorCode
- getErrorDescription() - Method in interface io.micronaut.security.errors.ErrorResponse
- getErrorDescription() - Method in exception io.micronaut.security.errors.OauthErrorResponseException
- getErrorUri() - Method in interface io.micronaut.security.errors.ErrorResponse
- getErrorUri() - Method in exception io.micronaut.security.errors.OauthErrorResponseException
- getExp() - Method in class io.micronaut.security.endpoints.introspection.IntrospectionResponse
- getExpiration() - Method in interface io.micronaut.security.token.generator.AccessTokenConfiguration
- getExpiration() - Method in class io.micronaut.security.token.generator.AccessTokenConfigurationProperties
- getExpiresIn() - Method in class io.micronaut.security.token.render.AccessRefreshToken
-
lifetime in seconds of the access token getter.
- getExtensions() - Method in class io.micronaut.security.endpoints.introspection.IntrospectionResponse
- getForbidden() - Method in interface io.micronaut.security.config.RedirectConfiguration
- getForbidden() - Method in class io.micronaut.security.config.RedirectConfigurationProperties
- getGrantType() - Method in class io.micronaut.security.endpoints.TokenRefreshRequest
-
grantType getter.
- getHeaderName() - Method in interface io.micronaut.security.token.bearer.BearerTokenConfiguration
- getHeaderName() - Method in class io.micronaut.security.token.bearer.BearerTokenConfigurationProperties
- getHeaderName() - Method in class io.micronaut.security.token.bearer.BearerTokenReader
- getHeaderName() - Method in interface io.micronaut.security.token.propagation.HttpHeaderTokenPropagatorConfiguration
- getHeaderName() - Method in class io.micronaut.security.token.propagation.HttpHeaderTokenPropagatorConfigurationProperties
- getHeaderName() - Method in class io.micronaut.security.token.reader.HttpHeaderTokenReader
- getHttpMethod() - Method in class io.micronaut.security.config.InterceptUrlMapPattern
-
httpMethod getter.
- getIat() - Method in class io.micronaut.security.endpoints.introspection.IntrospectionResponse
- getIdentity() - Method in interface io.micronaut.security.authentication.AuthenticationRequest
- getIdentity() - Method in class io.micronaut.security.authentication.UsernamePasswordCredentials
- getInterceptUrlMap() - Method in interface io.micronaut.security.config.SecurityConfiguration
- getInterceptUrlMap() - Method in class io.micronaut.security.config.SecurityConfigurationProperties
- getIpPatterns() - Method in interface io.micronaut.security.config.SecurityConfiguration
- getIpPatterns() - Method in class io.micronaut.security.config.SecurityConfigurationProperties
- getIss() - Method in class io.micronaut.security.endpoints.introspection.IntrospectionResponse
- getJti() - Method in class io.micronaut.security.endpoints.introspection.IntrospectionResponse
- getLoginFailure() - Method in interface io.micronaut.security.config.RedirectConfiguration
- getLoginFailure() - Method in class io.micronaut.security.config.RedirectConfigurationProperties
- getLoginSuccess() - Method in interface io.micronaut.security.config.RedirectConfiguration
- getLoginSuccess() - Method in class io.micronaut.security.config.RedirectConfigurationProperties
- getLogout() - Method in interface io.micronaut.security.config.RedirectConfiguration
- getLogout() - Method in class io.micronaut.security.config.RedirectConfigurationProperties
- getMessage() - Method in class io.micronaut.security.authentication.AuthenticationFailed
-
message getter.
- getMessage() - Method in interface io.micronaut.security.authentication.AuthenticationResponse
- getName() - Method in class io.micronaut.security.authentication.ClientAuthentication
- getName() - Method in class io.micronaut.security.authentication.ServerAuthentication
- getNameKey() - Method in interface io.micronaut.security.token.config.TokenConfiguration
-
Key which will be used in the
Authentication.getAttributes()for the User`s name. - getNameKey() - Method in class io.micronaut.security.token.config.TokenConfigurationProperties
- getNbf() - Method in class io.micronaut.security.endpoints.introspection.IntrospectionResponse
- getOrder() - Method in class io.micronaut.security.filters.SecurityFilter
- getOrder() - Method in class io.micronaut.security.rules.ConfigurationInterceptUrlMapRule
- getOrder() - Method in class io.micronaut.security.rules.IpPatternsRule
- getOrder() - Method in class io.micronaut.security.rules.SecuredAnnotationRule
- getOrder() - Method in class io.micronaut.security.rules.SensitiveEndpointRule
- getOrder() - Method in class io.micronaut.security.token.bearer.BearerTokenReader
- getOrder() - Method in class io.micronaut.security.token.cookie.CookieTokenReader
- getOrder() - Method in class io.micronaut.security.token.cookie.TokenCookieTokenReader
- getOrder() - Method in class io.micronaut.security.token.TokenAuthenticationFetcher
- getOrder() - Method in class io.micronaut.security.x509.X509AuthenticationFetcher
- getOriginalUri(HttpRequest<?>, MutableHttpResponse<?>) - Method in class io.micronaut.security.errors.CookiePriorToLoginPersistence
- getOriginalUri(I, O) - Method in interface io.micronaut.security.errors.PriorToLoginPersistence
- getPassword() - Method in class io.micronaut.security.authentication.UsernamePasswordCredentials
-
password getter.
- getPath() - Method in interface io.micronaut.security.endpoints.ControllerConfiguration
- getPath() - Method in interface io.micronaut.security.endpoints.introspection.IntrospectionConfiguration
- getPath() - Method in class io.micronaut.security.endpoints.introspection.IntrospectionConfigurationProperties
- getPath() - Method in class io.micronaut.security.endpoints.LoginControllerConfigurationProperties
- getPath() - Method in class io.micronaut.security.endpoints.LogoutControllerConfigurationProperties
- getPath() - Method in class io.micronaut.security.endpoints.OauthControllerConfigurationProperties
- getPath() - Method in interface io.micronaut.security.token.propagation.TokenPropagationConfiguration
- getPath() - Method in class io.micronaut.security.token.propagation.TokenPropagationConfigurationProperties
- getPattern() - Method in class io.micronaut.security.config.InterceptUrlMapPattern
-
pattern getter.
- getPattern() - Method in interface io.micronaut.security.filters.SecurityFilterConfiguration
- getPattern() - Method in class io.micronaut.security.filters.SecurityFilterConfigurationProperties
- getPatternList() - Method in class io.micronaut.security.rules.ConfigurationInterceptUrlMapRule
- getPrefix() - Method in interface io.micronaut.security.token.bearer.BearerTokenConfiguration
- getPrefix() - Method in class io.micronaut.security.token.bearer.BearerTokenConfigurationProperties
- getPrefix() - Method in class io.micronaut.security.token.bearer.BearerTokenReader
- getPrefix() - Method in interface io.micronaut.security.token.propagation.HttpHeaderTokenPropagatorConfiguration
- getPrefix() - Method in class io.micronaut.security.token.propagation.HttpHeaderTokenPropagatorConfigurationProperties
- getPrefix() - Method in class io.micronaut.security.token.reader.HttpHeaderTokenReader
- getReason() - Method in class io.micronaut.security.authentication.AuthenticationFailed
- getRedirectUri(HttpRequest<?>, AuthorizationException) - Method in class io.micronaut.security.authentication.DefaultAuthorizationExceptionHandler
- getRefresh() - Method in interface io.micronaut.security.config.RedirectConfiguration
- getRefresh() - Method in class io.micronaut.security.config.RedirectConfigurationProperties
- getRefreshToken() - Method in class io.micronaut.security.endpoints.TokenRefreshRequest
-
refreshToken getter.
- getRefreshToken() - Method in class io.micronaut.security.token.event.RefreshTokenGeneratedEvent
- getRefreshToken() - Method in class io.micronaut.security.token.render.AccessRefreshToken
-
refreshToken getter.
- getResponse() - Method in exception io.micronaut.security.authentication.AuthenticationException
- getRoles() - Method in interface io.micronaut.security.authentication.Authentication
- getRoles() - Method in class io.micronaut.security.authentication.ClientAuthentication
-
This implementation relies on a key being stored in the claims called "rolesKey" that stores the key where the roles are stored.
- getRoles() - Method in class io.micronaut.security.authentication.ServerAuthentication
- getRoles() - Method in class io.micronaut.security.token.render.BearerAccessRefreshToken
-
roles getter.
- getRoles(Authentication) - Method in class io.micronaut.security.rules.AbstractSecurityRule
-
Appends
SecurityRule.IS_ANONYMOUSif not authenticated. - getRolesName() - Method in interface io.micronaut.security.token.config.TokenConfiguration
-
Key which will be used in the
Authentication.getAttributes()for the User`s roles. - getRolesName() - Method in class io.micronaut.security.token.config.TokenConfigurationProperties
- getRolesSeparator() - Method in interface io.micronaut.security.token.config.TokenConfiguration
-
Separator which will be used for splitting the roles before processing the
Authentication. - getRolesSeparator() - Method in class io.micronaut.security.token.config.TokenConfigurationProperties
- getScope() - Method in class io.micronaut.security.endpoints.introspection.IntrospectionResponse
- getSecret() - Method in interface io.micronaut.security.authentication.AuthenticationRequest
- getSecret() - Method in class io.micronaut.security.authentication.UsernamePasswordCredentials
-
Returns password conforming to
AuthenticationRequestblueprint. - getServiceIdPattern() - Method in class io.micronaut.security.token.propagation.AbstractOutgoingRequestProcessorMatcher
- getServiceIdRegex() - Method in class io.micronaut.security.token.propagation.AbstractOutgoingRequestProcessorMatcher
- getSub() - Method in class io.micronaut.security.endpoints.introspection.IntrospectionResponse
- getSubjectDnRegex() - Method in interface io.micronaut.security.x509.X509Configuration
- getSubjectDnRegex() - Method in class io.micronaut.security.x509.X509ConfigurationProperties
- getToken() - Method in class io.micronaut.security.endpoints.introspection.IntrospectionRequest
- getToken_type_hint() - Method in class io.micronaut.security.endpoints.introspection.IntrospectionRequest
- getTokenType() - Method in class io.micronaut.security.endpoints.introspection.IntrospectionResponse
- getTokenType() - Method in class io.micronaut.security.token.render.AccessRefreshToken
-
token type getter.
- getTokenTypeHint() - Method in class io.micronaut.security.endpoints.introspection.IntrospectionRequest
- getUnauthorized() - Method in interface io.micronaut.security.config.RedirectConfiguration
- getUnauthorized() - Method in class io.micronaut.security.config.RedirectConfigurationProperties
- getUriPattern() - Method in class io.micronaut.security.token.propagation.AbstractOutgoingRequestProcessorMatcher
- getUriRegex() - Method in class io.micronaut.security.token.propagation.AbstractOutgoingRequestProcessorMatcher
- getUrl() - Method in interface io.micronaut.security.config.ForbiddenRedirectConfiguration
- getUrl() - Method in class io.micronaut.security.config.RedirectConfigurationProperties.ForbiddenRedirectConfigurationProperties
- getUrl() - Method in class io.micronaut.security.config.RedirectConfigurationProperties.RefreshRedirectConfigurationProperties
- getUrl() - Method in class io.micronaut.security.config.RedirectConfigurationProperties.UnauthorizedRedirectConfigurationProperties
- getUrl() - Method in interface io.micronaut.security.config.RefreshRedirectConfiguration
- getUrl() - Method in interface io.micronaut.security.config.UnauthorizedRedirectConfiguration
- getUser() - Method in class io.micronaut.security.expressions.SecuredEvaluationContext
- getUsername() - Method in class io.micronaut.security.authentication.UsernamePasswordCredentials
-
username getter.
- getUsername() - Method in class io.micronaut.security.endpoints.introspection.IntrospectionResponse
- getUsername() - Method in class io.micronaut.security.token.render.BearerAccessRefreshToken
-
username getter.
- GRANT_TYPE - Static variable in class io.micronaut.security.endpoints.TokenRefreshRequest
- GRANT_TYPE_REFRESH_TOKEN - Static variable in class io.micronaut.security.endpoints.TokenRefreshRequest
H
- handle(HttpRequest, AuthenticationException) - Method in class io.micronaut.security.authentication.AuthenticationExceptionHandler
- handle(HttpRequest, AuthorizationException) - Method in class io.micronaut.security.authentication.DefaultAuthorizationExceptionHandler
- handle(HttpRequest, OauthErrorResponseException) - Method in class io.micronaut.security.errors.OauthErrorResponseExceptionHandler
- handleLogout(HttpRequest<?>, Authentication) - Method in class io.micronaut.security.endpoints.LogoutController
- hasAnyRequiredRoles(List<String>, Collection<String>) - Method in interface io.micronaut.security.token.RolesFinder
- hasAnyRequiredRoles(List<String>, Map<String, Object>) - Method in interface io.micronaut.security.token.RolesFinder
- hashCode() - Method in class io.micronaut.security.authentication.AuthenticationFailed
- hashCode() - Method in class io.micronaut.security.authentication.UsernamePasswordCredentials
- hasRole(String) - Method in class io.micronaut.security.utils.DefaultSecurityService
-
If the current user has a specific role.
- hasRole(String) - Method in interface io.micronaut.security.utils.SecurityService
-
If the current user has a specific role.
- headerValue(String) - Method in class io.micronaut.security.token.propagation.HttpHeaderTokenPropagator
- HttpHeaderTokenPropagator - Class in io.micronaut.security.token.propagation
-
Propagates a token based off of a header.
- HttpHeaderTokenPropagator(HttpHeaderTokenPropagatorConfiguration) - Constructor for class io.micronaut.security.token.propagation.HttpHeaderTokenPropagator
- HttpHeaderTokenPropagatorConfiguration - Interface in io.micronaut.security.token.propagation
-
HTTP header token propagation configuration.
- HttpHeaderTokenPropagatorConfigurationProperties - Class in io.micronaut.security.token.propagation
-
Http header token propagation configuration.
- HttpHeaderTokenPropagatorConfigurationProperties() - Constructor for class io.micronaut.security.token.propagation.HttpHeaderTokenPropagatorConfigurationProperties
- HttpHeaderTokenReader - Class in io.micronaut.security.token.reader
-
Reads a token from an HTTP request and removes prefix from HTTP Header Value.
- HttpHeaderTokenReader() - Constructor for class io.micronaut.security.token.reader.HttpHeaderTokenReader
- httpResponseWithStatus(HttpRequest<?>, AuthorizationException) - Method in class io.micronaut.security.authentication.DefaultAuthorizationExceptionHandler
- httpResponseWithStatus(URI) - Method in class io.micronaut.security.authentication.DefaultAuthorizationExceptionHandler
-
Builds a HTTP Response redirection to the supplied location.
I
- IDTOKEN - Enum constant in enum class io.micronaut.security.authentication.AuthenticationMode
- index(HttpRequest<?>, Authentication) - Method in class io.micronaut.security.endpoints.LogoutController
-
POST endpoint for Logout Controller.
- index(HttpRequest<?>, String) - Method in class io.micronaut.security.endpoints.OauthController
- index(HttpRequest<?>, Map<String, String>, String) - Method in class io.micronaut.security.endpoints.OauthController
- indexGet(HttpRequest<?>, Authentication) - Method in class io.micronaut.security.endpoints.LogoutController
-
GET endpoint for Logout Controller.
- InterceptUrlMapConverter - Class in io.micronaut.security.config
- InterceptUrlMapPattern - Class in io.micronaut.security.config
- InterceptUrlMapPattern(String, List<String>, HttpMethod) - Constructor for class io.micronaut.security.config.InterceptUrlMapPattern
-
If the provided http method is null, the pattern will match all methods.
- InterceptUrlPatternModifier - Interface in io.micronaut.security.config
-
Decorates a
InterceptUrlMapPattern. - introspect(Authentication, T) - Method in class io.micronaut.security.endpoints.introspection.DefaultIntrospectionProcessor
- introspect(Authentication, T) - Method in interface io.micronaut.security.endpoints.introspection.IntrospectionProcessor
- introspect(IntrospectionRequest, T) - Method in class io.micronaut.security.endpoints.introspection.DefaultIntrospectionProcessor
- introspect(IntrospectionRequest, T) - Method in interface io.micronaut.security.endpoints.introspection.IntrospectionProcessor
- IntrospectionConfiguration - Interface in io.micronaut.security.endpoints.introspection
-
Encapsulates the configuration of
IntrospectionController. - IntrospectionConfigurationProperties - Class in io.micronaut.security.endpoints.introspection
- IntrospectionConfigurationProperties() - Constructor for class io.micronaut.security.endpoints.introspection.IntrospectionConfigurationProperties
- IntrospectionController - Class in io.micronaut.security.endpoints.introspection
- IntrospectionController(IntrospectionProcessor) - Constructor for class io.micronaut.security.endpoints.introspection.IntrospectionController
- IntrospectionProcessor<T> - Interface in io.micronaut.security.endpoints.introspection
-
Given a
IntrospectionRequestgenerates aIntrospectionResponse. - IntrospectionRequest - Class in io.micronaut.security.endpoints.introspection
-
A parameter representing the token along with optional parameters representing additional context that is known by the protected resource to aid the authorization server in its response.
- IntrospectionRequest(String, String) - Constructor for class io.micronaut.security.endpoints.introspection.IntrospectionRequest
- IntrospectionResponse - Class in io.micronaut.security.endpoints.introspection
- IntrospectionResponse(boolean, String, String, String, String, Long, Long, Long, String, String, String, String, Map<String, Object>) - Constructor for class io.micronaut.security.endpoints.introspection.IntrospectionResponse
- INVALID_CLIENT - Enum constant in enum class io.micronaut.security.errors.IssuingAnAccessTokenErrorCode
- INVALID_GRANT - Enum constant in enum class io.micronaut.security.errors.IssuingAnAccessTokenErrorCode
- INVALID_REQUEST - Enum constant in enum class io.micronaut.security.errors.IssuingAnAccessTokenErrorCode
- INVALID_REQUEST - Enum constant in enum class io.micronaut.security.errors.ObtainingAuthorizationErrorCode
- INVALID_SCOPE - Enum constant in enum class io.micronaut.security.errors.ObtainingAuthorizationErrorCode
- io.micronaut.security.authentication - package io.micronaut.security.authentication
-
Micronaut security authentication.
- io.micronaut.security.config - package io.micronaut.security.config
-
Security configuration.
- io.micronaut.security.endpoints - package io.micronaut.security.endpoints
-
Security login, logout and introspection endpoints.
- io.micronaut.security.endpoints.introspection - package io.micronaut.security.endpoints.introspection
-
Introspection endpoint related classes.
- io.micronaut.security.errors - package io.micronaut.security.errors
-
Classes related to OAuth 2.0 error responses.
- io.micronaut.security.event - package io.micronaut.security.event
-
Login failure and success events.
- io.micronaut.security.expressions - package io.micronaut.security.expressions
-
Classes related to Expression Language support in Micronaut Security.
- io.micronaut.security.filters - package io.micronaut.security.filters
-
Security and authentication filters.
- io.micronaut.security.handlers - package io.micronaut.security.handlers
-
Security handlers.
- io.micronaut.security.rules - package io.micronaut.security.rules
-
Security rules pertaining to roles and ip.
- io.micronaut.security.token - package io.micronaut.security.token
-
Token authentication.
- io.micronaut.security.token.bearer - package io.micronaut.security.token.bearer
-
Contains classes specific to JSON Web Token (JWT) Authentication within Micronaut.
- io.micronaut.security.token.claims - package io.micronaut.security.token.claims
-
Claims related classes.
- io.micronaut.security.token.config - package io.micronaut.security.token.config
-
Security token configuration.
- io.micronaut.security.token.cookie - package io.micronaut.security.token.cookie
-
JWT cookie configuration and handlers.
- io.micronaut.security.token.event - package io.micronaut.security.token.event
-
Token generated events.
- io.micronaut.security.token.generator - package io.micronaut.security.token.generator
-
Security token generator.
- io.micronaut.security.token.propagation - package io.micronaut.security.token.propagation
-
Support classes for JWT propagation.
- io.micronaut.security.token.reader - package io.micronaut.security.token.reader
-
Security token reader.
- io.micronaut.security.token.refresh - package io.micronaut.security.token.refresh
- io.micronaut.security.token.render - package io.micronaut.security.token.render
-
JWT token renderer.
- io.micronaut.security.token.validator - package io.micronaut.security.token.validator
-
Security token validator.
- io.micronaut.security.utils - package io.micronaut.security.utils
- io.micronaut.security.x509 - package io.micronaut.security.x509
-
Contains classes specific to x509.
- IpPatternsRule - Class in io.micronaut.security.rules
-
A security rule implementation backed by the
SecurityConfigurationProperties.getIpPatterns()()}. - IpPatternsRule(RolesFinder, SecurityConfiguration) - Constructor for class io.micronaut.security.rules.IpPatternsRule
- IS_ANONYMOUS - Static variable in interface io.micronaut.security.rules.SecurityRule
-
The token to represent allowing anonymous access.
- IS_AUTHENTICATED - Static variable in interface io.micronaut.security.rules.SecurityRule
-
The token to represent allowing any authenticated access.
- isActive() - Method in class io.micronaut.security.endpoints.introspection.IntrospectionResponse
- isAuthenticated() - Method in interface io.micronaut.security.authentication.AuthenticationResponse
-
If true, it is expected the
AuthenticationResponse.getAuthentication()method will return a non empty optional. - isAuthenticated() - Method in class io.micronaut.security.utils.DefaultSecurityService
-
Check if a user is authenticated.
- isAuthenticated() - Method in interface io.micronaut.security.utils.SecurityService
-
Check if a user is authenticated.
- isCookieHttpOnly() - Method in class io.micronaut.security.token.cookie.AbstractAccessTokenCookieConfigurationProperties
- isCookieSecure() - Method in class io.micronaut.security.token.cookie.AbstractAccessTokenCookieConfigurationProperties
- isEnabled() - Method in class io.micronaut.security.authentication.BasicAuthAuthenticationConfiguration
- isEnabled() - Method in class io.micronaut.security.config.RedirectConfigurationProperties.ForbiddenRedirectConfigurationProperties
- isEnabled() - Method in class io.micronaut.security.config.RedirectConfigurationProperties
- isEnabled() - Method in class io.micronaut.security.config.RedirectConfigurationProperties.RefreshRedirectConfigurationProperties
- isEnabled() - Method in class io.micronaut.security.config.RedirectConfigurationProperties.UnauthorizedRedirectConfigurationProperties
- isEnabled() - Method in class io.micronaut.security.config.SecurityConfigurationProperties
- isEnabled() - Method in class io.micronaut.security.endpoints.introspection.IntrospectionConfigurationProperties
- isEnabled() - Method in class io.micronaut.security.endpoints.LoginControllerConfigurationProperties
- isEnabled() - Method in class io.micronaut.security.endpoints.LogoutControllerConfigurationProperties
- isEnabled() - Method in class io.micronaut.security.endpoints.OauthControllerConfigurationProperties
- isEnabled() - Method in class io.micronaut.security.filters.SecurityFilterConfigurationProperties
- isEnabled() - Method in interface io.micronaut.security.token.bearer.BearerTokenConfiguration
- isEnabled() - Method in class io.micronaut.security.token.bearer.BearerTokenConfigurationProperties
- isEnabled() - Method in class io.micronaut.security.token.config.TokenConfigurationProperties
- isEnabled() - Method in class io.micronaut.security.token.cookie.RefreshTokenCookieConfigurationProperties
- isEnabled() - Method in class io.micronaut.security.token.cookie.TokenCookieConfigurationProperties
- isEnabled() - Method in class io.micronaut.security.token.propagation.HttpHeaderTokenPropagatorConfigurationProperties
- isEnabled() - Method in class io.micronaut.security.token.propagation.TokenPropagationConfigurationProperties
- isEnabled() - Method in class io.micronaut.security.x509.X509ConfigurationProperties
- isForbidden() - Method in exception io.micronaut.security.authentication.AuthorizationException
- isGetAllowed() - Method in interface io.micronaut.security.endpoints.LogoutControllerConfiguration
- isGetAllowed() - Method in class io.micronaut.security.endpoints.LogoutControllerConfigurationProperties
- isGetAllowed() - Method in interface io.micronaut.security.endpoints.OauthControllerConfiguration
- isGetAllowed() - Method in class io.micronaut.security.endpoints.OauthControllerConfigurationProperties
- isInterceptUrlMapPrependPatternWithContextPath() - Method in interface io.micronaut.security.config.SecurityConfiguration
- isInterceptUrlMapPrependPatternWithContextPath() - Method in class io.micronaut.security.config.SecurityConfigurationProperties
- isPriorToLogin() - Method in interface io.micronaut.security.config.RedirectConfiguration
- isPriorToLogin() - Method in class io.micronaut.security.config.RedirectConfigurationProperties
- isRejectNotFound() - Method in interface io.micronaut.security.config.SecurityConfiguration
-
For cases where no security rule handles a request and it is determined that the request does not match any routes on the server, whether the response should be to reject the request or allow the not found response to be returned.
- isRejectNotFound() - Method in class io.micronaut.security.config.SecurityConfigurationProperties
- ISSUED_AT - Static variable in class io.micronaut.security.endpoints.introspection.DefaultIntrospectionProcessor
- ISSUED_AT - Static variable in interface io.micronaut.security.token.Claims
- ISSUER - Static variable in class io.micronaut.security.endpoints.introspection.DefaultIntrospectionProcessor
- ISSUER - Static variable in interface io.micronaut.security.token.Claims
- IssuingAnAccessTokenErrorCode - Enum Class in io.micronaut.security.errors
-
A single ASCII error code as described in Issuing an Access Token - Error Response section of OAuth 2.0 spec.
J
- JSON_KEY_ERROR - Static variable in interface io.micronaut.security.errors.ErrorResponse
- JSON_KEY_ERROR_DESCRIPTION - Static variable in interface io.micronaut.security.errors.ErrorResponse
- JSON_KEY_ERROR_URI - Static variable in interface io.micronaut.security.errors.ErrorResponse
- JSON_KEY_STATE - Static variable in interface io.micronaut.security.errors.ErrorResponse
- JtiGenerator - Interface in io.micronaut.security.token.claims
-
Generates the "jti" (Token ID) claim, which provides a unique identifier for the token.
- JWT_ID - Static variable in class io.micronaut.security.endpoints.introspection.DefaultIntrospectionProcessor
K
- KEY - Static variable in class io.micronaut.security.filters.SecurityFilter
- KEY_ID - Static variable in interface io.micronaut.security.token.Claims
L
- LOG - Static variable in class io.micronaut.security.endpoints.introspection.DefaultIntrospectionProcessor
- LoggingUtils - Class in io.micronaut.security.utils
-
Utility methods to avoid verbosity of logging statements.
- login(UsernamePasswordCredentials, HttpRequest<?>) - Method in class io.micronaut.security.endpoints.LoginController
- LoginController - Class in io.micronaut.security.endpoints
-
Handles login requests.
- LoginController(Authenticator<HttpRequest<?>>, LoginHandler<HttpRequest<?>, MutableHttpResponse<?>>, ApplicationEventPublisher<LoginSuccessfulEvent>, ApplicationEventPublisher<LoginFailedEvent>) - Constructor for class io.micronaut.security.endpoints.LoginController
- LoginControllerConfiguration - Interface in io.micronaut.security.endpoints
-
Encapsulates the configuration of
LoginController. - LoginControllerConfigurationProperties - Class in io.micronaut.security.endpoints
- LoginControllerConfigurationProperties() - Constructor for class io.micronaut.security.endpoints.LoginControllerConfigurationProperties
- loginFailed(AuthenticationResponse, I) - Method in interface io.micronaut.security.handlers.LoginHandler
- loginFailed(AuthenticationResponse, HttpRequest<?>) - Method in class io.micronaut.security.token.bearer.AccessRefreshTokenLoginHandler
- loginFailed(AuthenticationResponse, HttpRequest<?>) - Method in class io.micronaut.security.token.cookie.CookieLoginHandler
- LoginFailedEvent - Class in io.micronaut.security.event
-
Event triggered when an unsuccessful login takes place.
- LoginFailedEvent(Object) - Constructor for class io.micronaut.security.event.LoginFailedEvent
-
Deprecated, for removal: This API element is subject to removal in a future version.
- LoginFailedEvent(Object, AuthenticationRequest) - Constructor for class io.micronaut.security.event.LoginFailedEvent
-
Event triggered when an unsuccessful login takes place.
- loginFailedEventPublisher - Variable in class io.micronaut.security.endpoints.LoginController
- loginFailure - Variable in class io.micronaut.security.token.cookie.CookieLoginHandler
- loginFailureUrl() - Method in class io.micronaut.security.config.DefaultRedirectService
- loginFailureUrl() - Method in interface io.micronaut.security.config.RedirectService
- loginHandler - Variable in class io.micronaut.security.endpoints.LoginController
- LoginHandler<I,
O> - Interface in io.micronaut.security.handlers -
Defines how to respond to a successful or failed login attempt.
- loginRefresh(Authentication, String, I) - Method in interface io.micronaut.security.handlers.LoginHandler
- loginRefresh(Authentication, String, HttpRequest<?>) - Method in class io.micronaut.security.token.bearer.AccessRefreshTokenLoginHandler
- loginRefresh(Authentication, String, HttpRequest<?>) - Method in class io.micronaut.security.token.cookie.CookieLoginHandler
- loginSuccess - Variable in class io.micronaut.security.token.cookie.CookieLoginHandler
- loginSuccess(Authentication, I) - Method in interface io.micronaut.security.handlers.LoginHandler
- loginSuccess(Authentication, HttpRequest<?>) - Method in class io.micronaut.security.token.bearer.AccessRefreshTokenLoginHandler
- loginSuccess(Authentication, HttpRequest<?>) - Method in class io.micronaut.security.token.cookie.CookieLoginHandler
- LoginSuccessfulEvent - Class in io.micronaut.security.event
-
Event triggered when a successful login takes place.
- LoginSuccessfulEvent(Object) - Constructor for class io.micronaut.security.event.LoginSuccessfulEvent
-
Event triggered when a successful login takes place.
- loginSuccessfulEventPublisher - Variable in class io.micronaut.security.endpoints.LoginController
- loginSuccessUrl() - Method in class io.micronaut.security.config.DefaultRedirectService
- loginSuccessUrl() - Method in interface io.micronaut.security.config.RedirectService
- logout - Variable in class io.micronaut.security.token.cookie.TokenCookieClearerLogoutHandler
- logout(I) - Method in interface io.micronaut.security.handlers.LogoutHandler
- logout(HttpRequest<?>) - Method in class io.micronaut.security.token.cookie.TokenCookieClearerLogoutHandler
- LogoutController - Class in io.micronaut.security.endpoints
- LogoutController(LogoutHandler<HttpRequest<?>, MutableHttpResponse<?>>, ApplicationEventPublisher<LogoutEvent>, LogoutControllerConfiguration) - Constructor for class io.micronaut.security.endpoints.LogoutController
- LogoutControllerConfiguration - Interface in io.micronaut.security.endpoints
-
Encapsulates the configuration of
LogoutController. - LogoutControllerConfigurationProperties - Class in io.micronaut.security.endpoints
-
Implementation of
LogoutControllerConfigurationused to configure theLogoutController. - LogoutControllerConfigurationProperties() - Constructor for class io.micronaut.security.endpoints.LogoutControllerConfigurationProperties
- LogoutEvent - Class in io.micronaut.security.event
-
Event triggered when the user logs out.
- LogoutEvent(Object) - Constructor for class io.micronaut.security.event.LogoutEvent
-
Event triggered when the user logs out.
- LogoutHandler<I,
O> - Interface in io.micronaut.security.handlers -
Responsible for logging the user out and returning an appropriate response.
- logoutUrl() - Method in class io.micronaut.security.config.DefaultRedirectService
- logoutUrl() - Method in interface io.micronaut.security.config.RedirectService
M
- MapClaims - Class in io.micronaut.security.token
- MapClaims(Map<String, Object>) - Constructor for class io.micronaut.security.token.MapClaims
-
Creates a MapClaims with the corresponding backing map.
- matches(ConditionContext) - Method in class io.micronaut.security.authentication.AuthenticationModeCondition
- modify(InterceptUrlMapPattern) - Method in class io.micronaut.security.config.DefaultInterceptUrlPatternModifier
- modify(InterceptUrlMapPattern) - Method in interface io.micronaut.security.config.InterceptUrlPatternModifier
N
- nameQualifier(AnnotationMetadataProvider) - Static method in class io.micronaut.security.utils.QualifierUtils
- names() - Method in interface io.micronaut.security.token.Claims
- names() - Method in class io.micronaut.security.token.MapClaims
- NON_REPLACED_SECURITY_ERROR_MESSAGE - Static variable in class io.micronaut.security.rules.SensitiveEndpointRule
- NOT_BEFORE - Static variable in class io.micronaut.security.endpoints.introspection.DefaultIntrospectionProcessor
- NOT_BEFORE - Static variable in interface io.micronaut.security.token.Claims
O
- OauthController - Class in io.micronaut.security.endpoints
-
A controller that handles token refresh.
- OauthController(RefreshTokenPersistence, RefreshTokenValidator, OauthControllerConfigurationProperties, LoginHandler<HttpRequest<?>, MutableHttpResponse<?>>) - Constructor for class io.micronaut.security.endpoints.OauthController
- OauthControllerConfiguration - Interface in io.micronaut.security.endpoints
-
Encapsulates the configuration of
OauthController. - OauthControllerConfigurationProperties - Class in io.micronaut.security.endpoints
-
Configures the provided
OauthController. - OauthControllerConfigurationProperties() - Constructor for class io.micronaut.security.endpoints.OauthControllerConfigurationProperties
- OauthErrorResponseException - Exception in io.micronaut.security.errors
-
An Runtime exception which implements
ErrorResponse. - OauthErrorResponseException(ErrorCode) - Constructor for exception io.micronaut.security.errors.OauthErrorResponseException
- OauthErrorResponseException(ErrorCode, String, String) - Constructor for exception io.micronaut.security.errors.OauthErrorResponseException
- OauthErrorResponseExceptionHandler - Class in io.micronaut.security.errors
-
Returns an application/json response for a
OauthErrorResponseExceptionwith status 400. - OauthErrorResponseExceptionHandler() - Constructor for class io.micronaut.security.errors.OauthErrorResponseExceptionHandler
- ObtainingAuthorizationErrorCode - Enum Class in io.micronaut.security.errors
-
A single ASCII error code as described in Obtaining Authorization - Error Response seciton of OAuth 2.0 spec.
- onUnauthorized(HttpRequest<?>, MutableHttpResponse<?>) - Method in class io.micronaut.security.errors.CookiePriorToLoginPersistence
- onUnauthorized(I, O) - Method in interface io.micronaut.security.errors.PriorToLoginPersistence
- ORDER - Static variable in class io.micronaut.security.rules.ConfigurationInterceptUrlMapRule
-
The order of the rule.
- ORDER - Static variable in class io.micronaut.security.rules.IpPatternsRule
-
The order of the rule.
- ORDER - Static variable in class io.micronaut.security.rules.SecuredAnnotationRule
-
The order of the rule.
- ORDER - Static variable in class io.micronaut.security.rules.SensitiveEndpointRule
-
The order of the rule.
- ORDER - Static variable in class io.micronaut.security.token.bearer.BearerTokenReader
- ORDER - Static variable in class io.micronaut.security.token.cookie.CookieTokenReader
- ORDER - Static variable in class io.micronaut.security.token.cookie.TokenCookieTokenReader
- ORDER - Static variable in class io.micronaut.security.token.TokenAuthenticationFetcher
-
The order of the fetcher.
- ORDER - Static variable in class io.micronaut.security.x509.X509AuthenticationFetcher
-
The order of the fetcher.
- outgoingHttpRequestProcessor - Variable in class io.micronaut.security.token.propagation.TokenPropagationHttpClientFilter
P
- parseCredentials(String) - Static method in class io.micronaut.security.authentication.BasicAuthUtils
- PASSWORD_EXPIRED - Enum constant in enum class io.micronaut.security.authentication.AuthenticationFailureReason
-
Failure when the cause is the user's password expired.
- persistToken(RefreshTokenGeneratedEvent) - Method in interface io.micronaut.security.token.refresh.RefreshTokenPersistence
-
Persist the refresh token.
- PREFIX - Static variable in class io.micronaut.security.authentication.BasicAuthAuthenticationConfiguration
- PREFIX - Static variable in class io.micronaut.security.config.RedirectConfigurationProperties
- PREFIX - Static variable in class io.micronaut.security.config.SecurityConfigurationProperties
- PREFIX - Static variable in class io.micronaut.security.endpoints.introspection.IntrospectionConfigurationProperties
- PREFIX - Static variable in class io.micronaut.security.endpoints.LoginControllerConfigurationProperties
- PREFIX - Static variable in class io.micronaut.security.endpoints.LogoutControllerConfigurationProperties
- PREFIX - Static variable in class io.micronaut.security.endpoints.OauthControllerConfigurationProperties
- PREFIX - Static variable in class io.micronaut.security.filters.SecurityFilterConfigurationProperties
- PREFIX - Static variable in class io.micronaut.security.token.bearer.BearerTokenConfigurationProperties
- PREFIX - Static variable in class io.micronaut.security.token.config.TokenConfigurationProperties
- PREFIX - Static variable in class io.micronaut.security.token.cookie.RefreshTokenCookieConfigurationProperties
- PREFIX - Static variable in class io.micronaut.security.token.cookie.TokenCookieConfigurationProperties
- PREFIX - Static variable in class io.micronaut.security.token.generator.AccessTokenConfigurationProperties
- PREFIX - Static variable in class io.micronaut.security.token.propagation.HttpHeaderTokenPropagatorConfigurationProperties
- PREFIX - Static variable in class io.micronaut.security.token.propagation.TokenPropagationConfigurationProperties
- PREFIX - Static variable in class io.micronaut.security.x509.X509ConfigurationProperties
- prependContextPath(String, ServerContextPathProvider) - Static method in class io.micronaut.security.config.ServerContextPathProviderUtils
- PrincipalArgumentBinder - Class in io.micronaut.security.authentication
-
Responsible for binding a
Principalto a route argument. - PrincipalArgumentBinder() - Constructor for class io.micronaut.security.authentication.PrincipalArgumentBinder
- priorToLoginPersistence - Variable in class io.micronaut.security.token.cookie.CookieLoginHandler
- PriorToLoginPersistence<I,
O> - Interface in io.micronaut.security.errors -
Keep track of state before login.
- processor - Variable in class io.micronaut.security.endpoints.introspection.IntrospectionController
Q
- QualifierUtils - Class in io.micronaut.security.utils
-
Utility class to get the name qualifier value.
R
- RedirectConfiguration - Interface in io.micronaut.security.config
- RedirectConfigurationProperties - Class in io.micronaut.security.config
-
ConfigurationPropertiesimplementation ofRedirectConfiguration. - RedirectConfigurationProperties() - Constructor for class io.micronaut.security.config.RedirectConfigurationProperties
- RedirectConfigurationProperties.ForbiddenRedirectConfigurationProperties - Class in io.micronaut.security.config
-
Forbidden redirect configuration.
- RedirectConfigurationProperties.RefreshRedirectConfigurationProperties - Class in io.micronaut.security.config
-
Forbidden redirect configuration.
- RedirectConfigurationProperties.UnauthorizedRedirectConfigurationProperties - Class in io.micronaut.security.config
-
Unauthorized redirect configuration.
- RedirectingLoginHandler<I,
O> - Interface in io.micronaut.security.handlers -
A marker contract to indicate the login handler returns redirecting responses.
- RedirectService - Interface in io.micronaut.security.config
-
Get redirection URLs combining context path and redirect configuration.
- refresh - Variable in class io.micronaut.security.token.cookie.CookieLoginHandler
- RefreshRedirectConfiguration - Interface in io.micronaut.security.config
-
Configuration about where to redirect after a successful refresh request.
- RefreshRedirectConfigurationProperties() - Constructor for class io.micronaut.security.config.RedirectConfigurationProperties.RefreshRedirectConfigurationProperties
- refreshTokenCookieConfiguration - Variable in class io.micronaut.security.token.cookie.TokenCookieClearerLogoutHandler
- refreshTokenCookieConfiguration - Variable in class io.micronaut.security.token.cookie.TokenCookieLoginHandler
- RefreshTokenCookieConfiguration - Interface in io.micronaut.security.token.cookie
-
Configuration for the refresh token cookie.
- RefreshTokenCookieConfigurationProperties - Class in io.micronaut.security.token.cookie
- RefreshTokenCookieConfigurationProperties(String) - Constructor for class io.micronaut.security.token.cookie.RefreshTokenCookieConfigurationProperties
- RefreshTokenGeneratedEvent - Class in io.micronaut.security.token.event
-
Triggered when a JWT refresh token is generated.
- RefreshTokenGeneratedEvent(Authentication, String) - Constructor for class io.micronaut.security.token.event.RefreshTokenGeneratedEvent
-
Triggered when a refresh token is generated.
- refreshTokenGeneratedEventPublisher - Variable in class io.micronaut.security.token.generator.DefaultAccessRefreshTokenGenerator
- refreshTokenGenerator - Variable in class io.micronaut.security.token.generator.DefaultAccessRefreshTokenGenerator
- RefreshTokenGenerator - Interface in io.micronaut.security.token.generator
-
Responsible for generating refresh tokens.
- RefreshTokenPersistence - Interface in io.micronaut.security.token.refresh
-
Responsible for persisting refresh tokens and retrieving user details by a refresh token.
- refreshTokenValidator - Variable in class io.micronaut.security.endpoints.introspection.DefaultIntrospectionProcessor
- RefreshTokenValidator - Interface in io.micronaut.security.token.validator
-
Responsible for validating a refresh token is in a valid format.
- refreshUrl() - Method in class io.micronaut.security.config.DefaultRedirectService
- refreshUrl() - Method in interface io.micronaut.security.config.RedirectService
- REJECTED - Enum constant in enum class io.micronaut.security.rules.SecurityRuleResult
-
The rule explicitly rejects this request.
- REJECTION - Static variable in class io.micronaut.security.filters.SecurityFilter
-
The attribute used to store if the request was rejected and why.
- render(Authentication, Integer, String, String) - Method in class io.micronaut.security.token.render.BearerTokenRenderer
- render(Authentication, Integer, String, String) - Method in interface io.micronaut.security.token.render.TokenRenderer
- render(Integer, String, String) - Method in class io.micronaut.security.token.render.BearerTokenRenderer
- render(Integer, String, String) - Method in interface io.micronaut.security.token.render.TokenRenderer
- resolveAud(Authentication) - Method in class io.micronaut.security.endpoints.introspection.DefaultIntrospectionProcessor
-
Populates the introspection response with aud claim.
- resolveClientId(Authentication) - Method in class io.micronaut.security.endpoints.introspection.DefaultIntrospectionProcessor
-
Populates the introspection response client_id.
- resolveExpiration(Authentication) - Method in class io.micronaut.security.endpoints.introspection.DefaultIntrospectionProcessor
-
Populates the introspection response with the exp claim of authentication.
- resolveExtensions(Authentication) - Method in class io.micronaut.security.endpoints.introspection.DefaultIntrospectionProcessor
- resolveIssuedAt(Authentication) - Method in class io.micronaut.security.endpoints.introspection.DefaultIntrospectionProcessor
-
Populates the introspection response with the iat claim of authentication.
- resolveIssuer(Authentication) - Method in class io.micronaut.security.endpoints.introspection.DefaultIntrospectionProcessor
-
Populates the introspection response with iss claim.
- resolveJwtId(Authentication) - Method in class io.micronaut.security.endpoints.introspection.DefaultIntrospectionProcessor
-
Populates the introspection response with jti username.
- resolveNotBefore(Authentication) - Method in class io.micronaut.security.endpoints.introspection.DefaultIntrospectionProcessor
-
Populates the introspection response with the nbf claim of authentication.
- resolveRoles(Map<String, Object>) - Method in class io.micronaut.security.token.DefaultRolesFinder
- resolveRoles(Map<String, Object>) - Method in interface io.micronaut.security.token.RolesFinder
-
Retrieves the list of roles from the User Attributes.
- resolveScope(Authentication) - Method in class io.micronaut.security.endpoints.introspection.DefaultIntrospectionProcessor
-
Populates the introspection response scope.
- resolveSub(Authentication) - Method in class io.micronaut.security.endpoints.introspection.DefaultIntrospectionProcessor
-
Populates the introspection response with sub claim.
- resolveToken(HttpRequest<?>) - Method in class io.micronaut.security.token.reader.DefaultTokenResolver
-
Returns the first token found by the supplied token readers.
- resolveToken(T) - Method in interface io.micronaut.security.token.reader.TokenResolver
-
Deprecated, for removal: This API element is subject to removal in a future version.Use
TokenResolver.resolveTokens(Object)instead. - resolveTokens(HttpRequest<?>) - Method in class io.micronaut.security.token.reader.DefaultTokenResolver
- resolveTokens(T) - Method in interface io.micronaut.security.token.reader.TokenResolver
-
Returns tokens found by the supplied token readers.
- resolveTokenType(Authentication) - Method in class io.micronaut.security.endpoints.introspection.DefaultIntrospectionProcessor
-
Populates the introspection response token type.
- resolveUsername(Authentication) - Method in class io.micronaut.security.endpoints.introspection.DefaultIntrospectionProcessor
-
Populates the introspection response with the username.
- responseBody(ErrorResponse) - Method in class io.micronaut.security.errors.OauthErrorResponseExceptionHandler
- RolesFinder - Interface in io.micronaut.security.token
-
Retrieves roles from token claims.
S
- SCOPE - Static variable in class io.micronaut.security.endpoints.introspection.DefaultIntrospectionProcessor
- secondsSinceEpochOfAttribute(String, Authentication) - Method in class io.micronaut.security.endpoints.introspection.DefaultIntrospectionProcessor
- SecuredAnnotationRule - Class in io.micronaut.security.rules
-
Security rule implementation for the
Securedannotation. - SecuredAnnotationRule(RolesFinder) - Constructor for class io.micronaut.security.rules.SecuredAnnotationRule
- SecuredEvaluationContext - Class in io.micronaut.security.expressions
-
Context for supporting
Securedannotation expressions with object references. - SecuredEvaluationContext(SecurityService) - Constructor for class io.micronaut.security.expressions.SecuredEvaluationContext
- securityConfiguration - Variable in class io.micronaut.security.filters.SecurityFilter
- SecurityConfiguration - Interface in io.micronaut.security.config
-
Defines security configuration properties.
- SecurityConfigurationProperties - Class in io.micronaut.security.config
-
Stores configuration for JWT.
- SecurityConfigurationProperties() - Constructor for class io.micronaut.security.config.SecurityConfigurationProperties
- SecurityFilter - Class in io.micronaut.security.filters
-
Security Filter.
- SecurityFilter(Collection<SecurityRule<HttpRequest<?>>>, Collection<AuthenticationFetcher<HttpRequest<?>>>, SecurityConfiguration) - Constructor for class io.micronaut.security.filters.SecurityFilter
- SecurityFilterConfiguration - Interface in io.micronaut.security.filters
-
Configuration for
SecurityFilter. - SecurityFilterConfigurationProperties - Class in io.micronaut.security.filters
-
ConfigurationPropertiesimplementation ofSecurityFilterConfiguration. - SecurityFilterConfigurationProperties() - Constructor for class io.micronaut.security.filters.SecurityFilterConfigurationProperties
- SecurityRule<T> - Interface in io.micronaut.security.rules
-
Informs the
SecurityFilterfilter what to do with the given request. - SecurityRuleResult - Enum Class in io.micronaut.security.rules
-
The result of a security rule check.
- securityRules - Variable in class io.micronaut.security.filters.SecurityFilter
- SecurityService - Interface in io.micronaut.security.utils
-
Provides a set of convenient methods related to authentication and authorization.
- SensitiveEndpointRule - Class in io.micronaut.security.rules
-
Finds any sensitive endpoints and processes requests that match their id.
- SensitiveEndpointRule(EndpointSensitivityProcessor) - Constructor for class io.micronaut.security.rules.SensitiveEndpointRule
-
Constructs the rule with the existing and default endpoint configurations used to determine if a given endpoint is sensitive.
- SERVER_ERROR - Enum constant in enum class io.micronaut.security.errors.ObtainingAuthorizationErrorCode
- ServerAuthentication - Class in io.micronaut.security.authentication
-
An implementation of the
Authenticationinterfaced intended to be used on the server side to create authentication objects from user data found through any means. - ServerAuthentication(String, Collection<String>, Map<String, Object>) - Constructor for class io.micronaut.security.authentication.ServerAuthentication
- ServerContextPathProviderUtils - Class in io.micronaut.security.config
-
Utility methods to prepend a URL with the context path provided via
ServerContextPathProvider. - serviceIdPattern - Variable in class io.micronaut.security.token.propagation.AbstractOutgoingRequestProcessorMatcher
- serviceIdRegex - Variable in class io.micronaut.security.token.propagation.AbstractOutgoingRequestProcessorMatcher
- SESSION - Enum constant in enum class io.micronaut.security.authentication.AuthenticationMode
- setAuthentication(AuthenticationMode) - Method in class io.micronaut.security.config.SecurityConfigurationProperties
-
Defines which authentication to use.
- setAuthenticationProviderStrategy(AuthenticationStrategy) - Method in class io.micronaut.security.config.SecurityConfigurationProperties
-
Determines how authentication providers should be processed.
- setCookieDomain(String) - Method in class io.micronaut.security.token.cookie.AbstractAccessTokenCookieConfigurationProperties
-
Sets the domain name of this Cookie.
- setCookieHttpOnly(Boolean) - Method in class io.micronaut.security.token.cookie.AbstractAccessTokenCookieConfigurationProperties
-
Whether the Cookie can only be accessed via HTTP.
- setCookieMaxAge(Duration) - Method in class io.micronaut.security.token.cookie.AbstractAccessTokenCookieConfigurationProperties
-
Sets the maximum age of the cookie.
- setCookieName(String) - Method in class io.micronaut.security.token.cookie.RefreshTokenCookieConfigurationProperties
-
Cookie Name.
- setCookieName(String) - Method in class io.micronaut.security.token.cookie.TokenCookieConfigurationProperties
-
Cookie Name.
- setCookiePath(String) - Method in class io.micronaut.security.token.cookie.RefreshTokenCookieConfigurationProperties
-
Sets the path of the cookie.
- setCookiePath(String) - Method in class io.micronaut.security.token.cookie.TokenCookieConfigurationProperties
-
Sets the path of the cookie.
- setCookieSameSite(SameSite) - Method in class io.micronaut.security.token.cookie.AbstractAccessTokenCookieConfigurationProperties
-
Sets the same-site setting of the cookie.
- setCookieSecure(Boolean) - Method in class io.micronaut.security.token.cookie.AbstractAccessTokenCookieConfigurationProperties
-
Sets whether the cookie is secured.
- setEnabled(boolean) - Method in class io.micronaut.security.authentication.BasicAuthAuthenticationConfiguration
-
Enables the
BasicAuthAuthenticationFetcher. - setEnabled(boolean) - Method in class io.micronaut.security.config.RedirectConfigurationProperties.ForbiddenRedirectConfigurationProperties
-
Whether it should redirect on forbidden rejections.
- setEnabled(boolean) - Method in class io.micronaut.security.config.RedirectConfigurationProperties.RefreshRedirectConfigurationProperties
-
Whether it should redirect on forbidden rejections.
- setEnabled(boolean) - Method in class io.micronaut.security.config.RedirectConfigurationProperties
-
Sets whether Redirection configuration enabled.
- setEnabled(boolean) - Method in class io.micronaut.security.config.RedirectConfigurationProperties.UnauthorizedRedirectConfigurationProperties
-
Whether it should redirect on unauthorized rejections.
- setEnabled(boolean) - Method in class io.micronaut.security.config.SecurityConfigurationProperties
-
If Security is enabled.
- setEnabled(boolean) - Method in class io.micronaut.security.endpoints.introspection.IntrospectionConfigurationProperties
-
Enables
IntrospectionController. - setEnabled(boolean) - Method in class io.micronaut.security.endpoints.LoginControllerConfigurationProperties
-
Enables
LoginController. - setEnabled(boolean) - Method in class io.micronaut.security.endpoints.LogoutControllerConfigurationProperties
-
Enables
LogoutController. - setEnabled(boolean) - Method in class io.micronaut.security.endpoints.OauthControllerConfigurationProperties
-
Sets whether the
OauthControlleris enabled. - setEnabled(boolean) - Method in class io.micronaut.security.filters.SecurityFilterConfigurationProperties
-
Enables
SecurityFilter. - setEnabled(boolean) - Method in class io.micronaut.security.token.bearer.BearerTokenConfigurationProperties
-
Set whether to enable bearer token authentication.
- setEnabled(boolean) - Method in class io.micronaut.security.token.config.TokenConfigurationProperties
-
Sets whether the configuration is enabled.
- setEnabled(boolean) - Method in class io.micronaut.security.token.cookie.RefreshTokenCookieConfigurationProperties
-
Sets whether JWT cookie configuration is enabled.
- setEnabled(boolean) - Method in class io.micronaut.security.token.cookie.TokenCookieConfigurationProperties
-
Sets whether JWT cookie configuration is enabled.
- setEnabled(boolean) - Method in class io.micronaut.security.token.propagation.HttpHeaderTokenPropagatorConfigurationProperties
-
Enable
HttpHeaderTokenPropagator. - setEnabled(boolean) - Method in class io.micronaut.security.token.propagation.TokenPropagationConfigurationProperties
-
Enables
TokenPropagationHttpClientFilter. - setEnabled(boolean) - Method in class io.micronaut.security.x509.X509ConfigurationProperties
-
Enables the
X509AuthenticationFetcher. - setExpiration(Integer) - Method in class io.micronaut.security.token.generator.AccessTokenConfigurationProperties
-
Access token expiration.
- setForbidden(RedirectConfigurationProperties.ForbiddenRedirectConfigurationProperties) - Method in class io.micronaut.security.config.RedirectConfigurationProperties
-
Sets the forbidden redirect configuration.
- setGetAllowed(boolean) - Method in class io.micronaut.security.endpoints.LogoutControllerConfigurationProperties
-
Enables HTTP GET invocations of
LogoutController. - setGetAllowed(boolean) - Method in class io.micronaut.security.endpoints.OauthControllerConfigurationProperties
-
Enables HTTP GET invocations of refresh token requests.
- setHeaderName(String) - Method in class io.micronaut.security.token.bearer.BearerTokenConfigurationProperties
-
Sets the header name to use.
- setHeaderName(String) - Method in class io.micronaut.security.token.propagation.HttpHeaderTokenPropagatorConfigurationProperties
-
Http Header to be used to propagate the token.
- setInterceptUrlMap(List<InterceptUrlMapPattern>) - Method in class io.micronaut.security.config.SecurityConfigurationProperties
-
Map that defines the interception patterns.
- setInterceptUrlMapPrependPatternWithContextPath(boolean) - Method in class io.micronaut.security.config.SecurityConfigurationProperties
-
Whether the intercept URL patterns should be prepended with context path if defined.
- setIpPatterns(List<String>) - Method in class io.micronaut.security.config.SecurityConfigurationProperties
-
Allowed IP patterns.
- setLoginFailure(String) - Method in class io.micronaut.security.config.RedirectConfigurationProperties
-
Where the user is redirected to after a failed login.
- setLoginSuccess(String) - Method in class io.micronaut.security.config.RedirectConfigurationProperties
-
Where the user is redirected to after a successful login.
- setLogout(String) - Method in class io.micronaut.security.config.RedirectConfigurationProperties
-
URL where the user is redirected after logout.
- setNameKey(String) - Method in class io.micronaut.security.token.config.TokenConfigurationProperties
-
Authenticationattributes map key for the user's name. - setPassword(String) - Method in class io.micronaut.security.authentication.UsernamePasswordCredentials
-
password setter.
- setPath(String) - Method in class io.micronaut.security.endpoints.introspection.IntrospectionConfigurationProperties
-
Path to the
IntrospectionController. - setPath(String) - Method in class io.micronaut.security.filters.SecurityFilterConfigurationProperties
-
Pattern the
SecurityFiltershould match. - setPath(String) - Method in class io.micronaut.security.endpoints.LoginControllerConfigurationProperties
-
Path to the
LoginController. - setPath(String) - Method in class io.micronaut.security.endpoints.LogoutControllerConfigurationProperties
-
Path to the
LogoutController. - setPath(String) - Method in class io.micronaut.security.endpoints.OauthControllerConfigurationProperties
-
Sets the path to map the
OauthControllerto. - setPath(String) - Method in class io.micronaut.security.token.propagation.TokenPropagationConfigurationProperties
-
Configures
TokenPropagationHttpClientFilterpath. - setPrefix(String) - Method in class io.micronaut.security.token.bearer.BearerTokenConfigurationProperties
-
Sets the prefix to use for the auth token.
- setPrefix(String) - Method in class io.micronaut.security.token.propagation.HttpHeaderTokenPropagatorConfigurationProperties
-
Value prefix for Http Header.
- setPriorToLogin(boolean) - Method in class io.micronaut.security.config.RedirectConfigurationProperties
-
If true, the user should be redirected back to the unauthorized request that initiated the login flow.
- setRefresh(RedirectConfigurationProperties.RefreshRedirectConfigurationProperties) - Method in class io.micronaut.security.config.RedirectConfigurationProperties
-
Sets the refresh redirect configuration.
- setRejectNotFound(boolean) - Method in class io.micronaut.security.config.SecurityConfigurationProperties
- setRolesName(String) - Method in class io.micronaut.security.token.config.TokenConfigurationProperties
-
Authenticationattributes map key for the user's roles. - setRolesSeparator(String) - Method in class io.micronaut.security.token.config.TokenConfigurationProperties
-
If the entry used for the roles in the
Authenticationattributes map is a String, you can use the separator to split its value into multiple roles. - setServiceIdRegex(String) - Method in class io.micronaut.security.token.propagation.AbstractOutgoingRequestProcessorMatcher
-
a regular expression to match the service id.
- setSubjectDnRegex(String) - Method in class io.micronaut.security.x509.X509ConfigurationProperties
-
Set the Subject DN regex.
- setUnauthorized(RedirectConfigurationProperties.UnauthorizedRedirectConfigurationProperties) - Method in class io.micronaut.security.config.RedirectConfigurationProperties
-
Sets the unauthorized redirect configuration.
- setUriRegex(String) - Method in class io.micronaut.security.token.propagation.AbstractOutgoingRequestProcessorMatcher
-
a regular expression to match the uri.
- setUrl(String) - Method in class io.micronaut.security.config.RedirectConfigurationProperties.ForbiddenRedirectConfigurationProperties
-
Where the user is redirected to after trying to access a secured route which he is forbidden to access.
- setUrl(String) - Method in class io.micronaut.security.config.RedirectConfigurationProperties.RefreshRedirectConfigurationProperties
-
Where the user is redirected to after trying to access a secured route which he is forbidden to access.
- setUrl(String) - Method in class io.micronaut.security.config.RedirectConfigurationProperties.UnauthorizedRedirectConfigurationProperties
-
Where the user is redirected to after trying to access a secured route.
- setUsername(String) - Method in class io.micronaut.security.authentication.UsernamePasswordCredentials
-
username setter.
- shouldRedirect(HttpRequest<?>, AuthorizationException) - Method in class io.micronaut.security.authentication.DefaultAuthorizationExceptionHandler
-
Decides whether the request should be handled with a redirect.
- SUBJECT - Static variable in class io.micronaut.security.endpoints.introspection.DefaultIntrospectionProcessor
- SUBJECT - Static variable in interface io.micronaut.security.token.Claims
- success(String) - Static method in interface io.micronaut.security.authentication.AuthenticationResponse
- success(String, Collection<String>) - Static method in interface io.micronaut.security.authentication.AuthenticationResponse
- success(String, Collection<String>, Map<String, Object>) - Static method in interface io.micronaut.security.authentication.AuthenticationResponse
- success(String, Map<String, Object>) - Static method in interface io.micronaut.security.authentication.AuthenticationResponse
T
- TEMPORARILY_UNAVAILABLE - Enum constant in enum class io.micronaut.security.errors.ObtainingAuthorizationErrorCode
- toJson() - Method in class io.micronaut.security.authentication.ServerAuthentication
- TOKEN - Static variable in class io.micronaut.security.filters.SecurityFilter
-
The attribute used to store a valid token in the request.
- TOKEN_ID - Static variable in interface io.micronaut.security.token.Claims
- TOKEN_TYPE - Static variable in class io.micronaut.security.endpoints.introspection.DefaultIntrospectionProcessor
- TokenAuthenticationFactory<T> - Interface in io.micronaut.security.token
-
Creates an
Authenticationobject from a token. - TokenAuthenticationFetcher - Class in io.micronaut.security.token
-
Attempts to retrieve a token form the
HttpRequestand if existing validated. - TokenAuthenticationFetcher(Collection<TokenValidator<HttpRequest<?>>>, TokenResolver<HttpRequest<?>>, ApplicationEventPublisher<TokenValidatedEvent>) - Constructor for class io.micronaut.security.token.TokenAuthenticationFetcher
-
Deprecated, for removal: This API element is subject to removal in a future version.
- TokenAuthenticationFetcher(List<TokenValidator<HttpRequest<?>>>, TokenResolver<HttpRequest<?>>, ApplicationEventPublisher<TokenValidatedEvent>) - Constructor for class io.micronaut.security.token.TokenAuthenticationFetcher
- tokenConfiguration - Variable in class io.micronaut.security.endpoints.introspection.DefaultIntrospectionProcessor
- TokenConfiguration - Interface in io.micronaut.security.token.config
-
Defines Security Token Configuration.
- TokenConfigurationProperties - Class in io.micronaut.security.token.config
-
Defines Security Token Configuration.
- TokenConfigurationProperties() - Constructor for class io.micronaut.security.token.config.TokenConfigurationProperties
- TokenCookieClearerLogoutHandler - Class in io.micronaut.security.token.cookie
-
Clears the cookie configured via
CookieLoginHandler. - TokenCookieClearerLogoutHandler(AccessTokenCookieConfiguration, RefreshTokenCookieConfiguration, RedirectConfiguration, RedirectService) - Constructor for class io.micronaut.security.token.cookie.TokenCookieClearerLogoutHandler
- TokenCookieConfiguration - Interface in io.micronaut.security.config
-
Represents configuration for a cookie that will store a token.
- TokenCookieConfigurationProperties - Class in io.micronaut.security.token.cookie
- TokenCookieConfigurationProperties() - Constructor for class io.micronaut.security.token.cookie.TokenCookieConfigurationProperties
- TokenCookieLoginHandler - Class in io.micronaut.security.token.cookie
- TokenCookieLoginHandler(RedirectService, RedirectConfiguration, AccessTokenCookieConfiguration, RefreshTokenCookieConfiguration, AccessTokenConfiguration, AccessRefreshTokenGenerator, PriorToLoginPersistence<HttpRequest<?>, MutableHttpResponse<?>>) - Constructor for class io.micronaut.security.token.cookie.TokenCookieLoginHandler
- TokenCookieTokenReader - Class in io.micronaut.security.token.cookie
-
Reads the token from the configured io.micronaut.security.token.jwt.cookie.
- TokenCookieTokenReader(AccessTokenCookieConfiguration) - Constructor for class io.micronaut.security.token.cookie.TokenCookieTokenReader
- tokenGenerator - Variable in class io.micronaut.security.token.generator.DefaultAccessRefreshTokenGenerator
- TokenGenerator - Interface in io.micronaut.security.token.generator
-
Responsible for generating token strings.
- tokenInfo(IntrospectionRequest, HttpRequest<?>) - Method in class io.micronaut.security.endpoints.introspection.IntrospectionController
- tokenPropagationConfiguration - Variable in class io.micronaut.security.token.propagation.TokenPropagationHttpClientFilter
- TokenPropagationConfiguration - Interface in io.micronaut.security.token.propagation
-
Token propagation Configuration.
- TokenPropagationConfigurationProperties - Class in io.micronaut.security.token.propagation
-
Token Propagation Configuration Properties.
- TokenPropagationConfigurationProperties() - Constructor for class io.micronaut.security.token.propagation.TokenPropagationConfigurationProperties
- TokenPropagationHttpClientFilter - Class in io.micronaut.security.token.propagation
-
HttpClientFilterto enable Token propagation. - TokenPropagationHttpClientFilter(TokenPropagationConfiguration, OutgoingHttpRequestProcessor, TokenPropagator) - Constructor for class io.micronaut.security.token.propagation.TokenPropagationHttpClientFilter
- tokenPropagator - Variable in class io.micronaut.security.token.propagation.TokenPropagationHttpClientFilter
- TokenPropagator - Interface in io.micronaut.security.token.propagation
-
Responsible for retrieving and writing tokens for the purpose of propagation between services.
- TokenReader<T> - Interface in io.micronaut.security.token.reader
-
Responsible for reading the token data from a request.
- TokenRefreshRequest - Class in io.micronaut.security.endpoints
-
Encapsulate the request to get a new access token.
- TokenRefreshRequest(String, String) - Constructor for class io.micronaut.security.endpoints.TokenRefreshRequest
- tokenRenderer - Variable in class io.micronaut.security.token.generator.DefaultAccessRefreshTokenGenerator
- TokenRenderer - Interface in io.micronaut.security.token.render
-
Responsible for converting token information to an
AccessRefreshToken. - TokenResolver<T> - Interface in io.micronaut.security.token.reader
-
Returns the token from the provided request.
- TokenValidatedEvent - Class in io.micronaut.security.event
-
Triggered when a token is validated.
- TokenValidatedEvent(Object) - Constructor for class io.micronaut.security.event.TokenValidatedEvent
-
Triggered when a token is validated.
- tokenValidatedEventPublisher - Variable in class io.micronaut.security.token.TokenAuthenticationFetcher
- TokenValidator<T> - Interface in io.micronaut.security.token.validator
-
Responsible for token validation and claims retrieval.
- tokenValidators - Variable in class io.micronaut.security.endpoints.introspection.DefaultIntrospectionProcessor
- tokenValidators - Variable in class io.micronaut.security.token.TokenAuthenticationFetcher
- toSecondsSinceEpoch(Date) - Static method in class io.micronaut.security.endpoints.introspection.DefaultIntrospectionProcessor
- toString() - Method in enum class io.micronaut.security.authentication.AuthenticationMode
- toString() - Method in class io.micronaut.security.endpoints.introspection.IntrospectionRequest
- toString() - Method in enum class io.micronaut.security.errors.IssuingAnAccessTokenErrorCode
- toString() - Method in enum class io.micronaut.security.errors.ObtainingAuthorizationErrorCode
U
- UNAUTHORIZED_CLIENT - Enum constant in enum class io.micronaut.security.errors.IssuingAnAccessTokenErrorCode
- UNAUTHORIZED_CLIENT - Enum constant in enum class io.micronaut.security.errors.ObtainingAuthorizationErrorCode
- UnauthorizedRedirectConfiguration - Interface in io.micronaut.security.config
-
Configuration about where to redirect if unauthorized.
- UnauthorizedRedirectConfigurationProperties() - Constructor for class io.micronaut.security.config.RedirectConfigurationProperties.UnauthorizedRedirectConfigurationProperties
- unauthorizedUrl() - Method in class io.micronaut.security.config.DefaultRedirectService
- unauthorizedUrl() - Method in interface io.micronaut.security.config.RedirectService
- UNKNOWN - Enum constant in enum class io.micronaut.security.authentication.AuthenticationFailureReason
-
An unknown failure.
- UNKNOWN - Enum constant in enum class io.micronaut.security.rules.SecurityRuleResult
-
The rule has no information to make the determination.
- UNSUPPORTED_GRANT_TYPE - Enum constant in enum class io.micronaut.security.errors.IssuingAnAccessTokenErrorCode
- UNSUPPORTED_RESPONSE_TYPE - Enum constant in enum class io.micronaut.security.errors.ObtainingAuthorizationErrorCode
- uriPattern - Variable in class io.micronaut.security.token.propagation.AbstractOutgoingRequestProcessorMatcher
- uriRegex - Variable in class io.micronaut.security.token.propagation.AbstractOutgoingRequestProcessorMatcher
- USER_DISABLED - Enum constant in enum class io.micronaut.security.authentication.AuthenticationFailureReason
-
Failure when the cause is the user account is disabled.
- USER_NOT_FOUND - Enum constant in enum class io.micronaut.security.authentication.AuthenticationFailureReason
-
Failure when the cause is the user is not found.
- username() - Method in class io.micronaut.security.utils.DefaultSecurityService
-
Get the username of the current user.
- username() - Method in interface io.micronaut.security.utils.SecurityService
-
Get the username of the current user.
- USERNAME - Static variable in class io.micronaut.security.endpoints.introspection.DefaultIntrospectionProcessor
- usernameForClaims(Claims) - Method in class io.micronaut.security.token.AbstractTokenAuthenticationFactory
- UsernamePasswordCredentials - Class in io.micronaut.security.authentication
- UsernamePasswordCredentials(String, String) - Constructor for class io.micronaut.security.authentication.UsernamePasswordCredentials
V
- validate(String) - Method in interface io.micronaut.security.token.validator.RefreshTokenValidator
- validateToken(String, T) - Method in interface io.micronaut.security.token.validator.TokenValidator
-
Validates the provided token and returns the authentication state.
- valueOf(String) - Static method in enum class io.micronaut.security.authentication.AuthenticationFailureReason
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.micronaut.security.authentication.AuthenticationMode
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.micronaut.security.config.AuthenticationStrategy
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.micronaut.security.errors.IssuingAnAccessTokenErrorCode
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.micronaut.security.errors.ObtainingAuthorizationErrorCode
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.micronaut.security.rules.SecurityRuleResult
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class io.micronaut.security.authentication.AuthenticationFailureReason
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.micronaut.security.authentication.AuthenticationMode
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.micronaut.security.config.AuthenticationStrategy
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.micronaut.security.errors.IssuingAnAccessTokenErrorCode
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.micronaut.security.errors.ObtainingAuthorizationErrorCode
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.micronaut.security.rules.SecurityRuleResult
-
Returns an array containing the constants of this enum class, in the order they are declared.
W
- writeToken(MutableHttpRequest<?>, String) - Method in class io.micronaut.security.token.propagation.HttpHeaderTokenPropagator
-
Writes the token to the request.
- writeToken(MutableHttpRequest<?>, String) - Method in interface io.micronaut.security.token.propagation.TokenPropagator
-
Writes the token to the request.
X
- X509Authentication - Class in io.micronaut.security.x509
-
An Authentication derived from an X509Certificate.
- X509Authentication(String, X509Certificate) - Constructor for class io.micronaut.security.x509.X509Authentication
- X509Authentication(String, X509Certificate, Collection<String>, Map<String, Object>) - Constructor for class io.micronaut.security.x509.X509Authentication
- X509AuthenticationArgumentBinder - Class in io.micronaut.security.x509
-
Binds the authentication if it's an
X509Authenticationto a route argument. - X509AuthenticationArgumentBinder() - Constructor for class io.micronaut.security.x509.X509AuthenticationArgumentBinder
- X509AuthenticationFetcher - Class in io.micronaut.security.x509
-
Creates an Authentication if an X.509 client certificate is present and a name (CN) can be extracted.
- X509AuthenticationFetcher(X509Configuration) - Constructor for class io.micronaut.security.x509.X509AuthenticationFetcher
- X509Configuration - Interface in io.micronaut.security.x509
-
X.509 authentication configuration.
- X509ConfigurationProperties - Class in io.micronaut.security.x509
-
Configuration for X.509 authentication.
- X509ConfigurationProperties() - Constructor for class io.micronaut.security.x509.X509ConfigurationProperties
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
DefaultTokenResolver(java.util.List<io.micronaut.security.token.reader.TokenReader<io.micronaut.http.HttpRequest<?>>>)instead.