diff --git a/auth_oidc_environment/README.rst b/auth_oidc_environment/README.rst new file mode 100644 index 0000000000..fb3a8a86db --- /dev/null +++ b/auth_oidc_environment/README.rst @@ -0,0 +1,102 @@ +===================== +Auth Oidc Environment +===================== + +.. + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! source digest: sha256:18aa5a39b1804e3212b277bcc74b32f2297dca10bf1d3192c5fd659082b81150 + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |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/licence-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%2Fserver--auth-lightgray.png?logo=github + :target: https://github.com/OCA/server-auth/tree/18.0/auth_oidc_environment + :alt: OCA/server-auth +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png + :target: https://translation.odoo-community.org/projects/server-auth-18-0/server-auth-18-0-auth_oidc_environment + :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/server-auth&target_branch=18.0 + :alt: Try me on Runboat + +|badge1| |badge2| |badge3| |badge4| |badge5| + +this module allows to use server env for OIDC configuration + +**Table of contents** + +.. contents:: + :local: + +Configuration +============= + +To configure this module, you need to: + +Create a module server_environment_file with a cfg file or set the +environment variable SERVER_ENV_CONFIG with the following section: + +[auth_oauth_provider.] + +Where is optional and must be equal to the name field you defined +in Odoo for the IDP. + +Example of configuration + +[auth_oauth_provider.azure] + +client_id=... client_secret=... + +Usage +===== + +Once configured, Odoo will read the Auth Providers values from the +configuration. + +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 +------- + +* ACSONE SA/NV + +Contributors +------------ + +- Adrien PEIFFER (ACSONE SA/NV) +- Raphaël Reverdy (Akretion) + +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/server-auth `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/auth_oidc_environment/__init__.py b/auth_oidc_environment/__init__.py new file mode 100644 index 0000000000..0650744f6b --- /dev/null +++ b/auth_oidc_environment/__init__.py @@ -0,0 +1 @@ +from . import models diff --git a/auth_oidc_environment/__manifest__.py b/auth_oidc_environment/__manifest__.py new file mode 100644 index 0000000000..57b7f551a1 --- /dev/null +++ b/auth_oidc_environment/__manifest__.py @@ -0,0 +1,18 @@ +# Copyright 2023 ACSONE SA/NV +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). + +{ + "name": "Auth Oidc Environment", + "summary": """ + This module allows to use server env for OIDC configuration""", + "version": "18.0.1.0.0", + "license": "AGPL-3", + "author": "ACSONE SA/NV,Odoo Community Association (OCA)", + "website": "https://github.com/OCA/server-auth", + "depends": [ + "auth_oidc", + "server_environment", + ], + "data": [], + "demo": [], +} diff --git a/auth_oidc_environment/i18n/auth_oidc_environment.pot b/auth_oidc_environment/i18n/auth_oidc_environment.pot new file mode 100644 index 0000000000..c975dbe527 --- /dev/null +++ b/auth_oidc_environment/i18n/auth_oidc_environment.pot @@ -0,0 +1,24 @@ +# Translation of Odoo Server. +# This file contains the translation of the following modules: +# * auth_oidc_environment +# +msgid "" +msgstr "" +"Project-Id-Version: Odoo Server 16.0\n" +"Report-Msgid-Bugs-To: \n" +"Last-Translator: \n" +"Language-Team: \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: \n" +"Plural-Forms: \n" + +#. module: auth_oidc_environment +#: model:ir.model,name:auth_oidc_environment.model_auth_oauth_provider +msgid "OAuth2 provider" +msgstr "" + +#. module: auth_oidc_environment +#: model:ir.model.fields,field_description:auth_oidc_environment.field_auth_oauth_provider__server_env_defaults +msgid "Server Env Defaults" +msgstr "" diff --git a/auth_oidc_environment/i18n/it.po b/auth_oidc_environment/i18n/it.po new file mode 100644 index 0000000000..eea27c216c --- /dev/null +++ b/auth_oidc_environment/i18n/it.po @@ -0,0 +1,27 @@ +# Translation of Odoo Server. +# This file contains the translation of the following modules: +# * auth_oidc_environment +# +msgid "" +msgstr "" +"Project-Id-Version: Odoo Server 16.0\n" +"Report-Msgid-Bugs-To: \n" +"PO-Revision-Date: 2024-01-03 14:33+0000\n" +"Last-Translator: mymage \n" +"Language-Team: none\n" +"Language: it\n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: \n" +"Plural-Forms: nplurals=2; plural=n != 1;\n" +"X-Generator: Weblate 4.17\n" + +#. module: auth_oidc_environment +#: model:ir.model,name:auth_oidc_environment.model_auth_oauth_provider +msgid "OAuth2 provider" +msgstr "Provider OAuth2" + +#. module: auth_oidc_environment +#: model:ir.model.fields,field_description:auth_oidc_environment.field_auth_oauth_provider__server_env_defaults +msgid "Server Env Defaults" +msgstr "Server ambiente predefinito" diff --git a/auth_oidc_environment/models/__init__.py b/auth_oidc_environment/models/__init__.py new file mode 100644 index 0000000000..4bc62d3ab5 --- /dev/null +++ b/auth_oidc_environment/models/__init__.py @@ -0,0 +1 @@ +from . import auth_oauth_provider diff --git a/auth_oidc_environment/models/auth_oauth_provider.py b/auth_oidc_environment/models/auth_oauth_provider.py new file mode 100644 index 0000000000..40f6821cbe --- /dev/null +++ b/auth_oidc_environment/models/auth_oauth_provider.py @@ -0,0 +1,23 @@ +# Copyright 2023 ACSONE SA/NV +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). + +from odoo import api, models + + +class AuthOauthProvider(models.Model): + _name = "auth.oauth.provider" + _inherit = ["auth.oauth.provider", "server.env.mixin"] + + @property + def _server_env_fields(self): + base_fields = super()._server_env_fields + auth_fields = { + "client_id": {}, + "client_secret": {}, + } + auth_fields.update(base_fields) + return auth_fields + + @api.model + def _server_env_global_section_name(self): + return "auth_oauth_provider" diff --git a/auth_oidc_environment/pyproject.toml b/auth_oidc_environment/pyproject.toml new file mode 100644 index 0000000000..4231d0cccb --- /dev/null +++ b/auth_oidc_environment/pyproject.toml @@ -0,0 +1,3 @@ +[build-system] +requires = ["whool"] +build-backend = "whool.buildapi" diff --git a/auth_oidc_environment/readme/CONFIGURE.md b/auth_oidc_environment/readme/CONFIGURE.md new file mode 100644 index 0000000000..3ab09897d0 --- /dev/null +++ b/auth_oidc_environment/readme/CONFIGURE.md @@ -0,0 +1,15 @@ +To configure this module, you need to: + +Create a module server_environment_file with a cfg file or set the +environment variable SERVER_ENV_CONFIG with the following section: + +\[auth_oauth_provider.\\] + +Where \ is optional and must be equal to the name field you +defined in Odoo for the IDP. + +Example of configuration + +\[auth_oauth_provider.azure\] + +client_id=... client_secret=... diff --git a/auth_oidc_environment/readme/CONTRIBUTORS.md b/auth_oidc_environment/readme/CONTRIBUTORS.md new file mode 100644 index 0000000000..89e6a5f75c --- /dev/null +++ b/auth_oidc_environment/readme/CONTRIBUTORS.md @@ -0,0 +1,2 @@ +- Adrien PEIFFER \<\> (ACSONE SA/NV) +- Raphaël Reverdy \<\> (Akretion) diff --git a/auth_oidc_environment/readme/DESCRIPTION.md b/auth_oidc_environment/readme/DESCRIPTION.md new file mode 100644 index 0000000000..7b01a8ae94 --- /dev/null +++ b/auth_oidc_environment/readme/DESCRIPTION.md @@ -0,0 +1 @@ +this module allows to use server env for OIDC configuration diff --git a/auth_oidc_environment/readme/USAGE.md b/auth_oidc_environment/readme/USAGE.md new file mode 100644 index 0000000000..f4ed3f7ad7 --- /dev/null +++ b/auth_oidc_environment/readme/USAGE.md @@ -0,0 +1,2 @@ +Once configured, Odoo will read the Auth Providers values from the +configuration. diff --git a/auth_oidc_environment/static/description/icon.png b/auth_oidc_environment/static/description/icon.png new file mode 100644 index 0000000000..3a0328b516 Binary files /dev/null and b/auth_oidc_environment/static/description/icon.png differ diff --git a/auth_oidc_environment/static/description/index.html b/auth_oidc_environment/static/description/index.html new file mode 100644 index 0000000000..fba4c280d0 --- /dev/null +++ b/auth_oidc_environment/static/description/index.html @@ -0,0 +1,443 @@ + + + + + +Auth Oidc Environment + + + +
+

