ZConnect COVID Certificate Verifier SDK - iOS

About SDK

This repository contains the source code of ZConnectVerificaC19SDK, SDK for iOS written in Swift based on official it-dgc-verificac19-sdk-android. The repository is forked from the official VerificaC19 App - iOS.

The SDK allows verifying DCCs using public keys from Italy backend servers. Offline verification is supported, if the latest public keys are present in the app's key store. Consequently, once up-to-date keys have been downloaded, the verification works without active internet connection.

Development

Prerequisites

You need a Mac to run Xcode.
Xcode 13+ is used for our builds. The OS requirement is macOS 11.0+.
Service Endpoints:
- This Library talks to the endpoint: https://get.dgc.gov.it/v1/dgc/ to retrieve kids, public keys, settings and medical rules for prod configuration,
- To get QR Codes for testing, you might want to check out https://dgc.a-sit.at/ehn/testsuite.

Swift Package Manager

You can add this SDK as a package dependecy by using Swift Package Manager tool which is already integrated into the swift compiler.

dependencies: [
    .package(
        url: "https://github.com/hrzucchetti/zconnect-verificaC19-sdk-ios.git", 
        .branch("release/latest")
    )
]

Dependencies

The following dependencies are used in the project by the verifier SDK and the core app and are imported as Swift Packages:

SwiftDGC. Eurpean core library that contains business logic to decode data from QR code payload and performs technical validations (i.e. correct signature verification, signature expiration verification, correct payload format etc).
Alamofire. Library used for networking.
JSONSchema. Library used by core module to validate DCC payload JSON schema.
SwiftCBOR. Library used by core module for CBOR specification implementation.
SwiftyJSON. Library used by core module to translate data from JSON format.

Usage

Use DataSynchronizer class to fetch data from backend
Ensure you are calling sync method at least every 24 hours to keep rules settings and signature keys up to date

    let synchronizer = DataSynchronizer()
    synchronizer.sync { result in
        switch result {
        case .updated:
            break
        case .sdkOutdated:
            break
        case .error(let error):
            break
        }
    }

Use Certificate class to get a simplified model of certificate content

    let certificate: Certificate? = Certificate(from: qrCodeContent)

Use CertificateValidator class to get a simplified status of given certificate. CertificateValidator can be instantiated by one of the following initializers

    let validator = CertificateValidator(payload: qrCodeContent)

    let validator = CertificateValidator(certificate: certificate!)

Call validate method and give one of the following scan mode and success handler to get the certificate status

scanModeBase = Green Pass "base"

    validator.validate(scanMode: .scanModeBase, onSuccessHandler: { status in
        switch status {
        case .valid:
            //certificate is valid
            break
        case .notValid, .notGreenPass:
            //certificate is not valid
            break
        }
    })

Support and feedback

The following channels are available for discussions, feedback, and support requests:

Type	Channel
Issues

How to contribute

Contribution and feedback is encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see our Contribution Guidelines. By participating in this project, you agree to abide by its Code of Conduct at all times.

Contributors

Our commitment to open source means that we are enabling -in fact encouraging- all interested parties to contribute and become part of its developer community.

Licensing

See the NOTICE for all copyright and licensing details.

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 https://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.

hrzucchetti / zconnect-verificaC19-sdk-ios