litestar-security 0.1.0__py3-none-any.whl

litestar_security/__init__.py

@@ -0,0 +1,194 @@
+"""Public package exports for Litestar Security."""
+
+from typing import TYPE_CHECKING, Any
+
+from litestar_security.__metadata__ import __project__, __version__
+from litestar_security.authentication import (
+    Authenticated,
+    AuthenticationMechanism,
+    AuthenticationOutcome,
+    AuthenticationPolicy,
+    AuthenticationRegistry,
+    AuthorizationResolver,
+    CredentialExtraction,
+    CredentialSlot,
+    IdentityResolution,
+    IdentityResolver,
+    InvalidCredentials,
+    MechanismRequirement,
+    NoCredentials,
+    PresentedCredential,
+    RequestAuthenticator,
+    VerificationUnavailable,
+    all_of,
+    any_of,
+    at_least,
+    mechanism,
+    optional,
+    public,
+    required,
+)
+from litestar_security.config import BlockingIntegration, ExternalCSRF, MFAConfig, PasskeyConfig, SecurityConfig
+from litestar_security.context import (
+    AuthenticationEvidence,
+    AuthorizationSnapshot,
+    CredentialRestrictions,
+    LitestarSessionHandle,
+    NullSessionHandle,
+    Principal,
+    ResourcePermission,
+    SecurityContext,
+    SessionHandle,
+    SessionPersistenceUnavailableError,
+    SessionUnavailableError,
+    intersect_authorization,
+)
+from litestar_security.guards import (
+    AssuranceRequirement,
+    AssuranceTrait,
+    AuthorizationDecision,
+    AuthorizationPredicate,
+    requires_assurance,
+    requires_authenticated,
+    requires_capability,
+    requires_role,
+    requires_scope,
+    requires_team_role,
+    requires_tenant,
+)
+from litestar_security.guards import all_of as guard_all_of
+from litestar_security.guards import any_of as guard_any_of
+from litestar_security.guards import at_least as guard_at_least
+from litestar_security.guards import one_of as guard_one_of
+from litestar_security.headers import ContentSecurityPolicy, CSPMode, SecurityHeadersConfig, csp_nonce
+from litestar_security.plugin import CurrentUser, SecurityPlugin
+from litestar_security.websocket import (
+    AuthorizationSnapshotRefresher,
+    InMemoryWebSocketTicketStore,
+    IssuedWebSocketTicket,
+    WebSocketBinding,
+    WebSocketCloseCodes,
+    WebSocketRevocationSource,
+    WebSocketSecurityConfig,
+    WebSocketTicketRecord,
+    WebSocketTicketService,
+    WebSocketTicketStore,
+    issue_websocket_ticket,
+    websocket_policy_fingerprint,
+)
+
+if TYPE_CHECKING:
+    from litestar_security.providers.oauth import (
+        GitHubOAuthProvider,
+        OAuthAccountService,
+        OAuthAccountStore,
+        OAuthConfig,
+        OAuthProvider,
+        OAuthRouteService,
+        TokenVault,
+    )
+
+__all__ = (
+    "AssuranceRequirement",
+    "AssuranceTrait",
+    "Authenticated",
+    "AuthenticationEvidence",
+    "AuthenticationMechanism",
+    "AuthenticationOutcome",
+    "AuthenticationPolicy",
+    "AuthenticationRegistry",
+    "AuthorizationDecision",
+    "AuthorizationPredicate",
+    "AuthorizationResolver",
+    "AuthorizationSnapshot",
+    "AuthorizationSnapshotRefresher",
+    "BlockingIntegration",
+    "CSPMode",
+    "ContentSecurityPolicy",
+    "CredentialExtraction",
+    "CredentialRestrictions",
+    "CredentialSlot",
+    "CurrentUser",
+    "ExternalCSRF",
+    "GitHubOAuthProvider",
+    "IdentityResolution",
+    "IdentityResolver",
+    "InMemoryWebSocketTicketStore",
+    "InvalidCredentials",
+    "IssuedWebSocketTicket",
+    "LitestarSessionHandle",
+    "MFAConfig",
+    "MechanismRequirement",
+    "NoCredentials",
+    "NullSessionHandle",
+    "OAuthAccountService",
+    "OAuthAccountStore",
+    "OAuthConfig",
+    "OAuthProvider",
+    "OAuthRouteService",
+    "PasskeyConfig",
+    "PresentedCredential",
+    "Principal",
+    "RequestAuthenticator",
+    "ResourcePermission",
+    "SecurityConfig",
+    "SecurityContext",
+    "SecurityHeadersConfig",
+    "SecurityPlugin",
+    "SessionHandle",
+    "SessionPersistenceUnavailableError",
+    "SessionUnavailableError",
+    "TokenVault",
+    "VerificationUnavailable",
+    "WebSocketBinding",
+    "WebSocketCloseCodes",
+    "WebSocketRevocationSource",
+    "WebSocketSecurityConfig",
+    "WebSocketTicketRecord",
+    "WebSocketTicketService",
+    "WebSocketTicketStore",
+    "__project__",
+    "__version__",
+    "all_of",
+    "any_of",
+    "at_least",
+    "csp_nonce",
+    "guard_all_of",
+    "guard_any_of",
+    "guard_at_least",
+    "guard_one_of",
+    "intersect_authorization",
+    "issue_websocket_ticket",
+    "mechanism",
+    "optional",
+    "public",
+    "required",
+    "requires_assurance",
+    "requires_authenticated",
+    "requires_capability",
+    "requires_role",
+    "requires_scope",
+    "requires_team_role",
+    "requires_tenant",
+    "websocket_policy_fingerprint",
+)
+
+_OAUTH_EXPORTS = frozenset({
+    "GitHubOAuthProvider",
+    "OAuthAccountService",
+    "OAuthAccountStore",
+    "OAuthConfig",
+    "OAuthProvider",
+    "OAuthRouteService",
+    "TokenVault",
+})
+
+
+def __getattr__(name: str) -> Any:  # noqa: ANN401 - module lazy-export hooks are dynamically typed
+    """Resolve curated OAuth exports without loading providers at root import."""
+    if name in _OAUTH_EXPORTS:
+        from litestar_security import providers  # noqa: PLC0415 - preserve lightweight package-root imports
+
+        return getattr(providers, name)
+    message = f"module {__name__!r} has no attribute {name!r}"
+    raise AttributeError(message)

