createVault

Creates a new secure store (a vault).

A unique name is assigned, and after creation, the vault is referenced and accessed by that name. This method also assigns a password and salt value to the vault. If a vault with the same name already exists, this method throws an exception. A newly created vault is in the unlocked state.

Syntax

+ (SUPDataVault*)createVault:(NSString*)name withPassword:(NSString*)password withSalt:(NSString*)salt;

Parameters

name – an arbitrary name for a DataVault instance on this device. This name is effectively the primary key for looking up DataVault instances on the device, so it cannot use the same name as any existing instance. If it does, this method throws an exception with error code INVALID_ARG. The name also cannot be empty or null.
password – the initial encryption password for this DataVault. This is the password needed for unlocking the vault. If null is passed, a default password is computed and used.
salt – the encryption salt value for this DataVault. This value, combined with the password, creates the actual encryption key that protects the data in the vault. If null is passed, a default salt is computed and used.

Returns

Returns the newly created instance of the DataVault with the provided ID. The returned DataVault is in the unlocked state with default configuration values. To change the default configuration values, you can immediately call the "set" methods for the values you want to change.

If a vault already exists with the same name, a SUPDataVaultException is thrown with the reason kDataVaultExceptionReasonAlreadyExists.

Examples

Create a data vault – creates a new data vault called myVault.

@try
{
    if(![SUPDataVault vaultExists:@"myVault"])
    {
        oVault = [SUPDataVault createVault:@"myVault" 
                               withPassword:@"goodPassword" 
                               withSalt:@"goodSalt"];
    }
}
@catch ( NSException *e )
{
    NSLog(@"SUPDataVaultException: %@",[e description]);
}