Skip to content

Commit

Permalink
doc: updates crypto doc with openssl list -cipher-algorithms
Browse files Browse the repository at this point in the history
PR-URL: #20502
Refs: #20385
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Shigeki Ohtsu <ohtsu@ohtsu.org>
  • Loading branch information
shobhitchittora authored and MylesBorins committed May 8, 2018
1 parent e94deb8 commit e362e06
Showing 1 changed file with 9 additions and 6 deletions.
15 changes: 9 additions & 6 deletions doc/api/crypto.md
Original file line number Diff line number Diff line change
Expand Up @@ -1334,8 +1334,9 @@ cipher in CCM mode is used (e.g. `'aes-128-ccm'`). In that case, the
authentication tag in bytes, see [CCM mode][].

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

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

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

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

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

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

0 comments on commit e362e06

Please sign in to comment.