authloom 0.1.0a1__tar.gz

authloom-0.1.0a1/CHANGELOG.md

@@ -0,0 +1,20 @@
+# Changelog
+
+All notable changes to AuthLoom will be documented in this file.
+
+## 0.1.0a1 — 2026-07-30
+
+Initial alpha release of AuthLoom.
+
+### Included
+
+- Email/password signup and signin for FastAPI applications
+- Cookie-backed database sessions with expiry and signout revocation
+- Required and optional current-user dependencies
+- Argon2 password hashing, email normalization, and hashed session-token storage
+- Async SQLAlchemy integration with Alembic migration guidance
+- Basic credentials-authentication example and test coverage
+
+### Release status
+
+AuthLoom is pre-release software. APIs, configuration, and database integration details may change before the first stable release.

authloom-0.1.0a1/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

authloom-0.1.0a1/PKG-INFO

@@ -0,0 +1,238 @@
+Metadata-Version: 2.4
+Name: authloom
+Version: 0.1.0a1
+Summary: Authentication building blocks for FastAPI applications
+Keywords: fastapi,authentication
+Author: Sreekar Nutulapati
+Author-email: Sreekar Nutulapati <sreekarnv1@gmail.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: FastAPI
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Typing :: Typed
+Requires-Dist: argon2-cffi>=25.1.0
+Requires-Dist: cuid2>=2.0.1
+Requires-Dist: email-normalize>=3.1.0
+Requires-Dist: fastapi>=0.140.0
+Requires-Dist: pydantic-settings>=2.14.2
+Requires-Dist: pydantic[email]>=2.13.4
+Requires-Dist: sqlalchemy>=2.0.51
+Requires-Python: >=3.12
+Project-URL: Homepage, https://github.com/sreekarnv/authloom
+Project-URL: Repository, https://github.com/sreekarnv/authloom
+Project-URL: Issues, https://github.com/sreekarnv/authloom/issues
+Project-URL: Changelog, https://github.com/sreekarnv/authloom/blob/main/CHANGELOG.md
+Description-Content-Type: text/markdown
+
+# AuthLoom
+
+AuthLoom is a Python 3.12 authentication library for FastAPI applications.
+
+It currently provides email/password signup and signin, cookie-backed database sessions, required and optional current-user dependencies, Argon2 password hashing, normalized email handling, hashed session tokens, expiry, and signout revocation.
+
+AuthLoom is pre-release software. APIs and database integration details may change before the first stable release.
+
+## Installation
+
+Using `uv`:
+
+```bash
+uv add "authloom==0.1.0a1"
+```
+
+Using `pip`:
+
+```bash
+pip install "authloom==0.1.0a1"
+```
+
+## Requirements
+
+- Python `>=3.12`
+- FastAPI `>=0.140.0`
+- SQLAlchemy `>=2.0.51` with async sessions
+
+## Basic Usage
+
+Applications provide the async SQLAlchemy session factory and own database setup.
+
+```python
+from typing import Annotated
+
+from fastapi import Depends, FastAPI
+from sqlalchemy.ext.asyncio import AsyncSession, async_sessionmaker, create_async_engine
+
+from authloom import AuthLoom, AuthLoomConfig, create_auth_router
+from authloom.db import User
+
+engine = create_async_engine("sqlite+aiosqlite:///./app.db")
+SessionLocal = async_sessionmaker(
+    engine,
+    class_=AsyncSession,
+    expire_on_commit=False,
+)
+
+auth = AuthLoom(config=AuthLoomConfig(session_factory=SessionLocal))
+
+app = FastAPI()
+app.include_router(create_auth_router(auth))
+
+
+@app.get("/protected")
+async def protected_route(
+    user: Annotated[User, Depends(auth.require_current_user)],
+):
+    return {"id": user.id, "email": user.email}
+
+
+@app.get("/optional")
+async def optional_route(
+    user: Annotated[User | None, Depends(auth.optional_current_user)],
+):
+    return {"authenticated": user is not None}
+```
+
+## Routes
+
+`create_auth_router(auth)` creates a FastAPI router mounted at `/auth`.
+
+| Method | Path | Description |
+| --- | --- | --- |
+| `POST` | `/auth/signup` | Create a user, create a session, and set the session cookie. |
+| `POST` | `/auth/signin` | Verify credentials, create a session, and set the session cookie. |
+| `POST` | `/auth/signout` | Revoke the current session and delete the session cookie when present. |
+| `GET` | `/auth/me` | Return the current authenticated user. |
+
+## Configuration
+
+The required configuration value is `session_factory`.
+
+```python
+from authloom import AuthLoom, AuthLoomConfig
+from authloom.settings import AuthLoomCookieSessionConfig, AuthLoomPasswordConfig
+
+auth = AuthLoom(
+    config=AuthLoomConfig(
+        session_factory=SessionLocal,
+        cookie_session=AuthLoomCookieSessionConfig(
+            cookie_name="authloom.auth",
+            ttl=60 * 60 * 24 * 7,
+            http_only=True,
+            secure=True,
+            samesite="lax",
+            path="/",
+        ),
+        password_config=AuthLoomPasswordConfig(
+            min_length=15,
+            max_length=64,
+        ),
+    )
+)
+```
+
+Cookie settings:
+
+| Option | Default | Notes |
+| --- | --- | --- |
+| `cookie_name` | `"authloom.auth"` | Must not be empty. |
+| `ttl` | `604800` | Lifetime in seconds. Must be greater than zero. |
+| `http_only` | `True` | Prevents browser JavaScript from reading the cookie. |
+| `secure` | `False` | Use `True` in HTTPS production deployments. |
+| `samesite` | `"lax"` | One of `"lax"`, `"strict"`, or `"none"`. `"none"` requires `secure=True`. |
+| `domain` | `None` | Optional cookie domain. |
+| `path` | `"/"` | Must not be empty and must start with `/`. |
+
+Password settings:
+
+| Option | Default | Validation |
+| --- | --- | --- |
+| `min_length` | `15` | Cannot be less than `15` and cannot exceed `max_length`. |
+| `max_length` | `64` | Cannot be less than `64` or greater than `128`. |
+
+Use `secure=True` for HTTPS production deployments.
+
+See `docs/configuration.md` for the full configuration reference.
+
+## Database And Migrations
+
+AuthLoom does not own migrations. Applications own Alembic setup and migration history.
+
+Include AuthLoom metadata in the application Alembic configuration when generating migrations:
+
+```python
+from authloom.db import metadata as authloom_metadata
+
+target_metadata = [authloom_metadata, your_app_metadata]
+```
+
+Do not rely on `metadata.create_all()` for production schema management.
+
+See `docs/database-and-migrations.md` for more detail.
+
+## Security Model
+
+AuthLoom currently provides:
+
+- Argon2 password hashing.
+- Email normalization before signup and signin.
+- Random session tokens sent to clients only through cookies.
+- SHA-256 hashes of session tokens stored in the database.
+- Session expiry based on the configured cookie/session lifetime.
+- Session revocation during signout.
+- `HttpOnly` cookie support.
+- Generic invalid-credential responses for signin failures.
+
+Production deployments should use HTTPS and `secure=True` cookies. AuthLoom does not add a separate CSRF protection system beyond the configured cookie policy.
+
+See `docs/security.md` for more detail.
+
+## v0.1 Limitations
+
+AuthLoom does not currently provide:
+
+- Rate limiting or brute-force protection.
+- Email verification.
+- Password reset or password change flows.
+- Multi-factor authentication.
+- OAuth or social login.
+- JWT access or refresh tokens.
+- Roles, permissions, organizations, or multi-tenancy.
+- Session cleanup jobs for expired or revoked sessions.
+- Packaged database migrations or a migration CLI.
+
+## Example Application
+
+See `examples/credentials_auth_basic/` for a SQLite FastAPI example.
+
+## Development
+
+Install development and test dependencies:
+
+```bash
+uv sync --locked --group dev --group test
+```
+
+Run Ruff:
+
+```bash
+uv run ruff check .
+```
+
+Run tests:
+
+```bash
+uv run pytest tests/unit
+uv run pytest tests/integration
+```
+
+Build the package:
+
+```bash
+uv build
+```
+
+## License
+
+This project is licensed under the Apache License 2.0. See `LICENSE` for details.

