Skip to content

Commit

Permalink
error codes and error message for ios plugin
Browse files Browse the repository at this point in the history
  • Loading branch information
@pradeep1991singh
pradeep1991singh committed Jul 1, 2017
1 parent 60ff098 commit 377fa3a
Show file tree
Hide file tree
Showing 3 changed files with 146 additions and 115 deletions.
2 changes: 1 addition & 1 deletion package.json
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "cordova-plugin-secure-key-store",
"version": "1.5.3",
"version": "1.5.4",
"description": "Cordova plugin for securely saving keys, passwords or strings on devices.",
"cordova": {
"id": "cordova-plugin-secure-key-store",
Expand Down
2 changes: 1 addition & 1 deletion plugin.xml
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?xml version='1.0' encoding='utf-8'?>
<plugin id="cordova-plugin-secure-key-store"
version="1.5.3"
version="1.5.4"
xmlns="http://apache.org/cordova/ns/plugins/1.0"
xmlns:android="http://schemas.android.com/apk/res/android">

Expand Down
257 changes: 144 additions & 113 deletions src/ios/SecureKeyStore.m
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ Licensed to the Apache Software Foundation (ASF) under one
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
Expand All @@ -24,49 +24,62 @@ @implementation SecureKeyStore

- (void) writeToSecureKeyStore:(NSMutableDictionary*) dict
{
// get keychain
KeychainItemWrapper * keychain = [[KeychainItemWrapper alloc] initWithIdentifier:@"cordova.plugins.SecureKeyStore" accessGroup:nil];
NSString *error;

// Serialize dictionary and store in keychain
NSData *serializedDict = [NSPropertyListSerialization dataFromPropertyList:dict format:NSPropertyListXMLFormat_v1_0 errorDescription:&error];
[keychain setObject:serializedDict forKey:(__bridge id)(kSecValueData)];
if (error) {
NSLog(@"%@", error);
}
// get keychain
KeychainItemWrapper * keychain = [[KeychainItemWrapper alloc] initWithIdentifier:@"cordova.plugins.SecureKeyStore" accessGroup:nil];
NSString *error;
// Serialize dictionary and store in keychain
NSData *serializedDict = [NSPropertyListSerialization dataFromPropertyList:dict format:NSPropertyListXMLFormat_v1_0 errorDescription:&error];
[keychain setObject:serializedDict forKey:(__bridge id)(kSecValueData)];
if (error) {
NSLog(@"%@", error);
}
}

- (NSMutableDictionary *) readFromSecureKeyStore
{
NSMutableDictionary *dict = [NSMutableDictionary dictionary];
// get keychain
KeychainItemWrapper * keychain = [[KeychainItemWrapper alloc] initWithIdentifier:@"cordova.plugins.SecureKeyStore" accessGroup:nil];
NSError *error;
@try
{
NSData *serializedDict = [keychain objectForKey:(__bridge id)(kSecValueData)];
NSUInteger dictLength = [serializedDict length];
if (dictLength) {
// de-serialize dictionary
dict = [NSPropertyListSerialization propertyListFromData:serializedDict mutabilityOption:NSPropertyListImmutable format:nil errorDescription:&error];
if (error) {
NSLog(@"Read process Exception: %@", error);
}
}
}
@catch (NSException * exception)
{
NSLog(@"Read exception: %@", exception);
}
return dict;
NSMutableDictionary *dict = [NSMutableDictionary dictionary];
// get keychain
KeychainItemWrapper * keychain = [[KeychainItemWrapper alloc] initWithIdentifier:@"cordova.plugins.SecureKeyStore" accessGroup:nil];
NSError *error;
@try
{
NSData *serializedDict = [keychain objectForKey:(__bridge id)(kSecValueData)];
NSUInteger dictLength = [serializedDict length];
if (dictLength) {
// de-serialize dictionary
dict = [NSPropertyListSerialization propertyListFromData:serializedDict mutabilityOption:NSPropertyListImmutable format:nil errorDescription:&error];
if (error) {
NSLog(@"Read process Exception: %@", error);
}
}
}
@catch (NSException * exception)
{
NSLog(@"Read exception: %@", exception);
}
return dict;
}

- (void) removeKeyFromSecureKeyStore:(NSString*) key
- (BOOL) removeKeyFromSecureKeyStore:(NSString*) key
{
// get mutable dictionary and remove key from store
NSMutableDictionary *dict = [self readFromSecureKeyStore];
[dict removeObjectForKey:key];
[self writeToSecureKeyStore:dict];
@try
{
// get mutable dictionary and remove key from store
NSMutableDictionary *dict = [self readFromSecureKeyStore];
[dict removeObjectForKey:key];
[self writeToSecureKeyStore:dict];
return YES;
}
@catch (NSException * exception)
{
NSLog(@"Remove exception: %@", exception.reason);
return NO;
}
}

- (void) resetSecureKeyStore
{
[[[KeychainItemWrapper alloc] initWithIdentifier:@"cordova.plugins.SecureKeyStore" accessGroup:nil] resetKeychainItem];
}

- (void)handleAppUninstallation
Expand All @@ -78,89 +91,107 @@ - (void)handleAppUninstallation
}
}

