Skip to contentSkip to conversation

how to handle AAD copy operation for algif_aead

RFC In review Stephan Müller 2 participants 7 messages Feb 24, 2017 – Mar 9, 2017 Crypto API

lore
Share & tools
lore
#0 lore raw

RFC 1/1 how to handle AAD copy operation for algif_aead

Hi Herbert et al,

attached are two patches where each patch has a different approach to copy the AAD in the algif_aead operation. I would like to hear your opinion which approach should be taken.

The patch 0001-crypto-algif_aead-copy-AAD-from-src-to-dst_separate.patch simply copies the AAD over from TX SGL to RX SGL. The pro is that the patch is small. The con is that this approach does *not* provide an in-place crypto operation.

The patch 0001-crypto-algif_aead-copy-AAD-from-src-to-dst_inplace.patch copies the AAD and the PT/CT from TX SGL into the RX SGL. In addition, this patch chains the SGL with the tag value part present in the TX SGL to the RX SGL in case of decryption. This implies that we have an in-place cipher operation operating in the RX SGL. Though, the patch is significantly larger.

(note: the patches are NOT meant for inclusion, but only for discussion -- yet both code parts are fully tested with by test framework in libkcapi).

Ciao
Stephan

Quoted 1 line

From 2135854799e3c8b2b6ea395941a21a6ab6b72823 Mon Sep 17 00:00:00 2001

From: Stephan Mueller <[email protected]>
Date: Fri, 24 Feb 2017 14:09:47 +0100
Subject: [PATCH] crypto: algif_aead - copy AAD from src to dst

Use the NULL cipher to copy the AAD and PT/CT from the TX SGL to the RX SGL. This allows an in-place crypto operation on the RX SGL for encryption, because the TX data is always smaller or equal to the RX data (the RX data will hold the tag).

For decryption, a per-request TX SGL is created which will only hold the tag value. As the RX SGL will have no space for the tag value and an in-place operation will not write the tag buffer, the TX SGL with the tag value is chained to the RX SGL. This now allows an in-place crypto operation.

---
 crypto/Kconfig      |   2 +
 crypto/algif_aead.c | 106 ++++++++++++++++++++++++++++++++++++++++++----------
 2 files changed, 88 insertions(+), 20 deletions(-)
crypto/Kconfig +2 -0
index 5a51b87..bfa531d 100644
@@ -1735,6 +1735,8 @@ config CRYPTO_USER_API_AEAD
 	tristate "User-space interface for AEAD cipher algorithms"
 	depends on NET
 	select CRYPTO_AEAD
+	select CRYPTO_BLKCIPHER
+	select CRYPTO_NULL
 	select CRYPTO_USER_API
 	help
 	  This option enables the user-spaces interface for AEAD
crypto/algif_aead.c +86 -20

176 lines not on this page · raw message

Signature · 1 line
2.9.3
Quoted 1 line

From cbd8a171c56008ce4932de9f0a54926279c6061d Mon Sep 17 00:00:00 2001

From: Stephan Mueller <[email protected]>
Date: Wed, 22 Feb 2017 17:22:02 +0100
Subject: [PATCH] crypto: algif_aead - copy AAD from src to dst

Use the NULL cipher to copy the AAD from the TX SGL to the RX SGL.

The required null cipher is allocated when allocating other components used by algif_aead and released when those components are deallocated.

---
 crypto/Kconfig      |  2 ++
 crypto/algif_aead.c | 33 +++++++++++++++++++++++++++++++++
 2 files changed, 35 insertions(+)
crypto/Kconfig +2 -0
index 5a51b87..bfa531d 100644
@@ -1735,6 +1735,8 @@ config CRYPTO_USER_API_AEAD
 	tristate "User-space interface for AEAD cipher algorithms"
 	depends on NET
 	select CRYPTO_AEAD
