//
//  Copyright (c) 2017 Open Whisper Systems. All rights reserved.
//

#import <AxolotlKit/IdentityKeyStore.h>
#import "TSStorageManager.h"

NS_ASSUME_NONNULL_BEGIN

@class OWSRecipientIdentity;

extern NSString *const TSStorageManagerTrustedKeysCollection;

@interface TSStorageManager (IdentityKeyStore) <IdentityKeyStore>

/**
 * Explicitly mark an identity as approved for blocking/nonblocking use
 * e.g. in response to a user confirmation action.
 *
 * @param   identityKey key data used to identify the recipient
 * @param   recipientId unique stable identifier for the recipient, e.g. e164 phone number
 * @param   approvedForBlockingUse if the user wants explicit confirmation before sending to changed numbers, whether
 * that confirmation has occurred.
 * @param   approvedForNonBlockingUse YES to override the duration during which we consider an SN "too soon" to send.
 *
 * @returns YES if we are replacing an existing known identity key for recipientId.
 *          NO  if there was no previously stored identity key for the recipient.
 */
- (BOOL)saveRemoteIdentity:(NSData *)identityKey
               recipientId:(NSString *)recipientId
    approvedForBlockingUse:(BOOL)approvedForBlockingUse
 approvedForNonBlockingUse:(BOOL)approvedForNonBlockingUse;

/**
 * Check if a recipient identity corresponds to an untrusted identity
 *
 * @param   recipientId unique stable identifier for the recipient, e.g. e164 phone number
 * @returns nil if the identity doesn't exist or if it's trusted
 *          else returns the untrusted identity
 */
- (nullable OWSRecipientIdentity *)unconfirmedIdentityThatShouldBlockSendingForRecipientId:(NSString *)recipientId;

/**
 * @param   recipientId unique stable identifier for the recipient, e.g. e164 phone number
 * @returns nil if the recipient's current id has been seen, or if it's the users first key
 *          else returns the unseen identity
 *
 */
- (nullable OWSRecipientIdentity *)unseenIdentityChangeForRecipientId:(NSString *)recipientId;

- (void)generateNewIdentityKey;
- (nullable NSData *)identityKeyForRecipientId:(NSString *)recipientId;
- (void)removeIdentityKeyForRecipient:(NSString *)receipientId;

@end

NS_ASSUME_NONNULL_END