keri-core 0.17.13

use super::event_msg_builder::EventMsgBuilder;
use crate::{
    error::Error,
    event::sections::{key_config::nxt_commitment, threshold::SignatureThreshold},
    event_message::EventTypeTag,
    keys::{PrivateKey, PublicKey},
    prefix::{BasicPrefix, IdentifierPrefix, IndexedSignature, SelfSigningPrefix},
    state::IdentifierState,
};
use ed25519_dalek::SigningKey;
use rand::rngs::OsRng;
use said::{derivation::HashFunctionCode, SelfAddressingIdentifier};

/// Collects data for testing `IdentifierState` update. `prev_event_hash`, `sn`,
/// `current_keypair` and `new_keypair` are used to generate mock event message
/// of given type, `keys_history` is used to check if any keypair used earlier
/// in event message sequence can verify current message.
pub struct TestStateData {
    state: IdentifierState,
    prefix: IdentifierPrefix,
    keys_history: Vec<BasicPrefix>,
    prev_event_hash: SelfAddressingIdentifier,
    sn: u64,
    current_keypair: (PublicKey, PrivateKey),
    new_keypair: (PublicKey, PrivateKey),
}

/// Create initial `TestStateData`, before application of any Event.
/// Provides only keypair for next event.
fn get_initial_test_data() -> Result<TestStateData, Error> {
    let keypair = SigningKey::generate(&mut OsRng);
    let pk = PublicKey::new(keypair.verifying_key().as_bytes().to_vec());
    let sk = PrivateKey::new(keypair.as_bytes().to_vec());

    Ok(TestStateData {
        state: IdentifierState::default(),
        prefix: IdentifierPrefix::default(),
        keys_history: vec![],
        prev_event_hash: SelfAddressingIdentifier::default(),
        sn: 0,
        current_keypair: (pk.clone(), sk.clone()),
        new_keypair: (pk, sk),
    })
}

/// Construct mock event message from `event_type` and `state_data`, apply it to
/// `IdentifierState` in `state_data.state` and check if it was updated correctly.
fn test_update_identifier_state(
    event_type: EventTypeTag,
    state_data: TestStateData,
) -> Result<TestStateData, Error> {
    // Get current and next key_pairs from argument.
    let (mut cur_pk, mut cur_sk) = state_data.current_keypair;
    let (mut next_pk, mut next_sk) = state_data.new_keypair;

    // If event is establishment event, rotate keypair.
    if event_type.is_establishment_event() {
        cur_pk = next_pk;
        cur_sk = next_sk;
        let keypair = SigningKey::generate(&mut OsRng);
        let pk = PublicKey::new(keypair.verifying_key().as_bytes().to_vec());
        let sk = PrivateKey::new(keypair.as_bytes().to_vec());
        next_pk = pk;
        next_sk = sk;
    };

    let current_key_pref = BasicPrefix::Ed25519(cur_pk.clone());
    let next_key_prefix = BasicPrefix::Ed25519(next_pk.clone());
    let next_keys_data = nxt_commitment(
        SignatureThreshold::Simple(1),
        &[next_key_prefix.clone()],
        &HashFunctionCode::Blake3_256.into(),
    );

    // Build event msg of given type.
    let event_msg = EventMsgBuilder::new(event_type.clone())
        .with_sn(state_data.sn)
        .with_previous_event(&state_data.prev_event_hash)
        .with_prefix(&state_data.prefix)
        .with_keys(vec![current_key_pref.clone()])
        .with_next_keys(vec![next_key_prefix])
        .build()?;
    let prefix = event_msg.data.get_prefix();

    // Serialize event message before signing.
    let sed = event_msg.encode()?;

    let attached_sig = {
        // Sign.
        let signer = cur_sk.clone();
        let sig = signer.sign_ed(&sed)?;
        IndexedSignature::new_both_same(SelfSigningPrefix::Ed25519Sha512(sig), 0)
    };

    // Attach sign to event message.
    let signed_event = event_msg.sign(vec![attached_sig.clone()], None, None);

    // Apply event to current IdentifierState.
    let new_state = state_data.state.apply(&signed_event)?;

    assert!(new_state.current.verify(&sed, &signed_event.signatures)?);

    // Check if current key prefix can verify message and signature.
    assert!(current_key_pref.verify(&sed, &attached_sig.signature)?);

    // If generated event is establishment event, check if any of previous
    // keys can verify message and signature.
    if event_type.is_establishment_event() {
        for old_key in state_data.keys_history.clone() {
            let ver = old_key.verify(&sed, &attached_sig.signature);
            assert!(ver.is_err() || !ver.unwrap())
        }
    };

    // Check if state is updated correctly.
    assert_eq!(new_state.prefix, prefix.clone());
    assert_eq!(new_state.sn, state_data.sn);
    assert_eq!(new_state.last_event_digest, event_msg.digest()?.into());
    assert_eq!(new_state.current.public_keys.len(), 1);
    assert_eq!(new_state.current.public_keys[0], current_key_pref);
    assert_eq!(new_state.current.threshold, SignatureThreshold::Simple(1));
    assert_eq!(new_state.current.next_keys_data, next_keys_data);
    assert!(new_state.witness_config.witnesses.is_empty());
    assert_eq!(
        new_state.witness_config.tally,
        SignatureThreshold::Simple(0)
    );

    let mut new_history = state_data.keys_history.clone();
    // If event_type is establishment event, append current key to keys
    // history. It will be obsolete in the future establishement events.
    if event_type.is_establishment_event() {
        new_history.push(current_key_pref);
    }
    // Current event will be previous event for the next one, so return its hash.
    let prev_event_hash = event_msg.digest()?;
    // Compute sn for next event.
    let next_sn = state_data.sn + 1;

    Ok(TestStateData {
        state: new_state,
        prefix: prefix,
        keys_history: new_history,
        prev_event_hash,
        sn: next_sn,
        current_keypair: (cur_pk, cur_sk),
        new_keypair: (next_pk, next_sk),
    })
}

/// For given sequence of EventTypes check wheather `IdentifierState` is updated correctly
/// by applying `test_update_identifier_state` sequentially.
pub fn test_mock_event_sequence(sequence: Vec<EventTypeTag>) -> Result<TestStateData, Error> {
    let mut st = get_initial_test_data();

    let step = |event_type, state_data: Result<TestStateData, Error>| {
        test_update_identifier_state(event_type, state_data?)
    };
    for event_type in sequence {
        st = step(event_type, st);
    }
    st
}