Merge pull request #223 from DP-3T/develop

Release 1.3.0

Author: stmitt

.github/workflows/build.yml

@@ -14,16 +14,16 @@ jobs:
     # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
     - uses: actions/checkout@v2
 
-    - name: Switch to Xcode 11.6
-      run: sudo xcode-select --switch /Applications/Xcode_11.6.app
+    - name: Switch to Xcode 11.7
+      run: sudo xcode-select --switch /Applications/Xcode_11.7.app
 
     # Generate xcode project
     - name: Generate xcodeproj
       run: swift package generate-xcodeproj --xcconfig-overrides Sources/Config.xcconfig
 
     # Compile project and run tests
     - name: Compile and run tests
-      run: fastlane scan
+      run: fastlane scan --disable_concurrent_testing true
 
   sampleapp:
     runs-on: macOS-latest
@@ -32,8 +32,8 @@ jobs:
     # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
     - uses: actions/checkout@v2
 
-    - name: Switch to Xcode 11.6
-      run: sudo xcode-select --switch /Applications/Xcode_11.6.app
+    - name: Switch to Xcode 11.7
+      run: sudo xcode-select --switch /Applications/Xcode_11.7.app
 
     # Compile sample app for iOS Simulator (no signing)
     - name: Compile and run tests

.github/workflows/deploy_to_cocoapods.yml

@@ -13,8 +13,8 @@ jobs:
     steps:
     - uses: actions/checkout@v1
 
-    - name: Switch to Xcode 11.6
-      run: sudo xcode-select --switch /Applications/Xcode_11.6.app
+    - name: Switch to Xcode 11.7
+      run: sudo xcode-select --switch /Applications/Xcode_11.7.app
 
     - name: Install Cocoapods
       run: gem install cocoapods

.github/workflows/distribute.yml

@@ -11,8 +11,8 @@ jobs:
     # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
     - uses: actions/checkout@v2
 
-    - name: Switch to Xcode 11.6
-      run: sudo xcode-select --switch /Applications/Xcode_11.6.app
+    - name: Switch to Xcode 11.7
+      run: sudo xcode-select --switch /Applications/Xcode_11.7.app
 
     - name: Run fastlane build
       env:

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog for DP3T-SDK iOS
 
+## Version 1.3.0 (29.09.2020)
+- Improve last day TEK export handling for iOS > 13.7 (must not disable EN until the following day)
+- Introduce new tracing error (.authorizationUnknown) to be able to handle users that did not grant (or revoked authorization by disabling exposure notifications in the iOS settings).
+- all apps using this SDK must specify ENDeveloperRegion and ENAPIVersion in their info.plist
+
 ## Version 1.2.1 (31.08.2020)
 - ensures that backgroundtask keeps running until outstandingPublishOperation is finished
 

DP3TSDK.podspec

@@ -2,7 +2,7 @@
 Pod::Spec.new do |spec|
 
   spec.name         = "DP3TSDK"
-  spec.version      = ENV['LIB_VERSION'] || '1.2.1'
+  spec.version      = ENV['LIB_VERSION'] || '1.3'
   spec.summary      = "Open protocol for COVID-19 proximity tracing using Bluetooth Low Energy on mobile devices"
 
   spec.description  = <<-DESC

README.md

