Skip to content

Commit 4fbd9a5

Browse files
committed
doc: fix API descriptions for OpenSSL-1.1.0
1 parent c2a148d commit 4fbd9a5

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
@@ -2078,16 +2078,20 @@ is a bit field taking one of or a mix of the following flags (defined in
20782078
* `crypto.constants.ENGINE_METHOD_DSA`
20792079
* `crypto.constants.ENGINE_METHOD_DH`
20802080
* `crypto.constants.ENGINE_METHOD_RAND`
2081-
* `crypto.constants.ENGINE_METHOD_ECDH`
2082-
* `crypto.constants.ENGINE_METHOD_ECDSA`
2081+
* `crypto.constants.ENGINE_METHOD_EC`
20832082
* `crypto.constants.ENGINE_METHOD_CIPHERS`
20842083
* `crypto.constants.ENGINE_METHOD_DIGESTS`
2085-
* `crypto.constants.ENGINE_METHOD_STORE`
20862084
* `crypto.constants.ENGINE_METHOD_PKEY_METHS`
20872085
* `crypto.constants.ENGINE_METHOD_PKEY_ASN1_METHS`
20882086
* `crypto.constants.ENGINE_METHOD_ALL`
20892087
* `crypto.constants.ENGINE_METHOD_NONE`
20902088

2089+
The flags below are deprecated in OpenSSL-1.1.0.
2090+
2091+
* `crypto.constants.ENGINE_METHOD_ECDH`
2092+
* `crypto.constants.ENGINE_METHOD_ECDSA`
2093+
* `crypto.constants.ENGINE_METHOD_STORE`
2094+
20912095
### crypto.setFips(bool)
20922096
<!-- YAML
20932097
added: REPLACEME
@@ -2352,12 +2356,8 @@ the `crypto`, `tls`, and `https` modules and are generally specific to OpenSSL.
23522356
<td>Limit engine usage to RAND</td>
23532357
</tr>
23542358
<tr>
2355-
<td><code>ENGINE_METHOD_ECDH</code></td>
2356-
<td>Limit engine usage to ECDH</td>
2357-
</tr>
2358-
<tr>
2359-
<td><code>ENGINE_METHOD_ECDSA</code></td>
2360-
<td>Limit engine usage to ECDSA</td>
2359+
<td><code>ENGINE_METHOD_EC</code></td>
2360+
<td>Limit engine usage to EC</td>
23612361
</tr>
23622362
<tr>
23632363
<td><code>ENGINE_METHOD_CIPHERS</code></td>
@@ -2367,10 +2367,6 @@ the `crypto`, `tls`, and `https` modules and are generally specific to OpenSSL.
23672367
<td><code>ENGINE_METHOD_DIGESTS</code></td>
23682368
<td>Limit engine usage to DIGESTS</td>
23692369
</tr>
2370-
<tr>
2371-
<td><code>ENGINE_METHOD_STORE</code></td>
2372-
<td>Limit engine usage to STORE</td>
2373-
</tr>
23742370
<tr>
23752371
<td><code>ENGINE_METHOD_PKEY_METHS</code></td>
23762372
<td>Limit engine usage to PKEY_METHDS</td>
@@ -2489,7 +2485,7 @@ the `crypto`, `tls`, and `https` modules and are generally specific to OpenSSL.
24892485

24902486

24912487
[`Buffer`]: buffer.html
2492-
[`EVP_BytesToKey`]: https://www.openssl.org/docs/man1.0.2/crypto/EVP_BytesToKey.html
2488+
[`EVP_BytesToKey`]: https://www.openssl.org/docs/man1.1.0/crypto/EVP_BytesToKey.html
24932489
[`UV_THREADPOOL_SIZE`]: cli.html#cli_uv_threadpool_size_size
24942490
[`cipher.final()`]: #crypto_cipher_final_outputencoding
24952491
[`cipher.update()`]: #crypto_cipher_update_data_inputencoding_outputencoding
@@ -2533,7 +2529,7 @@ the `crypto`, `tls`, and `https` modules and are generally specific to OpenSSL.
25332529
[NIST SP 800-132]: http://nvlpubs.nist.gov/nistpubs/Legacy/SP/nistspecialpublication800-132.pdf
25342530
[NIST SP 800-38D]: http://nvlpubs.nist.gov/nistpubs/Legacy/SP/nistspecialpublication800-38d.pdf
25352531
[Nonce-Disrespecting Adversaries]: https://github.com/nonce-disrespect/nonce-disrespect
2536-
[OpenSSL's SPKAC implementation]: https://www.openssl.org/docs/man1.0.2/apps/spkac.html
2532+
[OpenSSL's SPKAC implementation]: https://www.openssl.org/docs/man1.1.0/apps/openssl-spkac.html
25372533
[RFC 2412]: https://www.rfc-editor.org/rfc/rfc2412.txt
25382534
[RFC 3526]: https://www.rfc-editor.org/rfc/rfc3526.txt
25392535
[RFC 4055]: https://www.rfc-editor.org/rfc/rfc4055.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)