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
//! Module for signing and verifying data.
//!
//! ```rust
//! use std::convert::TryInto;
//!
//! use devolutions_crypto::signing_key::{generate_signing_keypair, SigningKeyVersion, SigningKeyPair, SigningPublicKey};
//! use devolutions_crypto::signature::{sign, Signature, SignatureVersion};
//!
//! let keypair: SigningKeyPair = generate_signing_keypair(SigningKeyVersion::Latest);
//! let public_key: SigningPublicKey = keypair.get_public_key();
//!
//! // You can sign data using the keypair.
//! let signature: Signature = sign(b"this is some test data", &keypair, SignatureVersion::Latest);
//!
//! // You can then verify if the signature is valid
//! assert!(signature.verify(b"this is some test data", &public_key));
//! assert!(!signature.verify(b"this is some wrong test data", &public_key));
//!
//! // You can serialize the signature to and from a byte array.
//! let signature_bytes: Vec<u8> = signature.into();
//!
//! let signature: Signature = signature_bytes.as_slice().try_into().expect("This signature should be valid");
//!
//! assert!(signature.verify(b"this is some test data", &public_key));
//! assert!(!signature.verify(b"this is some wrong test data", &public_key));
//! ```
mod signature_v1;
use super::DataType;
use super::Error;
use super::Header;
use super::HeaderType;
use super::Result;
use super::SignatureSubtype;
pub use super::SignatureVersion;
use super::signing_key::{SigningKeyPair, SigningPublicKey};
use signature_v1::SignatureV1;
use std::convert::TryFrom;
#[cfg(feature = "fuzz")]
use arbitrary::Arbitrary;
/// A versionned signature. Can be used to validate if some data has been tampered.
#[derive(Clone, Debug)]
#[cfg_attr(feature = "fuzz", derive(Arbitrary))]
pub struct Signature {
pub(crate) header: Header<Signature>,
payload: SignaturePayload,
}
impl HeaderType for Signature {
type Version = SignatureVersion;
type Subtype = SignatureSubtype;
fn data_type() -> DataType {
DataType::Signature
}
}
#[derive(Clone, Debug)]
#[cfg_attr(feature = "fuzz", derive(Arbitrary))]
enum SignaturePayload {
V1(SignatureV1),
}
/// Sign some data with a keypair so that anyone knowing the public part of it can verify the signature.
/// # Arguments
/// * `data` - The data you want to sign
/// * `keypair` - The keypair to use to sign the data. Note that the public part of the keypair is also required to sign the data.
/// * `version` - Version of the signature scheme to use. Use `SignatureVersion::Latest` if you're not dealing with shared data.
/// # Returns
/// Returns a `Signature` that can be used to verify if the data has been tempered with or if.
/// # Example
/// ```rust
/// use devolutions_crypto::signing_key::{generate_signing_keypair, SigningKeyVersion, SigningKeyPair};
/// use devolutions_crypto::signature::{sign, Signature, SignatureVersion};
///
/// let keypair: SigningKeyPair = generate_signing_keypair(SigningKeyVersion::Latest);
/// let signature: Signature = sign(b"this is some test data", &keypair, SignatureVersion::Latest);
/// ```
pub fn sign(data: &[u8], keypair: &SigningKeyPair, version: SignatureVersion) -> Signature {
let mut header = Header::default();
let payload = match version {
SignatureVersion::V1 | SignatureVersion::Latest => {
header.version = SignatureVersion::V1;
SignaturePayload::V1(SignatureV1::sign(data, keypair))
}
};
Signature { header, payload }
}
impl Signature {
/// Verify if the signature matches with the specified data and key.
/// # Arguments
/// * `data` - The data that's signed.
/// * `public_key` - The public part of the keypair used to sign the data.
/// # Returns
/// Returns true if the signature is valid and false if it doesn't.
/// # Example
/// ```rust
/// use devolutions_crypto::signing_key::{generate_signing_keypair, SigningKeyVersion, SigningKeyPair};
/// use devolutions_crypto::signature::{sign, Signature, SignatureVersion};
///
/// let keypair: SigningKeyPair = generate_signing_keypair(SigningKeyVersion::Latest);
/// let signature: Signature = sign(b"this is some test data", &keypair, SignatureVersion::Latest);
///
/// assert!(signature.verify(b"this is some test data", &keypair.get_public_key()));
/// ```
pub fn verify(&self, data: &[u8], public_key: &SigningPublicKey) -> bool {
match &self.payload {
SignaturePayload::V1(x) => x.verify(data, public_key),
}
}
}
impl From<Signature> for Vec<u8> {
/// Serialize the structure into a `Vec<u8>`, for storage, transmission or use in another language.
fn from(data: Signature) -> Self {
let mut header: Self = data.header.into();
let mut payload: Self = data.payload.into();
header.append(&mut payload);
header
}
}
impl TryFrom<&[u8]> for Signature {
type Error = Error;
/// Parses the data. Can return an Error of the data is invalid or unrecognized.
fn try_from(data: &[u8]) -> Result<Self> {
if data.len() < Header::len() {
return Err(Error::InvalidLength);
};
let header = Header::try_from(&data[0..Header::len()])?;
let payload = match header.version {
SignatureVersion::V1 => {
SignaturePayload::V1(SignatureV1::try_from(&data[Header::len()..])?)
}
_ => return Err(Error::UnknownVersion),
};
Ok(Self { header, payload })
}
}
impl From<SignaturePayload> for Vec<u8> {
fn from(data: SignaturePayload) -> Self {
match data {
SignaturePayload::V1(x) => x.into(),
}
}
}
#[test]
fn test_signature_v1() {
use std::convert::TryInto;
let data = b"this is a test";
let wrong_data = b"this is wrong";
let keypair = crate::signing_key::generate_signing_keypair(crate::SigningKeyVersion::V1);
let public = keypair.get_public_key();
let keypair2 = crate::signing_key::generate_signing_keypair(crate::SigningKeyVersion::V1);
let public2 = keypair2.get_public_key();
let sig1 = sign(data, &keypair, SignatureVersion::V1);
assert!(sig1.verify(data, &public));
assert!(!sig1.verify(data, &public2));
assert!(!sig1.verify(wrong_data, &public));
assert!(!sig1.verify(wrong_data, &public2));
let keypair_bytes: Vec<u8> = keypair.into();
let public_bytes: Vec<u8> = public.into();
let keypair_parsed: SigningKeyPair = (keypair_bytes.as_slice()).try_into().unwrap();
let public_parsed: SigningPublicKey = (public_bytes.as_slice()).try_into().unwrap();
let sig2 = sign(data, &keypair_parsed, SignatureVersion::V1);
assert!(sig1.verify(data, &public_parsed));
assert!(sig2.verify(data, &public_parsed));
}