Add benchmarks and memory tracking feature to Signature Examples by miyazakh · Pull Request #467 · wolfSSL/wolfssl-examples

miyazakh · 2024-10-27T02:34:25Z

Based on Japan Intern Morimoto san's work
Fix compile and some clean up

miyazakh · 2024-10-30T04:45:28Z

Hi @cconlon
I remove unnecessary files. There are still around 4000 lines to be added. But, half of that number comes from folder refactoring.
embedded/tls <-- Be moved from embedded/*. Around 2600 lines(C and Header)
embedded/signature <-- Be added newly. Around 2100 lines(C and Header)

cconlon

See minor comments. @miyazakh, did you also verify all examples run as expected against current master wolfssl?

cconlon · 2025-08-18T16:33:54Z

embedded/signature/README.md

@@ -0,0 +1,92 @@
+# Signature Examples for Embedded Systems
+
+This directory includes the following examples under the sub-directories.Each has a Makefile and source files to build and execute the example and a README to show how to build and Example output.


I suggest we adjust this to read:

This directory includes the following examples. Each subdirectory has a Makefile, source files, and a README to show how to build the example, along with expected example output.

Sure.Thanks

cconlon · 2025-08-18T16:37:50Z

embedded/signature/README.md

+||ecc_vfy_only_nonblock|verify signature with non-blocking|
+
+
+You can specify a target function of Simple example, Benchemark or Memory track program.It also has options for optimized code for MCU architectures such as Intel x86, ARM64 or a generic code by default, as well as Math library of Single Precision or TFM.


I suggest we adjust this to read:

When building each example, you can specify arguments to control the build. Specify a target function to run either a simple example, benchmark, or memory tracking example. Specify an "arch" option to build optimized code for MCU architectures such as Intel x86, ARM64 or a generic code by default. And specify a "math" option to choose an underlying wolfCrypt math library to use, between Single Precision or TFM.

cconlon · 2025-08-18T16:38:35Z

embedded/signature/README.md

+|math|Description|
+|---|---|
+|Default|Generic architecture by pure C language source code|
+|sp| SP for generic or specified  archtecture|


Spelling - "archtecture" should be "architecture"

cconlon · 2025-08-18T16:41:34Z

embedded/signature/README.md

+|x64|SP for x86 64bit|
+
+
+The Makefile is self-contained without libwolfssl. Put your wolfSSL source filesin parallel with wolfssl-examples directory. It is defined by WOLFROOT in Makefile.It compiles only needed files for the target. OBJ and OBJ_xxx macro in Makefiledefine object files for the common and specific target.


This paragraph needs some spacing adjustments and rework. I suggest we change it to read:

Each Makefile is self-contained to statically link wolfCrypt source files (without using a shared libwolfssl.so). Put your wolfSSL source files in parallel with the wolfssl-examples directory. The location of the primary wolfSSL source directory is defined by WOLFROOT in each Makefile. Each build compiles only the needed files for the target. OBJ and OBJ_xxx macros in each Makefile define object files for the common and specific target.

Thanks. Fixed.

cconlon · 2025-08-18T16:42:35Z

embedded/signature/README.md

+
+The Makefile is self-contained without libwolfssl. Put your wolfSSL source filesin parallel with wolfssl-examples directory. It is defined by WOLFROOT in Makefile.It compiles only needed files for the target. OBJ and OBJ_xxx macro in Makefiledefine object files for the common and specific target.
+
+Example programs are hard coded for a hash algorithm or signature scheme.Sha256 is for the hash by default. PKCS #1 v1.5 or ECDSA for the signature scheme.You can refer to the following API tables for modifying the examples for other algorithms or schemes.


Some spacing adjustments needed here. I suggest changing this to read:

Example programs are hard coded to use a specific hash algorithm or signature scheme. Sha256 is used for the hash by default. PKCS#1 v1.5 or ECDSA is used for the signature scheme. You can refer to the following API tables for modifying the examples for other algorithms or schemes.

cconlon · 2025-08-18T16:53:00Z

embedded/signature/rsa_vfy_only/verify.c

+ */
+
+#include <stdio.h>
+#include<wolfssl/wolfcrypt/settings.h>


Need a space after "#include" for settings.h

cconlon · 2025-08-18T16:53:15Z

embedded/signature/rsa_vfy_only/verify.c

+#include<wolfssl/wolfcrypt/settings.h>
+#include <wolfssl/wolfcrypt/rsa.h>
+#include <wolfssl/wolfcrypt/sha256.h>
+#include<wolfssl/ssl.h>


Please add a space after #include for ssl.h and test.h.

cconlon · 2025-08-18T16:53:46Z

embedded/signature/rsa_vfy_only/verify.c

+        if ((int)decSigLen < 0)
+            ret = (int)decSigLen;
+    }
+


Remove extra blank lines here.

Removed the line

cconlon · 2025-08-18T16:54:19Z

embedded/signature/rsa_vfy_only_nonblock/verify_nonblock.c

