Skip to content

Commit

Permalink
[IMP] auth_admin_passkey: pre-commit auto fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
amkarthik committed Nov 21, 2023
1 parent 9524c25 commit 7118f80
Show file tree
Hide file tree
Showing 9 changed files with 110 additions and 122 deletions.
90 changes: 41 additions & 49 deletions auth_admin_passkey/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,27 +17,26 @@ Authentification - System Administrator Passkey
: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/16.0/auth_admin_passkey
:target: https://github.com/OCA/server-auth/tree/17.0/auth_admin_passkey
: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-16-0/server-auth-16-0-auth_admin_passkey
:target: https://translation.odoo-community.org/projects/server-auth-17-0/server-auth-17-0-auth_admin_passkey
: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=16.0
: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|

This module extends the functionality of users module to support loging in
with an extra system administrator password in other user accounts.
This module extends the functionality of users module to support loging
in with an extra system administrator password in other user accounts.

* System Administrator has now the possibility to login in with any login

* According to the configuration, Odoo will send a mail to user and admin to
indicate them

* According to the configuration, password can be stored encrypted in
configuration file
- System Administrator has now the possibility to login in with any
login
- According to the configuration, Odoo will send a mail to user and
admin to indicate them
- According to the configuration, password can be stored encrypted in
configuration file

**Table of contents**

Expand All @@ -47,74 +46,67 @@ with an extra system administrator password in other user accounts.
Configuration
=============


To enable this feature, once the module installed, you have to add the
following keys in your ``odoo.cfg`` configuration file.

* ``auth_admin_passkey_password``. The password that allows user to logging in
with any login. If not set, the feature is disabled.

* ``auth_admin_passkey_password_sha512_encrypted`` (default False), if enabled,
auth_admin_passkey_password should be the password encrypted with sha512.
On linux, this can be done using this command:
``echo -n YOUR_PASSWORD_AUTH_ADMIN_PASSKEY | sha512sum``

* ``auth_admin_passkey_send_to_user`` (default True), if enabled, an email
will be send to the user, if his account has been used by the
System Administrator.

* ``auth_admin_passkey_sysadmin_email``. If set, an email will be sent to this
mail.

* ``auth_admin_passkey_sysadmin_lang``. the language (exemple en_US), used for
the mail sent to the System Administrator. If not set, the language of the
SUPERUSER_ID user will be used.

- ``auth_admin_passkey_password``. The password that allows user to
logging in with any login. If not set, the feature is disabled.
- ``auth_admin_passkey_password_sha512_encrypted`` (default False), if
enabled, auth_admin_passkey_password should be the password encrypted
with sha512. On linux, this can be done using this command:
``echo -n YOUR_PASSWORD_AUTH_ADMIN_PASSKEY | sha512sum``
- ``auth_admin_passkey_send_to_user`` (default True), if enabled, an
email will be send to the user, if his account has been used by the
System Administrator.
- ``auth_admin_passkey_sysadmin_email``. If set, an email will be sent
to this mail.
- ``auth_admin_passkey_sysadmin_lang``. the language (exemple en_US),
used for the mail sent to the System Administrator. If not set, the
language of the SUPERUSER_ID user will be used.

**typical Dev / Test configuration section**

No keys to add.

**typical Production configuration section**

.. code:: ini
.. code-block:: ini
auth_admin_passkey_password = PASSKEY_PASSWORD
auth_admin_passkey_password_sha512_encrypted = True
auth_admin_passkey_send_to_user = True
auth_admin_passkey_sysadmin_email = SYSADMIN_EMAIL
auth_admin_passkey_sysadmin_lang = SYSADMIN_LANG
auth_admin_passkey_password = PASSKEY_PASSWORD
auth_admin_passkey_password_sha512_encrypted = True
auth_admin_passkey_send_to_user = True
auth_admin_passkey_sysadmin_email = SYSADMIN_EMAIL
auth_admin_passkey_sysadmin_lang = SYSADMIN_LANG
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_admin_passkey%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
`feedback <https://github.com/OCA/server-auth/issues/new?body=module:%20auth_admin_passkey%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
~~~~~~~
-------

* GRAP

Contributors
~~~~~~~~~~~~
------------

* Eugen Don <[email protected]>
* Alexandre Papin (https://twitter.com/Fenkiou)
* Sylvain LE GAL (https://twitter.com/legalsylvain)
* Dhara Solanki <[email protected]> (http://www.initos.com)
* Zina Rasoamanana <[email protected]>
- Eugen Don <[email protected]>
- Alexandre Papin (https://twitter.com/Fenkiou)
- Sylvain LE GAL (https://twitter.com/legalsylvain)
- Dhara Solanki <[email protected]> (http://www.initos.com)
- Zina Rasoamanana <[email protected]>

Maintainers
~~~~~~~~~~~
-----------

This module is maintained by the OCA.

Expand All @@ -126,6 +118,6 @@ 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/16.0/auth_admin_passkey>`_ project on GitHub.
This module is part of the `OCA/server-auth <https://github.com/OCA/server-auth/tree/17.0/auth_admin_passkey>`_ project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
3 changes: 3 additions & 0 deletions auth_admin_passkey/pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[build-system]
requires = ["whool"]
build-backend = "whool.buildapi"
31 changes: 31 additions & 0 deletions auth_admin_passkey/readme/CONFIGURE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
To enable this feature, once the module installed, you have to add the
following keys in your `odoo.cfg` configuration file.

