eden-emu/mbedtls
15
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Improve documentation of crypto_knowledge.KeyType

Browse source 
Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>
This commit is contained in:
Gilles Peskine 2021-02-16 14:29:22 +01:00
parent d169d60319
commit fa3c69a60f
1 changed files with 19 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

25
scripts/mbedtls_dev/crypto_knowledge.py
View file

@ -30,27 +30,40 @@ class KeyType:
"""Analyze a key type. """Analyze a key type.
The key type must be specified in PSA syntax. In its simplest form, The key type must be specified in PSA syntax. In its simplest form,
this is a string 'PSA_KEY_TYPE_xxx' which is the name of a PSA key `name` is a string 'PSA_KEY_TYPE_xxx' which is the name of a PSA key
type macro. For key types that take arguments, the arguments can type macro. For key types that take arguments, the arguments can
be passed either through the optional argument `params` or by be passed either through the optional argument `params` or by
passing an expression of the form 'PSA_KEY_TYPE_xxx(param1, param2)' passing an expression of the form 'PSA_KEY_TYPE_xxx(param1, param2)'
as the a string. in `name` as a string.
""" """
self.name = name.strip() self.name = name.strip()
"""The key type macro name (``PSA_KEY_TYPE_xxx``).
For key types constructed from a macro with arguments, this is the
name of the macro, and the arguments are in `self.params`.
"""
if params is None: if params is None:
if '(' in self.name: if '(' in self.name:
m = re.match(r'(\w+)\s*\((.*)\)\Z', self.name) m = re.match(r'(\w+)\s*\((.*)\)\Z', self.name)
assert m is not None assert m is not None
self.name = m.group(1) self.name = m.group(1)
params = ','.split(m.group(2)) params = ','.split(m.group(2))
if params is None: self.params = (None if params is None else
self.params = params [param.strip() for param in params])
else: """The parameters of the key type, if there are any.
self.params = [param.strip() for param in params]
None if the key type is a macro without arguments.
"""
self.expression = self.name self.expression = self.name
"""A C expression whose value is the key type encoding."""
if self.params is not None: if self.params is not None:
self.expression += '(' + ', '.join(self.params) + ')' self.expression += '(' + ', '.join(self.params) + ')'
self.private_type = re.sub(r'_PUBLIC_KEY\Z', r'_KEY_PAIR', self.name) self.private_type = re.sub(r'_PUBLIC_KEY\Z', r'_KEY_PAIR', self.name)
"""The key type macro name for the corresponding key pair type.
For everything other than a public key type, this is the same as
`self.name`.
"""
ECC_KEY_SIZES = { ECC_KEY_SIZES = {
'PSA_ECC_FAMILY_SECP_K1': (192, 224, 256), 'PSA_ECC_FAMILY_SECP_K1': (192, 224, 256),