aboutsummaryrefslogtreecommitdiffhomepage
path: root/Firebase/Auth/Source/FIRAuthAppCredentialManager.m
blob: 2a0d1c7703ca85176aaec4d417ac2fdbc22a5f7e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
/*
 * Copyright 2017 Google
 *
 * Licensed 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 KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#import "Private/FIRAuthAppCredentialManager.h"

#import "Private/FIRAuthAppCredential.h"
#import "FIRAuthGlobalWorkQueue.h"
#import "FIRAuthKeychain.h"

NS_ASSUME_NONNULL_BEGIN

/** @var kKeychainDataKey
    @brief The keychain key for the data.
 */
static NSString *const kKeychainDataKey = @"app_credentials";

/** @var kFullCredentialKey
    @brief The data key for the full app credential.
 */
static NSString *const kFullCredentialKey = @"full_credential";

/** @var kPendingReceiptsKey
    @brief The data key for the array of pending receipts.
 */
static NSString *const kPendingReceiptsKey = @"pending_receipts";

/** @var kMaximumNumberOfPendingReceipts
    @brief The maximum number of partial credentials kept by this class.
 */
static const NSUInteger kMaximumNumberOfPendingReceipts = 32;

@implementation FIRAuthAppCredentialManager {
  /** @var _keychain
      @brief The keychain for app credentials to load from and to save to.
   */
  FIRAuthKeychain *_keychain;

  /** @var _pendingReceipts
      @brief A list of pending receipts sorted in the order they were recorded.
   */
  NSMutableArray<NSString *> *_pendingReceipts;

  /** @var _callbacksByReceipt
      @brief A map from pending receipts to callbacks.
   */
  NSMutableDictionary<NSString *, FIRAuthAppCredentialCallback> *_callbacksByReceipt;
}

- (instancetype)initWithKeychain:(FIRAuthKeychain *)keychain {
  self = [super init];
  if (self) {
    _keychain = keychain;
    // Load the credentials from keychain if possible.
    NSError *error;
    NSData *encodedData = [_keychain dataForKey:kKeychainDataKey error:&error];
    if (!error && encodedData) {
      NSKeyedUnarchiver *unarchiver =
          [[NSKeyedUnarchiver alloc] initForReadingWithData:encodedData];
      FIRAuthAppCredential *credential =
          [unarchiver decodeObjectOfClass:[FIRAuthAppCredential class]
                                   forKey:kFullCredentialKey];
      if ([credential isKindOfClass:[FIRAuthAppCredential class]]) {
        _credential = credential;
      }
      NSSet<Class> *allowedClasses =
          [NSSet<Class> setWithObjects:[NSArray class], [NSString class], nil];
      NSArray<NSString *> *pendingReceipts =
          [unarchiver decodeObjectOfClasses:allowedClasses forKey:kPendingReceiptsKey];
      if ([pendingReceipts isKindOfClass:[NSArray class]]) {
        _pendingReceipts = [pendingReceipts mutableCopy];
      }
    }
    if (!_pendingReceipts) {
      _pendingReceipts = [[NSMutableArray<NSString *> alloc] init];
    }
    _callbacksByReceipt =
        [[NSMutableDictionary<NSString *, FIRAuthAppCredentialCallback> alloc] init];
  }
  return self;
}

- (NSUInteger)maximumNumberOfPendingReceipts {
  return kMaximumNumberOfPendingReceipts;
}

- (void)didStartVerificationWithReceipt:(NSString *)receipt
                                timeout:(NSTimeInterval)timeout
                               callback:(FIRAuthAppCredentialCallback)callback {
  [_pendingReceipts removeObject:receipt];
  if (_pendingReceipts.count >= kMaximumNumberOfPendingReceipts) {
    [_pendingReceipts removeObjectAtIndex:0];
  }
  [_pendingReceipts addObject:receipt];
  _callbacksByReceipt[receipt] = callback;
  [self saveData];
  dispatch_after(dispatch_time(DISPATCH_TIME_NOW, (int64_t)(timeout * NSEC_PER_SEC)),
                               FIRAuthGlobalWorkQueue(), ^{
    [self callBackWithReceipt:receipt];
  });
}

- (BOOL)canFinishVerificationWithReceipt:(NSString *)receipt secret:(NSString *)secret {
  if (![_pendingReceipts containsObject:receipt]) {
    return NO;
  }
  [_pendingReceipts removeObject:receipt];
  _credential = [[FIRAuthAppCredential alloc] initWithReceipt:receipt secret:secret];
  [self saveData];
  [self callBackWithReceipt:receipt];
  return YES;
}

- (void)clearCredential {
  _credential = nil;
  [self saveData];
}

#pragma mark - Internal methods

/** @fn saveData
    @brief Save the data in memory to the keychain ignoring any errors.
 */
- (void)saveData {
  NSMutableData *archiveData = [NSMutableData data];
  NSKeyedArchiver *archiver = [[NSKeyedArchiver alloc] initForWritingWithMutableData:archiveData];
  [archiver encodeObject:_credential forKey:kFullCredentialKey];
  [archiver encodeObject:_pendingReceipts forKey:kPendingReceiptsKey];
  [archiver finishEncoding];
  [_keychain setData:archiveData forKey:kKeychainDataKey error:NULL];
}

/** @fn callBackWithReceipt:
    @brief Calls the saved callback for the specifc receipt.
    @param receipt The receipt associated with the callback.
 */
- (void)callBackWithReceipt:(NSString *)receipt {
  FIRAuthAppCredentialCallback callback = _callbacksByReceipt[receipt];
  if (!callback) {
    return;
  }
  [_callbacksByReceipt removeObjectForKey:receipt];
  if (_credential) {
    callback(_credential);
  } else {
    callback([[FIRAuthAppCredential alloc] initWithReceipt:receipt secret:nil]);
  }
}

@end

NS_ASSUME_NONNULL_END