criticaltrust 0.5.1

Digital signatures implementation for CriticalUp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

// SPDX-FileCopyrightText: The Ferrocene Developers
// SPDX-License-Identifier: MIT OR Apache-2.0

use crate::keys::newtypes::{PayloadBytes, SignatureBytes};
use crate::keys::PublicKey;
use crate::Error;

/// Pair of public and private keys capable of signing.
///
/// A key pair is required whenever signing operations are performed, and the trait allows swapping
/// implementations depending on the use case. The private portion of the pair doesn't have to be
/// stored on the local system. For example, it's possible and recommended for implementations of
/// [`KeyPair`] to rely on a Hardware Security Module.
pub trait KeyPair {
    /// Retrieve the [`PublicKey`] associated with this key pair.
    fn public(&self) -> &PublicKey;

    /// Sign the provided data with this key pair, returning the bytes of the signature.
    fn sign(
        &self,
        data: &PayloadBytes<'_>,
    ) -> impl std::future::Future<Output = Result<SignatureBytes<'static>, Error>> + Send;
}