Skip to content

Commit

Permalink
Add registry markdown doc
Browse files Browse the repository at this point in the history
Signed-off-by: Alex Cameron <[email protected]>
  • Loading branch information
tetsuo-cpp committed Jan 16, 2024
1 parent 7a93838 commit 500ce56
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 0 deletions.
17 changes: 17 additions & 0 deletions docs/algorithm-registry.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Algorithm Registry

This file is designed to act as a source of truth regarding what signing
algorithms are permitted across the Sigstore ecosystem. Any changes to this file
**must** be reflected in the `SupportedAlgorithm` enumeration in
[sigstore_common.proto](../protos/sigstore_common.proto).

Refer to the [Sigstore: Configurable Crypto Algorithms](https://docs.google.com/document/d/18vTKFvTQdRt3OGz6Qd1xf04o-hugRYSup-1EAOWn7MQ/)
specification for the design rationale for this registry.

| Algorithm | Name | Usage |
| --- | --- | --- |
| ECDSA | ecdsa-sha2-256-nistp256 | sign/verify |
|| ecdsa-sha2-256-nistp521 | verify only |
|| ecdsa-sha2-384-nistp384 | sign/verify |
| EdDSA | ed25519 | sign/verify |
|| ed25519-ph | sign/verify |
3 changes: 3 additions & 0 deletions protos/sigstore_common.proto
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,9 @@ message HashOutput {
//
// This is modelled as a linear set as we want to provide a small number of
// opinionated options instead of allowing every possible permutation.
//
// Any changes to this enum MUST be reflected in the algorithm registry.
// See: docs/algorithm-registry.md
enum SupportedAlgorithm {
SUPPORTED_ALGORITHM_UNSPECIFIED = 0;
ECDSA_SHA2_256_NISTP256 = 1;
Expand Down

0 comments on commit 500ce56

Please sign in to comment.