usso 0.4.0__tar.gz

usso-0.4.0/LICENSE.txt

@@ -0,0 +1,19 @@
+Copyright (c) 2016 The Python Packaging Authority (PyPA)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

usso-0.4.0/PKG-INFO

@@ -0,0 +1,92 @@
+Metadata-Version: 2.1
+Name: usso
+Version: 0.4.0
+Summary: A plug-and-play client for integrating universal single sign-on (SSO) with Python frameworks, enabling secure and seamless authentication across microservices.
+Author-email: Mahdi Kiani <mahdikiany@gmail.com>
+Maintainer-email: Mahdi Kiani <mahdikiany@gmail.com>
+License: Copyright (c) 2016 The Python Packaging Authority (PyPA)
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy of
+        this software and associated documentation files (the "Software"), to deal in
+        the Software without restriction, including without limitation the rights to
+        use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+        of the Software, and to permit persons to whom the Software is furnished to do
+        so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: Homepage, https://github.com/usso-io/usso-python
+Project-URL: Bug Reports, https://github.com/usso-io/usso-python/issues
+Project-URL: Funding, https://github.com/usso-io/usso-python
+Project-URL: Say Thanks!, https://github.com/usso-io/usso-python
+Project-URL: Source, https://github.com/usso-io/usso-python
+Keywords: usso,sso,authentication,security,fastapi,django
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Build Tools
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3 :: Only
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: peppercorn
+Provides-Extra: fastapi
+Requires-Dist: fastapi>=0.65.0; extra == "fastapi"
+Requires-Dist: uvicorn[standard]>=0.13.0; extra == "fastapi"
+Provides-Extra: django
+Requires-Dist: Django>=3.2; extra == "django"
+Provides-Extra: dev
+Requires-Dist: check-manifest; extra == "dev"
+Provides-Extra: test
+Requires-Dist: coverage; extra == "test"
+
+# USSO-Client
+
+The USSO-Client provides a universal single sign-on (SSO) integration for microservices, making it easy to add secure, scalable authentication across different frameworks. This client simplifies the process of connecting any microservice to the USSO service.
+
+## Features
+
+- **Core SSO Integration**: Use the USSO core client for basic SSO functionality across any Python application.
+- **Framework-Specific Modules**:
+  - **FastAPI Integration**: Specialized support for FastAPI applications, enabling async authentication mechanisms tailored to FastAPI's event loop.
+  - *Django Integration* (Coming soon): Customizable Django authentication backend that integrates seamlessly with Django's user management and middleware architecture.
+
+## Installation
+
+Install the USSO client using pip:
+
+```bash
+pip install usso-client
+```
+
+To add framework-specific support, use the following commands:
+
+For FastAPI:
+
+```bash
+pip install "usso-client[fastapi]"
+```
+
+## Quick Start
+Follow the quick start guides in the documentation to integrate USSO in your application.
+
+## Contributing
+Contributions are welcome! See CONTRIBUTING.md for more details on how to get involved.
+
+## License
+Distributed under the MIT License. See LICENSE for more information.

usso-0.4.0/README.md

@@ -0,0 +1,35 @@
+# USSO-Client
+
+The USSO-Client provides a universal single sign-on (SSO) integration for microservices, making it easy to add secure, scalable authentication across different frameworks. This client simplifies the process of connecting any microservice to the USSO service.
+
+## Features
+
+- **Core SSO Integration**: Use the USSO core client for basic SSO functionality across any Python application.
+- **Framework-Specific Modules**:
+  - **FastAPI Integration**: Specialized support for FastAPI applications, enabling async authentication mechanisms tailored to FastAPI's event loop.
+  - *Django Integration* (Coming soon): Customizable Django authentication backend that integrates seamlessly with Django's user management and middleware architecture.
+
+## Installation
+
+Install the USSO client using pip:
+
+```bash
+pip install usso-client
+```
+
+To add framework-specific support, use the following commands:
+
+For FastAPI:
+
+```bash
+pip install "usso-client[fastapi]"
+```
+
+## Quick Start
+Follow the quick start guides in the documentation to integrate USSO in your application.
+
+## Contributing
+Contributions are welcome! See CONTRIBUTING.md for more details on how to get involved.
+
+## License
+Distributed under the MIT License. See LICENSE for more information.

usso-0.4.0/pyproject.toml

