This project uses Meson, Ninja, and Cargo.
We use Meson 1.5.0+. If your package manager has an older version, you can install a new version using the pip module.
There is currently no documented minimum support Rust version (MSRV), but 1.85+ should work.
To build, you need the following utility packages and development library packages.
- GTK4
- gettext
- libdbus-1
- libnfc
- libpcsclite
- libssl/openssl
- libudev
Using the web extension also requires python3-dbus-next.
sudo apt update && sudo apt install \
# Build dependencies
curl git build-essential \
# Meson/Ninja dependencies
meson ninja-build \
# project dependencies
libgtk-4-dev gettext libdbus-1-dev libnfc-dev libpcsclite-dev libssl-dev libudev-dev \
# web extension dependencies
python3-dbus-next# Build dependencies
sudo dnf groupinstall "Development Tools"
sudo dnf install \
curl git \
# Meson/Ninja dependencies
meson ninja-build \
# project dependencies
gtk4-devel gettext dbus-devel libnfc-devel pcsc-lite-devel openssl-devel systemd-udev \
# web extension dependencies
python3-dbus-nextIf you are interested in installing the program, you can use meson install to
install the details. (If you would like to test without installing, you can
follow the build instructions for development below.)
To install the daemon and UI binaries, do the following:
git clone https://github.com/linux-credentials/credentialsd
cd credentialsd
meson setup -Dprefix=/usr/local build-release
meson install -C build-releaseNote that since Meson is installing to /usr/local, it will ask you to use
sudo to elevate privileges to install.
credentialsd depends on integration with xdg-desktop-portal. Until this is
upstreamed, you must build the patch from our fork. Setting a prefix of
/usr/local should allow xdg-desktop-portal to find the portal configuration
files from credentialsd installed in the previous step.
Note that recent xdg-desktop-portal builds require very recent versions of some dependencies, which may be difficult on some distros. For example, on Fedora, you must be on Fedora 44 or greater. Other distributions may require you to build the dependencies manually.
See the [official xdg-desktop-portal docs] for more information on building xdg-desktop-portal.
git clone https://github.com/linux-credentials/xdg-desktop-portal
cd xdg-desktop-portal
meson setup --prefix /usr/local . _build
meson install -C _buildAfter installing, you should enable the feature flag to enable the Credential
portal. Use systemctl --user edit xdg-desktop-portal.service and add the
following contents:
[Service]
Environment="XDG_DESKTOP_PORTAL_ENABLE_EXPERIMENTAL=credential"
Environment="G_MESSAGES_DEBUG=xdg-desktop-portal"
When using the installed server, systemd or D-Bus should take care of starting the services on demand, so you don't need to start it manually.
The first time you install this, though, you must log out and log back in again for the service activation files to take effect.
You can follow the logs with:
journalctl --user \
--pager-end \
--follow \
--unit xdg-desktop-portal.service \
--unit xyz.iinuwa.credentialsd.Credentials.service \
--unit xyz.iinuwa.credentialsd.UiControl.serviceNote: If you are testing the Firefox web extension, you will need to link the
native messaging manifest to your home directory, since Firefox does not read
from /usr/local:
mkdir -p ~/.mozilla/native-messaging-hosts/
LIBDIR=/usr/local/lib; [ -d /usr/local/lib64 ] && [ ! -L /usr/local/lib64 ] && LIBDIR=/usr/local/lib64
ln -s ${LIBDIR}/mozilla/native-messaging-hosts/xyz.iinuwa.credentialsd_helper.json ~/.mozilla/native-messaging-hosts/git clone https://github.com/linux-credentials/credentialsd
cd credentialsd
meson setup -Dprofile=development -Denable_trusted_client_overrides=true build
ninja -C build
enable_trusted_client_overrides lets the daemon read the
CREDSD_TRUSTED_CALLERS and CREDSD_TRUSTED_APP_IDS environment variables,
which are used below to trust a
development build of xdg-desktop-portal. Don't use it for builds you install:
any process in your session could then request credentials for any origin.
credentialsd-ui disables core dumps for itself, because it handles the PINs that users type. To debug a crash in the UI, turn core dumps back on:
meson configure -Denable_core_dumps=true build
ninja -C build
For more context on the patch, see the instructions above.
git clone https://github.com/linux-credentials/xdg-desktop-portal
cd xdg-desktop-portal
meson setup . _build
meson compile -C _buildTo run the required services during development, you need to add some environment variables.
# These paths must be absolute
XDP_REPO=/path/to/xdg-desktop-portal
CREDSD_REPO=/path/to/credentialsd
export XDG_DESKTOP_PORTAL_ENABLE_EXPERIMENTAL=credential
XDP_BINARY="$XDP_REPO/build/desktop-portal/xdg-desktop-portal"
$XDP_BINARY &
# Run the server, with debug logging enabled, and configure the server to trust your xdg-desktop-portal
export CREDSD_TRUSTED_CALLERS=$XDP_BINARY
export RUST_LOG=credentialsd=debug,libwebauthn=debug,pxp=debug
$CREDSD_REPO/build/credentialsd/src/credentialsd &
# Run the backend UI
export RUST_LOG=debug
export GSETTINGS_SCHEMA_DIR=$CREDSD_REPO/build/credentialsd-ui/data
$CREDSD_REPO/build/credentialsd-ui/src/credentialsd-uiIf you are using the Firefox add-on to test during development, follow the instructions for
development in webext/README.md.
There are a few Meson options to control the build that may be useful for packagers.
# list available options
> meson configure
# ...
Project options Default Value Possible Values Description
----------------- ------------- --------------- -----------
cargo_home The directory to store files downloaded by
Cargo
cargo_locked false [True, False] Whether Cargo.lock will be used without
modification. Defaults to false to
automatically resolve dependencies.
cargo_offline false [True, False] Whether to perform an offline build with
Cargo. Defaults to false to download crates
from registries.
enable_core_dumps false [True, False] Allow credentialsd-ui to write core dumps,
for debugging crashes. Defaults to false
because the UI handles PINs typed by the
user.
enable_trusted_client_overrides
false [True, False] Let the CREDSD_TRUSTED_CALLERS and
CREDSD_TRUSTED_APP_IDS environment variables
add trusted callers and privileged app IDs
to the daemon, for development. Defaults to
false because any process in the user
session could then request credentials for
any origin.
feature_daemon enabled [enabled, disabled, Whether to build the credentialsd daemon
auto]
feature_demo_client auto [enabled, disabled, Whether to build the demo client
auto]
feature_gui enabled [enabled, disabled, Whether to build the credentialsd-ui GUI
auto]
feature_web_extension enabled [enabled, disabled, Whether to build the web extension
auto]
profile release [release, development] The build profile for the targets. To relax
the security checks for development, see
`enable_trusted_client_overrides`.
For the feature_* options, auto means that the feature will be enabled if its dependencies are
discovered, and disabled if they are not: missing dependencies will not fail the build. See
Meson documentation on feature options for more information on those values.
Due to some unknown reason, tests hang unless you pass the --interactive flag to Meson, available since 1.5.0.
cd build
meson test --interactive