noosphere-core 0.18.1

Core data types of the Rust Noosphere implementation
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
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64

use crate::data::Mnemonic;
use anyhow::{anyhow, Result};
use bip39::{Language, Mnemonic as BipMnemonic};
use ed25519_zebra::{SigningKey as Ed25519PrivateKey, VerificationKey as Ed25519PublicKey};
use ucan::crypto::did::KeyConstructorSlice;
use ucan_key_support::{
    ed25519::{bytes_to_ed25519_key, Ed25519KeyMaterial, ED25519_MAGIC_BYTES},
    rsa::{bytes_to_rsa_key, RSA_MAGIC_BYTES},
};

/// A common set of DID Key formats that are supported by this crate
// TODO: Conditional web crypto support
pub const SUPPORTED_KEYS: &KeyConstructorSlice = &[
    (ED25519_MAGIC_BYTES, bytes_to_ed25519_key),
    (RSA_MAGIC_BYTES, bytes_to_rsa_key),
];

/// Produce a unique [Ed25519KeyMaterial] for general purpose use cases
pub fn generate_ed25519_key() -> Ed25519KeyMaterial {
    let private_key = Ed25519PrivateKey::new(rand::thread_rng());
    let public_key = Ed25519PublicKey::from(&private_key);
    Ed25519KeyMaterial(public_key, Some(private_key))
}

/// Restore an [Ed25519KeyMaterial] from a [Mnemonic]
pub fn restore_ed25519_key(mnemonic: &str) -> Result<Ed25519KeyMaterial> {
    let mnemonic = BipMnemonic::from_phrase(mnemonic, Language::English)?;
    let private_key = Ed25519PrivateKey::try_from(mnemonic.entropy())?;
    let public_key = Ed25519PublicKey::from(&private_key);

    Ok(Ed25519KeyMaterial(public_key, Some(private_key)))
}

/// Produce a [Mnemonic] for a given [Ed25519KeyMaterial]; note that the private
/// part of the key must be available in the [Ed25519KeyMaterial] in order to
/// produce the mnemonic.
pub fn ed25519_key_to_mnemonic(key_material: &Ed25519KeyMaterial) -> Result<Mnemonic> {
    let private_key = &key_material.1.ok_or_else(|| {
        anyhow!(
            "A mnemonic can only be generated for the key material if a private key is configured"
        )
    })?;
    let mnemonic = BipMnemonic::from_entropy(private_key.as_ref(), Language::English)?;
    Ok(Mnemonic(mnemonic.into_phrase()))
}

const ED25519_KEYPAIR_LENGTH: usize = 64;
const ED25519_KEY_LENGTH: usize = 32;

/// For a given [Ed25519KeyMaterial] produce a serialized byte array of the
/// key that is suitable for persisting to secure storage.
pub fn ed25519_key_to_bytes(
    key_material: &Ed25519KeyMaterial,
) -> Result<[u8; ED25519_KEYPAIR_LENGTH]> {
    let public_key = key_material.0;
    let private_key: Ed25519PrivateKey = key_material
        .1
        .ok_or_else(|| anyhow!("Private key required in order to deserialize."))?;

    let mut bytes: [u8; ED25519_KEYPAIR_LENGTH] = [0u8; ED25519_KEYPAIR_LENGTH];
    bytes[..ED25519_KEY_LENGTH].copy_from_slice(private_key.as_ref());
    bytes[ED25519_KEY_LENGTH..].copy_from_slice(public_key.as_ref());
    Ok(bytes)
}