生体認証ログイン機能を実装してみた話

きっかけ

きっかけ①モバイルエンジニアなのにスマホでの英語入力が苦手なこと

きっかけ②SUBLINEの本人確認実装のプロジェクトに携わった経験

実際に実装してみよう

ステップ１：自作アプリでの試行

Android自作アプリでの生体認証

必要なライブラリの追加

dependencies {
    implementation 'androidx.biometric:biometric-ktx:1.2.0-alpha05'
}

パーミッション（権限の許可）の追加

＜uses-permission android:name="android.permission.USE_BIOMETRIC"/＞

端末が生体認証に対応しているかの確認処理

    // 端末が生体認証に対応しているか確認
    private fun checkBiometric(): Boolean {
        val biometricManager = BiometricManager.from(this)
        when (biometricManager.canAuthenticate()) {
            BiometricManager.BIOMETRIC_SUCCESS -> {
                // 生体認証に対応している場合はここ
            }
            BiometricManager.BIOMETRIC_ERROR_NO_HARDWARE -> {
                // 生体認証ハードウェアなし
            }
            BiometricManager.BIOMETRIC_ERROR_HW_UNAVAILABLE -> {
                // 生体認証ハードウェアは利用できないためもう一度お試しください的なところ
            }
            BiometricManager.BIOMETRIC_ERROR_NONE_ENROLLED -> {
                // 端末自体に生体認証の登録を1つもしていない場合はここ
            }
            else -> {
                // その他のエラー
            }
        }
        return biometricManager.canAuthenticate() == BiometricManager.BIOMETRIC_SUCCESS
    }

認証後の処理の設定

        val biometricPrompt = BiometricPrompt(this, executor,
            object : BiometricPrompt.AuthenticationCallback() {

                // 認証後の処理の設定

                // 成功したらonAuthenticationSucceededに入ります
                override fun onAuthenticationSucceeded(result: BiometricPrompt.AuthenticationResult) {
                    super.onAuthenticationSucceeded(result)
                    Log.d("Biometric", "Succeeded")
                    runOnUiThread {
                        // 生体認証が成功した後の処理
                        // 例としてloginメソッドがある想定
                        login()
                    }
                }
                // 失敗したらonAuthenticationFailedに入ります
                // 指紋は読み取れたけど未登録と判断したとき
                override fun onAuthenticationFailed() {
                    super.onAuthenticationFailed()
                    Log.d("Biometric", "Failed")
                }
                // 失敗したらonAuthenticationErrorに入ります
                // どれにも当てはまらない復帰不可能なエラーを検出したとき
                override fun onAuthenticationError(errorCode: Int, errString: CharSequence) {
                    super.onAuthenticationError(errorCode, errString)
                    Log.d("Biometric", "Error")
                }
            })

表示ダイアログの設定

        // 表示ダイアログの設定
        val promptInfo = BiometricPrompt.PromptInfo.Builder()
            .setTitle("生体認証ログイン")
            .setSubtitle("指紋を読み取ります")
            .setDescription("端末に保存された指紋を認証して\nログイン情報を入力します")
            .setNegativeButtonText("キャンセル")
            .build()

        val button =
            findViewById＜Button＞(R.id.button)
        button.setOnClickListener {
            biometricPrompt.authenticate(promptInfo)
        }

準備が整ったらあとは決まった処理を書くだけ

package com.example.oharaauthapp

import android.content.Intent
import androidx.appcompat.app.AppCompatActivity
import android.os.Bundle
import android.text.TextUtils
import android.util.Log
import android.view.View
import android.widget.Button
import android.widget.EditText
import android.widget.TextView
import androidx.activity.OnBackPressedCallback
import androidx.biometric.BiometricPrompt
import java.util.concurrent.Executors

