fastapi-sso 0.10.0__py3-none-any.whl → 0.12.0__py3-none-any.whl

fastapi_sso/__init__.py

@@ -10,6 +10,8 @@ from .sso.github import GithubSSO
 from .sso.gitlab import GitlabSSO
 from .sso.google import GoogleSSO
 from .sso.kakao import KakaoSSO
+from .sso.line import LineSSO
+from .sso.linkedin import LinkedInSSO
 from .sso.microsoft import MicrosoftSSO
 from .sso.naver import NaverSSO
 from .sso.notion import NotionSSO

fastapi_sso/sso/base.py

@@ -1,5 +1,6 @@
 """SSO login base dependency
 """
+
 # pylint: disable=too-few-public-methods
 
 import json
@@ -93,6 +94,7 @@ class SSOBase:
             )
         self.scope = scope or self.scope
         self._refresh_token: Optional[str] = None
+        self._id_token: Optional[str] = None
         self._state: Optional[str] = None
 
     @property
@@ -153,6 +155,16 @@ class SSOBase:
         """
         return self._refresh_token or self.oauth_client.refresh_token
 
+    @property
+    def id_token(self) -> Optional[str]:
+        """
+        Retrieves the id token if returned from provider.
+
+        Returns:
+            Optional[str]: The id token if available.
+        """
+        return self._id_token
+
     async def openid_from_response(self, response: dict, session: Optional[httpx.AsyncClient] = None) -> OpenID:
         """
         Converts a response from the provider's user info endpoint to an OpenID object.
@@ -286,6 +298,7 @@ class SSOBase:
     def __enter__(self) -> "SSOBase":
         self._oauth_client = None
         self._refresh_token = None
+        self._id_token = None
         return self
 
     def __exit__(
@@ -296,6 +309,10 @@ class SSOBase:
     ) -> None:
         return None
 
