Move PSA information and dependency automation into their own module

This will let us use these features from other modules (yet to be created).

Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>
This commit is contained in:
Gilles Peskine 2023-06-19 20:46:47 +02:00
parent 1fdc884ed8
commit fdb722384b
4 changed files with 199 additions and 167 deletions

View file

@ -0,0 +1,162 @@
"""Collect information about PSA cryptographic mechanisms.
"""
# Copyright The Mbed TLS Contributors
# SPDX-License-Identifier: Apache-2.0
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
import re
from typing import Dict, FrozenSet, List, Optional
from . import macro_collector
class Information:
"""Gather information about PSA constructors."""
def __init__(self) -> None:
self.constructors = self.read_psa_interface()
@staticmethod
def remove_unwanted_macros(
constructors: macro_collector.PSAMacroEnumerator
) -> None:
# Mbed TLS does not support finite-field DSA.
# Don't attempt to generate any related test case.
constructors.key_types.discard('PSA_KEY_TYPE_DSA_KEY_PAIR')
constructors.key_types.discard('PSA_KEY_TYPE_DSA_PUBLIC_KEY')
def read_psa_interface(self) -> macro_collector.PSAMacroEnumerator:
"""Return the list of known key types, algorithms, etc."""
constructors = macro_collector.InputsForTest()
header_file_names = ['include/psa/crypto_values.h',
'include/psa/crypto_extra.h']
test_suites = ['tests/suites/test_suite_psa_crypto_metadata.data']
for header_file_name in header_file_names:
constructors.parse_header(header_file_name)
for test_cases in test_suites:
constructors.parse_test_cases(test_cases)
self.remove_unwanted_macros(constructors)
constructors.gather_arguments()
return constructors
def psa_want_symbol(name: str) -> str:
"""Return the PSA_WANT_xxx symbol associated with a PSA crypto feature."""
if name.startswith('PSA_'):
return name[:4] + 'WANT_' + name[4:]
else:
raise ValueError('Unable to determine the PSA_WANT_ symbol for ' + name)
def finish_family_dependency(dep: str, bits: int) -> str:
"""Finish dep if it's a family dependency symbol prefix.
A family dependency symbol prefix is a PSA_WANT_ symbol that needs to be
qualified by the key size. If dep is such a symbol, finish it by adjusting
the prefix and appending the key size. Other symbols are left unchanged.
"""
return re.sub(r'_FAMILY_(.*)', r'_\1_' + str(bits), dep)
def finish_family_dependencies(dependencies: List[str], bits: int) -> List[str]:
"""Finish any family dependency symbol prefixes.
Apply `finish_family_dependency` to each element of `dependencies`.
"""
return [finish_family_dependency(dep, bits) for dep in dependencies]
SYMBOLS_WITHOUT_DEPENDENCY = frozenset([
'PSA_ALG_AEAD_WITH_AT_LEAST_THIS_LENGTH_TAG', # modifier, only in policies
'PSA_ALG_AEAD_WITH_SHORTENED_TAG', # modifier
'PSA_ALG_ANY_HASH', # only in policies
'PSA_ALG_AT_LEAST_THIS_LENGTH_MAC', # modifier, only in policies
'PSA_ALG_KEY_AGREEMENT', # chaining
'PSA_ALG_TRUNCATED_MAC', # modifier
])
def automatic_dependencies(*expressions: str) -> List[str]:
"""Infer dependencies of a test case by looking for PSA_xxx symbols.
The arguments are strings which should be C expressions. Do not use
string literals or comments as this function is not smart enough to
skip them.
"""
used = set()
for expr in expressions:
used.update(re.findall(r'PSA_(?:ALG|ECC_FAMILY|KEY_TYPE)_\w+', expr))
used.difference_update(SYMBOLS_WITHOUT_DEPENDENCY)
return sorted(psa_want_symbol(name) for name in used)
# Define set of regular expressions and dependencies to optionally append
# extra dependencies for test case.
AES_128BIT_ONLY_DEP_REGEX = r'AES\s(192|256)'
AES_128BIT_ONLY_DEP = ["!MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH"]
DEPENDENCY_FROM_KEY = {
AES_128BIT_ONLY_DEP_REGEX: AES_128BIT_ONLY_DEP
}#type: Dict[str, List[str]]
def generate_key_dependencies(description: str) -> List[str]:
"""Return additional dependencies based on pairs of REGEX and dependencies.
"""
deps = []
for regex, dep in DEPENDENCY_FROM_KEY.items():
if re.search(regex, description):
deps += dep
return deps
# A temporary hack: at the time of writing, not all dependency symbols
# are implemented yet. Skip test cases for which the dependency symbols are
# not available. Once all dependency symbols are available, this hack must
# be removed so that a bug in the dependency symbols properly leads to a test
# failure.
def read_implemented_dependencies(filename: str) -> FrozenSet[str]:
return frozenset(symbol
for line in open(filename)
for symbol in re.findall(r'\bPSA_WANT_\w+\b', line))
_implemented_dependencies = None #type: Optional[FrozenSet[str]] #pylint: disable=invalid-name
def hack_dependencies_not_implemented(dependencies: List[str]) -> None:
global _implemented_dependencies #pylint: disable=global-statement,invalid-name
if _implemented_dependencies is None:
_implemented_dependencies = \
read_implemented_dependencies('include/psa/crypto_config.h')
if not all((dep.lstrip('!') in _implemented_dependencies or
not dep.lstrip('!').startswith('PSA_WANT'))
for dep in dependencies):
dependencies.append('DEPENDENCY_NOT_IMPLEMENTED_YET')
def tweak_key_pair_dependency(dep: str, usage: str):
"""
This helper function add the proper suffix to PSA_WANT_KEY_TYPE_xxx_KEY_PAIR
symbols according to the required usage.
"""
ret_list = list()
if dep.endswith('KEY_PAIR'):
if usage == "BASIC":
# BASIC automatically includes IMPORT and EXPORT for test purposes (see
# config_psa.h).
ret_list.append(re.sub(r'KEY_PAIR', r'KEY_PAIR_BASIC', dep))
ret_list.append(re.sub(r'KEY_PAIR', r'KEY_PAIR_IMPORT', dep))
ret_list.append(re.sub(r'KEY_PAIR', r'KEY_PAIR_EXPORT', dep))
elif usage == "GENERATE":
ret_list.append(re.sub(r'KEY_PAIR', r'KEY_PAIR_GENERATE', dep))
else:
# No replacement to do in this case
ret_list.append(dep)
return ret_list
def fix_key_pair_dependencies(dep_list: List[str], usage: str):
new_list = [new_deps
for dep in dep_list
for new_deps in tweak_key_pair_dependency(dep, usage)]
return new_list

