Azure AD B2C を使用して独自の iOS Swift アプリケーションで認証を有効にする

[アーティクル]
01/11/2024

この記事では、独自の iOS Swift モバイルアプリケーションに Azure Active Directory B2C (Azure AD B2C) 認証を追加する方法について説明します。 iOS Swift アプリケーションを iOS 用 Microsoft 認証ライブラリ (MSAL) と統合する方法について説明します。

この記事は、サンプル iOS Swift アプリケーションで認証を構成する方法に関する記事と共に利用してください。その際は、サンプルの iOS Swift アプリを独自の iOS Swift アプリに置き換えてください。この記事の手順を完了すると、アプリケーションで、Azure AD B2C を使用したサインインが受け付けられるようになります。

前提条件

「Azure AD B2C を使用してサンプル iOS Swift アプリで認証を構成する」の前提条件と統合の手順を確認します。

iOS Swift アプリプロジェクトを作成する

iOS Swift アプリケーションがまだない場合は、以下のステップを実行して新しいプロジェクトを設定します:

Xcode を開いてから、 [File]>[New]>[Project] の順に選択します。
iOS アプリの場合は、 [iOS]>[App] と選択してから、 [Next] を選択します。
[Choose options for your new project] には、以下を指定します。
1. [Product name] (MSALiOS など)。
2. [Organization identifier] (contoso.com など)。
3. [Interface] で、 [Storyboard] を選択します。
4. [Life cycle] で、 [UIKit App Delegate] を選択します。
5. [Language] で、 [Swift] を選択します。
[次へ] を選択します。
その中にアプリを作成するフォルダーを選択してから、 [作成] を選択します。

手順 1: MSAL ライブラリをインストールする

CocoaPods を使用して MSAL ライブラリをインストールします。プロジェクトの .xcodeproj ファイルと同じフォルダーに podfile ファイルが存在しない場合は、podfile という名前の空のファイルを作成します。次のコードを podfile ファイルに追加します。
```
use_frameworks!

target '<your-target-here>' do
   pod 'MSAL'
end
```
<your-target-here> を自分のプロジェクトの名前に置き換えます (例: MSALiOS)。詳細については、「ポッドファイル構文リファレンス」を参照してください。
ターミナルウィンドウで、podfile が含まれるフォルダーに移動してから、pod install を実行して MSAL ライブラリをインストールします。
pod install コマンドを実行すると、"<プロジェクト名>.xcworkspace" ファイルが作成されます。 Xcode でプロジェクトを再度読み込むため、Xcode を閉じてから、"<プロジェクト名>.xcworkspace" ファイルを開きます。

手順 2: アプリの URL スキームを設定する

ユーザーが認証されると、Azure AD B2C アプリケーション登録で構成されたリダイレクト URI を使用して、Azure AD B2C からアプリに承認コードが送信されます。

MSAL の既定のリダイレクト URI の形式は msauth.[Your_Bundle_Id]://auth です。例としては msauth.com.microsoft.identitysample.MSALiOS://auth が挙げられます。ここで msauth.com.microsoft.identitysample.MSALiOS は URL スキームです。

この手順では、CFBundleURLSchemes 配列を使用して URL スキームを登録します。アプリケーションは、この URL スキームで Azure AD B2C からのコールバックをリッスンします。

Xcode で、ソースコードファイルとして Info.plist ファイルを開きます。 <dict> セクションで、次の XML スニペットを追加します。

<key>CFBundleURLTypes</key>
<array>
    <dict>
        <key>CFBundleURLSchemes</key>
        <array>
            <string>msauth.com.microsoft.identitysample.MSALiOS</string>
        </array>
    </dict>
</array>
<key>LSApplicationQueriesSchemes</key>
<array>
    <string>msauthv2</string>
    <string>msauthv3</string>
</array>

手順 3: 認証コードを追加する

サンプルコードは、UIViewController クラスで構成されています。このクラスは:

ユーザーインターフェイスの構造を定義します。
Azure AD B2C ID プロバイダーに関する情報を含みます。アプリはこの情報を使用して、Azure AD B2C との信頼関係を確立します。
ユーザーの認証、トークンの取得、それらの検証を行うための認証コードを含みます。

ユーザーが認証を行う UIViewController を選択します。 UIViewController で、このコードを、GitHub で提供されているコードとマージします。

手順 4: iOS Swift アプリを構成する

認証コードを追加したら、Azure AD B2C 設定を使用して iOS Swift アプリを構成します。 Azure AD B2C ID プロバイダーの設定は、前のセクションで選択された UIViewController クラスで構成されています。

iOS Swift アプリを構成する方法については、「Azure AD B2C を使用してサンプル iOS Swift アプリでの認証を構成する」を参照してください。

手順 5: モバイルアプリを実行してテストする

接続されている iOS デバイスのシミュレーターを使用して、プロジェクトを作成して実行します。
[サインイン] を選択してから、Azure AD B2C のローカルまたはソーシャルアカウントを使用して、サインアップまたはサインインします。
認証に成功すると、ナビゲーションバーに自分の表示名が表示されます。

手順 6: コードの構成要素をカスタマイズする

このセクションでは、iOS Swift アプリの認証を可能にするコードの構成要素について説明します。 UIViewController のメソッドを示して、コードをカスタマイズする方法について説明します。

手順 6.1: パブリッククライアントアプリケーションをインスタンス化する

パブリッククライアントアプリケーションは、アプリケーションシークレットが安全に保管されると信頼されておらず、そこにクライアントシークレットは置かれません。 viewDidLoad で、パブリッククライアントアプリケーションオブジェクトを使用して MSAL をインスタンス化します。

次の Swift コードスニペットは、MSALPublicClientApplicationConfig 構成オブジェクトを使用して MSAL を初期化する方法を示しています。

構成オブジェクトでは、Azure AD B2C 環境に関する情報が提供されます。たとえば、Azure AD B2C に対する認証要求を作成するための、クライアント ID、リダイレクト URI、機関が提供されます。構成オブジェクトの詳細については、サンプルモバイルアプリの構成に関する記事を参照してください。

do {

    let signinPolicyAuthority = try self.getAuthority(forPolicy: self.kSignupOrSigninPolicy)
    let editProfileAuthority = try self.getAuthority(forPolicy: self.kEditProfilePolicy)
    
    let pcaConfig = MSALPublicClientApplicationConfig(clientId: kClientID, redirectUri: kRedirectUri, authority: signinPolicyAuthority)
    pcaConfig.knownAuthorities = [signinPolicyAuthority, editProfileAuthority]
    
    self.applicationContext = try MSALPublicClientApplication(configuration: pcaConfig)
    self.initWebViewParams()
    
    } catch {
        self.updateLoggingText(text: "Unable to create application \(error)")
    }

initWebViewParams メソッドでは、対話型認証エクスペリエンスを構成します。

次の Swift コードスニペットでは、システム Web ビューを使用して、webViewParameters クラスメンバーを初期化しています。詳細については、「iOS/macOS のブラウザーと WebView をカスタマイズする」を参照してください。

func initWebViewParams() {
    self.webViewParameters = MSALWebviewParameters(authPresentationViewController: self)
    self.webViewParameters?.webviewType = .default
}

手順 6.2: 対話型承認要求を開始する

対話型承認要求は、ユーザーが、システム Web ビューを使用してサインアップまたはサインインするよう求められるフローです。ユーザーが [サインイン] ボタンを選択すると、authorizationButton メソッドが呼び出されます。

authorizationButton メソッドにより、承認要求に関する関連データを使用して MSALInteractiveTokenParameters オブジェクトが準備されます。 acquireToken メソッドでは、MSALInteractiveTokenParameters を使用して、システム Web ビューからユーザーを認証します。

次のコードスニペットは、対話型承認要求の開始方法を示しています。

