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

Provide an clear overview of the asymmetric signature API #221

Merged
merged 6 commits into from
Nov 4, 2024
Merged

Provide an clear overview of the asymmetric signature API #221

merged 6 commits into from
Nov 4, 2024

Conversation

athoelke
Copy link
Contributor

I've taken some ideas from #107 and #216 to clarify the documentation for asymmetric signatures, which seems valuable independently of those PRs:

  • Rework the introduction to the signature chapter to describe:
    • Different signature schemes, and split the algorithm sub-chapter by scheme. This better paves the way for ML-DSA and SLH-DSA
    • The three types of algorithm: hash-and-sign, message-signature, and specialized-signature. This terminology is used throughout to improve clarity in how to use each algorithm.
    • The message and hash signature functions. This provides the right structure to add the interruptible APIs.
  • Small improvements to the text in the functionality overview, to increase clarity.

@athoelke
Remove hard line-wraps
98b9416
@athoelke
crypto: Clarify asymmetric signatures
8ef1883 
Provide an introduction to asymmetric signature:
* Separate the different signature schemes
* Categorize the types of signature algorithm, and use this terminology throughout
@athoelke athoelke added clarification Something is confusing or missing in the documentation Crypto API Issue or PR related to the Cryptography API labels Oct 14, 2024
@athoelke athoelke added this to the Crypto API 1.3 milestone Oct 14, 2024
@athoelke athoelke self-assigned this Oct 14, 2024
gilles-peskine-arm
gilles-peskine-arm approved these changes Nov 4, 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 good to me, with just some minor suggestions.

doc/crypto/api/ops/signature.rst Outdated Show resolved Hide resolved
doc/crypto/overview/functionality.rst Outdated Show resolved Hide resolved
gilles-peskine-arm
gilles-peskine-arm approved these changes Nov 4, 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 athoelke merged commit 3b63e4b into ARM-software:main Nov 4, 2024
@athoelke athoelke mentioned this pull request Nov 4, 2024
Merged
@athoelke athoelke deleted the crypto-signature-introduction branch November 4, 2024 17:32
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

@MarcusJGStreets MarcusJGStreets Awaiting requested review from MarcusJGStreets

Assignees

@athoelke athoelke

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