mbedtls-framework/util/mbedtls_maintainer/mldsa_test_generator.py

"""Generate ML-DSA test cases.
"""

# Copyright The Mbed TLS Contributors
# SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later

from typing import Iterator, List, Optional

# pip install dilithium-py
import dilithium_py.ml_dsa #type: ignore

import scripts_path # pylint: disable=unused-import
from mbedtls_framework import test_case

# ML_DSA instances for pure ML-DSA
PURE = {
    #44: dilithium_py.ml_dsa.ML_DSA_44,
    #65: dilithium_py.ml_dsa.ML_DSA_65,
    87: dilithium_py.ml_dsa.ML_DSA_87,
}

# ML_DSA instances for HashML-DSA
HASH = {
    #44: dilithium_py.ml_dsa.HASH_ML_DSA_44_WITH_SHA512,
    #65: dilithium_py.ml_dsa.HASH_ML_DSA_65_WITH_SHA512,
    87: dilithium_py.ml_dsa.HASH_ML_DSA_87_WITH_SHA512,
}

# Seeds (i.e. private keys) to test with.
SEEDS = [
    b'There was once upon a time a ...',
    b'\x00' * 32,
]

class Key:
    """An MLDSA key pair."""
    #pylint: disable=too-few-public-methods

    def __init__(self, kl: int, seed: bytes) -> None:
        self.kl = kl #pylint: disable=invalid-name
        self.seed = seed
        self.public, self.secret = PURE[kl]._keygen_internal(seed)

    def sign_message(self, message: bytes, deterministic: bool) -> bytes:
        PURE[self.kl].set_drbg_seed(bytes(48))
        return PURE[self.kl].sign(self.secret, message,
                                  deterministic=deterministic)

# Key pairs to test with.
KEYS = {kl: [Key(kl, seed) for seed in SEEDS]
        for kl in sorted(PURE.keys())}

# Input messages to test with.
MESSAGES = [
    (b'This is a test', ''),
    (b'', 'empty message'),
    (b'\x00', '"\\x00"'),
    (b'\x01', '"\\x01"'),
    (b'ACBDEFGHIJ' * 100, '1000B'),
]


class Generator:
    """Abstract base class to generate tests for one API."""

    @classmethod
    def function(cls, func: str, kl: int) -> str:
        raise NotImplementedError

    @classmethod
    def metadata_arguments(cls,
                           kl: int,
                           pair: bool,
                           deterministic: Optional[bool]) -> List[str]:
        raise NotImplementedError

    @classmethod
    def final_arguments(cls) -> List[str]:
        return []

    @classmethod
    def secret_is_seed(cls) -> bool:
        return True

    def one_mldsa_public_key_from_seed(self, key: Key,
                                       descr: str) -> test_case.TestCase:
        """Construct one test case for driver export_public_key()."""
        tc = test_case.TestCase()
        tc.set_function('export_public_key')
        tc.set_dependencies([f'TF_PSA_CRYPTO_PQCP_MLDSA_{key.kl}_ENABLED'])
        tc.set_arguments(self.metadata_arguments(key.kl, True, None) + [
            test_case.hex_string(key.seed),
            test_case.hex_string(key.public),
        ] + self.final_arguments())
        tc.set_description(f'MLDSA-{key.kl} export public key from seed {descr}')
        return tc

    def one_mldsa_sign_deterministic_pure(self,
                                          key: Key,
                                          message: bytes,
                                          descr: str) -> test_case.TestCase:
        """Construct one test case for deterministic signature."""
        signature = key.sign_message(message, deterministic=True)
        tc = test_case.TestCase()
        tc.set_function(self.function('sign_message_deterministic', key.kl))
        tc.set_dependencies([f'TF_PSA_CRYPTO_PQCP_MLDSA_{key.kl}_ENABLED'])
        tc.set_arguments(self.metadata_arguments(key.kl, True, True) + [
            test_case.hex_string(key.seed if self.secret_is_seed() else key.secret),
            test_case.hex_string(message),
            test_case.hex_string(signature),
        ] + self.final_arguments())
        tc.set_description(f'MLDSA-{key.kl} sign deterministic {descr}')
        return tc

    def one_mldsa_verify_pure(self,
                              key: Key,
                              message: bytes,
                              deterministic: bool,
                              descr: str) -> test_case.TestCase:
        """Construct one test case for verification.

        When deterministic is true, the test case is a deterministic signature.
        When deterministic is false, the test case is some other valid signature.
        """
        signature = key.sign_message(message, deterministic=deterministic)
        tc = test_case.TestCase()
        tc.set_function(self.function('verify_message', key.kl))
        tc.set_dependencies([f'TF_PSA_CRYPTO_PQCP_MLDSA_{key.kl}_ENABLED'])
        tc.set_arguments(self.metadata_arguments(key.kl, False, True) + [
            test_case.hex_string(key.public),
            test_case.hex_string(message),
            test_case.hex_string(signature),
        ] + self.final_arguments())
        variant = "deterministic" if deterministic else "randomized"
        tc.set_description(f'MLDSA-{key.kl} verify {variant} {descr}')
        return tc

    def gen_mldsa_pure(self, kl: int) -> Iterator[test_case.TestCase]:
        """Generate all test cases for pure ML-DSA signature and verification."""
        for i, key in enumerate(KEYS[kl], 1):
            yield self.one_mldsa_sign_deterministic_pure(key, MESSAGES[0][0],
                                                         f'key#{i}')
        for message, descr in MESSAGES[1:]:
            yield self.one_mldsa_sign_deterministic_pure(KEYS[kl][0], message,
                                                         f'key#1 {descr}')
        for i, key in enumerate(KEYS[kl], 1):
            yield self.one_mldsa_verify_pure(key, MESSAGES[0][0], True,
                                             f'key#{i}')
        for message, descr in MESSAGES[1:]:
            yield self.one_mldsa_verify_pure(KEYS[kl][0], message, True,
                                             f'key#1 {descr}')
        for i, key in enumerate(KEYS[kl], 1):
            yield self.one_mldsa_verify_pure(key, MESSAGES[0][0], False,
                                             f'key#{i}')
        for message, descr in MESSAGES[1:]:
            yield self.one_mldsa_verify_pure(KEYS[kl][0], message, False,
                                             f'key#1 {descr}')

    def gen_key_management(self, kl: int) -> Iterator[test_case.TestCase]:
        """Generate all key management test cases for the given parameter set."""
        raise NotImplementedError

    def gen_all(self) -> Iterator[test_case.TestCase]:
        """Generate all the tests for this API."""
        for kl in sorted(KEYS.keys()):
            yield from self.gen_key_management(kl)
            yield from self.gen_mldsa_pure(kl)


