Skip to content

About

SpiritByte keeps your credentials in an encrypted vault on your device. Create folders, generate passwords, customize the interface and transfer encrypted backups between Android and desktop. No account or server is required, and the app does not request Internet access.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

SpiritByte fox logo

SpiritByte Android

An offline password manager for Android, built with Kotlin, Jetpack Compose and Rust.

SpiritByte keeps your credentials in an encrypted vault on your device. Create folders, generate passwords, customize the interface and transfer encrypted backups between Android and desktop. No account or server is required, and the app does not request Internet access.

Current version: 0.4.0. Compatibility: Android 8.0 or later, ARM64 and x86_64.

Desktop version

SpiritByte Android is the mobile companion to SpiritByte Desktop. Both versions use the same Rust vault engine and support encrypted .spiritbyte backups, including folder structure, icons and colors.

Open the SpiritByte Desktop repository

Explore SpiritByte Desktop

Backup transfer is manual; automatic synchronization is not implemented.

Features

  • Local encrypted vault protected by a master password and a 12-word recovery phrase.
  • Create, edit, search and favorite credentials; generate passwords with the Rust engine.
  • Folders and subfolders with 22 icons, custom colors and credential filtering.
  • Encrypted backup import and export, compatible with desktop.
  • Automatic locking when the app enters the background and after two minutes of inactivity.
  • Screenshot protection and exclusion of the vault from Android automatic backups.
  • Bundled Geist Pixel fonts, five color palettes, CRT scanlines and adjustable panel opacity.
  • Solid, gradient, custom image or animated GIF backgrounds, plus the original animated fox intro.
  • Copy the 12-word recovery phrase, with sensitive clipboard preview handling.
  • Minimum-consumption appearance preset, bounded wallpaper decoding and cached vault filtering.

Deleting a folder preserves its credentials. Folder icons, colors and hierarchy are also retained when importing a backup.

Preview

SpiritByte appearance settings with Geist Pixel typography SpiritByte animated fox introduction

Build on Windows

Requirements

  • JDK 17 or a compatible Android Studio JDK, with JAVA_HOME configured.
  • Rust with the MSVC toolchain and Visual Studio C++ build tools.
  • Android SDK Platform 36, Build Tools 35.0.0 and NDK 28.2.13676358.
  • Git. Gradle 8.11.1 is provided through the wrapper.
git clone https://github.com/OscarTired/SpiritByte-Android.git
cd SpiritByte-Android
rustup target add aarch64-linux-android x86_64-linux-android
cargo install cargo-ndk --version 4.1.2 --locked

Set ANDROID_SDK_ROOT to your SDK directory and create an untracked local.properties file pointing to that same SDK. For example:

$env:ANDROID_SDK_ROOT = 'C:\Android\Sdk'
'sdk.dir=C\:/Android/Sdk' | Set-Content local.properties
.\scripts\build.ps1

The build generates UniFFI Kotlin bindings, compiles the Rust library for both Android architectures, builds the application and runs Android lint. The APK is copied to:

instalador/SpiritByte-Android.apk

Install this APK to run SpiritByte (com.spiritbyte.android). The app-debug-androidTest.apk file is only a test package and has no launcher icon.

The output is a debug-signed development build. Add -Lightweight to generate an optimized installer with R8 code/resource shrinking and debugging disabled, using the same development signing key. Updating an existing installation requires the same signing key; keep your encrypted backup before changing build environments. When using the same key, install over the existing app to preserve its vault.

To work in Android Studio, first run scripts/build-native.ps1, then open this repository. Generated Kotlin bindings and native libraries are not tracked in Git and should not be edited manually. After generating them, scripts/build.ps1 -SkipNative rebuilds the Android interface without rebuilding Rust.

The desktop checkout is not required for a normal Android build. Fonts, icons and artwork are already included. Optional asset-import scripts expect a sibling checkout named SpireByte-V2; font conversion additionally requires Python fonttools and brotli, and icon conversion requires the desktop Node dependencies.

Low resource usage and GIF backgrounds

Use Tema → Aplicar consumo mínimo for a solid background, opaque panels and disabled CRT/glow/intro effects. Choosing solid or gradient releases the decoded wallpaper while retaining the saved file. Static images are decoded to a maximum edge of 1280 px. Animated GIFs use the native Android decoder at up to 960 px and stop when their view is hidden or detached. Android 8 uses a fallback capped at 30 redraws per second and accepts GIF dimensions up to 960 × 960 px. Import accepts files up to 20 MiB.

GIFs remain animated after restarting the app. They use more CPU/battery than a solid background; choose the minimum-consumption preset when battery usage matters most. Physical-device RAM/battery measurements are still pending.

.\scripts\build.ps1 -SkipNative -Lightweight
# Run the instrumented suite on the development build:
.\gradlew.bat :app:connectedDebugAndroidTest

Backups and recovery

Choose a separate backup password when exporting a .spiritbyte file. The vault recovery phrase cannot unlock an exported backup.

To import, choose the file, unlock the vault again if requested, and enter the backup password. Imported records receive new IDs and are added to the destination vault; importing the same backup twice creates duplicates. Visual preferences and wallpapers are not included.

Write down or copy the recovery phrase before leaving its screen. It is shown once during setup. Opening Android's document picker locks the vault; export retains only encrypted backup data while that picker is open.

Architecture

app/       Jetpack Compose UI, lifecycle handling and Android document access
core/      Shared Rust encryption, vault, backup and password-generation engine
native/    UniFFI bridge, serialized sessions and transactional mutations
scripts/   Windows build tools and optional desktop asset conversion

The Rust core is the standalone spiritbyte-core library in this repository's core/ directory. Android's native bridge uses this local copy. Desktop includes its own copy of the same library, so each application can build independently without downloading the other repository.

When changing the engine, apply the same source and dependency changes to both repositories' core/ directories and run the core tests in both to preserve vault and backup compatibility. Copies do not synchronize automatically. See the core library README.

Security and development status

The app stores vault files in its private Android storage. Encryption uses Argon2id key derivation and XChaCha20-Poly1305 authenticated encryption. Backups are encrypted before being handed to Android's document picker.

The vault data encryption key is managed in Rust. Displayed credentials and entered passwords also exist in Android-managed memory, so guaranteed erasure of Kotlin strings is not claimed. Locking clears the visible session and prevents late background results from reopening it.

This is a development version. Biometric unlock, Android autofill and automatic synchronization are not implemented. Physical-device performance and memory validation remain pending. Publishing to an app store requires release signing and a review of its current target SDK requirements.

Verification

cargo test --manifest-path core/Cargo.toml
cargo test --manifest-path native/Cargo.toml --lib
.\gradlew.bat :app:lintDebug :app:assembleDebug
# With a connected emulator or test device:
.\gradlew.bat :app:connectedDebugAndroidTest

The instrumented tests exercise the real native library using temporary vaults, covering persistence, locking, recovery, backups and folder behavior. See VALIDATION.md for recorded results and remaining checks.

License

SpiritByte Android is released under the MIT License. Bundled font and icon licenses are included in app/src/main/assets/licenses.

About

SpiritByte keeps your credentials in an encrypted vault on your device. Create folders, generate passwords, customize the interface and transfer encrypted backups between Android and desktop. No account or server is required, and the app does not request Internet access.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages