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

Jump to bottom

Further clarifications on the use of key attributes when creating keys #205

Merged
merged 2 commits into from
Jul 30, 2024
Merged

Further clarifications on the use of key attributes when creating keys #205

merged 2 commits into from
Jul 30, 2024

Conversation

athoelke
Copy link
Contributor

An attempt to improve the documentation of how to set the attributes when creating a key, and how the implementation must use them.

In particular:

  • Removing the sloppy text relating to lifetimes and identifiers for key
  • Making it clearer when attributes are not required to be set. For example, the key size for key import, key agreement, pake etc.

@athoelke athoelke added clarification Something is confusing or missing in the documentation Crypto API Issue or PR related to the Cryptography API labels Jul 23, 2024
@athoelke athoelke added this to the Crypto API 1.3 milestone Jul 23, 2024
@athoelke
Copy link
Contributor Author

Once these changes are agreed as an improvement, I will propagate the changes to the new key creation functions in #194 and #199

@athoelke athoelke mentioned this pull request Jul 23, 2024
Open
gilles-peskine-arm
gilles-peskine-arm requested changes Jul 29, 2024
View reviewed changes
Copy link
Contributor

@gilles-peskine-arm gilles-peskine-arm left a comment

Choose a reason for hiding this comment

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

Looks mostly good to me

doc/crypto/api/keys/management.rst Outdated Show resolved Hide resolved
doc/crypto/api/ops/key-derivation.rst Outdated Show resolved Hide resolved
doc/crypto/api/ops/pake.rst Outdated Show resolved Hide resolved
athoelke
athoelke commented Jul 30, 2024
View reviewed changes
Copy link
Contributor Author

@athoelke athoelke left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Ooops: comment added to wrong place

@athoelke
Review feedback updates
9e7b941 
*  Some wordsmithing to improve clarity further
*  Relaxation of policy constraint for key derivation
*  Relaxation of inconsistent key size constraint for PAKE
athoelke added a commit to athoelke/psa-api that referenced this pull request Jul 30, 2024
@athoelke
Copied the key attribute clarifications from PR ARM-software#205
49cc0ef
gilles-peskine-arm
gilles-peskine-arm approved these changes Jul 30, 2024
View reviewed changes
Copy link
Contributor

@gilles-peskine-arm gilles-peskine-arm left a comment

Choose a reason for hiding this comment

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

LGTM

athoelke added a commit to athoelke/psa-api that referenced this pull request Jul 30, 2024
@athoelke
Adopt the key attribute clarifications for key creation functions from …
4f30b9b 
…ARM-software#205
@athoelke athoelke merged commit ceb8d4e into ARM-software:main Jul 30, 2024
@athoelke athoelke deleted the crypto-create-key-attributes branch July 30, 2024 16:01
athoelke added a commit to athoelke/psa-api that referenced this pull request Jul 30, 2024
@athoelke
Copied the key attribute clarifications from PR ARM-software#205
bde1d2d
athoelke added a commit to athoelke/psa-api that referenced this pull request Aug 7, 2024
@athoelke
Adopt the key attribute clarifications for key creation functions from …
a2460eb 
…ARM-software#205
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@gilles-peskine-arm gilles-peskine-arm gilles-peskine-arm approved these changes

@ndevillard ndevillard Awaiting requested review from ndevillard

@MarcusJGStreets MarcusJGStreets Awaiting requested review from MarcusJGStreets

Assignees
No one assigned
Labels
clarification Something is confusing or missing in the documentation Crypto API Issue or PR related to the Cryptography API
Projects
PSA Certified API development
Status: Done
Milestone
Crypto API 1.3
Development

Successfully merging this pull request may close these issues.
2 participants
@athoelke @gilles-peskine-arm