xn-auth 0.0.2__tar.gz

xn_auth-0.0.2/.env.dist

@@ -0,0 +1 @@
+VENV=venv

xn_auth-0.0.2/.gitignore

@@ -0,0 +1,7 @@
+/.idea
+/venv
+.env
+/*.egg-info
+/dist
+*.pyc
+/build

xn_auth-0.0.2/.pre-commit-config.yaml

@@ -0,0 +1,36 @@
+repos:
+- repo: local
+  hooks:
+  - id: tag
+    name: tag
+    ### make tag with next ver only if "fix" in commit_msg or starts with "feat"
+    entry: bash -c 'grep -e ^feat -e fix .git/COMMIT_EDITMSG && make patch || exit 0'
+    language: system
+    verbose: true
+    pass_filenames: false
+    always_run: true
+    stages: [post-commit]
+
+  - id: build
+    name: build
+    ### build & upload package only for "main" branch push
+    entry: bash -c 'echo $PRE_COMMIT_LOCAL_BRANCH | grep /master && make build || echo 0'
+    language: system
+    pass_filenames: false
+    verbose: true
+    require_serial: true
+    stages: [pre-push]
+
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  ### Ruff version.
+  rev: v0.6.4
+  hooks:
+    ### Run the linter.
+    - id: ruff
+      args: [--fix, --unsafe-fixes]
+      stages: [pre-commit]
+    ### Run the formatter.
+    - id: ruff-format
+      types_or: [python, pyi]
+      verbose: true
+      stages: [pre-commit]

xn_auth-0.0.2/PKG-INFO

@@ -0,0 +1,34 @@
+Metadata-Version: 2.1
+Name: xn-auth
+Version: 0.0.2
+Summary: Auth adapter for XN-Api framework
+Author-email: Artemiev <mixartemev@gmail.com>
+License: MIT
+Project-URL: Homepage, https://github.com/XyncNet/x-api
+Project-URL: Repository, https://github.com/XyncNet/x-api
+Keywords: starlette,fastapi,auth
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+Requires-Dist: fastapi
+Requires-Dist: pwdlib[argon2]
+Requires-Dist: python-jose[cryptography]
+Requires-Dist: xn-model
+Provides-Extra: dev
+Requires-Dist: build; extra == "dev"
+Requires-Dist: python-dotenv; extra == "dev"
+Requires-Dist: setuptools_scm; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+
+# X-Auth
+###### Pswd-jwt authentication for x-api
+
+#### Requirements
+- Python >= 3.12
+
+### INSTALL
+```bash
+pip install x-auth
+```
+
+---
+Made with ❤ on top of the [X-Model](https://github.com/XyncNet/x-model).

xn_auth-0.0.2/README.md

@@ -0,0 +1,13 @@
+# X-Auth
+###### Pswd-jwt authentication for x-api
+
+#### Requirements
+- Python >= 3.12
+
+### INSTALL
+```bash
+pip install x-auth
+```
+
+---
+Made with ❤ on top of the [X-Model](https://github.com/XyncNet/x-model).

xn_auth-0.0.2/makefile

@@ -0,0 +1,24 @@
+include .env
+PACKAGE := x_auth
+VPYTHON := $(VENV)/bin/python
+
+.PHONY: all install pre-commit clean build twine patch
+
+all:
+	make install clean build
+
+install: $(VENV)
+	$(VENV)/bin/pip install .[dev]; make pre-commit
+pre-commit: .pre-commit-config.yaml
+	pre-commit install -t pre-commit -t post-commit -t pre-push
+
+clean: dist $(PACKAGE).egg-info
+	rm -rf dist/* $(PACKAGE).egg-info $(PACKAGE)/__pycache__ dist/__pycache__
+
+build: $(VENV)
+	$(VPYTHON) -m build; make twine
+twine: $(VENV) dist
+	$(VPYTHON) -m twine upload dist/* --skip-existing
+
+patch: $(VENV)
+	git tag `$(VPYTHON) -m setuptools_scm --strip-dev`; git push --tags --prune -f

xn_auth-0.0.2/pyproject.toml

@@ -0,0 +1,44 @@
+[project]
+name = "xn-auth"
+requires-python = ">=3.12"
+authors = [
+    {name = "Artemiev", email = "mixartemev@gmail.com"},
+]
+keywords = ["starlette", "fastapi", "auth"]
+description = "Auth adapter for XN-Api framework"
+readme = "README.md"
+license = {text = "MIT"}
+dynamic = ["version"]
+
+dependencies = [
+    "fastapi",
+    'pwdlib[argon2]',
+    "python-jose[cryptography]",
+    "xn-model",
+]
+
+[project.optional-dependencies]
+dev = [
+    "build",
+    "python-dotenv",
+    "setuptools_scm",
+    "twine",
+]
+
+[project.urls]
+Homepage = "https://github.com/XyncNet/x-api"
+Repository = "https://github.com/XyncNet/x-api"
+
+[build-system]
+requires = ["setuptools>=64", "setuptools-scm[toml]>=8"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools]
+packages = ["x_auth"]
+
+[tool.setuptools_scm]
+version_scheme = "python-simplified-semver" # if "feature" in `branch_name` SEMVER_MINOR++ else SEMVER_PATCH++
+local_scheme = "no-local-version"
+
+[tool.ruff]
+line-length = 120

xn_auth-0.0.2/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

xn_auth-0.0.2/x_auth/__init__.py

@@ -0,0 +1,211 @@
+from datetime import timedelta, datetime
+from enum import IntEnum
+
+# from importlib.metadata import distributions
+from typing import Annotated
+from fastapi import Depends, HTTPException, Security
+from fastapi.security import OAuth2PasswordBearer, SecurityScopes, OAuth2PasswordRequestForm
+from jose import jwt, JWTError
+from pydantic import BaseModel, ValidationError
+from starlette import status
+from starlette.authentication import AuthCredentials, SimpleUser, AuthenticationError, AuthenticationBackend
+from starlette.requests import HTTPConnection
+from starlette.responses import Response
+from x_model.enum import Scope, UserStatus
+from x_model.model import Model, User
+from x_model.pydantic import UserReg, UserAuth
+
+
+class AuthFailReason(IntEnum):
+    username = 1
+    password = 2
+    signature = 3
+    expired = 4
+    dep_not_installed = 5
+
+
+class AuthException(AuthenticationError, HTTPException):
+    detail: AuthFailReason
+
+    def __init__(self, detail: AuthFailReason, clear_cookie: str | None = "access_token") -> None:
+        hdrs = (
+            {"set-cookie": clear_cookie + "=; expires=Thu, 01 Jan 1970 00:00:00 GMT"} if clear_cookie else None
+        )  # path=/;
+        super().__init__(status_code=status.HTTP_401_UNAUTHORIZED, detail=detail.name, headers=hdrs)
+
+
+def on_error(_: HTTPConnection, exc: AuthException) -> Response:
+    hdr = (
+        {
+            "Location": "/login",
+        }
+        if exc.status_code == 303 and "/login" in (r.path for r in _.app.routes)
+        else {}
+    )
+    resp = Response(str(exc), status_code=exc.status_code, headers=hdr)
+    resp.delete_cookie("access_token")
+    return resp
+
+
+class AuthType(IntEnum):
+    pwd = 1
+    tg = 2
+
+
+class TokenData(BaseModel):
+    id: int
+    username: str | None = None
+    scopes: list[str] = []
+
+
+class AuthUser(SimpleUser):
+    id: int
+
+    def __init__(self, uid: int, username: str) -> None:
+        super().__init__(username)
+        self.id = uid
+
+
+class OAuth(AuthenticationBackend):
+    EXPIRES = timedelta(days=7)
+
+    class Token(BaseModel):
+        access_token: str
+        token_type: str
+        user: UserAuth
+
+    def __init__(self, secret: str, db_user_model: type[User] = User, auth_type: AuthType = AuthType.pwd):
+        self.secret: str = secret
+        self.db_user_model: type[User] = db_user_model
+        self.auth_type: AuthType = auth_type
+
+        self.read = Security(self.check_token, scopes=[Scope.READ.name])
+        self.write = Security(self.check_token, scopes=[Scope.WRITE.name])
+        self.my = Security(self.check_token, scopes=[Scope.ALL.name])
+        self.active = Depends(self.check_token)
+
+    oauth2_scheme = OAuth2PasswordBearer(
+        tokenUrl="token",
+        scopes={
+            Scope.READ.name: "READ own items",
+            Scope.WRITE.name: "Write own items",
+            Scope.ALL.name: "Access for not only own items",
+        },
+    )
+
+    # async def get_token_for_tg(self, tg_user: WebAppUser) -> Token:
+    #     user: User
+    #     user, cr = await user_upsert(tg_user)
+    #     access_token = self.gen_access_token(
+    #         data={"sub": tg_user.username or str(tg_user.id), "id": tg_user.id,
+    #               "scopes": self.role_scopes_map[user.role]},
+    #         expires_delta=self.EXPIRES,
+    #     )
+    #     auth_user: UserAuth = UserAuth.model_validate(user, from_attributes=True)
+    #     return self.Token.model_validate(
+    #         {"access_token": access_token, "token_type": "bearer", "user": auth_user},
+    #         from_attributes=True
+    #     )
+
+    def get_data_from_jwt(self, jwtoken: str) -> tuple[AuthCredentials, AuthUser]:
+        payload = jwt.decode(jwtoken, self.secret, algorithms=["HS256"])
+        uid: int = payload.get("id")
+        username: str = payload.get("sub")
+        scopes = payload.get("scopes", [])
+        return AuthCredentials(scopes), AuthUser(uid, username)
+
+    async def authenticate(self, conn: HTTPConnection) -> tuple[AuthCredentials, AuthUser] | None:
+        if not (auth := conn.headers.get("Authorization")):
+            return
+        # try:
+        scheme, credentials = auth.split()
+        if scheme.lower() == "bearer":
+            try:
+                return self.get_data_from_jwt(credentials)
+            except JWTError as e:
+                print(e)
+                raise AuthException(AuthFailReason.expired, "access_token")
+            except ValidationError as e:
+                print(e)
+                raise AuthException(AuthFailReason.signature, "access_token")
+            # except Exception as exc:
+            #     raise AuthenticationError(exc, 'Invalid auth credentials')
+        # elif scheme.lower() == 'tg':
+        #     if 'xtg-auth' not in [d.name for d in distributions()]:
+        #         raise AuthException(AuthFailReason.dep_not_installed, None)
+        #     from aiogram.utils.web_app import safe_parse_webapp_init_data
+        #     tgData = safe_parse_webapp_init_data(self.secret, credentials)
+        #     credentials = (await self.get_token_for_tg(tgData.user)).access_token
+
+    # dependency
+    async def check_token(
+        self, security_scopes: SecurityScopes, token: Annotated[str | None, Depends(oauth2_scheme)]
+    ):  # , tg_data: [str, ]
+        auth_val = "Bearer"
+        if security_scopes.scopes:
+            auth_val += f' scope="{security_scopes.scope_str}"'
+        cred_exc = HTTPException(
+            status_code=status.HTTP_401_UNAUTHORIZED,
+            detail="Could not validate credentials",
+            headers={"WWW-Authenticate": auth_val},
+        )
+        try:
+            creds, user = self.get_data_from_jwt(token)
+        except (JWTError, ValidationError) as e:
+            cred_exc.detail += f": {e}"
+            raise cred_exc
+        if not user.username or not user.id:
+            cred_exc.detail += "token"
+            raise cred_exc
+        # noinspection PyTypeChecker
+        user_status: UserStatus | None = await self.db_user_model.get_or_none(username=user.username).values_list(
+            "status", flat=True
+        )
+        if not user_status:
+            cred_exc.detail = "User not found"
+            raise cred_exc
+        elif user_status < UserStatus.TEST:
+            raise HTTPException(status_code=status.HTTP_403_FORBIDDEN, detail="Inactive user")
+        for scope in security_scopes.scopes:
+            if scope not in creds.scopes:
+                cred_exc.detail = f"Not enough permissions. Need `{scope}`"
+                raise cred_exc
+
+    # api reg endpoint
+    async def reg_user(self, user_reg_input: UserReg) -> Token:
+        data = user_reg_input.model_dump()
+        try:
+            await self.db_user_model.create(**data)
+        except Exception as e:
+            raise HTTPException(status.HTTP_406_NOT_ACCEPTABLE, detail=e.__repr__())
+        tok = await self.login_for_access_token(
+            OAuth2PasswordRequestForm(username=user_reg_input.username, password=user_reg_input.password)
+        )
+        return tok
+
+    async def authenticate_user(self, username: str, password: str) -> tuple[TokenData, Model]:
+        if user_db := await self.db_user_model.get_or_none(username=username):
+            td = TokenData.model_validate(user_db, from_attributes=True)
+            td.scopes = self.role_scopes_map[user_db.role]
+            if user_db.pwd_vrf(password):
+                return td, user_db
+            reason = AuthFailReason.password
+        else:
+            reason = AuthFailReason.username
+        raise AuthException(detail=reason)
+
+    def gen_access_token(self, data: dict, expires_delta: timedelta = EXPIRES) -> str:
+        return jwt.encode({"exp": datetime.utcnow() + expires_delta, **data}, self.secret)
+
+    # api login endpoint
+    async def login_for_access_token(self, form_data: Annotated[OAuth2PasswordRequestForm, Depends()]) -> Token:
+        token, user_db = await self.authenticate_user(form_data.username, form_data.password)
+        if isinstance(token, TokenData):
+            access_token = self.gen_access_token(
+                data={"id": token.id, "sub": token.username, "scopes": token.scopes},
+                expires_delta=self.EXPIRES,
+            )
+            r = self.Token.model_validate(
+                {"access_token": access_token, "token_type": "bearer", "user": user_db}, from_attributes=True
+            )
+            return r

xn_auth-0.0.2/xn_auth.egg-info/PKG-INFO

@@ -0,0 +1,34 @@
+Metadata-Version: 2.1
+Name: xn-auth
+Version: 0.0.2
+Summary: Auth adapter for XN-Api framework
+Author-email: Artemiev <mixartemev@gmail.com>
+License: MIT
+Project-URL: Homepage, https://github.com/XyncNet/x-api
+Project-URL: Repository, https://github.com/XyncNet/x-api
+Keywords: starlette,fastapi,auth
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+Requires-Dist: fastapi
+Requires-Dist: pwdlib[argon2]
+Requires-Dist: python-jose[cryptography]
+Requires-Dist: xn-model
+Provides-Extra: dev
+Requires-Dist: build; extra == "dev"
+Requires-Dist: python-dotenv; extra == "dev"
+Requires-Dist: setuptools_scm; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+
+# X-Auth
+###### Pswd-jwt authentication for x-api
+
+#### Requirements
+- Python >= 3.12
+
+### INSTALL
+```bash
+pip install x-auth
+```
+
+---
+Made with ❤ on top of the [X-Model](https://github.com/XyncNet/x-model).

xn_auth-0.0.2/xn_auth.egg-info/SOURCES.txt

@@ -0,0 +1,12 @@
+.env.dist
+.gitignore
+.pre-commit-config.yaml
+README.md
+makefile
+pyproject.toml
+x_auth/__init__.py
+xn_auth.egg-info/PKG-INFO
+xn_auth.egg-info/SOURCES.txt
+xn_auth.egg-info/dependency_links.txt
+xn_auth.egg-info/requires.txt
+xn_auth.egg-info/top_level.txt

xn_auth-0.0.2/xn_auth.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

xn_auth-0.0.2/xn_auth.egg-info/requires.txt

@@ -0,0 +1,10 @@
+fastapi
+pwdlib[argon2]
+python-jose[cryptography]
+xn-model
+
+[dev]
+build
+python-dotenv
+setuptools_scm
+twine

xn_auth-0.0.2/xn_auth.egg-info/top_level.txt

@@ -0,0 +1 @@
+x_auth