usso 0.13.0__py3-none-any.whl → 0.15.0__py3-none-any.whl

usso/api.py

@@ -0,0 +1,102 @@
+import requests
+from singleton import Singleton
+
+from usso.core import Usso
+
+
+class UssoAPI(metaclass=Singleton):
+    def __init__(
+        self,
+        url: str = "https://api.usso.io",
+        api_key: str = None,
+        refresh_token: str = None,
+    ):
+        self.url = url
+        assert (
+            api_key or refresh_token
+        ), "Either api_key or refresh_token must be provided"
+        self.api_key = api_key
+        self.refresh_token = refresh_token
+        self.access_token = None
+
+    def refresh(self):
+        if not self.refresh_token:
+            return
+
+        url = f"{self.url}/auth/refresh"
+
+        if self.refresh_token:
+            headers = {"Authorization": f"Bearer {self.refresh_token}"}
+
+        resp = requests.post(url, headers=headers)
+        self.access_token = resp.json().get("access_token")
+
+    def _access_valid(self):
+        if not self.access_token:
+            return False
+
+        user_data = USSO(
+            jwks_url=f"{self.url}/website/jwks.json?"
+        ).user_data_from_token(self.access_token)
+        if user_data:
+            return True
+        return False
+
+    def _request(self, method="get", endpoint: str = "", data: dict = None):
+        url = f"{self.url}/{endpoint}"
+        headers = {}
+        if self.api_key:
+            headers["x-api-key"] = self.api_key
+        elif self.refresh_token:
+            if not self.access_token:
+                self.refresh()
+            headers["Authorization"] = f"Bearer {self.access_token}"
+
+        resp = requests.request(method, url, headers=headers, json=data)
+        return resp.json()
+
+    def get_users(self):
+        return self._request(endpoint="website/users/")
+
+    def get_user(self, user_id: str):
+        return self._request(endpoint=f"website/users/{user_id}/")
+
+    def get_user_credentials(self, user_id: str):
+        return self._request(endpoint=f"website/users/{user_id}/credentials/")
+
+    def get_user_by_credentials(self, credentials: dict):
+        return self._request(endpoint="website/users/credentials/", data=credentials)
+
+    def create_user(self, user_data: dict):
+        return self._request(method="post", endpoint="website/users/", data=user_data)
+
+    def create_user_credentials(self, user_id: str, credentials: dict):
+        return self._request(
+            method="post",
+            endpoint=f"website/users/{user_id}/credentials/",
+            data=credentials,
+        )
+
+    def create_user_by_credentials(
+        self, user_data: dict, credentials: dict | None = None
+    ):
+        if credentials:
+            user_data["authenticators"] = [credentials]
+        return self._request(method="post", endpoint="website/users/", data=user_data)
+
+    def get_user_payload(self, user_id: str):
+        return self._request(endpoint=f"website/users/{user_id}/payload/")
+
+    def update_user_payload(self, user_id: str, payload: dict):
+        return self._request(
+            method="patch",
+            endpoint=f"website/users/{user_id}/payload/",
+            data=payload,
+        )
+
+    def set_user_payload(self, user_id: str, payload: dict):
+        return self._request(
+            method="put",
+            endpoint=f"website/users/{user_id}/payload/",
+            data=payload,
+        )

usso/core.py

@@ -3,6 +3,7 @@ import logging
 import uuid
 from functools import lru_cache
 from typing import Optional, Tuple
+from singleton import Singleton
 
 import jwt
 from pydantic import BaseModel
@@ -39,59 +40,59 @@ class UserData(BaseModel):
         return b64tools.b64_encode_uuid_strip(self.uid)
 
 