@@ -0,0 +1,48 @@
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "usso"
+version = "0.4.0"
+description = "A plug-and-play client for integrating universal single sign-on (SSO) with Python frameworks, enabling secure and seamless authentication across microservices."
+readme = "README.md"
+requires-python = ">=3.8"
+license = {file = "LICENSE.txt"}
+keywords = ["usso", "sso", "authentication", "security", "fastapi", "django"]
+authors = [
+  {name = "Mahdi Kiani", email = "mahdikiany@gmail.com"}
+]
+maintainers = [
+  {name = "Mahdi Kiani", email = "mahdikiany@gmail.com"}
+]
+classifiers = [
+  "Development Status :: 3 - Alpha",
+  "Intended Audience :: Developers",
+  "Topic :: Software Development :: Build Tools",
+  "License :: OSI Approved :: MIT License",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.8",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3 :: Only",
+]
+dependencies = [
+  "peppercorn"  # Example main dependency
+]
+optional-dependencies = {"fastapi" = ["fastapi>=0.65.0", "uvicorn[standard]>=0.13.0"],"django" = ["Django>=3.2"],"dev" = ["check-manifest"],"test" = ["coverage"]}
+
+[project.urls]
+"Homepage" = "https://github.com/usso-io/usso-python"
+"Bug Reports" = "https://github.com/usso-io/usso-python/issues"
+"Funding" = "https://github.com/usso-io/usso-python"
+"Say Thanks!" = "https://github.com/usso-io/usso-python"
+"Source" = "https://github.com/usso-io/usso-python"
+
+[project.scripts]
+usso = "usso:main"
+
+[tool.setuptools]
+package-data = {"usso" = ["*.dat"]}

usso-0.4.0/setup.cfg

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

usso-0.4.0/src/usso/__init__.py

@@ -0,0 +1,2 @@
+from .core import *
+from usso_fastapi import integration as fastapi_integration

usso-0.4.0/src/usso/core.py

@@ -0,0 +1,30 @@
+from functools import lru_cache
+from typing import Optional, Tuple
+
+import jwt
+from pydantic import BaseModel
+
+
+class UserData(BaseModel):
+    user_id: str
+    email: str | None = None
+    phone: str | None = None
+    authentication_method: str | None = None
+    is_active: bool = False
+    jti: str
+    data: dict | None = None
+    token: str | None = None
+
+
+def get_authorization_scheme_param(
+    authorization_header_value: Optional[str],
+) -> Tuple[str, str]:
+    if not authorization_header_value:
+        return "", ""
+    scheme, _, param = authorization_header_value.partition(" ")
+    return scheme, param
+
+
+@lru_cache
+def get_jwks_keys(jwks_url):
+    return jwt.PyJWKClient(jwks_url)

usso-0.4.0/src/usso/exceptions.py

@@ -0,0 +1,16 @@
+error_messages = {
+    "invalid_signature": "Invalid signature",
+    "invalid_token": "Invalid token",
+    "expired_signature": "Expired signature",
+    "unauthorized": "Unauthorized",
+}
+
+
+class USSOException(Exception):
+    def __init__(self, status_code: int, error: str, message: str = None):
+        self.status_code = status_code
+        self.error = error
+        self.message = message
+        if message is None:
+            self.message = error_messages[error]
+        super().__init__(message)

usso-0.4.0/src/usso/usso_fastapi/__init__.py

@@ -0,0 +1 @@
+from .integration import *

usso-0.4.0/src/usso/usso_fastapi/integration.py

@@ -0,0 +1,73 @@
+import logging
+
+import jwt
+from fastapi import Request
+from starlette.status import HTTP_401_UNAUTHORIZED
+
+from usso.core import UserData, get_authorization_scheme_param, get_jwks_keys
+from usso.exceptions import USSOException
+
+logger = logging.getLogger("usso")
+
+
+async def user_data_from_token(token: str, **kwargs) -> UserData | None:
+    """Return the user associated with a token value."""
+    try:
+        header = jwt.get_unverified_header(token)
+        jwks_url = header["jwk_url"]
+        jwks_client = get_jwks_keys(jwks_url)
+        # , headers=optional_custom_headers)
+        signing_key = jwks_client.get_signing_key_from_jwt(token)
+        decoded = jwt.decode(
+            token,
+            signing_key.key,
+            algorithms=["RS256"],
+        )
+        decoded["token"] = token
+
+    except jwt.exceptions.ExpiredSignatureError:
+        if kwargs.get("raise_exception"):
+            raise USSOException(
+                status_code=HTTP_401_UNAUTHORIZED, error="expired_signature"
+            )
+        return None
+    except jwt.exceptions.InvalidSignatureError:
+        if kwargs.get("raise_exception"):
+            raise USSOException(
+                status_code=HTTP_401_UNAUTHORIZED, error="invalid_signature"
+            )
+        return None
+    except jwt.exceptions.InvalidTokenError:
+        if kwargs.get("raise_exception"):
+            raise USSOException(
+                status_code=HTTP_401_UNAUTHORIZED, error="invalid_token"
+            )
+        return None
+    except Exception as e:
+        if kwargs.get("raise_exception"):
+            raise USSOException(
+                status_code=HTTP_401_UNAUTHORIZED, error="error", message=str(e)
+            )
+        logger.error(e)
+        return None
+
+    return UserData(**decoded)
+
+
+async def jwt_access_security(request: Request) -> UserData | None:
+    """Return the user associated with a token value."""
+    kwargs = {}
+    authorization = request.headers.get("Authorization")
+    if authorization:
+        scheme, _, credentials = get_authorization_scheme_param(authorization)
+        if scheme.lower() == "bearer":
+            token = credentials
+            return await user_data_from_token(token, **kwargs)
+
+    cookie_token = request.cookies.get("access_token")
+    if cookie_token:
+        return await user_data_from_token(cookie_token, **kwargs)
+
+    if kwargs.get("raise_exception", True):
+        raise USSOException(status_code=HTTP_401_UNAUTHORIZED, error="unauthorized")
+    return None

