Skip to content

Commit

Permalink
[IMP] password_security: pre-commit stuff
Browse files Browse the repository at this point in the history
  • Loading branch information
ilyas caluwe committed Jan 31, 2024
1 parent f9dd7d9 commit 588d315
Show file tree
Hide file tree
Showing 10 changed files with 104 additions and 162 deletions.
89 changes: 42 additions & 47 deletions password_security/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,28 +17,28 @@ Password Security
: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/16.0/password_security
:target: https://github.com/OCA/server-auth/tree/17.0/password_security
: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-password_security
:target: https://translation.odoo-community.org/projects/server-auth-17-0/server-auth-17-0-password_security
: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 allows admin to set company-level password security requirements
and enforces them on the user.
This module allows admin to set company-level password security
requirements and enforces them on the user.

It contains features such as

* Password expiration days
* Password length requirement
* Password minimum number of lowercase letters
* Password minimum number of uppercase letters
* Password minimum number of numbers
* Password minimum number of special characters
- Password expiration days
- Password length requirement
- Password minimum number of lowercase letters
- Password minimum number of uppercase letters
- Password minimum number of numbers
- Password minimum number of special characters

**Table of contents**

Expand All @@ -48,51 +48,39 @@ It contains features such as
Configuration
=============

Navigate to General Settings under Configuration
Scroll down to the ``Password Policy`` section
Set the policies to your liking.
Navigate to General Settings under Configuration Scroll down to the
``Password Policy`` section Set the policies to your liking.

Password complexity requirements will be enforced upon next password change for
any user in that company.
Password complexity requirements will be enforced upon next password
change for any user in that company.

**Settings & Defaults**

These are defined at the company level:

===================== ======= ===================================================
Name Default Description
===================== ======= ===================================================
password_expiration 60 Days until passwords expire
password_length 12 Minimum number of characters in password
password_lower 0 Minimum number of lowercase letter in password
password_upper 0 Minimum number of uppercase letters in password
password_numeric 0 Minimum number of number in password
password_special 0 Minimum number of unique special character in password
password_history 30 Disallow reuse of this many previous passwords
password_minimum 24 Amount of hours that must pass until another reset
===================== ======= ===================================================
[TABLE]

Usage
=====

Configure using above instructions for each company that should have password
security mandates.
Configure using above instructions for each company that should have
password security mandates.

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:%20password_security%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:%20password_security%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
~~~~~~~
-------

* LasLabs
* Onestein
Expand All @@ -102,26 +90,33 @@ Authors
* Omar Nasr

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

* James Foster <[email protected]>
* Dave Lasley <[email protected]>
* Kaushal Prajapati <[email protected]>
* Petar Najman <[email protected]>
* Shepilov Vladislav <[email protected]>
* Florian Kantelberg <[email protected]>
* Dhara Solanki <[email protected]>
- James Foster <[email protected]>

* `Open Source Integrators <https://opensourceintegrators.com>`_
- Dave Lasley <dave@laslabs.com>

* Chandresh Thakkar <[email protected]>
* Daniel Reis <[email protected]>
- Kaushal Prajapati <[email protected]>

* `Onestein <https://www.onestein.nl>`_:
* Andrea Stirpe <[email protected]>
- Petar Najman <[email protected]>

- Shepilov Vladislav <[email protected]>

- Florian Kantelberg <[email protected]>

- Dhara Solanki <[email protected]>

- `Open Source Integrators <https://opensourceintegrators.com>`__

- Chandresh Thakkar <[email protected]>
- Daniel Reis <[email protected]>

- `Onestein <https://www.onestein.nl>`__:

- Andrea Stirpe <[email protected]>

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

This module is maintained by the OCA.

Expand All @@ -133,6 +128,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/password_security>`_ project on GitHub.
This module is part of the `OCA/server-auth <https://github.com/OCA/server-auth/tree/17.0/password_security>`_ 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 password_security/pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[build-system]
requires = ["whool"]
build-backend = "whool.buildapi"
11 changes: 11 additions & 0 deletions password_security/readme/CONFIGURE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
Navigate to General Settings under Configuration Scroll down to the
`Password Policy` section Set the policies to your liking.

Password complexity requirements will be enforced upon next password
change for any user in that company.

**Settings & Defaults**

These are defined at the company level:

[TABLE]
23 changes: 0 additions & 23 deletions password_security/readme/CONFIGURE.rst

This file was deleted.

21 changes: 21 additions & 0 deletions password_security/readme/CONTRIBUTORS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
- James Foster \<<[email protected]>\>

- Dave Lasley \<<[email protected]>\>

- Kaushal Prajapati \<<[email protected]>\>

- Petar Najman \<<[email protected]>\>

- Shepilov Vladislav \<<[email protected]>\>

- Florian Kantelberg \<<[email protected]>\>

- Dhara Solanki \<<[email protected]>\>

