KeychainWrapper Class Reference
| Inherits from | NSObject |
| Declared in | KeychainWrapper.h |
Tasks
Searching for values in Keychain
-
+ searchKeychainCopyMatchingIdentifier:Generic exposed method to search the keychain for a given value. Limit one result per search.
-
+ keychainStringFromMatchingIdentifier:Calls searchKeychainCopyMatchingIdentifier: and converts to a string value.
Create, update or Delete Keychain items
-
+ createKeychainValue:forIdentifier:Default initializer to store a value in the keychain. Associated properties are handled for you – setting Data Protection Access, Company Identifer (to uniquely identify string, etc).
-
+ createKeychainValue:forIdentifier:withDescription:Stores a value and a description to the keychain
-
+ updateKeychainValue:forIdentifier:Updates a value in the keychain. If you try to set the value with createKeychainValue: and it already exists, this method is called instead to update the value in place.
-
+ deleteItemFromKeychainWithIdentifier:Delete a value in the keychain.
Class Methods
createKeychainValue:forIdentifier:
Default initializer to store a value in the keychain. Associated properties are handled for you – setting Data Protection Access, Company Identifer (to uniquely identify string, etc).
+ (BOOL)createKeychainValue:(NSString *)value forIdentifier:(NSString *)identifierParameters
- value
value to set
- identifier
key for the stored item
Declared In
KeychainWrapper.hcreateKeychainValue:forIdentifier:withDescription:
Stores a value and a description to the keychain
+ (BOOL)createKeychainValue:(NSString *)value forIdentifier:(NSString *)identifier withDescription:(NSString *)descriptionParameters
- value
value to set
- identifier
key for the stored item
- description
a text description of the parameter
Discussion
descriptions are really only useful in OSX, since under IOS there is no way to browse the keychain like there is under OSX. You can set it but there is no way to see it afterwards.
Declared In
KeychainWrapper.hdeleteItemFromKeychainWithIdentifier:
Delete a value in the keychain.
+ (void)deleteItemFromKeychainWithIdentifier:(NSString *)identifierParameters
- identifier
key for the stored item
Declared In
KeychainWrapper.hkeychainStringFromMatchingIdentifier:
Calls searchKeychainCopyMatchingIdentifier: and converts to a string value.
+ (NSString *)keychainStringFromMatchingIdentifier:(NSString *)identifierParameters
- identifier
key for the stored item
Declared In
KeychainWrapper.hsearchKeychainCopyMatchingIdentifier:
Generic exposed method to search the keychain for a given value. Limit one result per search.
+ (NSData *)searchKeychainCopyMatchingIdentifier:(NSString *)identifierParameters
- identifier
key for the stored item
Declared In
KeychainWrapper.hupdateKeychainValue:forIdentifier:
Updates a value in the keychain. If you try to set the value with createKeychainValue: and it already exists, this method is called instead to update the value in place.
+ (BOOL)updateKeychainValue:(NSString *)value forIdentifier:(NSString *)identifierParameters
- value
value to set
- identifier
key for the stored item
Declared In
KeychainWrapper.h