1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323
use anyhow::{bail, Result};
use bc_components::{DigestProvider, Signature, Signer, SigningOptions, Verifier};
use crate::{Envelope, EnvelopeError};
#[cfg(feature = "known_value")]
use crate::extension::known_values;
/// Support for signing envelopes and verifying signatures.
impl Envelope {
/// Creates a signature for the envelope's subject and returns a new envelope with a `verifiedBy: Signature` assertion.
///
/// - Parameters:
/// - private_key: The signer's `SigningPrivateKey`
///
/// - Returns: The signed envelope.
pub fn add_signature(&self, private_key: &dyn Signer) -> Self {
self.add_signature_opt(private_key, None, None)
}
#[doc(hidden)]
/// Creates a signature for the envelope's subject and returns a new envelope with a `verifiedBy: Signature` assertion.
///
/// - Parameters:
/// - private_key: A signer's `PrivateKeyBase` or `SigningPrivateKey`.
/// - options: Optional signing options.
/// - note: Optional text note to add to the `Signature`
///
/// - Returns: The signed envelope.
pub fn add_signature_opt(
&self,
private_key: &dyn Signer,
options: Option<SigningOptions>,
note: Option<&str>,
) -> Self {
let mut assertions: Vec<Envelope> = vec![];
if let Some(note) = note {
assertions.push(Self::new_assertion(known_values::NOTE, note));
}
self.add_signatures_with_uncovered_assertions(&assertions, private_key, options)
}
#[doc(hidden)]
/// Creates several signatures for the envelope's subject and returns a new envelope with additional `verifiedBy: Signature` assertions.
///
/// - Parameters:
/// - private_keys: An array of signers' `SigningPrivateKey`s.
///
/// - Returns: The signed envelope.
pub fn add_signatures(&self, private_keys: &[&dyn Signer]) -> Self {
private_keys.iter().fold(self.clone(), |envelope, private_key| {
envelope.add_signature(*private_key)
})
}
#[doc(hidden)]
/// Creates several signatures for the envelope's subject and returns a new envelope with additional `verifiedBy: Signature` assertions.
///
/// - Parameters:
/// - private_keys: An array of signers' `SigningPrivateKey`s and optional `SigningOptions`.
///
/// - Returns: The signed envelope.
pub fn add_signatures_opt(&self, private_keys: &[(&dyn Signer, Option<SigningOptions>)]) -> Self {
private_keys.iter().fold(self.clone(), |envelope, (private_key, options)| {
envelope.add_signature_opt(*private_key, options.clone(), None)
})
}
#[doc(hidden)]
/// Creates a signature for the envelope's subject and returns a new envelope with a `verifiedBy: Signature` assertion.
///
/// - Parameters:
/// - private_key: The signer's `PrivateKeyBase`
/// - uncoveredAssertions: Assertions to add to the `Signature`.
/// - rng: The random number generator to use.
///
/// - Returns: The signed envelope.
fn add_signatures_with_uncovered_assertions(
&self,
uncovered_assertions: &[Self],
private_key: &dyn Signer,
options: Option<SigningOptions>,
) -> Self
{
let digest = *self.subject().digest().data();
let signature = Envelope::new(private_key.sign_with_options(&digest as &dyn AsRef<[u8]>, options).unwrap())
.add_assertion_envelopes(uncovered_assertions)
.unwrap();
self.add_assertion(known_values::VERIFIED_BY, signature)
}
/// Convenience constructor for a `verifiedBy: Signature` assertion envelope.
///
/// - Parameters:
/// - signature: The `Signature` for the object.
/// - note: An optional note to be added to the `Signature`.
///
/// - Returns: The new assertion envelope.
pub fn make_verified_by_signature(
&self,
signature: &Signature,
note: Option<&str>
) -> Self {
let verified_by = known_values::VERIFIED_BY;
let mut envelope = Envelope::new_assertion(verified_by, signature.clone());
if let Some(note) = note {
envelope = envelope.add_assertion(known_values::NOTE, note);
}
envelope
}
/// Returns an array of `Signature`s from all of the envelope's `verifiedBy` predicates.
///
/// - Throws: Throws an exception if any `verifiedBy` assertion doesn't contain a
/// valid `Signature` as its object.
pub fn signatures(&self) -> Result<Vec<Signature>> {
let verified_by = known_values::VERIFIED_BY;
self
.assertions_with_predicate(verified_by).into_iter()
.map(|assertion| assertion.as_object().unwrap().extract_subject::<Signature>())
.collect()
}
/// Returns whether the given signature is valid.
///
/// - Parameters:
/// - signature: The `Signature` to be checked.
/// - public_key: The potential signer's `Verifier`.
///
/// - Returns: `true` if the signature is valid for this envelope's subject, `false` otherwise.
pub fn is_verified_signature(
&self,
signature: &Signature,
public_key: &dyn Verifier,
) -> bool {
self.is_signature_from_key(signature, public_key)
}
/// Checks whether the given signature is valid for the given public key.
///
/// Used for chaining a series of operations that include validating signatures.
///
/// - Parameters:
/// - signature: The `Signature` to be checked.
/// - public_key: The potential signer's `Verifier`.
///
/// - Returns: This envelope.
///
/// - Throws: Throws `EnvelopeError.unverifiedSignature` if the signature is not valid.
/// valid.
pub fn verify_signature(
&self,
signature: &Signature,
public_key: &dyn Verifier,
) -> Result<Self> {
self.verify_signature_from_key(signature, public_key)
}
/// Returns whether the envelope's subject has a valid signature from the given public key.
///
/// - Parameters:
/// - public_key: The potential signer's `Verifier`.
///
/// - Returns: `true` if the signature is valid for this envelope's subject, `false` otherwise.
///
/// - Throws: Throws an exception if any `verifiedBy` assertion doesn't contain a
/// valid `Signature` as its object.
pub fn has_signature_from(
&self,
public_key: &dyn Verifier,
) -> Result<bool> {
self.has_some_signature_from_key(public_key)
}
/// Returns whether the envelope's subject has a valid signature from the given public key.
///
/// Used for chaining a series of operations that include validating signatures.
///
/// - Parameters:
/// - public_key: The potential signer's `Verifier`.
///
/// - Returns: This envelope.
///
/// - Throws: Throws `EnvelopeError.unverifiedSignature` if the signature is not valid.
/// valid.
pub fn verify_signature_from(
&self,
public_key: &dyn Verifier,
) -> Result<Self> {
self.verify_has_some_signature_from_key(public_key)
}
/// Checks whether the envelope's subject has a set of signatures.
pub fn has_signatures_from(
&self,
public_keys: &[&dyn Verifier],
) -> Result<bool> {
self.has_signatures_from_threshold(public_keys, None)
}
/// Returns whether the envelope's subject has some threshold of signatures.
///
/// If `threshold` is `nil`, then *all* signers in `public_keys` must have
/// signed. If `threshold` is `1`, then at least one signer must have signed.
///
/// - Parameters:
/// - public_keys: An array of potential signers' `Verifier`s.
/// - threshold: Optional minimum number of signers.
///
/// - Returns: `true` if the threshold of valid signatures is met, `false` otherwise.
///
/// - Throws: Throws an exception if any `verifiedBy` assertion doesn't contain a
/// valid `Signature` as its object.
pub fn has_signatures_from_threshold(
&self,
public_keys: &[&dyn Verifier],
threshold: Option<usize>,
) -> Result<bool> {
self.has_signatures_from_keys_threshold(public_keys, threshold)
}
/// Checks whether the envelope's subject has a set of signatures.
pub fn verify_signatures_from(
&self,
public_keys: &[&dyn Verifier],
) -> Result<Self> {
self.verify_signatures_from_threshold(public_keys, None)
}
/// Checks whether the envelope's subject has some threshold of signatures.
///
/// If `threshold` is `nil`, then *all* signers in `public_keys` must have
/// signed. If `threshold` is `1`, then at least one signer must have signed.
///
/// Used for chaining a series of operations that include validating signatures.
///
/// - Parameters:
/// - public_keys: An array of potential signers' `Verifier`s.
/// - threshold: Optional minimum number of signers.
///
/// - Returns: This envelope.
///
/// - Throws: Throws an exception if the threshold of valid signatures is not met.
pub fn verify_signatures_from_threshold(
&self,
public_keys: &[&dyn Verifier],
threshold: Option<usize>,
) -> Result<Self> {
self.verify_signatures_from_keys_threshold(public_keys, threshold)
}
}
#[doc(hidden)]
impl Envelope {
fn is_signature_from_key(
&self,
signature: &Signature,
key: &dyn Verifier
) -> bool {
key.verify(signature, self.subject().digest().as_ref())
}
fn verify_signature_from_key(
&self,
signature: &Signature,
key: &dyn Verifier,
) -> Result<Self> {
if !self.is_signature_from_key(signature, key) {
bail!(EnvelopeError::UnverifiedSignature);
}
Ok(self.clone())
}
fn has_some_signature_from_key(
&self,
key: &dyn Verifier
) -> Result<bool> {
let signatures = self.signatures();
let signatures = signatures?;
let result = signatures.iter().any(|signature| {
self.is_signature_from_key(signature, key)
});
Ok(result)
}
fn verify_has_some_signature_from_key(
&self,
key: &dyn Verifier
) -> Result<Self> {
if !self.has_some_signature_from_key(key)? {
bail!(EnvelopeError::UnverifiedSignature);
}
Ok(self.clone())
}
fn has_signatures_from_keys_threshold(
&self,
keys: &[&dyn Verifier],
threshold: Option<usize>
) -> Result<bool> {
let threshold = threshold.unwrap_or(keys.len());
let mut count = 0;
for key in keys {
if self.clone().has_some_signature_from_key(*key)? {
count += 1;
if count >= threshold {
return Ok(true);
}
}
}
Ok(false)
}
fn verify_signatures_from_keys_threshold(
&self,
keys: &[&dyn Verifier],
threshold: Option<usize>
) -> Result<Self> {
if !self.has_signatures_from_keys_threshold(keys, threshold)? {
bail!(EnvelopeError::UnverifiedSignature);
}
Ok(self.clone())
}
}