odoo-addon-fastapi-auth-api-key 17.0.1.0.0.2__py3-none-any.whl

odoo/addons/fastapi_auth_api_key/README.rst

@@ -0,0 +1,134 @@
+.. image:: https://odoo-community.org/readme-banner-image
+   :target: https://odoo-community.org/get-involved?utm_source=readme
+   :alt: Odoo Community Association
+
+====================
+Fastapi Auth API Key
+====================
+
+.. 
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! This file is generated by oca-gen-addon-readme !!
+   !! changes will be overwritten.                   !!
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! source digest: sha256:aff879a734035d7341665e38dce9d294e1379d01dddf4c0631dcb62f75f2a7e7
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
+    :target: https://odoo-community.org/page/development-status
+    :alt: Beta
+.. |badge2| image:: https://img.shields.io/badge/license-AGPL--3-blue.png
+    :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
+    :alt: License: AGPL-3
+.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Frest--framework-lightgray.png?logo=github
+    :target: https://github.com/OCA/rest-framework/tree/17.0/fastapi_auth_api_key
+    :alt: OCA/rest-framework
+.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
+    :target: https://translation.odoo-community.org/projects/rest-framework-17-0/rest-framework-17-0-fastapi_auth_api_key
+    :alt: Translate me on Weblate
+.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
+    :target: https://runboat.odoo-community.org/builds?repo=OCA/rest-framework&target_branch=17.0
+    :alt: Try me on Runboat
+
+|badge1| |badge2| |badge3| |badge4| |badge5|
+
+Provides FastAPI dependencies for Api Key authentication.
+
+**Table of contents**
+
+.. contents::
+   :local:
+
+Usage
+=====
+
+Getting an odoo environment
+---------------------------
+
+If you need to get an odoo env based on the provided api key, you can
+use authenticated_env_by_auth_api_key.
+
+.. code:: python
+
+   @router.get("/example_with_authenticated_env")
+   def example_with_authenticated_env(
+       env: Annotated[Environment, Depends(authenticated_env_by_auth_api_key)],
+   ) -> None:
+       # env.user is the user attached to the provided key
+       pass
+
+Getting the authenticated partner
+---------------------------------
+
+If want to get the partned related to the the provided api key, you can
+use authenticated_partner_by_api_key
+
+.. code:: python
+
+   @router.get("/example_with_authenticated_partner")
+   def example_with_authenticated_partner(
+       partner: Annotated[Partner, Depends(authenticated_partner_by_api_key)],
+   ) -> None:
+       # partner is the partner related to the provided key key.user_id.partner_id
+       pass
+
+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.
+
+Bug Tracker
+===========
+
+Bugs are tracked on `GitHub Issues <https://github.com/OCA/rest-framework/issues>`_.
+In case of trouble, please check there if your issue has already been reported.
+If you spotted it first, help us to smash it by providing a detailed and welcomed
+`feedback <https://github.com/OCA/rest-framework/issues/new?body=module:%20fastapi_auth_api_key%0Aversion:%2017.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
+
+Do not contact contributors directly about support or help with technical issues.
+
+Credits
+=======
+
+Authors
+-------
+
+* Camptocamp
+
+Contributors
+------------
+
+- Matthieu Méquignon <matthieu.mequignon@camptocamp.com>
+- Son Ho <sonhd@trobz.com>
+
+Other credits
+-------------
+
+The migration of this module from 16.0 to 17.0 was financially supported
+by Camptocamp
+
+Maintainers
+-----------
+
+This module is maintained by the OCA.
+
+.. image:: https://odoo-community.org/logo.png
+   :alt: Odoo Community Association
+   :target: https://odoo-community.org
+
+OCA, or the Odoo Community Association, is a nonprofit organization whose
+mission is to support the collaborative development of Odoo features and
+promote its widespread use.
+
+.. |maintainer-mmequignon| image:: https://github.com/mmequignon.png?size=40px
+    :target: https://github.com/mmequignon
+    :alt: mmequignon
+
+Current `maintainer <https://odoo-community.org/page/maintainer-role>`__:
+
+|maintainer-mmequignon| 
+
+This module is part of the `OCA/rest-framework <https://github.com/OCA/rest-framework/tree/17.0/fastapi_auth_api_key>`_ project on GitHub.
+
+You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

