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

[17.0][MIG] auth_api_key: Migration to 17.0. #591

Merged
merged 65 commits into from
Jan 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
65 commits
Select commit Hold shift + click to select a range
f930718
New generic module du define REST services
lmignon Jan 31, 2018
ee660e5
auth_api_key: New module to provide authentication by api_key
lmignon Jan 31, 2018
d45cf20
auth_api_key: Remove useless code
lmignon Feb 2, 2018
479e374
Update the auth_api_key for keychan 10.0.2 (renamed method)
RobinetDenisAcsone Feb 19, 2018
00d83d5
Fix the authentification method and show the user_id on the form
RobinetDenisAcsone Feb 19, 2018
648682d
refactor code in order to use generic code from base_rest instead of …
sebastienbeau Feb 25, 2018
bffe122
fix wrong name in selection box
sebastienbeau Aug 29, 2018
90f6942
Since keychain 10.0.2.0.1 there is a default validation method
hparfr Oct 17, 2018
185c0bb
Keychain removed
qgroulard Nov 6, 2018
b3630a0
Update Readme with more details
qgroulard Nov 8, 2018
8e4e467
Quick fix CONFIGURE.rst
qgroulard Nov 8, 2018
0307905
Developmet status: Beta
qgroulard Nov 8, 2018
f12ca09
[FIX] auth_api_key: fix api and flake8
lmignon Nov 13, 2018
454a93f
[MIG] server_auth from 10 to 12
sbidoul Nov 20, 2018
46e3251
auth_api_key: add description to model
sbidoul Nov 20, 2018
ea150e8
[CHG] auth_api_key is LGPL
sbidoul Nov 21, 2018
4c2af8e
Use consteq to compare keys
ap-wtioit Nov 30, 2018
02ca732
[UPD] README.rst
OCA-git-bot Feb 14, 2019
7be81bf
[IMP] ADD possibility to save api keys in database by using server.en…
mourad-ehm Jul 18, 2019
74dbb2c
[FIX] login_name error
mourad-ehm Jul 18, 2019
c6109aa
[IMP] make auth_api_key compatible in multi-db
sebastienbeau Jul 19, 2019
ab5095c
[UPD] README.rst
OCA-git-bot Jul 29, 2019
f2088ae
[FIX] auth_api_key: Fix tests according to last changes and add views…
lmignon Sep 20, 2019
a808b5d
[IMP] auth_api_key: Ensures backward compatibility
lmignon Sep 27, 2019
19b388f
[FIX] auth_api_key: Cache must be cleared if the user_id is modified
lmignon Sep 27, 2019
69de3d5
[IMP] auth_api_key: Improves key field description
lmignon Sep 27, 2019
6870008
[UPD] README.rst
OCA-git-bot Sep 28, 2019
b7c5c74
[IMP] auth_api_key: black, isort
Oct 17, 2019
305b70b
[MIG] auth_api_key: Migration to 13.0
Oct 17, 2019
db10be0
[UPD] Update auth_api_key.pot
oca-travis Oct 29, 2019
53b5e0c
[UPD] README.rst
OCA-git-bot Oct 29, 2019
d1f5c0a
pre-commit update
OCA-git-bot Mar 14, 2020
a517211
[MIG] auth_api_key: Migration to 14.0
chafique-delli Oct 12, 2020
72ae2ba
[UPD] Update auth_api_key.pot
oca-travis Dec 21, 2020
3c6f175
[UPD] README.rst
OCA-git-bot Dec 21, 2020
f004adc
Added translation using Weblate (Italian)
primes2h Feb 12, 2021
0c0060e
Translated using Weblate (Italian)
primes2h Feb 12, 2021
bf0060f
[14.0][IMP] auth_api_key: Allow to search on every key even if void
rousseldenis Sep 9, 2021
390fe10
auth_api_key 14.0.1.0.1
OCA-git-bot Sep 10, 2021
ca63204
auth_api_key: drop old migration
simahawk Sep 24, 2021
99f1527
auth_api_key: get rid of server env
simahawk Sep 24, 2021
a55e356
auth_api_key: 14.0.2.0.0
simahawk Sep 24, 2021
8a9bf50
[UPD] Update auth_api_key.pot
oca-travis Sep 27, 2021
6d796a0
[UPD] README.rst
OCA-git-bot Sep 27, 2021
a750d23
auth_api_key 14.0.2.0.1
OCA-git-bot Sep 27, 2021
d1a5980
Update translation files
oca-transbot Sep 27, 2021
20604ca
[MIG] auth_api_key: Migration to 15.0
yankinmax Nov 24, 2021
686a221
[UPD] Update auth_api_key.pot
Nov 30, 2021
6ecd366
auth_api_key: fix archived user allowed key
TDu Jul 22, 2022
b5b01f2
[UPD] Update auth_api_key.pot
Jul 26, 2022
6121f1d
auth_api_key 15.0.1.1.0
OCA-git-bot Jul 26, 2022
2933288
Update translation files
oca-transbot Jul 26, 2022
d3d5cc4
Revert "Merge PR #398 into 15.0"
TDu Jul 26, 2022
9b95cce
Revert "[UPD] Update auth_api_key.pot"
TDu Jul 26, 2022
9217c74
Revert "Update translation files"
TDu Jul 26, 2022
0f34de1
auth_api_key 15.0.1.1.1
OCA-git-bot Jul 28, 2022
3aff27a
Update translation files
oca-transbot Jul 28, 2022
5ebe9be
[IMP] auth_api_key: pre-commit stuff
benoit-bertholon Nov 29, 2022
3c75dc1
[MIG] auth_api_key: Migration to 16.0
benoit-bertholon Nov 29, 2022
b9ad341
[UPD] Update auth_api_key.pot
Dec 5, 2022
dbeb944
[UPD] README.rst
OCA-git-bot Dec 5, 2022
90d4072
Update translation files
weblate Dec 5, 2022
3f79341
[UPD] README.rst
OCA-git-bot Sep 3, 2023
8003141
[IMP] auth_api_key: pre-commit auto fixes
chrisb-c01 Dec 16, 2023
19b09b4
[MIG] auth_api_key: Migration to 17.0
chrisb-c01 Dec 16, 2023
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
116 changes: 116 additions & 0 deletions auth_api_key/README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,116 @@
============
Auth Api Key
============

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