usso-0.4.0/src/usso.egg-info/PKG-INFO

@@ -0,0 +1,92 @@
+Metadata-Version: 2.1
+Name: usso
+Version: 0.4.0
+Summary: A plug-and-play client for integrating universal single sign-on (SSO) with Python frameworks, enabling secure and seamless authentication across microservices.
+Author-email: Mahdi Kiani <mahdikiany@gmail.com>
+Maintainer-email: Mahdi Kiani <mahdikiany@gmail.com>
+License: Copyright (c) 2016 The Python Packaging Authority (PyPA)
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy of
+        this software and associated documentation files (the "Software"), to deal in
+        the Software without restriction, including without limitation the rights to
+        use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+        of the Software, and to permit persons to whom the Software is furnished to do
+        so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: Homepage, https://github.com/usso-io/usso-python
+Project-URL: Bug Reports, https://github.com/usso-io/usso-python/issues
+Project-URL: Funding, https://github.com/usso-io/usso-python
+Project-URL: Say Thanks!, https://github.com/usso-io/usso-python
+Project-URL: Source, https://github.com/usso-io/usso-python
+Keywords: usso,sso,authentication,security,fastapi,django
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Build Tools
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3 :: Only
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: peppercorn
+Provides-Extra: fastapi
+Requires-Dist: fastapi>=0.65.0; extra == "fastapi"
+Requires-Dist: uvicorn[standard]>=0.13.0; extra == "fastapi"
+Provides-Extra: django
+Requires-Dist: Django>=3.2; extra == "django"
+Provides-Extra: dev
+Requires-Dist: check-manifest; extra == "dev"
+Provides-Extra: test
+Requires-Dist: coverage; extra == "test"
+
+# USSO-Client
+
+The USSO-Client provides a universal single sign-on (SSO) integration for microservices, making it easy to add secure, scalable authentication across different frameworks. This client simplifies the process of connecting any microservice to the USSO service.
+
+## Features
+
+- **Core SSO Integration**: Use the USSO core client for basic SSO functionality across any Python application.
+- **Framework-Specific Modules**:
+  - **FastAPI Integration**: Specialized support for FastAPI applications, enabling async authentication mechanisms tailored to FastAPI's event loop.
+  - *Django Integration* (Coming soon): Customizable Django authentication backend that integrates seamlessly with Django's user management and middleware architecture.
+
+## Installation
+
+Install the USSO client using pip:
+
+```bash
+pip install usso-client
+```
+
+To add framework-specific support, use the following commands:
+
+For FastAPI:
+
+```bash
+pip install "usso-client[fastapi]"
+```
+
+## Quick Start
+Follow the quick start guides in the documentation to integrate USSO in your application.
+
+## Contributing
+Contributions are welcome! See CONTRIBUTING.md for more details on how to get involved.
+
+## License
+Distributed under the MIT License. See LICENSE for more information.

usso-0.4.0/src/usso.egg-info/SOURCES.txt

@@ -0,0 +1,16 @@
+LICENSE.txt
+README.md
+pyproject.toml
+src/usso/__init__.py
+src/usso/core.py
+src/usso/exceptions.py
+src/usso/package_data.dat
+src/usso.egg-info/PKG-INFO
+src/usso.egg-info/SOURCES.txt
+src/usso.egg-info/dependency_links.txt
+src/usso.egg-info/entry_points.txt
+src/usso.egg-info/requires.txt
+src/usso.egg-info/top_level.txt
+src/usso/usso_fastapi/__init__.py
+src/usso/usso_fastapi/integration.py
+tests/test_simple.py

usso-0.4.0/src/usso.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

usso-0.4.0/src/usso.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+usso = usso:main

usso-0.4.0/src/usso.egg-info/requires.txt

@@ -0,0 +1,14 @@
+peppercorn
+
+[dev]
+check-manifest
+
+[django]
+Django>=3.2
+
+[fastapi]
+fastapi>=0.65.0
+uvicorn[standard]>=0.13.0
+
+[test]
+coverage

usso-0.4.0/src/usso.egg-info/top_level.txt

@@ -0,0 +1 @@
+usso

usso-0.4.0/tests/test_simple.py

@@ -0,0 +1,14 @@
+# the inclusion of the tests module is not meant to offer best practices for
+# testing in general, but rather to support the `find_packages` example in
+# setup.py that excludes installing the "tests" package
+
+import unittest
+
+
+class TestSimple(unittest.TestCase):
+    def test_add_one(self):
+        self.assertEqual(5 + 1, 6)
+
+
+if __name__ == "__main__":
+    unittest.main()