tutorials: root_of_trust: split suspicious_service into a milestone and starter

pqcfox · alevy · commit 629fcfc70870 · 2025-06-25T12:09:28.000-07:00
diff --git a/examples/tutorials/root_of_trust/encryption_service_milestone_one/README.md b/examples/tutorials/root_of_trust/encryption_service_milestone_one/README.md
@@ -12,4 +12,5 @@ Specific abilities of this version:
 
 * Allows logging to screen over IPC
 * Does NOT allow prompting for plaintext over returning results in hex over UART
-* Does NOT allow for encryping user-provided plaintext using an encryption oracle driver
+* Does NOT allow for encrypting user-provided plaintext using an encryption
+  oracle driver
diff --git a/examples/tutorials/root_of_trust/encryption_service_milestone_one/main.c b/examples/tutorials/root_of_trust/encryption_service_milestone_one/main.c
@@ -1,3 +1,9 @@
+// Hardware Root of Trust (HWRoT) Demo Encryption Service Application
+//
+// When selected by the main screen HWRoT Demo application, listens for user-provided
+// plaintexts over UART and encrypts them, logging status over IPC back to the screen
+// application.
+
 #include "libtock/tock.h"
 #include <stdio.h>
 #include <stdlib.h>
diff --git a/examples/tutorials/root_of_trust/encryption_service_milestone_three/README.md b/examples/tutorials/root_of_trust/encryption_service_milestone_three/README.md
@@ -12,4 +12,5 @@ Specific abilities of this version:
 
 * Allows logging to screen over IPC
 * Allows prompting for plaintext over returning results in hex over UART
-* Allows for encryping user-provided plaintext using an encryption oracle driver
+* Allows for encrypting user-provided plaintext using an encryption oracle
+  driver
diff --git a/examples/tutorials/root_of_trust/encryption_service_milestone_three/main.c b/examples/tutorials/root_of_trust/encryption_service_milestone_three/main.c
@@ -1,3 +1,9 @@
+// Hardware Root of Trust (HWRoT) Demo Encryption Service Application
+//
+// When selected by the main screen HWRoT Demo application, listens for user-provided
+// plaintexts over UART and encrypts them, logging status over IPC back to the screen
+// application.
+
 #include "libtock/tock.h"
 #include <stdio.h>
 #include <stdlib.h>
diff --git a/examples/tutorials/root_of_trust/encryption_service_milestone_two/README.md b/examples/tutorials/root_of_trust/encryption_service_milestone_two/README.md
@@ -12,4 +12,5 @@ Specific abilities of this version:
 
 * Allows logging to screen over IPC
 * Allows prompting for plaintext over returning results in hex over UART
-* Does NOT allow for encryping user-provided plaintext using an encryption oracle driver
+* Does NOT allow for encrypting user-provided plaintext using an encryption
+  oracle driver
diff --git a/examples/tutorials/root_of_trust/encryption_service_milestone_two/main.c b/examples/tutorials/root_of_trust/encryption_service_milestone_two/main.c
@@ -1,3 +1,9 @@
+// Hardware Root of Trust (HWRoT) Demo Encryption Service Application
+//
+// When selected by the main screen HWRoT Demo application, listens for user-provided
+// plaintexts over UART and encrypts them, logging status over IPC back to the screen
+// application.
+
 #include "libtock/tock.h"
 #include <stdio.h>
 #include <stdlib.h>
diff --git a/examples/tutorials/root_of_trust/encryption_service_starter/README.md b/examples/tutorials/root_of_trust/encryption_service_starter/README.md
@@ -12,6 +12,8 @@ Specific abilities of this version:
 
 * Does NOT allow logging to screen over IPC
 * Does NOT allow for plaintext over returning results in hex over UART
-* Does NOT allow for encryping user-provided plaintext using an encryption oracle driver
+* Does NOT allow for encrypting user-provided plaintext using an encryption
+  oracle driver
 
