Package selection guidance compiled from public package information, community data, and project usage.
A Flutter package designed to streamline Internet Identity (ICP) authentication within apps. It enables seamless integration with the Internet Identity service, allowing users to authenticate using decentralized identities without passwords. The package handles the entire authentication flow, including login, session management, and identity verification, while supporting both Android and iOS platforms. Built for developers working in Web3, it simplifies secure access to blockchain-based applications.
Use cases
Decentralized app logins
Web3 user authentication
Blockchain-powered identity management
Secure mobile wallet access
DApp integration with ICP
User session persistence
Key features
Automated ICP authentication flow
Cross-platform support (Android & iOS)
Integration with Internet Identity service
Secure token handling
Minimal boilerplate code
Built-in session management
Suitable for
Flutter developers building DApps
Web3 and blockchain application creators
Mobile apps requiring passwordless login
Projects using Internet Identity
Teams focused on decentralized identity
Considerations
Requires Internet Identity backend setup
Limited to ICP ecosystem
Dependent on browser-based authentication flow
May need custom UI adjustments
Not suitable for non-ICP blockchain projects
Original README
Original README snapshot from the linked source repository. Visit the repository for the latest content.
flutter_icp_auth:
This Flutter package simplifies integrating ICP internet identity authentication flow within your Flutter application.
✨ Features
LOG IN: Enables users to log in using internet identity.
AUTO LOGIN: Allows users to log in automatically.
RELOAD: Automatically logs in users when the app is reloaded or opened, based on session data/delegationObject.
LOGOUT: Provides functionality for users to log out.
⚠️ Important Info
1. isLocal is used to denote whether you are running your application using mainnet links or locally.
Change the bool value based on your apps requirement.
If isLocal is true then replace the values of backendCanisterId and middlePageCanisterId with the locally deployed canister ids.
If isLocal is false then replace the values of backendCanisterId and middlePageCanisterId with the main-net deployed canister ids.
2. For local or main-net backendCanisterId make sure you have the following function in your backend:
Rust:
use ic_cdk::api::caller;
#[ic_cdk::query]fnwhoami() ->String {
letprincipal_id = caller().to_string();
format!("principal id - : {:?}", principal_id)
}
Motoko:
import Principal "mo:base/Principal";
actor {
public shared (msg) func whoami() : async Text {
Principal.toText(msg.caller);
};
};
For main-net you can use our canisterId as well: cni7b-uaaaa-aaaag-qc6ra-cai
3. For local or main-net middlePageCanisterId make sure you have the following:
Local:
Clone the repo from here and deploy locally: https://github.com/ICP-hub/flutter_icp_auth_middleware
Main-net:
a. You can deploy the cloned middlePage to main net and use the main net canister id.
OR
b. You can use our main-net id as well: nplfj-4yaaa-aaaag-qjucq-cai
4. For IDL and Services:
You can use candid_dart to generate the did files and the IDL services and then use them in the app as demonstrated in the example app.
OR
You can add/write the file or code manually and then use them accordingly.
Open android → app → src → main → AndroidManifest.XML, , add the following snippet, and replace android:scheme and android:host with your app's values:
bool isLocal =
false; // To confirm if you running your project locally or using main-net. Change it to true if running locallyService idlService =
FieldsMethod.idl; // Idl service (Location: lib/integration.dart)String backendCanisterId =
'cni7b-uaaaa-aaaag-qc6ra-cai'; // Replace it with your backend canisterIdString middlePageCanisterId =
'nplfj-4yaaa-aaaag-qjucq-cai'; // Replace it with your middlePage canisterId
isLoggedIn and _principalId are used to change the state of the log in/log out button and principal text. You can modify them according to your applications need.
Future<void> _manualLogin(Uri uri) async {
List<dynamic> result = awaitAuthLogIn.fetchAgent(
uri.queryParameters, isLocal, backendCanisterId, idlService);
if (result.isNotEmpty) {
setState(() {
isLoggedIn = uri.queryParameters['status'] == "true" ? true : false;
_principalId = result[0];
});
} else {
setState(() {
isLoggedIn = false;
_principalId = "Log in to see your principal";
});
}
}
3. Using the IIDLogin Button
When passing argument in the IIDLogin button, remember to pass your app:host and app:callback:
For login button call:
Replace the argument host and scheme with your app's host and scheme