authloom-0.1.0a1/README.md

@@ -0,0 +1,210 @@
+# AuthLoom
+
+AuthLoom is a Python 3.12 authentication library for FastAPI applications.
+
+It currently provides email/password signup and signin, cookie-backed database sessions, required and optional current-user dependencies, Argon2 password hashing, normalized email handling, hashed session tokens, expiry, and signout revocation.
+
+AuthLoom is pre-release software. APIs and database integration details may change before the first stable release.
+
+## Installation
+
+Using `uv`:
+
+```bash
+uv add "authloom==0.1.0a1"
+```
+
+Using `pip`:
+
+```bash
+pip install "authloom==0.1.0a1"
+```
+
+## Requirements
+
+- Python `>=3.12`
+- FastAPI `>=0.140.0`
+- SQLAlchemy `>=2.0.51` with async sessions
+
+## Basic Usage
+
+Applications provide the async SQLAlchemy session factory and own database setup.
+
+```python
+from typing import Annotated
+
+from fastapi import Depends, FastAPI
+from sqlalchemy.ext.asyncio import AsyncSession, async_sessionmaker, create_async_engine
+
+from authloom import AuthLoom, AuthLoomConfig, create_auth_router
+from authloom.db import User
+
+engine = create_async_engine("sqlite+aiosqlite:///./app.db")
+SessionLocal = async_sessionmaker(
+    engine,
+    class_=AsyncSession,
+    expire_on_commit=False,
+)
+
+auth = AuthLoom(config=AuthLoomConfig(session_factory=SessionLocal))
+
+app = FastAPI()
+app.include_router(create_auth_router(auth))
+
+
+@app.get("/protected")
+async def protected_route(
+    user: Annotated[User, Depends(auth.require_current_user)],
+):
+    return {"id": user.id, "email": user.email}
+
+
+@app.get("/optional")
+async def optional_route(
+    user: Annotated[User | None, Depends(auth.optional_current_user)],
+):
+    return {"authenticated": user is not None}
+```
+
+## Routes
+
+`create_auth_router(auth)` creates a FastAPI router mounted at `/auth`.
+
+| Method | Path | Description |
+| --- | --- | --- |
+| `POST` | `/auth/signup` | Create a user, create a session, and set the session cookie. |
+| `POST` | `/auth/signin` | Verify credentials, create a session, and set the session cookie. |
+| `POST` | `/auth/signout` | Revoke the current session and delete the session cookie when present. |
+| `GET` | `/auth/me` | Return the current authenticated user. |
+
+## Configuration
+
+The required configuration value is `session_factory`.
+
+```python
+from authloom import AuthLoom, AuthLoomConfig
+from authloom.settings import AuthLoomCookieSessionConfig, AuthLoomPasswordConfig
+
+auth = AuthLoom(
+    config=AuthLoomConfig(
+        session_factory=SessionLocal,
+        cookie_session=AuthLoomCookieSessionConfig(
+            cookie_name="authloom.auth",
+            ttl=60 * 60 * 24 * 7,
+            http_only=True,
+            secure=True,
+            samesite="lax",
+            path="/",
+        ),
+        password_config=AuthLoomPasswordConfig(
+            min_length=15,
+            max_length=64,
+        ),
+    )
+)
+```
+
+Cookie settings:
+
+| Option | Default | Notes |
+| --- | --- | --- |
+| `cookie_name` | `"authloom.auth"` | Must not be empty. |
+| `ttl` | `604800` | Lifetime in seconds. Must be greater than zero. |
+| `http_only` | `True` | Prevents browser JavaScript from reading the cookie. |
+| `secure` | `False` | Use `True` in HTTPS production deployments. |
+| `samesite` | `"lax"` | One of `"lax"`, `"strict"`, or `"none"`. `"none"` requires `secure=True`. |
+| `domain` | `None` | Optional cookie domain. |
+| `path` | `"/"` | Must not be empty and must start with `/`. |
+
+Password settings:
+
+| Option | Default | Validation |
+| --- | --- | --- |
+| `min_length` | `15` | Cannot be less than `15` and cannot exceed `max_length`. |
+| `max_length` | `64` | Cannot be less than `64` or greater than `128`. |
+
+Use `secure=True` for HTTPS production deployments.
+
+See `docs/configuration.md` for the full configuration reference.
+
+## Database And Migrations
+
+AuthLoom does not own migrations. Applications own Alembic setup and migration history.
+
+Include AuthLoom metadata in the application Alembic configuration when generating migrations:
+
+```python
+from authloom.db import metadata as authloom_metadata
+
+target_metadata = [authloom_metadata, your_app_metadata]
+```
+
+Do not rely on `metadata.create_all()` for production schema management.
+
+See `docs/database-and-migrations.md` for more detail.
+
+## Security Model
+
+AuthLoom currently provides:
+
+- Argon2 password hashing.
+- Email normalization before signup and signin.
+- Random session tokens sent to clients only through cookies.
+- SHA-256 hashes of session tokens stored in the database.
+- Session expiry based on the configured cookie/session lifetime.
+- Session revocation during signout.
+- `HttpOnly` cookie support.
+- Generic invalid-credential responses for signin failures.
+
+Production deployments should use HTTPS and `secure=True` cookies. AuthLoom does not add a separate CSRF protection system beyond the configured cookie policy.
+
+See `docs/security.md` for more detail.
+
+## v0.1 Limitations
+
+AuthLoom does not currently provide:
+
+- Rate limiting or brute-force protection.
+- Email verification.
+- Password reset or password change flows.
+- Multi-factor authentication.
+- OAuth or social login.
+- JWT access or refresh tokens.
+- Roles, permissions, organizations, or multi-tenancy.
+- Session cleanup jobs for expired or revoked sessions.
+- Packaged database migrations or a migration CLI.
+
+## Example Application
+
+See `examples/credentials_auth_basic/` for a SQLite FastAPI example.
+
+## Development
+
+Install development and test dependencies:
+
+```bash
+uv sync --locked --group dev --group test
+```
+
+Run Ruff:
+
+```bash
+uv run ruff check .
+```
+
+Run tests:
+
+```bash
+uv run pytest tests/unit
+uv run pytest tests/integration
+```
+
+Build the package:
+
+```bash
+uv build
+```
+
+## License
+
+This project is licensed under the Apache License 2.0. See `LICENSE` for details.