From 82e7d56aee163e1bd1597b8bef3201e1dadedd61 Mon Sep 17 00:00:00 2001 From: Enric Tobella Date: Fri, 31 Jul 2026 14:49:34 +0200 Subject: [PATCH 1/2] [IMP] endpoint_route_handler: Add a hook for filtering --- endpoint_route_handler/models/ir_http.py | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/endpoint_route_handler/models/ir_http.py b/endpoint_route_handler/models/ir_http.py index e7b83c72..df8cedcc 100644 --- a/endpoint_route_handler/models/ir_http.py +++ b/endpoint_route_handler/models/ir_http.py @@ -28,11 +28,17 @@ def _generate_routing_rules(self, modules, converters): self._endpoint_routing_rules(), ) + @classmethod + def _endpoint_routing_rules_kwargs(cls): + return {} + @classmethod def _endpoint_routing_rules(cls): """Yield custom endpoint rules""" e_registry = cls._endpoint_route_registry(http.request.env) - for endpoint_rule in e_registry.get_rules(): + for endpoint_rule in e_registry.get_rules( + **cls._endpoint_routing_rules_kwargs() + ): _logger.debug("LOADING %s", endpoint_rule) endpoint = endpoint_rule.endpoint for url in endpoint_rule.routing["routes"]: From ec9e883bec1946809aa79b700518cdb2d83a553c Mon Sep 17 00:00:00 2001 From: Enric Tobella Date: Fri, 31 Jul 2026 15:00:22 +0200 Subject: [PATCH 2/2] [ADD] endpoint_route_handler_filter: add new module for filtering --- endpoint_route_handler_filter/README.rst | 194 +++++++ endpoint_route_handler_filter/__init__.py | 1 + endpoint_route_handler_filter/__manifest__.py | 15 + .../models/__init__.py | 1 + .../models/ir_http.py | 40 ++ endpoint_route_handler_filter/pyproject.toml | 3 + .../readme/CONFIGURE.md | 39 ++ .../readme/CONTEXT.md | 41 ++ .../readme/CONTRIBUTORS.md | 2 + .../readme/DESCRIPTION.md | 18 + .../static/description/icon.png.oca | Bin 0 -> 9455 bytes .../static/description/index.html | 542 ++++++++++++++++++ 12 files changed, 896 insertions(+) create mode 100644 endpoint_route_handler_filter/README.rst create mode 100644 endpoint_route_handler_filter/__init__.py create mode 100644 endpoint_route_handler_filter/__manifest__.py create mode 100644 endpoint_route_handler_filter/models/__init__.py create mode 100644 endpoint_route_handler_filter/models/ir_http.py create mode 100644 endpoint_route_handler_filter/pyproject.toml create mode 100644 endpoint_route_handler_filter/readme/CONFIGURE.md create mode 100644 endpoint_route_handler_filter/readme/CONTEXT.md create mode 100644 endpoint_route_handler_filter/readme/CONTRIBUTORS.md create mode 100644 endpoint_route_handler_filter/readme/DESCRIPTION.md create mode 100644 endpoint_route_handler_filter/static/description/icon.png.oca create mode 100644 endpoint_route_handler_filter/static/description/index.html diff --git a/endpoint_route_handler_filter/README.rst b/endpoint_route_handler_filter/README.rst new file mode 100644 index 00000000..c8b3c437 --- /dev/null +++ b/endpoint_route_handler_filter/README.rst @@ -0,0 +1,194 @@ +.. image:: https://odoo-community.org/readme-banner-image + :target: https://odoo-community.org/get-involved?utm_source=readme + :alt: Odoo Community Association + +============================= +Endpoint Route Handler Filter +============================= + +.. + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! source digest: sha256:ca628323cca8616be9a95ead4ca25834b144f54fdeeb0277d7d453db02c914bc + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |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%2Fweb--api-lightgray.png?logo=github + :target: https://github.com/OCA/web-api/tree/19.0/endpoint_route_handler_filter + :alt: OCA/web-api +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png + :target: https://translation.odoo-community.org/projects/web-api-19-0/web-api-19-0-endpoint_route_handler_filter + :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/web-api&target_branch=19.0 + :alt: Try me on Runboat + +|badge1| |badge2| |badge3| |badge4| |badge5| + +This module allows FastAPI-based endpoints (built on top of ``fastapi`` +/ ``OCA/rest-framework``) to be selectively registered depending on the +Odoo **process** that is running, instead of always being exposed on +every worker regardless of which port it listens on. + +This makes it possible to run two (or more) Odoo processes against the +same database: + +- a **public** process (e.g. port 8069) that never registers the + internal endpoints, and +- an **internal** process (e.g. port 8070), reachable only from a + trusted network (VPN, internal VLAN, firewall rule), that does + register them. + +The module does not implement any authentication, authorization, or +network restriction itself — that is left to the FastAPI endpoint's own +auth mechanism (API key, JWT, etc.) and to your reverse proxy / firewall +configuration. It only controls **route existence** per process. + +**Table of contents** + +.. contents:: + :local: + +Use Cases / Context +=================== + +Odoo serves all registered controllers — standard web controllers as +well as any FastAPI endpoints mounted via ``fastapi.endpoint`` — through +a single WSGI application, regardless of which port (``http_port`` / +longpolling port) a given worker process is listening on. There is no +built-in mechanism to say "these routes exist only on port X." + +In practice this means that once a FastAPI endpoint is installed, it is +reachable from every process and every port Odoo happens to be running +on, including the main public-facing one. Restricting access to it then +falls entirely on network-level controls (reverse proxy IP allowlists, +firewall rules), which: + +- protect the network path to the endpoint, but not the fact that the + route exists on every process, and +- offer no protection against a request that legitimately originates + from an allowed network (e.g. a compromised internal host). + +For internal, technical, or automation-only endpoints — where the goal +is to expose a narrow set of actions to internal systems without +enlarging the attack surface of the main public Odoo instance — it is +preferable that the routes simply do not exist on the public process at +all. + +This module addresses that by making route registration conditional on a +process-local setting (not a database value, since +``ir.config_parameter`` is shared across all processes and workers +connected to the same database and would not allow differentiating +between them). This allows a deployment pattern of two Odoo processes, +same codebase and database, started with different configuration: + +- one process without the flag → internal routes never registered + (public, e.g. port 8069), +- one process with the flag → internal routes registered (internal only, + e.g. port 8070, restricted at the network layer to trusted sources). + +Network-level restriction (firewall/reverse proxy) and endpoint-level +authentication (JWT/API key on the FastAPI app) remain necessary and are +complementary to this module, not replaced by it. This module removes +one layer of exposure (route existence on the public process); it does +not replace access control on the internal one. + +Configuration +============= + +The module reads a single process-local setting to decide whether to +register the internal endpoint routes. It does **not** read this setting +from ``ir.config_parameter``, since that table is shared by every +process and worker connected to the same database and would not allow +two processes to behave differently. + +Choose **one** of the two mechanisms below, matching what the code +implements. + +Option A — Environment variable +------------------------------- + +Set ODOO_ENDPOINT_ROUTE_HANDLER_FILTER_GROUP for setting the allowed +route groups. + +Set ODOO_ENDPOINT_ROUTE_HANDLER_FILTER_IGNORE to ignore some route +groups. + +Option B — Config file key +-------------------------- + +Add ``odoo_endpoint_route_handler_ignore`` and +``odoo_endpoint_route_handler_filter`` under ``[options]`` in the config +file used to start the internal process only. Odoo's config loader +accepts undeclared keys from the config file (it just won't accept them +as CLI flags), so no changes to Odoo core are required. + +.. code:: ini + + ; odoo_public.conf + [options] + http_port = 8069 + odoo_endpoint_route_handler_ignore = internal,my_other_route ; internal and my_other_route are not accepted + + + ; odoo_internal.conf + [options] + http_port = 8070 + odoo_endpoint_route_handler_filter = internal,my_other_route ; Only internal and my_other_route are accepted + +Notes +----- + +- If you run the internal process with ``--workers=N``, all N worker + processes inherit the same setting — this is expected and desired. +- The setting only affects whether the routes are added to the routing + map. It does not grant or restrict any permission by itself. + +Bug Tracker +=========== + +Bugs are tracked on `GitHub 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 `_. + +Do not contact contributors directly about support or help with technical issues. + +Credits +======= + +Authors +------- + +* Dixmit + +Contributors +------------ + +- `Dixmit `__ + + - Enric Tobella + +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. + +This module is part of the `OCA/web-api `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/endpoint_route_handler_filter/__init__.py b/endpoint_route_handler_filter/__init__.py new file mode 100644 index 00000000..0650744f --- /dev/null +++ b/endpoint_route_handler_filter/__init__.py @@ -0,0 +1 @@ +from . import models diff --git a/endpoint_route_handler_filter/__manifest__.py b/endpoint_route_handler_filter/__manifest__.py new file mode 100644 index 00000000..6b38fb57 --- /dev/null +++ b/endpoint_route_handler_filter/__manifest__.py @@ -0,0 +1,15 @@ +# Copyright 2026 Dixmit +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). + +{ + "name": "Endpoint Route Handler Filter", + "summary": """This Addon allows us to filter the route handler + depending on the instance. This way we can have dedicated runners.""", + "version": "19.0.1.0.0", + "license": "AGPL-3", + "author": "Dixmit,Odoo Community Association (OCA)", + "website": "https://github.com/OCA/web-api", + "depends": [ + "endpoint_route_handler", + ], +} diff --git a/endpoint_route_handler_filter/models/__init__.py b/endpoint_route_handler_filter/models/__init__.py new file mode 100644 index 00000000..9a5eb718 --- /dev/null +++ b/endpoint_route_handler_filter/models/__init__.py @@ -0,0 +1 @@ +from . import ir_http diff --git a/endpoint_route_handler_filter/models/ir_http.py b/endpoint_route_handler_filter/models/ir_http.py new file mode 100644 index 00000000..4d0ceb02 --- /dev/null +++ b/endpoint_route_handler_filter/models/ir_http.py @@ -0,0 +1,40 @@ +# Copyright 2021 Camptocamp SA +# @author: Simone Orsi +# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl). + +import logging +import os + +from odoo import models, tools + +_logger = logging.getLogger(__name__) + + +class IrHttp(models.AbstractModel): + _inherit = "ir.http" + + @classmethod + def _endpoint_routing_rules_kwargs(cls): + result = super()._endpoint_routing_rules_kwargs() + group_filter = tools.config.get( + "odoo_endpoint_route_handler_filter" + ) or os.getenv("ODOO_ENDPOINT_ROUTE_HANDLER_FILTER_GROUP") + no_group_filter = tools.config.get( + "odoo_endpoint_route_handler_ignore" + ) or os.getenv("ODOO_ENDPOINT_ROUTE_HANDLER_FILTER_IGNORE") + if not group_filter and not no_group_filter: + return result + where = result.get("where") + if where: + where += " AND " + else: + where = "WHERE " + conditions = [] + if group_filter: + group_filter_sql = "','".join(group_filter.split(",")) + conditions.append(f"route_group in ('{group_filter_sql}')") + if no_group_filter: + no_group_filter_sql = "','".join(no_group_filter.split(",")) + conditions.append(f"route_group not in ('{no_group_filter_sql}')") + result.update({"where": f"{where} {' AND '.join(conditions)}"}) + return result diff --git a/endpoint_route_handler_filter/pyproject.toml b/endpoint_route_handler_filter/pyproject.toml new file mode 100644 index 00000000..4231d0cc --- /dev/null +++ b/endpoint_route_handler_filter/pyproject.toml @@ -0,0 +1,3 @@ +[build-system] +requires = ["whool"] +build-backend = "whool.buildapi" diff --git a/endpoint_route_handler_filter/readme/CONFIGURE.md b/endpoint_route_handler_filter/readme/CONFIGURE.md new file mode 100644 index 00000000..c1f8f4d1 --- /dev/null +++ b/endpoint_route_handler_filter/readme/CONFIGURE.md @@ -0,0 +1,39 @@ +The module reads a single process-local setting to decide whether to +register the internal endpoint routes. It does **not** read this setting +from `ir.config_parameter`, since that table is shared by every process +and worker connected to the same database and would not allow two +processes to behave differently. + +Choose **one** of the two mechanisms below, matching what the code +implements. + +## Option A — Environment variable + +Set ODOO_ENDPOINT_ROUTE_HANDLER_FILTER_GROUP for setting the allowed route groups. + +Set ODOO_ENDPOINT_ROUTE_HANDLER_FILTER_IGNORE to ignore some route groups. + +## Option B — Config file key + +Add `odoo_endpoint_route_handler_ignore` and `odoo_endpoint_route_handler_filter` under `[options]` in the config file used to start the internal process only. +Odoo's config loader accepts undeclared keys from the config file (it just won't accept them as CLI flags), so no changes to Odoo core are required. + +```ini +; odoo_public.conf +[options] +http_port = 8069 +odoo_endpoint_route_handler_ignore = internal,my_other_route ; internal and my_other_route are not accepted + + +; odoo_internal.conf +[options] +http_port = 8070 +odoo_endpoint_route_handler_filter = internal,my_other_route ; Only internal and my_other_route are accepted +``` + +## Notes + +- If you run the internal process with `--workers=N`, all N worker + processes inherit the same setting — this is expected and desired. +- The setting only affects whether the routes are added to the routing + map. It does not grant or restrict any permission by itself. diff --git a/endpoint_route_handler_filter/readme/CONTEXT.md b/endpoint_route_handler_filter/readme/CONTEXT.md new file mode 100644 index 00000000..4f87ad4a --- /dev/null +++ b/endpoint_route_handler_filter/readme/CONTEXT.md @@ -0,0 +1,41 @@ +Odoo serves all registered controllers — standard web controllers as +well as any FastAPI endpoints mounted via `fastapi.endpoint` — through a +single WSGI application, regardless of which port (`http_port` / +longpolling port) a given worker process is listening on. There is no +built-in mechanism to say "these routes exist only on port X." + +In practice this means that once a FastAPI endpoint is installed, it is +reachable from every process and every port Odoo happens to be running +on, including the main public-facing one. Restricting access to it then +falls entirely on network-level controls (reverse proxy IP allowlists, +firewall rules), which: + +- protect the network path to the endpoint, but not the fact that the + route exists on every process, and +- offer no protection against a request that legitimately originates + from an allowed network (e.g. a compromised internal host). + +For internal, technical, or automation-only endpoints — where the goal +is to expose a narrow set of actions to internal systems without +enlarging the attack surface of the main public Odoo instance — it is +preferable that the routes simply do not exist on the public process at +all. + +This module addresses that by making route registration conditional on +a process-local setting (not a database value, since `ir.config_parameter` +is shared across all processes and workers connected to the same +database and would not allow differentiating between them). This allows +a deployment pattern of two Odoo processes, same codebase and database, +started with different configuration: + +- one process without the flag → internal routes never registered + (public, e.g. port 8069), +- one process with the flag → internal routes registered (internal + only, e.g. port 8070, restricted at the network layer to trusted + sources). + +Network-level restriction (firewall/reverse proxy) and endpoint-level +authentication (JWT/API key on the FastAPI app) remain necessary and are +complementary to this module, not replaced by it. This module removes +one layer of exposure (route existence on the public process); it does +not replace access control on the internal one. diff --git a/endpoint_route_handler_filter/readme/CONTRIBUTORS.md b/endpoint_route_handler_filter/readme/CONTRIBUTORS.md new file mode 100644 index 00000000..4695794a --- /dev/null +++ b/endpoint_route_handler_filter/readme/CONTRIBUTORS.md @@ -0,0 +1,2 @@ +- [Dixmit](https://dixmit.com) + - Enric Tobella diff --git a/endpoint_route_handler_filter/readme/DESCRIPTION.md b/endpoint_route_handler_filter/readme/DESCRIPTION.md new file mode 100644 index 00000000..30f72027 --- /dev/null +++ b/endpoint_route_handler_filter/readme/DESCRIPTION.md @@ -0,0 +1,18 @@ +This module allows FastAPI-based endpoints (built on top of `fastapi` / +`OCA/rest-framework`) to be selectively registered depending on the Odoo +**process** that is running, instead of always being exposed on every worker +regardless of which port it listens on. + +This makes it possible to run two (or more) Odoo processes against the +same database: + +- a **public** process (e.g. port 8069) that never registers the + internal endpoints, and +- an **internal** process (e.g. port 8070), reachable only from a + trusted network (VPN, internal VLAN, firewall rule), that does + register them. + +The module does not implement any authentication, authorization, or +network restriction itself — that is left to the FastAPI endpoint's own +auth mechanism (API key, JWT, etc.) and to your reverse proxy / firewall +configuration. It only controls **route existence** per process. diff --git a/endpoint_route_handler_filter/static/description/icon.png.oca b/endpoint_route_handler_filter/static/description/icon.png.oca new file mode 100644 index 0000000000000000000000000000000000000000..3a0328b516c4980e8e44cdb63fd945757ddd132d GIT binary patch literal 9455 zcmW++2RxMjAAjx~&dlBk9S+%}OXg)AGE&Cb*&}d0jUxM@u(PQx^-s)697TX`ehR4?GS^qbkof1cslKgkU)h65qZ9Oc=ml_0temigYLJfnz{IDzUf>bGs4N!v3=Z3jMq&A#7%rM5eQ#dc?k~! zVpnB`o+K7|Al`Q_U;eD$B zfJtP*jH`siUq~{KE)`jP2|#TUEFGRryE2`i0**z#*^6~AI|YzIWy$Cu#CSLW3q=GA z6`?GZymC;dCPk~rBS%eCb`5OLr;RUZ;D`}um=H)BfVIq%7VhiMr)_#G0N#zrNH|__ zc+blN2UAB0=617@>_u;MPHN;P;N#YoE=)R#i$k_`UAA>WWCcEVMh~L_ zj--gtp&|K1#58Yz*AHCTMziU1Jzt_jG0I@qAOHsk$2}yTmVkBp_eHuY$A9)>P6o~I z%aQ?!(GqeQ-Y+b0I(m9pwgi(IIZZzsbMv+9w{PFtd_<_(LA~0H(xz{=FhLB@(1&qHA5EJw1>>=%q2f&^X>IQ{!GJ4e9U z&KlB)z(84HmNgm2hg2C0>WM{E(DdPr+EeU_N@57;PC2&DmGFW_9kP&%?X4}+xWi)( z;)z%wI5>D4a*5XwD)P--sPkoY(a~WBw;E~AW`Yue4kFa^LM3X`8x|}ZUeMnqr}>kH zG%WWW>3ml$Yez?i%)2pbKPI7?5o?hydokgQyZsNEr{a|mLdt;X2TX(#B1j35xPnPW z*bMSSOauW>o;*=kO8ojw91VX!qoOQb)zHJ!odWB}d+*K?#sY_jqPdg{Sm2HdYzdEx zOGVPhVRTGPtv0o}RfVP;Nd(|CB)I;*t&QO8h zFfekr30S!-LHmV_Su-W+rEwYXJ^;6&3|L$mMC8*bQptyOo9;>Qb9Q9`ySe3%V$A*9 zeKEe+b0{#KWGp$F+tga)0RtI)nhMa-K@JS}2krK~n8vJ=Ngm?R!9G<~RyuU0d?nz# z-5EK$o(!F?hmX*2Yt6+coY`6jGbb7tF#6nHA zuKk=GGJ;ZwON1iAfG$E#Y7MnZVmrY|j0eVI(DN_MNFJmyZ|;w4tf@=CCDZ#5N_0K= z$;R~bbk?}TpfDjfB&aiQ$VA}s?P}xPERJG{kxk5~R`iRS(SK5d+Xs9swCozZISbnS zk!)I0>t=A<-^z(cmSFz3=jZ23u13X><0b)P)^1T_))Kr`e!-pb#q&J*Q`p+B6la%C zuVl&0duN<;uOsB3%T9Fp8t{ED108<+W(nOZd?gDnfNBC3>M8WE61$So|P zVvqH0SNtDTcsUdzaMDpT=Ty0pDHHNL@Z0w$Y`XO z2M-_r1S+GaH%pz#Uy0*w$Vdl=X=rQXEzO}d6J^R6zjM1u&c9vYLvLp?W7w(?np9x1 zE_0JSAJCPB%i7p*Wvg)pn5T`8k3-uR?*NT|J`eS#_#54p>!p(mLDvmc-3o0mX*mp_ zN*AeS<>#^-{S%W<*mz^!X$w_2dHWpcJ6^j64qFBft-o}o_Vx80o0>}Du;>kLts;$8 zC`7q$QI(dKYG`Wa8#wl@V4jVWBRGQ@1dr-hstpQL)Tl+aqVpGpbSfN>5i&QMXfiZ> zaA?T1VGe?rpQ@;+pkrVdd{klI&jVS@I5_iz!=UMpTsa~mBga?1r}aRBm1WS;TT*s0f0lY=JBl66Upy)-k4J}lh=P^8(SXk~0xW=T9v*B|gzIhN z>qsO7dFd~mgxAy4V?&)=5ieYq?zi?ZEoj)&2o)RLy=@hbCRcfT5jigwtQGE{L*8<@Yd{zg;CsL5mvzfDY}P-wos_6PfprFVaeqNE%h zKZhLtcQld;ZD+>=nqN~>GvROfueSzJD&BE*}XfU|H&(FssBqY=hPCt`d zH?@s2>I(|;fcW&YM6#V#!kUIP8$Nkdh0A(bEVj``-AAyYgwY~jB zT|I7Bf@%;7aL7Wf4dZ%VqF$eiaC38OV6oy3Z#TER2G+fOCd9Iaoy6aLYbPTN{XRPz z;U!V|vBf%H!}52L2gH_+j;`bTcQRXB+y9onc^wLm5wi3-Be}U>k_u>2Eg$=k!(l@I zcCg+flakT2Nej3i0yn+g+}%NYb?ta;R?(g5SnwsQ49U8Wng8d|{B+lyRcEDvR3+`O{zfmrmvFrL6acVP%yG98X zo&+VBg@px@i)%o?dG(`T;n*$S5*rnyiR#=wW}}GsAcfyQpE|>a{=$Hjg=-*_K;UtD z#z-)AXwSRY?OPefw^iI+ z)AXz#PfEjlwTes|_{sB?4(O@fg0AJ^g8gP}ex9Ucf*@_^J(s_5jJV}c)s$`Myn|Kd z$6>}#q^n{4vN@+Os$m7KV+`}c%4)4pv@06af4-x5#wj!KKb%caK{A&Y#Rfs z-po?Dcb1({W=6FKIUirH&(yg=*6aLCekcKwyfK^JN5{wcA3nhO(o}SK#!CINhI`-I z1)6&n7O&ZmyFMuNwvEic#IiOAwNkR=u5it{B9n2sAJV5pNhar=j5`*N!Na;c7g!l$ z3aYBqUkqqTJ=Re-;)s!EOeij=7SQZ3Hq}ZRds%IM*PtM$wV z@;rlc*NRK7i3y5BETSKuumEN`Xu_8GP1Ri=OKQ$@I^ko8>H6)4rjiG5{VBM>B|%`&&s^)jS|-_95&yc=GqjNo{zFkw%%HHhS~e=s zD#sfS+-?*t|J!+ozP6KvtOl!R)@@-z24}`9{QaVLD^9VCSR2b`b!KC#o;Ki<+wXB6 zx3&O0LOWcg4&rv4QG0)4yb}7BFSEg~=IR5#ZRj8kg}dS7_V&^%#Do==#`u zpy6{ox?jWuR(;pg+f@mT>#HGWHAJRRDDDv~@(IDw&R>9643kK#HN`!1vBJHnC+RM&yIh8{gG2q zA%e*U3|N0XSRa~oX-3EAneep)@{h2vvd3Xvy$7og(sayr@95+e6~Xvi1tUqnIxoIH zVWo*OwYElb#uyW{Imam6f2rGbjR!Y3`#gPqkv57dB6K^wRGxc9B(t|aYDGS=m$&S!NmCtrMMaUg(c zc2qC=2Z`EEFMW-me5B)24AqF*bV5Dr-M5ig(l-WPS%CgaPzs6p_gnCIvTJ=Y<6!gT zVt@AfYCzjjsMEGi=rDQHo0yc;HqoRNnNFeWZgcm?f;cp(6CNylj36DoL(?TS7eU#+ z7&mfr#y))+CJOXQKUMZ7QIdS9@#-}7y2K1{8)cCt0~-X0O!O?Qx#E4Og+;A2SjalQ zs7r?qn0H044=sDN$SRG$arw~n=+T_DNdSrarmu)V6@|?1-ZB#hRn`uilTGPJ@fqEy zGt(f0B+^JDP&f=r{#Y_wi#AVDf-y!RIXU^0jXsFpf>=Ji*TeqSY!H~AMbJdCGLhC) zn7Rx+sXw6uYj;WRYrLd^5IZq@6JI1C^YkgnedZEYy<&4(z%Q$5yv#Boo{AH8n$a zhb4Y3PWdr269&?V%uI$xMcUrMzl=;w<_nm*qr=c3Rl@i5wWB;e-`t7D&c-mcQl7x! zZWB`UGcw=Y2=}~wzrfLx=uet<;m3~=8I~ZRuzvMQUQdr+yTV|ATf1Uuomr__nDf=X zZ3WYJtHp_ri(}SQAPjv+Y+0=fH4krOP@S&=zZ-t1jW1o@}z;xk8 z(Nz1co&El^HK^NrhVHa-_;&88vTU>_J33=%{if;BEY*J#1n59=07jrGQ#IP>@u#3A z;!q+E1Rj3ZJ+!4bq9F8PXJ@yMgZL;>&gYA0%_Kbi8?S=XGM~dnQZQ!yBSgcZhY96H zrWnU;k)qy`rX&&xlDyA%(a1Hhi5CWkmg(`Gb%m(HKi-7Z!LKGRP_B8@`7&hdDy5n= z`OIxqxiVfX@OX1p(mQu>0Ai*v_cTMiw4qRt3~NBvr9oBy0)r>w3p~V0SCm=An6@3n)>@z!|o-$HvDK z|3D2ZMJkLE5loMKl6R^ez@Zz%S$&mbeoqH5`Bb){Ei21q&VP)hWS2tjShfFtGE+$z zzCR$P#uktu+#!w)cX!lWN1XU%K-r=s{|j?)Akf@q#3b#{6cZCuJ~gCxuMXRmI$nGtnH+-h z+GEi!*X=AP<|fG`1>MBdTb?28JYc=fGvAi2I<$B(rs$;eoJCyR6_bc~p!XR@O-+sD z=eH`-ye})I5ic1eL~TDmtfJ|8`0VJ*Yr=hNCd)G1p2MMz4C3^Mj?7;!w|Ly%JqmuW zlIEW^Ft%z?*|fpXda>Jr^1noFZEwFgVV%|*XhH@acv8rdGxeEX{M$(vG{Zw+x(ei@ zmfXb22}8-?Fi`vo-YVrTH*C?a8%M=Hv9MqVH7H^J$KsD?>!SFZ;ZsvnHr_gn=7acz z#W?0eCdVhVMWN12VV^$>WlQ?f;P^{(&pYTops|btm6aj>_Uz+hqpGwB)vWp0Cf5y< zft8-je~nn?W11plq}N)4A{l8I7$!ks_x$PXW-2XaRFswX_BnF{R#6YIwMhAgd5F9X zGmwdadS6(a^fjHtXg8=l?Rc0Sm%hk6E9!5cLVloEy4eh(=FwgP`)~I^5~pBEWo+F6 zSf2ncyMurJN91#cJTy_u8Y}@%!bq1RkGC~-bV@SXRd4F{R-*V`bS+6;W5vZ(&+I<9$;-V|eNfLa5n-6% z2(}&uGRF;p92eS*sE*oR$@pexaqr*meB)VhmIg@h{uzkk$9~qh#cHhw#>O%)b@+(| z^IQgqzuj~Sk(J;swEM-3TrJAPCq9k^^^`q{IItKBRXYe}e0Tdr=Huf7da3$l4PdpwWDop%^}n;dD#K4s#DYA8SHZ z&1!riV4W4R7R#C))JH1~axJ)RYnM$$lIR%6fIVA@zV{XVyx}C+a-Dt8Y9M)^KU0+H zR4IUb2CJ{Hg>CuaXtD50jB(_Tcx=Z$^WYu2u5kubqmwp%drJ6 z?Fo40g!Qd<-l=TQxqHEOuPX0;^z7iX?Ke^a%XT<13TA^5`4Xcw6D@Ur&VT&CUe0d} z1GjOVF1^L@>O)l@?bD~$wzgf(nxX1OGD8fEV?TdJcZc2KoUe|oP1#=$$7ee|xbY)A zDZq+cuTpc(fFdj^=!;{k03C69lMQ(|>uhRfRu%+!k&YOi-3|1QKB z z?n?eq1XP>p-IM$Z^C;2L3itnbJZAip*Zo0aw2bs8@(s^~*8T9go!%dHcAz2lM;`yp zD=7&xjFV$S&5uDaiScyD?B-i1ze`+CoRtz`Wn+Zl&#s4&}MO{@N!ufrzjG$B79)Y2d3tBk&)TxUTw@QS0TEL_?njX|@vq?Uz(nBFK5Pq7*xj#u*R&i|?7+6# z+|r_n#SW&LXhtheZdah{ZVoqwyT{D>MC3nkFF#N)xLi{p7J1jXlmVeb;cP5?e(=f# zuT7fvjSbjS781v?7{)-X3*?>tq?)Yd)~|1{BDS(pqC zC}~H#WXlkUW*H5CDOo<)#x7%RY)A;ShGhI5s*#cRDA8YgqG(HeKDx+#(ZQ?386dv! zlXCO)w91~Vw4AmOcATuV653fa9R$fyK8ul%rG z-wfS zihugoZyr38Im?Zuh6@RcF~t1anQu7>#lPpb#}4cOA!EM11`%f*07RqOVkmX{p~KJ9 z^zP;K#|)$`^Rb{rnHGH{~>1(fawV0*Z#)}M`m8-?ZJV<+e}s9wE# z)l&az?w^5{)`S(%MRzxdNqrs1n*-=jS^_jqE*5XDrA0+VE`5^*p3CuM<&dZEeCjoz zR;uu_H9ZPZV|fQq`Cyw4nscrVwi!fE6ciMmX$!_hN7uF;jjKG)d2@aC4ropY)8etW=xJvni)8eHi`H$%#zn^WJ5NLc-rqk|u&&4Z6fD_m&JfSI1Bvb?b<*n&sfl0^t z=HnmRl`XrFvMKB%9}>PaA`m-fK6a0(8=qPkWS5bb4=v?XcWi&hRY?O5HdulRi4?fN zlsJ*N-0Qw+Yic@s0(2uy%F@ib;GjXt01Fmx5XbRo6+n|pP(&nodMoap^z{~q ziEeaUT@Mxe3vJSfI6?uLND(CNr=#^W<1b}jzW58bIfyWTDle$mmS(|x-0|2UlX+9k zQ^EX7Nw}?EzVoBfT(-LT|=9N@^hcn-_p&sqG z&*oVs2JSU+N4ZD`FhCAWaS;>|wH2G*Id|?pa#@>tyxX`+4HyIArWDvVrX)2WAOQff z0qyHu&-S@i^MS-+j--!pr4fPBj~_8({~e1bfcl0wI1kaoN>mJL6KUPQm5N7lB(ui1 zE-o%kq)&djzWJ}ob<-GfDlkB;F31j-VHKvQUGQ3sp`CwyGJk_i!y^sD0fqC@$9|jO zOqN!r!8-p==F@ZVP=U$qSpY(gQ0)59P1&t@y?5rvg<}E+GB}26NYPp4f2YFQrQtot5mn3wu_qprZ=>Ig-$ zbW26Ws~IgY>}^5w`vTB(G`PTZaDiGBo5o(tp)qli|NeV( z@H_=R8V39rt5J5YB2Ky?4eJJ#b`_iBe2ot~6%7mLt5t8Vwi^Jy7|jWXqa3amOIoRb zOr}WVFP--DsS`1WpN%~)t3R!arKF^Q$e12KEqU36AWwnCBICpH4XCsfnyrHr>$I$4 z!DpKX$OKLWarN7nv@!uIA+~RNO)l$$w}p(;b>mx8pwYvu;dD_unryX_NhT8*Tj>BTrTTL&!?O+%Rv;b?B??gSzdp?6Uug9{ zd@V08Z$BdI?fpoCS$)t4mg4rT8Q_I}h`0d-vYZ^|dOB*Q^S|xqTV*vIg?@fVFSmMpaw0qtTRbx} z({Pg?#{2`sc9)M5N$*N|4;^t$+QP?#mov zGVC@I*lBVrOU-%2y!7%)fAKjpEFsgQc4{amtiHb95KQEwvf<(3T<9-Zm$xIew#P22 zc2Ix|App^>v6(3L_MCU0d3W##AB0M~3D00EWoKZqsJYT(#@w$Y_H7G22M~ApVFTRHMI_3be)Lkn#0F*V8Pq zc}`Cjy$bE;FJ6H7p=0y#R>`}-m4(0F>%@P|?7fx{=R^uFdISRnZ2W_xQhD{YuR3t< z{6yxu=4~JkeA;|(J6_nv#>Nvs&FuLA&PW^he@t(UwFFE8)|a!R{`E`K`i^ZnyE4$k z;(749Ix|oi$c3QbEJ3b~D_kQsPz~fIUKym($a_7dJ?o+40*OLl^{=&oq$<#Q(yyrp z{J-FAniyAw9tPbe&IhQ|a`DqFTVQGQ&Gq3!C2==4x{6EJwiPZ8zub-iXoUtkJiG{} zPaR&}_fn8_z~(=;5lD-aPWD3z8PZS@AaUiomF!G8I}Mf>e~0g#BelA-5#`cj;O5>N Xviia!U7SGha1wx#SCgwmn*{w2TRX*I literal 0 HcmV?d00001 diff --git a/endpoint_route_handler_filter/static/description/index.html b/endpoint_route_handler_filter/static/description/index.html new file mode 100644 index 00000000..d6ccf4bc --- /dev/null +++ b/endpoint_route_handler_filter/static/description/index.html @@ -0,0 +1,542 @@ + + + + + +README.rst + + + +
+ + + +Odoo Community Association + +
+

