diff options
| author | Sakthipriyan Vairamani <thechargingvolcano@gmail.com> | 2015-09-30 08:03:43 +0530 |
|---|---|---|
| committer | Sakthipriyan Vairamani <thechargingvolcano@gmail.com> | 2015-10-28 07:46:27 +0530 |
| commit | 5d5a4c4c18566a07f13a51b8b0adad15c3495d6b (patch) | |
| tree | a427f17762904f05c95af3180cff0b29791ca7d0 | |
| parent | 6cf19103b63f4c33eb2c33590bc533ffa5a3e7e1 (diff) | |
| download | node-new-5d5a4c4c18566a07f13a51b8b0adad15c3495d6b.tar.gz | |
doc: createServer's key option can be an array
The `tls` module's `createServer` and `createSecureContext` accept
`key` option and it can be an array of keys as well. This patch
explains the format of the entries in that array.
Corresponding code:
https://github.com/nodejs/node/blob/v4.1.1/lib/_tls_common.js#L73-L90
PR-URL: https://github.com/nodejs/node/pull/3123
Reviewed-By: Roman Reiss <me@silverwind.io>
Reviewed-By: Fedor Indutny <fedor.indutny@gmail.com>
| -rw-r--r-- | doc/api/tls.markdown | 9 |
1 files changed, 7 insertions, 2 deletions
diff --git a/doc/api/tls.markdown b/doc/api/tls.markdown index ca891bb40f..8e64bc98a0 100644 --- a/doc/api/tls.markdown +++ b/doc/api/tls.markdown @@ -163,7 +163,9 @@ automatically set as a listener for the [secureConnection][] event. The the `key`, `cert` and `ca` options.) - `key`: A string or `Buffer` containing the private key of the server in - PEM format. (Could be an array of keys). (Required) + PEM format. To support multiple keys using different algorithms, an array + can be provided. It can either be a plain array of keys, or an array of + objects in the format `{pem: key, passphrase: passphrase}`. (Required) - `passphrase`: A string of passphrase for the private key or pfx. @@ -508,7 +510,10 @@ dictionary with keys: * `pfx` : A string or buffer holding the PFX or PKCS12 encoded private key, certificate and CA certificates -* `key` : A string holding the PEM encoded private key +* `key`: A string or `Buffer` containing the private key of the server in + PEM format. To support multiple keys using different algorithms, an array + can be provided. It can either be a plain array of keys, or an array of + 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 |