From 5d5a4c4c18566a07f13a51b8b0adad15c3495d6b Mon Sep 17 00:00:00 2001 From: Sakthipriyan Vairamani Date: Wed, 30 Sep 2015 08:03:43 +0530 Subject: [PATCH] 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 Reviewed-By: Fedor Indutny --- doc/api/tls.markdown | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/doc/api/tls.markdown b/doc/api/tls.markdown index ca891bb40fc5ce..8e64bc98a098a2 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