Skip to contentSkip to conversation

dm-crypt: Adjustments for crypt_set_keyring_key()

PATCH In review Markus Elfring 2 participants 4 messages Sep 18, 2024

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

cover dm-crypt: Adjustments for crypt_set_keyring_key()

From: Markus Elfring <[email protected]>
Date: Wed, 18 Sep 2024 15:48:05 +0200

A few update suggestions were taken into account
from static source code analysis.

Markus Elfring (2):
Use up_read() together with key_put() only once
Use common error handling code

 drivers/md/dm-crypt.c | 27 ++++++++++++---------------
 1 file changed, 12 insertions(+), 15 deletions(-)

--
2.46.0

#1 lore raw

PATCH 1/2 dm-crypt: Use up_read() together with key_put() only once in crypt_set_keyring_key()

From: Markus Elfring <[email protected]>
Date: Wed, 18 Sep 2024 15:05:29 +0200

The combination of the calls “up_read(&key->sem)” and “key_put(key)” was immediately used after a return code check for a set_key() call in this function implementation.
Thus use such a function call pair only once instead directly before the check.

This issue was transformed by using the Coccinelle software.

---
 drivers/md/dm-crypt.c | 7 ++-----
 1 file changed, 2 insertions(+), 5 deletions(-)
drivers/md/dm-crypt.c +2 -5
index d5533b43054e..dae2fe3cb182 100644
@@ -2621,16 +2621,13 @@ static int crypt_set_keyring_key(struct crypt_config *cc, const char *key_string
 	down_read(&key->sem);
 
 	ret = set_key(cc, key);
+	up_read(&key->sem);
+	key_put(key);
 	if (ret < 0) {
-		up_read(&key->sem);
-		key_put(key);
 		kfree_sensitive(new_key_string);
 		return ret;
 	}
 
-	up_read(&key->sem);
-	key_put(key);
-
 	/* clear the flag since following operations may invalidate previously valid key */
 	clear_bit(DM_CRYPT_KEY_VALID, &cc->flags);
 

--
2.46.0

#2 lore raw

PATCH 2/2 dm-crypt: Use common error handling code in crypt_set_keyring_key()

In reply to Markus Elfring

From: Markus Elfring <[email protected]>
Date: Wed, 18 Sep 2024 15:34:45 +0200

Add a jump target so that a bit of exception handling can be better reused at the end of this function implementation.

---
 drivers/md/dm-crypt.c | 24 ++++++++++++------------
 1 file changed, 12 insertions(+), 12 deletions(-)
drivers/md/dm-crypt.c +12 -12
index dae2fe3cb182..3d2247cfd42b 100644
@@ -2614,8 +2614,8 @@ static int crypt_set_keyring_key(struct crypt_config *cc, const char *key_string
 
 	key = request_key(type, key_desc + 1, NULL);
 	if (IS_ERR(key)) {
-		kfree_sensitive(new_key_string);
-		return PTR_ERR(key);
+		ret = PTR_ERR(key);
+		goto free_new_key_string;
 	}
 
 	down_read(&key->sem);
@@ -2623,23 +2623,23 @@ static int crypt_set_keyring_key(struct crypt_config *cc, const char *key_string
 	ret = set_key(cc, key);
 	up_read(&key->sem);
 	key_put(key);
-	if (ret < 0) {
-		kfree_sensitive(new_key_string);
-		return ret;
-	}
+	if (ret < 0)
+		goto free_new_key_string;
 
 	/* clear the flag since following operations may invalidate previously valid key */
 	clear_bit(DM_CRYPT_KEY_VALID, &cc->flags);
 
 	ret = crypt_setkey(cc);
+	if (ret)
+		goto free_new_key_string;
 
-	if (!ret) {
-		set_bit(DM_CRYPT_KEY_VALID, &cc->flags);
-		kfree_sensitive(cc->key_string);
-		cc->key_string = new_key_string;
-	} else
-		kfree_sensitive(new_key_string);
+	set_bit(DM_CRYPT_KEY_VALID, &cc->flags);
+	kfree_sensitive(cc->key_string);
+	cc->key_string = new_key_string;
+	return 0;
 
+free_new_key_string:
+	kfree_sensitive(new_key_string);
 	return ret;
 }
 

--
2.46.0

maintainer
#3 lore raw

Re: [PATCH 2/2] dm-crypt: Use common error handling code in crypt_set_keyring_key()

Both patches applied, thanks.

Mikulas

Quoted 63 lines · Markus Elfring

From: Markus Elfring <[email protected]>
Date: Wed, 18 Sep 2024 15:34:45 +0200

Add a jump target so that a bit of exception handling can be better reused at the end of this function implementation.

---
 drivers/md/dm-crypt.c | 24 ++++++++++++------------
 1 file changed, 12 insertions(+), 12 deletions(-)
drivers/md/dm-crypt.c +12 -13
index dae2fe3cb182..3d2247cfd42b 100644
@@ -2614,8 +2614,8 @@ static int crypt_set_keyring_key(struct crypt_config *cc, const char *key_string
 
 	key = request_key(type, key_desc + 1, NULL);
 	if (IS_ERR(key)) {
-		kfree_sensitive(new_key_string);
-		return PTR_ERR(key);
+		ret = PTR_ERR(key);
+		goto free_new_key_string;
 	}
 
 	down_read(&key->sem);
@@ -2623,23 +2623,23 @@ static int crypt_set_keyring_key(struct crypt_config *cc, const char *key_string
 	ret = set_key(cc, key);
 	up_read(&key->sem);
 	key_put(key);
-	if (ret < 0) {
-		kfree_sensitive(new_key_string);
-		return ret;
-	}
+	if (ret < 0)
+		goto free_new_key_string;
 
 	/* clear the flag since following operations may invalidate previously valid key */
 	clear_bit(DM_CRYPT_KEY_VALID, &cc->flags);
 
 	ret = crypt_setkey(cc);
+	if (ret)
+		goto free_new_key_string;
 
-	if (!ret) {
-		set_bit(DM_CRYPT_KEY_VALID, &cc->flags);
-		kfree_sensitive(cc->key_string);
-		cc->key_string = new_key_string;
-	} else
-		kfree_sensitive(new_key_string);
+	set_bit(DM_CRYPT_KEY_VALID, &cc->flags);
+	kfree_sensitive(cc->key_string);
+	cc->key_string = new_key_string;
+	return 0;
 
+free_new_key_string:
+	kfree_sensitive(new_key_string);
 	return ret;
 }
 
--

2.46.0