[PATCH 0/12] Do not include crypto/algapi.h

[PATCH 0/12] Do not include crypto/algapi.h

[Herbert Xu]

Hi:

The header file crypto/algapi.h is for internal use only.  There is
no reason to use it outside of the Crypto API.  Most uses of it
outside of the API should use crypto/utils.h instead.

Feel free to apply this patch to your tree directly.  Just send me
a reply and I'll drop it from my patch queue.

Thanks,
-- 
Email: Herbert Xu <herbert@gondor.apana.org.au>
Home Page: http://gondor.apana.org.au/~herbert/
PGP Key: http://gondor.apana.org.au/~herbert/pubkey.txt

Re: [PATCH 6/12] wifi: mac80211: Do not include crypto/algapi.h

[Johannes Berg]

On Wed, 2023-08-23 at 18:32 +0800, Herbert Xu wrote:
> The header file crypto/algapi.h is for internal use only.  Use the
> header file crypto/utils.h instead.
> 

No objection, of course, but I don't think it's necessarily clear that
it "is for internal use only", it literally says:

 * Cryptographic API for algorithms (i.e., low-level API).

which really isn't the same as "don't use this file".

Might want to clarify that, or even move it into crypto/ from
include/crypto/ or something?

johannes

Re: [PATCH 11/12] wireguard: Do not include crypto/algapi.h

[Jason A. Donenfeld]

