LMS wolfBoot support. #350

philljj · 2023-08-21T14:07:35Z

Description

Adds support for LMS/HSS signatures to wolfBoot.

LMS/HSS is a post-quantum stateful hash-based signature scheme.

Documentation

Added new docs post-quantum readme:

docs/PQ.md

Building

See procedure in docs/PQ.md.

Config

Added new LMS sim example

config/examples/sim-lms.config

The LMS_LEVELS, LMS_HEIGHT, and LMS_WINTERNITZ, IMAGE_SIGNATURE_SIZE, and (optionally) IMAGE_HEADER_SIZE must be set here.

SIGN?=LMS
...
LMS_LEVELS=2
LMS_HEIGHT=5
LMS_WINTERNITZ=8
...
IMAGE_SIGNATURE_SIZE=2644
IMAGE_HEADER_SIZE?=5288

In LMS the signature size is a function of the parameters. Use the added helper script tools/lms/lms_siglen to calculate your signature length given your LMS parameters:

$./tools/lms/lms_siglen 
levels:      3
height:      5
winternitz:  8
#
total_len:   3992

More Info

See these links for more info on LMS and wolfSSL/wolfCrypt:

dgarske · 2023-08-22T14:04:04Z

Please resolve conflicts.

anhu · 2023-08-22T14:22:16Z

config/examples/sim-lms.config

+# The number of available signatures is:
+#   N = 2 ** (levels * height)
+#
+# LMS/HSS Signature sizes are directly proportional to the levels parm,


Remove parm.

I reworded it.

anhu · 2023-08-22T14:23:06Z

config/examples/sim-lms.config

+IMAGE_SIGNATURE_SIZE=2644
+IMAGE_HEADER_SIZE?=5288
+
+# it should be multiple of system page size


"it" what is "it"?

Outdated comment I copy-pasted from other example configs. Will update it.

I updated it to be similar to the other sim*.config files.

anhu · 2023-08-22T14:25:08Z

options.mk

@@ -286,6 +286,53 @@ ifeq ($(SIGN),RSA4096)
  endif
 endif

+ifeq ($(SIGN),LMS)
+  # In LMS the signature size is a function of the LMS parameters.


anhu · 2023-08-22T14:31:00Z

tools/lms/lms_common.h

+        fprintf(stderr, "error: fclose returned %d\n", err);
+        return WC_LMS_RC_WRITE_FAIL;
+    }
+


What about read back and verify content written matches priv ?
We should show best practices and in this case speed/efficiency isn't priority.

Agree but probably should close and check return first before re-opening and reading to increase likelihood the write has actually reached persistent storage.

Added additional logic to re-open, read and compare priv key data.

anhu · 2023-08-22T14:32:12Z

tools/lms/lms_siglen

@@ -0,0 +1,76 @@
+#!/bin/bash
+#


Do we need GPL boiler plate here? I don't know the answer so I'm asking.

Not sure. The shell scripts in tools/scripts/ don't have GPL, so was using that as ref. But lms_siglen should probably have .sh suffix like them.

I originally experimented with putting the sig len calculation logic in makefile scripts but was too messy. And even if sig len is automatically set, the user will likely still need to manually config the header length for their platform. Hence I settled on this helper script.

anhu · 2023-08-22T14:33:08Z

tools/lms/lms_siglen

+# Globals
+
+# The lm_pub_len is 4 less than the pub len value of 60
+# returned from hash-sigs HSS api.


api is all caps (API)

dgarske · 2023-08-22T15:05:35Z

@philljj , please add a docs/PQ.md or docs/LMS.md with the details from the PR description. Please include a link to the hash-sigs repo.

anhu

Just one little punctuation problem.

anhu · 2023-08-22T22:01:45Z

docs/PQ.md

+
+Stateful HBS schemes are based on the security of their underlying hash
+functions and Merkle trees, which are not expected to be broken by the advent
+of cryptographically relevant quantum computers


Missing period at end of paragraph.

