Skip to content

Adhal 0.1.1

Choose a tag to compare

@khartig khartig released this 22 Oct 04:19
· 48 commits to main since this release

Adhal works exactly as it did in 0.1.0: the code in both packages is
unchanged, and so is the wire format. What is new is how this release
was published. It is the first one built and published by GitHub
Actions, with no npm token, and anyone can check that the packages on
npm came from this repository.

npm install --global @ad-hal/cli

Node.js ≥ 24, on macOS or Linux. The packages are
@ad-hal/cli and
@ad-hal/engine, which
the CLI depends on. Any other package that claims to be Adhal is
unofficial.

Security fixes in this release: none. 0.1.0 is not deprecated, and
a 0.1.0 peer and a 0.1.1 peer can drop files to each other.

What changed

  • Both packages were published by GitHub Actions through npm trusted
    publishing. npm accepts a publish of @ad-hal/engine or
    @ad-hal/cli only from this repository's release workflow, in an
    environment where each publish is approved by hand. No long-lived npm
    token exists to steal.
  • Each package has a provenance attestation on npm, so the package
    page shows which commit and workflow run built it, and
    npm audit signatures checks it.
  • The release carries its own artifacts: both tarballs, exactly as
    published, a SHA256SUMS file, and a CycloneDX SBOM for each package.
    Each tarball also has a GitHub build attestation, signed through
    Sigstore.
  • Both package READMEs link to these release notes, so the npm page
    says where to find out what changed in each version and which
    versions have security fixes.

Checking this release

Each of these runs on its own:

npm view @ad-hal/cli@0.1.1 dist.attestations.provenance.predicateType
gh release download v0.1.1 --repo khartig/adhal
sha256sum -c SHA256SUMS
gh attestation verify ad-hal-cli-0.1.1.tgz --repo khartig/adhal
gh attestation verify ad-hal-engine-0.1.1.tgz --repo khartig/adhal

The first command prints https://slsa.dev/provenance/v1. On macOS,
use shasum -a 256 -c SHA256SUMS in place of sha256sum. After an
install, npm audit signatures verifies the registry signatures of
everything installed, and the attestations of both Adhal packages.

The SBOMs list the dependency tree that was locked and tested. Neither
package ships a lockfile, so an install can resolve newer versions of
the packages that Adhal's dependencies depend on. npm sbom describes
what an install actually resolved.

Before you use it

  • Adhal is not anonymous. Each side's IP address is visible to the
    other, and to the DHT nodes near the drop's topic.
  • The code is a bearer capability. Whoever holds it can complete the
    drop.
  • Windows is not supported for security purposes yet.
  • The cryptographic composition has not been independently reviewed.
    The primitives come from @noble and OpenSSL, and the CPace
    implementation reproduces the CFRG test vectors. The review of 21
    findings in
    SECURITY-REVIEW.md
    was AI-assisted, not independent.
  • The JavaScript API of @ad-hal/engine is not stable before 1.0, and
    the CLI's flags may still change. The wire protocol will not.
  • Not built yet: LAN discovery, a relay for networks where a direct
    connection fails, and stable --json events.

What a drop does, the protocol, and what has been measured are in the
0.1.0 release notes.

Support

The latest npm release and the default branch are supported. Report a
vulnerability privately, as
SECURITY.md
describes, not in a public issue. A version with a known vulnerability
will be deprecated on npm, so installing it prints a warning.