Skip to content

Commit d4e8714

Browse files
jbuhacofftargos
authored andcommitted
doc: update function description for decipher.setAAD
According to the [NodeJS CCM example](https://nodejs.org/docs/latest-v14.x/api/crypto.html#crypto_ccm_mode], when decrypting the `plaintextLength` parameter actually refers to the ciphertext length, not the plaintext length: ``` decipher.setAAD(aad, { plaintextLength: ciphertext.length }); ``` The same can be seen in the [OpenSSL docs](https://wiki.openssl.org/index.php/EVP_Authenticated_Encryption_and_Decryption) where a call to `EVP_DecryptUpdate` passes the ciphertext length: ``` /* Provide the total ciphertext length */ if(1 != EVP_DecryptUpdate(ctx, NULL, &len, NULL, ciphertext_len)) handleErrors(); ``` This parameter probably should have been called `inputLength` or `bufferLength` instead of `plaintextLength`, so that it makes sense both when encrypting and decrypting, but at least we can correct the sentence in the documentation for now to refer to the correct value. PR-URL: #33095 Reviewed-By: Ujjwal Sharma <[email protected]> Reviewed-By: Tobias Nießen <[email protected]> Reviewed-By: Colin Ihrig <[email protected]>
1 parent e2484b2 commit d4e8714

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

doc/api/crypto.md

+7-2
Original file line numberDiff line numberDiff line change
@@ -493,7 +493,7 @@ _additional authenticated data_ (AAD) input parameter.
493493

494494
The `options` argument is optional for `GCM`. When using `CCM`, the
495495
`plaintextLength` option must be specified and its value must match the length
496-
of the plaintext in bytes. See [CCM mode][].
496+
of the ciphertext in bytes. See [CCM mode][].
497497

498498
The `decipher.setAAD()` method must be called before [`decipher.update()`][].
499499

@@ -3104,7 +3104,12 @@ mode must adhere to certain restrictions when using the cipher API:
31043104
mode might fail as CCM cannot handle more than one chunk of data per instance.
31053105
* When passing additional authenticated data (AAD), the length of the actual
31063106
message in bytes must be passed to `setAAD()` via the `plaintextLength`
3107-
option. This is not necessary if no AAD is used.
3107+
option.
3108+
Many crypto libraries include the authentication tag in the ciphertext,
3109+
which means that they produce ciphertexts of the length
3110+
`plaintextLength + authTagLength`. Node.js does not include the authentication
3111+
tag, so the ciphertext length is always `plaintextLength`.
3112+
This is not necessary if no AAD is used.
31083113
* As CCM processes the whole message at once, `update()` can only be called
31093114
once.
31103115
* Even though calling `update()` is sufficient to encrypt/decrypt the message,

0 commit comments

Comments
 (0)