Trust Idiom/ID SDK for iOS V2 導入マニュアル

1. 変更履歴

Table 1. TrustIDSDK 2.0.1変更点
変更箇所	内容
`メソッド追加`	linkAccount、showAccountのメソッドを追加。

2. はじめに

本ドキュメントは Trust Idiom/ID を導入される企業様に向けた、モバイルアプリ (iOS) 向けの SDK のインストール方法、実装方法などをまとめたマニュアルです。本ドキュメント及び SDK の構成については今後変更される場合があります。

2.1. 動作環境

SDK は以下の環境での動作を保証しています。

Table 2. 動作環境
OS	iOS 13.x 以上
アーキテクチャ	ARM

FIDO に使用している NC7000-3A-FS は x86 アーキテクチャの動作をサポートしていないため、iOS シミュレータでのデバッグ・実行は行えません。動作確認を行う際は iOS デバイスをご用意ください。

2.2. ライブラリ構成

SDK は以下のモジュールで構成されています。

Table 3. SDK の構成
モジュール名	説明
TrustIDSDK	Trust Idiom/ID SDK のコアモジュール
NCAdapter	NC7000-3A-FS のアダプターモジュール

Trust Idiom/ID SDK の基本機能は TrustIDSDK モジュールに搭載されています。その中で FIDO (生体認証など) に関わる機能は NC7000-3A-FS を包含した nc-adapter モジュールで提供しています。

2.3. NC7000-3A-FS について

NC7000-3A-FS は日本電気株式会社（NEC）製のネイティブアプリ向けの FIDO UAF1.1 に対応した認証機能の SDK です。

Trust Idiom/ID では FIDO 機能に NC7000-3A-FS を使用しているため、FIDO 機能の振る舞いを含めた仕様は本製品に準拠します。

Table 4. NC7000-3A-FS バージョン
バージョン
1.5.7

3. SBIデジトラスト株式会社へ一部プロジェクト情報を提出する

NC7000-3A-FS を利用するためには、SBIデジトラスト株式会社へ以下の一部プロジェクト情報を事前に提出いただく必要があります。具体的な提出方法に関しては、個別に担当者へご相談ください。

3.1. バンドルID(Bundle identifier)

NC7000-3A-FS のライセンス文字列を発行するには、導入先 iOS プロジェクトのバンドルID が必要です。

4. Firebase SDK のインストール

Trust Idiom/ID は Firebase のサービスである Firebase Cloud Messaging (以下 FCM) を利用しています。

Push 通知機能を利用する場合は Firebase SDK のインストールが必要です。Firebase SDK の導入手順は以下のドキュメントを参考にしてください。

Firebase を iOS プロジェクトに追加する

Firebase は次のサービスを利用します。

Firebase Cloud Messaging (FCM)

5. Trust Idiom/ID SDK のインストール

5.1. インストールする方法

Trust Idiom/ID SDK は Zip ファイルとして提供しています。担当者から受領した上でインストールを進めてください。

5.2. Trust Idiom/ID SDK のインストール

5.2.1. Xcode へのインポート

Zip ファイルを解凍すると次のファイル構成になっていることが確認できます。

Table 5. SDK のファイル構成
ファイルまたはフォルダ名	説明
`TrustIDSDK.framework`	Trust Idiom/ID SDK フレームワーク
`TrustID-Info.plist`	Trust Idiom/ID SDK の設定ファイル
`NCAdapter.framework`	NC7000-3A-FS 拡張フレームワーク
`NCPlugin◯◯.framework`	NC7000-3A-FS トランザクション認証拡張フレームワーク
`FIDO`	FIDO ライブラリおよび設定ファイル

これらのファイル・フォルダを Xcode プロジェクトにドラッグ&ドロップで追加します。具体的な内容については下記手順を参照してください。

TrustIDSDK.framework TrustID-Info.plist NCAdapter.framework NCPlugin◯◯.framework は「Copy items if needed」にチェックが付いていること、「Create folder references」を確認します。

FIDO は「Copy items if needed」にチェックが付いていること、「Create Groups」にチェックが付いていることを確認します。

下図のようになれば正常に追加できています。 FIDOディレクトリ配下の nc7000_3a_fs_client.framework, SVGKit.famework が含まれない場合はドラッグアンドドロップで追加します。

General > Frameworks, Libraries, and Embedded Content

Build Phases > Copy Bundle Resources

5.2.2. Runpath Search Paths の追加

「Runpath Search Paths」に「@executable_path/FIDO」を追加します。

Build Settings > Linking > Runpath Search Paths

5.2.3. NC7000-3A-FS 設定ファイルの修正

FIDO ディレクトリには NC7000-3A-FS の実行に必要な設定ファイルなどが含まれています。

