From e6f804b0af7d12981df0bee1d9269b8d4b352bae Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Sat, 20 Feb 2021 05:18:19 -0800 Subject: [PATCH] doc: alphabetize crypto Cipher class entries MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit PR-URL: https://github.com/nodejs/node/pull/37450 Reviewed-By: Michaël Zasso Reviewed-By: Gireesh Punathil Reviewed-By: Darshan Sen Reviewed-By: Luigi Pinca --- doc/api/crypto.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/doc/api/crypto.md b/doc/api/crypto.md index 6bc66ab52a3a5f..66f8684eb1f5db 100644 --- a/doc/api/crypto.md +++ b/doc/api/crypto.md @@ -282,6 +282,19 @@ Once the `cipher.final()` method has been called, the `Cipher` object can no longer be used to encrypt data. Attempts to call `cipher.final()` more than once will result in an error being thrown. +### `cipher.getAuthTag()` + + +* Returns: {Buffer} When using an authenticated encryption mode (`GCM`, `CCM` + and `OCB` are currently supported), the `cipher.getAuthTag()` method returns a + [`Buffer`][] containing the _authentication tag_ that has been computed from + the given data. + +The `cipher.getAuthTag()` method should only be called after encryption has +been completed using the [`cipher.final()`][] method. + ### `cipher.setAAD(buffer[, options])` - -* Returns: {Buffer} When using an authenticated encryption mode (`GCM`, `CCM` - and `OCB` are currently supported), the `cipher.getAuthTag()` method returns a - [`Buffer`][] containing the _authentication tag_ that has been computed from - the given data. - -The `cipher.getAuthTag()` method should only be called after encryption has -been completed using the [`cipher.final()`][] method. - ### `cipher.setAutoPadding([autoPadding])`