From 4cba1d3bfba3ef7973af1d31baf02846e0ce8a06 Mon Sep 17 00:00:00 2001 From: Shobhit Chittora Date: Thu, 3 May 2018 20:37:19 +0530 Subject: [PATCH 1/2] doc: updates crypto doc with openssl list -cypher-algorithms Closes: #20501 --- doc/api/crypto.md | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/doc/api/crypto.md b/doc/api/crypto.md index 32ef013b8096b5..2d3d268e36c2bf 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, From 36beaf4ab15dc2b37b8b65eaa9358674954a989e Mon Sep 17 00:00:00 2001 From: Shobhit Chittora Date: Thu, 3 May 2018 20:49:04 +0530 Subject: [PATCH 2/2] doc: removes extra spacing at the end of lines Refs: #20501 --- doc/api/crypto.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/doc/api/crypto.md b/doc/api/crypto.md index 2d3d268e36c2bf..9ca30f95462d81 100644 --- a/doc/api/crypto.md +++ b/doc/api/crypto.md @@ -1346,8 +1346,8 @@ 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` -(`openssl list-cipher-algorithms` for older versions of OpenSSL) will +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). @@ -1400,8 +1400,8 @@ 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` -(`openssl list-cipher-algorithms` for older versions of OpenSSL) will +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 @@ -1498,8 +1498,8 @@ 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` -(`openssl list-cipher-algorithms` for older versions of OpenSSL) will +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