-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
-
-
-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"]
-        assert os.getenv("USSO_JWKS_URL") == jwks_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=401, error="expired_signature")
-        return None
-    except jwt.exceptions.InvalidSignatureError:
-        if kwargs.get("raise_exception"):
-            raise USSOException(status_code=401, error="invalid_signature")
-        return None
-    except jwt.exceptions.InvalidTokenError:
-        if kwargs.get("raise_exception"):
-            raise USSOException(
-                status_code=401,
-                error="invalid_token",
+class Usso(metaclass=Singleton):
+    def __init__(self, jwks_url: str):
+        self.jwks_url = jwks_url
+
+    @lru_cache
+    def get_jwks_keys(self):
+        return jwt.PyJWKClient(self.jwks_url)
+
+    def get_authorization_scheme_param(self,
+        authorization_header_value: Optional[str],
+    ) -> Tuple[str, str]:
+        if not authorization_header_value:
+            return "", ""
+        scheme, _, param = authorization_header_value.partition(" ")
+        return scheme, param
+
+    def user_data_from_token(self, 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 = self.get_jwks_keys()
+            signing_key = jwks_client.get_signing_key_from_jwt(token)
+            decoded = jwt.decode(
+                token,
+                signing_key.key,
+                algorithms=["RS256"],
             )
-        return None
-    except Exception as e:
-        if kwargs.get("raise_exception"):
-            raise USSOException(
-                status_code=401,
-                error="error",
-                message=str(e),
-            )
-        logger.error(e)
-        return None
-
-    return UserData(**decoded)
-
-
-@lru_cache
-def get_jwks_keys(jwks_url):
-    return jwt.PyJWKClient(jwks_url)
+            decoded["token"] = token
+
+        except jwt.exceptions.ExpiredSignatureError:
+            if kwargs.get("raise_exception"):
+                raise USSOException(status_code=401, error="expired_signature")
+            return None
+        except jwt.exceptions.InvalidSignatureError:
+            if kwargs.get("raise_exception"):
+                raise USSOException(status_code=401, error="invalid_signature")
+            return None
+        except jwt.exceptions.InvalidTokenError:
+            if kwargs.get("raise_exception"):
+                raise USSOException(
+                    status_code=401,
+                    error="invalid_token",
+                )
+            return None
+        except Exception as e:
+            if kwargs.get("raise_exception"):
+                raise USSOException(
+                    status_code=401,
+                    error="error",
+                    message=str(e),
+                )
+            logger.error(e)
+            return None
+
+        return UserData(**decoded)

usso/fastapi/__init__.py

@@ -1 +1 @@
-from .integration import jwt_access_security
+from .integration import jwt_access_security, jwt_access_security_ws

usso/fastapi/integration.py

@@ -3,7 +3,7 @@ import logging
 from fastapi import Request, WebSocket
 from starlette.status import HTTP_401_UNAUTHORIZED
 
-from usso.core import UserData, get_authorization_scheme_param, user_data_from_token
+from usso.core import UserData, Usso
 from usso.exceptions import USSOException
 
 logger = logging.getLogger("usso")
@@ -14,14 +14,14 @@ async def jwt_access_security(request: Request) -> UserData | None:
     kwargs = {}
     authorization = request.headers.get("Authorization")
     if authorization:
-        scheme, _, credentials = get_authorization_scheme_param(authorization)
+        scheme, _, credentials = Usso().get_authorization_scheme_param(authorization)
         if scheme.lower() == "bearer":
             token = credentials
-            return user_data_from_token(token, **kwargs)
+            return Usso().user_data_from_token(token, **kwargs)
 
-    cookie_token = request.cookies.get("access_token")
+    cookie_token = request.cookies.get("usso_access_token")
     if cookie_token:
-        return user_data_from_token(cookie_token, **kwargs)
+        return Usso().user_data_from_token(cookie_token, **kwargs)
 
     if kwargs.get("raise_exception", True):
         raise USSOException(
@@ -36,14 +36,14 @@ async def jwt_access_security_ws(websocket: WebSocket) -> UserData | None:
     kwargs = {}
     authorization = websocket.headers.get("Authorization")
     if authorization:
-        scheme, _, credentials = get_authorization_scheme_param(authorization)
+        scheme, _, credentials = Usso().get_authorization_scheme_param(authorization)
         if scheme.lower() == "bearer":
             token = credentials
-            return user_data_from_token(token, **kwargs)
+            return Usso().user_data_from_token(token, **kwargs)
 
-    cookie_token = websocket.cookies.get("access_token")
+    cookie_token = websocket.cookies.get("usso_access_token")
     if cookie_token:
-        return user_data_from_token(cookie_token, **kwargs)
+        return Usso().user_data_from_token(cookie_token, **kwargs)
 
     if kwargs.get("raise_exception", True):
         raise USSOException(

{usso-0.13.0.dist-info → usso-0.15.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: usso
-Version: 0.13.0
+Version: 0.15.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>
@@ -24,11 +24,11 @@ License: Copyright (c) 2016 The Python Packaging Authority (PyPA)
         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
+Project-URL: Homepage, https://github.com/ussoio/usso-python
+Project-URL: Bug Reports, https://github.com/ussoio/usso-python/issues
+Project-URL: Funding, https://github.com/ussoio/usso-python
+Project-URL: Say Thanks!, https://github.com/ussoio/usso-python
+Project-URL: Source, https://github.com/ussoio/usso-python
 Keywords: usso,sso,authentication,security,fastapi,django
 Classifier: Development Status :: 3 - Alpha
 Classifier: Intended Audience :: Developers
@@ -48,6 +48,7 @@ Requires-Dist: peppercorn
 Requires-Dist: pydantic >=1.8.2
 Requires-Dist: requests >=2.26.0
 Requires-Dist: pyjwt[crypto]
+Requires-Dist: singleton-package
 Provides-Extra: dev
 Requires-Dist: check-manifest ; extra == 'dev'
 Provides-Extra: django

usso-0.15.0.dist-info/RECORD

@@ -0,0 +1,14 @@
+usso/__init__.py,sha256=fluJnb9X2ECUnUA0lNNR2xHdn3uSI2RVErQiFlqbOiU,49
+usso/api.py,sha256=RCNBRf0TYZqDFA7NGemSrQcEUKyeKO4siiQo6kJ71HY,3263
+usso/b64tools.py,sha256=6YCBx2lLaYFdk36f064VNZ1RejJTHtmgxqq0eT1sCwQ,518
+usso/core.py,sha256=Su1LpCRghQ-EfLVHQiSYXuQcaHT_1VlmZuIQKHaAbqU,2932
+usso/exceptions.py,sha256=hawOAuVbvQtjgRfwp1KFZ4SmV7fh720y5Gom9JVA8W8,504
+usso/package_data.dat,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+usso/fastapi/__init__.py,sha256=WqTIF9BNKlq5f0H8Vk-fcQawPWZMclwuD8QwO4agW7I,69
+usso/fastapi/integration.py,sha256=rkR9uZbe-DEBMgHYtIaP3QUhL6hWHM6edFhBDJQWuz0,1779
+usso-0.15.0.dist-info/LICENSE.txt,sha256=ceC9ZJOV9H6CtQDcYmHOS46NA3dHJ_WD4J9blH513pc,1081
+usso-0.15.0.dist-info/METADATA,sha256=SUe0o6EtDax6CypnPEGQv8uoSBS941WIZwiAtDTZIxQ,4334
+usso-0.15.0.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+usso-0.15.0.dist-info/entry_points.txt,sha256=4Zgpm5ELaAWPf0jPGJFz1_X69H7un8ycT3WdGoJ0Vvk,35
+usso-0.15.0.dist-info/top_level.txt,sha256=g9Jf6h1Oyidh0vPiFni7UHInTJjSvu6cUalpLTIvthg,5
+usso-0.15.0.dist-info/RECORD,,

usso-0.13.0.dist-info/RECORD

@@ -1,13 +0,0 @@
-usso/__init__.py,sha256=fluJnb9X2ECUnUA0lNNR2xHdn3uSI2RVErQiFlqbOiU,49
-usso/b64tools.py,sha256=6YCBx2lLaYFdk36f064VNZ1RejJTHtmgxqq0eT1sCwQ,518
-usso/core.py,sha256=eTzztT0Daxwl3b9VzPZSk1A-QQoGaCQdW2duK8FEWoo,2690
-usso/exceptions.py,sha256=hawOAuVbvQtjgRfwp1KFZ4SmV7fh720y5Gom9JVA8W8,504
-usso/package_data.dat,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-usso/fastapi/__init__.py,sha256=3hB0_Hq4LxfIL5NTI7SdC0jsFEICcBSTv6b9RuBWdxw,45
-usso/fastapi/integration.py,sha256=JD5n12KYUuqvi9nuUesNyJHbR9d7CWC46qVGbXqBH10,1775
-usso-0.13.0.dist-info/LICENSE.txt,sha256=ceC9ZJOV9H6CtQDcYmHOS46NA3dHJ_WD4J9blH513pc,1081
-usso-0.13.0.dist-info/METADATA,sha256=qnQ29y0i3rryXbi0vr1WSHO2tuoNDRBQhTct1vL52A4,4306
-usso-0.13.0.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-usso-0.13.0.dist-info/entry_points.txt,sha256=4Zgpm5ELaAWPf0jPGJFz1_X69H7un8ycT3WdGoJ0Vvk,35
-usso-0.13.0.dist-info/top_level.txt,sha256=g9Jf6h1Oyidh0vPiFni7UHInTJjSvu6cUalpLTIvthg,5
-usso-0.13.0.dist-info/RECORD,,