masking

Documentation

Overview

Package masking is Settings → Privacy's masking as the gateway's masker (gwmw.Masker): secrets, personal data and the user's own words go to a vendor as placeholders (internal/redact), and come back as they were. It reads the settings on each call. plugins/redact serves it.

Index

• func ModelBusy() string
• func ModelOn() bool
• func ModelWanted(st settings.Settings) bool
• func Preview(s string) (out string, hits []gwmw.Hit, off bool)
• func Wanted(st settings.Settings) bool
• func WithRoute(ctx context.Context, route string) context.Context
• type Masker
  • func (Masker) JSON(body []byte) ([]byte, int)
  • func (m Masker) JSONHits(body []byte) ([]byte, []gwmw.Hit)
  • func (Masker) JSONHitsContext(ctx context.Context, body []byte) ([]byte, []gwmw.Hit)
  • func (Masker) Restore(s string, escaped bool) string
  • func (Masker) Text(s string) (string, int)
  • func (m Masker) TextHits(s string) (string, []gwmw.Hit)
  • func (Masker) TextHitsContext(ctx context.Context, s string) (string, []gwmw.Hit)
  • func (Masker) Value(p string) (string, bool)
  • func (Masker) Writer(w http.ResponseWriter) (http.ResponseWriter, func())

Functions

func ModelBusy

func ModelBusy() string

ModelBusy says what the local model is doing that a request may wait on, for the error of one that waited too long: "" when nothing.

func ModelOn

func ModelOn() bool

ModelOn says Settings → Privacy's local model masks requests, as the user turned it on: only then is a request held back for a model that fails, and waited for it strictWait (model's strict).

func ModelWanted

func ModelWanted(st settings.Settings) bool

ModelWanted says st has masking ask the local model: the user turned it on, or left it as it is, on by default. One who had a model downloaded, or picked, with it off before it was on by default had turned it off.

func Preview

func Preview(s string) (out string, hits []gwmw.Hit, off bool)

Preview is s as the settings would send it, and what was found in it, with nothing remembered: no placeholder is kept for the replies, and none of its values is masked again later as one seen before. With masking off it is as masking would be turned on (Off says so), so the user can try it first.

func Wanted

func Wanted(st settings.Settings) bool

Wanted says settings st ask for anything to be masked.

func WithRoute

func WithRoute(ctx context.Context, route string) context.Context

WithRoute is ctx for masking a request that may go only to route (the providers its model, the model's fallbacks or a routing group's members are served by): a text sent on it before goes as it went there (redact.Options.Route).

Types

type Masker

type Masker struct{}

Masker masks as the settings say, read on each call.

func (Masker) JSON

func (Masker) JSON(body []byte) ([]byte, int)

func (Masker) JSONHits

func (m Masker) JSONHits(body []byte) ([]byte, []gwmw.Hit)

JSONHits is JSON, with what it masked (gwmw.Teller).

func (Masker) JSONHitsContext

func (Masker) JSONHitsContext(ctx context.Context, body []byte) ([]byte, []gwmw.Hit)

JSONHitsContext is JSONHits, its wait for the model ending with ctx (gwmw.ContextTeller).

func (Masker) Restore

func (Masker) Restore(s string, escaped bool) string

func (Masker) Text

func (Masker) Text(s string) (string, int)

func (Masker) TextHits

func (m Masker) TextHits(s string) (string, []gwmw.Hit)

TextHits is Text, with what it masked.

func (Masker) TextHitsContext

func (Masker) TextHitsContext(ctx context.Context, s string) (string, []gwmw.Hit)

TextHitsContext is TextHits, its wait for the model ending with ctx.

func (Masker) Value

func (Masker) Value(p string) (string, bool)

func (Masker) Writer

func (Masker) Writer(w http.ResponseWriter) (http.ResponseWriter, func())