Skip to contentSkip to conversation

selftests/sgx: Early enclave loading error path fixes

PATCH Superseded Reinette Chatre 3 participants 18 messages Feb 1, 2022 – Feb 23, 2022

Subsystems (2)

v2 of 3 Superseded Latest is v3 →

lore
Share & tools
lore
#0 lore raw

v2 cover selftests/sgx: Early enclave loading error path fixes

Changes since V1:
- V1: https://lore.kernel.org/linux-sgx/[email protected]/
- All changes impact the commit messages only, no changes to code.
- Rewrite commit message of 1/4 (Dave).
- Detail in 2/4 commit log what callers will see with this change (Dave).
- Add Acked-by from Dave to 2/4 and 4/4.

Hi Everybody,

Please find included a few fixes that address problems encountered after venturing into the enclave loading error handling code of the SGX selftests.

Reinette

Reinette Chatre (4):
selftests/sgx: Fix NULL-pointer-dereference upon early test failure selftests/sgx: Do not attempt enclave build without valid enclave selftests/sgx: Ensure enclave data available during debug print selftests/sgx: Remove extra newlines in test output

 tools/testing/selftests/sgx/load.c | 9 +++++----
 tools/testing/selftests/sgx/main.c | 9 +++++----
 2 files changed, 10 insertions(+), 8 deletions(-)

base-commit: 2056e2989bf47ad7274ecc5e9dda2add53c112f9

Signature · 1 line
2.25.1
#1 lore raw

PATCH v2 1/4 selftests/sgx: Fix NULL-pointer-dereference upon early test failure

== Background ==

The SGX selftests track parts of the enclave binaries in an array:
encl->segment_tbl[]. That array is dynamically allocated early (but not first) in the test's lifetime. The array is referenced at the end of the test in encl_delete().

== Problem ==

encl->segment_tbl[] can be NULL if the test fails before its allocation. That leads to a NULL-pointer-dereference in encl_delete(). This is triggered during early failures of the selftest like if the enclave binary ("test_encl.elf") is deleted.

== Solution ==

Ensure encl->segment_tbl[] is valid before attempting to access its members. The offset with which it is accessed, encl->nr_segments, is initialized before encl->segment_tbl[] and thus considered valid to use after the encl->segment_tbl[] check succeeds.

Fixes 3200505d4de6 ("selftests/sgx: Create a heap for the test enclave")

---
Changes since V1:
- Rewrite commit message (Dave).

 tools/testing/selftests/sgx/load.c | 9 +++++----
 1 file changed, 5 insertions(+), 4 deletions(-)
tools/testing/selftests/sgx/load.c +5 -4
index 9d4322c946e2..006b464c8fc9 100644
@@ -21,7 +21,7 @@
 
 void encl_delete(struct encl *encl)
 {
-	struct encl_segment *heap_seg = &encl->segment_tbl[encl->nr_segments - 1];
+	struct encl_segment *heap_seg;
 
 	if (encl->encl_base)
 		munmap((void *)encl->encl_base, encl->encl_size);
@@ -32,10 +32,11 @@ void encl_delete(struct encl *encl)
 	if (encl->fd)
 		close(encl->fd);
 
-	munmap(heap_seg->src, heap_seg->size);
-
-	if (encl->segment_tbl)
+	if (encl->segment_tbl) {
+		heap_seg = &encl->segment_tbl[encl->nr_segments - 1];
+		munmap(heap_seg->src, heap_seg->size);
 		free(encl->segment_tbl);
+	}
 
 	memset(encl, 0, sizeof(*encl));
 }
Signature · 1 line
2.25.1
#8 lore raw

PATCH v2 2/4 selftests/sgx: Do not attempt enclave build without valid enclave

In reply to Reinette Chatre

It is not possible to build an enclave if it was not possible to load the binary from which it should be constructed. Do not attempt to make further progress but instead return with failure. A "return false" from setup_test_encl() is expected to trip an ASSERT_TRUE() and abort the rest of the test.

Fixes 1b35eb719549 ("selftests/sgx: Encpsulate the test enclave creation")