tools/keytools/Makefile

dgarske

Over to @danielinux

danielinux · 2023-08-25T15:46:50Z

Unfortunately libhss can only be linked on a POSIX-C system and won't work baremetal:

/usr/lib/gcc/arm-none-eabi/12.2.1/../../../arm-none-eabi/bin/ld: /usr/lib/gcc/arm-none-eabi/12.2.1/../../../arm-none-eabi/lib/thumb/v7-m/nofp/libc.a(lib_a-sbrkr.o): in function `_sbrk_r':
/build/newlib-afIbHz/newlib-3.3.0/build/arm-none-eabi/thumb/v7-m/nofp/newlib/libc/reent/../../../../../../../../newlib/libc/reent/sbrkr.c:51: undefined reference to `_sbrk'
/usr/lib/gcc/arm-none-eabi/12.2.1/../../../arm-none-eabi/bin/ld: /usr/lib/gcc/arm-none-eabi/12.2.1/../../../arm-none-eabi/lib/thumb/v7-m/nofp/libc.a(lib_a-writer.o): in function `_write_r':
/build/newlib-afIbHz/newlib-3.3.0/build/arm-none-eabi/thumb/v7-m/nofp/newlib/libc/reent/../../../../../../../../newlib/libc/reent/writer.c:49: undefined reference to `_write'
/usr/lib/gcc/arm-none-eabi/12.2.1/../../../arm-none-eabi/bin/ld: /usr/lib/gcc/arm-none-eabi/12.2.1/../../../arm-none-eabi/lib/thumb/v7-m/nofp/libc.a(lib_a-closer.o): in function `_close_r':
/build/newlib-afIbHz/newlib-3.3.0/build/arm-none-eabi/thumb/v7-m/nofp/newlib/libc/reent/../../../../../../../../newlib/libc/reent/closer.c:47: undefined reference to `_close'
/usr/lib/gcc/arm-none-eabi/12.2.1/../../../arm-none-eabi/bin/ld: /usr/lib/gcc/arm-none-eabi/12.2.1/../../../arm-none-eabi/lib/thumb/v7-m/nofp/libc.a(lib_a-fstatr.o): in function `_fstat_r':
/build/newlib-afIbHz/newlib-3.3.0/build/arm-none-eabi/thumb/v7-m/nofp/newlib/libc/reent/../../../../../../../../newlib/libc/reent/fstatr.c:55: undefined reference to `_fstat'
/usr/lib/gcc/arm-none-eabi/12.2.1/../../../arm-none-eabi/bin/ld: /usr/lib/gcc/arm-none-eabi/12.2.1/../../../arm-none-eabi/lib/thumb/v7-m/nofp/libc.a(lib_a-isattyr.o): in function `_isatty_r':
/build/newlib-afIbHz/newlib-3.3.0/build/arm-none-eabi/thumb/v7-m/nofp/newlib/libc/reent/../../../../../../../../newlib/libc/reent/isattyr.c:52: undefined reference to `_isatty'
/usr/lib/gcc/arm-none-eabi/12.2.1/../../../arm-none-eabi/bin/ld: /usr/lib/gcc/arm-none-eabi/12.2.1/../../../arm-none-eabi/lib/thumb/v7-m/nofp/libc.a(lib_a-lseekr.o): in function `_lseek_r':
/build/newlib-afIbHz/newlib-3.3.0/build/arm-none-eabi/thumb/v7-m/nofp/newlib/libc/reent/../../../../../../../../newlib/libc/reent/lseekr.c:49: undefined reference to `_lseek'
/usr/lib/gcc/arm-none-eabi/12.2.1/../../../arm-none-eabi/bin/ld: /usr/lib/gcc/arm-none-eabi/12.2.1/../../../arm-none-eabi/lib/thumb/v7-m/nofp/libc.a(lib_a-readr.o): in function `_read_r':
/build/newlib-afIbHz/newlib-3.3.0/build/arm-none-eabi/thumb/v7-m/nofp/newlib/libc/reent/../../../../../../../../newlib/libc/reent/readr.c:49: undefined reference to `_read'
/usr/lib/gcc/arm-none-eabi/12.2.1/../../../arm-none-eabi/bin/ld: /usr/lib/gcc/arm-none-eabi/12.2.1/../../../arm-none-eabi/lib/thumb/v7-m/nofp/libc.a(lib_a-abort.o): in function `abort':
/build/newlib-afIbHz/newlib-3.3.0/build/arm-none-eabi/thumb/v7-m/nofp/newlib/libc/stdlib/../../../../../../../../newlib/libc/stdlib/abort.c:59: undefined reference to `_exit'
/usr/lib/gcc/arm-none-eabi/12.2.1/../../../arm-none-eabi/bin/ld: /usr/lib/gcc/arm-none-eabi/12.2.1/../../../arm-none-eabi/lib/thumb/v7-m/nofp/libc.a(lib_a-signalr.o): in function `_kill_r':
/build/newlib-afIbHz/newlib-3.3.0/build/arm-none-eabi/thumb/v7-m/nofp/newlib/libc/reent/../../../../../../../../newlib/libc/reent/signalr.c:53: undefined reference to `_kill'
/usr/lib/gcc/arm-none-eabi/12.2.1/../../../arm-none-eabi/bin/ld: /usr/lib/gcc/arm-none-eabi/12.2.1/../../../arm-none-eabi/lib/thumb/v7-m/nofp/libc.a(lib_a-signalr.o): in function `_getpid_r':
/build/newlib-afIbHz/newlib-3.3.0/build/arm-none-eabi/thumb/v7-m/nofp/newlib/libc/reent/../../../../../../../../newlib/libc/reent/signalr.c:83: undefined reference to `_getpid'