On Wed, Aug 23, 2023 at 12:33 PM Herbert Xu <herbert@gondor.apana.org.au> wrote:
>
> The header file crypto/algapi.h is for internal use only.  Use the
> header file crypto/utils.h instead.
>
> Signed-off-by: Herbert Xu <herbert@gondor.apana.org.au>
> ---
>
>  drivers/net/wireguard/cookie.c  |    2 +-
>  drivers/net/wireguard/netlink.c |    2 +-
>  drivers/net/wireguard/noise.c   |    2 +-
>  3 files changed, 3 insertions(+), 3 deletions(-)
>
> diff --git a/drivers/net/wireguard/cookie.c b/drivers/net/wireguard/cookie.c
> index 4956f0499c19..f89581b5e8cb 100644
> --- a/drivers/net/wireguard/cookie.c
> +++ b/drivers/net/wireguard/cookie.c
> @@ -12,9 +12,9 @@
>
>  #include <crypto/blake2s.h>
>  #include <crypto/chacha20poly1305.h>
> +#include <crypto/utils.h>
>
>  #include <net/ipv6.h>
> -#include <crypto/algapi.h>
>
>  void wg_cookie_checker_init(struct cookie_checker *checker,
>                             struct wg_device *wg)
> diff --git a/drivers/net/wireguard/netlink.c b/drivers/net/wireguard/netlink.c
> index 6d1bd9f52d02..0a1502100e8b 100644
> --- a/drivers/net/wireguard/netlink.c
> +++ b/drivers/net/wireguard/netlink.c
> @@ -12,10 +12,10 @@
>
>  #include <uapi/linux/wireguard.h>
>
> +#include <crypto/utils.h>
>  #include <linux/if.h>
>  #include <net/genetlink.h>
>  #include <net/sock.h>
> -#include <crypto/algapi.h>
>
>  static struct genl_family genl_family;
>
> diff --git a/drivers/net/wireguard/noise.c b/drivers/net/wireguard/noise.c
> index 720952b92e78..e7ad81ca4a36 100644
> --- a/drivers/net/wireguard/noise.c
> +++ b/drivers/net/wireguard/noise.c
> @@ -10,12 +10,12 @@
>  #include "queueing.h"
>  #include "peerlookup.h"
>
> +#include <crypto/utils.h>
>  #include <linux/rcupdate.h>
>  #include <linux/slab.h>
>  #include <linux/bitmap.h>
>  #include <linux/scatterlist.h>
>  #include <linux/highmem.h>
> -#include <crypto/algapi.h>
>
>  /* This implements Noise_IKpsk2:
>   *

Small nit - with the exception of the cookie.c reordering, could you
maintain the existing #include ordering of the other files? No need to
send a v2 for that if you don't want. And please make the entire
commit subject lowercase. With those done,

Acked-by: Jason A. Donenfeld <Jason@zx2c4.com>

As a side note, you may want to eventually do something to make sure
people don't add back algapi.h, like move it to internal/ or out of
include/ all together. I figure you've already thought about this, and
this series is just the first step.

Jason

Re: [PATCH 7/12] mptcp: Do not include crypto/algapi.h

[Matthieu Baerts]

Hello,

On 23/08/2023 12:32, Herbert Xu wrote:
> The header file crypto/algapi.h is for internal use only.  Use the
> header file crypto/utils.h instead.

Thank you for the patch! It looks good to me:

Acked-by: Matthieu Baerts <matthieu.baerts@tessares.net>

I understood that other patches will come later to make it clear
crypto/algapi.h is for internal use only so that's good!

> diff --git a/net/mptcp/subflow.c b/net/mptcp/subflow.c
> index 9ee3b7abbaf6..64bb200099dc 100644
> --- a/net/mptcp/subflow.c
> +++ b/net/mptcp/subflow.c
> @@ -9,8 +9,8 @@
>  #include <linux/kernel.h>
>  #include <linux/module.h>
>  #include <linux/netdevice.h>
> -#include <crypto/algapi.h>
>  #include <crypto/sha2.h>
> +#include <crypto/utils.h>

It is fine for me if you carry this patch in your tree: this part here
has not changed for a while and there is no ongoing work going to modify
it. So there should not be any conflicts when merging the different
trees later.

Cheers,
Matt
-- 
Tessares | Belgium | Hybrid Access Solutions
www.tessares.net

Re: [PATCH 8/12] SUNRPC: Do not include crypto/algapi.h

[Chuck Lever]

On Wed, Aug 23, 2023 at 06:32:30PM +0800, Herbert Xu wrote:
> The header file crypto/algapi.h is for internal use only.  Use the
> header file crypto/utils.h instead.
> 
> Signed-off-by: Herbert Xu <herbert@gondor.apana.org.au>

Acked-by: Chuck Lever <chuck.lever@oracle.com>


> ---
> 
>  net/sunrpc/auth_gss/gss_krb5_crypto.c |    2 +-
>  net/sunrpc/auth_gss/gss_krb5_unseal.c |    2 --
>  2 files changed, 1 insertion(+), 3 deletions(-)
> 
> diff --git a/net/sunrpc/auth_gss/gss_krb5_crypto.c b/net/sunrpc/auth_gss/gss_krb5_crypto.c
> index 9734e1d9f991..d2b02710ab07 100644
> --- a/net/sunrpc/auth_gss/gss_krb5_crypto.c
> +++ b/net/sunrpc/auth_gss/gss_krb5_crypto.c
> @@ -34,9 +34,9 @@
>   * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
>   */
>  
> -#include <crypto/algapi.h>
>  #include <crypto/hash.h>
>  #include <crypto/skcipher.h>
> +#include <crypto/utils.h>
>  #include <linux/err.h>
>  #include <linux/types.h>
>  #include <linux/mm.h>
> diff --git a/net/sunrpc/auth_gss/gss_krb5_unseal.c b/net/sunrpc/auth_gss/gss_krb5_unseal.c
> index 7d6d4ae4a3c9..b3ca30544e70 100644
> --- a/net/sunrpc/auth_gss/gss_krb5_unseal.c
> +++ b/net/sunrpc/auth_gss/gss_krb5_unseal.c
> @@ -57,11 +57,9 @@
>   * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
>   */
>  
> -#include <crypto/algapi.h>
>  #include <linux/types.h>
>  #include <linux/jiffies.h>
>  #include <linux/sunrpc/gss_krb5.h>
> -#include <linux/crypto.h>
>  
>  #include "gss_krb5_internal.h"
>  

-- 
Chuck Lever

Re: [PATCH 4/12] ceph: Do not include crypto/algapi.h

[Ilya Dryomov]

