Skip to content

Commit e948498

Browse files
committed
doc: remove OpenSSL 1.x references
Rename the openssl30 footnote, which marks APIs unavailable on BoringSSL rather than ones requiring OpenSSL 3. Drop the "As of OpenSSL 1.1.0" anchor from the PSK size limits and point the man1.1.1 links at man3.0. Signed-off-by: Filip Skokan <panva.ip@gmail.com>
1 parent 5b28e5f commit e948498

3 files changed

Lines changed: 17 additions & 17 deletions

File tree

doc/api/crypto.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4243,7 +4243,7 @@ Key decapsulation using a KEM algorithm with a private key.
42434243

42444244
Supported key types and their KEM algorithms are:
42454245

4246-
* `'rsa'`[^openssl30] RSA Secret Value Encapsulation
4246+
* `'rsa'`[^noboringssl] RSA Secret Value Encapsulation
42474247
* `'ec'`[^openssl32] DHKEM(P-256, HKDF-SHA256), DHKEM(P-384, HKDF-SHA256), DHKEM(P-521, HKDF-SHA256)
42484248
* `'x25519'`[^openssl32] DHKEM(X25519, HKDF-SHA256)
42494249
* `'x448'`[^openssl32] DHKEM(X448, HKDF-SHA512)
@@ -4315,7 +4315,7 @@ Key encapsulation using a KEM algorithm with a public key.
43154315

43164316
Supported key types and their KEM algorithms are:
43174317

4318-
* `'rsa'`[^openssl30] RSA Secret Value Encapsulation
4318+
* `'rsa'`[^noboringssl] RSA Secret Value Encapsulation
43194319
* `'ec'`[^openssl32] DHKEM(P-256, HKDF-SHA256), DHKEM(P-384, HKDF-SHA256), DHKEM(P-521, HKDF-SHA256)
43204320
* `'x25519'`[^openssl32] DHKEM(X25519, HKDF-SHA256)
43214321
* `'x448'`[^openssl32] DHKEM(X448, HKDF-SHA512)
@@ -7089,7 +7089,7 @@ See the [list of SSL OP Flags][] for details.
70897089
</tr>
70907090
</table>
70917091

7092-
[^openssl30]: Requires OpenSSL >= 3.0
7092+
[^noboringssl]: Not available when Node.js is built against BoringSSL
70937093

70947094
[^openssl32]: Requires OpenSSL >= 3.2
70957095

@@ -7131,7 +7131,7 @@ See the [list of SSL OP Flags][] for details.
71317131
[`--force-fips`]: cli.md#--force-fips
71327132
[`--openssl-config`]: cli.md#--openssl-configfile
71337133
[`--openssl-shared-config`]: cli.md#--openssl-shared-config
7134-
[`BN_is_prime_ex`]: https://www.openssl.org/docs/man1.1.1/man3/BN_is_prime_ex.html
7134+
[`BN_is_prime_ex`]: https://www.openssl.org/docs/man3.0/man3/BN_is_prime_ex.html
71357135
[`Buffer`]: buffer.md
71367136
[`DH_generate_key()`]: https://www.openssl.org/docs/man3.0/man3/DH_generate_key.html
71377137
[`DiffieHellmanGroup`]: #class-diffiehellmangroup

doc/api/tls.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -182,8 +182,8 @@ On the client connection, a custom `checkServerIdentity` should be passed
182182
because the default one will fail in the absence of a certificate.
183183

184184
According to the [RFC 4279][], PSK identities up to 128 bytes in length and
185-
PSKs up to 64 bytes in length must be supported. As of OpenSSL 1.1.0
186-
maximum identity size is 128 bytes, and maximum PSK length is 256 bytes.
185+
PSKs up to 64 bytes in length must be supported. In OpenSSL the maximum
186+
identity size is 128 bytes, and the maximum PSK length is 256 bytes.
187187