Endpoint Route Handler Filter

+ +

Beta License: AGPL-3 OCA/web-api Translate me on Weblate Try me on Runboat

+

This module allows FastAPI-based endpoints (built on top of fastapi +/ OCA/rest-framework) to be selectively registered depending on the +Odoo process that is running, instead of always being exposed on +every worker regardless of which port it listens on.

+

This makes it possible to run two (or more) Odoo processes against the +same database:

+
    +
  • a public process (e.g. port 8069) that never registers the +internal endpoints, and
    • +
  • an internal process (e.g. port 8070), reachable only from a +trusted network (VPN, internal VLAN, firewall rule), that does +register them.
    • +
+

The module does not implement any authentication, authorization, or +network restriction itself — that is left to the FastAPI endpoint’s own +auth mechanism (API key, JWT, etc.) and to your reverse proxy / firewall +configuration. It only controls route existence per process.

+

Table of contents

+ +
+

Use Cases / Context

+

Odoo serves all registered controllers — standard web controllers as +well as any FastAPI endpoints mounted via fastapi.endpoint — through +a single WSGI application, regardless of which port (http_port / +longpolling port) a given worker process is listening on. There is no +built-in mechanism to say “these routes exist only on port X.”

+

In practice this means that once a FastAPI endpoint is installed, it is +reachable from every process and every port Odoo happens to be running +on, including the main public-facing one. Restricting access to it then +falls entirely on network-level controls (reverse proxy IP allowlists, +firewall rules), which:

