Skip to content

Commit 6a39ffa

Browse files
authored
Merge pull request #2770 from Pikady/fix-doc
Fix typos and formatting issues
2 parents 65eee95 + eb776ae commit 6a39ffa

File tree

10 files changed

+25
-23
lines changed

10 files changed

+25
-23
lines changed

en_US/access-control/authn/mnesia.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ In the EMQX Dashboard, click **Access Control** -> **Authentication** from the l
2626
- **Salt Position**: Determines how salt (random data) is added to the password. Options are `suffix`, `prefix`, or `disable`. You can keep the default value unless you migrate user credentials from external storage into the EMQX built-in database. Note: Set **Salt Position** to `disable` if `plain` is selected.
2727
- For `bcrypt`:
2828
- **Salt Rounds**: Defines the number of times the hash function is applied, expressed as 2^Salt Rounds, also known as the "cost factor". The default value is `10`, with a permissible range of `5` to `10`. A higher value is recommended for enhanced security. Note: Increasing the cost factor by 1 doubles the necessary time for authentication.
29-
- For `pkbdf2`:
29+
- For `pbkdf2`:
3030
- **Pseudorandom Function**: Selects the hash function that generates the key, such as `sha256`.
3131
- **Iteration Count**: Sets the number of times the hash function is executed. The default is `4096`.
3232
- **Derived Key Length** (optional): Specifies the length of the generated key. If left blank, the length will default to that determined by the selected pseudorandom function.

en_US/access-control/authn/mongodb.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ Follow the instructions below on how to configure the authentication:
8989
- **Salt Position**: Define how salt (random data) is added to the password. Options are`suffix`, `prefix`, or `disable`. You can keep the default value unless you migrate user credentials from external storage into the EMQX built-in database. Note: Set **Salt Position** to `disable` if `plain` is selected.
9090
- For `bcrypt`:
9191
- **Salt Rounds**: Set the number of hash function applications, expressed as 2^Salt Rounds, also known as the "cost factor". Default: `10`; Range: `5-10`. Higher values are recommended for better security. Note: Increasing the cost factor by 1 doubles the necessary time for authentication.
92-
- For `pkbdf2`:
92+
- For `pbkdf2`:
9393
- **Pseudorandom Function**: Specify the hash functions to generate the key, such as `sha256`.
9494
- **Iteration Count**: Specify the iteration times; Default: `4096`.
9595
- **Derived Key Length** (optional): Specify the generated key length. You can leave this field blank, then the key length will be determined by the pseudorandom function you selected.

en_US/access-control/authn/mysql.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ Follow the instructions below on how to configure the authentication:
8989
- **Salt Position**: Determines how salt (random data) is added to the password. Options are `suffix`, `prefix`, or `disable`. Retain the default setting unless migrating credentials from external storage to the EMQX built-in database. Note: Set to `disable` if `plain` is chosen.
9090
- For `bcrypt`:
9191
- **Salt Rounds**: Set the number of times the hash function executes, denoted as 2^Salt Rounds, also known as the "cost factor". The default is `10`, with a range of `5` to `10`. A higher value is recommended for enhanced security. Note: Increasing the cost factor by 1 doubles the necessary time for authentication.
92-
- For `pkbdf2`:
92+
- For `pbkdf2`:
9393
- **Pseudorandom Function**: Specify the Hash functions to generate the key, such as `sha256`.
9494
- **Iteration Count**: Specify the iteration times; Default: `4096`.
9595
- **Derived Key Length** (optional): Specify the length of the generated password. You can leave this field blank, then the key length will be determined by the pseudorandom function you selected.