On Wed, Aug 23, 2023 at 12:32 PM Herbert Xu <herbert@gondor.apana.org.au> wrote:
>
> The header file crypto/algapi.h is for internal use only.  Use the
> header file crypto/utils.h instead.
>
> Signed-off-by: Herbert Xu <herbert@gondor.apana.org.au>
> ---
>
>  net/ceph/messenger_v2.c |    2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/net/ceph/messenger_v2.c b/net/ceph/messenger_v2.c
> index 1a888b86a494..4aab32144833 100644
> --- a/net/ceph/messenger_v2.c
> +++ b/net/ceph/messenger_v2.c
> @@ -8,9 +8,9 @@
>  #include <linux/ceph/ceph_debug.h>
>
>  #include <crypto/aead.h>
> -#include <crypto/algapi.h>  /* for crypto_memneq() */
>  #include <crypto/hash.h>
>  #include <crypto/sha2.h>
> +#include <crypto/utils.h>
>  #include <linux/bvec.h>
>  #include <linux/crc32c.h>
>  #include <linux/net.h>

Applied.

Thanks,

                Ilya

Re: [PATCH 6/12] wifi: mac80211: Do not include crypto/algapi.h

[Herbert Xu]

On Wed, Aug 23, 2023 at 12:34:35PM +0200, Johannes Berg wrote:
> 
> No objection, of course, but I don't think it's necessarily clear that
> it "is for internal use only", it literally says:
> 
>  * Cryptographic API for algorithms (i.e., low-level API).
> 
> which really isn't the same as "don't use this file".
> 
> Might want to clarify that, or even move it into crypto/ from
> include/crypto/ or something?

Yes it should be in include/crypto/internal.  Once the churn gets
small enough I'll move it there.

Thanks,
-- 
Email: Herbert Xu <herbert@gondor.apana.org.au>
Home Page: http://gondor.apana.org.au/~herbert/
PGP Key: http://gondor.apana.org.au/~herbert/pubkey.txt

[v2 PATCH] wireguard: do not include crypto/algapi.h

[Herbert Xu]

On Wed, Aug 23, 2023 at 01:48:47PM +0200, Jason A. Donenfeld wrote:
>
> Small nit - with the exception of the cookie.c reordering, could you
> maintain the existing #include ordering of the other files? No need to
> send a v2 for that if you don't want. And please make the entire
> commit subject lowercase. With those done,
> 
> Acked-by: Jason A. Donenfeld <Jason@zx2c4.com>

Thanks.  As these patches are independent of each other, I'll just
repost this one patch and delete it from the original series.

> As a side note, you may want to eventually do something to make sure
> people don't add back algapi.h, like move it to internal/ or out of
> include/ all together. I figure you've already thought about this, and
> this series is just the first step.

Sure that is the idea.  Although judging from the result of my
grep, it seems most of the external users are due to the utility
functions which hopefully won't be an issue anymore because of the
new crypto/utils.h file.

---8<---
The header file crypto/algapi.h is for internal use only.  Use the
header file crypto/utils.h instead.

Acked-by: Jason A. Donenfeld <Jason@zx2c4.com>
Signed-off-by: Herbert Xu <herbert@gondor.apana.org.au>
---

 drivers/net/wireguard/cookie.c  |    2 +-
 drivers/net/wireguard/netlink.c |    2 +-
 drivers/net/wireguard/noise.c   |    2 +-
 3 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/drivers/net/wireguard/cookie.c b/drivers/net/wireguard/cookie.c
index 4956f0499c19..f89581b5e8cb 100644
--- a/drivers/net/wireguard/cookie.c
+++ b/drivers/net/wireguard/cookie.c
@@ -12,9 +12,9 @@
 
 #include <crypto/blake2s.h>
 #include <crypto/chacha20poly1305.h>
+#include <crypto/utils.h>
 
 #include <net/ipv6.h>
-#include <crypto/algapi.h>
 
 void wg_cookie_checker_init(struct cookie_checker *checker,
 			    struct wg_device *wg)
