Skip to content

Commit a1f342f

Browse files
shobhitchittoraaddaleax
authored andcommitted
doc: updates crypto doc with openssl list -cipher-algorithms
PR-URL: #20502 Refs: #20385 Reviewed-By: Tobias Nießen <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Shigeki Ohtsu <[email protected]>
1 parent 4692cf4 commit a1f342f

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

doc/api/crypto.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1346,8 +1346,9 @@ option is not required but can be used to set the length of the authentication
13461346
tag that will be returned by `getAuthTag()` and defaults to 16 bytes.
13471347

13481348
The `algorithm` is dependent on OpenSSL, examples are `'aes192'`, etc. On
1349-
recent OpenSSL releases, `openssl list-cipher-algorithms` will display the
1350-
available cipher algorithms.
1349+
recent OpenSSL releases, `openssl list -cipher-algorithms`
1350+
(`openssl list-cipher-algorithms` for older versions of OpenSSL) will
1351+
display the available cipher algorithms.
13511352

13521353
The `password` is used to derive the cipher key and initialization vector (IV).
13531354
The value must be either a `'latin1'` encoded string, a [`Buffer`][], a
@@ -1399,8 +1400,9 @@ option is not required but can be used to set the length of the authentication
13991400
tag that will be returned by `getAuthTag()` and defaults to 16 bytes.
14001401

14011402
The `algorithm` is dependent on OpenSSL, examples are `'aes192'`, etc. On
1402-
recent OpenSSL releases, `openssl list-cipher-algorithms` will display the
1403-
available cipher algorithms.
1403+
recent OpenSSL releases, `openssl list -cipher-algorithms`
1404+
(`openssl list-cipher-algorithms` for older versions of OpenSSL) will
1405+
display the available cipher algorithms.
14041406

14051407
The `key` is the raw key used by the `algorithm` and `iv` is an
14061408
[initialization vector][]. Both arguments must be `'utf8'` encoded strings,
@@ -1496,8 +1498,9 @@ option is not required but can be used to restrict accepted authentication tags
14961498
to those with the specified length.
14971499

14981500
The `algorithm` is dependent on OpenSSL, examples are `'aes192'`, etc. On
1499-
recent OpenSSL releases, `openssl list-cipher-algorithms` will display the
1500-
available cipher algorithms.
1501+
recent OpenSSL releases, `openssl list -cipher-algorithms`
1502+
(`openssl list-cipher-algorithms` for older versions of OpenSSL) will
1503+
display the available cipher algorithms.
15011504

15021505
The `key` is the raw key used by the `algorithm` and `iv` is an
15031506
[initialization vector][]. Both arguments must be `'utf8'` encoded strings,

0 commit comments

Comments
 (0)