From ed28a0491224b775eac3f2bf34919e9bde79e589 Mon Sep 17 00:00:00 2001 From: Martin Date: Fri, 13 Oct 2023 12:17:12 +0200 Subject: [PATCH 1/2] Update frontend service README.md The readme of the forntend service was not in line with the changes made in the code. --- services/frontend/README.md | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/services/frontend/README.md b/services/frontend/README.md index 9b2155b36..09d584ecc 100644 --- a/services/frontend/README.md +++ b/services/frontend/README.md @@ -66,25 +66,27 @@ When setting the `FRONTEND_AUTO_ACCEPT_SHARES` to `true`, all incoming shares wi ## The password policy -Note that the password policy currently impacts _only_ public link password validation. +Note that the password policy currently impacts only **public link password validation**. With the password policy, mandatory criteria for the password can be defined via the environment variables listed below. Generally, a password can contain any UTF-8 characters, however some characters are regarded as special since they are not used in ordinary texts. Which characters should be treated as special is defined by "The OWASP® Foundation" [password-special-characters](https://owasp.org/www-community/password-special-characters) (between double quotes): " !"#$%&'()*+,-./:;<=>?@[\]^_`{|}~" -Note that a password can have a maximum length of **72 bytes**. Depending on the alphabet used, a character is encoded by 1 to 4 bytes, defining the maximum length of a password indirectly. While US-ASCII will only need one byte, Latin alphabets and also Greek or Cyrillic ones need two bytes. Three bytes are needed for characters in Chinese, Japanese and Korean etc. - The validation against the banned passwords list can be configured via a text file with words separated by new lines. If a user tries to set a password listed in the banned passwords list, the password can not be used (is invalid) even if the other mandatory criteria are passed. The admin can define the path of the banned passwords list file. If the file doesn't exist in a location, Infinite Scale tries to load a file from the `OCIS_CONFIG_DIR/FRONTEND_PASSWORD_POLICY_BANNED_PASSWORDS_LIST`. An option will be enabled when the file has been loaded successfully. -- `FRONTEND_PASSWORD_POLICY_MIN_CHARACTERS` +Following environment variables can be set to define the password policy behaviour: + +- `FRONTEND_PASSWORD_POLICY_MIN_CHARACTERS` Define the minimum password length. -- `FRONTEND_PASSWORD_POLICY_MIN_LOWERCASE_CHARACTERS` +- `FRONTEND_PASSWORD_POLICY_MIN_LOWERCASE_CHARACTERS` Define the minimum number of uppercase letters. -- `FRONTEND_PASSWORD_POLICY_MIN_UPPERCASE_CHARACTERS` +- `FRONTEND_PASSWORD_POLICY_MIN_UPPERCASE_CHARACTERS` Define the minimum number of lowercase letters. -- `FRONTEND_PASSWORD_POLICY_MIN_DIGITS` +- `FRONTEND_PASSWORD_POLICIY_MIN_DIGITS` Define the minimum number of digits. -- `FRONTEND_PASSWORD_POLICY_MIN_SPECIAL_CHARACTERS` +- `FRONTEND_PASSWORD_POLICY_MIN_SPECIAL_CHARACTERS` Define the minimum number of special characters. -- `FRONTEND_PASSWORD_POLICY_BANNED_PASSWORDS_LIST` -Define the path to the banned password list file. +- `FRONTEND_PASSWORD_POLICY_BANNED_PASSWORDS_LIST` +Path to the 'banned passwords list' file. + +Note that a password can have a maximum length of **72 bytes**. Depending on the alphabet used, a character is encoded by 1 to 4 bytes, defining the maximum length of a password indirectly. While US-ASCII will only need one byte, Latin alphabets and also Greek or Cyrillic ones need two bytes. Three bytes are needed for characters in Chinese, Japanese and Korean etc. From 55c9a95eeaee204abdb7f243154f0f5bf817ea4d Mon Sep 17 00:00:00 2001 From: Martin Date: Fri, 13 Oct 2023 12:21:27 +0200 Subject: [PATCH 2/2] Update services/frontend/README.md --- services/frontend/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/services/frontend/README.md b/services/frontend/README.md index 09d584ecc..dad0929bc 100644 --- a/services/frontend/README.md +++ b/services/frontend/README.md @@ -82,7 +82,7 @@ Define the minimum password length. Define the minimum number of uppercase letters. - `FRONTEND_PASSWORD_POLICY_MIN_UPPERCASE_CHARACTERS` Define the minimum number of lowercase letters. -- `FRONTEND_PASSWORD_POLICIY_MIN_DIGITS` +- `FRONTEND_PASSWORD_POLICY_MIN_DIGITS` Define the minimum number of digits. - `FRONTEND_PASSWORD_POLICY_MIN_SPECIAL_CHARACTERS` Define the minimum number of special characters.