Struct IONController 

pub struct IONController { /* private fields */ }

Struct for IONController.

Implementations

impl IONController

pub fn new(did: &str, controlled_did: &str) -> Result<Self, Box<dyn Error>>

Constructs a new IONController instance from existing Subject and Controller DIDs.

impl IONController

pub fn is_proof_in_doc_meta(&self, doc_meta: &DocumentMetadata) -> bool

Checks whether there is a proof field in document metadata.

pub fn add_proof_service(&self, did: &str, proof: &str) -> DIDStatePatch

Returns a patch for adding a proof service.

pub fn is_commitment_key( &self, doc_meta: &DocumentMetadata, key: &JWK, key_type: KeyType, ) -> bool

Confirms whether a given key is the commitment in document metadata

Trait Implementations

impl Controller for IONController

fn controlled_did(&self) -> &str

Returns the DID controlled by this controller.

fn update_key(&self) -> Result<JWK, KeyManagerError>

Retrieves the update key.

fn next_update_key(&self) -> Result<Option<JWK>, KeyManagerError>

Retrieves the next update key.

fn generate_next_update_key(&self) -> Result<(), KeyManagerError>

Generates a new update key.

fn recovery_key(&self) -> Result<JWK, KeyManagerError>

Retrieves the recovery key.

fn to_attestor(&self) -> Box<dyn Attestor>

Converts this controller into an attestor.

fn controlled_did_suffix(&self) -> &str

Returns the suffix of the DID controlled by this controller.

impl ControllerKeyManager for IONController

fn read_recovery_key(&self, did_suffix: &str) -> Result<JWK, KeyManagerError>

Reads a recovery key.

fn read_update_key(&self, did_suffix: &str) -> Result<JWK, KeyManagerError>

Reads an update key.

fn read_next_update_key(&self, did_suffix: &str) -> Result<JWK, KeyManagerError>

Reads a candidate next update key.

fn apply_next_update_key( &self, did_suffix: &str, next_update_key: &JWK, ) -> Result<(), KeyManagerError>

Apply the next_update_key to update_key and remove next_update_key

impl KeyManager for IONController

fn read_key( &self, did_suffix: &str, key_type: &KeyType, ) -> Result<OneOrMany<JWK>, KeyManagerError>

Reads a key of a given type.

fn only_one_key( &self, key: Result<OneOrMany<JWK>, KeyManagerError>, ) -> Result<JWK, KeyManagerError>

Check only one key is present and return key.

fn read_keys_from( &self, reader: Box<dyn Read>, ) -> Result<OneOrMany<JWK>, KeyManagerError>

Reads one key from a Reader.

fn get_path( &self, did_suffix: &str, key_type: &KeyType, dir_only: bool, ) -> Result<PathBuf, KeyManagerError>

Gets path for a given DID and key type

fn keys_exist(&self, did_suffix: &str, key_type: &KeyType) -> bool

Checks whether keys already exist on disk.

fn save_key( &self, did_suffix: &str, key_type: KeyType, key: &JWK, overwrite: bool, ) -> Result<(), KeyManagerError>

Saves a key to disk.

fn save_keys( &self, did_suffix: &str, key_type: KeyType, keys: &OneOrMany<JWK>, overwrite: bool, ) -> Result<(), KeyManagerError>

Saves one or more keys to disk.

fn remove_keys( &self, did_suffix: &str, key_type: &KeyType, ) -> Result<(), KeyManagerError>

Removes file from disk for key_type of did_suffix.

impl Subject for IONController

fn did(&self) -> &str

Returns the DID of the subject.

fn did_suffix(&self) -> &str

Returns the DID suffix of the subject.

impl TryFrom<ControllerData> for IONController

type Error = Box<dyn Error>

The type returned in the event of a conversion error.

fn try_from(data: ControllerData) -> Result<Self, Self::Error>

Performs the conversion.