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.

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

Reorganise key format and key derivation information #184

Merged
merged 3 commits into from
May 10, 2024

Conversation

athoelke
Copy link
Contributor

@athoelke athoelke commented Mar 13, 2024

[Updated: rebased after publication of Crypto API 1.2.1. Updated the rendered PDF]

This is a follow-up to #177, which moves the information about key formats, and key derivation, into each key type definition.

This is more user-centric than providing all the key formats in a single place, and all the key derivation methods in another single place. It will also scale better when we add additional formats, or key construction methods (see #149 and #167).

The new commits (since #177) start at 0733f81

Preview of the PDF: IHI0086-PSA_Certified_Crypto_API-1.3.0-key-formats-draft.2.pdf

@athoelke athoelke added bug Something is incorrect or inconsistent in the documentation clarification Something is confusing or missing in the documentation Crypto API Issue or PR related to the Cryptography API labels Mar 13, 2024
@athoelke athoelke added this to the Crypto API 1.3 milestone Mar 13, 2024
@athoelke athoelke self-assigned this Mar 13, 2024
@athoelke
Copy link
Contributor Author

athoelke commented Mar 13, 2024

I'm not sure if the 'Key format' and 'Key derivation' sections might benefit from some boilerplate text to indicate the sub-section's relevance to psa_import_key()/psa_export_key() and psa_key_derivation_ouput_key() respectively?

E.g. instead of:

Key format

The key data is the raw bytes of the key.

Key derivation

Draw m/8 bytes of data and ...

we say:

Key format

When calling psa_import_key() or psa_export_key(), the key data is the raw bytes of the key.

Key derivation

A call to psa_key_derivation_output_key() will construct the key by drawing m/8 bytes of data and ...

For key-pair, this would be an obvious place to cross reference to the public key export format. For public keys which might be used in key agreement, or other APIs, the boilerplate text would be suitably modified.

@athoelke
Copy link
Contributor Author

athoelke commented May 9, 2024

Rebased after #177 merged (with minor fixes)

@athoelke athoelke force-pushed the crypto-key-details branch from fa4ea77 to bd2ba51 Compare May 9, 2024 13:31
@athoelke athoelke merged commit 8fab2a2 into ARM-software:main May 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
clarification Something is confusing or missing in the documentation Crypto API Issue or PR related to the Cryptography API
Projects
Development

Successfully merging this pull request may close these issues.

1 participant