[18.0][MIG] auth_api_key: Migration to 18.0 #701

thienvh332 · 2024-10-09T10:04:04Z

OCA - Port:

[17.0][PW] auth_api_key: Port from 14.0 #700

Summary:

This PR migrates the auth_api_key module to Odoo 18.0.

Background:

Since Odoo 14.0, native API keys (res.users.apikey) have been supported, allowing users to authenticate XMLRPC/JSONRPC calls using their API key instead of a password. In Odoo 18.0, the native API key feature has been enhanced.

Some special features of the module:

Support for Bearer tokens in the Authorization header (auth="bearer")
Mandatory expiration dates for non-admin users' API keys
Deactivation of API keys for inactive users
Only the user itself can manage his api keys

Why keep `auth_api_key`:

The auth_api_key module, introduced in Odoo 10.0, offers unique advantages over native API keys.

Some special features of the module:

API keys remain usable even when the user is inactive (e.g., for system users in a shopinvader case).
Supports dual authentication via Basic Auth and API_KEY in separate HTTP headers.
Admins can manage API keys for users.

Given these advantages, particularly in use case like system user authentication, we have decided to retain and migrate the auth_api_key module to Odoo 18.0.

…custom one from shopinvader

Get rid of keychain dependency

Co-Authored-By: qgroulard <[email protected]>

…v.mixin obj

Api key is now based on the new version of server env Key belong to a specifiv database that can be requested based on the domain name. Just setup the db_filter with "%d^" to filter based on domain name

… to manage auth api keys

Add a migration script to create the auth.api.key records from keys defined into the cfg file Provides a specific serction name builder to continue reading the key info from the same section as the one expected by the previous version

This reverts commit bb13b69.

Updated by "Update PO files to match POT (msgmerge)" hook in Weblate. Translation: server-auth-15.0/server-auth-15.0-auth_api_key Translate-URL: https://translation.odoo-community.org/projects/server-auth-15-0/server-auth-15-0-auth_api_key/

Updated by "Update PO files to match POT (msgmerge)" hook in Weblate. Translation: server-auth-16.0/server-auth-16.0-auth_api_key Translate-URL: https://translation.odoo-community.org/projects/server-auth-16-0/server-auth-16-0-auth_api_key/

Updated by "Update PO files to match POT (msgmerge)" hook in Weblate. Translation: server-auth-17.0/server-auth-17.0-auth_api_key Translate-URL: https://translation.odoo-community.org/projects/server-auth-17-0/server-auth-17-0-auth_api_key/

Currently translated at 100.0% (17 of 17 strings) Translation: server-auth-17.0/server-auth-17.0-auth_api_key Translate-URL: https://translation.odoo-community.org/projects/server-auth-17-0/server-auth-17-0-auth_api_key/it/

…keys in UI

An archived user should not have an active api key anymore. But to stay backward compatible the migration script will keep all key active.

simahawk

@thienvh332 LG but please report the rationale to keep this module as is in the description of the module, thanks :)
(in separate commmit that we can backport)

simahawk · 2024-10-10T05:36:29Z

/ocabot migration auth_api_key

lmignon and others added 30 commits October 9, 2024 17:00

New generic module du define REST services

1069a5b

auth_api_key: New module to provide authentication by api_key

cccbd87

auth_api_key: Remove useless code

0fd65cd

Update the auth_api_key for keychan 10.0.2 (renamed method)

b16d703

Fix the authentification method and show the user_id on the form

84c36af

refactor code in order to use generic code from base_rest instead of …

1fd62ec

…custom one from shopinvader

fix wrong name in selection box

e036e06

Since keychain 10.0.2.0.1 there is a default validation method

828f08c

Keychain removed

bbbd0d6

Get rid of keychain dependency

Update Readme with more details

a501664

Quick fix CONFIGURE.rst

b5c91d0

Developmet status: Beta

750cbc1

[FIX] auth_api_key: fix api and flake8

c59dc51

[MIG] server_auth from 10 to 12

573ea22

auth_api_key: add description to model

2c8648a

[CHG] auth_api_key is LGPL

c5dc798

Use consteq to compare keys

65420d2

Co-Authored-By: qgroulard <[email protected]>

[UPD] README.rst

637ba56

[IMP] ADD possibility to save api keys in database by using server.en…

14ef368

…v.mixin obj

[FIX] login_name error

3d54842

[IMP] make auth_api_key compatible in multi-db

4e295fe

Api key is now based on the new version of server env Key belong to a specifiv database that can be requested based on the domain name. Just setup the db_filter with "%d^" to filter based on domain name

[UPD] README.rst

dc93895

[FIX] auth_api_key: Fix tests according to last changes and add views…

babd57b

… to manage auth api keys

[IMP] auth_api_key: Ensures backward compatibility

864a4b9