.. |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-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/17.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-17-0/server-auth-17-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=17.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:%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
-------

* 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]>

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/17.0/auth_api_key>`_ 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_api_key/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
from . import models
14 changes: 14 additions & 0 deletions auth_api_key/__manifest__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# 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": "17.0.1.0.0",
"license": "LGPL-3",
"author": "ACSONE SA/NV,Odoo Community Association (OCA)",
"website": "https://github.com/OCA/server-auth",
"development_status": "Beta",
"data": ["security/ir.model.access.csv", "views/auth_api_key.xml"],
}
113 changes: 113 additions & 0 deletions auth_api_key/i18n/auth_api_key.pot
Original file line number Diff line number Diff line change
@@ -0,0 +1,113 @@
# Translation of Odoo Server.
# This file contains the translation of the following modules:
# * auth_api_key
#
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_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____last_update
msgid "Last Modified on"
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 ""
123 changes: 123 additions & 0 deletions auth_api_key/i18n/it.po
Original file line number Diff line number Diff line change
@@ -0,0 +1,123 @@
# 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: 2021-02-12 10:45+0000\n"
"Last-Translator: Sergio Zanchetta <[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 4.3.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 "Creata da"

#. module: auth_api_key
#: model:ir.model.fields,field_description:auth_api_key.field_auth_api_key__create_date
msgid "Created on"
msgstr "Creata 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____last_update
msgid "Last Modified on"
msgstr "Ultima modifica il"

#. 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 "Server Env Defaults"
#~ msgstr "Variabili ambiente predefinite del server"
2 changes: 2 additions & 0 deletions auth_api_key/models/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
from . import ir_http
from . import auth_api_key
Loading
Loading