Просмотр исходного кода

docs: Apply suggestions from code review

Co-authored-by: Zaiming (Stone) Shi <zmstone@gmail.com>
William Yang 1 год назад
Родитель
Сommit
1040c752db
2 измененных файлов с 14 добавлено и 22 удалено
  1. 2 2
      changes/ce/feat-11721.en.md
  2. 12 20
      rel/i18n/emqx_schema.hocon

+ 2 - 2
changes/ce/feat-11721.en.md

@@ -4,7 +4,7 @@ Enhance TLS listener to support more flexible TLS verifications.
 
 
   If the option `partial_chain` is set to `true`, allow connections with incomplete certificate chains.
   If the option `partial_chain` is set to `true`, allow connections with incomplete certificate chains.
   
   
-  Check the description in emqx schema for more. 
+  Check the configuration manual document for more details.
   
   
 - Certificate KeyUsage Validation
 - Certificate KeyUsage Validation
 
 
@@ -18,5 +18,5 @@ Enhance TLS listener to support more flexible TLS verifications.
   example:
   example:
      "serverAuth,OID:1.3.6.1.5.5.7.3.2"
      "serverAuth,OID:1.3.6.1.5.5.7.3.2"
     
     
-  Check the description in emqx schema for more. 
+  Check the configuration manual document for more details.
      
      

+ 12 - 20
rel/i18n/emqx_schema.hocon

@@ -685,28 +685,20 @@ common_ssl_opts_schema_verify.label:
 """Verify peer"""
 """Verify peer"""
 
 
 common_ssl_opts_schema_partial_chain.desc:
 common_ssl_opts_schema_partial_chain.desc:
-"""Enable or disable peer verification with partial_chain:
-- `false`
-- `true`
-- `cacert_from_cacertfile`
-- `two_cacerts_from_cacertfile`
-
+"""Enable or disable peer verification with partial_chain.
 When local verifies a peer certificate during the x509 path validation
 When local verifies a peer certificate during the x509 path validation
 process, it constructs a certificate chain that starts with the peer
 process, it constructs a certificate chain that starts with the peer
 certificate and ends with a trust anchor.
 certificate and ends with a trust anchor.
-
-By default, if the setting is set to `false`, the trust anchor is the
-rootCA, and the certificate chain must be complete.
-
-If the setting is set to `true` or `cacert_from_cacertfile`,
-the last certificate in the cacertfile will be used as the trust anchor
-certificate (such as an intermediate CA). This creates a partial chain
+By default, if it is set to `false`, the trust anchor is the
+Root CA, and the certificate chain must be complete.
+However, if the setting is set to `true` or `cacert_from_cacertfile`,
+the last certificate in `cacertfile` will be used as the trust anchor
+certificate (intermediate CA). This creates a partial chain
 in the path validation.
 in the path validation.
-
-Alternatively, if the setting is set to `two_cacerts_from_cacertfile`,
-one of the last two certificates in the cacertfile will be used as the
+Alternatively, if it is configured with `two_cacerts_from_cacertfile`,
+one of the last two certificates in `cacertfile` will be used as the
 trust anchor certificate, forming a partial chain. This option is
 trust anchor certificate, forming a partial chain. This option is
-particularly useful for CA certificate rotation.
+particularly useful for intermediate CA certificate rotation.
 However, please note that it incurs some additional overhead, so it
 However, please note that it incurs some additional overhead, so it
 should only be used for certificate rotation purposes."""
 should only be used for certificate rotation purposes."""
 
 
@@ -714,7 +706,7 @@ common_ssl_opts_schema_partial_chain.label:
 """Partial chain"""
 """Partial chain"""
 
 
 common_ssl_opts_verify_peer_ext_key_usage.desc:
 common_ssl_opts_verify_peer_ext_key_usage.desc:
-"""Verify Extended Key Usage in Peer's certificate
+"""Verify extended key usage in peer's certificate
 For additional peer certificate validation, the value defined here must present in the
 For additional peer certificate validation, the value defined here must present in the
 'Extended Key Usage' of peer certificate defined in
 'Extended Key Usage' of peer certificate defined in
 [rfc5280](https://www.rfc-editor.org/rfc/rfc5280#section-4.2.1.12).
 [rfc5280](https://www.rfc-editor.org/rfc/rfc5280#section-4.2.1.12).
@@ -726,9 +718,9 @@ Allowed values are
 - "emailProtection"
 - "emailProtection"
 - "timeStamping"
 - "timeStamping"
 - "ocspSigning"
 - "ocspSigning"
-- raw OID, for example: "OID:1.3.6.1.5.5.7.3.2"
+- raw OID, for example: "OID:1.3.6.1.5.5.7.3.2" means `id-pk 2` which is equivalent to `clientAuth`
 
 
-Comma-separated string is also supported for validating the subset of key usages.
+Comma-separated string is also supported for validating more than one key usages.
 
 
 For example, `"serverAuth,OID:1.3.6.1.5.5.7.3.2"`"""
 For example, `"serverAuth,OID:1.3.6.1.5.5.7.3.2"`"""