Add API support for External-MU Signature[ML-DSA]

.CMake/alg_support.cmake

@@ -178,6 +178,9 @@ option(OQS_ENABLE_SIG_ML_DSA "Enable ml_dsa algorithm family" ON)
 cmake_dependent_option(OQS_ENABLE_SIG_ml_dsa_44 "" ON "OQS_ENABLE_SIG_ML_DSA" OFF)
 cmake_dependent_option(OQS_ENABLE_SIG_ml_dsa_65 "" ON "OQS_ENABLE_SIG_ML_DSA" OFF)
 cmake_dependent_option(OQS_ENABLE_SIG_ml_dsa_87 "" ON "OQS_ENABLE_SIG_ML_DSA" OFF)
+cmake_dependent_option(OQS_ENABLE_SIG_ml_dsa_44_extmu "" ON "OQS_ENABLE_SIG_ML_DSA" OFF)
+cmake_dependent_option(OQS_ENABLE_SIG_ml_dsa_65_extmu "" ON "OQS_ENABLE_SIG_ML_DSA" OFF)
+cmake_dependent_option(OQS_ENABLE_SIG_ml_dsa_87_extmu "" ON "OQS_ENABLE_SIG_ML_DSA" OFF)
 
 option(OQS_ENABLE_SIG_FALCON "Enable falcon algorithm family" ON)
 cmake_dependent_option(OQS_ENABLE_SIG_falcon_512 "" ON "OQS_ENABLE_SIG_FALCON" OFF)