Add a migration script to create the auth.api.key records from keys defined into the cfg file Provides a specific serction name builder to continue reading the key info from the same section as the one expected by the previous version

[FIX] auth_api_key: Cache must be cleared if the user_id is modified

0b610f5

[IMP] auth_api_key: Improves key field description

6183204

[UPD] README.rst

a61b1c2

[IMP] auth_api_key: black, isort

c0c2951

[MIG] auth_api_key: Migration to 13.0

d9967d3

[UPD] Update auth_api_key.pot

2f84603

TDu and others added 21 commits October 9, 2024 17:00

Revert "Update translation files"

d6b6a7c

This reverts commit bb13b69.

auth_api_key 15.0.1.1.1

55b83f2

Update translation files

1b3c442

Updated by "Update PO files to match POT (msgmerge)" hook in Weblate. Translation: server-auth-15.0/server-auth-15.0-auth_api_key Translate-URL: https://translation.odoo-community.org/projects/server-auth-15-0/server-auth-15-0-auth_api_key/

[IMP] auth_api_key: pre-commit stuff

44035d3

[MIG] auth_api_key: Migration to 16.0

693e6bd

[UPD] Update auth_api_key.pot

1636750

[UPD] README.rst

2460552

Update translation files

4f76247

Updated by "Update PO files to match POT (msgmerge)" hook in Weblate. Translation: server-auth-16.0/server-auth-16.0-auth_api_key Translate-URL: https://translation.odoo-community.org/projects/server-auth-16-0/server-auth-16-0-auth_api_key/

[UPD] README.rst

e2e517c

[IMP] auth_api_key: pre-commit auto fixes

58b4f94

[MIG] auth_api_key: Migration to 17.0

9ca9980

[UPD] Update auth_api_key.pot

7290cb2

[BOT] post-merge updates

29efc1c

Update translation files

4b31733

Updated by "Update PO files to match POT (msgmerge)" hook in Weblate. Translation: server-auth-17.0/server-auth-17.0-auth_api_key Translate-URL: https://translation.odoo-community.org/projects/server-auth-17-0/server-auth-17-0-auth_api_key/

Translated using Weblate (Italian)

d173069

Currently translated at 100.0% (17 of 17 strings) Translation: server-auth-17.0/server-auth-17.0-auth_api_key Translate-URL: https://translation.odoo-community.org/projects/server-auth-17-0/server-auth-17-0-auth_api_key/it/

Translated using Weblate (Italian)

4ed0f54

Currently translated at 100.0% (17 of 17 strings) Translation: server-auth-17.0/server-auth-17.0-auth_api_key Translate-URL: https://translation.odoo-community.org/projects/server-auth-17-0/server-auth-17-0-auth_api_key/it/

[14.0] auth_api_key: allow to update api key from form view and hide …

a0309fe

…keys in UI

auth_api_key: archive key when user is archived

c54811a

An archived user should not have an active api key anymore. But to stay backward compatible the migration script will keep all key active.

auth_api_key: add option to auto archive key with user

37fd8e9

[IMP] auth_api_key: apply pre-commit auto fixes

2298864

[MIG] auth_api_key: Migration to 18.0

f7d6ce1

thienvh332 marked this pull request as ready for review October 9, 2024 10:07

simahawk reviewed Oct 10, 2024

View reviewed changes

simahawk mentioned this pull request Oct 10, 2024

[18.0][MIG] auth_api_key_group: Migration to 18.0 #703

Open

1 task

OCA-git-bot added this to the 18.0 milestone Oct 10, 2024

OCA-git-bot mentioned this pull request Oct 10, 2024

Migration to version 18.0 #698

Open

12 tasks

simahawk mentioned this pull request Oct 10, 2024

[18.0][MIG] auth_api_key_server_env: Migration to 18.0 #702

Open

1 task

[UDP] auth_api_key: Update description for reason to keep this module

6327e96

thienvh332 requested a review from simahawk October 10, 2024 10:12

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[18.0][MIG] auth_api_key: Migration to 18.0 #701

[18.0][MIG] auth_api_key: Migration to 18.0 #701

thienvh332 commented Oct 9, 2024 •

edited

Loading

simahawk left a comment •

edited

Loading

simahawk commented Oct 10, 2024

[18.0][MIG] auth_api_key: Migration to 18.0 #701

Are you sure you want to change the base?

[18.0][MIG] auth_api_key: Migration to 18.0 #701

Conversation

thienvh332 commented Oct 9, 2024 • edited Loading

OCA - Port:

Summary:

Background:

Why keep auth_api_key:

simahawk left a comment • edited Loading

Choose a reason for hiding this comment

simahawk commented Oct 10, 2024

thienvh332 commented Oct 9, 2024 •

edited

Loading

Why keep `auth_api_key`:

simahawk left a comment •

edited

Loading