Skip to content

System Architecture

Canonical architecture narrative for FastAPI RBAC. AI harness files and agent guides should link here instead of duplicating this content.

Related:

High-level architecture

┌───────────────────┐      ┌───────────────────┐      ┌───────────────────┐
│  React Frontend   │◄────►│  FastAPI Backend  │◄────►│  PostgreSQL       │
└───────────────────┘      └─────────┬─────────┘      └───────────────────┘
                                     │
                                     ▼
                           ┌───────────────────┐
                           │  Redis            │
                           │  (token allowlist │
                           │   + Celery broker)│
                           └───────────────────┘

The project is a user-management microservice: authentication and authorization for other services.

Layer Stack
Backend FastAPI, SQLAlchemy/SQLModel, Redis, Celery
Frontend React, TypeScript, Redux Toolkit, ShadCN UI
Data PostgreSQL (persistent), Redis (sessions / cache / broker)

Backend layers

API layer

  • Route handlers: backend/app/api/v1/endpoints/
  • Shared dependencies: backend/app/api/deps.py
  • Request/response validation: Pydantic schemas in backend/app/schemas/
  • Versioned under /api/v1

Persistence and domain

  • Models: backend/app/models/ (SQLModel)
  • CRUD: backend/app/crud/
  • Migrations: backend/alembic/
  • Resource-specific deps: backend/app/deps/

Security and infrastructure

  • JWT + password helpers: backend/app/core/security.py (PyJWT)
  • Settings: backend/app/core/config.py
  • Redis session allowlist: backend/app/utils/token.py
  • Celery: backend/app/celery_app.py, workers, beat schedule

Frontend layers

  • Feature modules: react-frontend/src/features/ (auth, users, roles, permissions, …)
  • Shared UI: react-frontend/src/components/ (auth, layout, ShadCN ui/)
  • API clients: react-frontend/src/services/
  • Redux store: react-frontend/src/store/
  • Types: react-frontend/src/models/
  • Hooks: react-frontend/src/hooks/ (useAuth, usePermissions, …)

See Frontend — React architecture for patterns.

Key directory layout

High-level trees only. Prefer the repo (or graphify) over copying leaf-level trees into harness files.

Backend

backend/
├── alembic/                 # Migrations
├── app/
│   ├── api/                 # deps + v1 endpoints
│   ├── core/                # config, security, celery config
│   ├── crud/                # DB operations
│   ├── db/                  # session, init
│   ├── deps/                # resource dependencies
│   ├── models/              # SQLModel entities
│   ├── schemas/             # Pydantic API schemas
│   ├── utils/               # token allowlist, email, audit, …
│   ├── main.py              # FastAPI entry
│   └── …                    # celery, email templates, startup
└── test/                    # unit + integration suite

Frontend

react-frontend/
├── src/
│   ├── components/          # auth, layout, ui
│   ├── features/            # domain feature modules
│   ├── hooks/
│   ├── lib/
│   ├── models/              # TypeScript interfaces
│   ├── pages/
│   ├── services/            # Axios API layer
│   └── store/               # Redux Toolkit
├── package.json
└── vite.config.ts

Domain model

Core RBAC terms (see domain docs): user, role, permission, role group, permission group.

Concept Backend model Notes
User user_model.py Credentials, profile, lockout / verification fields; roles via UserRole
Role role_model.py Named roles; permissions via RolePermission; optional role group
Permission permission_model.py Granular actions (user.create, …); belongs to a permission group
Role group role_group_model.py Hierarchical grouping via RoleGroupMap
Permission group permission_group_model.py Logical grouping of permissions
Password history password_history_model.py Reuse prevention / audit
Audit log audit_log_model.py Security / activity events

Mapping tables: UserRole, RolePermission, RoleGroupMap.

Frontend mirrors these in react-frontend/src/models/ (user.ts, role.ts, permission.ts, roleGroup.ts, auth.ts, …).

Authentication flow

Session invalidation uses a Redis allowlist (user:{id}:{token_type} in app/utils/token.py), not a JWT jti blacklist. See ADR 0001.

  1. Login — POST /api/v1/auth/login validates credentials, issues access + refresh tokens, records tokens on the Redis allowlist.
  2. Authenticated requests — client sends Authorization: Bearer <access_token>; backend verifies signature/expiry and that the token remains allowlisted.
  3. Refresh — on 401, frontend uses the refresh token; backend rotates tokens and updates the allowlist. Failed refresh → logout.
  4. Logout — POST /api/v1/auth/logout removes allowlist entries; frontend clears in-memory access token and stored refresh token.

Frontend storage strategy:

  • Access token: memory (Redux) — reduces XSS exposure vs long-lived localStorage access tokens
  • Refresh token: localStorage, cleared on logout / failed refresh

Security architecture (summary)

  • JWT access/refresh with Redis allowlist invalidation
  • bcrypt passwords, history, lockout
  • RBAC via roles and permissions on protected routes
  • CSRF, rate limiting, input sanitization, security headers

Details: Security Features. Deep session analysis lives under docs/SESSION_SECURITY_*.md (historical / design notes; prefer this page + ADR for current behavior).

Deployment sketch

Docker Compose for local and environment-scoped production layouts; Alembic for schema; Celery workers for email and background work. See Deployment.