Skip to content

Commit e362e06

Browse files
shobhitchittoraMylesBorins
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 e94deb8 commit e362e06

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

doc/api/crypto.md

+9-6
Original file line numberDiff line numberDiff line change
@@ -1334,8 +1334,9 @@ cipher in CCM mode is used (e.g. `'aes-128-ccm'`). In that case, the
13341334
authentication tag in bytes, see [CCM mode][].
13351335

13361336
The `algorithm` is dependent on OpenSSL, examples are `'aes192'`, etc. On
1337-
recent OpenSSL releases, `openssl list-cipher-algorithms` will display the
1338-
available cipher algorithms.
1337+
recent OpenSSL releases, `openssl list -cipher-algorithms`
1338+
(`openssl list-cipher-algorithms` for older versions of OpenSSL) will
1339+
display the available cipher algorithms.
13391340

13401341
The `password` is used to derive the cipher key and initialization vector (IV).
13411342
The value must be either a `'latin1'` encoded string, a [`Buffer`][], a
@@ -1381,8 +1382,9 @@ cipher in CCM mode is used (e.g. `'aes-128-ccm'`). In that case, the
13811382
authentication tag in bytes, see [CCM mode][].
13821383

13831384
The `algorithm` is dependent on OpenSSL, examples are `'aes192'`, etc. On
1384-
recent OpenSSL releases, `openssl list-cipher-algorithms` will display the
1385-
available cipher algorithms.
1385+
recent OpenSSL releases, `openssl list -cipher-algorithms`
1386+
(`openssl list-cipher-algorithms` for older versions of OpenSSL) will
1387+
display the available cipher algorithms.
13861388

13871389
The `key` is the raw key used by the `algorithm` and `iv` is an
13881390
[initialization vector][]. Both arguments must be `'utf8'` encoded strings,
@@ -1472,8 +1474,9 @@ cipher in CCM mode is used (e.g. `'aes-128-ccm'`). In that case, the
14721474
authentication tag in bytes, see [CCM mode][].
14731475

14741476
The `algorithm` is dependent on OpenSSL, examples are `'aes192'`, etc. On
1475-
recent OpenSSL releases, `openssl list-cipher-algorithms` will display the
1476-
available cipher algorithms.
1477+
recent OpenSSL releases, `openssl list -cipher-algorithms`
1478+
(`openssl list-cipher-algorithms` for older versions of OpenSSL) will
1479+
display the available cipher algorithms.
14771480

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

0 commit comments

Comments
 (0)