let parameters = MSALInteractiveTokenParameters(scopes: kScopes, webviewParameters: self.webViewParameters!)
parameters.promptType = .selectAccount
parameters.authority = authority

applicationContext.acquireToken(with: parameters) { (result, error) in

// On error code    
guard let result = result else {
    self.updateLoggingText(text: "Could not acquire token: \(error ?? "No error information" as! Error)")
    return
}

// On success code
self.accessToken = result.accessToken
self.updateLoggingText(text: "Access token is \(self.accessToken ?? "Empty")")
}

ユーザーが、成功か失敗かのいずれかとして承認フローを完了すると、結果が acquireToken メソッドのクロージャに返されます。

acquireToken メソッドからは、result および error オブジェクトが返されます。このクロージャを使用して、次のことを行います。

認証の完了後、情報を使用してモバイルアプリの UI を更新します。
アクセストークンを使用して Web API サービスを呼び出します。
認証エラーを処理します (例: ユーザーがサインインフローをキャンセルした場合)。

手順 6.3: Web API を呼び出す

トークンベースの承認 Web APIを呼び出すには、アプリに有効なアクセストークンが必要です。アプリでは以下が実行されます。

Web API エンドポイントで必要なアクセス許可 (スコープ) を持つアクセストークンを取得します。
この形式を使用して、HTTP 要求の承認ヘッダーで、ベアラートークンとしてアクセストークンを渡します。

Authorization: Bearer <access-token>

ユーザーが対話形式で認証されると、アプリは acquireToken クロージャ内でアクセストークンを取得します。後続の Web API 呼び出しでは、このセクションで説明したように、acquire token silent (acquireTokenSilent) メソッドを使用します。

acquireTokenSilent メソッドは、次の処理を実行します:

要求されたスコープのアクセストークンの、トークンキャッシュからの取り込みを試みます。トークンが存在していて期限切れでない場合は、トークンが返されます。
トークンがトークンキャッシュに存在しないか期限切れである場合、MSAL ライブラリでは、更新トークンを使用して新しいアクセストークンの取得が試みられます。
更新トークンが存在しないか期限切れになっている場合は、例外が返されます。この場合は、ユーザーに対話形式でサインインすることを求めるプロンプトを表示する必要があります。

次のコードスニペットは、アクセストークンの取得方法を示しています。

do {

// Get the authority using the sign-in or sign-up user flow
let authority = try self.getAuthority(forPolicy: self.kSignupOrSigninPolicy)

// Get the current account from the application context
guard let thisAccount = try self.getAccountByPolicy(withAccounts: applicationContext.allAccounts(), policy: kSignupOrSigninPolicy) else {
    self.updateLoggingText(text: "There is no account available!")
    return
}

// Configure the acquire token silent parameters
let parameters = MSALSilentTokenParameters(scopes: kScopes, account:thisAccount)
parameters.authority = authority
parameters.loginHint = "username"

// Acquire token silent
self.applicationContext.acquireTokenSilent(with: parameters) { (result, error) in
    if let error = error {
        
        let nsError = error as NSError
        
        // interactionRequired means we need to ask the user to sign in. This usually happens
        // when the user's Refresh Token is expired or if the user has changed their password
        // among other possible reasons.
        
        if (nsError.domain == MSALErrorDomain) {
            
            if (nsError.code == MSALError.interactionRequired.rawValue) {
                
                // Start an interactive authorization code
                // Notice we supply the account here. This ensures we acquire token for the same account
                // as we originally authenticated.
                
                ...
            }
        }
        
        self.updateLoggingText(text: "Could not acquire token: \(error)")
        return
    }
    
    guard let result = result else {
        
        self.updateLoggingText(text: "Could not acquire token: No result returned")
        return
    }
    
    // On success, set the access token to the accessToken class member. 
    // The callGraphAPI method uses the access token to call a web API  
    self.accessToken = result.accessToken
    ...
}
} catch {
self.updateLoggingText(text: "Unable to construct parameters before calling acquire token \(error)")
}