diff --git a/drivers/net/wireguard/netlink.c b/drivers/net/wireguard/netlink.c
index 6d1bd9f52d02..0a2f225e754a 100644
--- a/drivers/net/wireguard/netlink.c
+++ b/drivers/net/wireguard/netlink.c
@@ -15,7 +15,7 @@
 #include <linux/if.h>
 #include <net/genetlink.h>
 #include <net/sock.h>
-#include <crypto/algapi.h>
+#include <crypto/utils.h>
 
 static struct genl_family genl_family;
 
diff --git a/drivers/net/wireguard/noise.c b/drivers/net/wireguard/noise.c
index 720952b92e78..202a33af5a72 100644
--- a/drivers/net/wireguard/noise.c
+++ b/drivers/net/wireguard/noise.c
@@ -15,7 +15,7 @@
 #include <linux/bitmap.h>
 #include <linux/scatterlist.h>
 #include <linux/highmem.h>
-#include <crypto/algapi.h>
+#include <crypto/utils.h>
 
 /* This implements Noise_IKpsk2:
  *
-- 
Email: Herbert Xu <herbert@gondor.apana.org.au>
Home Page: http://gondor.apana.org.au/~herbert/
PGP Key: http://gondor.apana.org.au/~herbert/pubkey.txt

Re: [PATCH 6/12] wifi: mac80211: Do not include crypto/algapi.h

[Johannes Berg]

On Thu, 2023-08-24 at 13:10 +0800, Herbert Xu wrote:
> On Wed, Aug 23, 2023 at 12:34:35PM +0200, Johannes Berg wrote:
> > 
> > No objection, of course, but I don't think it's necessarily clear that
> > it "is for internal use only", it literally says:
> > 
> >  * Cryptographic API for algorithms (i.e., low-level API).
> > 
> > which really isn't the same as "don't use this file".
> > 
> > Might want to clarify that, or even move it into crypto/ from
> > include/crypto/ or something?
> 
> Yes it should be in include/crypto/internal.  Once the churn gets
> small enough I'll move it there.
> 

Sounds good :)

I was kind of waiting to see - but now that others have applied some
patches to their tree I've done the same.

johannes

Re: [PATCH 6/12] wifi: mac80211: Do not include crypto/algapi.h

[Herbert Xu]

On Thu, Aug 24, 2023 at 08:59:08AM +0200, Johannes Berg wrote:
>
> I was kind of waiting to see - but now that others have applied some
> patches to their tree I've done the same.

Noted.  Thanks!
-- 
Email: Herbert Xu <herbert@gondor.apana.org.au>
Home Page: http://gondor.apana.org.au/~herbert/
PGP Key: http://gondor.apana.org.au/~herbert/pubkey.txt

Re: [PATCH 9/12] evm: Do not include crypto/algapi.h

[Mimi Zohar]

On Wed, 2023-08-23 at 18:32 +0800, Herbert Xu wrote:
> The header file crypto/algapi.h is for internal use only.  Use the
> header file crypto/utils.h instead.
> 
> Signed-off-by: Herbert Xu <herbert@gondor.apana.org.au>

Acked-by: Mimi Zohar <zohar@linux.ibm.com>

> ---
> 
>  security/integrity/evm/evm_main.c |    3 +--
>  1 file changed, 1 insertion(+), 2 deletions(-)
> 
> diff --git a/security/integrity/evm/evm_main.c b/security/integrity/evm/evm_main.c
> index c9b6e2a43478..e635a8d18dae 100644
> --- a/security/integrity/evm/evm_main.c
> +++ b/security/integrity/evm/evm_main.c
> @@ -14,7 +14,6 @@
>  #define pr_fmt(fmt) "EVM: "fmt
>  
>  #include <linux/init.h>
> -#include <linux/crypto.h>
>  #include <linux/audit.h>
>  #include <linux/xattr.h>
>  #include <linux/integrity.h>
> @@ -24,7 +23,7 @@
>  
>  #include <crypto/hash.h>
>  #include <crypto/hash_info.h>
> -#include <crypto/algapi.h>
> +#include <crypto/utils.h>
>  #include "evm.h"
>  
>  int evm_initialized;

Re: [PATCH 10/12] KEYS: encrypted: Do not include crypto/algapi.h

[Mimi Zohar]

On Wed, 2023-08-23 at 18:32 +0800, Herbert Xu wrote:
> The header file crypto/algapi.h is for internal use only.  Use the
> header file crypto/utils.h instead.
> 
> Signed-off-by: Herbert Xu <herbert@gondor.apana.org.au>

Acked-by: Mimi Zohar <zohar@linux.ibm.com>

> ---
> 
>  security/keys/encrypted-keys/encrypted.c |    2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/security/keys/encrypted-keys/encrypted.c b/security/keys/encrypted-keys/encrypted.c
> index 1e313982af02..8af2136069d2 100644
> --- a/security/keys/encrypted-keys/encrypted.c
> +++ b/security/keys/encrypted-keys/encrypted.c
> @@ -27,10 +27,10 @@
>  #include <linux/scatterlist.h>
>  #include <linux/ctype.h>
>  #include <crypto/aes.h>
> -#include <crypto/algapi.h>
>  #include <crypto/hash.h>
>  #include <crypto/sha2.h>
>  #include <crypto/skcipher.h>
> +#include <crypto/utils.h>
>  
>  #include "encrypted.h"
>  #include "ecryptfs_format.h"

Re: [PATCH 1/12] fscrypt: Do not include crypto/algapi.h

[Eric Biggers]

On Wed, Aug 23, 2023 at 06:32:15PM +0800, Herbert Xu wrote:
> The header file crypto/algapi.h is for internal use only.  Use the
> header file crypto/utils.h instead.
> 
> Signed-off-by: Herbert Xu <herbert@gondor.apana.org.au>
> ---
> 
>  fs/crypto/keysetup_v1.c |    2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/fs/crypto/keysetup_v1.c b/fs/crypto/keysetup_v1.c
> index 75dabd9b27f9..d698ecb9ad44 100644
> --- a/fs/crypto/keysetup_v1.c
> +++ b/fs/crypto/keysetup_v1.c
> @@ -20,8 +20,8 @@
>   *    managed alongside the master keys in the filesystem-level keyring)
>   */
>  
> -#include <crypto/algapi.h>
>  #include <crypto/skcipher.h>
> +#include <crypto/utils.h>
>  #include <keys/user-type.h>
>  #include <linux/hashtable.h>
>  #include <linux/scatterlist.h>