class PQCPGenerator(Generator):
    """Test mldsa-native entry points."""

    @classmethod
    def function(cls, func: str, kl: int) -> str:
        if func == 'verify_message':
            func = 'verify_pure'
        elif func == 'sign_message_deterministic':
            func = 'sign_deterministic_pure'
        return f'{func}_{kl}'

    @classmethod
    def metadata_arguments(cls,
                           _kl: int,
                           _pair: bool,
                           _deterministic: Optional[bool]) -> List[str]:
        return []

    @classmethod
    def secret_is_seed(cls) -> bool:
        return False

    @staticmethod
    def one_mldsa_key_pair_from_seed(key: Key,
                                     descr: str) -> test_case.TestCase:
        """Construct one test case for mldsa-native keypair_internal()."""
        tc = test_case.TestCase()
        tc.set_function(f'key_pair_from_seed_{key.kl}')
        tc.set_dependencies([f'TF_PSA_CRYPTO_PQCP_MLDSA_{key.kl}_ENABLED'])
        tc.set_arguments([
            test_case.hex_string(key.seed),
            test_case.hex_string(key.secret),
            test_case.hex_string(key.public),
        ])
        tc.set_description(f'MLDSA-{key.kl} key pair from seed {descr}')
        return tc

    def gen_key_management(self, kl: int) -> Iterator[test_case.TestCase]:
        """Generate test cases for mldsa-native keypair_internal()."""
        for i, key in enumerate(KEYS[kl], 1):
            yield self.one_mldsa_key_pair_from_seed(key, f'key#{i}')


def gen_pqcp_mldsa_all() -> Iterator[test_case.TestCase]:
    """Generate all test cases for mldsa-native."""
    generator = PQCPGenerator()
    yield from generator.gen_all()


class DriverGenerator(Generator):
    """Test driver entry points."""

    @classmethod
    def function(cls, func: str, _kl: int) -> str:
        if func == 'verify_message':
            func = 'verify_pure'
        elif func == 'sign_message_deterministic':
            func = 'sign_deterministic_pure'
        return func

    @classmethod
    def metadata_arguments(cls,
                           kl: int,
                           pair: bool,
                           deterministic: Optional[bool]) -> List[str]:
        arguments = []
        arguments.append('PSA_KEY_TYPE_ML_DSA_KEY_PAIR' if pair else
                         'PSA_KEY_TYPE_ML_DSA_PUBLIC_KEY')
        arguments.append(str(kl))
        if deterministic is not None:
            arguments.append('PSA_ALG_DETERMINISTIC_ML_DSA' if deterministic else
                             'PSA_ALG_ML_DSA')
        return arguments

    @classmethod
    def final_arguments(cls) -> List[str]:
        return ['PSA_SUCCESS']

    def gen_key_management(self, kl: int) -> Iterator[test_case.TestCase]:
        """Generate test cases for driver export_public_key()."""
        for i, key in enumerate(KEYS[kl], 1):
            yield self.one_mldsa_public_key_from_seed(key, f'key#{i}')