Something went wrong. Try again.
An HTTP library for Zig 0.17, server and client, HTTP/1.0 through HTTP/3, with the protocol in a module that owns no socket.
Something went wrong. Try again.
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212# SPDX-FileCopyrightText: © 2026 Jeffrey C. Ollie <jeff@ocjtech.us># SPDX-License-Identifier: MIT
{ description = "zig-http";
inputs = { nixpkgs = { url = "https://channels.nixos.org/nixos-unstable/nixexprs.tar.xz"; }; # Reads `build.zig.zon`, follows every transitive dependency, and writes a # Nix expression for the lot. A Nix build has no network and the Zig # package manager wants one; this is the bridge. Not the `zon2nix` in # nixpkgs, which is a different program taking different options. zon2nix = { url = "github:jcollie/zon2nix"; inputs.nixpkgs.follows = "nixpkgs"; }; };
outputs = { nixpkgs, zon2nix, ... }: let inherit (nixpkgs) lib; makePackages = system: import nixpkgs { inherit system; }; forAllSystems = lib.genAttrs lib.systems.flakeExposed; # The virtual machine tests are NixOS ones, so they exist only where # NixOS does. Without this `nix flake check` tries to evaluate them for # Darwin and fails before it has run anything. forLinuxSystems = lib.genAttrs ( lib.filter (system: lib.hasSuffix "-linux" system) lib.systems.flakeExposed );
# The devshell's Zig, with one line of its own standard library put # right, because without it `zig build fuzz --fuzz` cannot compile. # # Zig 0.16.0's `compiler/test_runner.zig` reports a failing fuzz input by # asking `std.debug.writeStackTrace` to print what `@errorReturnTrace()` # gave it. Those are two different types: an error return trace is a # `builtin.StackTrace`, a ring buffer with a write index, and that # function takes a `debug.StackTrace`, which is a plain slice and a count # of what was skipped. It is a type error, it is on the path taken only # under `-ffuzz`, and it stops *any* project with a fuzz test in it from # building one. The fix is the function next door: `writeErrorReturnTrace` # takes exactly the type in hand and is what the other three places in # the same file use. # # `--replace-fail` is the whole safety of this: the day Zig ships the fix # the pattern will not be found, the build will fail here rather than # patch something else, and this can go. # # It buys the fuzzer and not its coverage. Nothing in this release # populates the table of program counters, so a bounded run ends with # "corrupted coverage file: pcs_len was zero" and an unbounded one # panics in the build runner's coverage thread; neither is a finding, # and a finding says "input saved to" above the report. The properties in # `tests/fuzz.zig` run as ordinary tests either way, and # `zig build fuzz-run` drives them with a loop of our own. fuzzableZig = pkgs: let # A farm of symlinks rather than a copy: the library is 217 MB, and # exactly one file of it is being changed. library = pkgs.runCommand "zig-0.16.0-lib-fuzz-fix" { } '' cp -rs --no-preserve=mode ${pkgs.zig_0_16}/lib/zig $out chmod -R u+w $out rm $out/compiler/test_runner.zig cp --no-preserve=mode \ ${pkgs.zig_0_16}/lib/zig/compiler/test_runner.zig \ $out/compiler/test_runner.zig substituteInPlace $out/compiler/test_runner.zig \ --replace-fail \ 'std.debug.writeStackTrace(trace, stderr)' \ 'std.debug.writeErrorReturnTrace(trace, stderr)'
# And one character of the flate decoder, which is upstream's own # fix backported. # # `tossBitsShort` adds `consumed_bits` where it must subtract them, # so it reports more bits available than there are; execution # carries on and underflows a `usize` later, in `peekBitsEnding`, # on a subtraction that is itself correct. Twenty-five octets of # malformed gzip are enough, which is how this repository's # `coded-bodies` target met it. # # Fixed upstream by ziglang/zig#35815, merged 2026-06-17 for # 0.17.0, after 0.16.0 had shipped. This is that change and not an # invention of ours: patching the crash site instead -- which was # the first attempt here -- silences the symptom while leaving the # decoder believing it has bits it does not. # # The devshell's Zig only. `package.nix` builds with nixpkgs' # unpatched `zig_0_16`, so the shipped binary is exposed exactly as # any other program on this toolchain is, until the pin moves past # the fix. `coding.UndoError` documents that. rm $out/std/compress/flate/Decompress.zig cp --no-preserve=mode \ ${pkgs.zig_0_16}/lib/zig/std/compress/flate/Decompress.zig \ $out/std/compress/flate/Decompress.zig substituteInPlace $out/std/compress/flate/Decompress.zig \ --replace-fail \ 'if (d.input.bufferedLen() * 8 + d.consumed_bits < n) return error.EndOfStream;' \ 'if (d.input.bufferedLen() * 8 - d.consumed_bits < n) return error.EndOfStream;' ''; in pkgs.symlinkJoin { name = "zig-0.16.0-fuzzable"; paths = [ pkgs.zig_0_16 ]; nativeBuildInputs = [ pkgs.makeWrapper ]; postBuild = '' wrapProgram $out/bin/zig --set ZIG_LIB_DIR ${library} ''; }; in { packages = forAllSystems ( system: let pkgs = makePackages system; in rec { zig-http = pkgs.callPackage ./package.nix { }; default = zig-http; # The dependency farm on its own, for a job that runs `zig build` # for something other than the package -- the documentation, say -- # and needs the same dependencies without building the package to # get at them. zig-deps = pkgs.callPackage ./build.zig.zon.nix { }; } );
# The tests that need a machine rather than a process: a real curl, a # real h2spec and real load, each talking to the demonstration server # over a socket from a host of its own. None is reachable from a test # binary — they are about whether other implementations agree about the # framing, whether the HTTP/2 driver conforms, and what happens when # fifty clients are inside the server at once. checks = forLinuxSystems ( system: let pkgs = makePackages system; zig-http = pkgs.callPackage ./package.nix { }; test = file: pkgs.testers.runNixOSTest (import file { inherit zig-http; }); in { inherit zig-http; curl = test ./tests/nixos/curl.nix; h3 = test ./tests/nixos/h3.nix; aioquic = test ./tests/nixos/aioquic.nix; h2spec = test ./tests/nixos/h2spec.nix; load = test ./tests/nixos/load.nix; window = test ./tests/nixos/window.nix; tls = test ./tests/nixos/tls.nix; proxy = test ./tests/nixos/proxy.nix; client = test ./tests/nixos/client.nix; h3client = test ./tests/nixos/h3client.nix; traefik = test ./tests/nixos/traefik.nix; } );
devShells = forAllSystems ( system: let pkgs = makePackages system; in { default = pkgs.mkShell { name = "zig-http"; nativeBuildInputs = [ (fuzzableZig pkgs) pkgs.git-pages-cli pkgs.reuse
# Wrapped so that the Zig it shells out to for `zig env` is this # project's rather than whatever happens to be on the caller's # PATH -- without one it prints "unable to execute zig" and # stops, having written nothing, which leaves the previous # generated file in place looking untouched. (pkgs.symlinkJoin { name = "zon2nix"; paths = [ zon2nix.packages.${pkgs.stdenv.hostPlatform.system}.zon2nix ]; nativeBuildInputs = [ pkgs.makeWrapper ]; postBuild = '' wrapProgram $out/bin/zon2nix \ --prefix PATH : ${lib.makeBinPath [ pkgs.zig_0_16 ]} ''; })
# The other implementations to test against. curl is the # strictest reading of RFC 9112 likely to connect to this; # h2spec is the conformance suite for RFC 9113, and nghttp2 # brings `h2load` and the `nghttp` debug client. pkgs.curl pkgs.h2spec pkgs.httpie pkgs.nghttp2 pkgs.siege ]; }; } ); };}