@@ -672,6 +675,42 @@ if(OQS_DIST_ARM64_V8_BUILD OR (OQS_USE_ARM_NEON_INSTRUCTIONS AND OQS_USE_ARM_NEO
 endif()
 endif()
 
+if(CMAKE_SYSTEM_NAME MATCHES "Linux|Darwin")
+if(OQS_DIST_X86_64_BUILD OR (OQS_USE_AVX2_INSTRUCTIONS AND OQS_USE_BMI2_INSTRUCTIONS AND OQS_USE_POPCNT_INSTRUCTIONS))
+    cmake_dependent_option(OQS_ENABLE_SIG_ml_dsa_44_extmu_x86_64 "" ON "OQS_ENABLE_SIG_ml_dsa_44_extmu" OFF)
+endif()
+endif()
+
+if(CMAKE_SYSTEM_NAME MATCHES "Linux|Darwin")
+if(OQS_DIST_ARM64_V8_BUILD OR (OQS_USE_ARM_NEON_INSTRUCTIONS AND OQS_USE_ARM_NEON_INSTRUCTIONS))
+    cmake_dependent_option(OQS_ENABLE_SIG_ml_dsa_44_extmu_aarch64 "" ON "OQS_ENABLE_SIG_ml_dsa_44_extmu" OFF)
+endif()
+endif()
+
+if(CMAKE_SYSTEM_NAME MATCHES "Linux|Darwin")
+if(OQS_DIST_X86_64_BUILD OR (OQS_USE_AVX2_INSTRUCTIONS AND OQS_USE_BMI2_INSTRUCTIONS AND OQS_USE_POPCNT_INSTRUCTIONS))
+    cmake_dependent_option(OQS_ENABLE_SIG_ml_dsa_65_extmu_x86_64 "" ON "OQS_ENABLE_SIG_ml_dsa_65_extmu" OFF)
+endif()
+endif()
+
+if(CMAKE_SYSTEM_NAME MATCHES "Linux|Darwin")
+if(OQS_DIST_ARM64_V8_BUILD OR (OQS_USE_ARM_NEON_INSTRUCTIONS AND OQS_USE_ARM_NEON_INSTRUCTIONS))
+    cmake_dependent_option(OQS_ENABLE_SIG_ml_dsa_65_extmu_aarch64 "" ON "OQS_ENABLE_SIG_ml_dsa_65_extmu" OFF)
+endif()
+endif()
+
+if(CMAKE_SYSTEM_NAME MATCHES "Linux|Darwin")
+if(OQS_DIST_X86_64_BUILD OR (OQS_USE_AVX2_INSTRUCTIONS AND OQS_USE_BMI2_INSTRUCTIONS AND OQS_USE_POPCNT_INSTRUCTIONS))
+    cmake_dependent_option(OQS_ENABLE_SIG_ml_dsa_87_extmu_x86_64 "" ON "OQS_ENABLE_SIG_ml_dsa_87_extmu" OFF)
+endif()
+endif()
+
+if(CMAKE_SYSTEM_NAME MATCHES "Linux|Darwin")
+if(OQS_DIST_ARM64_V8_BUILD OR (OQS_USE_ARM_NEON_INSTRUCTIONS AND OQS_USE_ARM_NEON_INSTRUCTIONS))
+    cmake_dependent_option(OQS_ENABLE_SIG_ml_dsa_87_extmu_aarch64 "" ON "OQS_ENABLE_SIG_ml_dsa_87_extmu" OFF)
+endif()
+endif()
+
 
 if(OQS_DIST_X86_64_BUILD OR (OQS_USE_AVX2_INSTRUCTIONS))
     cmake_dependent_option(OQS_ENABLE_SIG_falcon_512_avx2 "" ON "OQS_ENABLE_SIG_falcon_512" OFF)

scripts/copy_from_upstream/copy_from_upstream.py

@@ -628,6 +628,23 @@ def handle_implementation(impl, family, scheme, dst_basedir):
 
 def process_families(instructions, basedir, with_kat, with_generator, with_libjade=False):
     for family in instructions['kems'] + instructions['sigs']:
+        extmu_variants = []
+        for s in family['schemes']:
+            if 'metadata' in s and any('signature_signature_extmu' in imp for imp in s['metadata']['implementations']):
+                ext_s = copy.deepcopy(s)
+                ext_s['scheme'] += "_extmu"
+                ext_s['scheme_c'] += "_extmu"
+                ext_s['pretty_name_full'] += "-extmu"
+                ext_s['is_extmu'] = True
+                for imp in ext_s['metadata']['implementations']:
+                    if 'signature_signature_extmu' in imp:
+                        imp['signature_signature'] = imp['signature_signature_extmu']
+                    if 'signature_verify_extmu' in imp:
+                        imp['signature_verify'] = imp['signature_verify_extmu']
+                    imp['api-with-context-string'] = False
+                extmu_variants.append(ext_s)
+        family['schemes'].extend(extmu_variants)
+
         try:
             os.makedirs(os.path.join(basedir, 'src', family['type'], family['name']))
         except:
@@ -699,8 +716,7 @@ def process_families(instructions, basedir, with_kat, with_generator, with_libja
                                 scheme['scheme'], str(ke), impl['name']))
                         pass
 
-
-            if with_kat:
+            if with_kat and not scheme.get('is_extmu', False):
                 if family in instructions['kems']:
                     try:
                         if kats['kem'][scheme['pretty_name_full']]['single'] != scheme['metadata']['nistkat-sha256']:

scripts/copy_from_upstream/src/sig/family/CMakeLists.txt

@@ -26,18 +26,20 @@ endif()
 {%- endif %}
 
 {%- for scheme in schemes -%}
+    {%- if not scheme.is_extmu %}
+        {%- set has_extmu = (schemes | selectattr("scheme_c", "equalto", scheme['scheme_c'] ~ "_extmu") | list | length > 0) %}
     {%- for impl in scheme['metadata']['implementations'] -%}
         {%- if impl['name'] == scheme['default_implementation'] %}
 
-if(OQS_ENABLE_SIG_{{ family }}_{{ scheme['scheme_c'] }}{%- if 'alias_scheme' in scheme %} OR OQS_ENABLE_SIG_{{ family }}_{{ scheme['alias_scheme'] }}{%- endif %})
+if(OQS_ENABLE_SIG_{{ family }}_{{ scheme['scheme_c'] }}{%- if 'alias_scheme' in scheme %} OR OQS_ENABLE_SIG_{{ family }}_{{ scheme['alias_scheme'] }}{%- endif %}{%- if has_extmu %} OR OQS_ENABLE_SIG_{{ family }}_{{ scheme['scheme_c'] }}_extmu{%- endif %})
     add_library({{ family }}_{{ scheme['scheme'] }}_{{ impl['name'] }} OBJECT sig_{{ family }}_{{ scheme['scheme'] }}.c {% for source_file in impl['sources']|sort -%}{{ impl['upstream']['name'] }}_{{ scheme['pqclean_scheme'] }}_{{ impl['name'] }}/{{ source_file }}{%- if not loop.last %} {% endif -%}{%- endfor -%}{%- if common_deps is defined %}{%- for cdep in common_deps %}{%- if cdep['include_only'] and 'common_dep' in impl and cdep['name'] in impl['common_dep'] %} {% for sf in cdep['sources_addl']|sort -%}{{ upstream_location }}_{{ cdep['name'] }}/{{ sf }}{%- if not loop.last %} {% endif -%}{%- endfor %}{%- endif %}{%- endfor %}{%- endif -%})
            {%- if impl['compile_opts'] %}
     target_compile_options({{ family }}_{{ scheme['scheme'] }}_{{ impl['name'] }} PUBLIC {{ impl['compile_opts'] }})
            {%- endif -%}
 
         {%- else %}
 
-if(OQS_ENABLE_SIG_{{ family }}_{{ scheme['scheme_c'] }}_{{ impl['name'] }}{%- if 'alias_scheme' in scheme %} OR OQS_ENABLE_SIG_{{ family }}_{{ scheme['alias_scheme'] }}_{{ impl['name'] }}{%- endif %})
+if(OQS_ENABLE_SIG_{{ family }}_{{ scheme['scheme_c'] }}_{{ impl['name'] }}{%- if 'alias_scheme' in scheme %} OR OQS_ENABLE_SIG_{{ family }}_{{ scheme['alias_scheme'] }}_{{ impl['name'] }}{%- endif %}{%- if has_extmu %} OR OQS_ENABLE_SIG_{{ family }}_{{ scheme['scheme_c'] }}_extmu_{{ impl['name'] }}{%- endif %})
     add_library({{ family }}_{{ scheme['scheme'] }}_{{ impl['name'] }} OBJECT {% for source_file in impl['sources']|sort -%}{{ impl['upstream']['name'] }}_{{ scheme['pqclean_scheme'] }}_{{ impl['name'] }}/{{ source_file }}{%- if not loop.last %} {% endif -%}{%- endfor -%}{%- if common_deps is defined %}{%- for cdep in common_deps %}{%- if cdep['include_only'] and 'common_dep' in impl and cdep['name'] in impl['common_dep'] %} {% for sf in cdep['sources_addl']|sort -%}{{ upstream_location }}_{{ cdep['name'] }}/{{ sf }}{%- if not loop.last %} {% endif -%}{%- endfor %}{%- endif %}{%- endfor %}{%- endif -%})
         {%- endif %}
     target_include_directories({{ family }}_{{ scheme['scheme'] }}_{{ impl['name'] }} PRIVATE ${CMAKE_CURRENT_LIST_DIR}/{{ impl['upstream']['name'] }}_{{ scheme['pqclean_scheme'] }}_{{ impl['name'] }})
@@ -57,7 +59,17 @@ if(OQS_ENABLE_SIG_{{ family }}_{{ scheme['scheme_c'] }}_{{ impl['name'] }}{%- if
         {%- endif %}
     set(_{{ family|upper }}_OBJS ${_{{ family|upper }}_OBJS} $<TARGET_OBJECTS:{{ family }}_{{ scheme['scheme'] }}_{{ impl['name'] }}>)
 endif()
-    {%- endfor -%}
+        {%- endfor %}
+    {%- else %}
+
+if(OQS_ENABLE_SIG_{{ family }}_{{ scheme['scheme_c'] }})
+    add_library({{ family }}_{{ scheme['scheme'] }} OBJECT sig_{{ family }}_{{ scheme['scheme'] }}.c)
+    {%- set base_pqclean = scheme['pqclean_scheme'] | replace('-extmu', '') %}
+    target_include_directories({{ family }}_{{ scheme['scheme'] }} PRIVATE ${CMAKE_CURRENT_LIST_DIR}/{{ scheme['metadata']['implementations'][0]['upstream']['name'] }}_{{ base_pqclean }}_{{ scheme['default_implementation'] }})
+    target_include_directories({{ family }}_{{ scheme['scheme'] }} PRIVATE ${PROJECT_SOURCE_DIR}/src/common/pqclean_shims)
+    set(_{{ family|upper }}_OBJS ${_{{ family|upper }}_OBJS} $<TARGET_OBJECTS:{{ family }}_{{ scheme['scheme'] }}>)
+endif()
+    {%- endif %}
 {%- endfor %}
 
 set({{ family|upper }}_OBJS ${_{{ family|upper }}_OBJS} PARENT_SCOPE)

scripts/copy_from_upstream/src/sig/family/sig_family.h

@@ -11,6 +11,9 @@
 #define OQS_SIG_{{ family }}_{{ scheme['scheme'] }}_length_public_key {{ scheme['metadata']['length-public-key'] }}
 #define OQS_SIG_{{ family }}_{{ scheme['scheme'] }}_length_secret_key {{ scheme['metadata']['length-secret-key'] }}
 #define OQS_SIG_{{ family }}_{{ scheme['scheme'] }}_length_signature {{ scheme['metadata']['length-signature'] }}
+{%- if scheme.is_extmu and 'length-mu' in scheme['metadata'] %}
+#define OQS_SIG_{{ family }}_{{ scheme['scheme'] }}_length_mu {{ scheme['metadata']['length-mu'] }}
+{%- endif %}
 
 OQS_SIG *OQS_SIG_{{ family }}_{{ scheme['scheme'] }}_new(void);
 OQS_API OQS_STATUS OQS_SIG_{{ family }}_{{ scheme['scheme'] }}_keypair(uint8_t *public_key, uint8_t *secret_key);