Skip to content

Commit 5140c40

Browse files
bnoordhuisMyles Borins
authored and
Myles Borins
committed
doc: harmonize description of ca argument
Different sections said different things about what the `ca` argument should look like. This commit harmonizes them. Ref: #4099 PR-URL: #4213 Reviewed-By: Roman Reiss <[email protected]>
1 parent 9a0f156 commit 5140c40

File tree

2 files changed

+12
-10
lines changed

2 files changed

+12
-10
lines changed

doc/api/https.markdown

+3-2
Original file line numberDiff line numberDiff line change
@@ -164,8 +164,9 @@ The following options from [`tls.connect()`][] can also be specified. However, a
164164
- `key`: Private key to use for SSL. Default `null`.
165165
- `passphrase`: A string of passphrase for the private key or pfx. Default `null`.
166166
- `cert`: Public x509 certificate to use. Default `null`.
167-
- `ca`: An authority certificate or array of authority certificates to check
168-
the remote host against.
167+
- `ca`: A string, `Buffer` or array of strings or `Buffer`s of trusted
168+
certificates in PEM format. If this is omitted several well known "root"
169+
CAs will be used, like VeriSign. These are used to authorize connections.
169170
- `ciphers`: A string describing the ciphers to use or exclude. Consult
170171
<http://www.openssl.org/docs/apps/ciphers.html#CIPHER_LIST_FORMAT> for
171172
details on the format.

doc/api/tls.markdown

+9-8
Original file line numberDiff line numberDiff line change
@@ -546,9 +546,9 @@ Creates a new client connection to the given `port` and `host` (old API) or
546546
- `cert`: A string or `Buffer` containing the certificate key of the client in
547547
PEM format. (Could be an array of certs).
548548

549-
- `ca`: An array of strings or `Buffer`s of trusted certificates in PEM
550-
format. If this is omitted several well known "root" CAs will be used,
551-
like VeriSign. These are used to authorize connections.
549+
- `ca`: A string, `Buffer` or array of strings or `Buffer`s of trusted
550+
certificates in PEM format. If this is omitted several well known "root"
551+
CAs will be used, like VeriSign. These are used to authorize connections.
552552

553553
- `ciphers`: A string describing the ciphers to use or exclude, separated by
554554
`:`. Uses the same default cipher suite as `tls.createServer`.
@@ -643,8 +643,9 @@ dictionary with keys:
643643
objects in the format `{pem: key, passphrase: passphrase}`. (Required)
644644
* `passphrase` : A string of passphrase for the private key or pfx
645645
* `cert` : A string holding the PEM encoded certificate
646-
* `ca` : Either a string or list of strings of PEM encoded CA
647-
certificates to trust.
646+
* `ca`: A string, `Buffer` or array of strings or `Buffer`s of trusted
647+
certificates in PEM format. If this is omitted several well known "root"
648+
CAs will be used, like VeriSign. These are used to authorize connections.
648649
* `crl` : Either a string or list of strings of PEM encoded CRLs
649650
(Certificate Revocation List)
650651
* `ciphers`: A string describing the ciphers to use or exclude.
@@ -704,9 +705,9 @@ automatically set as a listener for the [`'secureConnection'`][] event. The
704705
- `cert`: A string or `Buffer` containing the certificate key of the server in
705706
PEM format. (Could be an array of certs). (Required)
706707

707-
- `ca`: An array of strings or `Buffer`s of trusted certificates in PEM
708-
format. If this is omitted several well known "root" CAs will be used,
709-
like VeriSign. These are used to authorize connections.
708+
- `ca`: A string, `Buffer` or array of strings or `Buffer`s of trusted
709+
certificates in PEM format. If this is omitted several well known "root"
710+
CAs will be used, like VeriSign. These are used to authorize connections.
710711

711712
- `crl` : Either a string or list of strings of PEM encoded CRLs (Certificate
712713
Revocation List)

0 commit comments

Comments
 (0)