Skip to content

Commit 5017160

Browse files
committed
fixup! fixup! fixup! fixup! fixup! [doc] Improvements on management of trusted certificates
Signed-off-by: Ming Lu <ming.lu@cloud.com>
1 parent de54885 commit 5017160

1 file changed

Lines changed: 2 additions & 3 deletions

File tree

doc/content/design/trusted-certificates.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -78,14 +78,13 @@ The new "pool.install_trusted_certificate" should be used instead.
7878
This is a new API introduced in this design with its arguments being defined as:
7979
* session (ref session_id): reference to a valid session;
8080
* self (ref Pool): reference to the pool;
81-
* kind (string): the kind of the certificate; it can be either "ca" or "peer";
81+
* ca (boolean): the trusted certificate is a root CA certificate used to verify a chain (true), or a peer certificate used for certificate pinning (false);
8282
* cert (string): the trusted certificate in PEM format;
8383
* purpose (string list): the purposes of the trusted certificate.
8484

8585
This new API is used to install trusted certificate.
86-
The value of *kind* can be "ca", which stands for root CA certificate, or "peer" which stands for peer certificate.
8786
When *purpose* is an empty set, it stands for a root CA certificate for general purpose.
88-
The *purpose* can not be an empty set when the *kind* is "peer", because each peer certificate is specific to a single server and therefore unsuitable for a shared trusted certificate for general purpose.
87+
The *purpose* can not be an empty set when the *ca* is false, because each peer certificate is specific to a single server and therefore unsuitable for a shared trusted certificate for general purpose.
8988

9089
### pool.uninstall_certificate
9190
This is a new API introduced in this design to uninstall a trusted certificate with its arguments being defined as:

0 commit comments

Comments
 (0)