summaryrefslogtreecommitdiffstats
path: root/vendor/signature/src/signer.rs
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-05-04 12:41:41 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-05-04 12:41:41 +0000
commit10ee2acdd26a7f1298c6f6d6b7af9b469fe29b87 (patch)
treebdffd5d80c26cf4a7a518281a204be1ace85b4c1 /vendor/signature/src/signer.rs
parentReleasing progress-linux version 1.70.0+dfsg1-9~progress7.99u1. (diff)
downloadrustc-10ee2acdd26a7f1298c6f6d6b7af9b469fe29b87.tar.xz
rustc-10ee2acdd26a7f1298c6f6d6b7af9b469fe29b87.zip
Merging upstream version 1.70.0+dfsg2.
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'vendor/signature/src/signer.rs')
-rw-r--r--vendor/signature/src/signer.rs136
1 files changed, 136 insertions, 0 deletions
diff --git a/vendor/signature/src/signer.rs b/vendor/signature/src/signer.rs
new file mode 100644
index 000000000..c025711fe
--- /dev/null
+++ b/vendor/signature/src/signer.rs
@@ -0,0 +1,136 @@
+//! Traits for generating digital signatures
+
+use crate::{error::Error, Signature};
+
+#[cfg(feature = "digest-preview")]
+use crate::digest::Digest;
+
+#[cfg(feature = "rand-preview")]
+use crate::rand_core::{CryptoRng, RngCore};
+
+/// Sign the provided message bytestring using `Self` (e.g. a cryptographic key
+/// or connection to an HSM), returning a digital signature.
+pub trait Signer<S: Signature> {
+ /// Sign the given message and return a digital signature
+ fn sign(&self, msg: &[u8]) -> S {
+ self.try_sign(msg).expect("signature operation failed")
+ }
+
+ /// Attempt to sign the given message, returning a digital signature on
+ /// success, or an error if something went wrong.
+ ///
+ /// The main intended use case for signing errors is when communicating
+ /// with external signers, e.g. cloud KMS, HSMs, or other hardware tokens.
+ fn try_sign(&self, msg: &[u8]) -> Result<S, Error>;
+}
+
+/// Sign the provided message bytestring using `&mut Self` (e.g., an evolving
+/// cryptographic key), returning a digital signature.
+pub trait SignerMut<S: Signature> {
+ /// Sign the given message, update the state, and return a digital signature
+ fn sign(&mut self, msg: &[u8]) -> S {
+ self.try_sign(msg).expect("signature operation failed")
+ }
+
+ /// Attempt to sign the given message, updating the state, and returning a
+ /// digital signature on success, or an error if something went wrong.
+ ///
+ /// Signing can fail, e.g., if the number of time periods allowed by the
+ /// current key is exceeded.
+ fn try_sign(&mut self, msg: &[u8]) -> Result<S, Error>;
+}
+
+// Blanket impl of SignerMut for all Signer types
+impl<T, S> SignerMut<S> for T
+where
+ T: Signer<S>,
+ S: Signature,
+{
+ fn try_sign(&mut self, msg: &[u8]) -> Result<S, Error> {
+ T::try_sign(self, msg)
+ }
+}
+
+/// Sign the given prehashed message [`Digest`] using `Self`.
+///
+/// ## Notes
+///
+/// This trait is primarily intended for signature algorithms based on the
+/// [Fiat-Shamir heuristic], a method for converting an interactive
+/// challenge/response-based proof-of-knowledge protocol into an offline
+/// digital signature through the use of a random oracle, i.e. a digest
+/// function.
+///
+/// The security of such protocols critically rests upon the inability of
+/// an attacker to solve for the output of the random oracle, as generally
+/// otherwise such signature algorithms are a system of linear equations and
+/// therefore doing so would allow the attacker to trivially forge signatures.
+///
+/// To prevent misuse which would potentially allow this to be possible, this
+/// API accepts a [`Digest`] instance, rather than a raw digest value.
+///
+/// [Fiat-Shamir heuristic]: https://en.wikipedia.org/wiki/Fiat%E2%80%93Shamir_heuristic
+#[cfg(feature = "digest-preview")]
+#[cfg_attr(docsrs, doc(cfg(feature = "digest-preview")))]
+pub trait DigestSigner<D, S>
+where
+ D: Digest,
+ S: Signature,
+{
+ /// Sign the given prehashed message [`Digest`], returning a signature.
+ ///
+ /// Panics in the event of a signing error.
+ fn sign_digest(&self, digest: D) -> S {
+ self.try_sign_digest(digest)
+ .expect("signature operation failed")
+ }
+
+ /// Attempt to sign the given prehashed message [`Digest`], returning a
+ /// digital signature on success, or an error if something went wrong.
+ fn try_sign_digest(&self, digest: D) -> Result<S, Error>;
+}
+
+/// Sign the given message using the provided external randomness source.
+#[cfg(feature = "rand-preview")]
+#[cfg_attr(docsrs, doc(cfg(feature = "rand-preview")))]
+pub trait RandomizedSigner<S: Signature> {
+ /// Sign the given message and return a digital signature
+ fn sign_with_rng(&self, rng: impl CryptoRng + RngCore, msg: &[u8]) -> S {
+ self.try_sign_with_rng(rng, msg)
+ .expect("signature operation failed")
+ }
+
+ /// Attempt to sign the given message, returning a digital signature on
+ /// success, or an error if something went wrong.
+ ///
+ /// The main intended use case for signing errors is when communicating
+ /// with external signers, e.g. cloud KMS, HSMs, or other hardware tokens.
+ fn try_sign_with_rng(&self, rng: impl CryptoRng + RngCore, msg: &[u8]) -> Result<S, Error>;
+}
+
+/// Combination of [`DigestSigner`] and [`RandomizedSigner`] with support for
+/// computing a signature over a digest which requires entropy from an RNG.
+#[cfg(all(feature = "digest-preview", feature = "rand-preview"))]
+#[cfg_attr(docsrs, doc(cfg(feature = "digest-preview")))]
+#[cfg_attr(docsrs, doc(cfg(feature = "rand-preview")))]
+pub trait RandomizedDigestSigner<D, S>
+where
+ D: Digest,
+ S: Signature,
+{
+ /// Sign the given prehashed message `Digest`, returning a signature.
+ ///
+ /// Panics in the event of a signing error.
+ fn sign_digest_with_rng(&self, rng: impl CryptoRng + RngCore, digest: D) -> S {
+ self.try_sign_digest_with_rng(rng, digest)
+ .expect("signature operation failed")
+ }
+
+ /// Attempt to sign the given prehashed message `Digest`, returning a
+ /// digital signature on success, or an error if something went wrong.
+ fn try_sign_digest_with_rng(
+ &self,
+ rng: impl CryptoRng + RngCore,
+ digest: D,
+ ) -> Result<S, Error>;
+}