danielinux

Cannot merge until we figure out how to link a cross-compiled hss_lib.a that does not carry POSIX-C, OS system calls and other dependencies.

dgarske · 2023-08-25T16:00:43Z

Also we should have a CI test added for it so the example config is built (including that hash-sigs lib).

philljj · 2023-08-30T15:02:40Z

Note: these changes require wolfSSL LMS_VERIFY_ONLY support from this PR:
wolfSSL/wolfssl#6738

Also in this last change, the hash-sigs lib is separated like this:

ls lib/hash-sigs/
lib  src

The building of hash-sigs libs/objects is handled automatically with wolfBoot/keytools Makefiles.

The keytools build links with hss_lib.a.
The wolfboot build links with the subset of objects in the hss_verify.a build rule, with -DLMS_VERIFY_ONLY to guard out non-verify code from wolfCrypt LMS.

philljj · 2023-08-31T16:56:24Z

This last change introduced a small build error on mac m1 clang, fixing now.

tools/config.mk

danielinux

POSIX dependencies now solved. Successfully tested on embedded target.

Once the wolfSSL PR is merged, please add non-regression tests + github automations as suggested by @dgarske, and discussed internally.

Change requests have been addressed

danielinux · 2023-09-05T22:44:47Z

Happy to merge if you think your change requests have been addressed properly @anhu @dgarske

anhu · 2023-09-06T00:37:04Z

I'm good!! Thank you!

philljj self-assigned this Aug 21, 2023

philljj requested review from dgarske and danielinux August 22, 2023 13:55

dgarske self-assigned this Aug 22, 2023

dgarske removed their assignment Aug 22, 2023

anhu requested changes Aug 22, 2023

View reviewed changes

philljj force-pushed the lms_wolfboot_support branch from 47639ad to 5d01f38 Compare August 22, 2023 18:23

philljj requested a review from anhu August 22, 2023 18:31

anhu reviewed Aug 22, 2023

View reviewed changes

philljj requested a review from anhu August 23, 2023 13:36

philljj assigned dgarske and danielinux Aug 23, 2023

dgarske requested changes Aug 23, 2023

View reviewed changes

