Tiqr

Tiqr, the open source authentication solution for smartphones and Web Applications.

Requirements

• iOS 11.0 +
• Swift 5 +

Installation

Swift Package Manager

The Swift Package Manager is a tool for managing the distribution of Swift code. It’s integrated with the Swift build system to automate the process of downloading, compiling, and linking dependencies.

To integrate Tiqr click File -> Add Packages -> and enter the package URL:

https://github.com/Tiqr/tiqr-app-core-ios

Select Tiqr and press Add Package

Usage

Make the navigationController returned by Tiqr.shared.startWithOptions() your rootViewController:

func scene(_ scene: UIScene, willConnectTo session: UISceneSession, options connectionOptions: UIScene.ConnectionOptions) {
    guard let windowScene = (scene as? UIWindowScene) else { return }

    window = UIWindow(windowScene: windowScene)
    window?.rootViewController = Tiqr.shared.startWithOptions(options: connectionOptions, theme: Theme())
    window?.makeKeyAndVisible()
}

Pass in your theme class based on TiqrThemeType to customize the appearance.

final class Theme: TiqrThemeType {
    let primaryColor: UIColor = UIColor(named: "PrimaryColor")!

    let headerFont: UIFont = .boldSystemFont(ofSize: 20)
    let bodyBoldFont: UIFont = .boldSystemFont(ofSize: 16)
    let bodyFont: UIFont = .systemFont(ofSize: 16)

    let buttonFont: UIFont = .systemFont(ofSize: 16)
    let buttonTintColor: UIColor = .black
    let buttonBackgroundColor: UIColor = UIColor(named: "PrimaryColor")!

    let aboutIcon: UIImage? = UIImage(named: "aboutIcon")
    let topBarIcon: UIImage? = UIImage(named: "topBarIcon")
    let bottomBarIcon: UIImage? = UIImage(named: "bottomBarIcon")
}

for push notification support add the following to your AppDelegate:

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
    let center = UNUserNotificationCenter.current()
    center.delegate = self
    center.requestAuthorization(options: [.alert, .sound]) { granted, error in
        if let error = error {
            print(error.localizedDescription)
        } else if granted {
            DispatchQueue.main.async {
                UIApplication.shared.registerForRemoteNotifications()
            }
        }
    }

    return true
}

extension AppDelegate {
    func application(_ application: UIApplication, didRegisterForRemoteNotificationsWithDeviceToken deviceToken: Data) {
        Tiqr.shared.registerDeviceToken(token: deviceToken)
        print("Successfully registered for notifications")
    }

    func application(_ app: UIApplication, open url: URL, options: [UIApplication.OpenURLOptionsKey : Any] = [:]) -> Bool {
        Tiqr.shared.startChallenge(challenge: url.absoluteString)
        return true
    }
}

extension AppDelegate: UNUserNotificationCenterDelegate {
    func userNotificationCenter(_ center: UNUserNotificationCenter, didReceive response: UNNotificationResponse, withCompletionHandler completionHandler: @escaping () -> Void) {
        let userInfo = response.notification.request.content.userInfo
        if let challenge = userInfo["challenge"] as? String {
            Tiqr.shared.startChallenge(challenge: challenge)
        }
    }
}

Localizing Tiqr Core

Tiqr Core is available in a number of languages. To facilitate handling updates to the needed localizations Xcode Localization Catalogs (folder with .xcloc extension) are used. These can be edited with Xcode or any other text editor to update the localization.

To export localization catalogs use:

xcodebuild -exportLocalizations -sdk iphoneos16.1 -localizationPath localizations -includeScreenshots -exportLanguage da -exportLanguage de -exportLanguage en -exportLanguage es -exportLanguage fr -exportLanguage fy -exportLanguage hr -exportLanguage it -exportLanguage ja -exportLanguage nb -exportLanguage nl -exportLanguage pl -exportLanguage pt -exportLanguage ro -exportLanguage sk -exportLanguage sl -exportLanguage sr -exportLanguage sv

To import localization catalogs use:

xcodebuild -importLocalizations -sdk iphoneos16.1 -localizationPath localizations/da.xcloc
xcodebuild -importLocalizations -sdk iphoneos16.1 -localizationPath localizations/de.xcloc
xcodebuild -importLocalizations -sdk iphoneos16.1 -localizationPath localizations/en.xcloc
xcodebuild -importLocalizations -sdk iphoneos16.1 -localizationPath localizations/es.xcloc
xcodebuild -importLocalizations -sdk iphoneos16.1 -localizationPath localizations/fr.xcloc
xcodebuild -importLocalizations -sdk iphoneos16.1 -localizationPath localizations/fy.xcloc
xcodebuild -importLocalizations -sdk iphoneos16.1 -localizationPath localizations/hr.xcloc
xcodebuild -importLocalizations -sdk iphoneos16.1 -localizationPath localizations/it.xcloc
xcodebuild -importLocalizations -sdk iphoneos16.1 -localizationPath localizations/ja.xcloc
xcodebuild -importLocalizations -sdk iphoneos16.1 -localizationPath localizations/nb.xcloc
xcodebuild -importLocalizations -sdk iphoneos16.1 -localizationPath localizations/nl.xcloc
xcodebuild -importLocalizations -sdk iphoneos16.1 -localizationPath localizations/pl.xcloc
xcodebuild -importLocalizations -sdk iphoneos16.1 -localizationPath localizations/pt.xcloc
xcodebuild -importLocalizations -sdk iphoneos16.1 -localizationPath localizations/ro.xcloc
xcodebuild -importLocalizations -sdk iphoneos16.1 -localizationPath localizations/sk.xcloc
xcodebuild -importLocalizations -sdk iphoneos16.1 -localizationPath localizations/sl.xcloc
xcodebuild -importLocalizations -sdk iphoneos16.1 -localizationPath localizations/sr.xcloc
xcodebuild -importLocalizations -sdk iphoneos16.1 -localizationPath localizations/sv.xcloc

Note that Xcode provides these actions also in its UI, but omits the option to set the SDK which makes the export fail due to defaulting to macOS, which is unsupported.

Apple App store configuration

Use ID's based on a domain name you own, below we use example.org. Replace this with your own domain.

Identifiers

Go to https://developer.apple.com/account/resources/identifiers/list/ to add the App Group and App ID Identifiers:

Replace myapp.example.org with a domain name you control. The assumes you have a testing and production version of the app.

Add "App Groups":

• group.org.example.myapp.testing - App group for Tiqr Test App
• group.org.example.myapp - App group for Tiqr App

Add "App IDs":"

• Bundle ID (explicit): org.example.myapp.testing.notifications Description: Tiqr Test Notifications Type: App Enable capabilities:

  • App Groups: group.org.example.myapp.testing
  • Push Notifications

• Bundle ID (explicit): org.example.myapp.testing Description: Tiqr Test App Type: App Enable capabilities:

  • App Groups: group.org.example.myapp.testing
  • Push Notifications

• Bundle ID (explicit): org.example.myapp.notifications Description: Tiqr Nofifications Type: App Enable capabilities:

  • App Groups: group.org.example.myapp
  • Push Notifications

• Bundle ID (explicit): org.example.myapp Description: Tiqr App Type: App Enable capabilities:

  • App Groups: group.org.example.myapp
  • Push Notifications