4d9a26498e
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.
80 lines
2.1 KiB
Makefile
80 lines
2.1 KiB
Makefile
# Directory to place `go install`ed binaries into.
|
|
export GOBIN ?= $(shell pwd)/bin
|
|
|
|
GOLINT = $(GOBIN)/golint
|
|
GEN_ATOMICINT = $(GOBIN)/gen-atomicint
|
|
GEN_ATOMICWRAPPER = $(GOBIN)/gen-atomicwrapper
|
|
STATICCHECK = $(GOBIN)/staticcheck
|
|
|
|
GO_FILES ?= $(shell find . '(' -path .git -o -path vendor ')' -prune -o -name '*.go' -print)
|
|
|
|
# Also update ignore section in .codecov.yml.
|
|
COVER_IGNORE_PKGS = \
|
|
go.uber.org/atomic/internal/gen-atomicint \
|
|
go.uber.org/atomic/internal/gen-atomicwrapper
|
|
|
|
.PHONY: build
|
|
build:
|
|
go build ./...
|
|
|
|
.PHONY: test
|
|
test:
|
|
go test -race ./...
|
|
|
|
.PHONY: gofmt
|
|
gofmt:
|
|
$(eval FMT_LOG := $(shell mktemp -t gofmt.XXXXX))
|
|
gofmt -e -s -l $(GO_FILES) > $(FMT_LOG) || true
|
|
@[ ! -s "$(FMT_LOG)" ] || (echo "gofmt failed:" && cat $(FMT_LOG) && false)
|
|
|
|
$(GOLINT):
|
|
cd tools && go install golang.org/x/lint/golint
|
|
|
|
$(STATICCHECK):
|
|
cd tools && go install honnef.co/go/tools/cmd/staticcheck
|
|
|
|
$(GEN_ATOMICWRAPPER): $(wildcard ./internal/gen-atomicwrapper/*)
|
|
go build -o $@ ./internal/gen-atomicwrapper
|
|
|
|
$(GEN_ATOMICINT): $(wildcard ./internal/gen-atomicint/*)
|
|
go build -o $@ ./internal/gen-atomicint
|
|
|
|
.PHONY: golint
|
|
golint: $(GOLINT)
|
|
$(GOLINT) ./...
|
|
|
|
.PHONY: staticcheck
|
|
staticcheck: $(STATICCHECK)
|
|
$(STATICCHECK) ./...
|
|
|
|
.PHONY: lint
|
|
lint: gofmt golint staticcheck generatenodirty
|
|
|
|
# comma separated list of packages to consider for code coverage.
|
|
COVER_PKG = $(shell \
|
|
go list -find ./... | \
|
|
grep -v $(foreach pkg,$(COVER_IGNORE_PKGS),-e "^$(pkg)$$") | \
|
|
paste -sd, -)
|
|
|
|
.PHONY: cover
|
|
cover:
|
|
go test -coverprofile=cover.out -coverpkg $(COVER_PKG) -v ./...
|
|
go tool cover -html=cover.out -o cover.html
|
|
|
|
.PHONY: generate
|
|
generate: $(GEN_ATOMICINT) $(GEN_ATOMICWRAPPER)
|
|
go generate ./...
|
|
|
|
.PHONY: generatenodirty
|
|
generatenodirty:
|
|
@[ -z "$$(git status --porcelain)" ] || ( \
|
|
echo "Working tree is dirty. Commit your changes first."; \
|
|
git status; \
|
|
exit 1 )
|
|
@make generate
|
|
@status=$$(git status --porcelain); \
|
|
[ -z "$$status" ] || ( \
|
|
echo "Working tree is dirty after `make generate`:"; \
|
|
echo "$$status"; \
|
|
echo "Please ensure that the generated code is up-to-date." )
|