Index (flash-ext-security-core 2.1.0-6a6431c API)

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

A

authenticate(Request) - Method in interface dev.relism.flash.ext.security.AuthenticationMechanism: The caller, or null when the request carries no credential of this kind.
authenticate(Request) - Method in class dev.relism.flash.ext.security.SecurityExtension: The caller, or null when no mechanism recognises a credential.
Authenticated - Annotation Interface in dev.relism.flash.ext.security: The handler or MCP tool requires an authenticated caller.
AUTHENTICATED - Static variable in class dev.relism.flash.ext.security.SecurityPolicy: Any authenticated caller.
AuthenticationEntryPoint - Interface in dev.relism.flash.ext.security: Answers a request that needs a caller and carries no credential at all.
AuthenticationFailedException - Exception Class in dev.relism.flash.ext.security: A credential was presented and rejected.
AuthenticationFailedException(String) - Constructor for exception class dev.relism.flash.ext.security.AuthenticationFailedException
AuthenticationMechanism - Interface in dev.relism.flash.ext.security: Reads one kind of credential off a request.

B

bearer(String, String) - Static method in record class dev.relism.flash.ext.security.SecurityScheme

C

challenge() - Method in exception class dev.relism.flash.ext.security.AuthenticationFailedException
challenge() - Method in record class dev.relism.flash.ext.security.SecurityScheme: Returns the value of the challenge record component.
commence(Request, Response) - Method in interface dev.relism.flash.ext.security.AuthenticationEntryPoint
configure(FlashRegistrar<?>, FlashContext) - Method in class dev.relism.flash.ext.security.SecurityExtension
current() - Static method in class dev.relism.flash.ext.security.SecurityIdentity: The caller of the request this thread is handling; null when it is anonymous.

D

definition() - Method in record class dev.relism.flash.ext.security.SecurityScheme: Returns the value of the definition record component.
delete(String) - Method in class dev.relism.flash.ext.security.InMemorySessionStore
delete(String) - Method in interface dev.relism.flash.ext.security.SessionStore
dev.relism.flash.ext.security - package dev.relism.flash.ext.security

E

enforce(SecurityPolicy) - Method in class dev.relism.flash.ext.security.SecurityExtension
enforce(SecurityPolicy, AuthenticationEntryPoint) - Method in class dev.relism.flash.ext.security.SecurityExtension: anonymous answers a caller without credentials on this route instead of the configured entry point.
enforce(SecurityPolicy, AuthenticationEntryPoint, List<AuthenticationMechanism>) - Method in class dev.relism.flash.ext.security.SecurityExtension: A route only mechanisms authenticate: every other credential, the session cookie included, is no credential at all here — a bearer route that must not be reached with a browser's cookie or with another mechanism's token.
entryPoint(AuthenticationEntryPoint) - Method in class dev.relism.flash.ext.security.SecurityExtension: Replaces the default: a browser is redirected to sign in, anything else gets 401 with every challenge.
equals(Object) - Method in record class dev.relism.flash.ext.security.LoginMethod: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class dev.relism.flash.ext.security.SecurityScheme: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class dev.relism.flash.ext.security.Session: Indicates whether some other object is "equal to" this one.
expiresAt() - Method in record class dev.relism.flash.ext.security.Session: Returns the value of the expiresAt record component.

F

fillInStackTrace() - Method in exception class dev.relism.flash.ext.security.AuthenticationFailedException
find(String) - Method in class dev.relism.flash.ext.security.InMemorySessionStore
find(String) - Method in interface dev.relism.flash.ext.security.SessionStore: The session, or null.
FORM - Enum constant in enum class dev.relism.flash.ext.security.LoginMethod.Kind: A client posts username and password to url.

G

get(String) - Method in interface dev.relism.flash.ext.security.Target: The value called name, or null when the call does not carry one.

H

hasAudience(String) - Method in interface dev.relism.flash.ext.security.Principal: Whether the credential was issued for audience (RFC 8707).
hashCode() - Method in record class dev.relism.flash.ext.security.LoginMethod: Returns a hash code value for this object.
hashCode() - Method in record class dev.relism.flash.ext.security.SecurityScheme: Returns a hash code value for this object.
hashCode() - Method in record class dev.relism.flash.ext.security.Session: Returns a hash code value for this object.
hasRole(SecurityIdentity, String, Target) - Method in interface dev.relism.flash.ext.security.RoleResolver
hasRole(String) - Method in class dev.relism.flash.ext.security.SecurityIdentity
hasRole(String, Target) - Method in class dev.relism.flash.ext.security.SecurityIdentity
hasScope(String) - Method in interface dev.relism.flash.ext.security.Principal: Whether the credential grants scope.
hasScope(String) - Method in class dev.relism.flash.ext.security.SecurityIdentity

