-
Notifications
You must be signed in to change notification settings - Fork 115
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: Add docs for the new feature of password obfuscator. (#638)
* docs: Add docs for the new feature of password obfuscator. * fix: update sidebars.js
- Loading branch information
1 parent
87fe115
commit 56a446b
Showing
5 changed files
with
33 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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: | ||
|
||
<video src="/img/organization/password_obfuscator/password_obfuscator.mp4" controls="controls" width="100%"></video> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.