- `auth_admin_passkey_password`. The password that allows user to
logging in with any login. If not set, the feature is disabled.
- `auth_admin_passkey_password_sha512_encrypted` (default False), if
enabled, auth_admin_passkey_password should be the password encrypted
with sha512. On linux, this can be done using this command:
`echo -n YOUR_PASSWORD_AUTH_ADMIN_PASSKEY | sha512sum`
- `auth_admin_passkey_send_to_user` (default True), if enabled, an email
will be send to the user, if his account has been used by the System
Administrator.
- `auth_admin_passkey_sysadmin_email`. If set, an email will be sent to
this mail.
- `auth_admin_passkey_sysadmin_lang`. the language (exemple en_US), used
for the mail sent to the System Administrator. If not set, the
language of the SUPERUSER_ID user will be used.

**typical Dev / Test configuration section**

No keys to add.

**typical Production configuration section**

``` ini
auth_admin_passkey_password = PASSKEY_PASSWORD
auth_admin_passkey_password_sha512_encrypted = True
auth_admin_passkey_send_to_user = True
auth_admin_passkey_sysadmin_email = SYSADMIN_EMAIL
auth_admin_passkey_sysadmin_lang = SYSADMIN_LANG
```
38 changes: 0 additions & 38 deletions auth_admin_passkey/readme/CONFIGURE.rst

This file was deleted.