I

id() - Method in record class dev.relism.flash.ext.security.LoginMethod: Returns the value of the id record component.
id() - Method in record class dev.relism.flash.ext.security.Session: Returns the value of the id record component.
InMemorySessionStore - Class in dev.relism.flash.ext.security: One instance's sessions, lost on restart.
InMemorySessionStore() - Constructor for class dev.relism.flash.ext.security.InMemorySessionStore
issuer() - Method in record class dev.relism.flash.ext.security.SecurityScheme: Returns the value of the issuer record component.

K

kind() - Method in record class dev.relism.flash.ext.security.LoginMethod: Returns the value of the kind record component.

L

loginMethod(LoginMethod) - Method in class dev.relism.flash.ext.security.SecurityExtension
LoginMethod - Record Class in dev.relism.flash.ext.security: A way to sign in, listed at GET /auth/methods for a client to offer.
LoginMethod(String, String, String, LoginMethod.Kind) - Constructor for record class dev.relism.flash.ext.security.LoginMethod: Creates an instance of a LoginMethod record class.
LoginMethod.Kind - Enum Class in dev.relism.flash.ext.security
loginPage(String) - Method in class dev.relism.flash.ext.security.SecurityExtension: Where a browser signs in.
logoutUrl() - Method in interface dev.relism.flash.ext.security.Principal: Where signing out sends the browser; null for the application root.

M

mechanism(AuthenticationMechanism) - Method in class dev.relism.flash.ext.security.SecurityExtension

N

name() - Method in record class dev.relism.flash.ext.security.LoginMethod: Returns the value of the name record component.
name() - Method in interface dev.relism.flash.ext.security.Principal: Unique within the mechanism that produced it.
name() - Method in record class dev.relism.flash.ext.security.SecurityScheme: Returns the value of the name record component.
NONE - Static variable in interface dev.relism.flash.ext.security.Target: A role checked on nothing in particular.

O

of(Class<?>) - Static method in class dev.relism.flash.ext.security.SecurityPolicy: The policy type declares, or null when it carries no security annotation.
on() - Element in annotation interface dev.relism.flash.ext.security.RolesAllowed: Names of the path or query parameters (tool arguments on MCP) that identify the resource the role is held on — on = "project" checks the role on /projects/{project}.
openIdConnect(String, String) - Static method in record class dev.relism.flash.ext.security.SecurityScheme
origin(Request) - Method in class dev.relism.flash.ext.security.SecurityExtension: The configured SecurityExtension.origin(String), or the one req names when none is.
origin(String) - Method in class dev.relism.flash.ext.security.SecurityExtension: Where the application is served, e.g.

P

PermitAll - Annotation Interface in dev.relism.flash.ext.security: Anyone may call the handler.
permitsRoles(SecurityIdentity, Target) - Method in class dev.relism.flash.ext.security.SecurityPolicy
permitsScopes(SecurityIdentity) - Method in class dev.relism.flash.ext.security.SecurityPolicy
policy(Class<?>) - Method in class dev.relism.flash.ext.security.SecurityExtension: The policy type's annotations declare, checked against this configuration — declaring roles without a RoleResolver fails here, at boot.
POLICY - Static variable in class dev.relism.flash.ext.security.SecurityExtension: The node security annotations mount under, for middleware that must run before or after it.
principal() - Method in class dev.relism.flash.ext.security.SecurityIdentity
principal() - Method in record class dev.relism.flash.ext.security.Session: Returns the value of the principal record component.
principal(Class<P>) - Method in class dev.relism.flash.ext.security.SecurityIdentity: The principal as type, or null when another mechanism authenticated the caller.
Principal - Interface in dev.relism.flash.ext.security: Who an AuthenticationMechanism proved the caller to be.
PublicUrl - Class in dev.relism.flash.ext.security: The guard for a URL someone other than the operator chose — an identity provider an organization registers, a client's metadata document: fetching it must not become a request forgery against the server's own network.

R

REDIRECT - Enum constant in enum class dev.relism.flash.ext.security.LoginMethod.Kind: A browser navigates to url and comes back signed in — OpenID Connect, for instance.
refresh(Session) - Method in interface dev.relism.flash.ext.security.SessionRefresher
refresher(Class<? extends Principal>, SessionRefresher) - Method in class dev.relism.flash.ext.security.SecurityExtension
request() - Method in class dev.relism.flash.ext.security.SecurityIdentity: The request being authorized.
require(String) - Static method in class dev.relism.flash.ext.security.PublicUrl: ponytail: resolved here and again by the HTTP client, so DNS rebinding between the two is not covered.
required() - Method in class dev.relism.flash.ext.security.SecurityPolicy: False only for PermitAll.
requiresRoles() - Method in class dev.relism.flash.ext.security.SecurityPolicy
resolve(Principal) - Method in interface dev.relism.flash.ext.security.UserResolver
RoleResolver - Interface in dev.relism.flash.ext.security: Whether a caller holds a role — read from a token, a database, anywhere.
roles(RoleResolver) - Method in class dev.relism.flash.ext.security.SecurityExtension: Required by RolesAllowed; a handler that declares roles without one fails the boot.
RolesAllowed - Annotation Interface in dev.relism.flash.ext.security: The caller must hold at least one of these roles, as decided by the configured RoleResolver.

