fractal-server 2.18.3a1__py3-none-any.whl → 2.18.4__py3-none-any.whl

fractal_server/__init__.py

@@ -1 +1 @@
-__VERSION__ = "2.18.3a1"
+__VERSION__ = "2.18.4"

fractal_server/app/routes/auth/oauth.py

@@ -3,6 +3,8 @@ from httpx_oauth.clients.github import GitHubOAuth2
 from httpx_oauth.clients.google import GoogleOAuth2
 from httpx_oauth.clients.openid import OpenID
 from httpx_oauth.clients.openid import OpenIDConfigurationError
+from httpx_oauth.exceptions import GetIdEmailError
+from httpx_oauth.exceptions import GetProfileError
 
 from fractal_server.config import OAuthSettings
 from fractal_server.config import get_oauth_settings
@@ -13,6 +15,29 @@ from . import cookie_backend
 from . import fastapi_users
 
 
+class FractalOpenID(OpenID):
+    """
+    Subclass of `httpx_oauth.clients.openid.OpenID` with customizable name for
+    the `"email"` claim.
+    """
+
+    def __init__(self, *, email_claim: str, **kwargs):
+        super().__init__(**kwargs)
+        self.email_claim = email_claim
+
+    # TODO-requires-py312: add `@override` decorator
+    async def get_id_email(self, token: str) -> tuple[str, str | None]:
+        """
+        Identical to the parent-class method (httpx-oauth version 0.16.1),
+        apart from making `"email"` configurable.
+        """
+        try:
+            profile = await self.get_profile(token)
+        except GetProfileError as e:
+            raise GetIdEmailError(response=e.response) from e
+        return str(profile["sub"]), profile.get(self.email_claim)
+
+
 def _create_client_github(cfg: OAuthSettings) -> GitHubOAuth2:
     return GitHubOAuth2(
         client_id=cfg.OAUTH_CLIENT_ID.get_secret_value(),
@@ -29,10 +54,11 @@ def _create_client_google(cfg: OAuthSettings) -> GoogleOAuth2:
 
 def _create_client_oidc(cfg: OAuthSettings) -> OpenID:
     try:
-        open_id = OpenID(
+        open_id = FractalOpenID(
             client_id=cfg.OAUTH_CLIENT_ID.get_secret_value(),
             client_secret=cfg.OAUTH_CLIENT_SECRET.get_secret_value(),
             openid_configuration_endpoint=cfg.OAUTH_OIDC_CONFIG_ENDPOINT.get_secret_value(),  # noqa
+            email_claim=cfg.OAUTH_EMAIL_CLAIM,
         )
     except OpenIDConfigurationError as e:
         OAUTH_OIDC_CONFIG_ENDPOINT = (

fractal_server/config/_oauth.py

@@ -28,6 +28,11 @@ class OAuthSettings(BaseSettings):
             String to be used as `redirect_url` argument in
             `fastapi_users.get_oauth_router`, and then in
             `httpx_oauth.integrations.fastapi.OAuth2AuthorizeCallback`.
+        OAUTH_EMAIL_CLAIM:
+            Name of the OIDC claim with the user's email address. This is
+            `"email"` by default, but can be customized (e.g. to `"mail"`) to
+            fit with the response from the userinfo endpoint - see
+            https://openid.net/specs/openid-connect-core-1_0.html#UserInfoResponse
     """
 
     model_config = SettingsConfigDict(**SETTINGS_CONFIG_DICT)
@@ -43,6 +48,7 @@ class OAuthSettings(BaseSettings):
     OAUTH_CLIENT_SECRET: SecretStr | None = None
     OAUTH_OIDC_CONFIG_ENDPOINT: SecretStr | None = None
     OAUTH_REDIRECT_URL: str | None = None
+    OAUTH_EMAIL_CLAIM: str = "email"
 
     @model_validator(mode="after")
     def check_configuration(self: Self) -> Self:

{fractal_server-2.18.3a1.dist-info → fractal_server-2.18.4.dist-info}/METADATA

@@ -1,10 +1,11 @@
 Metadata-Version: 2.4
 Name: fractal-server
-Version: 2.18.3a1
+Version: 2.18.4
 Summary: Backend component of the Fractal analytics platform
 Author: Tommaso Comparin, Marco Franzon, Yuri Chiucconi, Jacopo Nespolo
 Author-email: Tommaso Comparin <tommaso.comparin@exact-lab.it>, Marco Franzon <marco.franzon@exact-lab.it>, Yuri Chiucconi <yuri.chiucconi@exact-lab.it>, Jacopo Nespolo <jacopo.nespolo@exact-lab.it>
 License-Expression: BSD-3-Clause
+License-File: LICENSE
 Requires-Dist: fastapi>=0.120.0,<0.121.0
 Requires-Dist: sqlmodel==0.0.27
 Requires-Dist: sqlalchemy[asyncio]>=2.0.23,<2.1

{fractal_server-2.18.3a1.dist-info → fractal_server-2.18.4.dist-info}/RECORD

@@ -1,4 +1,4 @@
-fractal_server/__init__.py,sha256=2-J9RpG_KXCtJNi4kxk3w5ETlw28IsXy-07Hns9oc6A,25
+fractal_server/__init__.py,sha256=1XYvdP5XhyuSdiA2WGJBMg-1xFdd82EGTGvgLTEc9Hg,23
 fractal_server/__main__.py,sha256=QeKoAgqoiozLJDa8kSVe-Aso1WWgrk1yLUYWS8RxZVM,11405
 fractal_server/alembic.ini,sha256=MWwi7GzjzawI9cCAK1LW7NxIBQDUqD12-ptJoq5JpP0,3153
 fractal_server/app/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -65,7 +65,7 @@ fractal_server/app/routes/auth/_aux_auth.py,sha256=gKdYTWUzxcU44Iep787zReWwdAs4k
 fractal_server/app/routes/auth/current_user.py,sha256=uDWttWo9isG69Jv1EGnnr2Ki5ZGd0D76jgjVDQMkn8c,3251
 fractal_server/app/routes/auth/group.py,sha256=uR98vdQHH-7BFl-Czj85ESPxT2yQymy4qtagaMrnUPU,6491
 fractal_server/app/routes/auth/login.py,sha256=buVa5Y8T0cd_SW1CqC-zMv-3SfPxGJknf7MYlUyKOl0,567
-fractal_server/app/routes/auth/oauth.py,sha256=NxrwOWBGPe7hLPEnD66nfWPGMWzDM80LIrwtmONVw-4,2731
+fractal_server/app/routes/auth/oauth.py,sha256=ocQjyy6OfuEORDYVVzQSgcisSwL-YLZxacq7FuzwJF4,3673
 fractal_server/app/routes/auth/register.py,sha256=IiUJhgY0ZrTs0RlBRRjoTv4wF5Gb3eXTInFV-dXkpsE,615
 fractal_server/app/routes/auth/router.py,sha256=Zip_fw9qJWtoXWjluznschyrCKb2n_rf3xWarSXMkgI,692
 fractal_server/app/routes/auth/users.py,sha256=5BagdH1dz-ZoXdvTgIo9QWBNFPW3p1pIZfY9BBu4eds,7397
@@ -103,7 +103,7 @@ fractal_server/config/_data.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuF
 fractal_server/config/_database.py,sha256=0_FvboMkQEKKRxvr9uFdp98oiQwMTFbdCW3loTZNSY0,1846
 fractal_server/config/_email.py,sha256=vMwLHN9-beYp_-up-WkTpeyNUZk4EHwt3N2l6-PYnx4,4364
 fractal_server/config/_main.py,sha256=6splUmAPRD1J9HXkeZ-Vqif7Nw4ljJXIugpvRrcwPeI,2476
-fractal_server/config/_oauth.py,sha256=UTmlFppDZcOQhr3RvkiG5XMqvr54XRAQ_Y-iR0V8N-8,2024
+fractal_server/config/_oauth.py,sha256=kktD0MEZ_NV4QOK6RmOXDK1x8RCrFEkqC6WLY-DzRIY,2390
 fractal_server/config/_settings_config.py,sha256=tsyXQOnn9QKCFJD6hRo_dJXlQQyl70DbqgHMJoZ1xnY,144
 fractal_server/data_migrations/tools.py,sha256=LeMeASwYGtEqd-3wOLle6WARdTGAimoyMmRbbJl-hAM,572
 fractal_server/exceptions.py,sha256=l6aZDk_6u_9PwDaQSoIFdI40ekpzqOJaxjx5rhW-HVI,141
@@ -267,7 +267,8 @@ fractal_server/types/validators/_workflow_task_arguments_validators.py,sha256=zt
 fractal_server/urls.py,sha256=QjIKAC1a46bCdiPMu3AlpgFbcv6a4l3ABcd5xz190Og,471
 fractal_server/utils.py,sha256=-rjg8QTXQcKweXjn0NcmETFs1_uM9PGnbl0Q7c4ERPM,2181
 fractal_server/zip_tools.py,sha256=Uhn-ax4_9g1PJ32BdyaX30hFpAeVOv2tZYTUK-zVn1E,5719
-fractal_server-2.18.3a1.dist-info/WHEEL,sha256=ZyFSCYkV2BrxH6-HRVRg3R9Fo7MALzer9KiPYqNxSbo,79
-fractal_server-2.18.3a1.dist-info/entry_points.txt,sha256=3TpdcjmETRYWJxFyAh3z-9955EWua9jdkSnBwxES1uE,60
-fractal_server-2.18.3a1.dist-info/METADATA,sha256=dowEZiXk1xYXEsowmAdTx54gIWNNZ6w8PJYuvUczzdA,4163
-fractal_server-2.18.3a1.dist-info/RECORD,,
+fractal_server-2.18.4.dist-info/licenses/LICENSE,sha256=QKAharUuhxL58kSoLizKJeZE3mTCBnX6ucmz8W0lxlk,1576
+fractal_server-2.18.4.dist-info/WHEEL,sha256=ZyFSCYkV2BrxH6-HRVRg3R9Fo7MALzer9KiPYqNxSbo,79
+fractal_server-2.18.4.dist-info/entry_points.txt,sha256=3TpdcjmETRYWJxFyAh3z-9955EWua9jdkSnBwxES1uE,60
+fractal_server-2.18.4.dist-info/METADATA,sha256=Un1KFSgGTikpOVXkKrM5PQLo3lWQsYUzNN_0cTA1nyM,4183
+fractal_server-2.18.4.dist-info/RECORD,,

fractal_server-2.18.4.dist-info/licenses/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright 2022 (C) Friedrich Miescher Institute for Biomedical Research and University of Zurich
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the copyright holder nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.