odoo/addons/fastapi_auth_api_key/__init__.py

@@ -0,0 +1 @@
+from . import models

odoo/addons/fastapi_auth_api_key/__manifest__.py

@@ -0,0 +1,20 @@
+# Copyright 2024 Camptocamp SA
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl)
+
+{
+    "name": "Fastapi Auth API Key",
+    "version": "17.0.1.0.0",
+    "category": "Others",
+    "website": "https://github.com/OCA/rest-framework",
+    "author": "Camptocamp, Odoo Community Association (OCA)",
+    "maintainers": ["mmequignon"],
+    "license": "AGPL-3",
+    "installable": True,
+    "depends": [
+        "fastapi",
+        "auth_api_key_group",
+    ],
+    "data": [
+        "views/fastapi_endpoint.xml",
+    ],
+}

odoo/addons/fastapi_auth_api_key/dependencies.py

@@ -0,0 +1,66 @@
+# 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.api import Environment
+from odoo.exceptions import ValidationError
+
+from odoo.addons.auth_api_key.models.auth_api_key import AuthApiKey
+from odoo.addons.base.models.res_partner import Partner
+from odoo.addons.fastapi.dependencies import fastapi_endpoint, odoo_env
+from odoo.addons.fastapi.models.fastapi_endpoint import FastapiEndpoint
+
+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:
+    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},
+        )
+    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},
+        ) from error
+    # Ensure the api key is authorized for the current endpoint.
+    if (
+        endpoint.sudo().auth_api_key_group_id
+        and auth_api_key not in endpoint.sudo().auth_api_key_group_id.auth_api_key_ids
+    ):
+        raise HTTPException(
+            status_code=status.HTTP_401_UNAUTHORIZED,
+            detail=_("Unauthorized"),
+            headers={"WWW-Authenticate": HTTP_API_KEY_HEADER},
+        )
+    return auth_api_key
+
+
+def authenticated_partner_by_api_key(
+    auth_api_key: Annotated[AuthApiKey, Depends(authenticated_auth_api_key)]
+) -> Partner:
+    return auth_api_key.user_id.partner_id
+
+
+def authenticated_env_by_auth_api_key(
+    auth_api_key: Annotated[AuthApiKey, Depends(authenticated_auth_api_key)]
+) -> Environment:
+    # set api key id in context
+    return auth_api_key.with_user(auth_api_key.user_id).env

odoo/addons/fastapi_auth_api_key/models/__init__.py

@@ -0,0 +1 @@
+from . import fastapi_endpoint

odoo/addons/fastapi_auth_api_key/models/fastapi_endpoint.py

@@ -0,0 +1,13 @@
+# Copyright 2024 Camptocamp SA
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl)
+
+from odoo import fields, models
+
+
+class FastapiEndpoint(models.Model):
+    _inherit = "fastapi.endpoint"
+
+    auth_api_key_group_id = fields.Many2one(
+        "auth.api.key.group",
+        help="If not set, all 'auth.api.key' are allowed to access to endpoints",
+    )

odoo/addons/fastapi_auth_api_key/readme/CONTRIBUTORS.md

@@ -0,0 +1,2 @@
+- Matthieu Méquignon \<<matthieu.mequignon@camptocamp.com>\>
+- Son Ho \<<sonhd@trobz.com>\>

odoo/addons/fastapi_auth_api_key/readme/CREDITS.md

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

odoo/addons/fastapi_auth_api_key/readme/DESCRIPTION.md

@@ -0,0 +1 @@
+Provides FastAPI dependencies for Api Key authentication.

odoo/addons/fastapi_auth_api_key/readme/USAGE.md

