FirebaseAESLib.Mobile 1.0.0

There is a newer version of this package available.
See the version list below for details.
dotnet add package FirebaseAESLib.Mobile --version 1.0.0
                    
NuGet\Install-Package FirebaseAESLib.Mobile -Version 1.0.0
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="FirebaseAESLib.Mobile" Version="1.0.0" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="FirebaseAESLib.Mobile" Version="1.0.0" />
                    
Directory.Packages.props
<PackageReference Include="FirebaseAESLib.Mobile" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add FirebaseAESLib.Mobile --version 1.0.0
                    
#r "nuget: FirebaseAESLib.Mobile, 1.0.0"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package FirebaseAESLib.Mobile@1.0.0
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=FirebaseAESLib.Mobile&version=1.0.0
                    
Install as a Cake Addin
#tool nuget:?package=FirebaseAESLib.Mobile&version=1.0.0
                    
Install as a Cake Tool

// ============================= // FILE: README.md // =============================

FirebaseAESLib.Mobile

FirebaseAESLib.Mobile is a Xamarin-compatible library that uses AES encryption to securely interact with Firebase Realtime Database and Firestore using the Firebase REST API.


โœ… Features

  • ๐Ÿ” AES-256 encryption/decryption
  • ๐Ÿ”ฅ Works with Firestore (via REST)
  • ๐Ÿ” Works with Realtime Database (via REST)
  • ๐Ÿ“ฑ Compatible with Xamarin, MAUI, .NET Standard 2.0
  • โš™๏ธ No Admin SDK dependencies

๐Ÿ“ฆ Installation

# Create the project (if not already done)
dotnet new classlib -n FirebaseAESLib.Mobile -f netstandard2.0
cd FirebaseAESLib.Mobile

# Add required packages
dotnet add package System.Security.Cryptography.Algorithms
dotnet add package System.Text.Json

Or just include the .cs files directly into your Xamarin shared project.


๐Ÿ”ง Configuration

Create a 256-bit AES key and IV, then Base64 encode them:

var key = Convert.ToBase64String(RandomNumberGenerator.GetBytes(32));
var iv = Convert.ToBase64String(RandomNumberGenerator.GetBytes(16));

Store them securely (e.g., in SecureStorage or environment variables).


๐Ÿ” Usage Example

using FirebaseAESLib.Mobile;

var aes = new AesEncryptor("base64-key", "base64-iv");

// Firestore
var firestore = new FirestoreRestClient("your-project-id", "your-api-key", aes);
await firestore.SetEncryptedAsync("users", "user1", new Dictionary<string, object>
{
    { "name", "Alice" },
    { "email", "alice@example.com" }
});

var result = await firestore.GetDecryptedAsync("users", "user1");

// Realtime Database
var realtime = new RealtimeRestClient("your-project-id", "optional-id-token", aes);
await realtime.SetEncryptedAsync("users/user2", new Dictionary<string, object>
{
    { "phone", "12345678" }
});

var realtimeResult = await realtime.GetDecryptedAsync("users/user2");

๐Ÿ” Firebase Setup Required

Field Source
Project ID Firebase Console > Project Settings
Web API Key Firebase Console > Project Settings > General
ID Token (optional) Firebase Auth token for signed-in user

To use Firebase Authentication:

  • Sign in using REST API or Firebase SDK
  • Get the idToken and pass it to RealtimeRestClient

๐Ÿ“ Files

  • AesEncryptor.cs: AES logic
  • FirestoreRestClient.cs: Handles Firestore REST
  • RealtimeRestClient.cs: Handles Realtime DB REST
  • HttpClientExtensions.cs: Adds PatchAsync()

๐Ÿงช Roadmap / Coming Soon

  • Token auto-refresh
  • Firestore query support
  • Support for structured (non-string) types
  • Upload as NuGet package

โœ… License

MIT License

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.0.5 490 7/23/2025
1.0.4 479 7/22/2025
1.0.3 125 6/27/2025
1.0.2 137 6/26/2025
1.0.1 131 6/26/2025
1.0.0 138 6/25/2025