次に示すように、callGraphAPI メソッドによってアクセストークンが取得され、Web API が呼び出されます。

@objc func callGraphAPI(_ sender: UIButton) {
    guard let accessToken = self.accessToken else {
        self.updateLoggingText(text: "Operation failed because could not find an access token!")
        return
    }
    
    let sessionConfig = URLSessionConfiguration.default
    sessionConfig.timeoutIntervalForRequest = 30
    let url = URL(string: self.kGraphURI)
    var request = URLRequest(url: url!)
    request.setValue("Bearer \(accessToken)", forHTTPHeaderField: "Authorization")
    let urlSession = URLSession(configuration: sessionConfig, delegate: self, delegateQueue: OperationQueue.main)
    
    self.updateLoggingText(text: "Calling the API....")
    
    urlSession.dataTask(with: request) { data, response, error in
        guard let validData = data else {
            self.updateLoggingText(text: "Could not call API: \(error ?? "No error information" as! Error)")
            return
        }
        
        let result = try? JSONSerialization.jsonObject(with: validData, options: [])
        
        guard let validResult = result as? [String: Any] else {
            self.updateLoggingText(text: "Nothing returned from API")
            return
        }
        
        self.updateLoggingText(text: "API response: \(validResult.debugDescription)")
        }.resume()
}

手順 6.4: ユーザーをサインアウトする

MSAL を使用してサインアウトすると、ユーザーに関する既知のすべての情報がアプリケーションから削除されます。このサインアウント方法を使用してユーザーをサインアウトし、UI を更新します。たとえば、保護された UI 要素を非表示にして、サインアウトボタンを非表示にし、サインインボタンを表示することができます。

次のコードスニペットは、ユーザーのサインアウト方法を示しています。

@objc func signoutButton(_ sender: UIButton) {
do {
    
    
    let thisAccount = try self.getAccountByPolicy(withAccounts: applicationContext.allAccounts(), policy: kSignupOrSigninPolicy)
    
    if let accountToRemove = thisAccount {
        try applicationContext.remove(accountToRemove)
    } else {
        self.updateLoggingText(text: "There is no account to signing out!")
    }
    
    ...
    
} catch  {
    self.updateLoggingText(text: "Received error signing out: \(error)")
}
}

次のステップ

具体的には、次の方法を学習します。

次の方法で共有

Azure AD B2C を使用して独自の iOS Swift アプリケーションで認証を有効にする

前提条件

iOS Swift アプリプロジェクトを作成する

手順 1: MSAL ライブラリをインストールする

手順 2: アプリの URL スキームを設定する

手順 3: 認証コードを追加する

手順 4: iOS Swift アプリを構成する

手順 5: モバイルアプリを実行してテストする

手順 6: コードの構成要素をカスタマイズする

手順 6.1: パブリッククライアントアプリケーションをインスタンス化する

手順 6.2: 対話型承認要求を開始する

手順 6.3: Web API を呼び出す

手順 6.4: ユーザーをサインアウトする

次のステップ

フィードバック

フィードバック

その他のリソース

次の方法で共有

Azure AD B2C を使用して独自の iOS Swift アプリケーションで認証を有効にする

前提条件

iOS Swift アプリ プロジェクトを作成する

手順 1: MSAL ライブラリをインストールする

手順 2: アプリの URL スキームを設定する

手順 3: 認証コードを追加する

手順 4: iOS Swift アプリを構成する

手順 5: モバイル アプリを実行してテストする

手順 6: コードの構成要素をカスタマイズする

手順 6.1: パブリック クライアント アプリケーションをインスタンス化する

手順 6.2: 対話型承認要求を開始する

手順 6.3: Web API を呼び出す

手順 6.4: ユーザーをサインアウトする

次のステップ

フィードバック

フィードバック

その他のリソース

iOS Swift アプリプロジェクトを作成する

手順 5: モバイルアプリを実行してテストする

手順 6.1: パブリッククライアントアプリケーションをインスタンス化する