[MIG] fastapi_auth_api_key: Migration to 18.0

Author: yankinmax

fastapi_auth_api_key/README.rst

@@ -72,7 +72,8 @@ Configuration
 -------------
 
 For this to work, the api key must be defined on the Endpoint. A new
-field auth_api_key_group_id has been added to the Endpoint model.
+field auth_api_key_group_id has been added to the Endpoint model as well
+as auth_http_api_key_header.
 
 Bug Tracker
 ===========
@@ -97,11 +98,12 @@ Contributors
 
 - Matthieu Méquignon <matthieu.mequignon@camptocamp.com>
 - Son Ho <sonhd@trobz.com>
+- Maksym Yankin <maksym.yankin@camptocamp.com>
 
 Other credits
 -------------
 
-The migration of this module from 16.0 to 17.0 was financially supported
+The migration of this module from 17.0 to 18.0 was financially supported
 by Camptocamp
 
 Maintainers

fastapi_auth_api_key/__manifest__.py

@@ -3,7 +3,7 @@
 
 {
     "name": "Fastapi Auth API Key",
-    "version": "17.0.1.0.0",
+    "version": "18.0.1.0.0",
     "category": "Others",
     "website": "https://github.com/OCA/rest-framework",
     "author": "Camptocamp, Odoo Community Association (OCA)",

fastapi_auth_api_key/dependencies.py

@@ -1,9 +1,9 @@
 # Copyright 2024 Camptocamp SA
 # License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl)
-import os
+
 from typing import Annotated
 
-from odoo import SUPERUSER_ID, _
+from odoo import SUPERUSER_ID
 from odoo.api import Environment
 from odoo.exceptions import ValidationError
 
@@ -14,31 +14,27 @@
 
 from fastapi import Depends, status
 from fastapi.exceptions import HTTPException
-from fastapi.security import APIKeyHeader
-
-HTTP_API_KEY_HEADER = os.environ.get("FASTAPI_AUTH_HTTP_API_KEY_HEADER", "HTTP-API-KEY")
 
 
 def authenticated_auth_api_key(
-    key: Annotated[str, Depends(APIKeyHeader(name=HTTP_API_KEY_HEADER))],
     env: Annotated[Environment, Depends(odoo_env)],
     endpoint: Annotated[FastapiEndpoint, Depends(fastapi_endpoint)],
 ) -> AuthApiKey:
+    admin_env = Environment(env.cr, SUPERUSER_ID, {})
+    key = endpoint.sudo().auth_http_api_key_header
     if not key:
         raise HTTPException(
             status_code=status.HTTP_401_UNAUTHORIZED,
-            detail=_("Missing %(HTTP_API_KEY_HEADER)s header")
-            % {"HTTP_API_KEY_HEADER": HTTP_API_KEY_HEADER},
-            headers={"WWW-Authenticate": HTTP_API_KEY_HEADER},
+            detail=admin_env._("Missing HTTP API key header"),
+            headers={"WWW-Authenticate": key},
         )
-    admin_env = Environment(env.cr, SUPERUSER_ID, {})
     try:
         auth_api_key = admin_env["auth.api.key"]._retrieve_api_key(key)
     except ValidationError as error:
         raise HTTPException(
             status_code=status.HTTP_401_UNAUTHORIZED,
             detail=error.args,
-            headers={"WWW-Authenticate": HTTP_API_KEY_HEADER},
+            headers={"WWW-Authenticate": key},
         ) from error
     # Ensure the api key is authorized for the current endpoint.
     if (
@@ -47,8 +43,8 @@ def authenticated_auth_api_key(
     ):
         raise HTTPException(
             status_code=status.HTTP_401_UNAUTHORIZED,
-            detail=_("Unauthorized"),
-            headers={"WWW-Authenticate": HTTP_API_KEY_HEADER},
+            detail=admin_env._("Unauthorized"),
+            headers={"WWW-Authenticate": key},
         )
     return auth_api_key
 

fastapi_auth_api_key/models/fastapi_endpoint.py

@@ -11,3 +11,8 @@ class FastapiEndpoint(models.Model):
         "auth.api.key.group",
         help="If not set, all 'auth.api.key' are allowed to access to endpoints",
     )
+    auth_http_api_key_header: str = fields.Char(
+        string="API Key Header",
+        help="The HTTP header name expected in requests for API authentication "
+        "(e.g. 'X-API-Key').",
+    )

fastapi_auth_api_key/readme/CONTRIBUTORS.md

@@ -1,2 +1,3 @@
 - Matthieu Méquignon \<<matthieu.mequignon@camptocamp.com>\>
 - Son Ho \<<sonhd@trobz.com>\>
+- Maksym Yankin \<<maksym.yankin@camptocamp.com>\>

fastapi_auth_api_key/readme/CREDITS.md

@@ -1,2 +1,2 @@
-The migration of this module from 16.0 to 17.0 was financially supported
+The migration of this module from 17.0 to 18.0 was financially supported
 by Camptocamp

fastapi_auth_api_key/readme/USAGE.md

@@ -29,4 +29,5 @@ def example_with_authenticated_partner(
 ## Configuration
 
 For this to work, the api key must be defined on the Endpoint. A new
-field auth_api_key_group_id has been added to the Endpoint model.
+field auth_api_key_group_id has been added to the Endpoint model as well
+as auth_http_api_key_header.

fastapi_auth_api_key/tests/test_fastapi_api_key_dependencies.py

@@ -72,34 +72,36 @@ def setUpClassApiKey(cls):
     def test_authenticated_auth_api_key_no_api_key(self):
         # An exception is raised when no api key is used
         with self.assertRaises(HTTPException) as error:
-            authenticated_auth_api_key(False, self.demo_env, self.demo_endpoint)
-        self.assertEqual(error.exception.detail, "Missing HTTP-API-KEY header")
+            authenticated_auth_api_key(self.demo_env, self.demo_endpoint)
+        self.assertEqual(error.exception.detail, "Missing HTTP API key header")
 
     def test_authenticated_auth_api_key_no_api_key_found(self):
+        self.demo_endpoint.auth_http_api_key_header = "404"
         # An exception is raised when no api key record is found
         with self.assertRaises(HTTPException) as error:
-            authenticated_auth_api_key("404", self.demo_env, self.demo_endpoint)
+            authenticated_auth_api_key(self.demo_env, self.demo_endpoint)
         self.assertEqual(error.exception.detail, ("The key 404 is not allowed",))
 
     def test_authenticated_auth_api_key_unauthorized_key(self):
+        self.demo_endpoint.auth_http_api_key_header = "unauthorized_key"
         # An exception is raised when unauthorized api key record is found
         with self.assertRaisesRegex(HTTPException, r"Unauthorized"):
-            authenticated_auth_api_key(
-                "unauthorized_key", self.demo_env, self.demo_endpoint
-            )
+            authenticated_auth_api_key(self.demo_env, self.demo_endpoint)
 
     def test_authenticated_auth_api_key(self):
-        result_key = authenticated_auth_api_key(
-            "authorized_key", self.demo_env, self.demo_endpoint
-        )
+        self.demo_endpoint.auth_http_api_key_header = "authorized_key"
+        result_key = authenticated_auth_api_key(self.demo_env, self.demo_endpoint)
         self.assertEqual(result_key, self.authorized_api_key)
 
     def test_authenticated_auth_api_key_without_group(self):
         # test with no group set unauthorized is allow to access
-        self.demo_endpoint.auth_api_key_group_id = False
-        result_key = authenticated_auth_api_key(
-            "unauthorized_key", self.demo_env, self.demo_endpoint
+        self.demo_endpoint.write(
+            {
+                "auth_api_key_group_id": False,
+                "auth_http_api_key_header": "unauthorized_key",
+            }
         )
+        result_key = authenticated_auth_api_key(self.demo_env, self.demo_endpoint)
         self.assertEqual(result_key, self.unauthorized_api_key)
 
     def test_authenticated_partner_by_api_key(self):

fastapi_auth_api_key/views/fastapi_endpoint.xml

@@ -9,6 +9,7 @@
         <field name="arch" type="xml">
             <group name="resoures" position="inside">
                 <field name="auth_api_key_group_id" />
+                <field name="auth_http_api_key_header" />
             </group>
         </field>
     </record>