Skip to content

Commit

Permalink
doc: harmonize description of ca argument
Browse files Browse the repository at this point in the history
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 <me@silverwind.io>
  • Loading branch information
bnoordhuis authored and Myles Borins committed Jan 19, 2016
1 parent 9a0f156 commit 5140c40
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 10 deletions.
5 changes: 3 additions & 2 deletions doc/api/https.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -164,8 +164,9 @@ The following options from [`tls.connect()`][] can also be specified. However, a
- `key`: Private key to use for SSL. Default `null`.
- `passphrase`: A string of passphrase for the private key or pfx. Default `null`.
- `cert`: Public x509 certificate to use. Default `null`.
- `ca`: An authority certificate or array of authority certificates to check
the remote host against.
- `ca`: A string, `Buffer` or array of strings or `Buffer`s of trusted
certificates in PEM format. If this is omitted several well known "root"
CAs will be used, like VeriSign. These are used to authorize connections.
- `ciphers`: A string describing the ciphers to use or exclude. Consult
<http://www.openssl.org/docs/apps/ciphers.html#CIPHER_LIST_FORMAT> for
details on the format.
Expand Down
17 changes: 9 additions & 8 deletions doc/api/tls.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -546,9 +546,9 @@ Creates a new client connection to the given `port` and `host` (old API) or
- `cert`: A string or `Buffer` containing the certificate key of the client in
PEM format. (Could be an array of certs).

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

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

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

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

0 comments on commit 5140c40

Please sign in to comment.