diff options
| author | Shobhit Chittora <chittorashobhit@gmail.com> | 2018-05-03 20:37:19 +0530 |
|---|---|---|
| committer | Anna Henningsen <anna@addaleax.net> | 2018-05-06 21:09:33 +0200 |
| commit | a1f342f054bac82c4a4a60dc7522f75a281e47a4 (patch) | |
| tree | 06377c3dfe3e0e64770ba0352fa904a4996306e5 /doc/api/crypto.md | |
| parent | 4692cf4ebba530b92b6c6aebc08fe9ddba5fb43d (diff) | |
| download | android-node-v8-a1f342f054bac82c4a4a60dc7522f75a281e47a4.tar.gz android-node-v8-a1f342f054bac82c4a4a60dc7522f75a281e47a4.tar.bz2 android-node-v8-a1f342f054bac82c4a4a60dc7522f75a281e47a4.zip | |
doc: updates crypto doc with openssl list -cipher-algorithms
PR-URL: https://github.com/nodejs/node/pull/20502
Refs: https://github.com/nodejs/node/issues/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>
Diffstat (limited to 'doc/api/crypto.md')
| -rw-r--r-- | doc/api/crypto.md | 15 |
1 files changed, 9 insertions, 6 deletions
diff --git a/doc/api/crypto.md b/doc/api/crypto.md index 32ef013b80..9ca30f9546 100644 --- a/doc/api/crypto.md +++ b/doc/api/crypto.md @@ -1346,8 +1346,9 @@ option is not required but can be used to set the length of the authentication tag that will be returned by `getAuthTag()` and defaults to 16 bytes. 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 @@ -1399,8 +1400,9 @@ option is not required but can be used to set the length of the authentication tag that will be returned by `getAuthTag()` and defaults to 16 bytes. 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, @@ -1496,8 +1498,9 @@ option is not required but can be used to restrict accepted authentication tags to those with the specified length. 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, |