Firebase Auth Backup

Allow customers to use their existing Firebase Authentication to authenticate into a secure enclave that holds the encryption key for the user. The Portal SDK leverages Firebase ID tokens to securely store and retrieve encryption keys from the secure enclave.

How it works

Your app signs the user in with Firebase Auth (Email/Password, Google Sign-In, Phone, or any other Firebase Auth provider).
You configure the Portal SDK with a callback that returns a fresh Firebase ID token.
During backup, the SDK encrypts the client backup share and stores the encryption key in the secure enclave, authenticated by the Firebase ID token.
During recovery, the SDK retrieves the encryption key from the secure enclave using the same authentication, then decrypts the backup share to restore the wallet.

Prerequisites

A Firebase project with Firebase Authentication enabled.
At least one sign-in provider configured in Firebase Auth (Email/Password, Google Sign-In, Apple Sign-In, etc.).
Your Firebase project registered with Portal (see below).

Register your Firebase project with Portal

You must register your Firebase project with Portal so that the secure enclave can validate your users’ Firebase ID tokens.

Go to the Portal Dashboard.
Navigate to Configuration > Webhooks.
In the Firebase Backup Authentication section, enter your Firebase Project ID and save.

You can also register the JWT provider programmatically via the Custodian API:

curl -X POST https://api.portalhq.io/api/v3/custodians/me/jwt-provider \
  -H "Authorization: Bearer YOUR_CUSTODIAN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "provider": "firebase",
    "projectId": "your-firebase-project-id"
  }'

Add Firebase to your app

iOS
Android
Flutter

If you have not already set up Firebase in your iOS app, follow the Firebase iOS setup guide. At a minimum, you need to:

Add your iOS app in the Firebase Console.
Download the GoogleService-Info.plist file and add it to your Xcode project.
Add the FirebaseAuth dependency via Swift Package Manager or CocoaPods.
Call FirebaseApp.configure() in your AppDelegate or app entry point.

If you have not already set up Firebase in your Android app, follow the Firebase Android setup guide. At a minimum, you need to:

Add your Android app in the Firebase Console.
Download the google-services.json file and add it to your app/ directory.
Add the Firebase dependencies to your build.gradle:

dependencies {
    implementation platform("com.google.firebase:firebase-bom:33.1.0")
    implementation "com.google.firebase:firebase-auth-ktx"
    implementation "org.jetbrains.kotlinx:kotlinx-coroutines-play-services:1.7.3"
}

Apply the Google services plugin:

// In your project-level build.gradle
plugins {
    id "com.google.gms.google-services" version "4.4.2" apply false
}

// In your app-level build.gradle
plugins {
    id "com.google.gms.google-services"
}

If you have not already set up Firebase in your Flutter app, follow the FlutterFire setup guide. At a minimum, you need to:

Install the FlutterFire CLI: dart pub global activate flutterfire_cli
Run flutterfire configure to connect your Flutter app to your Firebase project.
Add the firebase_core and firebase_auth packages to your pubspec.yaml:

dependencies:
  firebase_core: ^3.0.0
  firebase_auth: ^5.0.0
  portal_flutter: ^X.X.X

Initialize Firebase in your app entry point:

import 'package:firebase_core/firebase_core.dart';
import 'firebase_options.dart';

void main() async {
  WidgetsFlutterBinding.ensureInitialized();
  await Firebase.initializeApp(
    options: DefaultFirebaseOptions.currentPlatform,
  );
  runApp(MyApp());
}

Supported platforms

Firebase Auth Backup is currently available on:

iOS - See the iOS Back up a wallet guide
Android - See the Android Back up a wallet guide
Flutter - See the Flutter Back up a wallet guide

Support for React Native and Web is coming soon.

Getting Started

SDKs

APIs

Integrations

Resources

Firebase Auth Backup

How it works

Prerequisites

Register your Firebase project with Portal

Add Firebase to your app

Supported platforms

Getting Started

SDKs

APIs

Integrations

Resources

​How it works

​Prerequisites

​Register your Firebase project with Portal

​Add Firebase to your app

​Supported platforms

How it works

Prerequisites

Register your Firebase project with Portal

Add Firebase to your app

Supported platforms