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

protos: drop EXPERIMENTAL_ prefix #214

Merged
merged 2 commits into from
Feb 7, 2024
Merged

protos: drop EXPERIMENTAL_ prefix #214

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
71ab1ab
drop EXPERIMENTAL_ prefix
woodruffw Feb 5, 2024
d3dc93c
gen, protos: warning language
woodruffw Feb 5, 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
4 changes: 2 additions & 2 deletions gen/jsonschema/schemas/ArtifactVerificationOptions.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,8 +139,8 @@
"PKIX_ECDSA_P521_SHA_512",
"PKIX_ED25519",
"PKIX_ED25519_PH",
"EXPERIMENTAL_LMS_SHA256",
"EXPERIMENTAL_LMOTS_SHA256"
"LMS_SHA256",
"LMOTS_SHA256"
],
"type": "string",
"title": "Public Key Details",
Expand Down
4 changes: 2 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 @@ -269,8 +269,8 @@
"PKIX_ECDSA_P521_SHA_512",
"PKIX_ED25519",
"PKIX_ED25519_PH",
"EXPERIMENTAL_LMS_SHA256",
"EXPERIMENTAL_LMOTS_SHA256"
"LMS_SHA256",
"LMOTS_SHA256"
],
"type": "string",
"title": "Public Key Details",
Expand Down
4 changes: 2 additions & 2 deletions gen/jsonschema/schemas/PublicKey.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@
"PKIX_ECDSA_P521_SHA_512",
"PKIX_ED25519",
"PKIX_ED25519_PH",
"EXPERIMENTAL_LMS_SHA256",
"EXPERIMENTAL_LMOTS_SHA256"
"LMS_SHA256",
"LMOTS_SHA256"
],
"type": "string",
"title": "Public Key Details",
Expand Down
4 changes: 2 additions & 2 deletions gen/jsonschema/schemas/PublicKeyIdentities.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,8 @@
"PKIX_ECDSA_P521_SHA_512",
"PKIX_ED25519",
"PKIX_ED25519_PH",
"EXPERIMENTAL_LMS_SHA256",
"EXPERIMENTAL_LMOTS_SHA256"
"LMS_SHA256",
"LMOTS_SHA256"
],
"type": "string",
"title": "Public Key Details",
Expand Down
4 changes: 2 additions & 2 deletions gen/jsonschema/schemas/TransparencyLogInstance.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,8 +78,8 @@
"PKIX_ECDSA_P521_SHA_512",
"PKIX_ED25519",
"PKIX_ED25519_PH",
"EXPERIMENTAL_LMS_SHA256",
"EXPERIMENTAL_LMOTS_SHA256"
"LMS_SHA256",
"LMOTS_SHA256"
],
"type": "string",
"title": "Public Key Details",
Expand Down
4 changes: 2 additions & 2 deletions gen/jsonschema/schemas/TrustedRoot.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,8 +100,8 @@
"PKIX_ECDSA_P521_SHA_512",
"PKIX_ED25519",
"PKIX_ED25519_PH",
"EXPERIMENTAL_LMS_SHA256",
"EXPERIMENTAL_LMOTS_SHA256"
"LMS_SHA256",
"LMOTS_SHA256"
],
"type": "string",
"title": "Public Key Details",
Expand Down
67 changes: 39 additions & 28 deletions gen/pb-go/common/v1/sigstore_common.pb.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

