PowerAuth Mobile SDK for iOS and tvOS Extensions

Introduction

The PowerAuth Mobile SDK Extensions library is a lightweight counterpart to the full-featured PowerAuth Mobile SDK, providing limited functionality, such as:

Retrieving information about activation presence
Obtaining authentication tokens

If you need to perform more operations in your extension, such as calculating PowerAuth symmetric signatures, you can use the full-featured PowerAuth mobile SDK. This can be achieved by configuring activation data sharing in both your application and the extension.

Installation

This chapter describes how to get PowerAuth SDK for iOS and tvOS Extensions up and running in your app. In the current version, you can choose between CocoaPods and manual library integration. Both types of installation will lead to your app extension linked with a dynamic library, provided by the PowerAuth2ForExtensions.[xc]framework.

To distinguish between SDKs, the following short terms will be used in this document:

iOS SDK, as short term for PowerAuth SDK for iOS and tvOS
Extensions SDK as short term for PowerAuth SDK for iOS and tvOS Extensions

CocoaPods

CocoaPods is a dependency manager for Cocoa projects. You can install it with the following command:

$ gem install cocoapods

To integrate the PowerAuth library into your Xcode project using CocoaPods, specify it in your Podfile:

platform :ios, '11.0'

target 'YourAppTarget' do
  pod 'PowerAuth2'
end

target 'YourExtensionTarget' do
  pod 'PowerAuth2ForExtensions'
end

Then, run the following command:

$ pod install

Manual

If you prefer not to use CocoaPods as a dependency manager, you can integrate Extensions SDK into your project manually as a git submodule.

Git Submodules

The integration process is quite similar to the integration of our iOS library:

Open up the Terminal.app and go to your top-level project directory and add the library as a submodule:
```
$ git submodule add https://github.com/wultra/powerauth-mobile-sdk.git PowerAuthLib
$ git submodule update --init --recursive
```
The first command will clone PowerAuth SDK into the PowerAuthLib folder and the second, will update all nested submodules. We're expecting that you already did this when you integrated PowerAuth into your application.
Open the new PowerAuthLib folder, and go to the proj-xcode sub-folder
Drag the PowerAuthExtensionSdk.xcodeproj project file into Project Navigator of your application's Xcode project. It should appear nested underneath your application's blue project icon.
Select your application project in the Project Navigator to navigate to the target configuration window and select the extension's target under the TARGETS heading in the sidebar.
Now select Build Phases tab and expand Target Dependencies section. Click on the "Plus Sign" and choose "PowerAuth2ForExtensions" framework from the "PowerAuthExtensionSdk" project.
Next, in the same Build Phases tab expand Link With Libraries section. Click on the "Plus Sign" and choose "PowerAuth2ForExtensions.framework" from the "PowerAuthExtensionSdk" project.

Configuration

The Extensions SDK shares several source codes and configuration principles with the main iOS SDK. So, you can prepare the same set of constants as you're already using in your IOS application. The SDK provides just a limited functionality for app extension (for example, you cannot create an activation or calculate a full PowerAuth signature from an extension) and to do that it requires access to an activation data, created in the main application.

Prepare Data Sharing

The App Extension normally doesn't have access to data created by the main application, so the first step is to set up data sharing for your project.

Keychain Sharing

iOS SDK stores its most sensitive data into the iOS keychain, so you need to configure the keychain sharing first. If you're not familiar with keychain sharing, then don't worry about that, the keychain is shared only between the vendor's applications. So the sensitive information is not exposed to 3rd party applications.

Select your application project in the Project Navigator to navigate to the target configuration window and select the applications's target under the TARGETS heading in the sidebar.
Now select Signing & Capabilities tab and click + Capability button.
Find and add Keychain Sharing capability.
Click "+" in just created Keychain Sharing capability and Xcode will predefine first Keychain Group to your application's bundle name. Let's call this value as KEYCHAIN_GROUP_NAME

The predefined group is usually beneficial because iOS is by default using that group for storing all keychain entries created in the application. So, If your application is already using PowerAuth and you're going to just add extension support, then this is the most simple way to set up a keychain sharing.

Now you have to do a similar setup for your application's extension:

Select your application project in the Project Navigator to navigate to the target configuration window and select the extensions's target under the TARGETS heading in the sidebar.
Select Signing & Capabilities tab and click + Capability button.
Find and add Keychain Sharing capability.
Click "+" in just created Keychain Sharing capability and add the same KEYCHAIN_GROUP_NAME as you did for the application's target.
(optional) Repeat steps 4 to 6 for all other extensions which supposed to use Extensions SDK.

Now you need to know your Team ID (the unique identifier assigned to your team by Apple). Unfortunately, the identifier is not simply visible in Xcode, so you'll have to log in to Apple's development portal and look for that identifier on your membership details page.

If you know the Team ID, then the final KEYCHAIN_GROUP_IDENTIFIER constant is composed as TEAM_ID.KEYCHAIN_GROUP_NAME. So, it should look like: KTT00000MR.com.powerauth.demo.App.

App Groups

The PowerAuth SDK for iOS is using one boolean flag stored in the UserDefaults facility, to determine whether the application has been reinstalled. Unfortunately, the UserDefaults.standard created by the application cannot be shared with the app extension, so you have to create a new application group to share that data.

Select your application project in the Project Navigator to navigate to the target configuration window and select the applications's target under the TARGETS heading in the sidebar.
Now select Signing & Capabilities tab and click + Capability button.
Find and add App Groups capability.
Click "+" in just created App Groups capability add a group with the desired identifier and turn this particular group ON (e.g. make sure that the checkmark close to the group's name is selected). Let's call this value APP_GROUP_IDENTIFIER. If the group already exists, then just click the checkmark to turn it ON.
Now switch to the application's extension target, select the Capabilities tab, and also expand the App Groups section.
Turn "ON" App Groups for extension and add an app group with the same name as you did in step 3.

You can optionally check a troubleshooting section if you need to migrate the keychain initialization flag from standard user defaults to a shared one.

While all previous steps are optional, they are highly recommended. If the keychain is properly shared, then the Extension SDK can determine the status of the PowerAuth activation just from the content of keychain data. But still, this has a drawback, because the keychain data persists between the application's reinstallation. As you can see, in a couple of rare usage scenarios the extension may get inaccurate information about the activation.

Configure PowerAuth for Extension

If the data sharing is right, then the configuration of PowerAuth SDK for iOS Extension is pretty straightforward:

import PowerAuth2ForExtensions

class TodayViewController: UIViewController, NCWidgetProviding {

    // Lazy initialized variable
    private var powerAuthExt: PowerAuthExtensionSDK = {
        return TodayViewController.setupPowerAuth()
    }()

    private static func setupPowerAuth() -> PowerAuthExtensionSDK {
        let config = PowerAuthConfiguration(
            instanceId: Bundle.main.bundleIdentifier!,
            baseEndpointUrl: "https://localhost:8080/demo-server",
            configuration: "ARDDj6EB6iAUtNm...KKEcBxbnH9bMk8Ju3K1wmjbA==")

        let keychainConfig = PowerAuthKeychainConfiguration.sharedInstance()
        keychainConfig.keychainAttribute_AccessGroup = "KEYCHAIN_GROUP_IDENTIFIER"
        keychainConfig.keychainAttribute_UserDefaultsSuiteName = "APP_GROUP_IDENTIFIER"

        return PowerAuthExtensionSDK(configuration: config, keychainConfiguration: keychainConfig)!
    }

    // ... the rest of the controller's code ...
}

IMPORTANT: The configuration used above must match the configuration used in the application otherwise your extension will never get a proper activation status.

The Extensions SDK doesn't provide a shared instance for the PowerAuthExtensionSDK class and therefore you have to manage that instance on your own. The example above shows the beginning of a simple controller implementing an extension for the Today Widget. For all other code examples, we're going to use this.powerAuthExt as a properly initialized instance of the PowerAuthExtensionSDK object.

Getting Device Activation Status

Unlike the iOS SDK, the Extension SDK provides only limited information about activation status. You can check only whether there's locally stored activation or not:

if this.powerAuthExt.hasValidActivation() {
    // main application has a valid activation locally stored
}

Token-Based Authentication

WARNING: Before you start using access tokens, please visit our wiki page for powerauth-crypto for more information about this feature. You can also check the documentation about tokens available in PowerAuth SDK for iOS.

Getting Token

To get an access token, you can use the following code:

if let token = this.powerAuthExt.tokenStore.localToken(withName: "MyToken") {
    // you have a token that can generate authorization headers
}

Note that the token store also provides the requestAccessToken() method, but that always returns the PowerAuthErrorCode.invalidToken error. Unlike the iOS SDK API, you cannot get a token from the server from the app extension. Only the main application can do that and once the token is available, then it's also available for the app extension. Check PowerAuth SDK for iOS documentation for more details.

Generating Authorization Header

Once you have a PowerAuthToken object, use the following code to generate an authorization header:

if let header = token.generateHeader() {
    let httpHeader = [ header.key : header.value ]
    // now you can attach that httpHeader to your HTTP request
} else {
    // in case of nil, the token is no longer valid
}

Removing Token Locally

The token store exposes the removeLocalToken() method, but the implementation does nothing.

Removing Token From the Server

The token store exposes the removeAccessToken() method, but the implementation always returns the PowerAuthErrorCode.invalidToken error.

Common SDK Tasks

Error Handling

You can follow the same practices as for iOS SDK because the Extensions SDK codebase shares the same error constants with a full PowerAuth SDK for iOS.

Debug Build Detection

It is sometimes useful to switch Extensions SDK to a DEBUG build configuration, to get more logs from the library:

CocoaPods: we currently don't provide DEBUG pod. This will be resolved in some future versions of Extensions SDK.
Manual installation: Xcode matches build configuration across all nested projects, so you usually don't need to care about the configuration switching.

The DEBUG build is usually helpful during application development, but on the other side, it's highly unwanted in production applications. For this purpose, the PowerAuthSystem.isInDebug() method provides information on whether the PowerAuth for Extensions library was compiled in DEBUG configuration. It is a good practice to check this flag and crash the process when the production application is linked against the DEBUG library:

#if YOUR_APPSTORE_BUILD_FLAG
    // Final vs Debug library trap
    if PowerAuthSystem.isInDebug() {
        fatalError("CRITICAL ERROR: You're using Debug PowerAuth library in production build.")
    }
#endif

Troubleshooting

This section of the document contains various workarounds and tips for Extensions SDK usage.

UserDefaults Migration

If your previous version of the application did not use shared data between the application and the extension, then you probably need to migrate the keychain status flag from UserDefaults.standard to a shared one. We recommend performing this migration at the main application's startup code and BEFORE the PowerAuthSDK object is configured and used:

private func migrateUserDefaults() {
    let keychainConfig = PowerAuthKeychainConfiguration.sharedInstance()
    let suiteName = keychainConfig.keychainAttribute_UserDefaultsSuiteName
    guard let shared = UserDefaults(suiteName: suiteName) else {
        return // data sharing is probably not configured properly
    }
    if shared.bool(forKey: PowerAuthKeychain_Initialized) {
        return // migration is not required
    }
    let standard = UserDefaults.standard
    if standard.bool(forKey: PowerAuthKeychain_Initialized) {
        standard.removeObject(forKey: PowerAuthKeychain_Initialized)
        standard.synchronize()
        shared.set(true, forKey: PowerAuthKeychain_Initialized)
        shared.synchronize()
    }
}

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

PowerAuth-SDK-for-iOS-Extensions.md

PowerAuth-SDK-for-iOS-Extensions.md

PowerAuth Mobile SDK for iOS and tvOS Extensions

Table of Contents

Introduction

Installation

CocoaPods

Manual

Git Submodules

Configuration

Prepare Data Sharing

Keychain Sharing

App Groups

Configure PowerAuth for Extension

Getting Device Activation Status

Token-Based Authentication

Getting Token

Generating Authorization Header

Removing Token Locally

Removing Token From the Server

Common SDK Tasks

Error Handling

Debug Build Detection

Troubleshooting

UserDefaults Migration

Files

PowerAuth-SDK-for-iOS-Extensions.md

Latest commit

History

PowerAuth-SDK-for-iOS-Extensions.md

File metadata and controls

PowerAuth Mobile SDK for iOS and tvOS Extensions

Table of Contents

Introduction

Installation

CocoaPods

Manual

Git Submodules

Configuration

Prepare Data Sharing

Keychain Sharing

App Groups

Configure PowerAuth for Extension

Getting Device Activation Status

Token-Based Authentication

Getting Token

Generating Authorization Header

Removing Token Locally

Removing Token From the Server

Common SDK Tasks

Error Handling

Debug Build Detection

Troubleshooting

UserDefaults Migration