Table 6. FIDO ディレクトリ構成
ファイルまたはフォルダ名	説明
`CustomTransactionDisplay.h`	トランザクション確認画面を表示するクラス
`CustomTransactionDisplay.m`	トランザクション確認画面を表示するクラス
`nc7000_3a_fs_client.framework`	NC7000-3A-FS フレームワーク本体
`nc7000_3a_fs.bundle`	NC7000-3A-FS 設定ファイル
`SVGKit.framework`	SVG 描画ライブラリ

NC7000-3A-FS の実行には導入するアプリごとに提供されるライセンス文字列が必要です。ライセンス文字列を受領後、NC7000-3A-FS の設定ファイルである nc7000_3a_fs.bundle 内の fs_authtag.txt を書き換えます。

fs_authtag.txt の内容は次のようになっています（ライセンス文字列は一例）。

fs_authtag.txt

89c6ff64f3a9aabcffffffff20260401

トランザクション確認画面をカスタマイズする場合、NC7000-3A-FS の設定ファイルである nc7000_3a_fs.bundle 内の fs_config.txt を書き換えます。 [_トランザクション確認画面] については後述している内容を確認してください。

fs_config 設定値抜粋

"fingerprint":{
      "transaction_display": "ファイル名"
},
"faceID":{
      "transaction_display": "ファイル名"
},

fs_config.txt の詳細な設定値については、NC7000-3A-FSのドキュメントのSG値を確認してください。

5.2.4. FaceID の設定

FaceID機能を利用するため、 iOS11以降ではFaceID使用目的を記載しないとアプリケーションが動作しません。

Info.plistに「Privacy – Face ID Usage Description」を追加し、使用目的を記載してください。詳細ついてはNC7000-3A-FSのドキュメントの UAF APIリファレンスのFaceIDに関する記載箇所を参照してください。

5.2.5. Bitcodeの設定

Trust Idiom/ID SDKの利用において、Bitcodeをオフにする必要があります。

BuildSetting > Build Options > Enable Bitcode で値をNoにします。

5.3. プロジェクトの設定

5.3.1. Trust Idiom/ID SDK の設定

SDK の設定ファイルとして TrustID-Info.plist を Info.plist と同一フォルダ配下に配置します。

Table 7. TrustID-Info.plist 設定値
key	説明
CLIENT_ID	SDK クライアントID ※1
TENANT_ID	テナントID ※1
WEB_ENDPOINT	WebView画面のエンドポイント ※1
WEB_VERSION	WebViewのバージョン ※3
ENV	動作環境 (開発用: DEBUG、本番用: RELEASE)
AUTHENTICATION_ENDPOINT	認証リクエストエンドポイント
TOKEN_ENDPOINT	トークンエンドポイント
REFRESH_TOKEN_EXPIRES_IN	リフレッシュトークンの有効期限 ※2

※1 は Trust Idiom/ID で発行した値を設定する必要があります。担当者までご連絡ください。 ※2 は　Trust Idiom/ID　導入時に取り決めた値になります。 ※3 は　デフォルト値は1.0。機能改修で、バージョンを上げる場合は設定を行う。

5.4. Push Notifications の設定

本サービスはプッシュ通知を FCM を介して利用するため、Capabilities に Push Notifications を追加する必要があります。未追加の場合は Xcode Project 設定の Capability から Push Notifications を追加します。

また、アプリでプッシュ通知を利用するには Apple Developer 上で App の Push Notification を有効化し、Firebase に認証キーを登録する必要があります。詳しくは FCM のドキュメントを参照してください。

iOS で Firebase Cloud Messaging クライアントアプリを設定する | Firebase

5.5. クイックスタート

Trust Idiomの画面が起動することを確認します。

import UIKit
import TrustIDSDK

class LoginViewController: UIViewController {

    let service = TrustIDV2Service.shared

    override func viewDidLoad() {
        super.viewDidLoad()
        service.configure()
    }

    override func viewDidAppear(_ animated: Bool) {
        super.viewDidAppear(animated)
        service.login(from: self, path: "/1.0/tid/",clientId: "", scope: ["openid"])
    }
}

6. Trust Idiom/ID SDK の提供する実装方法

Trust Idiom/ID では、SDKの導入を実現するために以下の実装方法を提供しています。

6.1. TrustIDV2Serviceの初期設定

アプリ起動後に AppDelegate などで TrustIDV2Service.shared.configure() を実行ください。このメソッドを実行すると FIDO の設定がされます。

Trust Idiom/ID の機能を利用するために必要な実装については次項より解説します。各メソッドの詳細はAPIドキュメントをご確認ください。

6.2. login

ネイティブアプリでログインをするためのメソッドです。トークンとユーザー情報を取得します。本人確認が未実施の場合、Trust Idiomの画面が表示されます。 scopeに応じてユーザー情報が返却されます。

let service = TrustIDV2Service.shared
service.delegate = self // 実装したdelegateを設定する
service.login(from: self, clientId: "", scope: ["openid", "profile", "phone", "email", "address"])