Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

14.0 backport auth OIDC environment #570

Merged
merged 6 commits into from
Mar 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
99 changes: 99 additions & 0 deletions auth_oidc_environment/README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
=====================
Auth Oidc Environment
=====================

..
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! source digest: sha256:e2c3170e7abb1a1cfe48e78ac151c33cdbe2965df7ce0a50020748ca60903409
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

.. |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/14.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-14-0/server-auth-14-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=14.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.<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 <https://github.com/OCA/server-auth/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/server-auth/issues/new?body=module:%20auth_oidc_environment%0Aversion:%2014.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
~~~~~~~

* ACSONE SA/NV

Contributors
~~~~~~~~~~~~

* Adrien PEIFFER <[email protected]> (ACSONE SA/NV)

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 <https://github.com/OCA/server-auth/tree/14.0/auth_oidc_environment>`_ project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
1 change: 1 addition & 0 deletions auth_oidc_environment/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
from . import models
18 changes: 18 additions & 0 deletions auth_oidc_environment/__manifest__.py
Original file line number Diff line number Diff line change
@@ -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": "14.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": [],
}
24 changes: 24 additions & 0 deletions auth_oidc_environment/i18n/auth_oidc_environment.pot
Original file line number Diff line number Diff line change
@@ -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 ""
1 change: 1 addition & 0 deletions auth_oidc_environment/models/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
from . import auth_oauth_provider
24 changes: 24 additions & 0 deletions auth_oidc_environment/models/auth_oauth_provider.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# 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"
14 changes: 14 additions & 0 deletions auth_oidc_environment/readme/CONFIGURE.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
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=...
1 change: 1 addition & 0 deletions auth_oidc_environment/readme/CONTRIBUTORS.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* Adrien PEIFFER <[email protected]> (ACSONE SA/NV)
1 change: 1 addition & 0 deletions auth_oidc_environment/readme/DESCRIPTION.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
this module allows to use server env for OIDC configuration
1 change: 1 addition & 0 deletions auth_oidc_environment/readme/USAGE.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Once configured, Odoo will read the Auth Providers values from the configuration.
Binary file added auth_oidc_environment/static/description/icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Loading