@@ -74,7 +74,7 @@ DP3T-SDK is available through [Cocoapods](https://cocoapods.org/)
 
   ```ruby
 
-  pod 'DP3TSDK', => '1.2.1'
+  pod 'DP3TSDK', => '1.3'
 
   ```
 
@@ -164,6 +164,17 @@ The SDK supports iOS 13 background tasks. It uses the provided `exposure-notific
 
 If a `DP3TBackgroundHandler` was passed to the SDK on initialisation it will be called on each background task execution by the SDK.
 
+## Apps using the DP3T-SDK for iOS
+Name | Country | Source code | Store | Release-Date
+---- | ----------- | ------------- | ------------- | -------------
+SwissCovid | Switzerland | [Github](https://github.com/DP-3T/dp3t-app-ios-ch) | [AppStore](https://apps.apple.com/ch/app/swisscovid/id1509275381) | 25. Mai 2020
+ASI | Ecuador | [minka.gob.ec](https://minka.gob.ec/asi-ecuador/ios) | [AppStore](https://apps.apple.com/app/id1523594087) | 2. August 2020
+Hoia | Estonia | [koodivaramu.eesti.ee](https://koodivaramu.eesti.ee/tehik/hoia/dp3t-app-ios) | [AppStore](https://apps.apple.com/app/id1515441601) | 19. August 2020
+STAYAWAY COVID | Portugal | [Github](https://github.com/stayawayinesctec/stayaway-app) | [AppStore](https://apps.apple.com/pt/app/id1519479652) | 28. August 2020
+ Radar COVID | Spain | [Github](https://github.com/RadarCOVID/radar-covid-ios) | [AppStore](https://apps.apple.com/es/app/radar-covid/id1520443509) |
+
+If your project/country is not yet listed but uses the DP3T-SDK feel free to send a pull-request to add it to the [README](README).
+
 ## License
 
 This project is licensed under the terms of the MPL 2 license. See the [LICENSE](LICENSE) file.

SampleApp/DP3TSampleApp/ControlViewController.swift

@@ -407,7 +407,15 @@ class ControlViewController: UIViewController {
     }
 
     @objc func resetInfectionState() {
-        try? DP3TTracing.resetInfectionStatus()
+        do {
+            try DP3TTracing.resetInfectionStatus()
+        } catch let error as DP3TTracingError {
+            let ac = UIAlertController(title: "Error",
+                                       message: error.description,
+                                       preferredStyle: .alert)
+            ac.addAction(.init(title: "OK", style: .destructive))
+            self.present(ac, animated: true)
+        } catch {}
     }
 
     @objc func resetExposureDays() {
@@ -537,13 +545,17 @@ extension DP3TTracingError {
         case let .networkingError(error: error):
             return "networkingError \(error.localizedDescription)"
         case .permissonError:
-            return "networkingError"
+            return "permissionError"
+        case .authorizationUnknown:
+            return "authorizationUnknown"
         case .userAlreadyMarkedAsInfected:
             return "userAlreadyMarkedAsInfected"
         case let .exposureNotificationError(error: error):
             return "exposureNotificationError \(error.localizedDescription)"
         case .cancelled:
             return "cancelled"
+        case .infectionStatusNotResettable:
+            return "infectionStatusNotResettable"
         }
     }
 }

SampleApp/fastlane/Fastfile

@@ -4,18 +4,12 @@ platform :ios do
   desc "Push a new build to AppCenter"
   lane :distribute do
 
-  create_keychain(
-    name: "githubactionci",
-    password: "githubkeychain",
-    default_keychain: true,
-    unlock: true
-  )
+  # Create temporary keychain,...
+  setup_ci
 
   match(
     type: "development",
-    readonly: is_ci,
-    keychain_name: "githubactionci",
-    keychain_password: "githubkeychain"
+    readonly: is_ci
   )
 
   update_code_signing_settings(

Sources/DP3TSDK/Background/DP3TBackgroundTaskManager.swift

@@ -130,7 +130,8 @@ class DP3TBackgroundTaskManager {
 
         let outstandingPublishOperation = OutstandingPublishOperation(keyProvider: keyProvider,
                                                                       serviceClient: serviceClient,
-                                                                      runningInBackground: true)
+                                                                      runningInBackground: true,
+                                                                      tracer: tracer)
         completionGroup.enter()
         outstandingPublishOperation.completionBlock = {
             completionGroup.leave()

Sources/DP3TSDK/Background/OutstandingPublishOperation.swift

@@ -20,17 +20,28 @@ class OutstandingPublishOperation: Operation {
 
     private let runningInBackground: Bool
 
+    private var defaults: DefaultStorage
+
+    private var tracer: Tracer
+
     var now: Date {
         .init()
     }
 
     static let serialQueue = DispatchQueue(label: "org.dpppt.outstandingPublishQueue")
 
-    init(keyProvider: DiagnosisKeysProvider, serviceClient: ExposeeServiceClientProtocol, storage: OutstandingPublishStorage = OutstandingPublishStorage(), runningInBackground: Bool) {
+    init(keyProvider: DiagnosisKeysProvider,
+         serviceClient: ExposeeServiceClientProtocol,
+         storage: OutstandingPublishStorage = OutstandingPublishStorage(),
+         runningInBackground: Bool,
+         defaults: DefaultStorage = Default.shared,
+         tracer: Tracer) {
         self.keyProvider = keyProvider
         self.serviceClient = serviceClient
         self.storage = storage
         self.runningInBackground = runningInBackground
+        self.defaults = defaults
+        self.tracer = tracer
     }
 
     override func main() {
@@ -53,6 +64,12 @@ class OutstandingPublishOperation: Operation {
                     // ignore outstanding keys older than one day, upload token will be invalid
                     logger.log("skipping outstanding key %{public}@ because of age and removing publish from storage", op.debugDescription)
                     storage.remove(publish: op)
+
+                    // if we are running on iOS > 13.7 we need to disable the tracing
+                    if #available(iOS 13.7, *), !op.fake {
+                        tracer.setEnabled(false, completionHandler: nil)
+                    }
+                    enableResettingOfInfectionStatus(fake: op.fake)
                     continue
                 }
 
@@ -88,7 +105,13 @@ class OutstandingPublishOperation: Operation {
                 } else {
                     // get all keys up until today
                     group.enter()
-                    keyProvider.getDiagnosisKeys(onsetDate: nil, appDesc: serviceClient.descriptor) { result in
+
+                    // if we are running on iOS > 13.7 we need to disable the tracing after retreiving the key
+                    var disableAfterCompletion = false
+                    if #available(iOS 13.7, *) {
+                        disableAfterCompletion = true
+                    }
+                    keyProvider.getDiagnosisKeys(onsetDate: nil, appDesc: serviceClient.descriptor, disableExposureNotificationAfterCompletion: disableAfterCompletion) { result in
                         switch result {
                         case let .success(keys):
                             let rollingStartNumber = DayDate(date: op.dayToPublish).period
@@ -114,6 +137,8 @@ class OutstandingPublishOperation: Operation {
                         logger.error("could not retrieve key")
                     }
 
+                    enableResettingOfInfectionStatus(fake: op.fake)
+
                     logger.log("removing publish operation %{public}@ from storage", op.debugDescription)
                     storage.remove(publish: op)
 
@@ -153,12 +178,23 @@ class OutstandingPublishOperation: Operation {
                     logger.log("removing publish operation %{public}@ from storage", op.debugDescription)
                     storage.remove(publish: op)
 
+                    enableResettingOfInfectionStatus(fake: op.fake)
+
                     self.cancel()
                     return
                 }
                 logger.log("successfully published %{public}@ removing publish from storage", op.debugDescription)
                 storage.remove(publish: op)
+
+                enableResettingOfInfectionStatus(fake: op.fake)
             }
         }
     }
+    
+    fileprivate func enableResettingOfInfectionStatus(fake: Bool){
+        if !fake {
+            self.logger.log("enabling resetting of infection status")
+            self.defaults.infectionStatusIsResettable = true
+        }
+    }
 }

Sources/DP3TSDK/Cryptography/DiagnosisKeysProvider.swift

@@ -16,7 +16,7 @@ protocol DiagnosisKeysProvider: class {
 
     func getFakeKeys(count: Int, startingFrom: Date) -> [CodableDiagnosisKey]
 
-    func getDiagnosisKeys(onsetDate: Date?, appDesc: ApplicationDescriptor, completionHandler: @escaping (Result<[CodableDiagnosisKey], DP3TTracingError>) -> Void)
+    func getDiagnosisKeys(onsetDate: Date?, appDesc: ApplicationDescriptor, disableExposureNotificationAfterCompletion: Bool, completionHandler: @escaping (Result<[CodableDiagnosisKey], DP3TTracingError>) -> Void)
 }
 
 extension DiagnosisKeysProvider {
@@ -41,7 +41,7 @@ extension DiagnosisKeysProvider {
 fileprivate var logger = Logger(.main, category: "DiagnosisKeysProvider")
 
 extension ENManager: DiagnosisKeysProvider {
-    func getDiagnosisKeys(onsetDate: Date?, appDesc: ApplicationDescriptor, completionHandler: @escaping (Result<[CodableDiagnosisKey], DP3TTracingError>) -> Void) {
+    func getDiagnosisKeys(onsetDate: Date?, appDesc: ApplicationDescriptor, disableExposureNotificationAfterCompletion: Bool, completionHandler: @escaping (Result<[CodableDiagnosisKey], DP3TTracingError>) -> Void) {
         logger.trace()
         if !exposureNotificationEnabled {
             // Enable exposure notifications first, if currently not enabled (e.g. last day key)
@@ -55,8 +55,7 @@ extension ENManager: DiagnosisKeysProvider {
                 }
             }
         } else {
-            // Do not disable if it's currently already enabled
-            self.getDiagnosisKeysInternal(onsetDate: onsetDate, appDesc: appDesc, disableExposureNotificationAfterCompletion: false, completionHandler: completionHandler)
+            self.getDiagnosisKeysInternal(onsetDate: onsetDate, appDesc: appDesc, disableExposureNotificationAfterCompletion: disableExposureNotificationAfterCompletion, completionHandler: completionHandler)
         }
     }
 

Sources/DP3TSDK/DP3TError.swift

@@ -31,11 +31,17 @@ public enum DP3TTracingError: Error {
     /// Bluetooth device turned off
     case bluetoothTurnedOff
 
-    /// Bluetooth permission error
+    /// User has not been prompted for authorization yet (using startTracing() will prompt the user).
+    case authorizationUnknown
+
+    /// The user either denied authorization or region is not active
     case permissonError
 
     /// The user was marked as infected
     case userAlreadyMarkedAsInfected
+
+    /// the infection status is not resettable currently
+    case infectionStatusNotResettable
 }
 
 /// A set of networking errors returned from the SDK

Sources/DP3TSDK/DP3TSDK.swift

@@ -178,7 +178,10 @@ class DP3TSDK {
 
         let group = DispatchGroup()
 
-        let outstandingPublishOperation = OutstandingPublishOperation(keyProvider: diagnosisKeysProvider, serviceClient: service, runningInBackground: runningInBackground)
+        let outstandingPublishOperation = OutstandingPublishOperation(keyProvider: diagnosisKeysProvider,
+                                                                      serviceClient: service,
+                                                                      runningInBackground: runningInBackground,
+                                                                      tracer: tracer)
         group.enter()
         outstandingPublishOperation.completionBlock = {
             group.leave()
@@ -266,7 +269,7 @@ class DP3TSDK {
             }
         } else {
             group.enter()
-            diagnosisKeysProvider.getDiagnosisKeys(onsetDate: onset, appDesc: applicationDescriptor) { result in
+            diagnosisKeysProvider.getDiagnosisKeys(onsetDate: onset, appDesc: applicationDescriptor, disableExposureNotificationAfterCompletion: false) { result in
                 diagnosisKeysResult = result
                 group.leave()
             }
@@ -294,15 +297,23 @@ class DP3TSDK {
                                              delayedKeyDate: DayDate())
 
                 self.service.addExposeeList(model, authentication: authentication) { [weak self] result in
+                    guard let self = self else { return }
                     DispatchQueue.main.async {
                         switch result {
                         case let .success(outstandingPublish):
                             if !isFakeRequest {
-                                self?.state.infectionStatus = .infected
-                                self?.tracer.setEnabled(false, completionHandler: nil)
+                                self.state.infectionStatus = .infected
+                                if #available(iOS 13.7, *) {
+                                    // if we are running on iOS > 13.7 we have to keep EN framework running in order to export the key of the last day
+                                    // EN framework will later get disabled
+                                    self.log.log("disable resetting of infection status")
+                                    self.defaults.infectionStatusIsResettable = false
+                                } else {
+                                    self.tracer.setEnabled(false, completionHandler: nil)
+                                }
                             }
 
-                            self?.outstandingPublishesStorage.add(outstandingPublish)
+                            self.outstandingPublishesStorage.add(outstandingPublish)
 
                             callback(.success(()))
                         case let .failure(error):
@@ -314,6 +325,10 @@ class DP3TSDK {
         }
     }
 
+    var isInfectionStatusResettable: Bool {
+        defaults.infectionStatusIsResettable
+    }
+
     /// reset exposure days
     func resetExposureDays() throws {
         exposureDayStorage.markExposuresAsDeleted()
@@ -322,6 +337,9 @@ class DP3TSDK {
 
     /// reset the infection status
     func resetInfectionStatus() throws {
+        guard defaults.infectionStatusIsResettable else {
+            throw DP3TTracingError.infectionStatusNotResettable
+        }
         state.infectionStatus = .healthy
     }
 

Sources/DP3TSDK/DP3TTracing.swift

@@ -28,7 +28,7 @@ private var instance: DP3TSDK!
 /// DP3TTracing
 public enum DP3TTracing {
     /// The current version of the SDK
-    public static let frameworkVersion: String = "1.2.1"
+    public static let frameworkVersion: String = "1.3"
 
     /// sets global parameter values which are used throughout the sdk
     public static var parameters: DP3TParameters {
@@ -150,6 +150,15 @@ public enum DP3TTracing {
         try instance.resetExposureDays()
     }
 
+    /// checks if infection status is resettable
+
+    public static var isInfectionStatusResettable: Bool {
+        guard instance != nil else {
+            fatalError("DP3TSDK not initialized call `initialize(with:delegate:)`")
+        }
+        return instance.isInfectionStatusResettable
+    }
+
     /// reset the infection status
 
     public static func resetInfectionStatus() throws {