Paste a secret, get a link, send it. The first person to open it and press
Reveal sees the secret; the link dies at that moment. The recipient needs a
browser and nothing else — no account, no client, no installed tooling.
The server cannot read what it stores. AES-256-GCM happens in the browser and
the key lives in the URL fragment, which browsers never transmit, so hushd
holds ciphertext and no key material. That is a property of where the key sits
rather than a promise about our conduct, which is why there is deliberately no
endpoint accepting a plaintext secret and no server-side-encryption fallback:
two guarantees behind one URL would be worse than one honest guarantee.
Three decisions carry the design:
* GET /s/{id} touches NO storage, not even to check existence. Slack, Teams,
WhatsApp, iMessage and Outlook Safe Links all fetch a URL before a human
sees it, so destroying on GET would destroy most secrets in transit and the
recipient's "already used" would be indistinguishable from interception.
Only POST /reveal consumes. Bot user-agent detection is an arms race;
removing the side effect from GET is not. Pinned by
TestGettingTheRevealPageNeverConsumesTheSecret.
* Destruction is one Redis GETDEL, which is atomic. GET-then-DEL has a window
where two simultaneous readers both win, and for a one-time secret that
window is the product. The store contract demands atomicity and the same
concurrency test runs against both implementations.
* Missing, already-revealed, expired and evicted are ONE indistinguishable
410. Separating them would confirm to a prober that a given link was real.
The secret id IS the capability, so secret.ID is a struct whose every
accidental path — %v, %s, String(), slog, json.Marshal — emits a redacted
handle or refuses, and the raw value needs an explicit Value(). The first
version tried to prevent leaks by implementing no String() at all; its own test
caught that Go's fmt prints unexported fields anyway, so forbidding the method
had removed the control rather than the leak.
Operationally: structured JSON on stdout in the fleet's wire format, which
Vector already collects with no annotation; six hush_* metrics on the chassis
registry with no id, IP or path in any label; five alert rules wired into
vmalert. The public Ingress enumerates /, /s/ and /api/ so /metrics, /healthz
and /readyz share the port but are unreachable from the internet — no
basic-auth middleware to maintain and get wrong.
Dependencies are vendored because go-chassis is private: the Woodpecker test
step and the in-cluster Kaniko build both run -mod=vendor with GOPROXY=off and
hold no git credential.
cmd/hush-mcp is a stdio MCP server doing the same client-side crypto locally,
so using hush from an agent preserves the same guarantee as using it from a
browser.
3.9 KiB
3.9 KiB
Changelog
All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
1.11.0 - 2023-05-02
Fixed
- Fix initialization of
Valuewrappers.
Added
- Add
Stringmethod toatomic.Pointer[T]type allowing users to safely print underlying values of pointers.
1.10.0 - 2022-08-11
Added
- Add
atomic.Float32type for atomic operations onfloat32. - Add
CompareAndSwapandSwapmethods toatomic.String,atomic.Error, andatomic.Value. - Add generic
atomic.Pointer[T]type for atomic operations on pointers of any type. This is present only for Go 1.18 or higher, and is a drop-in for replacement for the standard library'ssync/atomic.Pointertype.
Changed
- Deprecate
CASmethods on all types in favor of correspondingCompareAndSwapmethods.
Thanks to @eNV25 and @icpd for their contributions to this release.
1.9.0 - 2021-07-15
Added
- Add
Float64.Swapto match int atomic operations. - Add
atomic.Timetype for atomic operations ontime.Timevalues.
1.8.0 - 2021-06-09
Added
- Add
atomic.Uintptrtype for atomic operations onuintptrvalues. - Add
atomic.UnsafePointertype for atomic operations onunsafe.Pointervalues.
1.7.0 - 2020-09-14
Added
- Support JSON serialization and deserialization of primitive atomic types.
- Support Text marshalling and unmarshalling for string atomics.
Changed
- Disallow incorrect comparison of atomic values in a non-atomic way.
Removed
- Remove dependency on
golang.org/x/{lint, tools}.
1.6.0 - 2020-02-24
Changed
- Drop library dependency on
golang.org/x/{lint, tools}.
1.5.1 - 2019-11-19
- Fix bug where
Bool.CASandBool.Toggledo work correctly together causingCASto fail even though the old value matches.
1.5.0 - 2019-10-29
Changed
- With Go modules, only the
go.uber.org/atomicimport path is supported now. If you need to use the old import path, please add areplacedirective to yourgo.mod.
1.4.0 - 2019-05-01
Added
- Add
atomic.Errortype for atomic operations onerrorvalues.
1.3.2 - 2018-05-02
Added
- Add
atomic.Durationtype for atomic operations ontime.Durationvalues.
1.3.1 - 2017-11-14
Fixed
- Revert optimization for
atomic.String.Store("")which caused data races.
1.3.0 - 2017-11-13
Added
- Add
atomic.Bool.CASfor compare-and-swap semantics on bools.
Changed
- Optimize
atomic.String.Store("")by avoiding an allocation.
1.2.0 - 2017-04-12
Added
- Shadow
atomic.Valuefromsync/atomic.
1.1.0 - 2017-03-10
Added
- Add atomic
Float64type.
Changed
- Support new
go.uber.org/atomicimport path.
1.0.0 - 2016-07-18
- Initial release.