Struct security_framework::os::macos::keychain::SecKeychain

pub struct SecKeychain(_);

A type representing a keychain.

Implementations

impl SecKeychain

pub fn default() -> Result<Self>

Creates a SecKeychain object corresponding to the user’s default keychain.

pub fn default_for_domain(domain: SecPreferencesDomain) -> Result<Self>

Creates a SecKeychain object corresponding to the user’s default keychain for the given domain.

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

Opens a keychain from a file.

pub fn unlock(&mut self, password: Option<&str>) -> Result<()>

Unlocks the keychain.

If a password is not specified, the user will be prompted to enter it.

pub fn set_settings(&mut self, settings: &KeychainSettings) -> Result<()>

Sets settings of the keychain.

pub fn disable_user_interaction() -> Result<KeychainUserInteractionLock>

Disables the user interface for keychain services functions that automatically display a user interface.

pub fn user_interaction_allowed() -> Result<bool>

Indicates whether keychain services functions that normally display a user interaction are allowed to do so.

impl SecKeychain

pub fn find_generic_password(
    &self,
    service: &str,
    account: &str
) -> Result<(SecKeychainItemPassword, SecKeychainItem)>

Find application password in this keychain

pub fn find_internet_password(
    &self,
    server: &str,
    security_domain: Option<&str>,
    account: &str,
    path: &str,
    port: Option<u16>,
    protocol: SecProtocolType,
    authentication_type: SecAuthenticationType
) -> Result<(SecKeychainItemPassword, SecKeychainItem)>

Find internet password in this keychain

pub fn set_internet_password(
    &self,
    server: &str,
    security_domain: Option<&str>,
    account: &str,
    path: &str,
    port: Option<u16>,
    protocol: SecProtocolType,
    authentication_type: SecAuthenticationType,
    password: &[u8]
) -> Result<()>

Update existing or add new internet password

pub fn set_generic_password(
    &self,
    service: &str,
    account: &str,
    password: &[u8]
) -> Result<()>

Set a generic password.

• keychain_opt is the keychain to use or None to use the default keychain.
• service is the associated service name for the password.
• account is the associated account name for the password.
• password is the password itself.

pub fn add_generic_password(
    &self,
    service: &str,
    account: &str,
    password: &[u8]
) -> Result<()>

Add application password to the keychain, without checking if it exists already

See set_generic_password()

pub fn add_internet_password(
    &self,
    server: &str,
    security_domain: Option<&str>,
    account: &str,
    path: &str,
    port: Option<u16>,
    protocol: SecProtocolType,
    authentication_type: SecAuthenticationType,
    password: &[u8]
) -> Result<()>

Add internet password to the keychain, without checking if it exists already

See set_internet_password()

Trait Implementations

impl Clone for SecKeychain

fn clone(&self) -> SecKeychain

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Drop for SecKeychain

fn drop(&mut self)

Executes the destructor for this type.

impl PartialEq<SecKeychain> for SecKeychain

fn eq(&self, other: &SecKeychain) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl TCFType for SecKeychain

type Ref = *mut OpaqueSecKeychainRef

The reference type wrapped inside this type.

fn as_concrete_TypeRef(&self) -> SecKeychainRef

Returns the object as its concrete TypeRef.

unsafe fn wrap_under_get_rule(reference: SecKeychainRef) -> Self

Returns an instance of the object, wrapping the underlying CFTypeRef subclass. Use this when following Core Foundation’s “Get Rule”. The reference count is bumped.

fn as_CFTypeRef(&self) -> CFTypeRef

Returns the object as a raw CFTypeRef. The reference count is not adjusted.

unsafe fn wrap_under_create_rule(reference: SecKeychainRef) -> Self

Returns an instance of the object, wrapping the underlying CFTypeRef subclass. Use this when following Core Foundation’s “Create Rule”. The reference count is not bumped.

fn type_id() -> CFTypeID

Returns the type ID for this class.

fn as_CFType(&self) -> CFType

Returns the object as a wrapped CFType. The reference count is incremented by one.

fn into_CFType(self) -> CFType

Returns the object as a wrapped CFType. Consumes self and avoids changing the reference count.

fn retain_count(&self) -> isize

Returns the reference count of the object. It is unwise to do anything other than test whether the return value of this method is greater than zero.

fn type_of(&self) -> usize

Returns the type ID of this object.

fn show(&self)

Writes a debugging version of this object on standard error.

fn instance_of<OtherCFType>(&self) -> bool where
    OtherCFType: TCFType, 

Returns true if this value is an instance of another type.

impl<'a> ToVoid<SecKeychain> for &'a SecKeychain

fn to_void(&self) -> *const c_void

impl ToVoid<SecKeychain> for SecKeychain

fn to_void(&self) -> *const c_void

impl ToVoid<SecKeychain> for SecKeychainRef

fn to_void(&self) -> *const c_void

impl ConcreteCFType for SecKeychain

impl Eq for SecKeychain

impl Send for SecKeychain

impl Sync for SecKeychain