en_US/access-control/authn/postgresql.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ Follow the instructions below on how to configure the authentication:
8484
- **Salt Position**: Specify how salt (random data) should be added to the password. Options are `suffix`, `prefix`, or `disable`. Keep the default value unless you migrate user credentials from external storage into the EMQX built-in database. Note: For `plain`, the **Salt Position** should be set to `disable`.
8585
- For `bcrypt`:
8686
- **Salt Rounds**: Define the number of times the hash function is applied, represented as 2^Salt Rounds, also known as the "cost factor". The default is `10`, with a range of `5` to `10`. A higher setting is recommended for increased security. Note: Increasing the cost factor by 1 doubles the necessary time for authentication.
87-
- For `pkbdf2`:
87+
- For `pbkdf2`:
8888
- **Pseudorandom Function**: Select the hash function used for key generation, such as `sha256`.
8989
- **Iteration Count**: Indicate the number of hash iterations. Default: `4096`.
9090
- **Derived Key Length**: Set the desired length of the generated password. This field can be left blank, in which case the key length will default to the output of the selected pseudorandom function.

en_US/access-control/authn/redis.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ Follow the instructions below on how to configure the authentication:
7272
- **Salt Position**: Determine how salt (random data) is added to the password. Options are `suffix`, `prefix`, or `disable`. Keep the default value unless you migrate user credentials from external storage into the EMQX built-in database. Note: Set to `disable` if `plain` is selected.
7373
- For `bcrypt`:
7474
- **Salt Rounds**: Set the number of applications of the hash function, expressed as 2^Salt Rounds, also known as the "cost factor". The default is `10`, with a range of `5` to `10`. Opting for a higher value enhances security. Note: Increasing the cost factor by 1 doubles the necessary time for authentication.
75-
- For `pkbdf2`:
75+
- For `pbkdf2`:
7676
- **Pseudorandom Function**: Select the hash function for key generation, such as `sha256`.
7777
- **Iteration Count**: Specify the number of iterations. Default: `4096`.
7878
- **Derived Key Length** (optional): Set the desired length of the generated password. If left unspecified, the length will be determined by the selected pseudorandom function.

zh_CN/access-control/authn/mnesia.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ EMQX 通过内置数据库为用户提供了一种低成本、开箱即用的密
2424
2. 选择 **bcrypt** 算法,需配置:
2525

2626
- **Salt Rounds**:指定散列需要的计算次数(2^Salt Rounds),也称成本因子。默认值:**10**,可选值:**5~10**;数值越高,加密的安全性越高,因此建议采用较大的值,但相应的用户验证的耗时也会增加,您可根据业务需求进行配置。
27-
3. 选择 **pkbdf2** 算法,需配置:
27+
3. 选择 **pbkdf2** 算法,需配置:
2828

2929
- **伪随机函数**:指定生成密钥使用的散列函数,如 sha256 等。
3030
- **迭代次数**:指定散列次数,默认值:**4096**<!--后续补充取值范围-->

zh_CN/access-control/authn/mongodb.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -80,8 +80,8 @@ MongoDB 认证器支持将认证数据存储为 MongoDB 文档。用户需要提
8080
- 选择 **plain****md5****sha****sha256****sha512** 算法,需配置:
8181
- **加盐方式**:用于指定盐和密码的组合方式,除需将访问凭据从外部存储迁移到 EMQX 内置数据库中外,一般不需要更改此选项;可选值:**suffix**(在密码尾部加盐)、**prefix**(在密码头部加盐)、**disable**(不启用)。注意:如选择 **plain**,加盐方式应设为 **disable**
8282
- 选择 **bcrypt** 算法,需配置:
83-
- **Salt Rounds**:指定散列需要的计算次数(2^Salt Rounds),也称成本因子。默认值:**10**,可选值:**5~10**;数值越高,加密的安全性越高,因此建议采用较大的值,但相应的用户验证的耗时也会增加,您可根据业务需求进行配置。
84-
- 选择 **pkbdf2** 算法,需配置:
83+
- **Salt Rounds**:指定散列需要的计算次数(2^Salt Rounds),也称成本因子。默认值:**10**,可选值:**5~10**;数值越高,加密的安全性越高,因此建议采用较大的值,但相应的用户验证的耗时也会增加,您可根据业务需求进行配置。
84+
- 选择 **pbkdf2** 算法,需配置:
8585
- **伪随机函数**:指定生成密钥使用的散列函数,如 sha256 等。
8686
- **迭代次数**:指定散列次数,默认值:**4096**<!--后续补充取值范围-->
8787
- **密钥长度**(可选):指定希望得到的密钥长度。如不指定,密钥长度将由**伪随机函数**确定。