188188
The current implementation doesn't support asynchronous PSK callbacks due to the
189189
limitations of the underlying OpenSSL API.
@@ -1207,7 +1207,7 @@ For example, a TLSv1.2 protocol with AES256-SHA cipher:
12071207
```
12081208

12091209
See
1210-
[SSL\_CIPHER\_get\_name](https://www.openssl.org/docs/man1.1.1/man3/SSL_CIPHER_get_name.html)
1210+
[SSL\_CIPHER\_get\_name](https://www.openssl.org/docs/man3.0/man3/SSL_CIPHER_get_name.html)
12111211
for more information.
12121212

12131213
### `tlsSocket.getEphemeralKeyInfo()`
@@ -1459,7 +1459,7 @@ added: v12.11.0
14591459
the client in the order of decreasing preference.
14601460

14611461
See
1462-
[SSL\_get\_shared\_sigalgs](https://www.openssl.org/docs/man1.1.1/man3/SSL_get_shared_sigalgs.html)
1462+
[SSL\_get\_shared\_sigalgs](https://www.openssl.org/docs/man3.0/man3/SSL_get_shared_sigalgs.html)
14631463
for more information.
14641464

14651465
### `tlsSocket.getTLSTicket()`
@@ -2048,7 +2048,7 @@ changes:
20482048
The list can contain digest algorithms (`SHA256`, `MD5` etc.), public key
20492049
algorithms (`RSA-PSS`, `ECDSA` etc.), combination of both (e.g
20502050
'RSA+SHA384') or TLS v1.3 scheme names (e.g. `rsa_pss_pss_sha512`).
2051-
See [OpenSSL man pages](https://www.openssl.org/docs/man1.1.1/man3/SSL_CTX_set1_sigalgs_list.html)
2051+
See [OpenSSL man pages](https://www.openssl.org/docs/man3.0/man3/SSL_CTX_set1_sigalgs_list.html)
20522052
for more info.
20532053
* `ciphers` {string} Cipher suite specification, replacing the default. For
20542054
more information, see [Modifying the default TLS cipher suite][]. Permitted
@@ -2555,7 +2555,7 @@ added: v0.11.3
25552555
[RFC 5077]: https://tools.ietf.org/html/rfc5077
25562556
[RFC 5929]: https://tools.ietf.org/html/rfc5929
25572557
[RFC 8879]: https://tools.ietf.org/html/rfc8879
2558-
[SSL_METHODS]: https://www.openssl.org/docs/man1.1.1/man7/ssl.html#Dealing-with-Protocol-Methods
2558+
[SSL_METHODS]: https://www.openssl.org/docs/man3.0/man7/ssl.html#Dealing-with-Protocol-Methods
25592559
[Session Resumption]: #session-resumption
25602560
[Stream]: stream.md#stream
25612561
[TLS recommendations]: https://wiki.mozilla.org/Security/Server_Side_TLS
@@ -2572,8 +2572,8 @@ added: v0.11.3
25722572
[`Duplex`]: stream.md#class-streamduplex
25732573
[`NODE_EXTRA_CA_CERTS`]: cli.md#node_extra_ca_certsfile
25742574
[`NODE_OPTIONS`]: cli.md#node_optionsoptions
2575-
[`SSL_export_keying_material`]: https://www.openssl.org/docs/man1.1.1/man3/SSL_export_keying_material.html
2576-
[`SSL_get_version`]: https://www.openssl.org/docs/man1.1.1/man3/SSL_get_version.html
2575+
[`SSL_export_keying_material`]: https://www.openssl.org/docs/man3.0/man3/SSL_export_keying_material.html
2576+
[`SSL_get_version`]: https://www.openssl.org/docs/man3.0/man3/SSL_get_version.html
25772577
[`crypto.getCurves()`]: crypto.md#cryptogetcurves
25782578
[`import()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/import
25792579
[`net.Server.address()`]: net.md#serveraddress
@@ -2608,6 +2608,6 @@ added: v0.11.3
26082608
[`x509.checkHost()`]: crypto.md#x509checkhostname-options
26092609
[asn1.js]: https://www.npmjs.com/package/asn1.js
26102610
[certificate object]: #certificate-object
2611-
[cipher list format]: https://www.openssl.org/docs/man1.1.1/man1/ciphers.html#CIPHER-LIST-FORMAT
2611+
[cipher list format]: https://www.openssl.org/docs/man3.0/man1/ciphers.html#CIPHER-LIST-FORMAT
26122612
[forward secrecy]: https://en.wikipedia.org/wiki/Perfect_forward_secrecy
26132613
[perfect forward secrecy]: #perfect-forward-secrecy

doc/api/webcrypto.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -119,15 +119,15 @@ WICG proposal:
119119

120120
Algorithms:
121121

122-
* `'AES-OCB'`[^openssl30]
122+
* `'AES-OCB'`[^noboringssl]
123123
* `'Argon2d'`[^openssl32]
124124
* `'Argon2i'`[^openssl32]
125125
* `'Argon2id'`[^openssl32]
126126
* `'ChaCha20-Poly1305'`
127127
* `'cSHAKE128'`
128128
* `'cSHAKE256'`
129-
* `'KMAC128'`[^openssl30]
130-
* `'KMAC256'`[^openssl30]
129+
* `'KMAC128'`[^noboringssl]
130+
* `'KMAC256'`[^noboringssl]
131131
* `'KT128'`
132132
* `'KT256'`
133133
* `'ML-DSA-44'`[^openssl35]
@@ -2719,7 +2719,7 @@ added:
27192719
27202720
[^modern-algos]: See [Modern Algorithms in the Web Cryptography API][]
27212721
2722-
[^openssl30]: Requires OpenSSL >= 3.0
2722+
[^noboringssl]: Not available when Node.js is built against BoringSSL
27232723
27242724
[^openssl32]: Requires OpenSSL >= 3.2
27252725

0 commit comments

Comments
 (0)