Struct Cred 

pub struct Cred {
    pub session: KeyRing,
    pub persistent: Option<KeyRing>,
    pub description: String,
    pub specifiers: Option<(String, String)>,
}

Representation of a keyutils credential.

Since the CredentialBuilderApi::build method does not provide an initial secret, and it is impossible to have 0-length keys, this representation holds a linux_keyutils::KeyRing instead of a linux_keyutils::Key.

The added benefit of this approach is that any call to get_password before set_password is done will result in a proper error as the key does not exist until set_password is called.

Fields

session: KeyRing

Host session keyring

persistent: Option<KeyRing>

Host persistent keyring

description: String

Description of the key entry

specifiers: Option<(String, String)>

Specifiers for the entry, if any

Implementations

impl Cred

pub fn build_from_specifiers( target: Option<&str>, delimiters: &[String; 3], service_no_dividers: bool, service: &str, user: &str, ) -> Result<Self>

Create the platform credential for a Keyutils entry.

An explicit target string is interpreted as the description to use for the entry. If none is provided, then we concatenate the user and service in the string {delimiters[0]}{user}{delimiters[1]}{service}{delimiters[2]}.

Trait Implementations

impl Clone for Cred

fn clone(&self) -> Cred

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl CredentialApi for Cred

fn set_secret(&self, secret: &[u8]) -> Result<()>

See the keyring-core API docs.

This will overwrite the entry if it already exists since it’s using add_key under the hood.

Returns an Invalid error if the password is empty, because keyutils keys cannot have empty values.

fn get_secret(&self) -> Result<Vec<u8>>

See the keyring-core API docs.

This requires a call to Key::read.

fn delete_credential(&self) -> Result<()>

See the keyring-core API docs.

Under the hood this uses Key::invalidate to immediately invalidate the key and prevent any further successful searches.

Note that the keyutils implementation uses caching, and the caches take some time to clear, so get_password may find a key that has been invalidated if it’s called within milliseconds of the invalidation in the same process that deleted the key.

fn get_credential(&self) -> Result<Option<Arc<Credential>>>

See the keyring-core API docs.

Since this store has no ambiguity, entries are wrappers.

fn get_specifiers(&self) -> Option<(String, String)>

See the keyring-core API docs.

Specifiers are remembered at creation time if the description was not custom.

fn as_any(&self) -> &dyn Any

See the keyring-core API docs.

fn debug_fmt(&self, f: &mut Formatter<'_>) -> Result

See the keyring-core API docs.

fn set_password(&self, password: &str) -> Result<(), Error>

Set the entry’s protected data to be the given string.

fn get_password(&self) -> Result<String, Error>

Retrieve the protected data as a UTF-8 string from the underlying credential.

fn get_attributes(&self) -> Result<HashMap<String, String>, Error>

Return any store-specific decorations on this entry’s credential.

fn update_attributes(&self, _: &HashMap<&str, &str>) -> Result<(), Error>

Update the secure store attributes on this entry’s credential.

impl Debug for Cred

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.