Commit 7d49bd0
doc: add clientCertEngine to docs
Added `clientCertEngine` option to `https` and `tls` docs.1 parent 33c1e8b commit 7d49bd0
2 files changed
Lines changed: 22 additions & 9 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -150,6 +150,9 @@ Global instance of [`https.Agent`][] for all HTTPS client requests. | |||
| 150 | 150 | <!-- YAML | |
| 151 | 151 | added: v0.3.6 | |
| 152 | 152 | changes: | |
| 153 | + - version: REPLACEME | ||
| 154 | + pr-url: https://github.com/nodejs/node/pull/6569 | ||
| 155 | + description: The `options` parameter can now include `clientCertEngine`. | ||
| 153 | 156 | - version: v7.5.0 | |
| 154 | 157 | pr-url: https://github.com/nodejs/node/pull/10638 | |
| 155 | 158 | description: The `options` parameter can be a WHATWG `URL` object. | |
@@ -164,9 +167,9 @@ changes: | |||
| 164 | 167 | ||
| 165 | 168 | Makes a request to a secure web server. | |
| 166 | 169 | ||
| 167 | - The following additional `options` from [`tls.connect()`][] are also accepted when using a | ||
| 168 | - custom [`Agent`][]: | ||
| 169 | - `pfx`, `key`, `passphrase`, `cert`, `ca`, `ciphers`, `rejectUnauthorized`, `secureProtocol`, `servername` | ||
| 170 | + The following additional `options` from [`tls.connect()`][] are also accepted | ||
| 171 | + when using a custom [`Agent`][]: `ca`, `cert`, `ciphers`, `clientCertEngine`, | ||
| 172 | + `key`, `passphrase`, `pfx`, `rejectUnauthorized`, `secureProtocol`, `servername` | ||
| 170 | 173 | ||
| 171 | 174 | `options` can be an object, a string, or a [`URL`][] object. If `options` is a | |
| 172 | 175 | string, it is automatically parsed with [`url.parse()`][]. If it is a [`URL`][] | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -905,6 +905,9 @@ port or host argument. | |||
| 905 | 905 | <!-- YAML | |
| 906 | 906 | added: v0.11.13 | |
| 907 | 907 | changes: | |
| 908 | + - version: REPLACEME | ||
| 909 | + pr-url: https://github.com/nodejs/node/pull/6569 | ||
| 910 | + description: The `options` parameter can now include `clientCertEngine`. | ||
| 908 | 911 | - version: v7.3.0 | |
| 909 | 912 | pr-url: https://github.com/nodejs/node/pull/10294 | |
| 910 | 913 | description: If the `key` option is an array, individual entries do not | |
@@ -959,8 +962,6 @@ changes: | |||
| 959 | 962 | certificate can match or chain to. | |
| 960 | 963 | For self-signed certificates, the certificate is its own CA, and must be | |
| 961 | 964 | provided. | |
| 962 | - * `crl` {string|string[]|Buffer|Buffer[]} Optional PEM formatted | ||
| 963 | - CRLs (Certificate Revocation Lists). | ||
| 964 | 965 | * `ciphers` {string} Optional cipher suite specification, replacing the | |
| 965 | 966 | default. For more information, see [modifying the default cipher suite][]. | |
| 966 | 967 | * `honorCipherOrder` {boolean} Attempt to use the server's cipher suite | |
@@ -974,20 +975,24 @@ changes: | |||
| 974 | 975 | [`crypto.getCurves()`][] to obtain a list of available curve names. On | |
| 975 | 976 | recent releases, `openssl ecparam -list_curves` will also display the name | |
| 976 | 977 | and description of each available elliptic curve. | |
| 978 | + * `clientCertEngine` {string} Optional name of an OpenSSL engine which can | ||
| 979 | + provide the client certificate. | ||
| 980 | + * `crl` {string|string[]|Buffer|Buffer[]} Optional PEM formatted | ||
| 981 | + CRLs (Certificate Revocation Lists). | ||
| 977 | 982 | * `dhparam` {string|Buffer} Diffie Hellman parameters, required for | |
| 978 | 983 | [Perfect Forward Secrecy][]. Use `openssl dhparam` to create the parameters. | |
| 979 | 984 | The key length must be greater than or equal to 1024 bits, otherwise an | |
| 980 | 985 | error will be thrown. It is strongly recommended to use 2048 bits or larger | |
| 981 | 986 | for stronger security. If omitted or invalid, the parameters are silently | |
| 982 | 987 | discarded and DHE ciphers will not be available. | |
| 983 | - * `secureProtocol` {string} Optional SSL method to use, default is | ||
| 984 | - `"SSLv23_method"`. The possible values are listed as [SSL_METHODS][], use | ||
| 985 | - the function names as strings. For example, `"SSLv3_method"` to force SSL | ||
| 986 | - version 3. | ||
| 987 | 988 | * `secureOptions` {number} Optionally affect the OpenSSL protocol behavior, | |
| 988 | 989 | which is not usually necessary. This should be used carefully if at all! | |
| 989 | 990 | Value is a numeric bitmask of the `SSL_OP_*` options from | |
| 990 | 991 | [OpenSSL Options][]. | |
| 992 | + * `secureProtocol` {string} Optional SSL method to use, default is | ||
| 993 | + `"SSLv23_method"`. The possible values are listed as [SSL_METHODS][], use | ||
| 994 | + the function names as strings. For example, `"SSLv3_method"` to force SSL | ||
| 995 | + version 3. | ||
| 991 | 996 | * `sessionIdContext` {string} Optional opaque identifier used by servers to | |
| 992 | 997 | ensure session state is not shared between applications. Unused by clients. | |
| 993 | 998 | ||
@@ -1015,6 +1020,9 @@ publicly trusted list of CAs as given in | |||
| 1015 | 1020 | <!-- YAML | |
| 1016 | 1021 | added: v0.3.2 | |
| 1017 | 1022 | changes: | |
| 1023 | + - version: REPLACEME | ||
| 1024 | + pr-url: https://github.com/nodejs/node/pull/6569 | ||
| 1025 | + description: The `options` parameter can now include `clientCertEngine`. | ||
| 1018 | 1026 | - version: v8.0.0 | |
| 1019 | 1027 | pr-url: https://github.com/nodejs/node/pull/11984 | |
| 1020 | 1028 | description: The `ALPNProtocols` and `NPNProtocols` options can | |
@@ -1025,6 +1033,8 @@ changes: | |||
| 1025 | 1033 | --> | |
| 1026 | 1034 | ||
| 1027 | 1035 | * `options` {Object} | |
| 1036 | + * `clientCertEngine` {string} Optional name of an OpenSSL engine which can | ||
| 1037 | + provide the client certificate. | ||
| 1028 | 1038 | * `handshakeTimeout` {number} Abort the connection if the SSL/TLS handshake | |
| 1029 | 1039 | does not finish in the specified number of milliseconds. Defaults to `120` | |
| 1030 | 1040 | seconds. A `'tlsClientError'` is emitted on the `tls.Server` object whenever | |
0 commit comments