Skip to content

Commit ae096ba

Browse files
committed
doc: fix API descriptions for OpenSSL-1.1.0
Fixes: #4270 PR-URL: #19794 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Rod Vagg <rod@vagg.org> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
1 parent 970ce14 commit ae096ba

File tree

2 files changed

+18
-22
lines changed

2 files changed

+18
-22
lines changed

doc/api/crypto.md

Lines changed: 11 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2132,16 +2132,20 @@ is a bit field taking one of or a mix of the following flags (defined in
21322132
* `crypto.constants.ENGINE_METHOD_DSA`
21332133
* `crypto.constants.ENGINE_METHOD_DH`
21342134
* `crypto.constants.ENGINE_METHOD_RAND`
2135-
* `crypto.constants.ENGINE_METHOD_ECDH`
2136-
* `crypto.constants.ENGINE_METHOD_ECDSA`
2135+
* `crypto.constants.ENGINE_METHOD_EC`
21372136
* `crypto.constants.ENGINE_METHOD_CIPHERS`
21382137
* `crypto.constants.ENGINE_METHOD_DIGESTS`
2139-
* `crypto.constants.ENGINE_METHOD_STORE`
21402138
* `crypto.constants.ENGINE_METHOD_PKEY_METHS`
21412139
* `crypto.constants.ENGINE_METHOD_PKEY_ASN1_METHS`
21422140
* `crypto.constants.ENGINE_METHOD_ALL`
21432141
* `crypto.constants.ENGINE_METHOD_NONE`
21442142

2143+
The flags below are deprecated in OpenSSL-1.1.0.
2144+
2145+
* `crypto.constants.ENGINE_METHOD_ECDH`
2146+
* `crypto.constants.ENGINE_METHOD_ECDSA`
2147+
* `crypto.constants.ENGINE_METHOD_STORE`
2148+
21452149
### crypto.setFips(bool)
21462150
<!-- YAML
21472151
added: REPLACEME
@@ -2472,12 +2476,8 @@ the `crypto`, `tls`, and `https` modules and are generally specific to OpenSSL.
24722476
<td>Limit engine usage to RAND</td>
24732477
</tr>
24742478
<tr>
2475-
<td><code>ENGINE_METHOD_ECDH</code></td>
2476-
<td>Limit engine usage to ECDH</td>
2477-
</tr>
2478-
<tr>
2479-
<td><code>ENGINE_METHOD_ECDSA</code></td>
2480-
<td>Limit engine usage to ECDSA</td>
2479+
<td><code>ENGINE_METHOD_EC</code></td>
2480+
<td>Limit engine usage to EC</td>
24812481
</tr>
24822482
<tr>
24832483
<td><code>ENGINE_METHOD_CIPHERS</code></td>
@@ -2487,10 +2487,6 @@ the `crypto`, `tls`, and `https` modules and are generally specific to OpenSSL.
24872487
<td><code>ENGINE_METHOD_DIGESTS</code></td>
24882488
<td>Limit engine usage to DIGESTS</td>
24892489
</tr>
2490-
<tr>
2491-
<td><code>ENGINE_METHOD_STORE</code></td>
2492-
<td>Limit engine usage to STORE</td>
2493-
</tr>
24942490
<tr>
24952491
<td><code>ENGINE_METHOD_PKEY_METHS</code></td>
24962492
<td>Limit engine usage to PKEY_METHDS</td>
@@ -2609,7 +2605,7 @@ the `crypto`, `tls`, and `https` modules and are generally specific to OpenSSL.
26092605

26102606

26112607
[`Buffer`]: buffer.html
2612-
[`EVP_BytesToKey`]: https://www.openssl.org/docs/man1.0.2/crypto/EVP_BytesToKey.html
2608+
[`EVP_BytesToKey`]: https://www.openssl.org/docs/man1.1.0/crypto/EVP_BytesToKey.html
26132609
[`UV_THREADPOOL_SIZE`]: cli.html#cli_uv_threadpool_size_size
26142610
[`cipher.final()`]: #crypto_cipher_final_outputencoding
26152611
[`cipher.update()`]: #crypto_cipher_update_data_inputencoding_outputencoding
@@ -2655,7 +2651,7 @@ the `crypto`, `tls`, and `https` modules and are generally specific to OpenSSL.
26552651
[NIST SP 800-132]: http://nvlpubs.nist.gov/nistpubs/Legacy/SP/nistspecialpublication800-132.pdf
26562652
[NIST SP 800-38D]: http://nvlpubs.nist.gov/nistpubs/Legacy/SP/nistspecialpublication800-38d.pdf
26572653
[Nonce-Disrespecting Adversaries]: https://github.com/nonce-disrespect/nonce-disrespect
2658-
[OpenSSL's SPKAC implementation]: https://www.openssl.org/docs/man1.0.2/apps/spkac.html
2654+
[OpenSSL's SPKAC implementation]: https://www.openssl.org/docs/man1.1.0/apps/openssl-spkac.html
26592655
[RFC 2412]: https://www.rfc-editor.org/rfc/rfc2412.txt
26602656
[RFC 3526]: https://www.rfc-editor.org/rfc/rfc3526.txt
26612657
[RFC 3610]: https://www.rfc-editor.org/rfc/rfc3610.txt

doc/api/tls.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -557,7 +557,7 @@ field which always contains the value `'TLSv1/SSLv3'`.
557557
For example: `{ name: 'AES256-SHA', version: 'TLSv1/SSLv3' }`
558558

559559
See `SSL_CIPHER_get_name()` in
560-
https://www.openssl.org/docs/man1.0.2/ssl/SSL_CIPHER_get_name.html for more
560+
https://www.openssl.org/docs/man1.1.0/ssl/SSL_CIPHER_get_name.html for more
561561
information.
562562

563563
### tlsSocket.getEphemeralKeyInfo()
@@ -671,7 +671,7 @@ Example responses include:
671671
* `TLSv1.2`
672672
* `unknown`
673673

674-
See https://www.openssl.org/docs/man1.0.2/ssl/SSL_get_version.html for more
674+
See https://www.openssl.org/docs/man1.1.0/ssl/SSL_get_version.html for more
675675
information.
676676

677677
### tlsSocket.getSession()
@@ -1071,8 +1071,8 @@ changes:
10711071
[OpenSSL Options][].
10721072
* `secureProtocol` {string} Optional SSL method to use. The possible values
10731073
are listed as [SSL_METHODS][], use the function names as strings.
1074-
For example, `'SSLv3_method'` to force SSL version 3. **Default:**
1075-
`'SSLv23_method'`.
1074+
For example, `'TLSv1_2_method'` to force TLS version 1.2. **Default:**
1075+
`'TLS_method'`.
10761076
* `sessionIdContext` {string} Optional opaque identifier used by servers to
10771077
ensure session state is not shared between applications. Unused by clients.
10781078

@@ -1364,10 +1364,10 @@ where `secure_socket` has the same API as `pair.cleartext`.
13641364
[Forward secrecy]: https://en.wikipedia.org/wiki/Perfect_forward_secrecy
13651365
[OCSP request]: https://en.wikipedia.org/wiki/OCSP_stapling
13661366
[OpenSSL Options]: crypto.html#crypto_openssl_options
1367-
[OpenSSL cipher list format documentation]: https://www.openssl.org/docs/man1.0.2/apps/ciphers.html#CIPHER-LIST-FORMAT
1367+
[OpenSSL cipher list format documentation]: https://www.openssl.org/docs/man1.1.0/apps/ciphers.html#CIPHER-LIST-FORMAT
13681368
[Perfect Forward Secrecy]: #tls_perfect_forward_secrecy
1369-
[SSL_CTX_set_timeout]: https://www.openssl.org/docs/man1.0.2/ssl/SSL_CTX_set_timeout.html
1370-
[SSL_METHODS]: https://www.openssl.org/docs/man1.0.2/ssl/ssl.html#DEALING-WITH-PROTOCOL-METHODS
1369+
[SSL_CTX_set_timeout]: https://www.openssl.org/docs/man1.1.0/ssl/SSL_CTX_set_timeout.html
1370+
[SSL_METHODS]: https://www.openssl.org/docs/man1.1.0/ssl/ssl.html#Dealing-with-Protocol-Methods
13711371
[Stream]: stream.html#stream_stream
13721372
[TLS Session Tickets]: https://www.ietf.org/rfc/rfc5077.txt
13731373
[TLS recommendations]: https://wiki.mozilla.org/Security/Server_Side_TLS

0 commit comments

Comments
 (0)