-
Notifications
You must be signed in to change notification settings - Fork 0
/
Networking.swift
545 lines (481 loc) · 22.8 KB
/
Networking.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
//
// Copyright 2023 Wultra s.r.o.
//
// 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 Foundation
import PowerAuth2
import WultraPowerAuthNetworking
/// Class that provides all functionality for both Identity Onboarding and Identity Verification.
/// Both features are separated into `onboarding` and `identityVerification` properties.
class Networking {
/// Errors during init
enum InitError: Error {
/// Provided URL is invalid (see `url` associated value)
case invalidBaseURL(url: String)
}
/// All necessary communication for Identity Onboarding (PowerAuth activation via user information such as client id and birthdate).
let onboarding: Onboarding
/// All necessary communication for Identity Verification (After PowerAuth was enrolled with verification pending)
let identityVerification: IdentityVerification
/// Networking service for HTTP communication and request signing.
let networking: WPNNetworkingService
/// Creates the service instance.
/// - Parameters:
/// - powerAuth: Valid powerauth instance.
/// - config: Configuration of the service. Default values are used when not specified (see config init documentation).
convenience init(powerAuth: PowerAuthSDK, config: WPNConfig) throws {
self.init(networking: WPNNetworkingService(powerAuth: powerAuth, config: config, serviceName: "WDOServiceNet"))
}
/// Creates the service instance.
/// - Parameter networking: Networking service for HTTP communication and request signing.
init(networking: WPNNetworkingService) {
self.networking = networking
self.onboarding = Onboarding(networking: networking)
self.identityVerification = IdentityVerification(networking: networking)
}
/// Class that provides all necessary communication for Identity Onboarding (PowerAuth activation via user information such as client id and birthdate).
class Onboarding {
fileprivate let powerAuth: PowerAuthSDK
fileprivate let networking: WPNNetworkingService
init(networking: WPNNetworkingService) {
self.powerAuth = networking.powerAuth
self.networking = networking
}
/// Starts the Identity Onboarding process.
///
/// Encrypted with the ECIES application scope.
/// - Parameters:
/// - credentials: Custom credentials object for user authentication.
/// - completion: Result completion.
/// - Returns: Operation to observe
@discardableResult
func start<TCreds: Codable>(with credentials: TCreds, completion: @escaping (Result<ProcessResponse, WPNError>) -> Void) -> Operation? {
typealias Endpoint = Endpoints.Onboarding.Start<TCreds>
return networking.post(
data: Endpoint.EndpointType.RequestData(.init(identification: credentials)),
to: Endpoint.endpoint,
encryptedWith: powerAuth.eciesEncryptorForApplicationScope(),
completion: { result, error in
assert(Thread.isMainThread)
if let data = result?.responseObject {
completion(.success(data))
} else {
completion(.failure(error ?? WPNError(reason: .unknown)))
}
}
)
}
/// Cancel the Identity Onboarding process.
///
/// Encrypted with the ECIES application scope.
/// - Parameters:
/// - processId: ID of the Identity Onboarding process
/// - completion: Result completion.
/// - Returns: Operation to observe
@discardableResult
func cancel(processId: String, completion: @escaping (Result<Void, WPNError>) -> Void) -> Operation? {
typealias Endpoint = Endpoints.Onboarding.Cancel
return networking.post(
data: Endpoint.EndpointType.RequestData(.init(processId: processId)),
to: Endpoint.endpoint,
encryptedWith: powerAuth.eciesEncryptorForApplicationScope(),
completion: { (result: WPNResponseBase?, error: WPNError?) in
assert(Thread.isMainThread)
if result?.status == .Ok {
completion(.success(()))
} else {
completion(.failure(error ?? WPNError(reason: .unknown)))
}
}
)
}
/// Retrieves status of the Identity Onboarding.
///
/// Encrypted with the ECIES application scope.
/// - Parameters:
/// - processId: ID of the Identity Onboarding process
/// - completion: Result completion.
/// - Returns: Operation to observe
@discardableResult
func getStatus(processId: String, completion: @escaping (Result<ProcessResponse, WPNError>) -> Void) -> Operation? {
typealias Endpoint = Endpoints.Onboarding.GetStatus
return networking.post(
data: Endpoint.EndpointType.RequestData(.init(processId: processId)),
to: Endpoint.endpoint,
encryptedWith: powerAuth.eciesEncryptorForApplicationScope(),
completion: { result, error in
assert(Thread.isMainThread)
if let data = result?.responseObject {
completion(.success(data))
} else {
completion(.failure(error ?? WPNError(reason: .unknown)))
}
}
)
}
/// Resends the OTP for users convenience (for example when SMS was not received by the user).
///
/// Note that there will be some frequency limit implemented by the server. Default is 30 seconds
/// but we advise to consult this with the backend developers.
///
/// Encrypted with the ECIES application scope.
///
/// - Parameters:
/// - processId: ID of the Identity Onboarding process
/// - completion: Result completion.
/// - Returns: Operation to observe
@discardableResult
func resendOTP(processId: String, completion: @escaping (Result<Void, WPNError>) -> Void) -> Operation? {
typealias Endpoint = Endpoints.Onboarding.ResendOTP
return networking.post(
data: Endpoint.EndpointType.RequestData(.init(processId: processId)),
to: Endpoint.endpoint,
encryptedWith: powerAuth.eciesEncryptorForApplicationScope(),
completion: { (result: WPNResponseBase?, error: WPNError?) in
assert(Thread.isMainThread)
if result?.status == .Ok {
completion(.success(()))
} else {
completion(.failure(error ?? WPNError(reason: .unknown)))
}
}
)
}
}
/// Class for all necessary communication for Identity Verification (After PowerAuth was enrolled with verification pending)
class IdentityVerification {
private let powerAuth: PowerAuthSDK
private let networking: WPNNetworkingService
init(networking: WPNNetworkingService) {
self.powerAuth = networking.powerAuth
self.networking = networking
}
/// Retrieves status of the Identity Verification status.
///
/// - Parameter completion: Result completion.
/// - Returns: Operation to observe.
@discardableResult
func getStatus(completion: @escaping (Result<IdentityStatusResponse, WPNError>) -> Void) -> Operation? {
typealias Endpoint = Endpoints.Identification.GetStatus
return networking.post(
data: Endpoint.EndpointType.RequestData(.init()),
signedWith: .possession(),
to: Endpoint.endpoint,
completion: { result, error in
assert(Thread.isMainThread)
if let data = result?.responseObject {
completion(.success(data))
} else {
completion(.failure(error ?? WPNError(reason: .unknown)))
}
}
)
}
/// Starts Identity Verification process.
///
/// - Parameters:
/// - processId: ID of the process
/// - completion: Result completion.
/// - Returns: Operation to observe
@discardableResult
func start(processId: String, completion: @escaping (Result<Void, WPNError>) -> Void) -> Operation? {
typealias Endpoint = Endpoints.Identification.Init
return networking.post(
data: Endpoint.EndpointType.RequestData(.init(processId: processId)),
signedWith: .possession(),
to: Endpoint.endpoint,
completion: { (result: WPNResponseBase?, error: WPNError?) in
assert(Thread.isMainThread)
if result?.status == .Ok {
completion(.success(()))
} else {
completion(.failure(error ?? WPNError(reason: .unknown)))
}
}
)
}
/// Cancel and clean the current verification process. Acts as a "reset".
///
/// - Parameters:
/// - processId: ID of the process.
/// - completion: Result completion.
/// - Returns: Operation to observe
@discardableResult
func cleanup(processId: String, completion: @escaping (Result<Void, WPNError>) -> Void) -> Operation? {
typealias Endpoint = Endpoints.Identification.Cancel
return networking.post(
data: Endpoint.EndpointType.RequestData(.init(processId: processId)),
signedWith: .possession(),
to: Endpoint.endpoint,
completion: { result, error in
assert(Thread.isMainThread)
if result?.status == .Ok {
completion(.success(()))
} else {
completion(.failure(error ?? WPNError(reason: .unknown)))
}
}
)
}
/// Retrieves a consent text (usually HTML) for user to approve/reject.
/// - Parameters:
/// - processId: ID of the process.
/// - completion: Result completion.
/// - Returns: Operation to observe.
@discardableResult
func getConsentText(processId: String, completion: @escaping (Result<String, WPNError>) -> Void) -> Operation? {
typealias Endpoint = Endpoints.Identification.ConsentText
return networking.post(
data: Endpoint.EndpointType.RequestData(.init(processId: processId)),
signedWith: .possession(),
to: Endpoint.endpoint,
completion: { result, error in
assert(Thread.isMainThread)
if let data = result?.responseObject {
completion(.success(data.consentText))
} else {
completion(.failure(error ?? WPNError(reason: .unknown)))
}
}
)
}
/// Approves or rejects privacy consent.
///
/// - Parameters:
/// - processId: ID of the process.
/// - approved: If the user approved the consent.
/// - completion: Result completion.
/// - Returns: Operation to observe.
@discardableResult
func resolveConsent(processId: String, approved: Bool, completion: @escaping (Result<Void, WPNError>) -> Void) -> Operation? {
typealias Endpoint = Endpoints.Identification.ConsentApprove
return networking.post(
data: Endpoint.EndpointType.RequestData(.init(processId: processId, approved: approved)),
signedWith: .possession(),
to: Endpoint.endpoint,
completion: { result, error in
assert(Thread.isMainThread)
if result?.status == .Ok {
completion(.success(()))
} else {
completion(.failure(error ?? WPNError(reason: .unknown)))
}
}
)
}
/// Provides necessary data to init scan SDK (like ZenID).
///
/// - Parameters:
/// - processId: ID of the process.
/// - challenge: Challenge that the SDK provided.
/// - completion: Result completion.
/// - Returns: Operation to observe.
@discardableResult
func initScanSDK(processId: String, challenge: String, completion: @escaping (Result<String, WPNError>) -> Void) -> Operation? {
typealias Endpoint = Endpoints.Identification.DocumentScanSdkInit
return networking.post(
data: Endpoint.EndpointType.RequestData(.init(processId: processId, attributes: .init(challengeToken: challenge))),
signedWith: .possession(),
to: Endpoint.endpoint,
encryptedWith: powerAuth.eciesEncryptorForActivationScope(),
completion: { (result: WPNResponse<SDKInitResponse>?, error: WPNError?) in
assert(Thread.isMainThread)
if let token = result?.responseObject?.attributes.responseToken {
completion(.success(token))
} else {
completion(.failure(error ?? WPNError(reason: .unknown)))
}
}
)
}
/// Submits documents necessary for identity verification (like photos of ID or passport).
///
/// Encrypted with the ECIES activation scope.
/// - Parameters:
/// - data: Data to be send.
/// You can use `WDODocumentPayloadBuilder.build` for easier use.
/// - progressCallback: Progress callback during upload.
/// - completion: Result completion..
/// - Returns: Operation to observe.
@discardableResult
func submitDocuments(data: DocumentSubmitRequest, progressCallback: ((Double) -> Void)? = nil, completion: @escaping (Result<Void, WPNError>) -> Void) -> Operation? {
typealias Endpoint = Endpoints.Identification.SubmitDocuments
return networking.post(
data: Endpoint.EndpointType.RequestData(data),
signedWith: .possession(),
to: Endpoint.endpoint,
encryptedWith: powerAuth.eciesEncryptorForActivationScope(),
timeoutInterval: 180,
progressCallback: progressCallback,
completion: { result, error in
assert(Thread.isMainThread)
if result?.status == .Ok {
completion(.success(()))
} else {
completion(.failure(error ?? WPNError(reason: .unknown)))
}
}
)
}
/// Asks for status of already uploaded documents.
///
/// - Parameters:
/// - processId: ID of the process.
/// - completion: Result completion.
/// - Returns: Operation to observe.
@discardableResult
func documentsStatus(processId: String, completion: @escaping (Result<DocumentStatusResponse, WPNError>) -> Void) -> Operation? {
typealias Endpoint = Endpoints.Identification.DocumentsStatus
return networking.post(
data: Endpoint.EndpointType.RequestData(.init(processId: processId)),
signedWith: .possession(),
to: Endpoint.endpoint,
timeoutInterval: 120,
completion: { result, error in
assert(Thread.isMainThread)
if let data = result?.responseObject {
completion(.success(data))
} else {
completion(.failure(error ?? WPNError(reason: .unknown)))
}
}
)
}
/// Starts presence check process (that user is actually physically present).
///
/// Encrypted with the ECIES activation scope.
/// - Parameters:
/// - processId: ID of the process.
/// - completion: Result completion.
/// - Returns: Operation to observe.
@discardableResult
func presenceCheckInit(processId: String, completion: @escaping (Result<PresenceCheckInitResponse, WPNError>) -> Void) -> Operation? {
typealias Endpoint = Endpoints.Identification.PresenceCheckInit
return networking.post(
data: Endpoint.EndpointType.RequestData(.init(processId: processId)),
signedWith: .possession(),
to: Endpoint.endpoint,
encryptedWith: powerAuth.eciesEncryptorForActivationScope(),
completion: { result, error in
assert(Thread.isMainThread)
if let data = result?.responseObject {
completion(.success(data))
} else {
completion(.failure(error ?? WPNError(reason: .unknown)))
}
}
)
}
/// Confirms presence check is done on the device.
///
/// Signed with PowerAuth possession factor.
/// - Parameters:
/// - processId: ID of the process.
/// - completion: Result completion.
/// - Returns: Operation to observe.
@discardableResult
func presenceCheckSubmit(processId: String, completion: @escaping (Result<Void, WPNError>) -> Void) -> Operation? {
typealias Endpoint = Endpoints.Identification.PresenceCheckSubmit
return networking.post(
data: Endpoint.EndpointType.RequestData(.init(processId: processId)),
signedWith: .possession(),
to: Endpoint.endpoint,
completion: { result, error in
assert(Thread.isMainThread)
if result?.status == .Ok {
completion(.success(()))
} else {
completion(.failure(error ?? WPNError(reason: .unknown)))
}
}
)
}
/// OTP resend in case that the user didn't received it.
///
/// - Parameters:
/// - processId: ID of the process.
/// - completion: Result completion.
/// - Returns: Operation to observe.
@discardableResult
func resendOTP(processId: String, completion: @escaping (Result<Void, WPNError>) -> Void) -> Operation? {
typealias Endpoint = Endpoints.Identification.ResendOTP
return networking.post(
data: Endpoint.EndpointType.RequestData(.init(processId: processId)),
signedWith: .possession(),
to: Endpoint.endpoint,
completion: { (result: WPNResponseBase?, error: WPNError?) in
assert(Thread.isMainThread)
if result?.status == .Ok {
completion(.success(()))
} else {
completion(.failure(error ?? WPNError(reason: .unknown)))
}
}
)
}
/// OTP verification during identification of the user.
///
/// - Parameters:
/// - processId: ID of the process.
/// - otp: OTP that user received.
/// - completion: Result completion.
/// - Returns: Operation to observe.
@discardableResult
func verifyOTP(processId: String, otp: String, completion: @escaping (Result<VerifyOTPResponse, WPNError>) -> Void) -> Operation? {
typealias Endpoint = Endpoints.Identification.VerifyOTP
return networking.post(
data: Endpoint.EndpointType.RequestData(.init(processId: processId, otpCode: otp)),
to: Endpoint.endpoint,
encryptedWith: powerAuth.eciesEncryptorForActivationScope(),
completion: { result, error in
assert(Thread.isMainThread)
if let data = result?.responseObject {
completion(.success(data))
} else {
completion(.failure(error ?? WPNError(reason: .unknown)))
}
}
)
}
}
}
#if ENABLE_ONBOARDING_DEMO
extension Networking.Onboarding {
/// Retrieves OTP needed for Onboarding Process.
///
/// Note that this method is available only in demo Wultra implementation.
/// Encrypted with the ECIES activation scope.
/// - Parameters:
/// - processId: ID of the onboarding process
/// - completion: Result completion.
/// - Returns: Operation to observe
@discardableResult
func getOTP(processId: String, type: OTPDetailType, completion: @escaping (Result<String, WPNError>) -> Void) -> Operation? {
typealias Endpoint = Endpoints.GetOTP
return networking.post(
data: Endpoint.EndpointType.RequestData(.init(processId: processId, otpType: type)),
to: Endpoint.endpoint,
encryptedWith: powerAuth.eciesEncryptorForApplicationScope(),
completion: { result, error in
assert(Thread.isMainThread)
if let data = result?.responseObject {
completion(.success(data.otpCode))
} else {
completion(.failure(error ?? WPNError(reason: .unknown)))
}
}
)
}
}
#endif