Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

include keyid in public ed25519/ecdsa public key files #250

Closed
wants to merge 1 commit into from
Closed

include keyid in public ed25519/ecdsa public key files #250

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions securesystemslib/interface.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -516,13 +516,15 @@ def generate_and_write_ed25519_keypair(filepath=None, password=None):
# to final destination.
file_object = tempfile.TemporaryFile()

# Generate the ed25519 public key file contents in metadata format (i.e.,
# does not include the keyid portion).
Copy link
Author

@shibumi shibumi Jul 3, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you know why we never included the keyid here? It doesn't make sense for me, because if we don't provide a filepath we are even naming the keypair files <KEYID>.{pub,key}

# Generate the ed25519 public key file contents in metadata format
# We can include the keyid here, because the keyid is calculated
# by the key data without the private key.
keytype = ed25519_key['keytype']
keyid = ed25519_key['keyid']
keyval = ed25519_key['keyval']
scheme = ed25519_key['scheme']
ed25519key_metadata_format = securesystemslib.keys.format_keyval_to_metadata(
keytype, scheme, keyval, private=False)
keytype, scheme, keyval, keyid=keyid, private=False)

file_object.write(json.dumps(ed25519key_metadata_format).encode('utf-8'))

Expand Down Expand Up @@ -786,8 +788,9 @@ def generate_and_write_ecdsa_keypair(filepath=None, password=None):
keytype = ecdsa_key['keytype']
keyval = ecdsa_key['keyval']
scheme = ecdsa_key['scheme']
keyid = ecdsa_key['keyid']
ecdsakey_metadata_format = securesystemslib.keys.format_keyval_to_metadata(
keytype, scheme, keyval, private=False)
keytype, scheme, keyval, keyid=keyid, private=False)

file_object.write(json.dumps(ecdsakey_metadata_format).encode('utf-8'))

Expand Down
12 changes: 10 additions & 2 deletions securesystemslib/keys.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -378,7 +378,7 @@ def generate_ed25519_key(scheme='ed25519'):



def format_keyval_to_metadata(keytype, scheme, key_value, private=False):
def format_keyval_to_metadata(keytype, scheme, key_value, keyid=None, private=False):
"""
<Purpose>
Return a dictionary conformant to 'securesystemslib.formats.KEY_SCHEMA'.
Expand Down Expand Up @@ -464,7 +464,15 @@ def format_keyval_to_metadata(keytype, scheme, key_value, private=False):

else:
public_key_value = {'public': key_value['public']}

# If we encounter a keyid, we are dealing with pub key file generation
# as in interface.py#L526
if keyid is not None:
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is this check here is enough? Maybe we want to validate the keyid?

return {'keytype': keytype,
'scheme': scheme,
'keyid': keyid,
'keyid_hash_algorithms': securesystemslib.settings.HASH_ALGORITHMS,
'keyval': public_key_value}

return {'keytype': keytype,
'scheme': scheme,
'keyid_hash_algorithms': securesystemslib.settings.HASH_ALGORITHMS,
Expand Down