View file

@ -120,6 +120,7 @@ if(GEN_FILES)
${CMAKE_CURRENT_SOURCE_DIR}/../tests/scripts/generate_psa_tests.py ${CMAKE_CURRENT_SOURCE_DIR}/../tests/scripts/generate_psa_tests.py
${CMAKE_CURRENT_SOURCE_DIR}/../scripts/mbedtls_dev/crypto_knowledge.py ${CMAKE_CURRENT_SOURCE_DIR}/../scripts/mbedtls_dev/crypto_knowledge.py
${CMAKE_CURRENT_SOURCE_DIR}/../scripts/mbedtls_dev/macro_collector.py ${CMAKE_CURRENT_SOURCE_DIR}/../scripts/mbedtls_dev/macro_collector.py
${CMAKE_CURRENT_SOURCE_DIR}/../scripts/mbedtls_dev/psa_information.py
${CMAKE_CURRENT_SOURCE_DIR}/../scripts/mbedtls_dev/psa_storage.py ${CMAKE_CURRENT_SOURCE_DIR}/../scripts/mbedtls_dev/psa_storage.py
${CMAKE_CURRENT_SOURCE_DIR}/../scripts/mbedtls_dev/test_case.py ${CMAKE_CURRENT_SOURCE_DIR}/../scripts/mbedtls_dev/test_case.py
${CMAKE_CURRENT_SOURCE_DIR}/../scripts/mbedtls_dev/test_data_generation.py ${CMAKE_CURRENT_SOURCE_DIR}/../scripts/mbedtls_dev/test_data_generation.py

View file