+ */
+
+#include <stdio.h>
+#include<wolfssl/wolfcrypt/settings.h>


Add space after #include for settings.h, ssl.h, test.h

cconlon · 2025-08-18T16:54:46Z

embedded/signature/rsa_vfy_only_nonblock/verify_nonblock.c

+    printf("Verified\n");
+
+    printf("Non-blocking:\n");
+    printf("  Total time : %.2f micro sec,   Bloking count: %d  \n",1000*1000*total_blk_time, blk_count);


Check this line against our 80 character limit.

Add becnmark and memory tranking to the following program: signature/rsa_vfy_only/verify signature/rsa_buffer/verify signature/ecc-sign-verify/ecc_sign_verify

-modified Makefile to execute clean target before building. -modified Makefile to add CFLAGS for sp_x86_64. -fixed BENCH_TIME_SEC possible to be defined by compiler flags. -add -lpthread to be given to compiler.

* Add non-blocking mode for ECC Signature Example * Add non-blocking mode for RSA with TFM * Add ecc_vfy_only and ecc_vfy_only_nonblock - Add ecc_vfy_only to separate the function Verifying only from the ecc_sign_verify that signing and verifying the signatures. - Rename rsa_buffer to rsa_sign_verify - Add rsa_vfy_only_nonblock * Revise the README --------- Co-authored-by: Shingo Morimoto <shingo@wolfssl.com>

add Makefile to make all remove unnecessary files remove trailing spaces

add file header fix wc_RsaSSL_Verify

miyazakh · 2025-08-19T21:35:43Z

Hi @cconlon

did you also verify all examples run as expected against current master wolfssl?

Yes, I did. I ran all examples again under the latest master wolfssl. It needed tweaking user_settings.h for wc_RsaSSL_Verify()

miyazakh self-assigned this Oct 27, 2024

miyazakh requested a review from cconlon October 27, 2024 02:34

miyazakh mentioned this pull request Oct 27, 2024

Add benchmarks and memory tracking feature to Signature Examples. #352

Closed

miyazakh assigned cconlon Oct 27, 2024

miyazakh force-pushed the sig_verify_morimoto branch from 661dd3a to b6328e5 Compare October 30, 2024 04:36

cconlon requested changes Aug 18, 2025

View reviewed changes

cconlon removed their assignment Aug 18, 2025

Shingo Morimoto and others added 8 commits August 20, 2025 04:53

Add benchmarks and memory tracking feature to Signature Examples.

e4f5ccb

Add becnmark and memory tranking to the following program: signature/rsa_vfy_only/verify signature/rsa_buffer/verify signature/ecc-sign-verify/ecc_sign_verify

Moved files in the embedded directory to the embedded/tls directory

da617f2

fix SP_C64/C32 option (wolfSSL#2)

2666ae8

Fixed for sp_c64.c to be available.

b5225aa

Modified Makefile and benchmark variables

17c96d1

-modified Makefile to execute clean target before building. -modified Makefile to add CFLAGS for sp_x86_64. -fixed BENCH_TIME_SEC possible to be defined by compiler flags. -add -lpthread to be given to compiler.

add wc_encrypt.o as target

f6a2790

add Makefile to make all remove unnecessary files remove trailing spaces

addressed review comments

51b3eff

add file header fix wc_RsaSSL_Verify

miyazakh force-pushed the sig_verify_morimoto branch from b6328e5 to 51b3eff Compare August 19, 2025 21:25

		@@ -0,0 +1,92 @@
		# Signature Examples for Embedded Systems

		This directory includes the following examples under the sub-directories.Each has a Makefile and source files to build and execute the example and a README to show how to build and Example output.

		\|\|ecc_vfy_only_nonblock\|verify signature with non-blocking\|


		You can specify a target function of Simple example, Benchemark or Memory track program.It also has options for optimized code for MCU architectures such as Intel x86, ARM64 or a generic code by default, as well as Math library of Single Precision or TFM.

		\|x64\|SP for x86 64bit\|


		The Makefile is self-contained without libwolfssl. Put your wolfSSL source filesin parallel with wolfssl-examples directory. It is defined by WOLFROOT in Makefile.It compiles only needed files for the target. OBJ and OBJ_xxx macro in Makefiledefine object files for the common and specific target.


		The Makefile is self-contained without libwolfssl. Put your wolfSSL source filesin parallel with wolfssl-examples directory. It is defined by WOLFROOT in Makefile.It compiles only needed files for the target. OBJ and OBJ_xxx macro in Makefiledefine object files for the common and specific target.

		Example programs are hard coded for a hash algorithm or signature scheme.Sha256 is for the hash by default. PKCS #1 v1.5 or ECDSA for the signature scheme.You can refer to the following API tables for modifying the examples for other algorithms or schemes.

Conversation

miyazakh commented Oct 27, 2024

Uh oh!

miyazakh commented Oct 30, 2024

Uh oh!

cconlon left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

miyazakh commented Aug 19, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants