32 releases (18 breaking)
|0.19.0||Aug 30, 2022|
|0.18.1||Dec 17, 2021|
|0.17.0||Dec 12, 2021|
|0.16.3||Nov 28, 2021|
|0.4.0||Apr 30, 2020|
#86 in Development tools
Independent verification system of binary packages.
- Accessing a rebuilderd instance in your browser
- Scripting access to a rebuilderd instance
- Running a rebuilderd instance yourself
rebuilderd monitors the package repository of a linux distribution and uses rebuilder backends like archlinux-repro to verify the provided binary packages can be reproduced from the given source code.
It tracks the state of successfully verified packages and optionally generates a report of differences with diffoscope for debugging. Note that due to the early state of this technology a failed rebuild is more likely due to an undeterministic build process instead of a supply chain compromise, but if multiple rebuilders you trust report 100% reproducible for the set of packages you use you can be confident that the binaries on your system haven't been tampered with. People are encouraged to run their own rebuilders if they can afford to.
|Status||Docker||Doesn't need --privileged||Doesn't need /dev/kvm||Backend|
|Arch Linux||✔️ supported||❌||-||✔️||archlinux-repro|
|Tails||🚀 experimental||❌||-||❌||docs (script)|
Docker: There's a docker-compose example setup in this repository, but not all rebuilder backends support running inside of a docker container (for example because it's creating containers itself).
Doesn't need --privileged: Some rebuilder backends create containers in a way that works inside of a docker container, if they're granted the required kernel capabilities to do so. This may have security implications for other containers running on that system or the code running inside the container may reconfigure the system outside of the docker container.
Doesn't need /dev/kvm: Some build tools may need to start a virtual machine and depend on /dev/kvm to be available. This is a special requirement for the hosting environment, you either need a VPS with Nested KVM or dedicated non-virtualized hardware.
Accessing a rebuilderd instance in your browser
Many instance run a web frontend to display their results. rebuilderd-website is a very good choice and the software powering the Arch Linux rebuilderd instance:
Loading the index of all packages may take a short time.
Scripting access to a rebuilderd instance
It's also possible to query and manage a rebuilderd instance in a scriptable
way. It's recommended to install the
rebuildctl commandline util to do this
(instructions for your system may vary, see packaging status to the right):
pacman -S rebuilderd-tools
You can then query a rebuilderd instance for the status of a specific package:
rebuildctl -H https://reproducible.archlinux.org pkgs ls --name rebuilderd
You have to specify which instance you want to query because there's no definite truth™. You could ask multiple instances though, including one you operate yourself.
If the rebuilder seems to have outdated data or lists a package as unknown the update may still be in the build queue. You can query the build queue of an instance like this:
rebuildctl -H https://reproducible.archlinux.org queue ls --head
If there's no output that means the build queue is empty.
If you're the administrator of this instance you can also run commands like:
Or immediately retry all failed rebuild attempts (there's an automatic retry on by default):
rebuildctl pkgs requeue --status BAD --reset
Running a rebuilderd instance yourself
"I compile everything from source" - a significant amount of real world binary packages can already be reproduced today. The more people run rebuilders, the harder it is to compromise all of them.
At the current stage of the project we're interested in every rebuilder there is! Most rebuilderd discussion currently happens in #archlinux-reproducible on libera, feel free to drop by if you're running a instance or considering setting one up. Having a few unreproducible packages is normal (even if it's slightly more than the official rebuilder), but having additional people confirm successful rebuilds is very helpful.
Rebuilding Arch Linux
Please see the setup instructions in the Arch Linux Wiki.
Development with docker
There is a docker-compose setup in the repo, to start a basic stack simply clone the repository and run:
DOCKER_BUILDKIT=1 docker-compose up
The initial build is going to take some time.
To recompile your changes (you can optionally specify a specific image to build):
DOCKER_BUILDKIT=1 docker-compose build
The auth cookie has strict permissions, for development simply change them with:
sudo chmod 0644 secret/auth
Check you can successfully run administrative tasks, use this command to compile and run the
REBUILDERD_COOKIE_PATH=secret/auth cargo run -p rebuildctl -- -v status
There are no packages in the database yet, there's an example profile that we can load. It only contains one lightweight package and should successfully rebuild out-of-the-box in our docker-compose setup.
REBUILDERD_COOKIE_PATH=secret/auth cargo run -p rebuildctl -- pkgs sync-profile --sync-config contrib/confs/rebuilderd-sync.conf debian-anarchism
Check the package was successfully added to the database with status
REBUILDERD_COOKIE_PATH=secret/auth cargo run -p rebuildctl -- pkgs ls
You can display the build queue with this command, it's also going to display a timer for jobs that are currently in progress:
REBUILDERD_COOKIE_PATH=secret/auth cargo run -p rebuildctl -- queue ls --head
You can use a combination of the commands mentioned to monitor your rebuilder. The packages should eventually show up as
rebuildctl pkgs ls.
If you want to build from source or you want to run rebuilderd built from a specific commit this section contains instructions for that.
A rebuilder consists of the
rebuilderd daemon and >= 1 workers:
First we switch into the
daemon/ folder and run our rebuilderd daemon:
cd daemon; cargo run
This takes a moment but the api should now be available at
This daemon needs to run in the background, so we're starting a new terminal to continue with the next steps.
Next we're going to build the
rebuilctl binary and confirm it's able to
connect to the api. If we don't get an error message this means it's working.
cd tools; cargo run -- status
We didn't connect any workers yet so this output is empty.
Next we want to connect a rebuilder. rebuilderd only does the scheduling for you, so you need to install additional software here (called a rebuilder backend):
- Arch Linux:
pacman -S archlinux-reproor
git clone https://github.com/archlinux/archlinux-repro && archlinux-repro/ && make && sudo make install. Note that on debian buster you need to install systemd from buster-backports.
With a rebuilder backend installed we're now going to run our first worker:
cd worker; cargo run -- connect http://127.0.0.1:8484
This rebuilder should now show up in our
rebuildctl status output:
cd tools; cargo run -- status
Next we're going to import some packages:
cd tools; cargo run -- pkgs sync archlinux community \ 'https://ftp.halifax.rwth-aachen.de/archlinux/$repo/os/$arch' \ --architecture x86_64 --maintainer kpcyrd
--maintainer option is optional and allows you to rebuild packages by a specific maintainer only.
To show the current status of our imported packages run:
cd tools; cargo run -- pkgs ls
To monitor your workers are picking up tasks:
cd tools; cargo build && CLICOLOR_FORCE=1 watch -c ../target/debug/rebuildctl status
To inspect the queue run:
cd tools; cargo run -- queue ls
An easy way to test the package import is using a command like this:
cargo watch -- cargo run --bin rebuildctl -- pkgs sync-profile --print-json --sync-config contrib/confs/rebuilderd-sync.conf tails
Build a package directly:
cargo run --bin rebuilderd-worker -- \ build debian 'http://deb.debian.org/debian/pool/main/a/anarchism/anarchism_15.3-3_all.deb' \ --input-url 'https://buildinfos.debian.net/buildinfo-pool/a/anarchism/anarchism_15.3-3_all.buildinfo' \ --backend 'debian=./rebuilder-debian.sh'
Debian: pkg-config liblzma-dev libssl-dev libsqlite3-dev libzstd-dev
Rebuilderd development is currently funded by:
kpcyrd's savings account
- Google and The Linux Foundation
- People like you and me on github sponsors