Struct KeychainFile 

pub struct KeychainFile { /* private fields */ }

A keychain database, optionally unlocked.

Implementations

impl KeychainFile

pub fn open(path: impl AsRef<Path>) -> Result<Self>

pub fn from_bytes(bytes: &[u8]) -> Result<Self>

pub fn path(&self) -> Option<&Path>

pub fn keychain(&self) -> &Keychain

pub fn schema(&self) -> &Schema

pub fn is_unlocked(&self) -> bool

pub fn db_blob(&self) -> Result<DbBlob>

The database blob, which holds the salt and the encrypted database keys.

pub fn unlock(&mut self, password: &[u8]) -> Result<()>

Derive the database keys from a password and unwrap every item key.

pub fn item_key_count(&self) -> usize

Number of item keys recovered by Self::unlock.

pub fn items(&self) -> Vec<Item<'_>>

Every password item in the keychain, in table order.

pub fn items_of_type(&self, record_type: RecordType) -> Vec<Item<'_>>

pub fn records_of_type(&self, record_type: RecordType) -> Vec<&Record>

Records of any relation, for kc show --all.

pub fn secret(&self, item: &Item<'_>) -> Result<SecretBytes>

Decrypt an item’s secret. Requires an unlocked keychain.

pub fn find(&self, query: &Query) -> Vec<Item<'_>>

Items matching every supplied criterion.

pub fn find_one(&self, query: &Query) -> Result<Item<'_>>

Exactly one match, or an error naming the ambiguity.

pub fn save(&self, path: impl AsRef<Path>) -> Result<()>

Write the database back out.

pub fn save_in_place(&self) -> Result<()>

Write back to the path this was opened from.

impl KeychainFile

pub fn info(&self) -> Result<Info>

impl KeychainFile

pub fn add_password( &mut self, record_type: RecordType, item: &NewItem, secret: &[u8], timestamp: &str, ) -> Result<()>

Store a password item, creating the item key that protects it.

Requires an unlocked keychain: the item key is wrapped with the database’s encryption key and both blobs are signed with its signing key.

pub fn add_identity(&mut self, identity: &NewIdentity) -> Result<[u8; 20]>

Store an identity: the certificate in the clear, the private key wrapped.

The two records are linked by the certificate’s public key hash, which the key record carries as its Label — that is how SecIdentity pairs them, and how crate::db::KeychainFile and security both find them.

Requires an unlocked keychain: the private key is wrapped with the database’s encryption key, and both blobs are signed with its signing key.