Data masking

Configure the current server-side masking settings and verify the result with a sample payload.

How it works

EventOre’s masking service redacts recognized sensitive fields and value patterns. Default sensitive field names include password, token, authorization, cardNumber, and ssn. The default replacement is [REDACTED]. This changes the displayed or returned representation; it does not rewrite messages stored in a broker.

Supported Spring configuration

The current server binds these properties under eventore.masking:

eventore:
  masking:
    enabled: true
    replacement: "[REDACTED]"
    custom-fields:
      - customerSecret
      - internalToken
    mask-values: true

custom-fields adds sensitive field-name patterns to the defaults. mask-values controls value-pattern detection. Configure this in Spring application configuration; the bundled Helm chart does not expose these masking fields as values. The current binding does not accept a rules list with strategy or default-strategy.

Verify an example

Use the sample preview request from the repository root. In PowerShell, use curl.exe. Add your Bearer header if API authentication is enabled.

curl http://localhost:8080/api/v1/masking/config
curl -X POST http://localhost:8080/api/v1/masking/preview -H "Content-Type: application/json" --data-binary "@docs/examples/masking-preview.json"

With default masking enabled, the returned masked string should contain:

{"orderId":"demo-1001","password":"[REDACTED]"}

The preview response includes original, masked, and wasMasked. Use synthetic data when testing because the endpoint echoes the original input.

Limits and access behavior

The masking service supports an explicit unmasked override on some call paths. Static API-token authentication is not a per-user permission system. Do not treat this feature as a guarantee that every client or endpoint can only access redacted data. Verify the specific streaming or inspection path you use, and apply broker permissions and API access controls separately.

Next: configuration reference · live streaming · local lab.