litestar_security/__metadata__.py

@@ -0,0 +1,12 @@
+"""Package metadata."""
+
+from importlib.metadata import PackageNotFoundError, metadata, version
+
+__all__ = ("__project__", "__version__")
+
+try:
+    __version__ = version("litestar-security")
+    __project__ = metadata("litestar-security")["Name"]
+except PackageNotFoundError:  # pragma: no cover
+    __version__ = "0.1.0"
+    __project__ = "litestar-security"

litestar_security/_cli.py

@@ -0,0 +1,28 @@
+"""CLI commands for Litestar Security."""
+
+from typing import TYPE_CHECKING
+
+import click
+
+from litestar_security.__metadata__ import __project__, __version__
+
+if TYPE_CHECKING:
+    from click import Group
+
+__all__ = ("register", "security_group")
+
+
+@click.group(name="security", help="Litestar Security operations.", no_args_is_help=True)
+@click.version_option(version=__version__, prog_name=__project__)
+def security_group() -> None:
+    """Manage Litestar Security integrations."""
+
+
+def register(cli: "Group") -> None:
+    """Attach the security command group to a Click group once.
+
+    Args:
+        cli: The Click group to attach to. Calling this repeatedly is safe.
+    """
+    if security_group.name not in cli.commands:
+        cli.add_command(security_group)