crypto: lib/aesgcm - Add kernel docs for aesgcm_mac
authorSagar Vashnav <sagarvashnav72427@gmail.com>
Wed, 25 Oct 2023 12:57:07 +0000 (08:57 -0400)
committerHerbert Xu <herbert@gondor.apana.org.au>
Fri, 17 Nov 2023 11:16:28 +0000 (19:16 +0800)
Add kernel documentation for the aesgcm_mac.
This function generates the authentication tag using the AES-GCM algorithm.

Signed-off-by: Sagar Vashnav <sagarvashnav72427@gmail.com>
Signed-off-by: Herbert Xu <herbert@gondor.apana.org.au>
lib/crypto/aesgcm.c

index c632d6e17af8769853cc29de8223c1216ba52b24..6bba6473fdf3474b53582fa827c32cf560b7ed7b 100644 (file)
@@ -73,6 +73,19 @@ static void aesgcm_ghash(be128 *ghash, const be128 *key, const void *src,
        }
 }
 
+/**
+ * aesgcm_mac - Generates the authentication tag using AES-GCM algorithm.
+ * @ctx: The data structure that will hold the AES-GCM key schedule
+ * @src: The input source data.
+ * @src_len: Length of the source data.
+ * @assoc: Points to the associated data.
+ * @assoc_len: Length of the associated data values.
+ * @ctr: Points to the counter value.
+ * @authtag: The output buffer for the authentication tag.
+ *
+ * It takes in the AES-GCM context, source data, associated data, counter value,
+ * and an output buffer for the authentication tag.
+ */
 static void aesgcm_mac(const struct aesgcm_ctx *ctx, const u8 *src, int src_len,
                       const u8 *assoc, int assoc_len, __be32 *ctr, u8 *authtag)
 {