---
Changes since V1:
- Add Acked-by from Dave.
- Detail in commit log what callers will see with this change (Dave).

 tools/testing/selftests/sgx/main.c | 1 +
 1 file changed, 1 insertion(+)
tools/testing/selftests/sgx/main.c +1 -0
index 370c4995f7c4..a7cd2c3e6f7e 100644
@@ -147,6 +147,7 @@ static bool setup_test_encl(unsigned long heap_size, struct encl *encl,
 	if (!encl_load("test_encl.elf", encl, heap_size)) {
 		encl_delete(encl);
 		TH_LOG("Failed to load the test enclave.\n");
+		return false;
 	}
 
 	if (!encl_measure(encl))
Signature · 1 line
2.25.1
#11 lore raw

PATCH v2 3/4 selftests/sgx: Ensure enclave data available during debug print

In reply to Reinette Chatre

In support of debugging the SGX tests print details from the enclave and its memory mappings if any failure is encountered during enclave loading.

When a failure is encountered no data is printed because the printing of the data is preceded by cleanup of the data.

Move the data cleanup after the data print.

Fixes 147172148909 ("selftests/sgx: Dump segments and /proc/self/maps only on failure")

---
No changes since V1.

 tools/testing/selftests/sgx/main.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
tools/testing/selftests/sgx/main.c +2 -2
index a7cd2c3e6f7e..b0bd95a4730d 100644
@@ -186,8 +186,6 @@ static bool setup_test_encl(unsigned long heap_size, struct encl *encl,
 	return true;
 
 err:
-	encl_delete(encl);
-
 	for (i = 0; i < encl->nr_segments; i++) {
 		seg = &encl->segment_tbl[i];
 
@@ -208,6 +206,8 @@ static bool setup_test_encl(unsigned long heap_size, struct encl *encl,
 
 	TH_LOG("Failed to initialize the test enclave.\n");
 
+	encl_delete(encl);
+
 	return false;
 }
 
Signature · 1 line
2.25.1
#14 lore raw

PATCH v2 4/4 selftests/sgx: Remove extra newlines in test output

In reply to Reinette Chatre

The TH_LOG() macro is an optional debug logging function made available by kselftest itself. When TH_LOG_ENABLED is set it prints the provided message with additional information and formatting that already includes a newline.

Providing a newline to the message printed by TH_LOG() results in a double newline that produces irregular test output.

Remove the unnecessary newlines from the text provided to TH_LOG().

Fixes 1b35eb719549 ("selftests/sgx: Encpsulate the test enclave creation")

---
Changes since V1:
- Add Acked-by from Dave.

 tools/testing/selftests/sgx/main.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
tools/testing/selftests/sgx/main.c +2 -2
index b0bd95a4730d..dd74fa42302e 100644
@@ -146,7 +146,7 @@ static bool setup_test_encl(unsigned long heap_size, struct encl *encl,
 
 	if (!encl_load("test_encl.elf", encl, heap_size)) {
 		encl_delete(encl);
-		TH_LOG("Failed to load the test enclave.\n");
+		TH_LOG("Failed to load the test enclave.");
 		return false;
 	}
 
@@ -204,7 +204,7 @@ static bool setup_test_encl(unsigned long heap_size, struct encl *encl,
 		fclose(maps_file);
 	}
 
-	TH_LOG("Failed to initialize the test enclave.\n");
+	TH_LOG("Failed to initialize the test enclave.");
 
 	encl_delete(encl);
 
Signature · 1 line
2.25.1
maintainer Acked-by on v2 1/4
#2 lore raw

Re: [PATCH V2 1/4] selftests/sgx: Fix NULL-pointer-dereference upon early test failure

In reply to Reinette Chatre
Quoted 7 lines · Reinette Chatre

== Background ==

The SGX selftests track parts of the enclave binaries in an array:
encl->segment_tbl[]. That array is dynamically allocated early (but not first) in the test's lifetime. The array is referenced at the end of the test in encl_delete().

Quoted 9 lines

== Problem ==

encl->segment_tbl[] can be NULL if the test fails before its allocation. That leads to a NULL-pointer-dereference in encl_delete(). This is triggered during early failures of the selftest like if the enclave binary ("test_encl.elf") is deleted.

== Solution ==

"==" usage looks a bit odd in the change log.

Quoted 33 lines

Ensure encl->segment_tbl[] is valid before attempting to access its members. The offset with which it is accessed, encl->nr_segments, is initialized before encl->segment_tbl[] and thus considered valid to use after the encl->segment_tbl[] check succeeds.

Fixes 3200505d4de6 ("selftests/sgx: Create a heap for the test enclave")

---
Changes since V1:
- Rewrite commit message (Dave).

  tools/testing/selftests/sgx/load.c | 9 +++++----
  1 file changed, 5 insertions(+), 4 deletions(-)
tools/testing/selftests/sgx/load.c +1 -2
index 9d4322c946e2..006b464c8fc9 100644
@@ -21,7 +21,7 @@
 
  void encl_delete(struct encl *encl)
  {
-	struct encl_segment *heap_seg = &encl->segment_tbl[encl->nr_segments - 1];
+	struct encl_segment *heap_seg;
 
  	if (encl->encl_base)
  		munmap((void *)encl->encl_base, encl->encl_size);
@@ -32,10 +32,11 @@ void encl_delete(struct encl *encl)
  	if (encl->fd)
  		close(encl->fd);
 
-	munmap(heap_seg->src, heap_seg->size);

tools/testing/selftests/sgx/load.c void encl_delete(struct encl *encl) · line 42

Quoted 10 lines
tools/testing/selftests/sgx/load.c +4 -2
-
-	if (encl->segment_tbl)
+	if (encl->segment_tbl) {
+		heap_seg = &encl->segment_tbl[encl->nr_segments - 1];
+		munmap(heap_seg->src, heap_seg->size);
  		free(encl->segment_tbl);
+	}
 
  	memset(encl, 0, sizeof(*encl));
  }

The rest looks good to me. I can take this through kselftest tree, if not,

thanks,
-- Shuah

maintainer Acked-by on v2 2/4
#9 lore raw

Re: [PATCH V2 2/4] selftests/sgx: Do not attempt enclave build without valid enclave

In reply to Reinette Chatre
Quoted 23 lines · Reinette Chatre

It is not possible to build an enclave if it was not possible to load the binary from which it should be constructed. Do not attempt to make further progress but instead return with failure. A "return false" from setup_test_encl() is expected to trip an ASSERT_TRUE() and abort the rest of the test.

Fixes 1b35eb719549 ("selftests/sgx: Encpsulate the test enclave creation")

---
Changes since V1:
- Add Acked-by from Dave.
- Detail in commit log what callers will see with this change (Dave).

  tools/testing/selftests/sgx/main.c | 1 +
  1 file changed, 1 insertion(+)
tools/testing/selftests/sgx/main.c +0 -0
index 370c4995f7c4..a7cd2c3e6f7e 100644

tools/testing/selftests/sgx/main.c static bool setup_test_encl(unsigned long heap_size, struct encl *encl, · line 153

Quoted 7 lines
tools/testing/selftests/sgx/main.c +1 -0
@@ -147,6 +147,7 @@ static bool setup_test_encl(unsigned long heap_size, struct encl *encl,
  	if (!encl_load("test_encl.elf", encl, heap_size)) {
  		encl_delete(encl);
  		TH_LOG("Failed to load the test enclave.\n");
+		return false;
  	}
 
  	if (!encl_measure(encl))

thanks,
-- Shuah

maintainer Acked-by on v2 3/4
#12 lore raw

Re: [PATCH V2 3/4] selftests/sgx: Ensure enclave data available during debug print

In reply to Reinette Chatre
Quoted 4 lines · Reinette Chatre

In support of debugging the SGX tests print details from the enclave and its memory mappings if any failure is encountered during enclave loading.

Quoted 8 lines

When a failure is encountered no data is printed because the printing of the data is preceded by cleanup of the data.

Move the data cleanup after the data print.

Fixes 147172148909 ("selftests/sgx: Dump segments and /proc/self/maps only on failure")

---

thanks,
-- Shuah

maintainer Acked-by on v2 4/4
#15 lore raw

Re: [PATCH V2 4/4] selftests/sgx: Remove extra newlines in test output

In reply to Reinette Chatre
Quoted 36 lines · Reinette Chatre

The TH_LOG() macro is an optional debug logging function made available by kselftest itself. When TH_LOG_ENABLED is set it prints the provided message with additional information and formatting that already includes a newline.

Providing a newline to the message printed by TH_LOG() results in a double newline that produces irregular test output.

Remove the unnecessary newlines from the text provided to TH_LOG().

Fixes 1b35eb719549 ("selftests/sgx: Encpsulate the test enclave creation")

---
Changes since V1:
- Add Acked-by from Dave.

  tools/testing/selftests/sgx/main.c | 4 ++--
  1 file changed, 2 insertions(+), 2 deletions(-)
tools/testing/selftests/sgx/main.c +1 -1
index b0bd95a4730d..dd74fa42302e 100644
@@ -146,7 +146,7 @@ static bool setup_test_encl(unsigned long heap_size, struct encl *encl,
 
  	if (!encl_load("test_encl.elf", encl, heap_size)) {
  		encl_delete(encl);
-		TH_LOG("Failed to load the test enclave.\n");
+		TH_LOG("Failed to load the test enclave.");
  		return false;
  	}
 

tools/testing/selftests/sgx/main.c static bool setup_test_encl(unsigned long heap_size, struct encl *encl, · line 210

Quoted 8 lines
tools/testing/selftests/sgx/main.c +1 -1
@@ -204,7 +204,7 @@ static bool setup_test_encl(unsigned long heap_size, struct encl *encl,
  		fclose(maps_file);
  	}
 
-	TH_LOG("Failed to initialize the test enclave.\n");
+	TH_LOG("Failed to initialize the test enclave.");
 
  	encl_delete(encl);
 

thanks,
-- Shuah

maintainer
#17 lore raw
In reply to Reinette Chatre
Quoted 21 lines · Reinette Chatre

Changes since V1:
- V1: https://lore.kernel.org/linux-sgx/[email protected]/
- All changes impact the commit messages only, no changes to code.
- Rewrite commit message of 1/4 (Dave).
- Detail in 2/4 commit log what callers will see with this change (Dave).
- Add Acked-by from Dave to 2/4 and 4/4.

Hi Everybody,

Please find included a few fixes that address problems encountered after venturing into the enclave loading error handling code of the SGX selftests.

Reinette

Reinette Chatre (4):
selftests/sgx: Fix NULL-pointer-dereference upon early test failure selftests/sgx: Do not attempt enclave build without valid enclave selftests/sgx: Ensure enclave data available during debug print selftests/sgx: Remove extra newlines in test output

Quoted 7 lines
  tools/testing/selftests/sgx/load.c | 9 +++++----
  tools/testing/selftests/sgx/main.c | 9 +++++----
  2 files changed, 10 insertions(+), 8 deletions(-)

base-commit: 2056e2989bf47ad7274ecc5e9dda2add53c112f9

I can take these through kselftest tree if there are no dependencies on another tree.

thanks,
-- Shuah

#3 lore raw

Re: [PATCH V2 1/4] selftests/sgx: Fix NULL-pointer-dereference upon early test failure

In reply to Shuah Khan

Hi Shuah and Dave,

Quoted 15 lines · Shuah Khan
Quoted 14 lines · Reinette Chatre

== Background ==

The SGX selftests track parts of the enclave binaries in an array:
encl->segment_tbl[]. That array is dynamically allocated early (but not first) in the test's lifetime. The array is referenced at the end of the test in encl_delete().

== Problem ==

encl->segment_tbl[] can be NULL if the test fails before its allocation. That leads to a NULL-pointer-dereference in encl_delete(). This is triggered during early failures of the selftest like if the enclave binary ("test_encl.elf") is deleted.

Quoted 4 lines
Quoted 2 lines

== Solution ==

"==" usage looks a bit odd in the change log.

This is a new trend in the x86/ area and I was asked to modify the commit message to follow suit in:
https://lore.kernel.org/linux-sgx/[email protected]/

Quoted 42 lines
Quoted 29 lines

Ensure encl->segment_tbl[] is valid before attempting to access its members. The offset with which it is accessed, encl->nr_segments, is initialized before encl->segment_tbl[] and thus considered valid to use after the encl->segment_tbl[] check succeeds.

Fixes 3200505d4de6 ("selftests/sgx: Create a heap for the test enclave")

---
Changes since V1:
- Rewrite commit message (Dave).

  tools/testing/selftests/sgx/load.c | 9 +++++----

  1 file changed, 5 insertions(+), 4 deletions(-)
tools/testing/selftests/sgx/load.c +1 -1
index 9d4322c946e2..006b464c8fc9 100644
@@ -21,7 +21,7 @@
     void encl_delete(struct encl *encl)
   {
-    struct encl_segment *heap_seg = &encl->segment_tbl[encl->nr_segments - 1];
+    struct encl_segment *heap_seg;
         if (encl->encl_base)
           munmap((void *)encl->encl_base, encl->encl_size);
@@ -32,10 +32,11 @@ void encl_delete(struct encl *encl)
       if (encl->fd)
           close(encl->fd);
   -    munmap(heap_seg->src, heap_seg->size);

tools/testing/selftests/sgx/load.c void encl_delete(struct encl *encl) · line 42

Quoted 10 lines
tools/testing/selftests/sgx/load.c +4 -2
-
-    if (encl->segment_tbl)
+    if (encl->segment_tbl) {
+        heap_seg = &encl->segment_tbl[encl->nr_segments - 1];
+        munmap(heap_seg->src, heap_seg->size);
           free(encl->segment_tbl);
+    }
         memset(encl, 0, sizeof(*encl));
   }
 

The rest looks good to me. I can take this through kselftest tree, if not,

Quoted 2 lines

Thank you very much for reviewing the changes.

None of the patches in this series have external dependencies (all patches in the "Fixes:" can be found in v5.17-rc1) but my understanding is that Dave (for now) prefers to take them via the tip.git tree. This is because there are more SGX features and tests for those features [1] in flight to the SGX area and at least for now it would make things easier if the changes to the SGX selftests are contained in the same tree.

Dave: please do correct me if I am wrong.

Reinette

[1] https://lore.kernel.org/linux-sgx/[email protected]/

maintainer
#4 lore raw

Re: [PATCH V2 1/4] selftests/sgx: Fix NULL-pointer-dereference upon early test failure

Quoted 18 lines · Reinette Chatre

Hi Shuah and Dave,

Quoted 15 lines · Shuah Khan
Quoted 14 lines · Reinette Chatre

== Background ==

The SGX selftests track parts of the enclave binaries in an array:
encl->segment_tbl[]. That array is dynamically allocated early (but not first) in the test's lifetime. The array is referenced at the end of the test in encl_delete().

== Problem ==

encl->segment_tbl[] can be NULL if the test fails before its allocation. That leads to a NULL-pointer-dereference in encl_delete(). This is triggered during early failures of the selftest like if the enclave binary ("test_encl.elf") is deleted.

Quoted 10 lines
Quoted 4 lines
Quoted 2 lines

== Solution ==

"==" usage looks a bit odd in the change log.

This is a new trend in the x86/ area and I was asked to modify the commit message to follow suit in:
https://lore.kernel.org/linux-sgx/[email protected]/

Good to know. Thanks for the link.

Quoted 8 lines
Quoted 5 lines

The rest looks good to me. I can take this through kselftest tree, if not,

Thank you very much for reviewing the changes.

Quoted 9 lines

None of the patches in this series have external dependencies (all patches in the "Fixes:" can be found in v5.17-rc1) but my understanding is that Dave (for now) prefers to take them via the tip.git tree. This is because there are more SGX features and tests for those features [1] in flight to the SGX area and at least for now it would make things easier if the changes to the SGX selftests are contained in the same tree.

Dave: please do correct me if I am wrong.

Sounds good to me.

thanks,
-- Shuah

maintainer Reviewed-by on v2 2/4
#10 lore raw

Re: [PATCH V2 2/4] selftests/sgx: Do not attempt enclave build without valid enclave

In reply to Reinette Chatre
Quoted 32 lines · Reinette Chatre

It is not possible to build an enclave if it was not possible to load the binary from which it should be constructed. Do not attempt to make further progress but instead return with failure. A "return false" from setup_test_encl() is expected to trip an ASSERT_TRUE() and abort the rest of the test.

Fixes 1b35eb719549 ("selftests/sgx: Encpsulate the test enclave creation")

---
Changes since V1:
- Add Acked-by from Dave.
- Detail in commit log what callers will see with this change (Dave).

 tools/testing/selftests/sgx/main.c | 1 +
 1 file changed, 1 insertion(+)
tools/testing/selftests/sgx/main.c +1 -0
index 370c4995f7c4..a7cd2c3e6f7e 100644
@@ -147,6 +147,7 @@ static bool setup_test_encl(unsigned long heap_size, struct encl *encl,
 	if (!encl_load("test_encl.elf", encl, heap_size)) {
 		encl_delete(encl);
 		TH_LOG("Failed to load the test enclave.\n");
+		return false;
 	}
 
 	if (!encl_measure(encl))
Signature · 1 line
2.25.1

BR, Jarkko

maintainer Reviewed-by on v2 3/4
#13 lore raw

Re: [PATCH V2 3/4] selftests/sgx: Ensure enclave data available during debug print

In reply to Reinette Chatre
Quoted 42 lines · Reinette Chatre

In support of debugging the SGX tests print details from the enclave and its memory mappings if any failure is encountered during enclave loading.

When a failure is encountered no data is printed because the printing of the data is preceded by cleanup of the data.

Move the data cleanup after the data print.

Fixes 147172148909 ("selftests/sgx: Dump segments and /proc/self/maps only on failure")

---
No changes since V1.

 tools/testing/selftests/sgx/main.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
tools/testing/selftests/sgx/main.c +2 -2
index a7cd2c3e6f7e..b0bd95a4730d 100644
@@ -186,8 +186,6 @@ static bool setup_test_encl(unsigned long heap_size, struct encl *encl,
 	return true;
 
 err:
-	encl_delete(encl);
-
 	for (i = 0; i < encl->nr_segments; i++) {
 		seg = &encl->segment_tbl[i];
 
@@ -208,6 +206,8 @@ static bool setup_test_encl(unsigned long heap_size, struct encl *encl,
 
 	TH_LOG("Failed to initialize the test enclave.\n");
 
+	encl_delete(encl);
+
 	return false;
 }
 
Signature · 1 line
2.25.1

LGTM

BR, Jarkko

maintainer Reviewed-by on v2 4/4
#16 lore raw

Re: [PATCH V2 4/4] selftests/sgx: Remove extra newlines in test output

In reply to Reinette Chatre
Quoted 46 lines · Reinette Chatre

The TH_LOG() macro is an optional debug logging function made available by kselftest itself. When TH_LOG_ENABLED is set it prints the provided message with additional information and formatting that already includes a newline.

Providing a newline to the message printed by TH_LOG() results in a double newline that produces irregular test output.

Remove the unnecessary newlines from the text provided to TH_LOG().

Fixes 1b35eb719549 ("selftests/sgx: Encpsulate the test enclave creation")

---
Changes since V1:
- Add Acked-by from Dave.

 tools/testing/selftests/sgx/main.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
tools/testing/selftests/sgx/main.c +2 -2
index b0bd95a4730d..dd74fa42302e 100644
@@ -146,7 +146,7 @@ static bool setup_test_encl(unsigned long heap_size, struct encl *encl,
 
 	if (!encl_load("test_encl.elf", encl, heap_size)) {
 		encl_delete(encl);
-		TH_LOG("Failed to load the test enclave.\n");
+		TH_LOG("Failed to load the test enclave.");
 		return false;
 	}
 
@@ -204,7 +204,7 @@ static bool setup_test_encl(unsigned long heap_size, struct encl *encl,
 		fclose(maps_file);
 	}
 
-	TH_LOG("Failed to initialize the test enclave.\n");
+	TH_LOG("Failed to initialize the test enclave.");
 
 	encl_delete(encl);
 
Signature · 1 line
2.25.1

BR, Jarkko

maintainer Reviewed-by on v2 1/4
#5 lore raw

Re: [PATCH V2 1/4] selftests/sgx: Fix NULL-pointer-dereference upon early test failure

In reply to Reinette Chatre
Quoted 61 lines · Reinette Chatre

== Background ==

The SGX selftests track parts of the enclave binaries in an array:
encl->segment_tbl[]. That array is dynamically allocated early (but not first) in the test's lifetime. The array is referenced at the end of the test in encl_delete().

== Problem ==

encl->segment_tbl[] can be NULL if the test fails before its allocation. That leads to a NULL-pointer-dereference in encl_delete(). This is triggered during early failures of the selftest like if the enclave binary ("test_encl.elf") is deleted.

== Solution ==

Ensure encl->segment_tbl[] is valid before attempting to access its members. The offset with which it is accessed, encl->nr_segments, is initialized before encl->segment_tbl[] and thus considered valid to use after the encl->segment_tbl[] check succeeds.

Fixes 3200505d4de6 ("selftests/sgx: Create a heap for the test enclave")

---
Changes since V1:
- Rewrite commit message (Dave).

 tools/testing/selftests/sgx/load.c | 9 +++++----
 1 file changed, 5 insertions(+), 4 deletions(-)
tools/testing/selftests/sgx/load.c +5 -4
index 9d4322c946e2..006b464c8fc9 100644
@@ -21,7 +21,7 @@
 
 void encl_delete(struct encl *encl)
 {
-	struct encl_segment *heap_seg = &encl->segment_tbl[encl->nr_segments - 1];
+	struct encl_segment *heap_seg;
 
 	if (encl->encl_base)
 		munmap((void *)encl->encl_base, encl->encl_size);
@@ -32,10 +32,11 @@ void encl_delete(struct encl *encl)
 	if (encl->fd)
 		close(encl->fd);
 
-	munmap(heap_seg->src, heap_seg->size);
-
-	if (encl->segment_tbl)
+	if (encl->segment_tbl) {
+		heap_seg = &encl->segment_tbl[encl->nr_segments - 1];
+		munmap(heap_seg->src, heap_seg->size);
 		free(encl->segment_tbl);
+	}
 
 	memset(encl, 0, sizeof(*encl));
 }
Signature · 1 line
2.25.1

BR, Jarkko

#6 lore raw

Re: [PATCH V2 1/4] selftests/sgx: Fix NULL-pointer-dereference upon early test failure

Hi Jarkko,

Quoted 57 lines · Jarkko Sakkinen
Quoted 56 lines · Reinette Chatre

== Background ==

The SGX selftests track parts of the enclave binaries in an array:
encl->segment_tbl[]. That array is dynamically allocated early (but not first) in the test's lifetime. The array is referenced at the end of the test in encl_delete().

== Problem ==

encl->segment_tbl[] can be NULL if the test fails before its allocation. That leads to a NULL-pointer-dereference in encl_delete(). This is triggered during early failures of the selftest like if the enclave binary ("test_encl.elf") is deleted.

== Solution ==

Ensure encl->segment_tbl[] is valid before attempting to access its members. The offset with which it is accessed, encl->nr_segments, is initialized before encl->segment_tbl[] and thus considered valid to use after the encl->segment_tbl[] check succeeds.

Fixes 3200505d4de6 ("selftests/sgx: Create a heap for the test enclave")

---
Changes since V1:
- Rewrite commit message (Dave).

 tools/testing/selftests/sgx/load.c | 9 +++++----
 1 file changed, 5 insertions(+), 4 deletions(-)
tools/testing/selftests/sgx/load.c +5 -4
index 9d4322c946e2..006b464c8fc9 100644
@@ -21,7 +21,7 @@
 
 void encl_delete(struct encl *encl)
 {
-	struct encl_segment *heap_seg = &encl->segment_tbl[encl->nr_segments - 1];
+	struct encl_segment *heap_seg;
 
 	if (encl->encl_base)
 		munmap((void *)encl->encl_base, encl->encl_size);
@@ -32,10 +32,11 @@ void encl_delete(struct encl *encl)
 	if (encl->fd)
 		close(encl->fd);
 
-	munmap(heap_seg->src, heap_seg->size);
-
-	if (encl->segment_tbl)
+	if (encl->segment_tbl) {
+		heap_seg = &encl->segment_tbl[encl->nr_segments - 1];
+		munmap(heap_seg->src, heap_seg->size);
 		free(encl->segment_tbl);
+	}
 
Quoted 9 lines
Quoted 5 lines
tools/testing/selftests/sgx/load.c +0 -0
 	memset(encl, 0, sizeof(*encl));
 }
Signature · 1 line
2.25.1

Thank you very much for taking a look at these patches.

V3[1] was submitted (8 February) and merged (11 February) onto x86/sgx before I received your reviewed-by tags for V1 (15 February) or V2 (20 February). The merged version thus does not contain your tags.

Reinette

[1] https://lore.kernel.org/linux-sgx/[email protected]/

maintainer
#7 lore raw

Re: [PATCH V2 1/4] selftests/sgx: Fix NULL-pointer-dereference upon early test failure

Quoted 72 lines · Reinette Chatre

Hi Jarkko,

Quoted 57 lines · Jarkko Sakkinen
Quoted 56 lines · Reinette Chatre

== Background ==

The SGX selftests track parts of the enclave binaries in an array:
encl->segment_tbl[]. That array is dynamically allocated early (but not first) in the test's lifetime. The array is referenced at the end of the test in encl_delete().

== Problem ==

encl->segment_tbl[] can be NULL if the test fails before its allocation. That leads to a NULL-pointer-dereference in encl_delete(). This is triggered during early failures of the selftest like if the enclave binary ("test_encl.elf") is deleted.

== Solution ==

Ensure encl->segment_tbl[] is valid before attempting to access its members. The offset with which it is accessed, encl->nr_segments, is initialized before encl->segment_tbl[] and thus considered valid to use after the encl->segment_tbl[] check succeeds.

Fixes 3200505d4de6 ("selftests/sgx: Create a heap for the test enclave")

---
Changes since V1:
- Rewrite commit message (Dave).

 tools/testing/selftests/sgx/load.c | 9 +++++----
 1 file changed, 5 insertions(+), 4 deletions(-)
tools/testing/selftests/sgx/load.c +5 -4
index 9d4322c946e2..006b464c8fc9 100644
@@ -21,7 +21,7 @@
 
 void encl_delete(struct encl *encl)
 {
-	struct encl_segment *heap_seg = &encl->segment_tbl[encl->nr_segments - 1];
+	struct encl_segment *heap_seg;
 
 	if (encl->encl_base)
 		munmap((void *)encl->encl_base, encl->encl_size);
@@ -32,10 +32,11 @@ void encl_delete(struct encl *encl)
 	if (encl->fd)
 		close(encl->fd);
 
-	munmap(heap_seg->src, heap_seg->size);
-
-	if (encl->segment_tbl)
+	if (encl->segment_tbl) {
+		heap_seg = &encl->segment_tbl[encl->nr_segments - 1];
+		munmap(heap_seg->src, heap_seg->size);
 		free(encl->segment_tbl);
+	}
 
Quoted 9 lines
Quoted 5 lines
tools/testing/selftests/sgx/load.c +0 -0
 	memset(encl, 0, sizeof(*encl));
 }
Signature · 1 line
2.25.1

Thank you very much for taking a look at these patches.

Quoted 7 lines

V3[1] was submitted (8 February) and merged (11 February) onto x86/sgx before I received your reviewed-by tags for V1 (15 February) or V2 (20 February). The merged version thus does not contain your tags.

Reinette

[1] https://lore.kernel.org/linux-sgx/[email protected]/

Not a big deal, but thanks for confirming :-)

BR, Jarkko