unlock

Unlock the vault before changing the its properties or storing anything in it. If the incorrect password or salt is used, this method throws an exception. If the number of unsuccessful attempts exceeds the retry limit, the vault is deleted.

The password is validated against the password policy if it has been set using setPasswordPolicy. If the password is not compatible with the password policy, an IncompatiblePassword exception is thrown. In that case, call changePassword to set a new password that is compatible with the password policy.

Syntax

- (void)unlock:(NSString*)password withSalt:(NSString*)salt;

Parameters

password – the encryption password for this DataVault. 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. This value may be an application-specific constant. If null is passed, a default salt is computed and used.

Returns

If an incorrect password or salt is used, a SUPDataVaultException is thrown with the reason kDataVaultExceptionReasonInvalidPassword.

Examples

Unlocks the data vault – once the vault is unlocked, you can change its properties and stored content.

@try
{
   [oVault unlock:@"password" withSalt:@"salt"];
}
@catch(SUPDataVaultException *e)
{
   NSLog(@"Exception will be thrown for bad password");
}