+
    +
  • protect the network path to the endpoint, but not the fact that the +route exists on every process, and
    • +
  • offer no protection against a request that legitimately originates +from an allowed network (e.g. a compromised internal host).
    • +
+

For internal, technical, or automation-only endpoints — where the goal +is to expose a narrow set of actions to internal systems without +enlarging the attack surface of the main public Odoo instance — it is +preferable that the routes simply do not exist on the public process at +all.

+

This module addresses that by making route registration conditional on a +process-local setting (not a database value, since +ir.config_parameter is shared across all processes and workers +connected to the same database and would not allow differentiating +between them). This allows a deployment pattern of two Odoo processes, +same codebase and database, started with different configuration:

+
    +
  • one process without the flag → internal routes never registered +(public, e.g. port 8069),
    • +
  • one process with the flag → internal routes registered (internal only, +e.g. port 8070, restricted at the network layer to trusted sources).
    • +
+

Network-level restriction (firewall/reverse proxy) and endpoint-level +authentication (JWT/API key on the FastAPI app) remain necessary and are +complementary to this module, not replaced by it. This module removes +one layer of exposure (route existence on the public process); it does +not replace access control on the internal one.

+
+
+

Configuration

+

The module reads a single process-local setting to decide whether to +register the internal endpoint routes. It does not read this setting +from ir.config_parameter, since that table is shared by every +process and worker connected to the same database and would not allow +two processes to behave differently.