class MainActivity : AppCompatActivity() {
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)

        val mainTv = findViewById(R.id.main_tv)
        val mainUser = findViewById(R.id.main_user)
        val mainPass = findViewById(R.id.main_pass)

        val loginBtn = findViewById＜Button＞(R.id.login_btn)
        val authBtn = findViewById＜Button＞(R.id.auth_btn)
        val executor = Executors.newSingleThreadExecutor()

        val biometricPrompt = BiometricPrompt(this, executor,
            object : BiometricPrompt.AuthenticationCallback() {

                // 認証後の処理の設定

                // 成功したらonAuthenticationSucceededに入ります
                override fun onAuthenticationSucceeded(result: BiometricPrompt.AuthenticationResult) {
                    super.onAuthenticationSucceeded(result)
                    Log.d("Biometric", "Succeeded")
                    runOnUiThread {
                        // 生体認証が成功した後の処理
                        mainUser.setText("ohara")
                        mainPass.setText("test123")

                        loginBtn.performClick()
                    }
                }
                // 失敗したらonAuthenticationFailedに入ります
                // 指紋は読み取れたけど未登録と判断したとき
                override fun onAuthenticationFailed() {
                    super.onAuthenticationFailed()
                    Log.d("Biometric", "Failed")
                }
                // 失敗したらonAuthenticationErrorに入ります
                // どれにも当てはまらない復帰不可能なエラーを検出したとき
                override fun onAuthenticationError(errorCode: Int, errString: CharSequence) {
                    super.onAuthenticationError(errorCode, errString)
                    Log.d("Biometric", "Error")
                }
            })

        // 表示ダイアログの設定

        val promptInfo = BiometricPrompt.PromptInfo.Builder()
            .setTitle("生体認証ログイン")
            .setSubtitle("指紋を読み取ります")
            .setDescription("端末に保存された指紋を認証して\nログイン情報を入力します")
            .setNegativeButtonText("キャンセル")
            .build()

        loginBtn.setOnClickListener {
            if(TextUtils.isEmpty(mainUser.text) || TextUtils.isEmpty(mainPass.text)) {
                mainTv.text = "ユーザー名とパスワードを入力してください。"
                mainTv.visibility = View.VISIBLE
            } else if(mainUser.text.toString() == "ohara" && mainPass.text.toString() == "test123") {
                // SubActivityへの画面遷移
                val intent = Intent(this, SubActivity::class.java)
                intent.putExtra("UserName",mainUser.text.toString())
                intent.putExtra("Pass",mainPass.text.toString())
                startActivity(intent)
            }else{
                mainTv.text = "ユーザー名もしくはパスワードが間違っています"
                mainTv.visibility = View.VISIBLE
            }
        }

        authBtn.setOnClickListener {
            checkBiometric()
            // ここで生体認証ダイアログpromptInfoとその判定を呼び出しています
            biometricPrompt.authenticate(promptInfo)
        }

        onBackPressedDispatcher.addCallback(callback)
    }

    // 端末が生体認証に対応しているか確認
    private fun checkBiometric(): Boolean {
        val biometricManager = BiometricManager.from(this)
        when (biometricManager.canAuthenticate()) {
            BiometricManager.BIOMETRIC_SUCCESS -> {
                // 生体認証に対応している場合はここ
            }
            BiometricManager.BIOMETRIC_ERROR_NO_HARDWARE -> {
                // 生体認証ハードウェアなし
                // エラーダイアログなどのエラー処理
            }
            BiometricManager.BIOMETRIC_ERROR_HW_UNAVAILABLE -> {
                // 生体認証ハードウェアは利用できないためもう一度お試しください的なところ
                // エラーダイアログなどのエラー処理
            }
            BiometricManager.BIOMETRIC_ERROR_NONE_ENROLLED -> {
                // 端末自体に生体認証の登録を1つもしていない場合はここ
                // エラーダイアログなどのエラー処理
            }
            else -> {
                // その他のエラー処理
            }
        }
        return biometricManager.canAuthenticate() == BiometricManager.BIOMETRIC_SUCCESS
    }

    private val callback = object : OnBackPressedCallback(true) {
        //コールバックのhandleOnBackPressedを呼び出して、戻るキーを押したときの処理を記述
        override fun handleOnBackPressed() {
            //端末の戻るボタンでの画面遷移防止のためreturnだけでいい
            return
        }
    }
}

iOS自作アプリでの生体認証

info.plistに追加

画像の通りプロジェクトファイルのinfoから
"Privacy - Face ID Usage Description"というものを追加してそれっぽい理由を書きます

生体認証に必要な準備はこれだけ

import UIKit
import LocalAuthentication

class YourController: UIViewController {

    @IBOutlet weak var authLoginButton: UIButton!

　　　　・・・基本処理を省略・・・

    @IBAction func tapAuthLogin(_ sender: Any) {
        authenticateUser()
    }

    func authenticateUser() {
        let context = LAContext()
        var error: NSError?

        // Touch ID / Face IDが利用可能かどうかを確認
        if context.canEvaluatePolicy(.deviceOwnerAuthenticationWithBiometrics, error: &error) {
            let reason = "Log in with Touch ID / Face ID"

            context.evaluatePolicy(.deviceOwnerAuthenticationWithBiometrics, localizedReason: reason) { success, authenticationError in
                DispatchQueue.main.async {
                    if success {
                        // 認証成功
                        self.loginSuccess()
                    } else {
                        // 認証失敗
                        self.showAuthenticationError(error: authenticationError)
                    }
                }
            }
        } else {
            // 生体認証が利用できない場合の処理
            showError(error: error)
        }
    }

    func loginSuccess() {
        // ログイン成功時の処理
        // 例としてloginメソッドがある想定
        login()
    }

    func showAuthenticationError(error: Error?) {
        // 認証失敗時のエラーメッセージ表示
        let alert = UIAlertController(title: "Authentication Failed", message: error?.localizedDescription, preferredStyle: .alert)
        alert.addAction(UIAlertAction(title: "OK", style: .default, handler: nil))
        self.present(alert, animated: true, completion: nil)
    }

    func showError(error: Error?) {
        // 生体認証が利用できない場合のエラーメッセージ表示
        let alert = UIAlertController(title: "Biometrics Unavailable", message: error?.localizedDescription, preferredStyle: .alert)
        alert.addAction(UIAlertAction(title: "OK", style: .default, handler: nil))
        self.present(alert, animated: true, completion: nil)
    }
}

iOSでそのまま自社プロダクトにも取り入れてみます

ステップ２：自社サービス「SUBLINE」での実装

ステップ３：自社サービス「サスケWorks」での実装

まとめ