-
-
Notifications
You must be signed in to change notification settings - Fork 424
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by simahawk
- Loading branch information
Showing
23 changed files
with
1,181 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,123 @@ | ||
============ | ||
Auth Api Key | ||
============ | ||
|
||
.. | ||
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | ||
!! This file is generated by oca-gen-addon-readme !! | ||
!! changes will be overwritten. !! | ||
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | ||
!! source digest: sha256:455a0f8646088cc228c9423fcbabbc1d81cabbebd0cac6dcf07bbbe000a6fc87 | ||
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | ||
.. |badge1| image:: https://img.shields.io/badge/maturity-Production%2FStable-green.png | ||
:target: https://odoo-community.org/page/development-status | ||
:alt: Production/Stable | ||
.. |badge2| image:: https://img.shields.io/badge/licence-LGPL--3-blue.png | ||
:target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html | ||
:alt: License: LGPL-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_api_key | ||
: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_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/server-auth&target_branch=18.0 | ||
:alt: Try me on Runboat | ||
|
||
|badge1| |badge2| |badge3| |badge4| |badge5| | ||
|
||
Authenticate http requests from an API key. | ||
|
||
API keys are codes passed in (in the http header API-KEY) by programs | ||
calling an API in order to identify -in this case- the calling program's | ||
user. | ||
|
||
Take care while using this kind of mechanism since information into http | ||
headers are visible in clear. Thus, use it only to authenticate requests | ||
from known sources. | ||
|
||
For unknown sources, it is a good practice to filter out this header at | ||
proxy level. | ||
|
||
**Table of contents** | ||
|
||
.. contents:: | ||
:local: | ||
|
||
Configuration | ||
============= | ||
|
||
The api key menu is available into Settings > Technical in debug mode. | ||
By default, when you create an API key, the key is saved into the | ||
database. | ||
|
||
If you want to manage them via serve environment settings use | ||
auth_api_key_server_env. | ||
|
||
Usage | ||
===== | ||
|
||
To apply this authentication system to your http request you must set | ||
'api_key' as value for the 'auth' parameter of your route definition | ||
into your controller. | ||
|
||
.. code:: python | ||
class MyController(Controller): | ||
@route('/my_service', auth='api_key', ...) | ||
def my_service(self, *args, **kwargs): | ||
pass | ||
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_api_key%0Aversion:%2018.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 | ||
------------ | ||
|
||
- Denis Robinet <[email protected]> | ||
- Laurent Mignon <[email protected]> | ||
- Quentin Groulard <[email protected]> | ||
- Sébastien Beau <[email protected]> | ||
- Chafique Delli <[email protected]> | ||
- Thien Vo Hong <[email protected]> | ||
|
||
Other credits | ||
------------- | ||
|
||
The migration of this module from 17.0 to 18.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. | ||
|
||
This module is part of the `OCA/server-auth <https://github.com/OCA/server-auth/tree/18.0/auth_api_key>`_ project on GitHub. | ||
|
||
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
from . import models |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
# Copyright 2018 ACSONE SA/NV | ||
# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl). | ||
|
||
{ | ||
"name": "Auth Api Key", | ||
"summary": """ | ||
Authenticate http requests from an API key""", | ||
"version": "18.0.1.0.0", | ||
"license": "LGPL-3", | ||
"author": "ACSONE SA/NV,Odoo Community Association (OCA)", | ||
"website": "https://github.com/OCA/server-auth", | ||
"development_status": "Production/Stable", | ||
"depends": ["base_setup"], | ||
"data": [ | ||
"security/ir.model.access.csv", | ||
"views/auth_api_key.xml", | ||
"views/res_config_settings.xml", | ||
], | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,108 @@ | ||
# Translation of Odoo Server. | ||
# This file contains the translation of the following modules: | ||
# * auth_api_key | ||
# | ||
msgid "" | ||
msgstr "" | ||
"Project-Id-Version: Odoo Server 17.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_api_key | ||
#: model:ir.model,name:auth_api_key.model_auth_api_key | ||
msgid "API Key" | ||
msgstr "" | ||
|
||
#. module: auth_api_key | ||
#: model:ir.model.constraint,message:auth_api_key.constraint_auth_api_key_name_uniq | ||
msgid "Api Key name must be unique." | ||
msgstr "" | ||
|
||
#. module: auth_api_key | ||
#: model:ir.actions.act_window,name:auth_api_key.auth_api_key_act_window | ||
#: model:ir.ui.menu,name:auth_api_key.auth_api_key_menu | ||
msgid "Auth Api Key" | ||
msgstr "" | ||
|
||
#. module: auth_api_key | ||
#: model:ir.model.fields,field_description:auth_api_key.field_auth_api_key__create_uid | ||
msgid "Created by" | ||
msgstr "" | ||
|
||
#. module: auth_api_key | ||
#: model:ir.model.fields,field_description:auth_api_key.field_auth_api_key__create_date | ||
msgid "Created on" | ||
msgstr "" | ||
|
||
#. module: auth_api_key | ||
#: model:ir.model.fields,field_description:auth_api_key.field_auth_api_key__display_name | ||
msgid "Display Name" | ||
msgstr "" | ||
|
||
#. module: auth_api_key | ||
#: model:ir.model,name:auth_api_key.model_ir_http | ||
msgid "HTTP Routing" | ||
msgstr "" | ||
|
||
#. module: auth_api_key | ||
#: model:ir.model.fields,field_description:auth_api_key.field_auth_api_key__id | ||
msgid "ID" | ||
msgstr "" | ||
|
||
#. module: auth_api_key | ||
#: model:ir.model.fields,field_description:auth_api_key.field_auth_api_key__key | ||
msgid "Key" | ||
msgstr "" | ||
|
||
#. module: auth_api_key | ||
#: model:ir.model.fields,field_description:auth_api_key.field_auth_api_key__write_uid | ||
msgid "Last Updated by" | ||
msgstr "" | ||
|
||
#. module: auth_api_key | ||
#: model:ir.model.fields,field_description:auth_api_key.field_auth_api_key__write_date | ||
msgid "Last Updated on" | ||
msgstr "" | ||
|
||
#. module: auth_api_key | ||
#: model:ir.model.fields,field_description:auth_api_key.field_auth_api_key__name | ||
msgid "Name" | ||
msgstr "" | ||
|
||
#. module: auth_api_key | ||
#: model:ir.model.fields,help:auth_api_key.field_auth_api_key__key | ||
msgid "" | ||
"The API key. Enter a dummy value in this field if it is\n" | ||
" obtained from the server environment configuration." | ||
msgstr "" | ||
|
||
#. module: auth_api_key | ||
#. odoo-python | ||
#: code:addons/auth_api_key/models/auth_api_key.py:0 | ||
#, python-format | ||
msgid "The key %s is not allowed" | ||
msgstr "" | ||
|
||
#. module: auth_api_key | ||
#: model:ir.model.fields,help:auth_api_key.field_auth_api_key__user_id | ||
msgid "" | ||
"The user used to process the requests authenticated by\n" | ||
" the api key" | ||
msgstr "" | ||
|
||
#. module: auth_api_key | ||
#: model:ir.model.fields,field_description:auth_api_key.field_auth_api_key__user_id | ||
msgid "User" | ||
msgstr "" | ||
|
||
#. module: auth_api_key | ||
#. odoo-python | ||
#: code:addons/auth_api_key/models/auth_api_key.py:0 | ||
#, python-format | ||
msgid "User is not allowed" | ||
msgstr "" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,121 @@ | ||
# Translation of Odoo Server. | ||
# This file contains the translation of the following modules: | ||
# * auth_api_key | ||
# | ||
msgid "" | ||
msgstr "" | ||
"Project-Id-Version: Odoo Server 15.0\n" | ||
"Report-Msgid-Bugs-To: \n" | ||
"PO-Revision-Date: 2024-08-17 18:58+0000\n" | ||
"Last-Translator: mymage <[email protected]>\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 5.6.2\n" | ||
|
||
#. module: auth_api_key | ||
#: model:ir.model,name:auth_api_key.model_auth_api_key | ||
msgid "API Key" | ||
msgstr "Chiave API" | ||
|
||
#. module: auth_api_key | ||
#: model:ir.model.constraint,message:auth_api_key.constraint_auth_api_key_name_uniq | ||
msgid "Api Key name must be unique." | ||
msgstr "La chiave API deve essere univoca." | ||
|
||
#. module: auth_api_key | ||
#: model:ir.actions.act_window,name:auth_api_key.auth_api_key_act_window | ||
#: model:ir.ui.menu,name:auth_api_key.auth_api_key_menu | ||
msgid "Auth Api Key" | ||
msgstr "Chiave API di autenticazione" | ||
|
||
#. module: auth_api_key | ||
#: model:ir.model.fields,field_description:auth_api_key.field_auth_api_key__create_uid | ||
msgid "Created by" | ||
msgstr "Creato da" | ||
|
||
#. module: auth_api_key | ||
#: model:ir.model.fields,field_description:auth_api_key.field_auth_api_key__create_date | ||
msgid "Created on" | ||
msgstr "Creato il" | ||
|
||
#. module: auth_api_key | ||
#: model:ir.model.fields,field_description:auth_api_key.field_auth_api_key__display_name | ||
msgid "Display Name" | ||
msgstr "Nome visualizzato" | ||
|
||
#. module: auth_api_key | ||
#: model:ir.model,name:auth_api_key.model_ir_http | ||
msgid "HTTP Routing" | ||
msgstr "Instradamento HTTP" | ||
|
||
#. module: auth_api_key | ||
#: model:ir.model.fields,field_description:auth_api_key.field_auth_api_key__id | ||
msgid "ID" | ||
msgstr "ID" | ||
|
||
#. module: auth_api_key | ||
#: model:ir.model.fields,field_description:auth_api_key.field_auth_api_key__key | ||
msgid "Key" | ||
msgstr "Chiave" | ||
|
||
#. module: auth_api_key | ||
#: model:ir.model.fields,field_description:auth_api_key.field_auth_api_key__write_uid | ||
msgid "Last Updated by" | ||
msgstr "Ultimo aggiornamento di" | ||
|
||
#. module: auth_api_key | ||
#: model:ir.model.fields,field_description:auth_api_key.field_auth_api_key__write_date | ||
msgid "Last Updated on" | ||
msgstr "Ultimo aggiornamento il" | ||
|
||
#. module: auth_api_key | ||
#: model:ir.model.fields,field_description:auth_api_key.field_auth_api_key__name | ||
msgid "Name" | ||
msgstr "Nome" | ||
|
||
#. module: auth_api_key | ||
#: model:ir.model.fields,help:auth_api_key.field_auth_api_key__key | ||
msgid "" | ||
"The API key. Enter a dummy value in this field if it is\n" | ||
" obtained from the server environment configuration." | ||
msgstr "" | ||
"Chiave API. Se viene acquisita dalla configurazione\n" | ||
" ambiente del server, inserire nel campo un valore fittizio." | ||
|
||
#. module: auth_api_key | ||
#. odoo-python | ||
#: code:addons/auth_api_key/models/auth_api_key.py:0 | ||
#, python-format | ||
msgid "The key %s is not allowed" | ||
msgstr "Chiave %s non autorizzata" | ||
|
||
#. module: auth_api_key | ||
#: model:ir.model.fields,help:auth_api_key.field_auth_api_key__user_id | ||
msgid "" | ||
"The user used to process the requests authenticated by\n" | ||
" the api key" | ||
msgstr "" | ||
"Utente utilizzato per elaborare le richieste autenticate\n" | ||
" dalla chiave API" | ||
|
||
#. module: auth_api_key | ||
#: model:ir.model.fields,field_description:auth_api_key.field_auth_api_key__user_id | ||
msgid "User" | ||
msgstr "Utente" | ||
|
||
#. module: auth_api_key | ||
#. odoo-python | ||
#: code:addons/auth_api_key/models/auth_api_key.py:0 | ||
#, python-format | ||
msgid "User is not allowed" | ||
msgstr "Utente non autorizzato" | ||
|
||
#~ msgid "Last Modified on" | ||
#~ msgstr "Ultima modifica il" | ||
|
||
#~ msgid "Server Env Defaults" | ||
#~ msgstr "Variabili ambiente predefinite del server" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
from . import ir_http | ||
from . import auth_api_key | ||
from . import res_company | ||
from . import res_config_settings |
Oops, something went wrong.