- (void) set:(CDVInvokedUrlCommand*)command
{
CDVPluginResult* pluginResult = nil;
NSString* key = [command.arguments objectAtIndex:0];
NSString* value = [command.arguments objectAtIndex:1];

@try {
// handle app uninstallation
[self handleAppUninstallation];

// get mutable dictionary and store data
[self.commandDelegate runInBackground:^{
@synchronized(self) {
NSMutableDictionary *dict = [self readFromSecureKeyStore];
[dict setValue: value forKey: key];
[self writeToSecureKeyStore:dict];

CDVPluginResult* pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK messageAsString:@"Key saved to keychain successfully"];
[self.commandDelegate sendPluginResult:pluginResult callbackId:command.callbackId];
}
}];
}
@catch (NSException* exception)
{
pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_ERROR messageAsString:exception];
[self.commandDelegate sendPluginResult:pluginResult callbackId:command.callbackId];
}
}

- (void) get:(CDVInvokedUrlCommand*)command
- (void) set:(CDVInvokedUrlCommand*)command
{
CDVPluginResult* pluginResult = nil;
NSString* key = [command.arguments objectAtIndex:0];

@try {
// handle app uninstallation
[self handleAppUninstallation];
[self.commandDelegate runInBackground:^{
@synchronized(self) {
// get mutable dictionaly and retrieve store data
NSMutableDictionary *dict = [self readFromSecureKeyStore];
NSString *value = nil;

if (dict != nil) {
value =[dict valueForKey:key];
CDVPluginResult* pluginResult = nil;
NSString* key = [command.arguments objectAtIndex:0];
NSString* value = [command.arguments objectAtIndex:1];

@try {
// handle app uninstallation
[self handleAppUninstallation];
// get mutable dictionary and store data
[self.commandDelegate runInBackground:^{
@synchronized(self) {
@try {
NSMutableDictionary *dict = [self readFromSecureKeyStore];
[dict setValue: value forKey: key];
[self writeToSecureKeyStore:dict];

CDVPluginResult* pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK messageAsString:@"key saved successfully"];
[self.commandDelegate sendPluginResult:pluginResult callbackId:command.callbackId];
}
@catch (NSException* exception)
{
NSString* errorMessage = [NSString stringWithFormat:@"{\"code\":9,\"message\":\"error saving key, please try to un-install and re-install app again\",\"actual-error\":%@}", exception];
CDVPluginResult* pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_ERROR messageAsString:errorMessage];
[self.commandDelegate sendPluginResult:pluginResult callbackId:command.callbackId];
}
}

CDVPluginResult* pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK messageAsString:value];
[self.commandDelegate sendPluginResult:pluginResult callbackId:command.callbackId];
}
}];
}
@catch (NSException* exception)
{
pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_ERROR messageAsString: @"Exception: fetching key from keychain"];
[self.commandDelegate sendPluginResult:pluginResult callbackId:command.callbackId];
}
}];
}
@catch (NSException* exception)
{
NSString* errorMessage = [NSString stringWithFormat:@"{\"code\":9,\"message\":\"error saving key\",\"actual-error\":%@}", exception];
pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_ERROR messageAsString:errorMessage];
[self.commandDelegate sendPluginResult:pluginResult callbackId:command.callbackId];
}
}

