auth library
Classes
- AuthAuditEvent
- AuthAuditLogger
- AuthChallenge
- Represents a challenge that should be sent to the client.
- AuthCredentialProvider
- Pluggable credential provider used by router authenticators.
- AuthCredentialRegistry
- Global registry for router authentication credential providers.
- AuthenticateMessage
- Represents the AUTHENTICATE frame from a client.
- Authenticator
- Base interface for all authenticators.
- AuthenticatorContext
- Contextual information passed to authenticators during the handshake.
- AuthenticatorDefinition
- Definition of an authenticator that can be referenced by realms/listeners.
- AuthenticatorFactory
- Factory responsible for creating authenticators for specific methods.
- AuthenticatorRegistry
- Registry for pluggable authenticator factories.
- AuthFailure
- Represents an authentication failure.
- AuthorizationProviderDefinition
- Definition of a realm authorization provider referenced by realm config.
- AuthResult
- Outcome of authentication handling.
- AuthSecurityTracker
- AuthSuccess
- Represents a successful authentication.
- BackpressureThrottleSettings
- Boss-side throttling thresholds derived from backpressure alerts.
- CraCredential
- Credential payload returned by AuthCredentialProvider.loadCra.
- CredentialLookupEvent
- Optional hook for delivering lookup result information to observers.
- CryptosignCredential
- Credential payload returned by AuthCredentialProvider.loadCryptosign.
- DiscloseSettings
- Disclose flags for permissions (caller/publisher callee IDs).
- Http3Settings
- HttpAuthProviderDefinition
- Definition of an HTTP bearer auth provider used by protected HTTP routes.
- HttpListenerSettings
- HttpRouteAction
- HttpRouteMatch
- HttpRouteRateLimitSettings
- HttpRouteSettings
- InternalRealmSettings
- InternalRealmSettingsBuilder
- ListenerSettings
- Listener/transport configuration (RawSocket, WebSocket, HTTP, ...).
- ListenerSettingsBuilder
- MetricsSettings
- Metrics configuration (OpenMetrics-compatible exporter, etc.).
- OpenMetricsSettings
- PermissionSettings
- Permission entry describing which operations are allowed or denied.
- PermissionSettingsBuilder
- RawSocketListenerSettings
- RealmAuthSettings
- Pluggable auth configuration for a realm.
- RealmLimitSettings
- Limits and timeouts applied at the realm level.
- RealmSettings
- Configuration for an individual realm.
- RealmSettingsBuilder
- RemoteAbortRequest
- RemoteAuthenticateRequest
- RemoteAuthenticateResponse
- RemoteAuthenticator
- RemoteAuthenticatorConfig
- RemoteAuthenticatorDelegate
- Delegate invoked for remote authentication decisions.
- RemoteAuthenticatorFactory
- RemoteAuthenticatorRegistry
- RemoteChallenge
- RemoteHelloRequest
- RemoteHelloResponse
- RoleSettings
- Role definition containing permissions for publish/subscribe/RPC actions.
- RoleSettingsBuilder
- RouterSettings
- Top-level router settings parsed from configuration.
- RouterSettingsBuilder
- Fluent builder for assembling RouterSettings programmatically.
- RouterSettingsEquality
- Equality helpers
- ScramCredential
- Credential payload returned by AuthCredentialProvider.loadScram.
- SessionProfileAuthSettings
- Authentication and identity defaults for a SessionProfileSettings.
- SessionProfileSettings
- Shared session/auth profile that multiple transports can reference.
- SessionProfileSettingsBuilder
- TicketCredential
- Credential payload returned by AuthCredentialProvider.loadTicket.
- TransportAlertSettings
- Alert thresholds for transport lifecycle events (GOAWAY, timeouts, errors).
- TransportMetadata
- Metadata describing the transport connection initiating authentication.
- WebSocketListenerSettings
- WorkerPoolSettings
Enums
- AuthAuditOutcome
- AuthStatus
- HttpRouteActionType
- ListenerProtocol
- Listener protocols that can be negotiated per endpoint.
- PermissionMatchPolicy
- Supported matching policies for role permissions.
- RemoteAuthenticateStatus
- RemoteHelloStatus
Extensions
- ListenerProtocolX on ListenerProtocol
- RouterSettingsOpenMetricsHttp on RouterSettings
-
Adds router-native HTTP routes for
metrics.open_metrics.listen.
Functions
-
authFailureFromRejection(
CredentialRejection rejection) → AuthFailure -
httpRouteActionTypeFromString(
String value) → HttpRouteActionType -
httpRouteActionTypeToString(
HttpRouteActionType type) → String -
listenerProtocolFromString(
String value) → ListenerProtocol -
listenerProtocolToString(
ListenerProtocol protocol) → String -
permissionMatchPolicyFromString(
String value) → PermissionMatchPolicy -
registerDefaultAuthenticators(
) → void - Registers the built-in authenticator factories. This should be invoked in every isolate that intends to use AuthenticatorRegistry.
Typedefs
- CredentialLookupListener = void Function(CredentialLookupEvent event)
Exceptions / Errors
- CredentialRejection
- Details describing why a credential lookup deliberately rejected access.