@@ -0,0 +1,32 @@
+## Getting an odoo environment
+
+If you need to get an odoo env based on the provided api key, you can
+use authenticated_env_by_auth_api_key.
+
+``` python
+@router.get("/example_with_authenticated_env")
+def example_with_authenticated_env(
+    env: Annotated[Environment, Depends(authenticated_env_by_auth_api_key)],
+) -> None:
+    # env.user is the user attached to the provided key
+    pass
+```
+
+## Getting the authenticated partner
+
+If want to get the partned related to the the provided api key, you can
+use authenticated_partner_by_api_key
+
+``` python
+@router.get("/example_with_authenticated_partner")
+def example_with_authenticated_partner(
+    partner: Annotated[Partner, Depends(authenticated_partner_by_api_key)],
+) -> None:
+    # partner is the partner related to the provided key key.user_id.partner_id
+    pass
+```
+
+## 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.

odoo/addons/fastapi_auth_api_key/static/description/index.html

@@ -0,0 +1,369 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<meta name="generator" content="Docutils: https://docutils.sourceforge.io/" />
+<title>README.rst</title>
+<style type="text/css">
+
+/*
+:Author: David Goodger (goodger@python.org)
+:Id: $Id: html4css1.css 8954 2022-01-20 10:10:25Z milde $
+:Copyright: This stylesheet has been placed in the public domain.
+
+Default cascading style sheet for the HTML output of Docutils.
+
+See https://docutils.sourceforge.io/docs/howto/html-stylesheets.html for how to
+customize this style sheet.
+*/
+
+/* used to remove borders from tables and images */
+.borderless, table.borderless td, table.borderless th {
+  border: 0 }
+
+table.borderless td, table.borderless th {
+  /* Override padding for "table.docutils td" with "! important".
+     The right padding separates the table cells. */
+  padding: 0 0.5em 0 0 ! important }
+
+.first {
+  /* Override more specific margin styles with "! important". */
+  margin-top: 0 ! important }
+
+.last, .with-subtitle {
+  margin-bottom: 0 ! important }
+
+.hidden {
+  display: none }
+
+.subscript {
+  vertical-align: sub;
+  font-size: smaller }
+
+.superscript {
+  vertical-align: super;
+  font-size: smaller }
+
+a.toc-backref {
+  text-decoration: none ;
+  color: black }
+
+blockquote.epigraph {
+  margin: 2em 5em ; }
+
+dl.docutils dd {
+  margin-bottom: 0.5em }
+
+object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
+  overflow: hidden;
+}
+
+/* Uncomment (and remove this text!) to get bold-faced definition list terms
+dl.docutils dt {
+  font-weight: bold }
+*/
+
+div.abstract {
+  margin: 2em 5em }
+
+div.abstract p.topic-title {
+  font-weight: bold ;
+  text-align: center }
+
+div.admonition, div.attention, div.caution, div.danger, div.error,
+div.hint, div.important, div.note, div.tip, div.warning {
+  margin: 2em ;
+  border: medium outset ;
+  padding: 1em }
+
+div.admonition p.admonition-title, div.hint p.admonition-title,
+div.important p.admonition-title, div.note p.admonition-title,
+div.tip p.admonition-title {
+  font-weight: bold ;
+  font-family: sans-serif }
+
+div.attention p.admonition-title, div.caution p.admonition-title,
+div.danger p.admonition-title, div.error p.admonition-title,
+div.warning p.admonition-title, .code .error {
+  color: red ;
+  font-weight: bold ;
+  font-family: sans-serif }
+
+/* Uncomment (and remove this text!) to get reduced vertical space in
+   compound paragraphs.
+div.compound .compound-first, div.compound .compound-middle {
+  margin-bottom: 0.5em }
+
+div.compound .compound-last, div.compound .compound-middle {
+  margin-top: 0.5em }
+*/
+
+div.dedication {
+  margin: 2em 5em ;
+  text-align: center ;
+  font-style: italic }
+
+div.dedication p.topic-title {
+  font-weight: bold ;
+  font-style: normal }
+
+div.figure {
+  margin-left: 2em ;
+  margin-right: 2em }
+
+div.footer, div.header {
+  clear: both;
+  font-size: smaller }
+
+div.line-block {
+  display: block ;
+  margin-top: 1em ;
+  margin-bottom: 1em }
+
+div.line-block div.line-block {
+  margin-top: 0 ;
+  margin-bottom: 0 ;
+  margin-left: 1.5em }
+
+div.sidebar {
+  margin: 0 0 0.5em 1em ;
+  border: medium outset ;
+  padding: 1em ;
+  background-color: #ffffee ;
+  width: 40% ;
+  float: right ;
+  clear: right }
+
+div.sidebar p.rubric {
+  font-family: sans-serif ;
+  font-size: medium }
+
+div.system-messages {
+  margin: 5em }
+
+div.system-messages h1 {
+  color: red }
+
+div.system-message {
+  border: medium outset ;
+  padding: 1em }
+
+div.system-message p.system-message-title {
+  color: red ;
+  font-weight: bold }
+
+div.topic {
+  margin: 2em }
+
+h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
+h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
+  margin-top: 0.4em }
+
+h1.title {
+  text-align: center }
+
+h2.subtitle {
+  text-align: center }
+
+hr.docutils {
+  width: 75% }
+
+img.align-left, .figure.align-left, object.align-left, table.align-left {
+  clear: left ;
+  float: left ;
+  margin-right: 1em }
+
+img.align-right, .figure.align-right, object.align-right, table.align-right {
+  clear: right ;
+  float: right ;
+  margin-left: 1em }
+
+img.align-center, .figure.align-center, object.align-center {
+  display: block;
+  margin-left: auto;
+  margin-right: auto;
+}
+
+table.align-center {
+  margin-left: auto;
+  margin-right: auto;
+}
+
+.align-left {
+  text-align: left }
+
+.align-center {
+  clear: both ;
+  text-align: center }
+
+.align-right {
+  text-align: right }
+
+/* reset inner alignment in figures */
+div.align-right {
+  text-align: inherit }
+
+/* div.align-center * { */
+/*   text-align: left } */
+
+.align-top    {
+  vertical-align: top }
+
+.align-middle {
+  vertical-align: middle }
+
+.align-bottom {
+  vertical-align: bottom }
+
+ol.simple, ul.simple {
+  margin-bottom: 1em }
+
+ol.arabic {
+  list-style: decimal }
+
+ol.loweralpha {
+  list-style: lower-alpha }
+
+ol.upperalpha {
+  list-style: upper-alpha }
+
+ol.lowerroman {
+  list-style: lower-roman }
+
+ol.upperroman {
+  list-style: upper-roman }
+
+p.attribution {
+  text-align: right ;
+  margin-left: 50% }
+
+p.caption {
+  font-style: italic }
+
+p.credits {
+  font-style: italic ;
+  font-size: smaller }
+
+p.label {
+  white-space: nowrap }
+
+p.rubric {
+  font-weight: bold ;
+  font-size: larger ;
+  color: maroon ;
+  text-align: center }
+
+p.sidebar-title {
+  font-family: sans-serif ;
+  font-weight: bold ;
+  font-size: larger }
+
+p.sidebar-subtitle {
+  font-family: sans-serif ;
+  font-weight: bold }
+
+p.topic-title {
+  font-weight: bold }
+
+pre.address {
+  margin-bottom: 0 ;
+  margin-top: 0 ;
+  font: inherit }
+
+pre.literal-block, pre.doctest-block, pre.math, pre.code {
+  margin-left: 2em ;
+  margin-right: 2em }
+
+pre.code .ln { color: grey; } /* line numbers */
+pre.code, code { background-color: #eeeeee }
+pre.code .comment, code .comment { color: #5C6576 }
+pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
+pre.code .literal.string, code .literal.string { color: #0C5404 }
+pre.code .name.builtin, code .name.builtin { color: #352B84 }
+pre.code .deleted, code .deleted { background-color: #DEB0A1}
+pre.code .inserted, code .inserted { background-color: #A3D289}
+
+span.classifier {
+  font-family: sans-serif ;
+  font-style: oblique }
+
+span.classifier-delimiter {
+  font-family: sans-serif ;
+  font-weight: bold }
+
+span.interpreted {
+  font-family: sans-serif }
+
+span.option {
+  white-space: nowrap }
+
+span.pre {
+  white-space: pre }
+
+span.problematic {
+  color: red }
+
+span.section-subtitle {
+  /* font-size relative to parent (h1..h6 element) */
+  font-size: 80% }
+
+table.citation {
+  border-left: solid 1px gray;
+  margin-left: 1px }
+
+table.docinfo {
+  margin: 2em 4em }
+
+table.docutils {
+  margin-top: 0.5em ;
+  margin-bottom: 0.5em }
+
+table.footnote {
+  border-left: solid 1px black;
+  margin-left: 1px }
+
+table.docutils td, table.docutils th,
+table.docinfo td, table.docinfo th {
+  padding-left: 0.5em ;
+  padding-right: 0.5em ;
+  vertical-align: top }
+
+table.docutils th.field-name, table.docinfo th.docinfo-name {
+  font-weight: bold ;
+  text-align: left ;
+  white-space: nowrap ;
+  padding-left: 0 }
+
+/* "booktabs" style (no vertical lines) */
+table.docutils.booktabs {
+  border: 0px;
+  border-top: 2px solid;
+  border-bottom: 2px solid;
+  border-collapse: collapse;
+}
+table.docutils.booktabs * {
+  border: 0px;
+}
+table.docutils.booktabs th {
+  border-bottom: thin solid;
+  text-align: left;
+}
+
+h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
+h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
+  font-size: 100% }
+
+ul.auto-toc {
+  list-style-type: none }
+
+</style>
+</head>
+<body>
+<div class="document">
+
+
+
+</div>
+</body>
+</html>

odoo/addons/fastapi_auth_api_key/tests/__init__.py

@@ -0,0 +1 @@
+from . import test_fastapi_api_key_dependencies

odoo/addons/fastapi_auth_api_key/tests/test_fastapi_api_key_dependencies.py

@@ -0,0 +1,111 @@
+from odoo.tests import tagged
+from odoo.tests.common import TransactionCase
+
+from odoo.addons.fastapi_auth_api_key.dependencies import (
+    authenticated_auth_api_key,
+    authenticated_env_by_auth_api_key,
+    authenticated_partner_by_api_key,
+)
+
+from fastapi.exceptions import HTTPException
+
+
+@tagged("-at_install", "post_install")
+class TestFastapiAuthApiKey(TransactionCase):
+    @classmethod
+    def setUpClass(cls):
+        super().setUpClass()
+        cls.env = cls.env(context=dict(cls.env.context, tracking_disable=True))
+        demo_user = cls.env.ref("base.user_demo")
+        cls.demo_env = demo_user.with_user(demo_user).env
+        cls.demo_endpoint = cls.env["fastapi.endpoint"].create(
+            {
+                "name": "Test Enpoint",
+                "app": "demo",
+                "root_path": "/path_demo",
+                "demo_auth_method": "api_key",
+                "user_id": demo_user.id,
+            }
+        )
+        cls.setUpClassApiKey()
+
+    @classmethod
+    def setUpClassApiKey(cls):
+        user_model = cls.env["res.users"].with_context(no_reset_password=True)
+        cls.authorized_user = user_model.create(
+            {
+                "name": "John Authorized",
+                "login": "johnauth",
+            }
+        )
+        cls.unauthorized_user = user_model.create(
+            {
+                "name": "Bob Unauthorized",
+                "login": "bobunauth",
+            }
+        )
+        api_key_model = cls.env["auth.api.key"]
+        cls.authorized_api_key = api_key_model.create(
+            {
+                "user_id": cls.authorized_user.id,
+                "name": "Authorized api key",
+                "key": "authorized_key",
+            }
+        )
+        cls.unauthorized_api_key = api_key_model.create(
+            {
+                "user_id": cls.unauthorized_user.id,
+                "name": "Unauthorized api key",
+                "key": "unauthorized_key",
+            }
+        )
+        api_key_group_model = cls.env["auth.api.key.group"]
+        cls.authorized_api_key_group = api_key_group_model.create(
+            {
+                "name": "Authorized api key group",
+                "code": "authorized_api_key_group",
+                "auth_api_key_ids": [(6, 0, cls.authorized_api_key.ids)],
+            }
+        )
+        cls.demo_endpoint.auth_api_key_group_id = cls.authorized_api_key_group
+
+    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")
+
+    def test_authenticated_auth_api_key_no_api_key_found(self):
+        # 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)
+        self.assertEqual(error.exception.detail, ("The key 404 is not allowed",))
+
+    def test_authenticated_auth_api_key_unauthorized_key(self):
+        # 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
+            )
+
+    def test_authenticated_auth_api_key(self):
+        result_key = authenticated_auth_api_key(
+            "authorized_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.assertEqual(result_key, self.unauthorized_api_key)
+
+    def test_authenticated_partner_by_api_key(self):
+        result_partner = authenticated_partner_by_api_key(self.authorized_api_key)
+        self.assertEqual(result_partner, self.authorized_user.partner_id)
+
+    def test_authenticated_env_by_auth_api_key(self):
+        result_env = authenticated_env_by_auth_api_key(self.authorized_api_key)
+        self.assertEqual(result_env.user, self.authorized_user)

odoo/addons/fastapi_auth_api_key/views/fastapi_endpoint.xml

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<!-- Copyright 2024 Camptocamp SA
+     License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). -->
+<odoo>
+
+    <record id="fastapi_endpoint_form_view" model="ir.ui.view">
+      <field name="name">fastapi.endpoint.form.inherit</field>
+      <field name="model">fastapi.endpoint</field>
+      <field name="inherit_id" ref="fastapi.fastapi_endpoint_form_view" />
+      <field name="arch" type="xml">
+        <group name="resoures" position="inside">
+            <field name="auth_api_key_group_id" />
+        </group>
+      </field>
+    </record>
+
+</odoo>

odoo_addon_fastapi_auth_api_key-17.0.1.0.0.2.dist-info/METADATA

@@ -0,0 +1,152 @@
+Metadata-Version: 2.1
+Name: odoo-addon-fastapi_auth_api_key
+Version: 17.0.1.0.0.2
+Requires-Python: >=3.10
+Requires-Dist: odoo-addon-auth_api_key_group>=17.0dev,<17.1dev
+Requires-Dist: odoo-addon-fastapi>=17.0dev,<17.1dev
+Requires-Dist: odoo>=17.0a,<17.1dev
+Summary: Fastapi Auth API Key
+Home-page: https://github.com/OCA/rest-framework
+License: AGPL-3
+Author: Camptocamp, Odoo Community Association (OCA)
+Author-email: support@odoo-community.org
+Classifier: Programming Language :: Python
+Classifier: Framework :: Odoo
+Classifier: Framework :: Odoo :: 17.0
+Classifier: License :: OSI Approved :: GNU Affero General Public License v3
+Description-Content-Type: text/x-rst
+
+.. image:: https://odoo-community.org/readme-banner-image
+   :target: https://odoo-community.org/get-involved?utm_source=readme
+   :alt: Odoo Community Association
+
+====================
+Fastapi Auth API Key
+====================
+
+.. 
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! This file is generated by oca-gen-addon-readme !!
+   !! changes will be overwritten.                   !!
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! source digest: sha256:aff879a734035d7341665e38dce9d294e1379d01dddf4c0631dcb62f75f2a7e7
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
+    :target: https://odoo-community.org/page/development-status
+    :alt: Beta
+.. |badge2| image:: https://img.shields.io/badge/license-AGPL--3-blue.png
+    :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
+    :alt: License: AGPL-3
+.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Frest--framework-lightgray.png?logo=github
+    :target: https://github.com/OCA/rest-framework/tree/17.0/fastapi_auth_api_key
+    :alt: OCA/rest-framework
+.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
+    :target: https://translation.odoo-community.org/projects/rest-framework-17-0/rest-framework-17-0-fastapi_auth_api_key
+    :alt: Translate me on Weblate
+.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
+    :target: https://runboat.odoo-community.org/builds?repo=OCA/rest-framework&target_branch=17.0
+    :alt: Try me on Runboat
+
+|badge1| |badge2| |badge3| |badge4| |badge5|
+
+Provides FastAPI dependencies for Api Key authentication.
+
+**Table of contents**
+
+.. contents::
+   :local:
+
+Usage
+=====
+
+Getting an odoo environment
+---------------------------
+
+If you need to get an odoo env based on the provided api key, you can
+use authenticated_env_by_auth_api_key.
+
+.. code:: python
+
+   @router.get("/example_with_authenticated_env")
+   def example_with_authenticated_env(
+       env: Annotated[Environment, Depends(authenticated_env_by_auth_api_key)],
+   ) -> None:
+       # env.user is the user attached to the provided key
+       pass
+
+Getting the authenticated partner
+---------------------------------
+
+If want to get the partned related to the the provided api key, you can
+use authenticated_partner_by_api_key
+
+.. code:: python
+
+   @router.get("/example_with_authenticated_partner")
+   def example_with_authenticated_partner(
+       partner: Annotated[Partner, Depends(authenticated_partner_by_api_key)],
+   ) -> None:
+       # partner is the partner related to the provided key key.user_id.partner_id
+       pass
+
+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.
+
+Bug Tracker
+===========
+
+Bugs are tracked on `GitHub Issues <https://github.com/OCA/rest-framework/issues>`_.
+In case of trouble, please check there if your issue has already been reported.
+If you spotted it first, help us to smash it by providing a detailed and welcomed
+`feedback <https://github.com/OCA/rest-framework/issues/new?body=module:%20fastapi_auth_api_key%0Aversion:%2017.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
+
+Do not contact contributors directly about support or help with technical issues.
+
+Credits
+=======
+
+Authors
+-------
+
+* Camptocamp
+
+Contributors
+------------
+
+- Matthieu Méquignon <matthieu.mequignon@camptocamp.com>
+- Son Ho <sonhd@trobz.com>
+
+Other credits
+-------------
+
+The migration of this module from 16.0 to 17.0 was financially supported
+by Camptocamp
+
+Maintainers
+-----------
+
+This module is maintained by the OCA.
+
+.. image:: https://odoo-community.org/logo.png
+   :alt: Odoo Community Association
+   :target: https://odoo-community.org
+
+OCA, or the Odoo Community Association, is a nonprofit organization whose
+mission is to support the collaborative development of Odoo features and
+promote its widespread use.
+
+.. |maintainer-mmequignon| image:: https://github.com/mmequignon.png?size=40px
+    :target: https://github.com/mmequignon
+    :alt: mmequignon
+
+Current `maintainer <https://odoo-community.org/page/maintainer-role>`__:
+
+|maintainer-mmequignon| 
+
+This module is part of the `OCA/rest-framework <https://github.com/OCA/rest-framework/tree/17.0/fastapi_auth_api_key>`_ project on GitHub.
+
+You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

odoo_addon_fastapi_auth_api_key-17.0.1.0.0.2.dist-info/RECORD

@@ -0,0 +1,19 @@
+odoo/addons/fastapi_auth_api_key/README.rst,sha256=3_NEw2Cs2g_lLF6ecNG58dQFItqC1oTle1CvVd4oOrc,4539
+odoo/addons/fastapi_auth_api_key/__init__.py,sha256=X9EJGOE2GtZbS0G82PtSXmWSZ_R8jEM0rlJTDliQjp4,21
+odoo/addons/fastapi_auth_api_key/__manifest__.py,sha256=MczNigaWO00mSBj0Onx1Zs5i-fysEoRe9JW7cPb2i7w,525
+odoo/addons/fastapi_auth_api_key/dependencies.py,sha256=L8-MovwUEyLbHSqRgM1jOk613hnR3okL8IxUl0MJ-Ok,2472
+odoo/addons/fastapi_auth_api_key/models/__init__.py,sha256=NF75IvaT9G60mgm2FqAkfw91SzMZ9m7CL41HiOD3rj4,31
+odoo/addons/fastapi_auth_api_key/models/fastapi_endpoint.py,sha256=o6mY2tDaq0O48zZEW9HtyLwH5CZlD-hedJJju8y2ZaM,364
+odoo/addons/fastapi_auth_api_key/readme/CONTRIBUTORS.md,sha256=mx3lro8qYrF4g6_PfPHtP67Hgg0ZxjWogLbPCTndOTo,93
+odoo/addons/fastapi_auth_api_key/readme/CREDITS.md,sha256=my2DTaWSAwefqnxfRSXjioSzh2xziwgUHxLCcdypQuk,87
+odoo/addons/fastapi_auth_api_key/readme/DESCRIPTION.md,sha256=6b3Y62QEGlT7pl5KClLfoFKUiRZRszvLGLjKhs8hx3w,58
+odoo/addons/fastapi_auth_api_key/readme/USAGE.md,sha256=RJKRqTYkJzfYgei0op3Cv760AYe2fS3zds8cTqCN9FI,978
+odoo/addons/fastapi_auth_api_key/static/description/icon.png,sha256=CgnOEZCwoe6f1vlLwkqFVfc2q_uwBMU0UnXN8j6X5ag,10254
+odoo/addons/fastapi_auth_api_key/static/description/index.html,sha256=cJaH4ZOi11VMtG9IyLN-2F95ZV5zvDidBurJw4bG25Y,7729
+odoo/addons/fastapi_auth_api_key/tests/__init__.py,sha256=bYedQRS3KDphc7VnwZSrJ-EPD0joTC8XCtSmXI6g2_Q,48
+odoo/addons/fastapi_auth_api_key/tests/test_fastapi_api_key_dependencies.py,sha256=a9IHS-3pMzm5F1vSx_pip9_lzY1v5XOBU6s4lDMcPuo,4412
+odoo/addons/fastapi_auth_api_key/views/fastapi_endpoint.xml,sha256=QP05xAoftf5XEdjYEfKdf9WplCkPFTzVs-m86TP_YHg,599
+odoo_addon_fastapi_auth_api_key-17.0.1.0.0.2.dist-info/METADATA,sha256=GuLlHUTxrhBIM6U0MNlJXoDr5PK0r-Qq3_7dQUoXkTw,5210
+odoo_addon_fastapi_auth_api_key-17.0.1.0.0.2.dist-info/WHEEL,sha256=ZhOvUsYhy81Dx67gN3TV0RchQWBIIzutDZaJODDg2Vo,81
+odoo_addon_fastapi_auth_api_key-17.0.1.0.0.2.dist-info/top_level.txt,sha256=QE6RBQ0QX5f4eFuUcGgU5Kbq1A_qJcDs-e_vpr6pmfU,4
+odoo_addon_fastapi_auth_api_key-17.0.1.0.0.2.dist-info/RECORD,,

odoo_addon_fastapi_auth_api_key-17.0.1.0.0.2.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: Whool 1.3
+Root-Is-Purelib: true
+Tag: py3-none-any
+

odoo_addon_fastapi_auth_api_key-17.0.1.0.0.2.dist-info/top_level.txt

@@ -0,0 +1 @@
+odoo