This repository was archived by the owner on Feb 24, 2025. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 16
/
Copy pathMockSecureVault.swift
647 lines (499 loc) · 20 KB
/
MockSecureVault.swift
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
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
//
// MockSecureVault.swift
//
// Copyright © 2021 DuckDuckGo. All rights reserved.
//
// 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 BrowserServicesKit
import Foundation
import GRDB
import SecureStorage
typealias MockVaultFactory = SecureVaultFactory<MockSecureVault<MockDatabaseProvider>>
let MockSecureVaultFactory = SecureVaultFactory<MockSecureVault>(
makeCryptoProvider: {
return MockCryptoProvider()
}, makeKeyStoreProvider: { _ in
let provider = MockKeyStoreProvider()
provider._l1Key = "key".data(using: .utf8)
return provider
}, makeDatabaseProvider: { key in
return try MockDatabaseProvider(key: key)
}
)
final class MockSecureVault<T: AutofillDatabaseProvider>: AutofillSecureVault {
enum MockError: Error {
case noStubSet
}
var stubEncryptPassword: ((BrowserServicesKit.SecureVaultModels.WebsiteCredentials, Data?, Data?) -> SecureVaultModels.WebsiteCredentials)?
func encryptPassword(for credentials: BrowserServicesKit.SecureVaultModels.WebsiteCredentials, key l2Key: Data?, salt: Data?) throws -> BrowserServicesKit.SecureVaultModels.WebsiteCredentials {
guard let stubEncryptPassword = stubEncryptPassword?(credentials, l2Key, salt) else {
throw MockError.noStubSet
}
return stubEncryptPassword
}
public typealias MockSecureVaultDatabaseProviders = SecureStorageProviders<T>
var storedAccounts: [SecureVaultModels.WebsiteAccount] = []
var storedCredentials: [Int64: SecureVaultModels.WebsiteCredentials] = [:]
var storedCredentialsForDomain: [String: [SecureVaultModels.WebsiteCredentials]] = [:]
var storedNeverPromptWebsites = [SecureVaultModels.NeverPromptWebsites]()
var storedNotes: [SecureVaultModels.Note] = []
var storedIdentities: [SecureVaultModels.Identity] = []
var storedCards: [SecureVaultModels.CreditCard] = []
public required init(providers: MockSecureVaultDatabaseProviders) {}
func authWith(password: Data) throws -> any AutofillSecureVault {
return self
}
func resetL2Password(oldPassword: Data?, newPassword: Data) throws {}
func accounts() throws -> [SecureVaultModels.WebsiteAccount] {
return storedAccounts
}
func accountsCount() throws -> Int {
return storedAccounts.count
}
func accountsCountBucket() throws -> String {
return ""
}
func accountsFor(domain: String) throws -> [SecureVaultModels.WebsiteAccount] {
return storedAccounts.filter { $0.domain == domain }
}
func accountsWithPartialMatchesFor(eTLDplus1: String) throws -> [SecureVaultModels.WebsiteAccount] {
return storedAccounts.filter { $0.domain?.contains(eTLDplus1) ?? false }
}
func websiteCredentialsFor(accountId: Int64) throws -> SecureVaultModels.WebsiteCredentials? {
return storedCredentials[accountId]
}
func websiteCredentialsFor(domain: String) throws -> [BrowserServicesKit.SecureVaultModels.WebsiteCredentials] {
return storedCredentialsForDomain[domain] ?? []
}
func websiteCredentialsWithPartialMatchesFor(eTLDplus1: String) throws -> [BrowserServicesKit.SecureVaultModels.WebsiteCredentials] {
return storedCredentialsForDomain[eTLDplus1] ?? []
}
func storeWebsiteCredentials(_ credentials: SecureVaultModels.WebsiteCredentials) throws -> Int64 {
let accountID = Int64(credentials.account.id!)!
storedCredentials[accountID] = credentials
return accountID
}
func updateLastUsedFor(accountId: Int64) throws {
if var account = storedAccounts.first(where: { $0.id == String(accountId) }) {
account.lastUsed = Date()
}
}
func deleteWebsiteCredentialsFor(accountId: Int64) throws {
storedCredentials[accountId] = nil
}
func deleteAllWebsiteCredentials() throws {
storedAccounts.removeAll()
storedCredentials.removeAll()
}
func neverPromptWebsites() throws -> [SecureVaultModels.NeverPromptWebsites] {
return storedNeverPromptWebsites
}
func hasNeverPromptWebsitesFor(domain: String) throws -> Bool {
return !storedNeverPromptWebsites.filter { $0.domain == domain }.isEmpty
}
func storeNeverPromptWebsites(_ neverPromptWebsite: SecureVaultModels.NeverPromptWebsites) throws -> Int64 {
if let neverPromptWebsiteId = neverPromptWebsite.id {
storedNeverPromptWebsites.append(neverPromptWebsite)
return neverPromptWebsiteId
} else {
storedNeverPromptWebsites.append(neverPromptWebsite)
return -1
}
}
func deleteAllNeverPromptWebsites() throws {
storedNeverPromptWebsites = []
}
func notes() throws -> [SecureVaultModels.Note] {
return storedNotes
}
func noteFor(id: Int64) throws -> SecureVaultModels.Note? {
return storedNotes.first { $0.id == id }
}
func storeNote(_ note: SecureVaultModels.Note) throws -> Int64 {
storedNotes.append(note)
return note.id!
}
func deleteNoteFor(noteId: Int64) throws {
storedNotes = storedNotes.filter { $0.id != noteId }
}
func identities() throws -> [SecureVaultModels.Identity] {
return storedIdentities
}
func identitiesCount() throws -> Int {
return storedIdentities.count
}
func identityFor(id: Int64) throws -> SecureVaultModels.Identity? {
return storedIdentities.first { $0.id == id }
}
func storeIdentity(_ identity: SecureVaultModels.Identity) throws -> Int64 {
storedIdentities.append(identity)
return identity.id!
}
func deleteIdentityFor(identityId: Int64) throws {
storedIdentities = storedIdentities.filter { $0.id != identityId }
}
func creditCards() throws -> [SecureVaultModels.CreditCard] {
return storedCards
}
func creditCardsCount() throws -> Int {
return storedCards.count
}
func creditCardFor(id: Int64) throws -> SecureVaultModels.CreditCard? {
return storedCards.first { $0.id == id }
}
func storeCreditCard(_ card: SecureVaultModels.CreditCard) throws -> Int64 {
storedCards.append(card)
return card.id!
}
func deleteCreditCardFor(cardId: Int64) throws {
storedCards = storedCards.filter { $0.id != cardId }
}
func existingIdentityForAutofill(matching proposedIdentity: SecureVaultModels.Identity) throws -> SecureVaultModels.Identity? {
return nil
}
func existingCardForAutofill(matching proposedCard: SecureVaultModels.CreditCard) throws -> SecureVaultModels.CreditCard? {
return nil
}
var spyInDatabaseTransactionBlock: ((Database) throws -> Void)?
func inDatabaseTransaction(_ block: @escaping (Database) throws -> Void) throws {
spyInDatabaseTransactionBlock = block
}
func modifiedSyncableCredentials() throws -> [SecureVaultModels.SyncableCredentials] {
[]
}
func accountTitlesForSyncableCredentials(modifiedBefore date: Date) throws -> [String] {
[]
}
func deleteSyncableCredentials(_ syncableCredentials: SecureVaultModels.SyncableCredentials, in database: Database) throws {
if let accountId = syncableCredentials.metadata.objectId {
try deleteWebsiteCredentialsFor(accountId: accountId)
}
}
func storeWebsiteCredentials(_ credentials: SecureVaultModels.WebsiteCredentials, clearModifiedAt: Bool) throws -> Int64 {
try storeWebsiteCredentials(credentials)
}
func storeSyncableCredentials(_ syncableCredentials: SecureVaultModels.SyncableCredentials, in database: Database) throws {}
func syncableCredentialsForSyncIds(_ syncIds: any Sequence<String>, in database: Database) throws -> [SecureVaultModels.SyncableCredentials] {
[]
}
func syncableCredentialsForAccountId(_ accountId: Int64, in database: Database) throws -> SecureVaultModels.SyncableCredentials? {
nil
}
func accountsForDomain(_ domain: String, in database: Database) throws -> [SecureVaultModels.WebsiteAccount] {
try accountsFor(domain: domain)
}
func getEncryptionKey() throws -> Data {
Data()
}
func encrypt(_ data: Data, using key: Data) throws -> Data {
data
}
func decrypt(_ data: Data, using key: Data) throws -> Data {
data
}
func hasAccountFor(username: String?, domain: String?) throws -> Bool {
storedAccounts.contains(where: { $0.username == username && $0.domain == domain })
}
func getHashingSalt() throws -> Data? {
nil
}
func storeWebsiteCredentials(_ credentials: SecureVaultModels.WebsiteCredentials, in database: Database, encryptedUsing l2Key: Data, hashedUsing salt: Data?) throws -> Int64 {
1
}
func storeSyncableCredentials(_ syncableCredentials: SecureVaultModels.SyncableCredentials, in database: Database, encryptedUsing l2Key: Data, hashedUsing salt: Data?) throws {
}
}
extension MockSecureVault {
func addWebsiteCredentials(identifiers: [Int64]) {
var credentials = [Int64: SecureVaultModels.WebsiteCredentials]()
for identifier in identifiers {
let account = SecureVaultModels.WebsiteAccount(id: String(identifier),
title: "title-\(identifier)",
username: "user-\(identifier)",
domain: "domain-\(identifier)")
let credential = SecureVaultModels.WebsiteCredentials(account: account, password: "password\"containing\"quotes".data(using: .utf8)!)
credentials[identifier] = credential
}
self.storedAccounts = credentials.map(\.value.account)
self.storedCredentials = credentials
}
}
// MARK: - Mock Providers
private extension URL {
static let duckduckgo = URL(string: "https://duckduckgo.com/")!
}
class MockDatabaseProvider: AutofillDatabaseProvider {
// swiftlint:disable identifier_name
var _accounts = [SecureVaultModels.WebsiteAccount]()
var _notes = [SecureVaultModels.Note]()
var _identities = [Int64: SecureVaultModels.Identity]()
var _creditCards = [Int64: SecureVaultModels.CreditCard]()
var _forDomain = [String]()
var _credentialsDict = [Int64: SecureVaultModels.WebsiteCredentials]()
var _credentialsForDomain = [String: [SecureVaultModels.WebsiteCredentials]]()
var _note: SecureVaultModels.Note?
var _neverPromptWebsites = [SecureVaultModels.NeverPromptWebsites]()
var db: GRDB.DatabaseWriter
// swiftlint:enable identifier_name
required init(file: URL = .duckduckgo, key: Data = Data()) throws {
db = try! DatabaseQueue(named: "TestQueue")
}
static func recreateDatabase(withKey key: Data) throws -> Self {
return try MockDatabaseProvider(file: URL(string: "https://duck.com")!, key: Data()) as! Self
}
func storeWebsiteCredentials(_ credentials: SecureVaultModels.WebsiteCredentials) throws -> Int64 {
if let accountIdString = credentials.account.id, let accountID = Int64(accountIdString) {
_credentialsDict[accountID] = credentials
return accountID
} else {
_credentialsDict[-1] = credentials
return -1
}
}
func websiteCredentialsForAccountId(_ accountId: Int64) throws -> SecureVaultModels.WebsiteCredentials? {
return _credentialsDict[accountId]
}
func websiteCredentialsForDomain(_ domain: String) throws -> [BrowserServicesKit.SecureVaultModels.WebsiteCredentials] {
return _credentialsForDomain[domain] ?? []
}
func websiteCredentialsForTopLevelDomain(_ domain: String) throws -> [BrowserServicesKit.SecureVaultModels.WebsiteCredentials] {
return _credentialsForDomain[domain] ?? []
}
func websiteAccountsForDomain(_ domain: String) throws -> [SecureVaultModels.WebsiteAccount] {
self._forDomain.append(domain)
return _accounts
}
func websiteAccountsForTopLevelDomain(_ eTLDplus1: String) throws -> [SecureVaultModels.WebsiteAccount] {
self._forDomain.append(eTLDplus1)
return _accounts
}
func updateLastUsedForAccountId(_ accountId: Int64) throws {
if var account = _accounts.first(where: { $0.id == String(accountId) }) {
account.lastUsed = Date()
}
}
func deleteWebsiteCredentialsForAccountId(_ accountId: Int64) throws {
self._accounts = self._accounts.filter { $0.id != String(accountId) }
}
func deleteAllWebsiteCredentials() throws {
self._accounts.removeAll()
self._credentialsDict.removeAll()
}
func accounts() throws -> [SecureVaultModels.WebsiteAccount] {
return _accounts
}
func accountsCount() throws -> Int {
return _accounts.count
}
func neverPromptWebsites() throws -> [SecureVaultModels.NeverPromptWebsites] {
return _neverPromptWebsites
}
func hasNeverPromptWebsitesFor(domain: String) throws -> Bool {
return false
}
func storeNeverPromptWebsite(_ neverPromptWebsite: SecureVaultModels.NeverPromptWebsites) throws -> Int64 {
if let neverPromptWebsiteId = neverPromptWebsite.id {
_neverPromptWebsites.append(neverPromptWebsite)
return neverPromptWebsiteId
} else {
return -1
}
}
func deleteAllNeverPromptWebsites() throws {
_neverPromptWebsites.removeAll()
}
func updateNeverPromptWebsite(_ neverPromptWebsite: SecureVaultModels.NeverPromptWebsites) throws {
}
func insertNeverPromptWebsite(_ neverPromptWebsite: SecureVaultModels.NeverPromptWebsites) throws {
}
func notes() throws -> [SecureVaultModels.Note] {
return _notes
}
func noteForNoteId(_ noteId: Int64) throws -> SecureVaultModels.Note? {
return _note
}
func deleteNoteForNoteId(_ noteId: Int64) throws {
self._notes = self._notes.filter { $0.id != noteId }
}
func storeNote(_ note: SecureVaultModels.Note) throws -> Int64 {
_note = note
return note.id ?? -1
}
func identities() throws -> [SecureVaultModels.Identity] {
return Array(_identities.values)
}
func identitiesCount() throws -> Int {
return _identities.count
}
func identityForIdentityId(_ identityId: Int64) throws -> SecureVaultModels.Identity? {
return _identities[identityId]
}
func storeIdentity(_ identity: SecureVaultModels.Identity) throws -> Int64 {
if let identityID = identity.id {
_identities[identityID] = identity
return identityID
} else {
return -1
}
}
func deleteIdentityForIdentityId(_ identityId: Int64) throws {
_identities.removeValue(forKey: identityId)
}
func creditCards() throws -> [SecureVaultModels.CreditCard] {
return Array(_creditCards.values)
}
func creditCardsCount() throws -> Int {
return _creditCards.count
}
func creditCardForCardId(_ cardId: Int64) throws -> SecureVaultModels.CreditCard? {
return _creditCards[cardId]
}
func storeCreditCard(_ creditCard: SecureVaultModels.CreditCard) throws -> Int64 {
if let cardID = creditCard.id {
_creditCards[cardID] = creditCard
return cardID
} else {
return -1
}
}
func deleteCreditCardForCreditCardId(_ cardId: Int64) throws {
_creditCards.removeValue(forKey: cardId)
}
func hasAccountFor(username: String?, domain: String?) throws -> Bool {
_accounts.contains(where: { $0.username == username && $0.domain == domain })
}
func inTransaction(_ block: @escaping (Database) throws -> Void) throws {
try db.write(block)
}
func storeWebsiteCredentials(_ credentials: SecureVaultModels.WebsiteCredentials, in database: Database) throws -> Int64 {
1
}
func modifiedSyncableCredentials() throws -> [SecureVaultModels.SyncableCredentials] {
[]
}
func modifiedSyncableCredentials(before date: Date) throws -> [SecureVaultModels.SyncableCredentials] {
[]
}
func syncableCredentialsForSyncIds(_ syncIds: any Sequence<String>, in database: Database) throws -> [SecureVaultModels.SyncableCredentials] {
[]
}
func websiteCredentialsForAccountId(_ accountId: Int64, in database: Database) throws -> SecureVaultModels.WebsiteCredentials? {
nil
}
func syncableCredentialsForAccountId(_ accountId: Int64, in database: Database) throws -> SecureVaultModels.SyncableCredentials? {
nil
}
func storeSyncableCredentials(_ syncableCredentials: SecureVaultModels.SyncableCredentials, in database: Database) throws {
}
func deleteSyncableCredentials(_ syncableCredentials: SecureVaultModels.SyncableCredentials, in database: Database) throws {
}
func updateSyncTimestamp(in database: Database, tableName: String, objectId: Int64, timestamp: Date?) throws {
}
}
class MockCryptoProvider: SecureStorageCryptoProvider {
var passwordSalt: Data {
return Data()
}
var keychainServiceName: String {
return "service"
}
var keychainAccountName: String {
return "account"
}
// swiftlint:disable identifier_name
var _derivedKey: Data?
var _decryptedData: Data?
var _lastDataToDecrypt: Data?
var _lastDataToEncrypt: Data?
var _lastKey: Data?
var hashingSalt: Data?
// swiftlint:enable identifier_name
func generateSecretKey() throws -> Data {
return Data()
}
func generatePassword() throws -> Data {
return Data()
}
func deriveKeyFromPassword(_ password: Data) throws -> Data {
return _derivedKey!
}
func generateNonce() throws -> Data {
return Data()
}
func encrypt(_ data: Data, withKey key: Data) throws -> Data {
_lastDataToEncrypt = data
_lastKey = key
return data
}
func decrypt(_ data: Data, withKey key: Data) throws -> Data {
_lastDataToDecrypt = data
_lastKey = key
guard let data = _decryptedData else {
throw SecureStorageError.invalidPassword
}
return data
}
func generateSalt() throws -> Data {
return Data()
}
func hashData(_ data: Data) throws -> String? {
return ""
}
func hashData(_ data: Data, salt: Data?) throws -> String? {
return ""
}
}
class MockKeyStoreProvider: SecureStorageKeyStoreProvider {
// swiftlint:disable identifier_name
var _l1Key: Data?
var _encryptedL2Key: Data?
var _generatedPassword: Data?
var _generatedPasswordCleared = false
var _lastEncryptedL2Key: Data?
// swiftlint:enable identifier_name
var generatedPasswordEntryName: String {
return ""
}
var l1KeyEntryName: String {
return ""
}
var l2KeyEntryName: String {
return ""
}
var keychainServiceName: String {
return ""
}
func attributesForEntry(named: String, serviceName: String) -> [String: Any] {
return [:]
}
func storeGeneratedPassword(_ password: Data) throws {
}
func generatedPassword() throws -> Data? {
return _generatedPassword
}
func clearGeneratedPassword() throws {
_generatedPasswordCleared = true
}
func storeL1Key(_ data: Data) throws {
}
func l1Key() throws -> Data? {
return _l1Key
}
func storeEncryptedL2Key(_ data: Data) throws {
_lastEncryptedL2Key = data
}
func encryptedL2Key() throws -> Data? {
return _encryptedL2Key
}
}