VPNUStorage
Special class which can be used to save account-specific information on disk.
Discussion
Use this class if you want to save any information which is specific for an account described by VPNUAccountUserInfo. This class also provides an interface to save data securely using methods which use encryption and decryption.
attention: The class uses NSUserDefaults internally. If you clear the defaults associated with the intance of this class (generally standardUserDefaults), all stored values (including encrypted) will be lost.
Extends: NSObject
Declared in: VPNUStorage.h
Class Methods
defaultStorage
+ (instancetype)defaultStorage;
Returns the shared storage object.
Discussion
The shared storage is created internally with standardUserDefaults instance of NSUserDefaults class. If you want to use any custom NSUserDefaults object, you can initialize your own instance of VPNUStorage using initWithUserDefaults: covinience initializer.
Availability
Available in Mac OS X v10.7. Available in iOS v7.0.
Instance Methods
initWithUserDefaults:
- (instancetype)initWithUserDefaults:(NSUserDefaults *)userDefaults NS_DESIGNATED_INITIALIZER;
Initializes and return a newly created
VPNUStorage instance which uses a custom NSUserDefaults object.
Parameters
- userDefaults
- A custom
NSUserDefaultsobject.
Discussion
This method is a convenience constructor.
attention: Use this method only if you know what you are doing. Generally you want to use standardUserDefaults instance of NSUserDefaults class - simply use the defaultStorage class method (the latter is generally preferred).
readObjectForKey:
- (id)readObjectForKey:(NSString *)key;
Returns the object associated with the provided key.
Parameters
- key
- The key with which to associate with the object. Cannot be nil.
Availability
Available in Mac OS X v10.7. Available in iOS v7.0.
readObjectForKey:forAccount:
- (id)readObjectForKey:(NSString *)key forAccount:(VPNUAccountUserInfo *)account;
Returns the object associated with the provided key and account.
Parameters
- key
- The key with which to associate with the object. Cannot be nil.
- account
- The account with which to associate with the given key.
Availability
Available in Mac OS X v10.7. Available in iOS v7.0.
readWithDecryptionObjectForKey:
- (id)readWithDecryptionObjectForKey:(NSString *)key;
Decrypts and returns the object associated with the provided key.
Parameters
- key
- The key with which to associate with the object. Cannot be nil.
Warning
This method generates an exception if no encryption key was provided using setEncryptionKey: method.
Availability
Available in Mac OS X v10.7. Available in iOS v7.0.
readWithDecryptionObjectForKey:forAccount:
- (id)readWithDecryptionObjectForKey:(NSString *)key forAccount:(VPNUAccountUserInfo *)account;
Decrypts and returns the object associated with the provided key and account.
Parameters
- key
- The key with which to associate with the object. Cannot be nil.
- account
- The account with which to associate with the given key.
Warning
This method generates an exception if no encryption key was provided using setEncryptionKey: method.
Availability
Available in Mac OS X v10.7. Available in iOS v7.0.
setEncryptionKey:
- (void)setEncryptionKey:(NSString *)key;
Sets the provided string as the encryption and decryption key used by secure methods.
Parameters
- key
- Encryption key to be used for encryption. Cannot be nil.
Discussion
The provided string is later used internally when the methods with pattern storeWithEncryptionObject: and readWithDecryptionObjectForKey: are called. It is recommended to use an arbitrary, comparatively large and permutated string for this value. Generally you are discouraged to use a user's login or password or any meaningful string as an encryption key.
attention: Set the key only once before making any calls to the instance. Otherwise the correctness of encryption and decryption is not guaranteed.
attention: Encryption key should be the same between the launches of your host application. If you change the key, all previously saved values will be inaccessible until you set the key back to the previous value.
Availability
Available in Mac OS X v10.7. Available in iOS v7.0.
storeObject:forKey:
- (void)storeObject:(id)object forKey:(NSString *)key;
Stores provided object for the specified key.
Parameters
- object
- The object to store.
- key
- The key with which to associate with the object. Cannot be nil.
Warning
The object parameter can be only property list objects: NSData, NSString, NSNumber, NSDate, NSArray, or NSDictionary.
Availability
Available in Mac OS X v10.7. Available in iOS v7.0.
storeObject:forKey:forAccount:
- (void)storeObject:(id)object forKey:(NSString *)key forAccount:(VPNUAccountUserInfo *)account;
Stores provided key-value pair (key and object) for the specified account.
Parameters
- object
- The object to store.
- key
- The key with which to associate with the object. Cannot be nil.
- account
- The account with which to associate with the given key-value pair.
Warning
The object parameter can be only property list objects: NSData, NSString, NSNumber, NSDate, NSArray, or NSDictionary.
Availability
Available in Mac OS X v10.7. Available in iOS v7.0.
storeWithEncryptionObject:forKey:
- (void)storeWithEncryptionObject:(id)object forKey:(NSString *)key;
Encrypts and stores provided object for the specified key.
Parameters
- object
- The object to store. Cannot be nil.
- key
- The key with which to associate with the object. Cannot be nil.
Warning
This method generates an exception if no encryption key was provided using setEncryptionKey: method.
Warning
The object parameter can be only property list objects: NSData, NSString, NSNumber, NSDate, NSArray, or NSDictionary.
Availability
Available in Mac OS X v10.7. Available in iOS v7.0.
storeWithEncryptionObject:forKey:forAccount:
- (void)storeWithEncryptionObject:(id)object forKey:(NSString *)key forAccount:(VPNUAccountUserInfo *)account;
Encrypts and stores provided key-value pair (key and object) for the specified account.
Parameters
- object
- The object to store. Cannot be nil.
- key
- The key with which to associate with the object. Cannot be nil.
- account
- The account with which to associate with the given key-value pair.
Warning
This method generates an exception if no encryption key was provided using setEncryptionKey: method.
Warning
The object parameter can be only property list objects: NSData, NSString, NSNumber, NSDate, NSArray, or NSDictionary.
Availability
Available in Mac OS X v10.7. Available in iOS v7.0.