Browse Source

doc: harmonize description of `ca` argument

Different sections said different things about what the `ca` argument
should look like.  This commit harmonizes them.

Ref: https://github.com/nodejs/node/pull/4099
PR-URL: https://github.com/nodejs/node/pull/4213
Reviewed-By: Roman Reiss <me@silverwind.io>
v4.x
Ben Noordhuis 9 years ago
committed by Myles Borins
parent
commit
5140c404ae
  1. 5
      doc/api/https.markdown
  2. 17
      doc/api/tls.markdown

5
doc/api/https.markdown

@ -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`. - `key`: Private key to use for SSL. Default `null`.
- `passphrase`: A string of passphrase for the private key or pfx. Default `null`. - `passphrase`: A string of passphrase for the private key or pfx. Default `null`.
- `cert`: Public x509 certificate to use. Default `null`. - `cert`: Public x509 certificate to use. Default `null`.
- `ca`: An authority certificate or array of authority certificates to check - `ca`: A string, `Buffer` or array of strings or `Buffer`s of trusted
the remote host against. 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 - `ciphers`: A string describing the ciphers to use or exclude. Consult
<http://www.openssl.org/docs/apps/ciphers.html#CIPHER_LIST_FORMAT> for <http://www.openssl.org/docs/apps/ciphers.html#CIPHER_LIST_FORMAT> for
details on the format. details on the format.

17
doc/api/tls.markdown

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

Loading…
Cancel
Save