- [Open Source Integrators](https://opensourceintegrators.com)

> - Chandresh Thakkar \<<[email protected]>\>
> - Daniel Reis \<<[email protected]>\>
- [Onestein](https://www.onestein.nl):
- Andrea Stirpe \<<[email protected]>\>
15 changes: 0 additions & 15 deletions password_security/readme/CONTRIBUTORS.rst

This file was deleted.

11 changes: 11 additions & 0 deletions password_security/readme/DESCRIPTION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
This module allows admin to set company-level password security
requirements and enforces them on the user.

It contains features such as

- Password expiration days
- Password length requirement
- Password minimum number of lowercase letters
- Password minimum number of uppercase letters
- Password minimum number of numbers
- Password minimum number of special characters
11 changes: 0 additions & 11 deletions password_security/readme/DESCRIPTION.rst

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
Configure using above instructions for each company that should have password
security mandates.
Configure using above instructions for each company that should have
password security mandates.
78 changes: 14 additions & 64 deletions password_security/static/description/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -369,9 +369,9 @@ <h1 class="title">Password Security</h1>
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! source digest: sha256:dc29155c73a519d3732e2806f60bd11ebb31cd8c181ebd5918e4bc68080d37aa
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
<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/lgpl-3.0-standalone.html"><img alt="License: LGPL-3" src="https://img.shields.io/badge/licence-LGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/OCA/server-auth/tree/16.0/password_security"><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-password_security"><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 allows admin to set company-level password security requirements
and enforces them on the user.</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/lgpl-3.0-standalone.html"><img alt="License: LGPL-3" src="https://img.shields.io/badge/licence-LGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/OCA/server-auth/tree/17.0/password_security"><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-password_security"><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 allows admin to set company-level password security
requirements and enforces them on the user.</p>
<p>It contains features such as</p>
<ul class="simple">
<li>Password expiration days</li>
Expand All @@ -397,72 +397,25 @@ <h1 class="title">Password Security</h1>
</div>
<div class="section" id="configuration">
<h1><a class="toc-backref" href="#toc-entry-1">Configuration</a></h1>
<p>Navigate to General Settings under Configuration
Scroll down to the <tt class="docutils literal">Password Policy</tt> section
Set the policies to your liking.</p>
<p>Password complexity requirements will be enforced upon next password change for
any user in that company.</p>
<p>Navigate to General Settings under Configuration Scroll down to the
<tt class="docutils literal">Password Policy</tt> section Set the policies to your liking.</p>
<p>Password complexity requirements will be enforced upon next password
change for any user in that company.</p>
<p><strong>Settings &amp; Defaults</strong></p>
<p>These are defined at the company level:</p>
<table border="1" class="docutils">
<colgroup>
<col width="26%" />
<col width="9%" />
<col width="66%" />
</colgroup>
<thead valign="bottom">
<tr><th class="head">Name</th>
<th class="head">Default</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr><td>password_expiration</td>
<td>60</td>
<td>Days until passwords expire</td>
</tr>
<tr><td>password_length</td>
<td>12</td>
<td>Minimum number of characters in password</td>
</tr>
<tr><td>password_lower</td>
<td>0</td>
<td>Minimum number of lowercase letter in password</td>
</tr>
<tr><td>password_upper</td>
<td>0</td>
<td>Minimum number of uppercase letters in password</td>
</tr>
<tr><td>password_numeric</td>
<td>0</td>
<td>Minimum number of number in password</td>
</tr>
<tr><td>password_special</td>
<td>0</td>
<td>Minimum number of unique special character in password</td>
</tr>
<tr><td>password_history</td>
<td>30</td>
<td>Disallow reuse of this many previous passwords</td>
</tr>
<tr><td>password_minimum</td>
<td>24</td>
<td>Amount of hours that must pass until another reset</td>
</tr>
</tbody>
</table>
<p>[TABLE]</p>
</div>
<div class="section" id="usage">
<h1><a class="toc-backref" href="#toc-entry-2">Usage</a></h1>
<p>Configure using above instructions for each company that should have password
security mandates.</p>
<p>Configure using above instructions for each company that should have
password security mandates.</p>
</div>
<div class="section" id="bug-tracker">
<h1><a class="toc-backref" href="#toc-entry-3">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:%20password_security%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:%20password_security%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 @@ -503,13 +456,10 @@ <h2><a class="toc-backref" href="#toc-entry-6">Contributors</a></h2>
</ul>
</blockquote>
</li>
<li><dl class="first docutils">
<dt><a class="reference external" href="https://www.onestein.nl">Onestein</a>:</dt>
<dd><ul class="first last simple">
<li><p class="first"><a class="reference external" href="https://www.onestein.nl">Onestein</a>:</p>
<ul class="simple">
<li>Andrea Stirpe &lt;<a class="reference external" href="mailto:a.stirpe&#64;onestein.nl">a.stirpe&#64;onestein.nl</a>&gt;</li>
</ul>
</dd>
</dl>
</li>
</ul>
</div>
Expand All @@ -520,7 +470,7 @@ <h2><a class="toc-backref" href="#toc-entry-7">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/password_security">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/password_security">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 588d315

Please sign in to comment.