zh_CN/access-control/authn/mysql.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -83,8 +83,8 @@ SELECT password_hash, salt, is_superuser FROM mqtt_user WHERE username = ${usern
8383

8484
- **加盐方式**:用于指定盐和密码的组合方式,除需将访问凭据从外部存储迁移到 EMQX 内置数据库中外,一般不需要更改此选项;可选值:**suffix**(在密码尾部加盐)、**prefix**(在密码头部加盐)、**disable**(不启用)。注意:如选择 **plain**,加盐方式应设为 **disable**
8585
- 选择 **bcrypt** 算法,需配置:
86-
- **Salt Rounds**:指定散列需要的计算次数(2^Salt Rounds),也称成本因子。默认值:**10**,可选值:**5~10**;数值越高,加密的安全性越高,因此建议采用较大的值,但相应的用户验证的耗时也会增加,您可根据业务需求进行配置。
87-
- 选择 **pkbdf2** 算法,需配置:
86+
- **Salt Rounds**:指定散列需要的计算次数(2^Salt Rounds),也称成本因子。默认值:**10**,可选值:**5~10**;数值越高,加密的安全性越高,因此建议采用较大的值,但相应的用户验证的耗时也会增加,您可根据业务需求进行配置。
87+
- 选择 **pbkdf2** 算法,需配置:
8888
- **伪随机函数**:指定生成密钥使用的散列函数,如 sha256 等。
8989
- **迭代次数**:指定散列次数,默认值:**4096**<!--后续补充取值范围-->
9090
- **密钥长度**(可选):指定希望得到的密钥长度。如不指定,密钥长度将由**伪随机函数**确定。

zh_CN/access-control/authn/postgresql.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,8 @@ SELECT password_hash, salt, is_superuser FROM mqtt_user WHERE username = ${usern
5959

6060
您可按照如下说明完成相关配置:
6161

62+
**连接**:输入连接到PostgreSQL的信息。
63+
6264
- **服务**:填入 PostgreSQL 服务器地址 (`host:port`) 。
6365
- **数据库**:填入 PostgreSQL 的数据库名称。
6466
- **用户名**(可选):填入用户名称。
@@ -68,19 +70,19 @@ SELECT password_hash, salt, is_superuser FROM mqtt_user WHERE username = ${usern
6870

6971
- **连接池大小**(可选):填入一个整数用于指定从 EMQX 节点到 PostgreSQL 数据库的并发连接数;默认值:**8**
7072

73+
**认证配置**:配置认证相关设置:
7174
- **密码加密方式**:选择存储密码时使用的散列算法,如 plain、md5、sha、bcrypt、pbkdf2 等。
7275

7376
- 如果选择 **plain****md5****sha****sha256****sha512** 算法,还需配置:
7477
- **加盐方式**:用于指定盐和密码的组合方式,除需将访问凭据从外部存储迁移到 EMQX 内置数据库中外,一般不需要更改此选项;可选值:**suffix**(在密码尾部加盐)、**prefix**(在密码头部加盐)、**disable**(不启用)。注意:如选择 **plain**,加盐方式应设为 **disable**
7578

76-
- 如果选择 **pkbdf2** 算法,还需配置:
79+
- 如果选择 **bcrypt** 算法,还需配置:
80+
- **Salt Rounds**:指定散列需要的计算次数(2^Salt Rounds),也称成本因子。默认值:**10**,可选值:**5~10**;数值越高,加密的安全性越高,因此建议采用较大的值,但相应的用户验证的耗时也会增加,您可根据业务需求进行配置。
7781

82+
- 如果选择 **pbkdf2** 算法,还需配置:
7883
- **伪随机函数**:指定生成密钥使用的散列函数,如 sha256 等。
7984

80-
- **加盐方式**:用于指定盐和密码的组合方式,除需将访问凭据从外部存储迁移到 EMQX 内置数据库中外,一般不需要更改此选项;可选值:**suffix**(在密码尾部加盐)、**prefix**(在密码头部加盐)、**disable**(不启用)。注意:如选择 **plain**,加盐方式应设为 **disable**
81-
- 选择 **bcrypt** 算法,需配置:
82-
- **Salt Rounds**:指定散列需要的计算次数(2^Salt Rounds),也称成本因子。默认值:**10**,可选值:**5~10**;数值越高,加密的安全性越高,因此建议采用较大的值,但相应的用户验证的耗时也会增加,您可根据业务需求进行配置。
83-
- 选择 **pkbdf2** 算法,需配置:
85+
- **迭代次数**:指定迭代次数。默认值:**4096**
8486

8587
- **密钥长度**(可选):指定希望得到的密钥长度。如不指定,密钥长度将由**伪随机函数**确定。
8688

zh_CN/access-control/authn/redis.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -60,14 +60,14 @@ Redis 认证器支持使用 [Redis hashes](https://redis.io/docs/manual/data-typ
6060
**认证配置**:在此部分进行认证加密算法相关的配置。
6161

6262
- **密码加密方式**:选择存储密码时使用的散列算法,如 plain、md5、sha、bcrypt、pbkdf2 等。
63-
- 选择 **plain****md5****sha****sha256****sha512** 算法,需配置:
64-
- **加盐方式**:用于指定盐和密码的组合方式,除需将访问凭据从外部存储迁移到 EMQX 内置数据库中外,一般不需要更改此选项;可选值:**suffix**(在密码尾部加盐)、**prefix**(在密码头部加盐)、**disable**(不启用)。注意:如选择 **plain**,加盐方式应设为 **disable**
65-
- 选择 **bcrypt** 算法,需配置:
66-
- **Salt Rounds**:指定散列需要的计算次数(2^Salt Rounds),也称成本因子。默认值:**10**,可选值:**5~10**;数值越高,加密的安全性越高,因此建议采用较大的值,但相应的用户验证的耗时也会增加,您可根据业务需求进行配置。
67-
- 选择 **pkbdf2** 算法,需配置:
68-
- **伪随机函数**:指定生成密钥使用的散列函数,如 sha256 等。
69-
- **迭代次数**:指定散列次数,默认值:**4096**<!--后续补充取值范围-->
70-
- **密钥长度**(可选):指定希望得到的密钥长度。如不指定,密钥长度将由**伪随机函数**确定。
63+
- 选择 **plain****md5****sha****sha256****sha512** 算法,需配置:
64+
- **加盐方式**:用于指定盐和密码的组合方式,除需将访问凭据从外部存储迁移到 EMQX 内置数据库中外,一般不需要更改此选项;可选值:**suffix**(在密码尾部加盐)、**prefix**(在密码头部加盐)、**disable**(不启用)。注意:如选择 **plain**,加盐方式应设为 **disable**
65+
- 选择 **bcrypt** 算法,需配置:
66+
- **Salt Rounds**:指定散列需要的计算次数(2^Salt Rounds),也称成本因子。默认值:**10**,可选值:**5~10**;数值越高,加密的安全性越高,因此建议采用较大的值,但相应的用户验证的耗时也会增加,您可根据业务需求进行配置。
67+
- 选择 **pbkdf2** 算法,需配置:
68+
- **伪随机函数**:指定生成密钥使用的散列函数,如 sha256 等。
69+
- **迭代次数**:指定散列次数,默认值:**4096**<!--后续补充取值范围-->
70+
- **密钥长度**(可选):指定希望得到的密钥长度。如不指定,密钥长度将由**伪随机函数**确定。
7171
- **命令**:Redis 查询命令
7272

7373
## 通过配置文件配置

0 commit comments

Comments
 (0)