First Steps - Zig-Sec/PassKeeZ GitHub Wiki

PassKeeZ is a open-source passkey authenticator for Linux. It is used to store credentials and generate signatures for authentication on the web. After you've successfully installed PassKeeZ, you should find a hidden folder and configuration file in your home directory (~/.passkeez/config.json) with the following content:

{"db_path":"~/.passkeez/passkeez.kdbx", "lang":"english"}

The database path db_path points to a database where all your credentials are stored. This is by default a Keepass Database XML (KDBX) database, used by the KeePass family of password managers. You can manage your database using KeePassXC. PassKeeZ uses the same entry format as KeePassXC for storing passkeys. You are free to change the db_path as you like but make sure it either points to a KDBX4 or CCDB database.

The language lang defines the language of the PassKeeZ application. Supported languages are english and german.

If you're using PassKeeZ for the first time, the database pointed to by db_path probably won't exist. This is not a problem! PassKeeZ only accesses the database to either store a new passkey or create an assertion (signature) for authentication. If the database doesn't exist, a new database with the name specified by db_path will be created.

Let's say you want to register a new user on passkey.org using passkeys for authentication.

In the picture above, PassKeeZ is asking you, if you want to create a new database. You'll see those little message windows a lot. PassKeeZ is running as a deamon in the background and communicates with you, the user, via a different application called zigenity. If you click Yes, PassKeeZ will ask you for a password. This password is used to derive a secret key used to encrypt your passkeys. Make sure you remember it! If you want to change your password or delete a credential, you can use a password manager like KeePassXC.

After the database has been successfully created, PassKeeZ will again ask you for your password to decrypt the database.

After the database has been decrypted successfully, a new passkey is stored within it.

You've created your first passkey, congratulations! Try to sign out and in again.