Feature

core/data-masking

Replaces sensitive text in the chat and completion traffic an AI gateway routes with a placeholder before it travels past the gateway: in requests before they reach the model provider, in replies before they reach the caller, or both, as scope says. It attaches to a gateway declaring dataplane.aggrega.ai/content-masking and masks what the attachment lists, regular expressions under patterns and, under entities, entity types a recognizer service detects, in the text of the conversation's messages; which roles, turns and fields count as that text each realization states. An attachment listing nothing to mask halts the build: no list is assumed. action redact replaces a match for good; restore puts the original back in the reply, where a realization can do so reliably; refuse lets no text carrying a match travel on. An unreachable or erring recognizer fails the request. By default, text a realization does not mask is refused rather than forwarded, and what a masked reply carries unread is withheld; allow_unmasked_text and allow_unmasked_reply_parts relax that. It shares no component with core/semantic-caching nor a gateway with values.log_masking. Its values refuse display_name, description, severity and as. Realized on core/gateway/litellm, kong-enterprise, agentgateway, higress and traefik-hub, each refusing restore. Masking alone falls short: text no pattern matches and no recognizer detects passes; the gateway and its recognizers see the original; tool definitions, response formats, stop sequences, reasoning a client sends back and the names of JSON keys pass as sent; the gateway's log and a logging integration can hold unmasked text; and traffic not crossing the gateway is untouched.

Provenance

OfficialSigned by a signing identity this catalog recognizes as an official publisher.
Content digest
sha256:93cf650169630e3e2706d730475e4e2155b7244ff643799dfddbd7a70176e7ef
Published
2026-11-10T10:17:05Z
Signing identity
https://token.actions.githubusercontent.com/https://github.com/aggrega-ai/aggrega-hub/.github/workflows/catalog-publish-sign.yml@refs/heads/main

Signature

  • Officialapplication/vnd.dev.sigstore.bundle.v0.3+json

    https://token.actions.githubusercontent.com/https://github.com/aggrega-ai/aggrega-hub/.github/workflows/catalog-publish-sign.yml@refs/heads/main

    sha256:b105e5245acff4f7124fec8c368301fbf267e4f0eb67f8be2dd3dea7551426d0

Reference at this version

oci://hub.aggrega.ai/feature/core/data-masking:1.0.0
Applies to
dataplane.aggrega.ai/content-masking
Conflicts with
core/semantic-caching

Developer parameters

Values the developer sets when attaching this feature.

Extends TextMaskingSchemas#/schemas/MaskedTextParameter

NameTypeDefaultRequiredDescription
actionstring (redact | restore | refuse)redactyesWhat becomes of text in which a listed pattern matches or a listed entity is detected. redact replaces each match for good. restore replaces it with a numbered stand-in the gateway maps back to the original in its reply to the caller; the mapping lives only for that request, only entity types a recognizer detected can be restored, and a restored reply reaches the caller unmasked. A realization whose gateway cannot map every stand-in back to its own original refuses restore at build time; the one for core/gateway/litellm does. refuse lets the text not travel on: a request carrying it is refused before it is forwarded and, where scope reaches replies, a reply carrying it is not delivered and the caller receives an error. A realization that cannot refuse on a scope refuses that pairing by name at build time.
scopestring (request | response | both)requestnoWhere masking applies. request masks a request before it reaches the model provider; response masks the reply before it reaches the caller, after the provider has already received the request unmasked; both does the two. Entities are found over the whole reply, so while entities are masked in replies a request asking for a streamed reply is refused unless infra.allow_streamed_replies is set.
placeholder_shows_namebooleantruenoWhether the placeholder replacing a pattern's match must show the pattern's name. On, the default, it does, so a reader of the masked text can tell what kind of value was there. Off, the attachment accepts a placeholder that does not, a numbered one say, and a realization whose gateway cannot show the name honours the attachment rather than refusing it. A realization whose placeholder always shows the name honours either.

Output contract

Values this feature publishes to consumers.

No output values declared.

Annotations

No annotations declared.

Relationships

Typed edges to and from other published entities. A reference with no published target renders as a broken edge rather than a link.

Uses

Used by

Feature concept reference →

The Aggrega catalog — an open index of components, features, recipes, and the plugins that render them.

Built with the shared Aggrega design system.

Privacy