Explorar el Código

#17289: Document new default configuration

Jeremy Stretch hace 1 año
padre
commit
7c0bdf3fb8
Se han modificado 1 ficheros con 15 adiciones y 5 borrados
  1. 15 5
      docs/configuration/security.md

+ 15 - 5
docs/configuration/security.md

@@ -20,19 +20,29 @@ A list of permitted URL schemes referenced when rendering links within NetBox. N
 
 
 ## AUTH_PASSWORD_VALIDATORS
 ## AUTH_PASSWORD_VALIDATORS
 
 
-This parameter acts as a pass-through for configuring Django's built-in password validators for local user accounts. If configured, these will be applied whenever a user's password is updated to ensure that it meets minimum criteria such as length or complexity. An example is provided below. For more detail on the available options, please see [the Django documentation](https://docs.djangoproject.com/en/stable/topics/auth/passwords/#password-validation).
+This parameter acts as a pass-through for configuring Django's built-in password validators for local user accounts. These rules are applied whenever a user's password is created or updated to ensure that it meets minimum criteria such as length or complexity. The default configuration is shown below.
 
 
 ```python
 ```python
 AUTH_PASSWORD_VALIDATORS = [
 AUTH_PASSWORD_VALIDATORS = [
     {
     {
-        'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator',
-        'OPTIONS': {
-            'min_length': 10,
-        }
+        "NAME": "django.contrib.auth.password_validation.MinimumLengthValidator",
+        "OPTIONS": {
+            "min_length": 12,
+        },
+    },
+    {
+        "NAME": "utilities.password_validation.AlphanumericPasswordValidator",
     },
     },
 ]
 ]
 ```
 ```
 
 
+The default configuration enforces the follow criteria:
+
+* A password must be at least 12 characters in length.
+* A password must have at least one uppercase letter, one lowercase letter, and one numeric digit.
+
+Although it is not recommended, the default validation rules can be disabled by setting `AUTH_PASSWORD_VALIDATORS = []` in the configuration file. For more detail on customizing password validation, please see [the Django documentation](https://docs.djangoproject.com/en/stable/topics/auth/passwords/#password-validation).
+
 ---
 ---
 
 
 ## CORS_ORIGIN_ALLOW_ALL
 ## CORS_ORIGIN_ALLOW_ALL