Auth Oidc Environment

+ + +

Beta License: AGPL-3 OCA/server-auth Translate me on Weblate Try me on Runboat

+

this module allows to use server env for OIDC configuration

+

Table of contents

+ +
+

Configuration

+

To configure this module, you need to:

+

Create a module server_environment_file with a cfg file or set the +environment variable SERVER_ENV_CONFIG with the following section:

+

[auth_oauth_provider.<name>]

+

Where <name> is optional and must be equal to the name field you defined +in Odoo for the IDP.

+

Example of configuration

+

[auth_oauth_provider.azure]

+

client_id=… client_secret=…

+
+
+

Usage

+

Once configured, Odoo will read the Auth Providers values from the +configuration.

+
+
+

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

+
    +
  • ACSONE SA/NV
    • +
+
+
+

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/server-auth project on GitHub.

+

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

+
+
+
+ + diff --git a/auth_oidc_environment/tests/__init__.py b/auth_oidc_environment/tests/__init__.py new file mode 100644 index 0000000000..c25a516081 --- /dev/null +++ b/auth_oidc_environment/tests/__init__.py @@ -0,0 +1 @@ +from . import test_auth_oidc_environment diff --git a/auth_oidc_environment/tests/test_auth_oidc_environment.py b/auth_oidc_environment/tests/test_auth_oidc_environment.py new file mode 100644 index 0000000000..641fb6a9af --- /dev/null +++ b/auth_oidc_environment/tests/test_auth_oidc_environment.py @@ -0,0 +1,29 @@ +# Copyright 2023 ACSONE SA/NV +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). + +from unittest.mock import patch + +from odoo.tools.config import config as odoo_config + +from odoo.addons.server_environment import server_env +from odoo.addons.server_environment.tests.common import ServerEnvironmentCase + + +@patch.dict(odoo_config.options, {"running_env": "testing"}) +class TestEnvironmentVariables(ServerEnvironmentCase): + def test_env_variables(self): + env_var = ( + "[auth_oauth_provider.sample]\n" "client_id=foo\n" "client_secret=bar\n" + ) + with self.set_config_dir(None), self.set_env_variables(env_var): + parser = server_env._load_config() + self.assertEqual( + list(parser.keys()), ["DEFAULT", "auth_oauth_provider.sample"] + ) + self.assertDictEqual( + dict(parser["auth_oauth_provider.sample"].items()), + { + "client_id": "foo", + "client_secret": "bar", + }, + )