Flaxon 0.3.0 and Teloce-Py 0.3.0 are available on PyPI. Release instructions are maintained on this site; source links identify the framework snapshot. Check version and upgrade guidance.

Security API

JWTBackend

JWT authentication backend.

Constructor

JWTBackend(
    secret_key: str,
    algorithm: str = "HS256"
)
````

## Methods

### authenticate

```python
async def authenticate(
    request: Request
) -> User | None

Authenticate a request.

create_token

async def create_token(
    user: User,
    expires_in: int | None = None
) -> str

Create a JWT token.

validate_token

async def validate_token(
    token: str
) -> User | None

Validate a JWT token.

revoke_token

async def revoke_token(
    token: str
) -> None

Revoke a token.

SessionBackend

Session authentication backend.

Constructor

SessionBackend(
    session_store: dict[str, dict[str, Any]] | None = None
)

Methods

authenticate

async def authenticate(
    request: Request
) -> User | None

Authenticate a request.

create_token

async def create_token(
    user: User,
    expires_in: int | None = None
) -> str

Create a session token.

validate_token

async def validate_token(
    token: str
) -> User | None

Validate a session token.

revoke_token

async def revoke_token(
    token: str
) -> None

Revoke a session.

User

Authenticated user object.

Constructor

User(
    id: str | int,
    username: str | None = None,
    email: str | None = None,
    roles: list[str] | None = None,
    permissions: list[str] | None = None,
    metadata: dict[str, Any] | None = None
)

Methods

has_role

def has_role(
    role: str
) -> bool

Check if the user has a role.

has_permission

def has_permission(
    permission: str
) -> bool

Check if the user has a permission.

to_dict

def to_dict() -> dict[str, Any]

Convert user data into a dictionary.

Authentication Decorators

login_required

login_required(
    func: Callable
) -> Callable

Decorator requiring authentication.

permission_required

permission_required(
    permission: str
) -> Callable

Decorator requiring a specific permission.

role_required

role_required(
    role: str
) -> Callable

Decorator requiring a specific role.

authorize

authorize(
    permission: str | None = None,
    role: str | None = None
) -> Callable

Decorator requiring permission and/or role authorization.

CSRF

Cross-Site Request Forgery protection.

Constructor

CSRF(
    secret_key: str,
    cookie_name: str = "_csrf",
    header_name: str = "x-csrf-token"
)

Methods

generate_token

def generate_token() -> str

Generate a CSRF token.

verify_token

def verify_token(
    token: str
) -> bool

Verify a CSRF token.

get_token_from_request

def get_token_from_request(
    request: Request
) -> str | None

Get a CSRF token from a request.

validate_request

def validate_request(
    request: Request
) -> None

Validate a request's CSRF token.

RateLimiter

Rate limiting utility.

Constructor

RateLimiter(
    requests: int = 60,
    window_seconds: int = 60,
    key_func: Callable[[dict[str, Any]], str] | None = None
)

Methods

check

async def check(
    scope: dict[str, Any]
) -> bool

Check whether the request exceeds the rate limit.

get_remaining

def get_remaining(
    scope: dict[str, Any]
) -> int

Get remaining allowed requests.

get_retry_after

def get_retry_after(
    scope: dict[str, Any]
) -> int

Get retry-after time in seconds.

APIKeyManager

API key management.

Methods

generate_key

def generate_key(
    prefix: str = "flx"
) -> tuple[str, str]

Generate a new API key.

register

def register(
    key: str,
    metadata: dict[str, Any] | None = None
) -> None

validate

def validate(
    key: str
) -> dict[str, Any] | None

Validate an API key.

revoke

def revoke(
    key: str
) -> None

Revoke an API key.

list_keys

def list_keys() -> list[dict[str, Any]]

List registered API keys.

Password Utilities

hash_password

hash_password(
    password: str
) -> str

Hash a password securely.

verify_password

verify_password(
    password: str,
    hashed: str
) -> bool

Verify a password against a hash.

needs_rehash

needs_rehash(
    hashed: str
) -> bool

Check whether a password hash needs to be regenerated.

Use this capability in a full-stack app

Flaxon serves Python APIs and Teloce interfaces in one project. Keep validation, authorization and privileged operations on the server; components call those endpoints and present their results. Follow the full-stack lessons and Teloce integration reference to connect this capability to pages, components and application modules.