Skip to content

Commit 250f979

Browse files
committed
docs: Add docs for the new feature of password obfuscator.
1 parent 87fe115 commit 250f979

File tree

4 files changed

+32
-0
lines changed

4 files changed

+32
-0
lines changed
+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
title: Password Obfuscator
3+
description: Supporting different password obfuscator options.
4+
keywords: [password, obfuscator]
5+
authors: [ZhaoYP-2001]
6+
---
7+
8+
Here, we will show you how to enable the option to specify the password obfuscator for the password parameter of the login API.
9+
10+
## Configuration
11+
12+
On the organization edit page, you can find the `Password obfuscator` configuration option. You can select the encryption algorithm from the dropdown list.
13+
14+
![password_obfuscator](/img/organization/password_obfuscator/password_obfuscator.png)
15+
16+
- Plain: The password parameter of the login API will be transmitted directly in plain text.
17+
- AES: The password parameter of the login API will first be encrypted using the AES algorithm and then transmitted in ciphertext form.
18+
- DES: The password parameter of the login API will first be encrypted using the DES algorithm and then transmitted in ciphertext form.
19+
20+
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:
21+
22+
![password_obf_key](/img/organization/password_obfuscator/password_obf_key.png)
23+
24+
:::note
25+
26+
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.
27+
28+
:::
29+
30+
Here is a demo video that shows how to use password obfuscator:
31+
32+
<video src="/img/organization/password_obfuscator/password_obfuscator.mp4" controls="controls" width="100%"></video>
Loading
Binary file not shown.
Loading

0 commit comments

Comments
 (0)