fractal-server 2.18.3a1__tar.gz → 2.18.4__tar.gz

fractal_server-2.18.4/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.

{fractal_server-2.18.3a1 → fractal_server-2.18.4}/PKG-INFO

@@ -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.4/fractal_server/__init__.py

@@ -0,0 +1 @@
+__VERSION__ = "2.18.4"

{fractal_server-2.18.3a1 → fractal_server-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-2.18.3a1 → fractal_server-2.18.4}/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 → fractal_server-2.18.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "fractal-server"
-version = "2.18.3a1"
+version = "2.18.4"
 description = "Backend component of the Fractal analytics platform"
 authors = [
     { name="Tommaso Comparin", email="tommaso.comparin@exact-lab.it" },
@@ -10,6 +10,8 @@ authors = [
 ]
 readme = "README.md"
 license = "BSD-3-Clause"
+license-files = ["LICENSE"]
+
 requires-python = ">=3.11,<3.15"
 dependencies = [
     "fastapi >= 0.120.0, <0.121.0",
@@ -92,7 +94,7 @@ filterwarnings = [
 markers = ["container", "ssh", "fails_on_macos", "oauth"]
 
 [tool.bumpver]
-current_version = "2.18.3a1"
+current_version = "2.18.4"
 version_pattern = "MAJOR.MINOR.PATCH[PYTAGNUM]"
 commit_message = "bump version {old_version} -> {new_version}"
 commit = true

fractal_server-2.18.3a1/fractal_server/__init__.py

@@ -1 +0,0 @@
-__VERSION__ = "2.18.3a1"