authenticator-ios-v2/ForgeRock-Authenticator/FRAIdentityDatabaseSQLiteOperations.m

	FRAIdentityDatabaseSQLiteOperations.m revision 0fc1bec9becddcbec0d26541dd7ef40b43c0a67b
/*
 * The contents of this file are subject to the terms of the Common Development and
 * Distribution License (the License). You may not use this file except in compliance with the
 * License.
 *
 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
 * specific language governing permission and limitations under the License.
 *
 * When distributing Covered Software, include this CDDL Header Notice in each file and include
 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
 * Header, with the fields enclosed by brackets [] replaced by your own identifying
 * information: "Portions copyright [year] [name of copyright owner]".
 *
 * Copyright 2016 ForgeRock AS.
 */

#import "FMDatabase.h"
#import "FRAError.h"
#import "FRAFMDatabaseConnectionHelper.h"
#import "FRAHotpOathMechanism.h"
#import "FRAIdentity.h"
#import "FRAIdentityDatabaseSQLiteOperations.h"
#import "FRAMechanism.h"
#import "FRANotification.h"
#import "FRAOathCode.h"
#import "FRAPushMechanism.h"
#import "FRASerialization.h"
#import "FRATotpOathMechanism.h"

@implementation FRAIdentityDatabaseSQLiteOperations {
    FRAFMDatabaseConnectionHelper *sqlDatabase;
}

#pragma mark -
#pragma Life cycle Functions

- (instancetype)initWithDatabase:(FRAFMDatabaseConnectionHelper *)database {
    self = [super init];
    if (self) {
        sqlDatabase = database;
    }
    return self;
}

#pragma mark -
#pragma SQL Functions

- (BOOL)performStatement:(NSString *)schema withValues:(NSArray *)values error:(NSError * __autoreleasing *)error {
    // Get schema
    NSString *sql = [FRAFMDatabaseConnectionHelper readSchema:schema withError:error];
    if (sql == nil) {
        return NO;
    }

    // Open Database
    FMDatabase *database;
    @try {
        database = [sqlDatabase getConnectionWithError:error];
        if (database == nil) {
            return NO;
        }

        // Perform update
        BOOL result = [database executeUpdate:sql values:values error:error];
        NSLog(@"Result: %@\nValues: %@\nSQL: %@", result ? @"YES" : @"NO", values, sql);
        return result;
    }
    @finally {
        [sqlDatabase closeConnectionToDatabase:database];
    }
}

#pragma mark -
#pragma mark Identity Functions

- (BOOL)insertIdentity:(FRAIdentity *)identity error:(NSError *__autoreleasing *)error {
    NSMutableArray *arguments = [[NSMutableArray alloc] init];
    // Issuer
    [arguments addObject:[FRASerialization nonNilString:identity.issuer]];

    // Account Name
    [arguments addObject:[FRASerialization nonNilString:identity.accountName]];

    // Image URL
    if (identity.image) {
        NSURL *imageUrl = identity.image;
        [arguments addObject:[imageUrl absoluteString]];
    } else {
        [arguments addObject:[NSNull null]];
    }

    // Background Color
    if (identity.backgroundColor) {
        [arguments addObject:identity.backgroundColor];
    } else {
        [arguments addObject:[NSNull null]];
    }

    return [self performStatement:@"insert_identity" withValues:arguments error:error];
}

- (BOOL)deleteIdentity:(FRAIdentity *)identity error:(NSError *__autoreleasing *)error {
    NSMutableArray* arguments = [[NSMutableArray alloc] init];

    // Issuer
    [arguments addObject:[FRASerialization nonNilString:identity.issuer]];

    // Account Name
    [arguments addObject:[FRASerialization nonNilString:identity.accountName]];

    return [self performStatement:@"delete_identity" withValues:arguments error:error];
}

#pragma mark -
#pragma mark Mechanism Functions

