1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: mention CCM along with GCM in crypto APIs

Browse Source 
PR-URL: https://github.com/nodejs/node/pull/19945
Refs: https://github.com/nodejs/node/pull/18138
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
This commit is contained in:
Tobias Nießen 2018-04-11 14:58:15 +02:00
parent 2a6ab9b37b
commit 04148b1121
No known key found for this signature in database
GPG Key ID: 718207F8FD156B70
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/api/crypto.md
View File

@ -262,10 +262,10 @@ The `cipher.setAAD()` method must be called before [`cipher.update()`][].
<!-- YAML <!-- YAML
added: v1.0.0 added: v1.0.0
--> -->
- Returns: {Buffer} When using an authenticated encryption mode (only `GCM` is - Returns: {Buffer} When using an authenticated encryption mode (only `GCM` and
currently supported), the `cipher.getAuthTag()` method returns a [`Buffer`][] `CCM` are currently supported), the `cipher.getAuthTag()` method returns a
containing the _authentication tag_ that has been computed from the given [`Buffer`][] containing the _authentication tag_ that has been computed from
data. the given data.
The `cipher.getAuthTag()` method should only be called after encryption has The `cipher.getAuthTag()` method should only be called after encryption has
been completed using the [`cipher.final()`][] method. been completed using the [`cipher.final()`][] method.
@ -409,7 +409,7 @@ changes:
- `buffer` {Buffer | TypedArray | DataView} - `buffer` {Buffer | TypedArray | DataView}
- Returns: {Cipher} for method chaining. - Returns: {Cipher} for method chaining.
When using an authenticated encryption mode (only `GCM` is currently When using an authenticated encryption mode (only `GCM` and `CCM` are currently
supported), the `decipher.setAAD()` method sets the value used for the supported), the `decipher.setAAD()` method sets the value used for the
_additional authenticated data_ (AAD) input parameter. _additional authenticated data_ (AAD) input parameter.
@ -426,7 +426,7 @@ changes:
- `buffer` {Buffer | TypedArray | DataView} - `buffer` {Buffer | TypedArray | DataView}
- Returns: {Cipher} for method chaining. - Returns: {Cipher} for method chaining.
When using an authenticated encryption mode (only `GCM` is currently When using an authenticated encryption mode (only `GCM` and `CCM` are currently
supported), the `decipher.setAuthTag()` method is used to pass in the supported), the `decipher.setAuthTag()` method is used to pass in the
received _authentication tag_. If no tag is provided, or if the cipher text received _authentication tag_. If no tag is provided, or if the cipher text
has been tampered with, [`decipher.final()`][] will throw, indicating that the has been tampered with, [`decipher.final()`][] will throw, indicating that the