[041/127] mm: add kvfree_sensitive() for freeing sensitive data objects

Commit Message

Andrew Morton June 4, 2020, 11:48 p.m. UTC

From: Waiman Long <[e-mail]>
Subject: mm: add kvfree_sensitive() for freeing sensitive data objects

For kvmalloc'ed data object that contains sensitive information like
cryptographic keys, we need to make sure that the buffer is always cleared
before freeing it.  Using memset() alone for buffer clearing may not
provide certainty as the compiler may compile it away.  To be sure, the
special memzero_explicit() has to be used.

This patch introduces a new kvfree_sensitive() for freeing those sensitive
data objects allocated by kvmalloc().  The relevant places where
kvfree_sensitive() can be used are modified to use it.

Link: http://lkml.kernel.org/r/[e-mail]
Fixes: 4f0882491a14 ("KEYS: Avoid false positive ENOMEM error on key read")
Signed-off-by: Waiman Long <[e-mail]>
Suggested-by: Linus Torvalds <[e-mail]>
Reviewed-by: Eric Biggers <[e-mail]>
Acked-by: David Howells <[e-mail]>
Cc: Jarkko Sakkinen <[e-mail]>
Cc: James Morris <[e-mail]>
Cc: "Serge E. Hallyn" <[e-mail]>
Cc: Joe Perches <[e-mail]>
Cc: Matthew Wilcox <[e-mail]>
Cc: David Rientjes <[e-mail]>
Cc: Uladzislau Rezki <[e-mail]>
Signed-off-by: Andrew Morton <[e-mail]>
---

 include/linux/mm.h       |    1 +
 mm/util.c                |   18 ++++++++++++++++++
 security/keys/internal.h |   11 -----------
 security/keys/keyctl.c   |   16 +++++-----------
 4 files changed, 24 insertions(+), 22 deletions(-)

Comments

Jarkko Sakkinen June 16, 2020, 8:59 p.m. UTC | #1

On Thu, Jun 04, 2020 at 04:48:21PM -0700, Andrew Morton wrote:
> From: Waiman Long <[e-mail]>
> Subject: mm: add kvfree_sensitive() for freeing sensitive data objects
> 
> For kvmalloc'ed data object that contains sensitive information like
> cryptographic keys, we need to make sure that the buffer is always cleared
> before freeing it.  Using memset() alone for buffer clearing may not
> provide certainty as the compiler may compile it away.  To be sure, the
> special memzero_explicit() has to be used.
> 
> This patch introduces a new kvfree_sensitive() for freeing those sensitive
> data objects allocated by kvmalloc().  The relevant places where
> kvfree_sensitive() can be used are modified to use it.
> 
> Link: http://lkml.kernel.org/r/[e-mail]
> Fixes: 4f0882491a14 ("KEYS: Avoid false positive ENOMEM error on key read")
> Signed-off-by: Waiman Long <[e-mail]>
> Suggested-by: Linus Torvalds <[e-mail]>
> Reviewed-by: Eric Biggers <[e-mail]>
> Acked-by: David Howells <[e-mail]>
> Cc: Jarkko Sakkinen <[e-mail]>
> Cc: James Morris <[e-mail]>
> Cc: "Serge E. Hallyn" <[e-mail]>
> Cc: Joe Perches <[e-mail]>
> Cc: Matthew Wilcox <[e-mail]>
> Cc: David Rientjes <[e-mail]>
> Cc: Uladzislau Rezki <[e-mail]>
> Signed-off-by: Andrew Morton <[e-mail]>

Acked-by: Jarkko Sakkinen <[e-mail]>

/Jarkko

Patch

--- a/include/linux/mm.h~mm-add-kvfree_sensitive-for-freeing-sensitive-data-objects
+++ a/include/linux/mm.h
@@ -776,6 +776,7 @@  static inline void *kvcalloc(size_t n, s
 }
 
 extern void kvfree(const void *addr);
+extern void kvfree_sensitive(const void *addr, size_t len);
 
 /*
  * Mapcount of compound page as a whole, does not include mapped sub-pages.
--- a/mm/util.c~mm-add-kvfree_sensitive-for-freeing-sensitive-data-objects
+++ a/mm/util.c
@@ -604,6 +604,24 @@  void kvfree(const void *addr)
 }
 EXPORT_SYMBOL(kvfree);
 
+/**
+ * kvfree_sensitive - Free a data object containing sensitive information.
+ * @addr: address of the data object to be freed.
+ * @len: length of the data object.
+ *
+ * Use the special memzero_explicit() function to clear the content of a
+ * kvmalloc'ed object containing sensitive data to make sure that the
+ * compiler won't optimize out the data clearing.
+ */
+void kvfree_sensitive(const void *addr, size_t len)
+{
+	if (likely(!ZERO_OR_NULL_PTR(addr))) {
+		memzero_explicit((void *)addr, len);
+		kvfree(addr);
+	}
+}
+EXPORT_SYMBOL(kvfree_sensitive);
+
 static inline void *__page_rmapping(struct page *page)
 {
 	unsigned long mapping;
--- a/security/keys/internal.h~mm-add-kvfree_sensitive-for-freeing-sensitive-data-objects
+++ a/security/keys/internal.h
@@ -350,15 +350,4 @@  static inline void key_check(const struc
 #define key_check(key) do {} while(0)
 
 #endif
-
-/*
- * Helper function to clear and free a kvmalloc'ed memory object.
- */
-static inline void __kvzfree(const void *addr, size_t len)
-{
-	if (addr) {
-		memset((void *)addr, 0, len);
-		kvfree(addr);
-	}
-}
 #endif /* _INTERNAL_H */
--- a/security/keys/keyctl.c~mm-add-kvfree_sensitive-for-freeing-sensitive-data-objects
+++ a/security/keys/keyctl.c
@@ -142,10 +142,7 @@  SYSCALL_DEFINE5(add_key, const char __us
 
 	key_ref_put(keyring_ref);
  error3:
-	if (payload) {
-		memzero_explicit(payload, plen);
-		kvfree(payload);
-	}
+	kvfree_sensitive(payload, plen);
  error2:
 	kfree(description);
  error:
@@ -360,7 +357,7 @@  long keyctl_update_key(key_serial_t id,
 
 	key_ref_put(key_ref);
 error2:
-	__kvzfree(payload, plen);
+	kvfree_sensitive(payload, plen);
 error:
 	return ret;
 }
@@ -914,7 +911,7 @@  can_read_key:
 		 */
 		if (ret > key_data_len) {
 			if (unlikely(key_data))
-				__kvzfree(key_data, key_data_len);
+				kvfree_sensitive(key_data, key_data_len);
 			key_data_len = ret;
 			continue;	/* Allocate buffer */
 		}
@@ -923,7 +920,7 @@  can_read_key:
 			ret = -EFAULT;
 		break;
 	}
-	__kvzfree(key_data, key_data_len);
+	kvfree_sensitive(key_data, key_data_len);
 
 key_put_out:
 	key_put(key);
@@ -1225,10 +1222,7 @@  long keyctl_instantiate_key_common(key_s
 		keyctl_change_reqkey_auth(NULL);
 
 error2:
-	if (payload) {
-		memzero_explicit(payload, plen);
-		kvfree(payload);
-	}
+	kvfree_sensitive(payload, plen);
 error:
 	return ret;
 }