bitritter (original) (raw)

Simple GTK app (Relm4 framework) to interact with Bitwarden/Vaultwarden vaults. Aimed at Linux mobile devices, but works on Desktop too. Maybe it works on other platforms as well, but they are not tested/maintained.

About this app

Motivation

This app started as a hobby project, since i am interested in testing out Linux phones as a daily driver and found it difficult to use, because most of my online accounts are protected by long and complicated passwords stored in my Vaultwarden instance. Since Bitwarden itself as a company has other priorities right now than to provide a mobile Linux client, i tried to build one on my own.

Name

Bitritter is a combination of Bitwarden, which the client aims to be compatilble with and the german word Ritter, which means knight.

Installation

Manual installation

Right now the only way to install is to clone this repository and compile it yourself. Usually it can be done via

  cargo build --release

with cargo installed (usually via rustup). A binary named bitritter should then appear in the target/release/ directory.

Installation via package manager

PostMarketOS

The app is in the testing repositories of Alpine already, so if you have that enabled, just use

  apk add bitritter

usually with root permissions.

NixOS

coming soon

Other

Help appreciated with formats like Mobian, Flatpak etc.

State

This app is still in a very early stage of development, but i wanted to upload my work, because there were several people interested in seeing it and maybe even contributing to it. Release early, release often, eh?

Feature list

Add a vault via GUI
Persist the vault information and active vault (later needed for switching) information
Login to a server (partial)
- Login with master password only
- Two Factor Authentication (2FA)
- Login with client certificate
Sync your vault
Manual Sync via button (in the List Menu)
Unlock the vault
Look at Entry details
- Login
- Card
- Identity
- Note
Edit Entry details
Save edited details to the vault
Delete entries
Basic filter and search capabilities on the list
Basic sorting on the list

Personal Vault

Decrypt values to show on the detail page
Copy values from the detail page
provide TOTP token
decrypt URIs
open links/URIs directly from the detail page

Organisation Vault

Not yet supported

Usage

Creating/connecting to a vault

Considering you already have a bitwarden or vaultwarden vault, if not prompted at the first start of the app, use the Menu "Vault" and then "add Vault". In the dialog, fill in the respective fields. Since we use the rbw crate as our backend, the instructions here can be helpful.

After configuring a server, you should be prompted to enter your master password. BitRitter will then fetch the data (sync) and try to decrypt the vault items. In case of an error, a message toast should appear, otherwise you will be navigated to the Vault List.

Vault List

From the Vault List you have several options:

Display a Vault Item in Detail View.
Apply Filters.
Apply Sorting configurations. For now we can only sort by name in either Ascending or Descending order.
Sync the Vault
Add another Vault. Switching between Vaults might be implemented at a later point in time.

Detail View

In this view you have the following options:

View field contents
Copy field contents
Copy TOTP tokens
Copy links (URIs) or open them with your systems default action (Browser for websites etc.)

Alternatives

After my first proof of concept, i got informed about Goldwarden, which has similar goals. I think it is more feature complete right now, so maybe it is interesting for you aswell.

Contributing

Please refrain from opening issues about lacking features, since i got many topics on my list already. PRs for improving my coding style are welcome, but please do not rewrite the whole code... If there are bugs right now, you can open an issue, but since the app is quite unstable, i am not sure they get addressed very soon. I hope that can change if i can get the basic features stabilized.