+

Choose one of the two mechanisms below, matching what the code +implements.

+
+

Option A — Environment variable

+

Set ODOO_ENDPOINT_ROUTE_HANDLER_FILTER_GROUP for setting the allowed +route groups.

+

Set ODOO_ENDPOINT_ROUTE_HANDLER_FILTER_IGNORE to ignore some route +groups.

+
+
+

Option B — Config file key

+

Add odoo_endpoint_route_handler_ignore and +odoo_endpoint_route_handler_filter under [options] in the config +file used to start the internal process only. Odoo’s config loader +accepts undeclared keys from the config file (it just won’t accept them +as CLI flags), so no changes to Odoo core are required.

+
+; odoo_public.conf
+[options]
+http_port = 8069
+odoo_endpoint_route_handler_ignore = internal,my_other_route ; internal and my_other_route are not accepted
+
+
+; odoo_internal.conf
+[options]
+http_port = 8070
+odoo_endpoint_route_handler_filter = internal,my_other_route ; Only internal and my_other_route are accepted
+
+
+
+

Notes

+
    +
  • If you run the internal process with --workers=N, all N worker +processes inherit the same setting — this is expected and desired.
    • +
  • The setting only affects whether the routes are added to the routing +map. It does not grant or restrict any permission by itself.
    • +
+
+
+
+

Bug Tracker

+

Bugs are tracked on GitHub 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.

+

Do not contact contributors directly about support or help with technical issues.

+
+
+

Credits

+
+

Authors

+
    +
  • Dixmit
    • +
+
+
+

Contributors

+ +
+
+

Maintainers

+

This module is maintained by the OCA.

+ +Odoo Community Association + +

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.

+

This module is part of the OCA/web-api project on GitHub.

+

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

+
+
+
+
+ +