diff --git a/docs/organization/passwordObfuscator.md b/docs/organization/passwordObfuscator.md new file mode 100644 index 000000000..2aa579ad6 --- /dev/null +++ b/docs/organization/passwordObfuscator.md @@ -0,0 +1,32 @@ +--- +title: Password Obfuscator +description: Supporting different password obfuscator options. +keywords: [password, obfuscator] +authors: [ZhaoYP-2001] +--- + +Here, we will show you how to enable the option to specify the password obfuscator for the password parameter of the login API. + +## Configuration + +On the organization edit page, you can find the `Password obfuscator` configuration option. You can select the encryption algorithm from the dropdown list. + +![password_obfuscator](/img/organization/password_obfuscator/password_obfuscator.png) + +- Plain: The password parameter of the login API will be transmitted directly in plain text. +- AES: The password parameter of the login API will first be encrypted using the AES algorithm and then transmitted in ciphertext form. +- DES: The password parameter of the login API will first be encrypted using the DES algorithm and then transmitted in ciphertext form. + +Each time you update the encryption algorithm other than Plain, Casdoor will randomly generate an encryption key for you and populate it into the `Password obf key` configuration option. If you want to specify the encryption key for the encryption algorithm, you can modify the key in `Password obf key` configuration option: + +![password_obf_key](/img/organization/password_obfuscator/password_obf_key.png) + +:::note + +If your key does not meet the encryption algorithm requirements, Casdoor will prompt you with the regular expression that the key should meet in the error message. + +::: + +Here is a demo video that shows how to use password obfuscator: + + diff --git a/sidebars.js b/sidebars.js index 7001b4e9d..3936589c9 100644 --- a/sidebars.js +++ b/sidebars.js @@ -115,6 +115,7 @@ module.exports = { "organization/overview", "organization/organization-tree", "organization/passwordComplexity", + "organization/passwordObfuscator", "organization/accountCustomization", "organization/customize-theme", "organization/mfa-items", diff --git a/static/img/organization/password_obfuscator/password_obf_key.png b/static/img/organization/password_obfuscator/password_obf_key.png new file mode 100644 index 000000000..4a1b47f25 Binary files /dev/null and b/static/img/organization/password_obfuscator/password_obf_key.png differ diff --git a/static/img/organization/password_obfuscator/password_obfuscator.mp4 b/static/img/organization/password_obfuscator/password_obfuscator.mp4 new file mode 100644 index 000000000..f4b6979f1 Binary files /dev/null and b/static/img/organization/password_obfuscator/password_obfuscator.mp4 differ diff --git a/static/img/organization/password_obfuscator/password_obfuscator.png b/static/img/organization/password_obfuscator/password_obfuscator.png new file mode 100644 index 000000000..12d328b61 Binary files /dev/null and b/static/img/organization/password_obfuscator/password_obfuscator.png differ