-This application is essentially just a scaffold to build from while following the tutorial.
+This version of the application is essentially just a scaffold to build from
+while following the tutorial.
diff --git a/examples/tutorials/root_of_trust/suspicious_service_milestone_one/Makefile b/examples/tutorials/root_of_trust/suspicious_service_milestone_one/Makefile
diff --git a/examples/tutorials/root_of_trust/suspicious_service_milestone_one/README.md b/examples/tutorials/root_of_trust/suspicious_service_milestone_one/README.md
@@ -1,7 +1,7 @@
 Hardware Root of Trust (HWRoT) "Suspicious" Userspace Attack Application
 ------------------------------------------------------------------------
 
-This application implements a basic SRAM dump attack on the encryption servicde
+This application implements a basic SRAM dump attack on the encryption service
 application in the Hardware Root of Trust demo.
 
 This is part of a tutorial which improves the encryption application in multiple
diff --git a/examples/tutorials/root_of_trust/suspicious_service_milestone_one/main.c b/examples/tutorials/root_of_trust/suspicious_service_milestone_one/main.c
@@ -1,3 +1,8 @@
+// Hardware Root of Trust (HWRoT) Demo SRAM Dump Application
+//
+// When selected by the main screen HWRoT Demo application, attempts to dump its
+// own SRAM, followed by the SRAM of the encryption service application.
+
 #include "libtock/tock.h"
 #include <stdio.h>
 #include <stdlib.h>
@@ -82,8 +87,8 @@ static int log_to_screen(const char* message) {
   return 0;
 }
 
