Struct LAPrivateKey

Source

#[repr(C)]
pub struct LAPrivateKey { /* private fields */ }

Available on crate feature LAPrivateKey only.

Expand description

Managed Private Key.

Implementations§

Source §

impl LAPrivateKey

Source

pub unsafe fn publicKey(&self) -> Retained<LAPublicKey>

Available on crate feature LAPublicKey only.

Offers the public key counterpart of a LAPrivateKeyinstance

Source

pub unsafe fn signData_secKeyAlgorithm_completion( &self, data: &NSData, algorithm: &SecKeyAlgorithm, handler: &Block<dyn Fn(mut NSData, mut NSError)>, )

Available on crate features block2 and objc2-security only.

Generates a digital signature for the given data.

Parameter data: The data to be signed, typically the digest of the actual data.

Parameter algorithm: A SecKeyAlgorithmsuitable for generating signatures with this key – e.g: kSecKeyAlgorithmECDSASignatureMessageX962SHA256 Parameter handler: Completion handler with the signature of given data or an error on failure.

Source

pub unsafe fn canSignUsingSecKeyAlgorithm( &self, algorithm: &SecKeyAlgorithm, ) -> bool

Available on crate feature objc2-security only.

Checks if the the provided algorithm can be used for signing data

Parameter algorithm: Cryptographic algorithm

Returns: YESin case the key supports the provided algorithm with the specified operation.

Source

pub unsafe fn decryptData_secKeyAlgorithm_completion( &self, data: &NSData, algorithm: &SecKeyAlgorithm, handler: &Block<dyn Fn(mut NSData, mut NSError)>, )

Available on crate features block2 and objc2-security only.

Decrypts the given ciphertext

Parameter data: The data to decrypt. The length and format of the data must conform to chosen algorithm, typically be less or equal to the value returned by SecKeyGetBlockSize().

Parameter algorithm: A SecKeyAlgorithmsuitable for decrypting data with this key –e.g: kSecKeyAlgorithmECIESEncryptionStandardVariableIVX963SHA256AESGCM Parameter handler: Completion handler with plaintext or an error on failure.

Source

pub unsafe fn canDecryptUsingSecKeyAlgorithm( &self, algorithm: &SecKeyAlgorithm, ) -> bool

Available on crate feature objc2-security only.

Checks if the the provided algorithm can be used for decryption

Parameter algorithm: Cryptographic algorithm

Returns: YESin case the key supports the provided algorithm with the specified operation.

Source

pub unsafe fn exchangeKeysWithPublicKey_secKeyAlgorithm_secKeyParameters_completion( &self, public_key: &NSData, algorithm: &SecKeyAlgorithm, parameters: &NSDictionary, handler: &Block<dyn Fn(mut NSData, mut NSError)>, )

Available on crate features block2 and objc2-security only.

Performs a Diffie-Hellman style key exchange operation

Parameter publicKey: Remote party’s public key.

Parameter algorithm: A SecKeyAlgorithmsuitable for performing a key exchange with this key –e.g: kSecKeyAlgorithmECDHKeyExchangeCofactorX963SHA256 Parameter parameters: Dictionary with parameters, see SecKeyKeyExchangeParameterconstants. Used algorithm determines the set of required and optional parameters to be used.

Parameter handler: Completion handler with the result of the key exchange or an error on failure.

Source

pub unsafe fn canExchangeKeysUsingSecKeyAlgorithm( &self, algorithm: &SecKeyAlgorithm, ) -> bool

Available on crate feature objc2-security only.

Checks if the the provided algorithm can be used for performing key exchanges

Parameter algorithm: Cryptographic algorithm

Returns: YESin case the key supports the provided algorithm with the specified operation.

Source

pub unsafe fn new() -> Retained<Self>

Clients cannot create LAPrivateKeyinstances directly. They typically obtain them from a LAPersistedRightinstance.

Source

pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>

Clients cannot create LAPrivateKeyinstances directly. They typically obtain them from a LAPersistedRightinstance.

Methods from Deref<Target = NSObject>§

Source

pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>§

Source

pub fn class(&self) -> &'static AnyClass

Dynamically find the class of this object.

§Example

Check that an instance of NSObject has the precise class NSObject.

use objc2::ClassType;
use objc2::runtime::NSObject;

let obj = NSObject::new();
assert_eq!(obj.class(), NSObject::class());

Source

pub unsafe fn get_ivar<T>(&self, name: &str) -> &T
where T: Encode,

👎Deprecated: this is difficult to use correctly, use Ivar::load instead.

Use Ivar::load instead.

§Safety

The object must have an instance variable with the given name, and it must be of type T.

See Ivar::load_ptr for details surrounding this.

Source

pub fn downcast_ref<T>(&self) -> Option<&T>
where T: DowncastTarget,

Attempt to downcast the object to a class of type T.

This is the reference-variant. Use Retained::downcast if you want to convert a retained object to another type.

§Mutable classes

Some classes have immutable and mutable variants, such as NSString and NSMutableString.

When some Objective-C API signature says it gives you an immutable class, it generally expects you to not mutate that, even though it may technically be mutable “under the hood”.

So using this method to convert a NSString to a NSMutableString, while not unsound, is generally frowned upon unless you created the string yourself, or the API explicitly documents the string to be mutable.

See Apple’s documentation on mutability and on isKindOfClass: for more details.

§Generic classes

Objective-C generics are called “lightweight generics”, and that’s because they aren’t exposed in the runtime. This makes it impossible to safely downcast to generic collections, so this is disallowed by this method.

You can, however, safely downcast to generic collections where all the type-parameters are AnyObject.

§Panics

This works internally by calling isKindOfClass:. That means that the object must have the instance method of that name, and an exception will be thrown (if CoreFoundation is linked) or the process will abort if that is not the case. In the vast majority of cases, you don’t need to worry about this, since both root objects NSObject and NSProxy implement this method.

§Examples

Cast an NSString back and forth from NSObject.

use objc2::rc::Retained;
use objc2_foundation::{NSObject, NSString};

let obj: Retained<NSObject> = NSString::new().into_super();
let string = obj.downcast_ref::<NSString>().unwrap();
// Or with `downcast`, if we do not need the object afterwards
let string = obj.downcast::<NSString>().unwrap();

Try (and fail) to cast an NSObject to an NSString.

use objc2_foundation::{NSObject, NSString};

let obj = NSObject::new();
assert!(obj.downcast_ref::<NSString>().is_none());

Try to cast to an array of strings.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);
// This is invalid and doesn't type check.
let arr = arr.downcast_ref::<NSArray<NSString>>();

This fails to compile, since it would require enumerating over the array to ensure that each element is of the desired type, which is a performance pitfall.

Downcast when processing each element instead.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);

for elem in arr {
    if let Some(data) = elem.downcast_ref::<NSString>() {
        // handle `data`
    }
}