@ -123,6 +123,7 @@ $(GENERATED_PSA_DATA_FILES): generated_psa_test_data
generated_psa_test_data: scripts/generate_psa_tests.py generated_psa_test_data: scripts/generate_psa_tests.py
generated_psa_test_data: ../scripts/mbedtls_dev/crypto_knowledge.py generated_psa_test_data: ../scripts/mbedtls_dev/crypto_knowledge.py
generated_psa_test_data: ../scripts/mbedtls_dev/macro_collector.py generated_psa_test_data: ../scripts/mbedtls_dev/macro_collector.py
generated_psa_test_data: ../scripts/mbedtls_dev/psa_information.py
generated_psa_test_data: ../scripts/mbedtls_dev/psa_storage.py generated_psa_test_data: ../scripts/mbedtls_dev/psa_storage.py
generated_psa_test_data: ../scripts/mbedtls_dev/test_case.py generated_psa_test_data: ../scripts/mbedtls_dev/test_case.py
generated_psa_test_data: ../scripts/mbedtls_dev/test_data_generation.py generated_psa_test_data: ../scripts/mbedtls_dev/test_data_generation.py

View file

@ -27,150 +27,13 @@ from typing import Callable, Dict, FrozenSet, Iterable, Iterator, List, Optional
import scripts_path # pylint: disable=unused-import import scripts_path # pylint: disable=unused-import
from mbedtls_dev import crypto_knowledge from mbedtls_dev import crypto_knowledge
from mbedtls_dev import macro_collector from mbedtls_dev import macro_collector #pylint: disable=unused-import
from mbedtls_dev import psa_information
from mbedtls_dev import psa_storage from mbedtls_dev import psa_storage
from mbedtls_dev import test_case from mbedtls_dev import test_case
from mbedtls_dev import test_data_generation from mbedtls_dev import test_data_generation
def psa_want_symbol(name: str) -> str:
"""Return the PSA_WANT_xxx symbol associated with a PSA crypto feature."""
if name.startswith('PSA_'):
return name[:4] + 'WANT_' + name[4:]
else:
raise ValueError('Unable to determine the PSA_WANT_ symbol for ' + name)
def finish_family_dependency(dep: str, bits: int) -> str:
"""Finish dep if it's a family dependency symbol prefix.
A family dependency symbol prefix is a PSA_WANT_ symbol that needs to be
qualified by the key size. If dep is such a symbol, finish it by adjusting
the prefix and appending the key size. Other symbols are left unchanged.
"""
return re.sub(r'_FAMILY_(.*)', r'_\1_' + str(bits), dep)
def finish_family_dependencies(dependencies: List[str], bits: int) -> List[str]:
"""Finish any family dependency symbol prefixes.
Apply `finish_family_dependency` to each element of `dependencies`.
"""
return [finish_family_dependency(dep, bits) for dep in dependencies]
SYMBOLS_WITHOUT_DEPENDENCY = frozenset([
'PSA_ALG_AEAD_WITH_AT_LEAST_THIS_LENGTH_TAG', # modifier, only in policies
'PSA_ALG_AEAD_WITH_SHORTENED_TAG', # modifier
'PSA_ALG_ANY_HASH', # only in policies
'PSA_ALG_AT_LEAST_THIS_LENGTH_MAC', # modifier, only in policies
'PSA_ALG_KEY_AGREEMENT', # chaining
'PSA_ALG_TRUNCATED_MAC', # modifier
])
def automatic_dependencies(*expressions: str) -> List[str]:
"""Infer dependencies of a test case by looking for PSA_xxx symbols.
The arguments are strings which should be C expressions. Do not use
string literals or comments as this function is not smart enough to
skip them.
"""
used = set()
for expr in expressions:
used.update(re.findall(r'PSA_(?:ALG|ECC_FAMILY|KEY_TYPE)_\w+', expr))
used.difference_update(SYMBOLS_WITHOUT_DEPENDENCY)
return sorted(psa_want_symbol(name) for name in used)
# Define set of regular expressions and dependencies to optionally append
# extra dependencies for test case.
AES_128BIT_ONLY_DEP_REGEX = r'AES\s(192|256)'
AES_128BIT_ONLY_DEP = ["!MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH"]
DEPENDENCY_FROM_KEY = {
AES_128BIT_ONLY_DEP_REGEX: AES_128BIT_ONLY_DEP
}#type: Dict[str, List[str]]
def generate_key_dependencies(description: str) -> List[str]:
"""Return additional dependencies based on pairs of REGEX and dependencies.
"""
deps = []
for regex, dep in DEPENDENCY_FROM_KEY.items():
if re.search(regex, description):
deps += dep
return deps
# A temporary hack: at the time of writing, not all dependency symbols
# are implemented yet. Skip test cases for which the dependency symbols are
# not available. Once all dependency symbols are available, this hack must
# be removed so that a bug in the dependency symbols properly leads to a test
# failure.
def read_implemented_dependencies(filename: str) -> FrozenSet[str]:
return frozenset(symbol
for line in open(filename)
for symbol in re.findall(r'\bPSA_WANT_\w+\b', line))
_implemented_dependencies = None #type: Optional[FrozenSet[str]] #pylint: disable=invalid-name
def hack_dependencies_not_implemented(dependencies: List[str]) -> None:
global _implemented_dependencies #pylint: disable=global-statement,invalid-name
if _implemented_dependencies is None:
_implemented_dependencies = \
read_implemented_dependencies('include/psa/crypto_config.h')
if not all((dep.lstrip('!') in _implemented_dependencies or
not dep.lstrip('!').startswith('PSA_WANT'))
for dep in dependencies):
dependencies.append('DEPENDENCY_NOT_IMPLEMENTED_YET')
def tweak_key_pair_dependency(dep: str, usage: str):
"""
This helper function add the proper suffix to PSA_WANT_KEY_TYPE_xxx_KEY_PAIR
symbols according to the required usage.
"""
ret_list = list()
if dep.endswith('KEY_PAIR'):
if usage == "BASIC":
# BASIC automatically includes IMPORT and EXPORT for test purposes (see
# config_psa.h).
ret_list.append(re.sub(r'KEY_PAIR', r'KEY_PAIR_BASIC', dep))
ret_list.append(re.sub(r'KEY_PAIR', r'KEY_PAIR_IMPORT', dep))
ret_list.append(re.sub(r'KEY_PAIR', r'KEY_PAIR_EXPORT', dep))
elif usage == "GENERATE":
ret_list.append(re.sub(r'KEY_PAIR', r'KEY_PAIR_GENERATE', dep))
else:
# No replacement to do in this case
ret_list.append(dep)
return ret_list
def fix_key_pair_dependencies(dep_list: List[str], usage: str):
new_list = [new_deps
for dep in dep_list
for new_deps in tweak_key_pair_dependency(dep, usage)]
return new_list
class Information:
"""Gather information about PSA constructors."""
def __init__(self) -> None:
self.constructors = self.read_psa_interface()
@staticmethod
def remove_unwanted_macros(
constructors: macro_collector.PSAMacroEnumerator
) -> None:
# Mbed TLS does not support finite-field DSA.
# Don't attempt to generate any related test case.
constructors.key_types.discard('PSA_KEY_TYPE_DSA_KEY_PAIR')
constructors.key_types.discard('PSA_KEY_TYPE_DSA_PUBLIC_KEY')
def read_psa_interface(self) -> macro_collector.PSAMacroEnumerator:
"""Return the list of known key types, algorithms, etc."""
constructors = macro_collector.InputsForTest()
header_file_names = ['include/psa/crypto_values.h',
'include/psa/crypto_extra.h']
test_suites = ['tests/suites/test_suite_psa_crypto_metadata.data']
for header_file_name in header_file_names:
constructors.parse_header(header_file_name)
for test_cases in test_suites:
constructors.parse_test_cases(test_cases)
self.remove_unwanted_macros(constructors)
constructors.gather_arguments()
return constructors
def test_case_for_key_type_not_supported( def test_case_for_key_type_not_supported(
verb: str, key_type: str, bits: int, verb: str, key_type: str, bits: int,
@ -181,7 +44,7 @@ def test_case_for_key_type_not_supported(
"""Return one test case exercising a key creation method """Return one test case exercising a key creation method
for an unsupported key type or size. for an unsupported key type or size.
""" """
hack_dependencies_not_implemented(dependencies) psa_information.hack_dependencies_not_implemented(dependencies)
tc = test_case.TestCase() tc = test_case.TestCase()
short_key_type = crypto_knowledge.short_expression(key_type) short_key_type = crypto_knowledge.short_expression(key_type)
adverb = 'not' if dependencies else 'never' adverb = 'not' if dependencies else 'never'
@ -197,7 +60,7 @@ def test_case_for_key_type_not_supported(
class KeyTypeNotSupported: class KeyTypeNotSupported:
"""Generate test cases for when a key type is not supported.""" """Generate test cases for when a key type is not supported."""
def __init__(self, info: Information) -> None: def __init__(self, info: psa_information.Information) -> None:
self.constructors = info.constructors self.constructors = info.constructors
ALWAYS_SUPPORTED = frozenset([ ALWAYS_SUPPORTED = frozenset([
@ -224,20 +87,22 @@ class KeyTypeNotSupported:
# They would be skipped in all configurations, which is noise. # They would be skipped in all configurations, which is noise.
return return
import_dependencies = [('!' if param is None else '') + import_dependencies = [('!' if param is None else '') +
psa_want_symbol(kt.name)] psa_information.psa_want_symbol(kt.name)]
if kt.params is not None: if kt.params is not None:
import_dependencies += [('!' if param == i else '') + import_dependencies += [('!' if param == i else '') +
psa_want_symbol(sym) psa_information.psa_want_symbol(sym)
for i, sym in enumerate(kt.params)] for i, sym in enumerate(kt.params)]
if kt.name.endswith('_PUBLIC_KEY'): if kt.name.endswith('_PUBLIC_KEY'):
generate_dependencies = [] generate_dependencies = []
else: else:
generate_dependencies = fix_key_pair_dependencies(import_dependencies, 'GENERATE') generate_dependencies = \
import_dependencies = fix_key_pair_dependencies(import_dependencies, 'BASIC') psa_information.fix_key_pair_dependencies(import_dependencies, 'GENERATE')
import_dependencies = \
psa_information.fix_key_pair_dependencies(import_dependencies, 'BASIC')
for bits in kt.sizes_to_test(): for bits in kt.sizes_to_test():
yield test_case_for_key_type_not_supported( yield test_case_for_key_type_not_supported(
'import', kt.expression, bits, 'import', kt.expression, bits,
finish_family_dependencies(import_dependencies, bits), psa_information.finish_family_dependencies(import_dependencies, bits),
test_case.hex_string(kt.key_material(bits)), test_case.hex_string(kt.key_material(bits)),
param_descr=param_descr, param_descr=param_descr,
) )
@ -251,7 +116,7 @@ class KeyTypeNotSupported:
if not kt.is_public(): if not kt.is_public():
yield test_case_for_key_type_not_supported( yield test_case_for_key_type_not_supported(
'generate', kt.expression, bits, 'generate', kt.expression, bits,
finish_family_dependencies(generate_dependencies, bits), psa_information.finish_family_dependencies(generate_dependencies, bits),
str(bits), str(bits),
param_descr=param_descr, param_descr=param_descr,
) )
@ -294,7 +159,7 @@ def test_case_for_key_generation(
) -> test_case.TestCase: ) -> test_case.TestCase:
"""Return one test case exercising a key generation. """Return one test case exercising a key generation.
""" """
hack_dependencies_not_implemented(dependencies) psa_information.hack_dependencies_not_implemented(dependencies)
tc = test_case.TestCase() tc = test_case.TestCase()
short_key_type = crypto_knowledge.short_expression(key_type) short_key_type = crypto_knowledge.short_expression(key_type)
tc.set_description('PSA {} {}-bit' tc.set_description('PSA {} {}-bit'
@ -308,7 +173,7 @@ def test_case_for_key_generation(
class KeyGenerate: class KeyGenerate:
"""Generate positive and negative (invalid argument) test cases for key generation.""" """Generate positive and negative (invalid argument) test cases for key generation."""
def __init__(self, info: Information) -> None: def __init__(self, info: psa_information.Information) -> None:
self.constructors = info.constructors self.constructors = info.constructors
ECC_KEY_TYPES = ('PSA_KEY_TYPE_ECC_KEY_PAIR', ECC_KEY_TYPES = ('PSA_KEY_TYPE_ECC_KEY_PAIR',
@ -327,9 +192,9 @@ class KeyGenerate:
""" """
result = 'PSA_SUCCESS' result = 'PSA_SUCCESS'
import_dependencies = [psa_want_symbol(kt.name)] import_dependencies = [psa_information.psa_want_symbol(kt.name)]
if kt.params is not None: if kt.params is not None:
import_dependencies += [psa_want_symbol(sym) import_dependencies += [psa_information.psa_want_symbol(sym)
for i, sym in enumerate(kt.params)] for i, sym in enumerate(kt.params)]
if kt.name.endswith('_PUBLIC_KEY'): if kt.name.endswith('_PUBLIC_KEY'):
# The library checks whether the key type is a public key generically, # The library checks whether the key type is a public key generically,
@ -338,7 +203,8 @@ class KeyGenerate:
generate_dependencies = [] generate_dependencies = []
result = 'PSA_ERROR_INVALID_ARGUMENT' result = 'PSA_ERROR_INVALID_ARGUMENT'
else: else:
generate_dependencies = fix_key_pair_dependencies(import_dependencies, 'GENERATE') generate_dependencies = \
psa_information.fix_key_pair_dependencies(import_dependencies, 'GENERATE')
for bits in kt.sizes_to_test(): for bits in kt.sizes_to_test():
if kt.name == 'PSA_KEY_TYPE_RSA_KEY_PAIR': if kt.name == 'PSA_KEY_TYPE_RSA_KEY_PAIR':
size_dependency = "PSA_VENDOR_RSA_GENERATE_MIN_KEY_BITS <= " + str(bits) size_dependency = "PSA_VENDOR_RSA_GENERATE_MIN_KEY_BITS <= " + str(bits)
@ -347,7 +213,7 @@ class KeyGenerate:
test_dependencies = generate_dependencies test_dependencies = generate_dependencies
yield test_case_for_key_generation( yield test_case_for_key_generation(
kt.expression, bits, kt.expression, bits,
finish_family_dependencies(test_dependencies, bits), psa_information.finish_family_dependencies(test_dependencies, bits),
str(bits), str(bits),
result result
) )
@ -380,7 +246,7 @@ class OpFail:
INCOMPATIBLE = 2 INCOMPATIBLE = 2
PUBLIC = 3 PUBLIC = 3
def __init__(self, info: Information) -> None: def __init__(self, info: psa_information.Information) -> None:
self.constructors = info.constructors self.constructors = info.constructors
key_type_expressions = self.constructors.generate_expressions( key_type_expressions = self.constructors.generate_expressions(
sorted(self.constructors.key_types) sorted(self.constructors.key_types)
@ -417,8 +283,8 @@ class OpFail:
pretty_alg, pretty_alg,
pretty_reason, pretty_reason,
' with ' + pretty_type if pretty_type else '')) ' with ' + pretty_type if pretty_type else ''))
dependencies = automatic_dependencies(alg.base_expression, key_type) dependencies = psa_information.automatic_dependencies(alg.base_expression, key_type)
dependencies = fix_key_pair_dependencies(dependencies, 'BASIC') dependencies = psa_information.fix_key_pair_dependencies(dependencies, 'BASIC')
for i, dep in enumerate(dependencies): for i, dep in enumerate(dependencies):
if dep in not_deps: if dep in not_deps:
dependencies[i] = '!' + dep dependencies[i] = '!' + dep
@ -445,7 +311,7 @@ class OpFail:
"""Generate failure test cases for keyless operations with the specified algorithm.""" """Generate failure test cases for keyless operations with the specified algorithm."""
if alg.can_do(category): if alg.can_do(category):
# Compatible operation, unsupported algorithm # Compatible operation, unsupported algorithm
for dep in automatic_dependencies(alg.base_expression): for dep in psa_information.automatic_dependencies(alg.base_expression):
yield self.make_test_case(alg, category, yield self.make_test_case(alg, category,
self.Reason.NOT_SUPPORTED, self.Reason.NOT_SUPPORTED,
not_deps=frozenset([dep])) not_deps=frozenset([dep]))
@ -463,7 +329,7 @@ class OpFail:
key_is_compatible = kt.can_do(alg) key_is_compatible = kt.can_do(alg)
if key_is_compatible and alg.can_do(category): if key_is_compatible and alg.can_do(category):
# Compatible key and operation, unsupported algorithm # Compatible key and operation, unsupported algorithm
for dep in automatic_dependencies(alg.base_expression): for dep in psa_information.automatic_dependencies(alg.base_expression):
yield self.make_test_case(alg, category, yield self.make_test_case(alg, category,
self.Reason.NOT_SUPPORTED, self.Reason.NOT_SUPPORTED,
kt=kt, not_deps=frozenset([dep])) kt=kt, not_deps=frozenset([dep]))
@ -569,7 +435,7 @@ class StorageTestData(StorageKey):
class StorageFormat: class StorageFormat:
"""Storage format stability test cases.""" """Storage format stability test cases."""
def __init__(self, info: Information, version: int, forward: bool) -> None: def __init__(self, info: psa_information.Information, version: int, forward: bool) -> None:
"""Prepare to generate test cases for storage format stability. """Prepare to generate test cases for storage format stability.
* `info`: information about the API. See the `Information` class. * `info`: information about the API. See the `Information` class.
@ -636,13 +502,13 @@ class StorageFormat:
verb = 'save' if self.forward else 'read' verb = 'save' if self.forward else 'read'
tc = test_case.TestCase() tc = test_case.TestCase()
tc.set_description(verb + ' ' + key.description) tc.set_description(verb + ' ' + key.description)
dependencies = automatic_dependencies( dependencies = psa_information.automatic_dependencies(
key.lifetime.string, key.type.string, key.lifetime.string, key.type.string,
key.alg.string, key.alg2.string, key.alg.string, key.alg2.string,
) )
dependencies = finish_family_dependencies(dependencies, key.bits) dependencies = psa_information.finish_family_dependencies(dependencies, key.bits)
dependencies += generate_key_dependencies(key.description) dependencies += psa_information.generate_key_dependencies(key.description)
dependencies = fix_key_pair_dependencies(dependencies, 'BASIC') dependencies = psa_information.fix_key_pair_dependencies(dependencies, 'BASIC')
tc.set_dependencies(dependencies) tc.set_dependencies(dependencies)
tc.set_function('key_storage_' + verb) tc.set_function('key_storage_' + verb)
if self.forward: if self.forward:
@ -847,13 +713,13 @@ class StorageFormat:
class StorageFormatForward(StorageFormat): class StorageFormatForward(StorageFormat):
"""Storage format stability test cases for forward compatibility.""" """Storage format stability test cases for forward compatibility."""
def __init__(self, info: Information, version: int) -> None: def __init__(self, info: psa_information.Information, version: int) -> None:
super().__init__(info, version, True) super().__init__(info, version, True)
class StorageFormatV0(StorageFormat): class StorageFormatV0(StorageFormat):
"""Storage format stability test cases for version 0 compatibility.""" """Storage format stability test cases for version 0 compatibility."""
def __init__(self, info: Information) -> None: def __init__(self, info: psa_information.Information) -> None:
super().__init__(info, 0, False) super().__init__(info, 0, False)
def all_keys_for_usage_flags(self) -> Iterator[StorageTestData]: def all_keys_for_usage_flags(self) -> Iterator[StorageTestData]:
@ -963,6 +829,7 @@ class StorageFormatV0(StorageFormat):
yield from super().generate_all_keys() yield from super().generate_all_keys()
yield from self.all_keys_for_implicit_usage() yield from self.all_keys_for_implicit_usage()
class PSATestGenerator(test_data_generation.TestGenerator): class PSATestGenerator(test_data_generation.TestGenerator):
"""Test generator subclass including PSA targets and info.""" """Test generator subclass including PSA targets and info."""
# Note that targets whose names contain 'test_format' have their content # Note that targets whose names contain 'test_format' have their content
@ -978,14 +845,15 @@ class PSATestGenerator(test_data_generation.TestGenerator):
lambda info: StorageFormatForward(info, 0).all_test_cases(), lambda info: StorageFormatForward(info, 0).all_test_cases(),
'test_suite_psa_crypto_storage_format.v0': 'test_suite_psa_crypto_storage_format.v0':
lambda info: StorageFormatV0(info).all_test_cases(), lambda info: StorageFormatV0(info).all_test_cases(),
} #type: Dict[str, Callable[[Information], Iterable[test_case.TestCase]]] } #type: Dict[str, Callable[[psa_information.Information], Iterable[test_case.TestCase]]]
def __init__(self, options): def __init__(self, options):
super().__init__(options) super().__init__(options)
self.info = Information() self.info = psa_information.Information()
def generate_target(self, name: str, *target_args) -> None: def generate_target(self, name: str, *target_args) -> None:
super().generate_target(name, self.info) super().generate_target(name, self.info)
if __name__ == '__main__': if __name__ == '__main__':
test_data_generation.main(sys.argv[1:], __doc__, PSATestGenerator) test_data_generation.main(sys.argv[1:], __doc__, PSATestGenerator)