+    @property
+    def _extra_query_params(self) -> Dict:
+        return {}
+
     async def process_login(
         self,
         code: str,
@@ -326,6 +343,7 @@ class SSOBase:
         if self._oauth_client is not None:  # pragma: no cover
             self._oauth_client = None
             self._refresh_token = None
+            self._id_token = None
             warnings.warn(
                 (
                     "Reusing the SSO object is not safe and caused a security issue in previous versions."
@@ -334,6 +352,7 @@ class SSOBase:
                 ReusedOauthClientWarning,
             )
         params = params or {}
+        params.update(self._extra_query_params)
         additional_headers = additional_headers or {}
         additional_headers.update(self.additional_headers or {})
 
@@ -364,6 +383,7 @@ class SSOBase:
             response = await session.post(token_url, headers=headers, content=body, auth=auth)
             content = response.json()
             self._refresh_token = content.get("refresh_token")
+            self._id_token = content.get("id_token")
             self.oauth_client.parse_request_body_response(json.dumps(content))
 
             uri, headers, _ = self.oauth_client.add_token(await self.userinfo_endpoint)

fastapi_sso/sso/line.py

@@ -0,0 +1,37 @@
+"""Line SSO Login Helper
+"""
+
+from typing import TYPE_CHECKING, Optional
+
+from fastapi_sso.sso.base import DiscoveryDocument, OpenID, SSOBase
+
+if TYPE_CHECKING:
+    import httpx
+
+
+class LineSSO(SSOBase):
+    """Class providing login via Line OAuth"""
+
+    provider = "line"
+    base_url = "https://api.line.me/oauth2/v2.1"
+    scope = ["email", "profile", "openid"]
+
+    async def get_discovery_document(self) -> DiscoveryDocument:
+        """Get document containing handy urls"""
+        return {
+            "authorization_endpoint": "https://access.line.me/oauth2/v2.1/authorize",
+            "token_endpoint": f"{self.base_url}/token",
+            "userinfo_endpoint": f"{self.base_url}/userinfo",
+        }
+
+    async def openid_from_response(self, response: dict, session: Optional["httpx.AsyncClient"] = None) -> OpenID:
+        """Return OpenID from user information provided by Line"""
+        return OpenID(
+            email=response.get("email"),
+            first_name=None,
+            last_name=None,
+            display_name=response.get("name"),
+            provider=self.provider,
+            id=response.get("sub"),
+            picture=response.get("picture"),
+        )

fastapi_sso/sso/linkedin.py

@@ -0,0 +1,37 @@
+"""LinkedIn SSO Oauth Helper class"""
+
+from typing import TYPE_CHECKING, Dict, Optional
+
+from fastapi_sso.sso.base import DiscoveryDocument, OpenID, SSOBase
+
+if TYPE_CHECKING:
+    import httpx
+
+
+class LinkedInSSO(SSOBase):
+    """Class providing login via LinkedIn SSO"""
+
+    provider = "linkedin"
+    scope = ["openid", "profile", "email"]
+    additional_headers = {"accept": "application/json"}
+
+    @property
+    def _extra_query_params(self) -> Dict:
+        return {"client_secret": self.client_secret}
+
+    async def get_discovery_document(self) -> DiscoveryDocument:
+        return {
+            "authorization_endpoint": "https://www.linkedin.com/oauth/v2/authorization",
+            "token_endpoint": "https://www.linkedin.com/oauth/v2/accessToken",
+            "userinfo_endpoint": "https://api.linkedin.com/v2/userinfo",
+        }
+
+    async def openid_from_response(self, response: dict, session: Optional["httpx.AsyncClient"] = None) -> OpenID:
+        return OpenID(
+            email=response.get("email"),
+            provider=self.provider,
+            id=response["sub"],
+            first_name=response["given_name"],
+            last_name=response["family_name"],
+            picture=response["picture"],
+        )

fastapi_sso/sso/spotify.py

@@ -1,7 +1,6 @@
 """Spotify SSO Login Helper
 """
 
-
 from typing import TYPE_CHECKING, Optional
 
 from fastapi_sso.sso.base import DiscoveryDocument, OpenID, SSOBase

{fastapi_sso-0.10.0.dist-info → fastapi_sso-0.12.0.dist-info}/METADATA

@@ -1,10 +1,10 @@
 Metadata-Version: 2.1
 Name: fastapi-sso
-Version: 0.10.0
+Version: 0.12.0
 Summary: FastAPI plugin to enable SSO to most common providers (such as Facebook login, Google login and login via Microsoft Office 365 Account)
 Home-page: https://tomasvotava.github.io/fastapi-sso/
 License: MIT
-Keywords: fastapi,sso,oauth,google,facebook,spotify
+Keywords: fastapi,sso,oauth,google,facebook,spotify,linkedin
 Author: Tomas Votava
 Author-email: info@tomasvotava.eu
 Requires-Python: >=3.8,<4.0
@@ -19,6 +19,7 @@ Requires-Dist: fastapi (>=0.80)
 Requires-Dist: httpx (>=0.23.0)
 Requires-Dist: oauthlib (>=3.1.0)
 Requires-Dist: pydantic[email] (>=1.8.0)
+Requires-Dist: pylint (>=3.0.3,<4.0.0)
 Project-URL: Documentation, https://tomasvotava.github.io/fastapi-sso/
 Project-URL: Repository, https://github.com/tomasvotava/fastapi-sso
 Description-Content-Type: text/markdown
@@ -82,6 +83,8 @@ I tend to process Pull Requests faster when properly caffeinated 😉.
 - Kakao (by Jae-Baek Song - [thdwoqor](https://github.com/thdwoqor))
 - Naver (by 1tang2bang92) - [1tang2bang92](https://github.com/1tang2bang92)
 - Gitlab (by Alessandro Pischedda) - [Cereal84](https://github.com/Cereal84)
+- Line (by Jimmy Yeh) - [jimmyyyeh](https://github.com/jimmyyyeh)
+- LinkedIn (by Alessandro Pischedda) - [Cereal84](https://github.com/Cereal84)
 
 See [Contributing](#contributing) for a guide on how to contribute your own login provider.
 

{fastapi_sso-0.10.0.dist-info → fastapi_sso-0.12.0.dist-info}/RECORD

@@ -1,7 +1,7 @@
-fastapi_sso/__init__.py,sha256=yIYh0Va_EEA6BXLzs-vw02YCpQLChrTeX-ZuYwp4fSQ,586
+fastapi_sso/__init__.py,sha256=aqYfVqDcq3sk8BuPNbcVnSED6ouoHi-1is9oe_Lgl-M,654
 fastapi_sso/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 fastapi_sso/sso/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-fastapi_sso/sso/base.py,sha256=PPOZ5RVqIVxfwZb15PKCt8Tax_x5rcw0V3Pu8KaXfro,14080
+fastapi_sso/sso/base.py,sha256=K2UnC8ay20lFeCn5WUx1z-DYzpqFYqDC8RZjpVdamTI,14607
 fastapi_sso/sso/facebook.py,sha256=F1ox1auZ5PlJW2xccAN0oF8HpvTA5tF6cdPdXar_xF0,1327
 fastapi_sso/sso/fitbit.py,sha256=OcCL1Go5jZ6XAarucORErX7Nuk9g9qFCQPamdcEbcFE,1258
 fastapi_sso/sso/generic.py,sha256=pLVK7WuxiQS8XdblkdC5h6he6BcybTdMCrXvfdJlvA8,2625
@@ -9,11 +9,13 @@ fastapi_sso/sso/github.py,sha256=DM4gDK0QTqf8Iftn0La3V7g7bBZ6KuXUB2QyVUELXro,169
 fastapi_sso/sso/gitlab.py,sha256=DzvbTkW0dalDDJVGbbQkr8G5Q3GuMF991-aM_L15v64,1032
 fastapi_sso/sso/google.py,sha256=iyVqh5YG5Xw-Ss4y8xEv1APDvubdI9Vt3ijvPMmStVk,1380
 fastapi_sso/sso/kakao.py,sha256=WvlPMWdYSDM_XHv8wtbvzIzm3xUzxmaEulcf-UaeQSE,864
+fastapi_sso/sso/line.py,sha256=s0nsC11wXvCvddwCWSiv108cvCFUPHkF2FEpdOAVMj4,1190
+fastapi_sso/sso/linkedin.py,sha256=QLehBYsbGUdV4QWluS3ERuxvcf2w1k5kyNhZ4zW8OYM,1236
 fastapi_sso/sso/microsoft.py,sha256=tVxHHGlXTuFCwiLh8pcM7I9aP9ncea5U0ZPp-JEB6hU,1918
 fastapi_sso/sso/naver.py,sha256=mwv7ondZHzaUOXleMiBNkKEHnUywctVUjw0wo83l-II,901
 fastapi_sso/sso/notion.py,sha256=3OU70JpE4mle9DXyZrf4sRpwq1raWcOHjFJrRmsI-EM,1302
-fastapi_sso/sso/spotify.py,sha256=AghNIMG3BvYBthc59vF8rh-Ykuqw04c5tHoikfoVjgU,1250
-fastapi_sso-0.10.0.dist-info/LICENSE.md,sha256=5NVQtYs6liDtYdWM4VObWmTTKaK0k9C9txx5pLPJSyQ,1093
-fastapi_sso-0.10.0.dist-info/METADATA,sha256=7OvXKf0jLrQbAw-0fpvWWc7JhX0eAQ-5m2o6qe69a9g,4395
-fastapi_sso-0.10.0.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
-fastapi_sso-0.10.0.dist-info/RECORD,,
+fastapi_sso/sso/spotify.py,sha256=GhB-Fg3C4In_kzkEUCiPHi00oa1a2Z-QuhX3MCve8m4,1249
+fastapi_sso-0.12.0.dist-info/LICENSE.md,sha256=5NVQtYs6liDtYdWM4VObWmTTKaK0k9C9txx5pLPJSyQ,1093
+fastapi_sso-0.12.0.dist-info/METADATA,sha256=DbEoACGkvJY2IIKpsHh_ESS1yOGZmVUJE4tdSBq7S2I,4588
+fastapi_sso-0.12.0.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
+fastapi_sso-0.12.0.dist-info/RECORD,,