-static void dump_memory(uint32_t *start, uint32_t *end, const char *label) {
-  for (uint32_t *addr = start; addr < end; addr++) {
+static void dump_memory(uint32_t* start, uint32_t* end, const char* label) {
+  for (uint32_t* addr = start; addr < end; addr++) {
     printf("[%s] %p: %08lX\n", label, addr, *addr);
   }
 }
@@ -105,7 +110,7 @@ int main(void) {
   if (ret < 0) {
     printf("ERROR: cannot log to screen\n");
   }
-  dump_memory((uint32_t *)SELF_SRAM_START, (uint32_t *)SELF_SRAM_END, "SELF");
+  dump_memory((uint32_t*)SELF_SRAM_START, (uint32_t*)SELF_SRAM_END, "SELF");
   ret = log_to_screen("Dumping own SRAM complete!");
   if (ret < 0) {
     printf("ERROR: cannot log to screen\n");
@@ -116,11 +121,11 @@ int main(void) {
   if (ret < 0) {
     printf("ERROR: cannot log to screen\n");
   }
-  dump_memory((uint32_t *)ENCRYPTION_SRAM_START, (uint32_t *)ENCRYPTION_SRAM_END, "ENCRYPTION");
+  dump_memory((uint32_t*)ENCRYPTION_SRAM_START, (uint32_t*)ENCRYPTION_SRAM_END, "ENCRYPTION");
   ret = log_to_screen("Dumping encryption SRAM complete!");
   if (ret < 0) {
     printf("ERROR: cannot log to screen\n");
   }
-  
+
   return 0;
 }
diff --git a/examples/tutorials/root_of_trust/suspicious_service_starter/Makefile b/examples/tutorials/root_of_trust/suspicious_service_starter/Makefile
@@ -0,0 +1,13 @@
+# Makefile for user application
+
+# Specify this directory relative to the current application.
+TOCK_USERLAND_BASE_DIR = ../../../../
+
+PACKAGE_NAME = org.tockos.tutorials.attestation.suspicious
+
+# Which files to compile.
+C_SRCS := $(wildcard *.c)
+
+# Include userland master makefile. Contains rules and flags for actually
+# building the application.
+include $(TOCK_USERLAND_BASE_DIR)/AppMakefile.mk
diff --git a/examples/tutorials/root_of_trust/suspicious_service_starter/README.md b/examples/tutorials/root_of_trust/suspicious_service_starter/README.md
@@ -0,0 +1,17 @@
+Hardware Root of Trust (HWRoT) "Suspicious" Userspace Attack Application
+------------------------------------------------------------------------
+
+This application implements a basic SRAM dump attack on the encryption service
+application in the Hardware Root of Trust demo.
+
+This is part of a tutorial which improves the encryption application in multiple
+steps and mounts multiple attacks on it. A writeup for the tutorial is available
+at https://book.tockos.org/.
+
+Specific abilities of this version:
+
+* Does NOT allow dumping application's own SRAM
+* Does NOT allow attempting dumping of the encryption service application's SRAM 
+
+This version of the application is essentially just a scaffold to build from
+while following the tutorial.
diff --git a/examples/tutorials/root_of_trust/suspicious_service_starter/main.c b/examples/tutorials/root_of_trust/suspicious_service_starter/main.c
@@ -0,0 +1,8 @@
+// Hardware Root of Trust (HWRoT) Demo SRAM Dump Application
+//
+// When selected by the main screen HWRoT Demo application, attempts to dump its
+// own SRAM, followed by the SRAM of the encryption service application.
+
+int main(void) {
+  return 0;
+}

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,8 @@`
	`1`	`+// Hardware Root of Trust (HWRoT) Demo SRAM Dump Application`
	`2`	`+//`
	`3`	`+// When selected by the main screen HWRoT Demo application, attempts to dump its`
	`4`	`+// own SRAM, followed by the SRAM of the encryption service application.`
	`5`	`+`
`1`	`6`	`#include "libtock/tock.h"`
`2`	`7`	`#include <stdio.h>`
`3`	`8`	`#include <stdlib.h>`
`@@ -82,8 +87,8 @@ static int log_to_screen(const char* message) {`
`82`	`87`	`return 0;`
`83`	`88`	`}`
`84`	`89`
`85`		`-static void dump_memory(uint32_t start, uint32_t end, const char *label) {`
`86`		`- for (uint32_t *addr = start; addr < end; addr++) {`
	`90`	`+static void dump_memory(uint32_t* start, uint32_t* end, const char* label) {`
	`91`	`+ for (uint32_t* addr = start; addr < end; addr++) {`
`87`	`92`	`printf("[%s] %p: %08lX\n", label, addr, *addr);`
`88`	`93`	`}`
`89`	`94`	`}`
`@@ -105,7 +110,7 @@ int main(void) {`
`105`	`110`	`if (ret < 0) {`
`106`	`111`	`printf("ERROR: cannot log to screen\n");`
`107`	`112`	`}`
`108`		`- dump_memory((uint32_t )SELF_SRAM_START, (uint32_t )SELF_SRAM_END, "SELF");`
	`113`	`+ dump_memory((uint32_t)SELF_SRAM_START, (uint32_t)SELF_SRAM_END, "SELF");`
`109`	`114`	`ret = log_to_screen("Dumping own SRAM complete!");`
`110`	`115`	`if (ret < 0) {`
`111`	`116`	`printf("ERROR: cannot log to screen\n");`
`@@ -116,11 +121,11 @@ int main(void) {`
`116`	`121`	`if (ret < 0) {`
`117`	`122`	`printf("ERROR: cannot log to screen\n");`
`118`	`123`	`}`
`119`		`- dump_memory((uint32_t )ENCRYPTION_SRAM_START, (uint32_t )ENCRYPTION_SRAM_END, "ENCRYPTION");`
	`124`	`+ dump_memory((uint32_t)ENCRYPTION_SRAM_START, (uint32_t)ENCRYPTION_SRAM_END, "ENCRYPTION");`
`120`	`125`	`ret = log_to_screen("Dumping encryption SRAM complete!");`
`121`	`126`	`if (ret < 0) {`
`122`	`127`	`printf("ERROR: cannot log to screen\n");`
`123`	`128`	`}`
`124`		`-`
	`129`	`+`
`125`	`130`	`return 0;`
`126`	`131`	`}`