tools/keytools/Makefile Show resolved Hide resolved

dgarske previously approved these changes Aug 24, 2023

View reviewed changes

dgarske removed their assignment Aug 24, 2023

danielinux requested changes Aug 25, 2023

View reviewed changes

danielinux removed their assignment Aug 25, 2023

philljj mentioned this pull request Aug 30, 2023

Wolfcrypt LMS verify-only support wolfSSL/wolfssl#6738

Merged

philljj dismissed dgarske’s stale review via e734e3e August 30, 2023 14:49

philljj requested a review from danielinux August 31, 2023 04:42

philljj requested a review from dgarske August 31, 2023 19:33

dgarske previously requested changes Aug 31, 2023

View reviewed changes

tools/config.mk Show resolved Hide resolved

philljj force-pushed the lms_wolfboot_support branch from b77ffcb to 9c7eb99 Compare August 31, 2023 21:02

philljj requested a review from dgarske August 31, 2023 21:09

danielinux requested changes Sep 1, 2023

View reviewed changes

danielinux mentioned this pull request Sep 4, 2023

[Test action, please ignore] Lms action fix hss dep #360

Closed

LMS wolfBoot support.

08bb217

philljj force-pushed the lms_wolfboot_support branch from 2205c35 to 08bb217 Compare September 5, 2023 21:02

philljj requested a review from danielinux September 5, 2023 21:14

philljj assigned danielinux Sep 5, 2023

danielinux approved these changes Sep 5, 2023

View reviewed changes

danielinux assigned anhu and dgarske and unassigned philljj Sep 5, 2023

dgarske approved these changes Sep 5, 2023

View reviewed changes

anhu approved these changes Sep 6, 2023

View reviewed changes

danielinux merged commit e23d450 into wolfSSL:master Sep 6, 2023
58 checks passed

philljj deleted the lms_wolfboot_support branch September 6, 2023 16:30

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

LMS wolfBoot support. #350

LMS wolfBoot support. #350

philljj commented Aug 21, 2023 •

edited

Loading

dgarske commented Aug 22, 2023

anhu Aug 22, 2023

philljj Aug 22, 2023

anhu Aug 22, 2023

philljj Aug 22, 2023

philljj Aug 22, 2023

anhu Aug 22, 2023

philljj Aug 22, 2023

anhu Aug 22, 2023

philljj Aug 22, 2023 •

edited

Loading

philljj Aug 22, 2023

anhu Aug 22, 2023

philljj Aug 22, 2023

philljj Aug 22, 2023 •

edited

Loading

anhu Aug 22, 2023

dgarske commented Aug 22, 2023

anhu left a comment

anhu Aug 22, 2023

dgarske left a comment

danielinux commented Aug 25, 2023

danielinux left a comment

dgarske commented Aug 25, 2023

philljj commented Aug 30, 2023 •

edited

Loading

philljj commented Aug 31, 2023

danielinux left a comment

danielinux commented Sep 5, 2023

anhu commented Sep 6, 2023

LMS wolfBoot support. #350

LMS wolfBoot support. #350

Conversation

philljj commented Aug 21, 2023 • edited Loading

Description

Documentation

Building

Config

More Info

dgarske commented Aug 22, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

philljj Aug 22, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

philljj Aug 22, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dgarske commented Aug 22, 2023

anhu left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dgarske left a comment

Choose a reason for hiding this comment

danielinux commented Aug 25, 2023

danielinux left a comment

Choose a reason for hiding this comment

dgarske commented Aug 25, 2023

philljj commented Aug 30, 2023 • edited Loading

philljj commented Aug 31, 2023

danielinux left a comment

Choose a reason for hiding this comment

danielinux commented Sep 5, 2023

anhu commented Sep 6, 2023

philljj commented Aug 21, 2023 •

edited

Loading

philljj Aug 22, 2023 •

edited

Loading

philljj Aug 22, 2023 •

edited

Loading

philljj commented Aug 30, 2023 •

edited

Loading