- (void) remove:(CDVInvokedUrlCommand*)command
- (void) get:(CDVInvokedUrlCommand*)command
{
CDVPluginResult* pluginResult = nil;
NSString* key = (NSString*)[command.arguments objectAtIndex:0];
@try {
// handle app uninstallation
[self handleAppUninstallation];
[self.commandDelegate runInBackground:^{
@synchronized(self) {
[self removeKeyFromSecureKeyStore:key];
CDVPluginResult* pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK messageAsString:@"Key removed successfully"];
[self.commandDelegate sendPluginResult:pluginResult callbackId:command.callbackId];
}
}];
}
@catch(NSException *exception) {
pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_ERROR messageAsString: @"Exception: Could not delete key from keychain"];
[self.commandDelegate sendPluginResult:pluginResult callbackId:command.callbackId];
}
CDVPluginResult* pluginResult = nil;
NSString* key = [command.arguments objectAtIndex:0];

@try {
// handle app uninstallation
[self handleAppUninstallation];
[self.commandDelegate runInBackground:^{
@synchronized(self) {
// get mutable dictionaly and retrieve store data
NSMutableDictionary *dict = [self readFromSecureKeyStore];
NSString *value = nil;

if (dict != nil) {
value =[dict valueForKey:key];
}

if (value != nil) {
value =[dict valueForKey:key];
CDVPluginResult* pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK messageAsString:value];
[self.commandDelegate sendPluginResult:pluginResult callbackId:command.callbackId];
} else {
NSString* errorMessage = @"{\"code\":1,\"message\":\"key does not present\"}";
CDVPluginResult* pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_ERROR messageAsString:errorMessage];
[self.commandDelegate sendPluginResult:pluginResult callbackId:command.callbackId];
}
}
}];
}
@catch (NSException* exception)
{
NSString* errorMessage = [NSString stringWithFormat:@"{\"code\":1,\"message\":\"key does not present\",\"actual-error\":%@}", exception];
pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_ERROR messageAsString:errorMessage];
[self.commandDelegate sendPluginResult:pluginResult callbackId:command.callbackId];
}
}

- (void) resetSecureKeyStore
- (void) remove:(CDVInvokedUrlCommand*)command
{
[[[KeychainItemWrapper alloc] initWithIdentifier:@"cordova.plugins.SecureKeyStore" accessGroup:nil] resetKeychainItem];
CDVPluginResult* pluginResult = nil;
NSString* key = (NSString*)[command.arguments objectAtIndex:0];
@try {
// handle app uninstallation
[self handleAppUninstallation];
[self.commandDelegate runInBackground:^{
@synchronized(self) {
BOOL status = [self removeKeyFromSecureKeyStore:key];
if (status) {
CDVPluginResult* pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK messageAsString:@"Key removed successfully"];
[self.commandDelegate sendPluginResult:pluginResult callbackId:command.callbackId];
} else {
NSString* errorMessage = @"{\"code\":6,\"message\":\"could not delete key\"}";
CDVPluginResult* pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_ERROR messageAsString:errorMessage];
[self.commandDelegate sendPluginResult:pluginResult callbackId:command.callbackId];
}
}
}];
}
@catch(NSException *exception) {
NSString* errorMessage = [NSString stringWithFormat:@"{\"code\":6,\"message\":\"could not delete key\",\"actual-error\":%@}", exception];
pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_ERROR messageAsString:errorMessage];
[self.commandDelegate sendPluginResult:pluginResult callbackId:command.callbackId];
}
}

@end

0 comments on commit 377fa3a

Please sign in to comment.