+	select CRYPTO_BLKCIPHER
+	select CRYPTO_NULL
 	select CRYPTO_USER_API
 	help
 	  This option enables the user-spaces interface for AEAD
crypto/algif_aead.c +33 -0
index 050a866..98c988b 100644
@@ -30,6 +30,8 @@
 #include <crypto/internal/aead.h>
 #include <crypto/scatterwalk.h>
 #include <crypto/if_alg.h>
+#include <crypto/skcipher.h>
+#include <crypto/null.h>
 #include <linux/init.h>
 #include <linux/list.h>
 #include <linux/kernel.h>
@@ -82,6 +84,7 @@ struct aead_ctx {
 
 	unsigned int len;	/* Length of allocated memory for this struct */
 	struct crypto_aead *aead_tfm;
+	struct crypto_skcipher *null;
 };
 
 static DECLARE_WAIT_QUEUE_HEAD(aead_aio_finish_wait);
@@ -559,6 +562,20 @@ static void aead_async_cb(struct crypto_async_request *_req, int err)
 	wake_up_interruptible(&aead_aio_finish_wait);
 }
 
+static int crypto_aead_copy_sgl(struct crypto_skcipher *null,
+				struct scatterlist *src,
+				struct scatterlist *dst, unsigned int len)
+{
+	SKCIPHER_REQUEST_ON_STACK(skreq, null);
+
+	skcipher_request_set_tfm(skreq, null);
+	skcipher_request_set_callback(skreq, CRYPTO_TFM_REQ_MAY_BACKLOG,
+				      NULL, NULL);
+	skcipher_request_set_crypt(skreq, src, dst, len, NULL);
+
+	return crypto_skcipher_encrypt(skreq);
+}
+
 static int aead_recvmsg(struct socket *sock, struct msghdr *msg, size_t ignored,
 			int flags)
 {
@@ -704,6 +721,12 @@ static int aead_recvmsg(struct socket *sock, struct msghdr *msg, size_t ignored,
 	sg_init_table(areq->tsgl, areq->tsgl_entries);
 	aead_pull_tsgl(sk, processed, areq->tsgl);
 
+	/* copy AAD from src to dst */
+	err = crypto_aead_copy_sgl(ctx->null, areq->tsgl,
+				   areq->first_rsgl.sgl.sg, ctx->aead_assoclen);
+	if (err)
+		goto free;
+
 	/* Initialize the crypto operation */
 	aead_request_set_crypt(&areq->aead_req, areq->tsgl,
 			       areq->first_rsgl.sgl.sg, used, ctx->iv);
@@ -825,6 +848,7 @@ static void aead_sock_destruct(struct sock *sk)
 	wait_event_interruptible(aead_aio_finish_wait, (ctx->inflight == 0));
 
 	aead_pull_tsgl(sk, ctx->used, NULL);
+	crypto_put_default_null_skcipher2();
 	sock_kzfree_s(sk, ctx->iv, ivlen);
 	sock_kfree_s(sk, ctx, ctx->len);
 	af_alg_release_parent(sk);
@@ -836,6 +860,7 @@ static int aead_accept_parent(void *private, struct sock *sk)
 	struct alg_sock *ask = alg_sk(sk);
 	unsigned int len = sizeof(*ctx);
 	unsigned int ivlen = crypto_aead_ivsize(private);
+	struct crypto_skcipher *null;
 
 	ctx = sock_kmalloc(sk, len, GFP_KERNEL);
 	if (!ctx)
@@ -849,6 +874,14 @@ static int aead_accept_parent(void *private, struct sock *sk)
 	}
 	memset(ctx->iv, 0, ivlen);
 
+	null = crypto_get_default_null_skcipher2();
+	if (IS_ERR(null)) {
+		sock_kfree_s(sk, ctx->iv, ivlen);
+		sock_kfree_s(sk, ctx, len);
+		return PTR_ERR(null);
+	}
+	ctx->null = null;
+
 	INIT_LIST_HEAD(&ctx->tsgl_list);
 	ctx->len = len;
 	ctx->used = 0;
Signature · 1 line
2.9.3
maintainer
#1 lore raw
Quoted 10 lines · Stephan Müller

Hi Herbert et al,

attached are two patches where each patch has a different approach to copy the AAD in the algif_aead operation. I would like to hear your opinion which approach should be taken.

The patch 0001-crypto-algif_aead-copy-AAD-from-src-to-dst_separate.patch simply copies the AAD over from TX SGL to RX SGL. The pro is that the patch is small. The con is that this approach does *not* provide an in-place crypto operation.

I prefer this patch with the proviso that it copy the whole thing instead of just the AD. That way you can just feed the dst memory to crypto_aead for in-place operation. Of course you have to mangle the tag data onto the dst SG list for decryption but it shouldn't be too hard.

Thanks,

Signature · 3 lines
Email: Herbert Xu <[email protected]>
Home Page: http://gondor.apana.org.au/~herbert/
PGP Key: http://gondor.apana.org.au/~herbert/pubkey.txt
#2 lore raw

Am Donnerstag, 9. März 2017, 11:00:11 CET schrieb Herbert Xu:

Hi Herbert,

Quoted 12 lines · Stephan Müller
Quoted 10 lines

Hi Herbert et al,

attached are two patches where each patch has a different approach to copy the AAD in the algif_aead operation. I would like to hear your opinion which approach should be taken.

The patch 0001-crypto-algif_aead-copy-AAD-from-src-to-dst_separate.patch simply copies the AAD over from TX SGL to RX SGL. The pro is that the patch is small. The con is that this approach does *not* provide an in-place crypto operation.

Quoted 5 lines

I prefer this patch with the proviso that it copy the whole thing instead of just the AD. That way you can just feed the dst memory to crypto_aead for in-place operation. Of course you have to mangle the tag data onto the dst SG list for decryption but it shouldn't be too hard.

I thought that is exactly the second patch. It copies the entire data to the dst SGL and extends the SGL with the tag in case of decryption.

Ciao
Stephan

maintainer
#3 lore raw
Quoted 6 lines · Stephan Müller
Quoted 6 lines
Quoted 5 lines

The patch 0001-crypto-algif_aead-copy-AAD-from-src-to-dst_separate.patch simply copies the AAD over from TX SGL to RX SGL. The pro is that the patch is small. The con is that this approach does *not* provide an in-place crypto operation.

Quoted 8 lines
Quoted 5 lines

I prefer this patch with the proviso that it copy the whole thing instead of just the AD. That way you can just feed the dst memory to crypto_aead for in-place operation. Of course you have to mangle the tag data onto the dst SG list for decryption but it shouldn't be too hard.

I thought that is exactly the second patch. It copies the entire data to the dst SGL and extends the SGL with the tag in case of decryption.

Are you sure? The patch says:

+ /* copy AAD from src to dst */
+ err = crypto_aead_copy_sgl(ctx->null, areq->tsgl,
+ areq->first_rsgl.sgl.sg, ctx->aead_assoclen);

Which seems to only copy the AD.

Cheers,

Signature · 3 lines
Email: Herbert Xu <[email protected]>
Home Page: http://gondor.apana.org.au/~herbert/
PGP Key: http://gondor.apana.org.au/~herbert/pubkey.txt
#4 lore raw

Am Donnerstag, 9. März 2017, 11:05:54 CET schrieb Herbert Xu:

Hi Herbert,

Quoted 23 lines · Stephan Müller
Quoted 6 lines
Quoted 6 lines
Quoted 5 lines

The patch 0001-crypto-algif_aead-copy-AAD-from-src-to-dst_separate.patch simply copies the AAD over from TX SGL to RX SGL. The pro is that the patch is small. The con is that this approach does *not* provide an in-place crypto operation.

Quoted 8 lines
Quoted 5 lines

I prefer this patch with the proviso that it copy the whole thing instead of just the AD. That way you can just feed the dst memory to crypto_aead for in-place operation. Of course you have to mangle the tag data onto the dst SG list for decryption but it shouldn't be too hard.

I thought that is exactly the second patch. It copies the entire data to the dst SGL and extends the SGL with the tag in case of decryption.

Are you sure? The patch says:

crypto/algif_aead.c +3 -0
+       /* copy AAD from src to dst */
+       err = crypto_aead_copy_sgl(ctx->null, areq->tsgl,
+                                  areq->first_rsgl.sgl.sg,

ctx->aead_assoclen);

Quoted 1 line

Which seems to only copy the AD.

This is the first patch (0001-crypto-algif_aead-copy-AAD-from-src-to- dst_separate.patch).

The second alternative patch (0001-crypto-algif_aead-copy-AAD-from-src-to- dst_inplace.patch) does:

+ if (ctx->enc) {
+ /* Copy AAD || PT to RX SGL buffer for in-place operation. */
+ err = crypto_aead_copy_sgl(ctx->null, tsgl->sg,
+ areq->first_rsgl.sgl.sg, processed);
+ if (err)
+ goto free;
+ aead_pull_tsgl(sk, processed, NULL, 0);
+ } else {
+ /* Copy AAD || CT to RX SGL buffer for in-place operation. */
+ err = crypto_aead_copy_sgl(ctx->null, tsgl->sg,
+ areq->first_rsgl.sgl.sg, outlen);
+ if (err)
+ goto free;
+
+ /* Create TX SGL for tag and chain it to RX SGL. */
+ areq->tsgl_entries = aead_count_tsgl(sk, processed);
+ if (!areq->tsgl_entries)
+ areq->tsgl_entries = 1;
+ areq->tsgl = sock_kmalloc(sk, sizeof(*areq->tsgl) *
+ areq->tsgl_entries,
+ GFP_KERNEL);
+ if (!areq->tsgl) {
+ err = -ENOMEM;
+ goto free;
+ }
+ sg_init_table(areq->tsgl, areq->tsgl_entries);
+
+ /* Release TX SGL, except for tag data. */
+ aead_pull_tsgl(sk, processed, areq->tsgl, processed - as);
+
+ /* chain the areq TX SGL holding the tag with RX SGL */
+ if (!last_rsgl) {
+ /* no RX SGL present (e.g. only authentication) */
+ sg_init_table(areq->first_rsgl.sgl.sg, 2);
+ sg_chain(areq->first_rsgl.sgl.sg, 2, areq->tsgl);
+ } else {
+ /* RX SGL present */
+ struct af_alg_sgl *sgl_prev = &last_rsgl->sgl;
+
+ sg_unmark_end(sgl_prev->sg + sgl_prev->npages - 1);
+ sg_chain(sgl_prev->sg, sgl_prev->npages + 1, areq->tsgl);
+ }
}

Ciao
Stephan

maintainer
#5 lore raw
Quoted 6 lines · Stephan Müller

This is the first patch (0001-crypto-algif_aead-copy-AAD-from-src-to- dst_separate.patch).

The second alternative patch (0001-crypto-algif_aead-copy-AAD-from-src-to- dst_inplace.patch) does:

I see. Yes that looks good.

Thanks,

Signature · 3 lines
Email: Herbert Xu <[email protected]>
Home Page: http://gondor.apana.org.au/~herbert/
PGP Key: http://gondor.apana.org.au/~herbert/pubkey.txt
#6 lore raw

Am Donnerstag, 9. März 2017, 11:23:16 CET schrieb Herbert Xu:

Hi Herbert,

Quoted 1 line

I see. Yes that looks good.

Thank you. I will provide an official patch after the discussion about the memory handling is completed.

As the memory handling patch should be considered for stable whereas the AAD copy patch should not, I would therefore recommend completing the memory handling discussion first.

Ciao
Stephan