- (BOOL)insertMechanism:(FRAMechanism *)mechanism error:(NSError *__autoreleasing *)error {
    NSMutableArray *arguments = [[NSMutableArray alloc] init];

    FRAIdentity *parent = mechanism.parent;

    // idIssuer
    [arguments addObject:[FRASerialization nonNilString:parent.issuer]];

    // idAccountName
    [arguments addObject:[FRASerialization nonNilString:parent.accountName]];

    // mechanismUID - Special case for PushMechanism
    if ([mechanism isKindOfClass:[FRAHotpOathMechanism class]] || [mechanism isKindOfClass:[FRATotpOathMechanism class]]) {
        [arguments addObject:[NSNull null]];
    } else if ([mechanism isKindOfClass:[FRAPushMechanism class]]) {
        FRAPushMechanism *pushMechanism = (FRAPushMechanism*)mechanism;
        [arguments addObject:[FRASerialization nonNilString:pushMechanism.mechanismUID]];
    } else {
        @throw [FRAError createIllegalStateException:@"Unrecognised class of Mechanism"];
    }

    // Mechanism Type
    [arguments addObject:[FRASerialization nonNilString:[[mechanism class] mechanismType]]];

    // Version
    [arguments addObject:[NSNumber numberWithInteger:mechanism.version]];

    // Options
    NSMutableDictionary *options = [[NSMutableDictionary alloc] init];
    if ([mechanism isKindOfClass:[FRAHotpOathMechanism class]]) {
        FRAHotpOathMechanism *hotpOathMechanism = (FRAHotpOathMechanism *)mechanism;

        // Secret Key
        NSString *base64Key = [FRASerialization serializeSecret:hotpOathMechanism.secretKey];
        [options setObject:[FRASerialization nonNilString:base64Key] forKey:OATH_MECHANISM_SECRET];

        // Algorithm
        NSString *algorithm = [FRAOathCode asString:hotpOathMechanism.algorithm];
        [options setObject:[FRASerialization nonNilString:algorithm] forKey:OATH_MECHANISM_ALGORITHM];

        // Code Length
        NSString *digitsString = [[NSNumber numberWithUnsignedInteger:hotpOathMechanism.codeLength] stringValue];
        [options setObject:[FRASerialization nonNilString:digitsString] forKey:OATH_MECHANISM_DIGITS];

        // Counter
        NSString *counterString = [[NSNumber numberWithUnsignedLongLong:hotpOathMechanism.counter] stringValue];
        [options setObject:[FRASerialization nonNilString:counterString] forKey:OATH_MECHANISM_COUNTER];

    } else if ([mechanism isKindOfClass:[FRATotpOathMechanism class]]) {
        FRATotpOathMechanism *totpOathMechanism = (FRATotpOathMechanism *)mechanism;

        // Secret Key
        NSString *base64Key = [FRASerialization serializeBytes:totpOathMechanism.secretKey];
        [options setObject:[FRASerialization nonNilString:base64Key] forKey:OATH_MECHANISM_SECRET];

        // Algorithm
        NSString *algorithm = [FRAOathCode asString:totpOathMechanism.algorithm];
        [options setObject:[FRASerialization nonNilString:algorithm] forKey:OATH_MECHANISM_ALGORITHM];

        // Code Length
        NSString *digitsString = [[NSNumber numberWithUnsignedInteger:totpOathMechanism.codeLength] stringValue];
        [options setObject:[FRASerialization nonNilString:digitsString] forKey:OATH_MECHANISM_DIGITS];

        // Period
        NSString *periodString = [[NSNumber numberWithUnsignedInteger:totpOathMechanism.period] stringValue];
        [options setObject:[FRASerialization nonNilString:periodString] forKey:OATH_MECHANISM_PERIOD];
    } else if ([mechanism isKindOfClass:[FRAPushMechanism class]]) {
        FRAPushMechanism *pushMechanism = (FRAPushMechanism *)mechanism;

        // Secret Key as String
        [options setObject:[FRASerialization nonNilString:pushMechanism.secret] forKey:PUSH_MECHANISM_SECRET];

        // Auth Endpoint as String
        [options setObject:[FRASerialization nonNilString:pushMechanism.authEndpoint] forKey:PUSH_MECHANISM_AUTH_END_POINT];

        // Version integer as String
        NSString *versionString = [[NSNumber numberWithInteger:pushMechanism.version] stringValue];
        [options setObject:[FRASerialization nonNilString:versionString] forKey:PUSH_MECHANISM_VERSION];
    } else {
        @throw [FRAError createIllegalStateException:@"Unrecognised class of Mechanism"];
    }

    // Convert options to JSON
    NSString *jsonString;
    if (![FRASerialization serializeMap:options intoString:&jsonString error:error]) {
        return NO;
    }
    [arguments addObject:jsonString];

    return [self performStatement:@"insert_mechanism" withValues:arguments error:error];
}

