Refactoring and examples for key interface #123
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Xynnn007
force-pushed
the
main
branch
2 times, most recently
from
e62c788
to
5a708e3
Compare
flavio
previously approved these changes
Sep 7, 2022
Xynnn007
force-pushed
the
main
branch
2 times, most recently
from
9cf6d77
to
0247914
Compare
added 2 commits
September 7, 2022 21:47
- Wrap the Signer and KeyPair trait object inside enums - Wrap ECDSA keys inside enum Signed-off-by: Xynnn007 <mading.ma@alibaba-inc.com>
- key pair generation and export - key pair generation, signing and verification - key pair import - docs for all above Signed-off-by: Xynnn007 <mading.ma@alibaba-inc.com>
flavio
approved these changes
Sep 8, 2022
lukehinds
approved these changes
Sep 8, 2022
flavio
added a commit
to flavio/sigstore-rs
that referenced
this pull request
Oct 7, 2022
Enhancements ============ * update user-agent value to be specific to sigstore-rs (sigstore#122) * remove /api/v1/version from client by (sigstore#121) * crate async fulcio client (sigstore#132) * Removed ring dependency (sigstore#127) Others ====== * Update dependencies * Refactoring and examples for key interface (sigstore#123) * Fix doc test failures (sigstore#136) Contributors ============ * Bob Callaway (@bobcallaway) * Bob McWhirter (@bobmcwhirter) * Flavio Castelli (@flavio) * Luke Hinds (@lukehinds) * Xynnn (@Xynnn007) Signed-off-by: Flavio Castelli <fcastelli@suse.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Due to #27, there is a need to refactor the key_interface to deal with the following current problems:
signing_keymodule, they must import the crates into theCargo.toml, likep256,p384,signature,digestetc. It is better for users not to need to care about the underlying Elliptic Curves. They can directly usesigstorecrate without import any other crates to do all the key related operations.SigStoreSigner. AlsoSigStoreSigneris somehow overlapped functionally withSignertrait object. It is good to combine them, and give a more easy way for users to convert a PEM/DER encoded private key into an object who implementssign.Thus this PR includes
enums.Signertrait object andSigStoreSignerstruct into anenumnamedSigStoreSigner.Release Note
Added the new following APIs:
SigStoreKeyPairenumto_sigstore_signer()forSigStoreKeyPairto_sigstore_keypair()forSigStoreSignerECDSAKeysenum, a wrapper forEcdsaKeysChanged the following
structs:SigStoreSignerinto anenumChanged the following APIs:
SigStoreSigner:SigStoreSigner::new(SigningScheme::ECDSA_P256_SHA256_ASN1)->SigningScheme::ECDSA_P256_SHA256_ASN1.create_signer()Added the following examples due to typical scenarios:
Deleted the origin example:
To make it clear, an overview architecture of the implementation for key-interface was included.
Documentation
Please refer to the
key_interfaceexamples for the usages.