ITraxAuditRedactor
Package Trax.Api.GraphQL.AuditNamespace Trax.Api.GraphQL.AuditSource ITraxAuditRedactor.cs
NO WARRANTY. Trax auth is plumbing, not a security product. You are solely responsible for securing systems that use it. See API Security.
Decides which GraphQL variables, if any, an audit entry records. AddAudit registers DefaultAuditRedactor, which records none, unless the host has registered its own.
Signature
public interface ITraxAuditRedactor
{
JsonObject? Redact(JsonObject? variables);
}
public sealed class DefaultAuditRedactor : ITraxAuditRedactor
{
public JsonObject? Redact(JsonObject? variables);
}Parameters
| Parameter | Type | Description |
|---|---|---|
variables | System.Text.Json.Nodes.JsonObject? | The request's variables, as an object built for this call, or null when the request had none. An input object is a nested JsonObject and a list a JsonArray. |
Returns
The variables to record in TraxAuditEntry.Variables, or null to record none. The redactor may change variables in place and return it, or return a different object. DefaultAuditRedactor returns null.
Behavior
- Called by the listener once for each request it records, and not for one that
SkipIntrospectionorSkipSubscriptionsdrops. The entries for a socket refused atconnection_initand for a failed subscription event carry no variables and do not call it. - When the redactor throws, the entry is recorded without variables.
- Literal values written in the document never reach the redactor or the entry: the listener replaces every string with
""and every number with0, directive arguments included, before it records the document. - Error messages are not recorded unless
TraxAuditOptions.RecordErrorMessagesis set, and the redactor never sees them. AddAuditregistersDefaultAuditRedactorwithTryAdd, so a redactor registered before or afterAddAuditwithservices.AddSingleton<ITraxAuditRedactor, T>()replaces it.
Example
Keep the variables, minus a set of sensitive fields at any depth:
services.AddSingleton<ITraxAuditRedactor, SensitiveFieldRedactor>();
public sealed class SensitiveFieldRedactor : ITraxAuditRedactor
{
private static readonly HashSet<string> Sensitive = new(StringComparer.OrdinalIgnoreCase)
{
"password", "token", "apiKey", "secret", "ssn",
};
public JsonObject? Redact(JsonObject? variables)
{
Strip(variables);
return variables;
}
private static void Strip(JsonNode? node)
{
switch (node)
{
case JsonObject obj:
foreach (var key in obj.Select(p => p.Key).Where(Sensitive.Contains).ToList())
obj.Remove(key);
foreach (var (_, child) in obj)
Strip(child);
break;
case JsonArray array:
foreach (var child in array)
Strip(child);
break;
}
}
}A removal list keeps any field it does not name. An allow-list, copying across only the fields to record, does not.