Struct security_framework::key::SecKey

pub struct SecKey(/* private fields */);

A type representing an encryption key.

Implementations

impl SecKey

pub fn generate(attributes: CFDictionary) -> Result<Self, CFError>

Translates to SecKeyCreateRandomKey GenerateKeyOptions provides a helper to create an attribute CFDictionary.

pub fn application_label(&self) -> Option<Vec<u8>>

Returns the programmatic identifier for the key. For keys of class kSecAttrKeyClassPublic and kSecAttrKeyClassPrivate, the value is the hash of the public key.

pub fn attributes(&self) -> CFDictionary

Translates to SecKeyCopyAttributes

pub fn external_representation(&self) -> Option<CFData>

Translates to SecKeyCopyExternalRepresentation

pub fn public_key(&self) -> Option<Self>

Translates to SecKeyCopyPublicKey

pub fn create_signature( &self, algorithm: Algorithm, input: &[u8], ) -> Result<Vec<u8>, CFError>

Creates the cryptographic signature for a block of data using a private key and specified algorithm.

pub fn verify_signature( &self, algorithm: Algorithm, signed_data: &[u8], signature: &[u8], ) -> Result<bool, CFError>

Verifies the cryptographic signature for a block of data using a public key and specified algorithm.

pub fn delete(&self) -> Result<(), Error>

Translates to SecItemDelete, passing in the SecKeyRef

Trait Implementations

impl Clone for SecKey

fn clone(&self) -> SecKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SecKey

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

Formats the value using the given formatter.

impl Drop for SecKey

fn drop(&mut self)

Executes the destructor for this type.

impl PartialEq for SecKey

fn eq(&self, other: &SecKey) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TCFType for SecKey

type Ref = *mut OpaqueSecKeyRef

The reference type wrapped inside this type.

fn as_concrete_TypeRef(&self) -> SecKeyRef

Returns the object as its concrete TypeRef.

unsafe fn wrap_under_get_rule(reference: SecKeyRef) -> 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: SecKeyRef) -> 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

where Self: Sized,

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<SecKey> for &'a SecKey

fn to_void(&self) -> *const c_void

impl ToVoid<SecKey> for SecKeyRef

fn to_void(&self) -> *const c_void

impl ToVoid<SecKey> for SecKey

fn to_void(&self) -> *const c_void

impl ConcreteCFType for SecKey

impl Eq for SecKey

impl Send for SecKey

impl Sync for SecKey