shrike 0.1.1

AT Protocol library for Rust
Documentation 
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

//! P-256 and secp256k1 signing and verification for AT Protocol.
//!
//! Supports two elliptic curve families: P-256 (NIST P-256) and secp256k1
//! (Bitcoin curve). Both implement SigningKey and VerifyingKey traits.
//! Use parse_did_key to extract keys from did:key identifiers.

pub mod did_key;
pub mod k256_impl;
pub mod p256_impl;
pub mod signature;

pub use did_key::parse_did_key;
pub use k256_impl::{K256SigningKey, K256VerifyingKey};
pub use p256_impl::{P256SigningKey, P256VerifyingKey};
pub use signature::Signature;

use thiserror::Error;

#[derive(Debug, Error)]
pub enum CryptoError {
    #[error("invalid key: {0}")]
    InvalidKey(String),
    #[error("invalid signature: {0}")]
    InvalidSignature(String),
    #[error("signing failed: {0}")]
    SigningFailed(String),
}

/// Signing key for producing ECDSA signatures over arbitrary content.
pub trait SigningKey: Send + Sync {
    /// Return the corresponding public verification key.
    fn public_key(&self) -> &dyn VerifyingKey;
    /// Sign the given content and return a compact 64-byte ECDSA signature.
    fn sign(&self, content: &[u8]) -> Result<Signature, CryptoError>;
}

/// Verification key for checking ECDSA signatures.
pub trait VerifyingKey: Send + Sync {
    /// Serialize as a 33-byte SEC1 compressed point.
    fn to_bytes(&self) -> [u8; 33];
    /// Verify a signature over the given content. Returns an error if invalid.
    fn verify(&self, content: &[u8], sig: &Signature) -> Result<(), CryptoError>;
    /// Return the `did:key:z...` identifier for this public key.
    fn did_key(&self) -> String;
    /// Return the z-prefixed base58btc multibase encoding of this public key.
    fn multibase(&self) -> String;
}