5 changes: 5 additions & 0 deletions auth_admin_passkey/readme/CONTRIBUTORS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
- Eugen Don \<<[email protected]>\>
- Alexandre Papin (<https://twitter.com/Fenkiou>)
- Sylvain LE GAL (<https://twitter.com/legalsylvain>)
- Dhara Solanki \<<[email protected]>\> (<http://www.initos.com>)
- Zina Rasoamanana \<<[email protected]>\>
5 changes: 0 additions & 5 deletions auth_admin_passkey/readme/CONTRIBUTORS.rst

This file was deleted.

9 changes: 9 additions & 0 deletions auth_admin_passkey/readme/DESCRIPTION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
This module extends the functionality of users module to support loging
in with an extra system administrator password in other user accounts.

- System Administrator has now the possibility to login in with any
login
- According to the configuration, Odoo will send a mail to user and
admin to indicate them
- According to the configuration, password can be stored encrypted in
configuration file
10 changes: 0 additions & 10 deletions auth_admin_passkey/readme/DESCRIPTION.rst

This file was deleted.

41 changes: 21 additions & 20 deletions auth_admin_passkey/static/description/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -369,13 +369,14 @@ <h1 class="title">Authentification - System Administrator Passkey</h1>
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! source digest: sha256:5747081959f948bc3969ac96543ca8e56a01418bff23687907352ae112298d85
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
<p><a class="reference external image-reference" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external image-reference" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/OCA/server-auth/tree/16.0/auth_admin_passkey"><img alt="OCA/server-auth" src="https://img.shields.io/badge/github-OCA%2Fserver--auth-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/server-auth-16-0/server-auth-16-0-auth_admin_passkey"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external image-reference" href="https://runboat.odoo-community.org/builds?repo=OCA/server-auth&amp;target_branch=16.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
<p>This module extends the functionality of users module to support loging in
with an extra system administrator password in other user accounts.</p>
<p><a class="reference external image-reference" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external image-reference" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/OCA/server-auth/tree/17.0/auth_admin_passkey"><img alt="OCA/server-auth" src="https://img.shields.io/badge/github-OCA%2Fserver--auth-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/server-auth-17-0/server-auth-17-0-auth_admin_passkey"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external image-reference" href="https://runboat.odoo-community.org/builds?repo=OCA/server-auth&amp;target_branch=17.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
<p>This module extends the functionality of users module to support loging
in with an extra system administrator password in other user accounts.</p>
<ul class="simple">
<li>System Administrator has now the possibility to login in with any login</li>
<li>According to the configuration, Odoo will send a mail to user and admin to
indicate them</li>
<li>System Administrator has now the possibility to login in with any
login</li>
<li>According to the configuration, Odoo will send a mail to user and
admin to indicate them</li>
<li>According to the configuration, password can be stored encrypted in
configuration file</li>
</ul>
Expand All @@ -397,20 +398,20 @@ <h1><a class="toc-backref" href="#toc-entry-1">Configuration</a></h1>
<p>To enable this feature, once the module installed, you have to add the
following keys in your <tt class="docutils literal">odoo.cfg</tt> configuration file.</p>
<ul class="simple">
<li><tt class="docutils literal">auth_admin_passkey_password</tt>. The password that allows user to logging in
with any login. If not set, the feature is disabled.</li>
<li><tt class="docutils literal">auth_admin_passkey_password_sha512_encrypted</tt> (default False), if enabled,
auth_admin_passkey_password should be the password encrypted with sha512.
On linux, this can be done using this command:
<li><tt class="docutils literal">auth_admin_passkey_password</tt>. The password that allows user to
logging in with any login. If not set, the feature is disabled.</li>
<li><tt class="docutils literal">auth_admin_passkey_password_sha512_encrypted</tt> (default False), if
enabled, auth_admin_passkey_password should be the password encrypted
with sha512. On linux, this can be done using this command:
<tt class="docutils literal">echo <span class="pre">-n</span> YOUR_PASSWORD_AUTH_ADMIN_PASSKEY | sha512sum</tt></li>
<li><tt class="docutils literal">auth_admin_passkey_send_to_user</tt> (default True), if enabled, an email
will be send to the user, if his account has been used by the
<li><tt class="docutils literal">auth_admin_passkey_send_to_user</tt> (default True), if enabled, an
email will be send to the user, if his account has been used by the
System Administrator.</li>
<li><tt class="docutils literal">auth_admin_passkey_sysadmin_email</tt>. If set, an email will be sent to this
mail.</li>
<li><tt class="docutils literal">auth_admin_passkey_sysadmin_lang</tt>. the language (exemple en_US), used for
the mail sent to the System Administrator. If not set, the language of the
SUPERUSER_ID user will be used.</li>
<li><tt class="docutils literal">auth_admin_passkey_sysadmin_email</tt>. If set, an email will be sent
to this mail.</li>
<li><tt class="docutils literal">auth_admin_passkey_sysadmin_lang</tt>. the language (exemple en_US),
used for the mail sent to the System Administrator. If not set, the
language of the SUPERUSER_ID user will be used.</li>
</ul>
<p><strong>typical Dev / Test configuration section</strong></p>
<p>No keys to add.</p>
Expand All @@ -428,7 +429,7 @@ <h1><a class="toc-backref" href="#toc-entry-2">Bug Tracker</a></h1>
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/server-auth/issues">GitHub Issues</a>.
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
<a class="reference external" href="https://github.com/OCA/server-auth/issues/new?body=module:%20auth_admin_passkey%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
<a class="reference external" href="https://github.com/OCA/server-auth/issues/new?body=module:%20auth_admin_passkey%0Aversion:%2017.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
<p>Do not contact contributors directly about support or help with technical issues.</p>
</div>
<div class="section" id="credits">
Expand Down Expand Up @@ -456,7 +457,7 @@ <h2><a class="toc-backref" href="#toc-entry-6">Maintainers</a></h2>
<p>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.</p>
<p>This module is part of the <a class="reference external" href="https://github.com/OCA/server-auth/tree/16.0/auth_admin_passkey">OCA/server-auth</a> project on GitHub.</p>
<p>This module is part of the <a class="reference external" href="https://github.com/OCA/server-auth/tree/17.0/auth_admin_passkey">OCA/server-auth</a> project on GitHub.</p>
<p>You are welcome to contribute. To learn how please visit <a class="reference external" href="https://odoo-community.org/page/Contribute">https://odoo-community.org/page/Contribute</a>.</p>
</div>
</div>
Expand Down

0 comments on commit 7118f80

Please sign in to comment.