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 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441
use anyhow::bail;
use bc_components::{PrivateKeyBase, Signature, PublicKeyBase, SigningPublicKey, DigestProvider};
use bc_rand::{RandomNumberGenerator, SecureRandomNumberGenerator};
use crate::{Envelope, EnvelopeError, EnvelopeEncodable, impl_envelope_encodable};
#[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:
/// - privateKeys: The signer's `PrivateKeyBase`
///
/// - Returns: The signed envelope.
pub fn sign_with(&self, private_keys: &PrivateKeyBase) -> Self {
self.sign_with_opt(private_keys, None, [])
}
#[doc(hidden)]
/// Creates a signature for the envelope's subject and returns a new envelope with a `verifiedBy: Signature` assertion.
///
/// - Parameters:
/// - privateKeys: The signer's `PrivateKeyBase`
/// - note: Optional text note to add to the `Signature`
/// - rng: The random number generator to use.
///
/// - Returns: The signed envelope.
pub fn sign_with_opt_using<D>(
&self,
private_keys: &PrivateKeyBase,
note: Option<&str>,
tag: D,
rng: &mut impl RandomNumberGenerator
) -> Self
where
D: AsRef<[u8]>,
{
let mut assertions: Vec<Envelope> = vec![];
if let Some(note) = note {
assertions.push(Self::new_assertion(known_values::NOTE, note));
}
self.sign_with_uncovered_assertions_using(private_keys, &assertions, tag, rng)
}
/// Creates a signature for the envelope's subject and returns a new envelope with a `verifiedBy: Signature` assertion.
///
/// - Parameters:
/// - privateKeys: The signer's `PrivateKeyBase`
/// - note: Optional text note to add to the `Signature`
///
/// - Returns: The signed envelope.
pub fn sign_with_opt<D>(
&self,
private_keys: &PrivateKeyBase,
note: Option<&str>,
tag: D,
) -> Self
where
D: AsRef<[u8]>,
{
let mut rng = SecureRandomNumberGenerator;
self.sign_with_opt_using(private_keys, note, tag, &mut rng)
}
#[doc(hidden)]
pub fn sign_with_using(
&self,
private_keys: &PrivateKeyBase,
rng: &mut impl RandomNumberGenerator
) -> Self {
self.sign_with_opt_using(private_keys, None, [], rng)
}
pub fn sign_with_keys<T>(
&self,
private_keys_array: &[T],
) -> Self
where
T: AsRef<PrivateKeyBase>,
{
self.sign_with_keys_opt(private_keys_array, [])
}
/// Creates several signatures for the envelope's subject and returns a new envelope with additional `verifiedBy: Signature` assertions.
///
/// - Parameters:
/// - privateKeys: An array of signers' `PrivateKeyBase`s.
///
/// - Returns: The signed envelope.
pub fn sign_with_keys_opt<D, T>(
&self,
private_keys_array: &[T],
tag: D,
) -> Self
where
D: AsRef<[u8]> + Clone,
T: AsRef<PrivateKeyBase>,
{
let mut rng = SecureRandomNumberGenerator;
self.sign_with_keys_opt_using(private_keys_array, tag, &mut rng)
}
#[doc(hidden)]
/// Creates several signatures for the envelope's subject and returns a new envelope with additional `verifiedBy: Signature` assertions.
///
/// - Parameters:
/// - privateKeys: An array of signers' `PrivateKeyBase`s.
/// - rng: The random number generator to use.
///
/// - Returns: The signed envelope.
pub fn sign_with_keys_opt_using<D, T>(
&self,
private_keys_array: &[T],
tag: D,
rng: &mut impl RandomNumberGenerator
) -> Self
where
D: AsRef<[u8]> + Clone,
T: AsRef<PrivateKeyBase>,
{
private_keys_array.iter().fold(self.clone(), |envelope, private_key| {
envelope.sign_with_opt_using(private_key.as_ref(), None, tag.clone(), rng)
})
}
#[doc(hidden)]
/// Creates a signature for the envelope's subject and returns a new envelope with a `verifiedBy: Signature` assertion.
///
/// - Parameters:
/// - privateKeys: The signer's `PrivateKeyBase`
/// - uncoveredAssertions: Assertions to add to the `Signature`.
/// - rng: The random number generator to use.
///
/// - Returns: The signed envelope.
pub fn sign_with_uncovered_assertions_using<D>(
&self,
private_keys: &PrivateKeyBase,
uncovered_assertions: &[Self],
tag: D,
rng: &mut impl RandomNumberGenerator
) -> Self
where
D: AsRef<[u8]>,
{
let signing_private_key = private_keys.signing_private_key();
let digest = *self.subject().digest().data();
let signature = Envelope::new(signing_private_key.schnorr_sign_using(digest, tag, rng))
.add_assertion_envelopes(uncovered_assertions)
.unwrap();
self.add_assertion(known_values::VERIFIED_BY, signature)
}
/// Creates a signature for the envelope's subject and returns a new envelope with a `verifiedBy: Signature` assertion.
///
/// - Parameters:
/// - privateKeys: The signer's `PrivateKeyBase`
/// - uncoveredAssertions: Assertions to add to the `Signature`.
///
/// - Returns: The signed envelope.
pub fn sign_with_uncovered_assertions<D>(
&self,
private_keys: &PrivateKeyBase,
uncovered_assertions: &[Self],
tag: D,
) -> Self
where
D: AsRef<[u8]>,
{
let mut rng = SecureRandomNumberGenerator;
self.sign_with_uncovered_assertions_using(private_keys, uncovered_assertions, tag, &mut rng)
}
/// 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, Envelope::new(signature));
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) -> anyhow::Result<Vec<Signature>> {
let verified_by = known_values::VERIFIED_BY;
self
.assertions_with_predicate(verified_by).into_iter()
.map(|assertion| assertion.object().unwrap().extract_subject::<Signature>())
.collect()
}
/// Returns whether the given signature is valid.
///
/// - Parameters:
/// - signature: The `Signature` to be checked.
/// - publicKeys: The potential signer's `PublicKeyBase`.
///
/// - Returns: `true` if the signature is valid for this envelope's subject, `false` otherwise.
pub fn is_verified_signature(
&self,
signature: &Signature,
public_keys: &PublicKeyBase,
) -> bool {
self.is_signature_from_key(signature, public_keys.signing_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.
/// - publicKeys: The potential signer's `PublicKeyBase`.
///
/// - Returns: This envelope.
///
/// - Throws: Throws `EnvelopeError.unverifiedSignature` if the signature is not valid.
/// valid.
pub fn verify_signature(
&self,
signature: &Signature,
public_keys: &PublicKeyBase,
) -> Result<Self, EnvelopeError> {
self.verify_signature_from_key(signature, public_keys.signing_public_key())
}
/// Returns whether the envelope's subject has a valid signature from the given public key.
///
/// - Parameters:
/// - publicKeys: The potential signer's `PublicKeyBase`.
///
/// - 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_keys: &PublicKeyBase,
) -> anyhow::Result<bool> {
self.has_some_signature_from_key(public_keys.signing_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:
/// - publicKeys: The potential signer's `PublicKeyBase`.
///
/// - Returns: This envelope.
///
/// - Throws: Throws `EnvelopeError.unverifiedSignature` if the signature is not valid.
/// valid.
pub fn verify_signature_from(
&self,
public_keys: &PublicKeyBase,
) -> anyhow::Result<Self> {
self.verify_has_some_signature_from_key(public_keys.signing_public_key())
}
/// Checks whether the envelope's subject has a set of signatures.
pub fn has_signatures_from<T>(
&self,
public_keys_array: &[T],
) -> anyhow::Result<bool>
where
T: AsRef<PublicKeyBase>,
{
self.has_signatures_from_threshold(public_keys_array, None)
}
/// Returns whether the envelope's subject has some threshold of signatures.
///
/// If `threshold` is `nil`, then *all* signers in `publicKeysArray` must have
/// signed. If `threshold` is `1`, then at least one signer must have signed.
///
/// - Parameters:
/// - publicKeysArray: An array of potential signers' `PublicKeyBase`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<T>(
&self,
public_keys_array: &[T],
threshold: Option<usize>,
) -> anyhow::Result<bool>
where
T: AsRef<PublicKeyBase>,
{
let public_keys = public_keys_array
.iter()
.map(|public_key| public_key.as_ref())
.collect::<Vec<_>>();
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<T>(
&self,
public_keys_array: &[T],
) -> anyhow::Result<Self>
where
T: AsRef<PublicKeyBase>,
{
self.verify_signatures_from_threshold(public_keys_array, None)
}
/// Checks whether the envelope's subject has some threshold of signatures.
///
/// If `threshold` is `nil`, then *all* signers in `publicKeysArray` 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:
/// - publicKeysArray: An array of potential signers' `PublicKeyBase`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<T>(
&self,
public_keys_array: &[T],
threshold: Option<usize>,
) -> anyhow::Result<Self>
where
T: AsRef<PublicKeyBase>,
{
let public_keys = public_keys_array
.iter()
.map(|public_key| public_key.as_ref())
.collect::<Vec<_>>();
self.verify_signatures_from_keys_threshold(&public_keys, threshold)
}
}
#[doc(hidden)]
impl Envelope {
fn is_signature_from_key<T>(
&self,
signature: &Signature,
key: T
) -> bool
where
T: AsRef<SigningPublicKey>,
{
key.as_ref().verify(signature, self.subject().digest().as_ref())
}
fn verify_signature_from_key(
&self,
signature: &Signature,
key: &SigningPublicKey
) -> Result<Self, EnvelopeError> {
if !self.is_signature_from_key(signature, key) {
return Err(EnvelopeError::UnverifiedSignature);
}
Ok(self.clone())
}
fn has_some_signature_from_key<T>(
&self,
key: T
) -> anyhow::Result<bool>
where
T: AsRef<SigningPublicKey>,
{
let signatures = self.signatures();
let signatures = signatures?;
let result = signatures.iter().any(|signature| {
self.is_signature_from_key(signature, key.as_ref())
});
Ok(result)
}
fn verify_has_some_signature_from_key(
&self,
key: &SigningPublicKey
) -> anyhow::Result<Self> {
if !self.has_some_signature_from_key(key)? {
bail!(EnvelopeError::UnverifiedSignature);
}
Ok(self.clone())
}
fn has_signatures_from_keys_threshold<T>(
&self,
keys: &[T],
threshold: Option<usize>
) -> anyhow::Result<bool>
where
T: AsRef<SigningPublicKey>,
{
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<T>(
&self,
keys: &[T],
threshold: Option<usize>
) -> anyhow::Result<Self>
where
T: AsRef<SigningPublicKey>,
{
if !self.has_signatures_from_keys_threshold(keys, threshold)? {
bail!(EnvelopeError::UnverifiedSignature);
}
Ok(self.clone())
}
}
impl_envelope_encodable!(Signature);