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.
123 lines
4.0 KiB
Go
123 lines
4.0 KiB
Go
package redis
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
"strings"
|
|
)
|
|
|
|
// HOTKEYS commands are only available on standalone *Client instances.
|
|
// They are NOT available on ClusterClient, Ring, or UniversalClient because
|
|
// HOTKEYS is a stateful command requiring session affinity - all operations
|
|
// (START, GET, STOP, RESET) must be sent to the same Redis node.
|
|
//
|
|
// If you are using UniversalClient and need HOTKEYS functionality, you must
|
|
// type assert to *Client first:
|
|
//
|
|
// if client, ok := universalClient.(*redis.Client); ok {
|
|
// result, err := client.HotKeysStart(ctx, args)
|
|
// // ...
|
|
// }
|
|
|
|
// HotKeysMetric represents the metrics that can be tracked by the HOTKEYS command.
|
|
type HotKeysMetric string
|
|
|
|
const (
|
|
// HotKeysMetricCPU tracks CPU time spent on the key (in microseconds).
|
|
HotKeysMetricCPU HotKeysMetric = "CPU"
|
|
// HotKeysMetricNET tracks network bytes used by the key (ingress + egress + replication).
|
|
HotKeysMetricNET HotKeysMetric = "NET"
|
|
)
|
|
|
|
// HotKeysStartArgs contains the arguments for the HOTKEYS START command.
|
|
// This command is only available on standalone clients due to its stateful nature
|
|
// requiring session affinity. It must NOT be used on cluster or pooled clients.
|
|
type HotKeysStartArgs struct {
|
|
// Metrics to track. At least one must be specified.
|
|
Metrics []HotKeysMetric
|
|
// Count is the number of top keys to report.
|
|
// Default: 10, Min: 10, Max: 64
|
|
Count uint8
|
|
// Duration is the auto-stop tracking after this many seconds.
|
|
// Default: 0 (no auto-stop)
|
|
Duration int64
|
|
// Sample is the sample ratio - track keys with probability 1/sample.
|
|
// Default: 1 (track every key), Min: 1
|
|
Sample int64
|
|
// Slots specifies specific hash slots to track (0-16383).
|
|
// All specified slots must be hosted by the receiving node.
|
|
// If not specified, all slots are tracked.
|
|
Slots []uint16
|
|
}
|
|
|
|
// ErrHotKeysNoMetrics is returned when HotKeysStart is called without any metrics specified.
|
|
var ErrHotKeysNoMetrics = errors.New("redis: at least one metric must be specified for HOTKEYS START")
|
|
|
|
// HotKeysStart starts collecting hotkeys data.
|
|
// At least one metric must be specified in args.Metrics.
|
|
// This command is only available on standalone clients.
|
|
func (c *Client) HotKeysStart(ctx context.Context, args *HotKeysStartArgs) *StatusCmd {
|
|
cmdArgs := make([]interface{}, 0, 16)
|
|
cmdArgs = append(cmdArgs, "hotkeys", "start")
|
|
|
|
// Validate that at least one metric is specified
|
|
if len(args.Metrics) == 0 {
|
|
cmd := NewStatusCmd(ctx, cmdArgs...)
|
|
cmd.SetErr(ErrHotKeysNoMetrics)
|
|
return cmd
|
|
}
|
|
|
|
cmdArgs = append(cmdArgs, "metrics", len(args.Metrics))
|
|
for _, metric := range args.Metrics {
|
|
cmdArgs = append(cmdArgs, strings.ToLower(string(metric)))
|
|
}
|
|
|
|
if args.Count > 0 {
|
|
cmdArgs = append(cmdArgs, "count", args.Count)
|
|
}
|
|
|
|
if args.Duration > 0 {
|
|
cmdArgs = append(cmdArgs, "duration", args.Duration)
|
|
}
|
|
|
|
if args.Sample > 0 {
|
|
cmdArgs = append(cmdArgs, "sample", args.Sample)
|
|
}
|
|
|
|
if len(args.Slots) > 0 {
|
|
cmdArgs = append(cmdArgs, "slots", len(args.Slots))
|
|
for _, slot := range args.Slots {
|
|
cmdArgs = append(cmdArgs, slot)
|
|
}
|
|
}
|
|
|
|
cmd := NewStatusCmd(ctx, cmdArgs...)
|
|
_ = c.Process(ctx, cmd)
|
|
return cmd
|
|
}
|
|
|
|
// HotKeysStop stops the ongoing hotkeys collection session.
|
|
// This command is only available on standalone clients.
|
|
func (c *Client) HotKeysStop(ctx context.Context) *StatusCmd {
|
|
cmd := NewStatusCmd(ctx, "hotkeys", "stop")
|
|
_ = c.Process(ctx, cmd)
|
|
return cmd
|
|
}
|
|
|
|
// HotKeysReset discards the last hotkeys collection session results.
|
|
// Returns an error if tracking is currently active.
|
|
// This command is only available on standalone clients.
|
|
func (c *Client) HotKeysReset(ctx context.Context) *StatusCmd {
|
|
cmd := NewStatusCmd(ctx, "hotkeys", "reset")
|
|
_ = c.Process(ctx, cmd)
|
|
return cmd
|
|
}
|
|
|
|
// HotKeysGet retrieves the results of the ongoing or last hotkeys collection session.
|
|
// This command is only available on standalone clients.
|
|
func (c *Client) HotKeysGet(ctx context.Context) *HotKeysCmd {
|
|
cmd := NewHotKeysCmd(ctx, "hotkeys", "get")
|
|
_ = c.Process(ctx, cmd)
|
|
return cmd
|
|
}
|