Acked-by: Eric Biggers <ebiggers@google.com>

- Eric

Re: [PATCH 3/12] Bluetooth: Do not include crypto/algapi.h

[Luiz Augusto von Dentz]

Hi Herbert,

On Wed, Aug 23, 2023 at 3:32 AM Herbert Xu <herbert@gondor.apana.org.au> wrote:
>
> The header file crypto/algapi.h is for internal use only.  Use the
> header file crypto/utils.h instead.
>
> Signed-off-by: Herbert Xu <herbert@gondor.apana.org.au>
> ---
>
>  net/bluetooth/smp.c |    3 +--
>  1 file changed, 1 insertion(+), 2 deletions(-)
>
> diff --git a/net/bluetooth/smp.c b/net/bluetooth/smp.c
> index f1a9fc0012f0..5f2f97de295e 100644
> --- a/net/bluetooth/smp.c
> +++ b/net/bluetooth/smp.c
> @@ -22,11 +22,10 @@
>
>  #include <linux/debugfs.h>
>  #include <linux/scatterlist.h>
> -#include <linux/crypto.h>
>  #include <crypto/aes.h>
> -#include <crypto/algapi.h>
>  #include <crypto/hash.h>
>  #include <crypto/kpp.h>
> +#include <crypto/utils.h>
>
>  #include <net/bluetooth/bluetooth.h>
>  #include <net/bluetooth/hci_core.h>

Acked-by: Luiz Augusto von Dentz <luiz.von.dentz@intel.com>

-- 
Luiz Augusto von Dentz