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

Add algorithm registry markdown and KnownSignatureAlgorithm enumeration #194

Merged
merged 18 commits into from
Jan 17, 2024
Merged

Add algorithm registry markdown and KnownSignatureAlgorithm enumeration #194

Show file tree
Hide file tree
Changes from 15 commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
7a93838
Add `SupportedAlgorithm` enumeration
tetsuo-cpp Jan 9, 2024
500ce56
Add registry markdown doc
tetsuo-cpp Jan 16, 2024
e52e07e
Regenerate code
tetsuo-cpp Jan 16, 2024
196acba
Switch to P521 with SHA-512
tetsuo-cpp Jan 17, 2024
9b1d4ad
Make it clear that Sigstore services aren't required to adhere to thi…
tetsuo-cpp Jan 17, 2024
58725fe
Rename to `KnownSignatureAlgorithm`
tetsuo-cpp Jan 17, 2024
466fc05
Correct `KnownSignatureAlgorithm` comment
tetsuo-cpp Jan 17, 2024
1243b19
Note that `ed25519-ph` is used for hashedrekord
tetsuo-cpp Jan 17, 2024
c06b5d1
Fix algorithm registry to list SHA-512 with P-521
tetsuo-cpp Jan 17, 2024
3d33e9a
Regenerate code
tetsuo-cpp Jan 17, 2024
3610161
Add hash algorithms to registry also
tetsuo-cpp Jan 17, 2024
d126419
Add RSA signature algorithms to registry
tetsuo-cpp Jan 17, 2024
db90d7f
gen, protos: more HashAlgorithm variants
woodruffw Jan 17, 2024
40ea700
protos: indentation
woodruffw Jan 17, 2024
fe4aafb
algorithm-registry: clarify the purpose of the Hash Algorithms table
woodruffw Jan 17, 2024
10fb943
algorithm-registry: add sha2-512
woodruffw Jan 17, 2024
b46b70c
algorithm-registry: omit sha2-256/192
woodruffw Jan 17, 2024
a6b56fb
switcheroo
woodruffw Jan 17, 2024
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
41 changes: 41 additions & 0 deletions docs/algorithm-registry.md
View file
Open in desktop
tetsuo-cpp marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# Algorithm Registry

This file is designed to act as a source of truth regarding what signing
algorithms are recommended across the Sigstore ecosystem. Any changes to this
file **must** be reflected in the `KnownSignatureAlgorithm` enumeration in
[sigstore_common.proto](../protos/sigstore_common.proto).
tetsuo-cpp marked this conversation as resolved.
Show resolved Hide resolved

Note that Sigstore clients and services aren't required support all algorithms
in this registry and may support algorithms that aren't in the registry. The
algorithm registry is more of a guideline than a rule and is meant to serve as
a secure set of defaults that the community can follow.

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

## Signature Algorithms

| Algorithm | Name | Usage |
|-----------|----------------------------|---------------------------------------------------|
| RSA | rsa-sign-pkcs1-2048-sha256 | verify only |
| | rsa-sign-pkcs1-3072-sha256 | sign/verify |
| | rsa-sign-pkcs1-4096-sha256 | sign/verify |
| ECDSA | ecdsa-sha2-256-nistp256 | sign/verify |
| | ecdsa-sha2-384-nistp384 | sign/verify |
| | ecdsa-sha2-512-nistp521 | sign/verify |
| EdDSA | ed25519 | sign/verify |
| | ed25519-ph | sign/verify (recommended only for `hashedrekord`) |

## Hash Algorithms

Generally speaking, these hash algorithms are implied by the above signing suites.
However, clients *may* need to list or configure them explicitly, e.g. for custom
signing schemes or as part of a `hashedrekord` entry.
woodruffw marked this conversation as resolved.
Show resolved Hide resolved

| Algorithm | Name |
|-----------|--------------|
| SHA2 | sha2-256 |
| | sha2-256/192 |
woodruffw marked this conversation as resolved.
Show resolved Hide resolved
| | sha2-384 |
woodruffw marked this conversation as resolved.
Show resolved Hide resolved
| SHA3 | sha3-256 |
woodruffw marked this conversation as resolved.
Show resolved Hide resolved
| | sha3-384 |
6 changes: 5 additions & 1 deletion gen/jsonschema/schemas/Bundle.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,11 @@
"algorithm": {
"enum": [
"HASH_ALGORITHM_UNSPECIFIED",
"SHA2_256"
"SHA2_256",
"SHA2_256_192",
"SHA2_512",
"SHA3_256",
"SHA3_384"
],
"type": "string",
"title": "This package defines commonly used message types within the Sigstore\n community.",
Expand Down
6 changes: 5 additions & 1 deletion gen/jsonschema/schemas/HashOutput.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,11 @@
"algorithm": {
"enum": [
"HASH_ALGORITHM_UNSPECIFIED",
"SHA2_256"
"SHA2_256",
"SHA2_256_192",
"SHA2_512",
"SHA3_256",
"SHA3_384"
],
"type": "string",
"title": "This package defines commonly used message types within the Sigstore\n community.",
Expand Down
12 changes: 10 additions & 2 deletions gen/jsonschema/schemas/Input.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,11 @@
"algorithm": {
"enum": [
"HASH_ALGORITHM_UNSPECIFIED",
"SHA2_256"
"SHA2_256",
"SHA2_256_192",
"SHA2_512",
"SHA3_256",
"SHA3_384"
],
"type": "string",
"title": "This package defines commonly used message types within the Sigstore\n community.",
Expand Down Expand Up @@ -543,7 +547,11 @@
"hashAlgorithm": {
"enum": [
"HASH_ALGORITHM_UNSPECIFIED",
"SHA2_256"
"SHA2_256",
"SHA2_256_192",
"SHA2_512",
"SHA3_256",
"SHA3_384"
],
"type": "string",
"title": "This package defines commonly used message types within the Sigstore\n community.",
Expand Down
6 changes: 5 additions & 1 deletion gen/jsonschema/schemas/MessageSignature.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,11 @@
"algorithm": {
"enum": [
"HASH_ALGORITHM_UNSPECIFIED",
"SHA2_256"
"SHA2_256",
"SHA2_256_192",
"SHA2_512",
"SHA3_256",
"SHA3_384"
],
"type": "string",
"title": "This package defines commonly used message types within the Sigstore\n community.",
Expand Down
6 changes: 5 additions & 1 deletion gen/jsonschema/schemas/TransparencyLogInstance.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,11 @@
"hashAlgorithm": {
"enum": [
"HASH_ALGORITHM_UNSPECIFIED",
"SHA2_256"
"SHA2_256",
"SHA2_256_192",
"SHA2_512",
"SHA3_256",
"SHA3_384"
],
"type": "string",
"title": "This package defines commonly used message types within the Sigstore\n community.",
Expand Down
6 changes: 5 additions & 1 deletion gen/jsonschema/schemas/TrustedRoot.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -206,7 +206,11 @@
"hashAlgorithm": {
"enum": [
"HASH_ALGORITHM_UNSPECIFIED",
"SHA2_256"
"SHA2_256",
"SHA2_256_192",
"SHA2_512",
"SHA3_256",
"SHA3_384"
],
"type": "string",
"title": "This package defines commonly used message types within the Sigstore\n community.",
Expand Down
Loading