- (BOOL)deleteMechanism:(FRAMechanism *)mechanism error:(NSError *__autoreleasing *)error {
    NSMutableArray *arguments = [[NSMutableArray alloc] init];

    FRAIdentity *parent = mechanism.parent;

    // Issuer
    [arguments addObject:[FRASerialization nonNilString:parent.issuer]];

    // Account Name
    [arguments addObject:[FRASerialization nonNilString:parent.accountName]];

    // Mechanism Type
    [arguments addObject:[FRASerialization nonNilString:[[mechanism class] mechanismType]]];

    return [self performStatement:@"delete_mechanism" withValues:arguments error:error];
}

- (BOOL)updateMechanism:(FRAMechanism *)mechanism error:(NSError *__autoreleasing *)error {
    return [self insertMechanism:mechanism error:error];
}

#pragma mark -
#pragma mark Notification Functions

- (BOOL)insertNotification:(FRANotification *)notification error:(NSError *__autoreleasing *)error {
    NSMutableArray* arguments = [[NSMutableArray alloc] init];

    FRAMechanism *parent = notification.parent;
    // mechanismUID
    NSString *mechanismUID;
    if ([parent isKindOfClass:[FRAHotpOathMechanism class]] || [parent isKindOfClass:[FRATotpOathMechanism class]]) {
        mechanismUID = nil;
    } else if ([parent isKindOfClass:[FRAPushMechanism class]]) {
        FRAPushMechanism *pushMechanism = (FRAPushMechanism *)parent;
        mechanismUID = pushMechanism.mechanismUID;
    } else {
        @throw [[NSException alloc] initWithName:@"Illegal State" reason:@"Unrecognised class of Mechanism" userInfo:nil];
    }
    [arguments addObject:[FRASerialization nonNilString:mechanismUID]];

    // timeReceived
    [arguments addObject:[FRASerialization nonNilDate:notification.timeReceived]];

    // timeExpired
    [arguments addObject:[FRASerialization nonNilDate:notification.timeExpired]];

    // Data Json Map
    NSMutableDictionary *dataMap = [[NSMutableDictionary alloc] init];

    // Data: Message ID
    [dataMap setObject:notification.messageId forKey:NOTIFICATION_MESSAGE_ID];

    // Data: Push Challenge
    [dataMap setObject:notification.challenge forKey:NOTIFICATION_PUSH_CHALLENGE];

    // Data: Time to Live
    NSString *ttlString = [NSString stringWithFormat:@"%f", notification.timeToLive];
    [dataMap setObject:ttlString forKey:NOTIFICATION_TIME_TO_LIVE];

    // Data: Load Balancer cookie
    [dataMap setObject:notification.loadBalancerCookie forKey:NOTIFICATION_LOAD_BALANCER_COOKIE];

    // Convert map to JSON
    NSString *jsonString;
    if (![FRASerialization serializeMap:dataMap intoString:&jsonString error:error]) {
        return NO;
    }
    [arguments addObject:jsonString];

    // pending
    [arguments addObject:[NSNumber numberWithBool:[notification isPending]]];

    // approved
    [arguments addObject:[NSNumber numberWithBool:[notification isApproved]]];

    return [self performStatement:@"insert_notification" withValues:arguments error:error];
}

- (BOOL)deleteNotification:(FRANotification *)notification error:(NSError *__autoreleasing *)error {
    NSMutableArray *arguments = [[NSMutableArray alloc] init];

    FRAMechanism *parent = notification.parent;

    // mechanismUID
    NSString *mechanismUID;
    if ([parent isKindOfClass:[FRAHotpOathMechanism class]] || [parent isKindOfClass:[FRATotpOathMechanism class]]) {
        mechanismUID = nil;
    } else if ([parent isKindOfClass:[FRAPushMechanism class]]) {
        FRAPushMechanism *pushMechanism = (FRAPushMechanism *)parent;
        mechanismUID = pushMechanism.mechanismUID;
    } else {
        @throw [[NSException alloc] initWithName:@"Illegal State" reason:@"Unrecognised class of Mechanism" userInfo:nil];
    }
    [arguments addObject:[FRASerialization nonNilString:mechanismUID]];

    // timeReceived
    [arguments addObject:[FRASerialization nonNilDate:notification.timeReceived]];

    return [self performStatement:@"delete_notification" withValues:arguments error:error];
}

- (BOOL)updateNotification:(FRANotification *)notification error:(NSError *__autoreleasing *)error {
    return [self insertNotification:notification error:error];
}


@end