15 changes: 12 additions & 3 deletions gen/pb-python/sigstore_protobuf_specs/dev/sigstore/common/v1/__init__.py
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions gen/pb-ruby/lib/sigstore_common_pb.rb
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions gen/pb-rust/schemas/ArtifactVerificationOptions.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,8 +139,8 @@
"PKIX_ECDSA_P521_SHA_512",
"PKIX_ED25519",
"PKIX_ED25519_PH",
"EXPERIMENTAL_LMS_SHA256",
"EXPERIMENTAL_LMOTS_SHA256"
"LMS_SHA256",
"LMOTS_SHA256"
],
"type": "string",
"title": "Public Key Details",
Expand Down
4 changes: 2 additions & 2 deletions gen/pb-rust/schemas/Input.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -269,8 +269,8 @@
"PKIX_ECDSA_P521_SHA_512",
"PKIX_ED25519",
"PKIX_ED25519_PH",
"EXPERIMENTAL_LMS_SHA256",
"EXPERIMENTAL_LMOTS_SHA256"
"LMS_SHA256",
"LMOTS_SHA256"
],
"type": "string",
"title": "Public Key Details",
Expand Down
4 changes: 2 additions & 2 deletions gen/pb-rust/schemas/PublicKey.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@
"PKIX_ECDSA_P521_SHA_512",
"PKIX_ED25519",
"PKIX_ED25519_PH",
"EXPERIMENTAL_LMS_SHA256",
"EXPERIMENTAL_LMOTS_SHA256"
"LMS_SHA256",
"LMOTS_SHA256"
],
"type": "string",
"title": "Public Key Details",
Expand Down
4 changes: 2 additions & 2 deletions gen/pb-rust/schemas/PublicKeyIdentities.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,8 @@
"PKIX_ECDSA_P521_SHA_512",
"PKIX_ED25519",
"PKIX_ED25519_PH",
"EXPERIMENTAL_LMS_SHA256",
"EXPERIMENTAL_LMOTS_SHA256"
"LMS_SHA256",
"LMOTS_SHA256"
],
"type": "string",
"title": "Public Key Details",
Expand Down
4 changes: 2 additions & 2 deletions gen/pb-rust/schemas/TransparencyLogInstance.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,8 +78,8 @@
"PKIX_ECDSA_P521_SHA_512",
"PKIX_ED25519",
"PKIX_ED25519_PH",
"EXPERIMENTAL_LMS_SHA256",
"EXPERIMENTAL_LMOTS_SHA256"
"LMS_SHA256",
"LMOTS_SHA256"
],
"type": "string",
"title": "Public Key Details",
Expand Down
4 changes: 2 additions & 2 deletions gen/pb-rust/schemas/TrustedRoot.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,8 +100,8 @@
"PKIX_ECDSA_P521_SHA_512",
"PKIX_ED25519",
"PKIX_ED25519_PH",
"EXPERIMENTAL_LMS_SHA256",
"EXPERIMENTAL_LMOTS_SHA256"
"LMS_SHA256",
"LMOTS_SHA256"
],
"type": "string",
"title": "Public Key Details",
Expand Down
36 changes: 25 additions & 11 deletions gen/pb-typescript/src/__generated__/sigstore_common.ts
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

18 changes: 15 additions & 3 deletions protos/sigstore_common.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,9 +85,21 @@ enum PublicKeyDetails {
PKIX_ED25519 = 7; // See RFC8032
PKIX_ED25519_PH = 8;

// **EXPERIMENTAL**: LMS and LM-OTS variants.
EXPERIMENTAL_LMS_SHA256 = 14;
EXPERIMENTAL_LMOTS_SHA256 = 15;
// LMS and LM-OTS
//
// These keys and signatures may be used by private Sigstore
// deployments, but are not currently supported by the public
// good instance.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Do you think a comment along the lines of "here be dragons" would be good? This would cover some of the original motivation of the experimental prefix, that when using these, you should understand the cryptographic and performance consequences.

Copy link
Member Author

@woodruffw woodruffw Feb 5, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Good idea! I'll add some additional warning language here.

//
// USER WARNING: LMS and LM-OTS are both stateful signature schemes.
// Using them correctly requires discretion and careful consideration
// to ensure that individual secret keys are not used more than once.
// In addition, LM-OTS is a single-use scheme, meaning that it
// MUST NOT be used for more than one signature per LM-OTS key.
// If you cannot maintain these invariants, you MUST NOT use these
// schemes.
LMS_SHA256 = 14;
LMOTS_SHA256 = 15;

// Reserved for future additions of public key/signature algorithm types.
reserved 19 to 50;
Expand Down
Loading