S

save(Session) - Method in class dev.relism.flash.ext.security.InMemorySessionStore
save(Session) - Method in interface dev.relism.flash.ext.security.SessionStore
schemes() - Method in interface dev.relism.flash.ext.security.AuthenticationMechanism: How OpenAPI documents each credential this mechanism reads, and how a 401 challenges for it.
schemes() - Method in class dev.relism.flash.ext.security.SecurityExtension: The schemes of every registered mechanism, in registration order.
ScopesAllowed - Annotation Interface in dev.relism.flash.ext.security: The caller's credential must grant every one of these scopes.
SecurityExtension - Class in dev.relism.flash.ext.security: Flash security: the authentication chain, the policies security annotations declare, sessions, and the /auth/logout and /auth/methods routes.
SecurityExtension() - Constructor for class dev.relism.flash.ext.security.SecurityExtension
SecurityIdentity - Class in dev.relism.flash.ext.security: The authenticated caller of the current request: the Principal a mechanism produced, the application user it resolves to, and the roles and scopes it holds.
SecurityPolicy - Class in dev.relism.flash.ext.security: What a handler's or tool's security annotations require, compiled once at boot.
SecurityScheme - Record Class in dev.relism.flash.ext.security: A credential as OpenAPI names and defines it, the WWW-Authenticate challenge an anonymous API call receives for it, and — for OAuth — the issuer that grants it.
SecurityScheme(String, Map<String, Object>, String, String) - Constructor for record class dev.relism.flash.ext.security.SecurityScheme: Creates an instance of a SecurityScheme record class.
Session - Record Class in dev.relism.flash.ext.security: A signed-in principal, kept server-side under the id its cookie carries.
Session(String, Principal, Instant) - Constructor for record class dev.relism.flash.ext.security.Session: Creates an instance of a Session record class.
SessionRefresher - Interface in dev.relism.flash.ext.security: Renews an expired session — with a refresh token, typically.
sessions(SessionStore) - Method in class dev.relism.flash.ext.security.SecurityExtension
SessionStore - Interface in dev.relism.flash.ext.security: Where sessions live.
sessionTimeout(Duration) - Method in class dev.relism.flash.ext.security.SecurityExtension
signIn(Request, Response, Principal) - Method in class dev.relism.flash.ext.security.SecurityExtension: Starts a session for principal lasting the configured timeout.
signIn(Request, Response, Principal, Instant) - Method in class dev.relism.flash.ext.security.SecurityExtension
signOut(Request, Response) - Method in class dev.relism.flash.ext.security.SecurityExtension: Ends the caller's session and returns where the browser goes next.

T

Target - Interface in dev.relism.flash.ext.security: The resource a role is checked on: the values RolesAllowed.on() names, read from path and query parameters on HTTP and from tool arguments on MCP.
toString() - Method in record class dev.relism.flash.ext.security.LoginMethod: Returns a string representation of this record class.
toString() - Method in record class dev.relism.flash.ext.security.SecurityScheme: Returns a string representation of this record class.
toString() - Method in record class dev.relism.flash.ext.security.Session: Returns a string representation of this record class.

U

url() - Method in record class dev.relism.flash.ext.security.LoginMethod: Returns the value of the url record component.
user(Class<U>) - Method in class dev.relism.flash.ext.security.SecurityIdentity: The application user, resolved once per request by the configured UserResolver.
UserResolver<U> - Interface in dev.relism.flash.ext.security: The application user a verified principal belongs to — typically found, or provisioned, by issuer and subject.
users(UserResolver<?>) - Method in class dev.relism.flash.ext.security.SecurityExtension: Resolves SecurityIdentity.user — default: the principal itself.

V

value() - Element in annotation interface dev.relism.flash.ext.security.RolesAllowed
value() - Element in annotation interface dev.relism.flash.ext.security.ScopesAllowed
valueOf(String) - Static method in enum class dev.relism.flash.ext.security.LoginMethod.Kind: Returns the enum constant of this class with the specified name.
values() - Static method in enum class dev.relism.flash.ext.security.LoginMethod.Kind: Returns an array containing the constants of this enum class, in the order they are declared.

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