パッケージ、リポジトリ、アプリカテゴリを検索

パッケージ詳細v2.2.0

flutter_locker

指紋、Touch ID、Face IDなどバイオメトリック認証を使用してキーチェーンでシークレットを保護します

AndroidiOS
30日間ダウンロード
4000
いいね数
50
Pub ポイント
160

パッケージをインストール

flutter pub add flutter_locker

パッケージ概要

公開情報に基づく選定ガイドです。参考としてご利用ください。

Flutter Locker は、バイオメトリック認証(指紋、Touch ID、Face ID)を用いたプラットフォーム固有のキーチェーンを使用して、機密データを安全に保存および取得するためのパッケージです。Android および iOS のネイティブセキュリティ機能を活用し、API キーやトークンなどの秘密情報を保護します。このパッケージは、データが常に暗号化された状態で保持され、成功したバイオメトリック認証後にのみアクセス可能になることを保証しており、ユーザー体験を損なうことなくアプリのセキュリティを強化します。高セキュリティなローカルストレージを必要とするアプリに最適です。

用途

  • API キーを安全に保存する
  • ユーザー資格情報を保護する
  • センシティブなデータへのバイオメトリックアクセスを有効にする
  • ローカルに暗号化キーを保存する
  • セキュアなセッション管理の実装

主な機能

  • バイオメトリック認証の統合
  • プラットフォームネイティブなキーチェーンの使用
  • 暗号化されたローカルストレージ
  • セキュアなアクセスのためのシンプルな API
  • 生体認証に失敗した場合、パスワードに自動的にフォールバック

適している対象

  • 機密ユーザー情報を扱うアプリ
  • 金融または医療アプリケーション
  • 認証重視アプリ
  • セキュアなローカルストレージを必要とするアプリ
  • ユーザーのプライバシーを最優先する開発者

注意事項

  • バイオメトリックハードウェアのサポートが必要です
  • Android および iOS プラットフォームに限定
  • 追加の権限処理が必要になる場合があります
  • バイオメトリクス環境以外には適していません
  • 下位のOSセキュリティメカニズムに依存します

元の README

関連するソースリポジトリの README 原文のスナップショットです。最新の内容はリポジトリをご覧ください。

Flutter Locker🔒

Locker

Flutter plugin that secures your secrets in keychain using biometric authentication (Fingerprint, Touch ID, Face ID...).

It uses:

Table of contents

Migrate to 2.1.0

The models now accept named parameters instead of unnamed, e.g.:

RetrieveSecretRequest(
  key: 'key',
  androidPrompt: AndroidPrompt(title: 'title', cancelLabel: 'cancel'),
  iOsPrompt: IOsPrompt(touchIdText: 'description'),
)

Usage

FlutterLocker.supportsBiometricAuthentication();

Checks if the devices has biometric capabilities no matter if they are configured and turned on.

FlutterLocker.canAuthenticate();

Checks if the devices has biometric capabilities that are configured and turned on.

await FlutterLocker.save(SaveSecretRequest(
  key: 'key',
  secret: 'secret',
  androidPrompt: AndroidPrompt(title: 'Authenticate', cancelLabel: 'Cancel'),
));

Saves the secret. On Android prompt is shown, while on iOS there is no need for the prompt when saving.

await FlutterLocker.retrieve(RetrieveSecretRequest(
  key: key,
  androidPrompt: AndroidPrompt(title: 'Authenticate', cancelLabel: 'Cancel'),
  iOsPrompt: IOsPrompt(touchIdText: 'Authenticate'),
));

Retrieves the secret. You need to provide a prompt for Android and iOS. Prompt for iOS is used only with TouchID. FaceID uses strings from Info.plist.

await FlutterLocker.delete('key');

Deletes the secret.

Exceptions

For common exceptions, a LockerException is thrown.

Use LockerException.reason to find out what went wrong:

  • secretNotFound - Happens when you try to retrieve a secret that was never saved for that key
  • authenticationCanceled - User canceled the authentication prompt
  • authenticationFailed - User failed authentication, e.g. by too many wrong attempts

For other exception, a PlatformException is thrown. You can use PlatformException.message to get more info.

Notes

  • iOS only: app will not show authentication dialog when saving (authentication will always succeed)
  • please follow Locker and Goldfinger setup to prevent any issues

Setup

iOS

To use Locker you need to add the NSFaceIDUsageDescription to you Info.plist.

If NSFaceIDUsageDescription is not provided, the app will crash with the following error:

This app has crashed because it attempted to access privacy-sensitive data without a usage description.  The app's Info.plist must contain an NSFaceIDUsageDescription key with a string value explaining to the user how the app uses this data.
Android

Ensure MainActivity extends FlutterFragmentActivity.

class MainActivity: FlutterFragmentActivity() {
    // ...
}

When showing authentication prompt, the app might crash on some Samsung devices if you don't use an appropriate theme: https://github.com/infinum/flutter-plugins-locker/commit/fcb1f6401d89f860d24ea9a75027d62a03e87926.

Contributing

We believe that the community can help us improve and build better a product. Please refer to our contributing guide to learn about the types of contributions we accept and the process for submitting them.

To ensure that our community remains respectful and professional, we defined a code of conduct that we expect all contributors to follow.

We appreciate your interest and look forward to your contributions.

License

Copyright 2024 Infinum

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Credits

Maintained and sponsored by Infinum.

カテゴリー

ソースリポジトリ

このパッケージを使用しているプロジェクト