Struct libkeycard::Keycard

pub struct Keycard {
    pub entries: Vec<Entry>,
    /* private fields */
}

A Keycard object is a collection of entries tied together in an authenticated blockchain. It consists of the root entry for the entity all the way through the current entry.

Fields

entries: Vec<Entry>

Implementations

impl Keycard

pub fn new(t: &EntryType) -> Keycard

Creates a new Keycard of the specified type

pub fn from(data: &str) -> Result<Keycard, LKCError>

Creates a new keycard entry chain from text.

pub fn get_current(&self) -> Option<&Entry>

Returns the last entry of the keycard

pub fn find(&self, hash: &CryptoString) -> Result<&Entry, LKCError>

Finds the entry in a keycard which has the requested hash

pub fn get_current_mut(&mut self) -> Option<&mut Entry>

Returns a mutable reference to the last entry of the keycard

pub fn get_type(&self) -> EntryType

Returns the type of entries stored in the keycard

pub fn get_text(&self) -> Result<String, LKCError>

Returns the entire keycard chain as text

pub fn chain(
    &mut self,
    spair: &SigningPair,
    expires: u16
) -> Result<HashMap<&'static str, CryptoString>, LKCError>

Creates a new Entry object in the keycard. Organization keycards are complete and compliant when chain() returns. User keycards will require cross_sign() and user_sign() to be called before it is complete.

pub fn cross_sign(&mut self, signing_pair: &SigningPair) -> Result<(), LKCError>

This convenience method applies only to user keycards and is used to set the organization’s signature for the current entry.

pub fn user_sign(
    &mut self,
    hash_algorithm: &str,
    signing_pair: &SigningPair
) -> Result<(), LKCError>

This convenience method applies only to user keycards and is used to add the final user signature and generate the hash for the entry. Once this has been applied, the current entry for the card should be compliant and should pass verification.

pub fn verify(&self) -> Result<(), LKCError>

Verifies the keycard’s complete chain of entries