{"id":34997466,"url":"https://github.com/insmnia/binauth","last_synced_at":"2026-01-13T21:59:11.625Z","repository":{"id":330597042,"uuid":"1123309462","full_name":"insmnia/binauth","owner":"insmnia","description":"A bitwise permission system for Python with SQLAlchemy and FastAPI integration.","archived":false,"fork":false,"pushed_at":"2025-12-26T22:29:24.000Z","size":96,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-12-28T04:48:49.699Z","etag":null,"topics":["async","backend","fastapi","permissions","python","sqlalchemy"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/insmnia.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-12-26T15:52:58.000Z","updated_at":"2025-12-26T22:39:34.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/insmnia/binauth","commit_stats":null,"previous_names":["insmnia/binauth"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/insmnia/binauth","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/insmnia%2Fbinauth","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/insmnia%2Fbinauth/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/insmnia%2Fbinauth/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/insmnia%2Fbinauth/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/insmnia","download_url":"https://codeload.github.com/insmnia/binauth/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/insmnia%2Fbinauth/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28400397,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-13T14:36:09.778Z","status":"ssl_error","status_checked_at":"2026-01-13T14:35:19.697Z","response_time":56,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["async","backend","fastapi","permissions","python","sqlalchemy"],"created_at":"2025-12-27T02:47:14.045Z","updated_at":"2026-01-13T21:59:11.620Z","avatar_url":"https://github.com/insmnia.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# binauth\n\n[![CI](https://github.com/insmnia/binauth/actions/workflows/ci.yml/badge.svg)](https://github.com/insmnia/binauth/actions/workflows/ci.yml)\n[![PyPI version](https://badge.fury.io/py/binauth.svg)](https://pypi.org/project/binauth/)\n\nA bitwise permission system for Python with SQLAlchemy and FastAPI integration.\n\n## Features\n\n- Bitwise permission storage (up to 32 actions per scope)\n- Type-safe permission definitions using `IntEnum`\n- Async SQLAlchemy repository\n- FastAPI integration with dependency injection\n- Permission discovery endpoint for admin UIs\n- TTL-based permission caching\n- Generic user ID support (int, UUID, str)\n\n## Installation\n\n### From GitHub\n\n```bash\n# Core only\npip install git+https://github.com/insmnia/binauth.git\n\n# With SQLAlchemy support\npip install \"binauth[db] @ git+https://github.com/insmnia/binauth.git\"\n\n# With FastAPI support\npip install \"binauth[fastapi] @ git+https://github.com/insmnia/binauth.git\"\n\n# All dependencies\npip install \"binauth[all] @ git+https://github.com/insmnia/binauth.git\"\n```\n\n### From PyPI (when published)\n\n```bash\npip install binauth\npip install binauth[db]       # With SQLAlchemy\npip install binauth[fastapi]  # With FastAPI\npip install binauth[all]      # All dependencies\n```\n\n## Quick Start\n\n### Define Permissions\n\n```python\nfrom enum import IntEnum\nfrom typing import ClassVar\nfrom binauth import PermissionActionRegistry, PermissionsManager\n\nclass TaskPermissions(PermissionActionRegistry):\n    scope_name = \"tasks\"\n    category = \"Content Management\"  # For grouping in admin UI\n    description = \"Task management permissions\"\n\n    class Actions(IntEnum):\n        CREATE = 1 \u003c\u003c 0  # 1\n        READ = 1 \u003c\u003c 1    # 2\n        UPDATE = 1 \u003c\u003c 2  # 4\n        DELETE = 1 \u003c\u003c 3  # 8\n\n    # Optional: descriptions for admin UI\n    action_descriptions: ClassVar[dict[str, str]] = {\n        \"CREATE\": \"Create new tasks\",\n        \"READ\": \"View tasks\",\n        \"UPDATE\": \"Edit tasks\",\n        \"DELETE\": \"Remove tasks\",\n    }\n\nmanager = PermissionsManager([TaskPermissions])\n```\n\n### Check Permissions\n\n```python\nclass User:\n    def __init__(self, permissions: dict[PermissionScope, PermissionBinLevel]):\n        self.permissions = permissions\n\n# User has CREATE and READ permissions (level = 3)\nuser = User(permissions={\"tasks\": 3})\n\n# Check single permission\nhas_read = manager.check_permission(user, \"tasks\", TaskPermissions.Actions.READ)\n\n# Check multiple permissions (all required)\nhas_all = manager.check_permissions(\n    user,\n    \"tasks\",\n    [TaskPermissions.Actions.READ, TaskPermissions.Actions.UPDATE],\n    require_all=True,\n)\n\n# Check multiple permissions (any required)\nhas_any = manager.check_permissions(\n    user,\n    \"tasks\",\n    [TaskPermissions.Actions.CREATE, TaskPermissions.Actions.DELETE],\n    require_all=False,\n)\n```\n\n### FastAPI Integration\n\n```python\nfrom fastapi import FastAPI, Depends\nfrom binauth import (\n    create_permission_dependency,\n    get_permissions_router,\n    setup_permission_exception_handler,\n)\n\napp = FastAPI()\nsetup_permission_exception_handler(app)\n\n# Option 1: Pass user ID directly\npermission = create_permission_dependency(\n    manager=manager,\n    get_db=get_db,\n    get_current_user_id=get_current_user_id,  # Returns int/UUID/str\n    cache_ttl=60,\n)\n\n# Option 2: Pass user object with .id attribute\npermission = create_permission_dependency(\n    manager=manager,\n    get_db=get_db,\n    get_current_user=get_current_user,  # Returns User with .id\n    cache_ttl=60,\n)\n\n# Protected endpoint\n@app.get(\"/tasks\")\nasync def list_tasks(\n    user_id: int = Depends(permission.require(\"tasks\", TaskPermissions.Actions.READ))\n):\n    return {\"tasks\": [...]}\n\n# Permission discovery endpoint (for admin UI)\napp.include_router(get_permissions_router(manager, get_current_user))\n# GET /permissions returns all available permissions grouped by category\n```\n\n### Database Storage\n\n```python\nfrom binauth import AsyncPermissionRepository, Base\n\n# Create tables\nasync with engine.begin() as conn:\n    await conn.run_sync(Base.metadata.create_all)\n\n# Use repository\nasync with async_session() as session:\n    repo = AsyncPermissionRepository(session, manager)\n\n    # Grant permissions\n    await repo.grant_actions(user_id, \"tasks\", TaskPermissions.Actions.READ)\n\n    # Check permissions\n    has_perm = await repo.has_permission(\n        user_id, \"tasks\", TaskPermissions.Actions.READ\n    )\n\n    # Get all user permissions\n    perms = await repo.get_all_user_permissions(user_id)\n```\n\n### Permission Discovery\n\nGet all available permissions for admin UIs:\n\n```python\nschema = manager.get_permissions_schema()\n# Returns:\n# [\n#     {\n#         \"name\": \"Content Management\",\n#         \"scopes\": [\n#             {\n#                 \"name\": \"tasks\",\n#                 \"description\": \"Task management permissions\",\n#                 \"actions\": [\n#                     {\"name\": \"CREATE\", \"value\": 1, \"description\": \"Create new tasks\"},\n#                     {\"name\": \"READ\", \"value\": 2, \"description\": \"View tasks\"},\n#                     ...\n#                 ]\n#             }\n#         ]\n#     }\n# ]\n```\n\n## Limitations\n\n- Maximum 32 actions per scope (uses PostgreSQL INTEGER for storage)\n- Action values must be powers of 2 (`1 \u003c\u003c n` where `0 \u003c= n \u003c= 31`)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finsmnia%2Fbinauth","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Finsmnia%2Fbinauth","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finsmnia%2Fbinauth/lists"}