Redact
Hide secrets from a recording, what that covers, and where it stops.
effects.Redact hides the cells of a region from every frame it passes on.
Effects: []reel.Effect{
effects.Redact(effects.Env("API_TOKEN")),
effects.Redact(effects.Regexp(regexp.MustCompile(`sk-[A-Za-z0-9]{20,}`)), effects.Blur()),
},| Style | Draws |
|---|---|
Block() | A blank cell in the cell's background color, so it looks like the blank part of its row. The default. |
Blur() | Blurred text. The cell is drawn as an x and then blurred, so what it held is never drawn, and no amount of sharpening brings it back. |
Replace(c) | The character c, in the cell's own colors |
Between limits it to a window, and MinPartial is below.
What it covers
Effects after Redact never see what it hid, and it runs first.
Text, Env, and Regexp regions also hide their text in the terminal's title, the program status, and desktop notifications, as a • for each character, and in the recording's title. Cells, Row, and Rows regions hide cells only.
Text and Env also hide a secret that only partly shows, such as while it's typed. MinPartial(n) sets how many characters of its start or end count, 3 by default. A lower number shows less as it's typed, and hides more unrelated text.
Where it stops
Check the result
Redaction only hides what it finds in the text as the program wrote it. Watch the recording before you share it.
It won't catch:
- Text a program lays out over several rows itself, as full-screen programs do.
- A middle part of a secret, cut off on both sides.
- A secret spelled with characters that draw as nothing, such as zero-width spaces.
- The first characters of a secret being typed, until
MinPartialof them are typed. - What effects after it draw themselves, such as your own card.
Use Cells or Row to hide a place on the screen where any of that matters.
These outputs skip effects, so they aren't redacted, and they hold the secret:
.snapand.jsonare written from the replay. A.snapoutput in a profile with a redaction shows the secret..castcan't be written with a concealer. An export returns an error wrappingreel.ErrRawOutputbefore anything's written, so write it in a separate run, and keep that file private.
Typed secrets
effects.RedactInputs hides typed text from what Keys shows, as a • for each character. It changes no frames, so use it with Redact:
Effects: []reel.Effect{
effects.Redact(effects.Env("PASSWORD")),
effects.RedactInputs(effects.Env("PASSWORD")),
effects.Keys(time.Second),
},Its region has to find text: a Text, Regexp, or Env, or Any of them. It's matched against the text typed since the last key that isn't text, across input events, and backspace takes back a character. Export reads every input first, so it hides a secret's first characters too. A live Record shows them until enough are typed.
Under a keyboard mode that reports keys without their text, such as some kitty keyboard protocol modes, a shifted symbol can decode as its key and no longer match.
See _examples/reel-redact, and the CLI's --redact, --redact-env, and --redact-regexp.
Last updated on