SensitiveFlow.TestKit 1.0.0-preview.2

SensitiveFlow

<p align="center"> <img src="assets/logo.png" alt="SensitiveFlow logo" width="200" /> </p>

SensitiveFlow is a .NET library that brings observability and control to sensitive data. It focuses on runtime behavior -- automatic auditing, log redaction, and masking -- not compliance paperwork.

Important: SensitiveFlow helps reduce accidental exposure of sensitive data, but it does not guarantee legal compliance or complete data protection by itself. You are responsible for how you use these primitives in your application.

Why SensitiveFlow?

Sensitive data flows through your application on every request: EF Core saves, HTTP responses, log lines. SensitiveFlow makes that flow visible and controlled at the infrastructure level, without requiring manual instrumentation.

Packages

Quick Start

1. Install packages

dotnet add package SensitiveFlow.Core
dotnet add package SensitiveFlow.Audit
dotnet add package SensitiveFlow.Audit.EFCore
dotnet add package SensitiveFlow.EFCore
dotnet add package SensitiveFlow.AspNetCore

2. Annotate your model

using SensitiveFlow.Core.Attributes;
using SensitiveFlow.Core.Enums;

public class Customer
{
    public Guid Id { get; set; }
    public string DataSubjectId { get; set; } = string.Empty;

    [PersonalData(Category = DataCategory.Identification)]
    public string Name { get; set; } = string.Empty;

    [PersonalData(Category = DataCategory.Contact)]
    public string Email { get; set; } = string.Empty;

    [SensitiveData(Category = SensitiveDataCategory.Other)]
    [RetentionData(Years = 5, Policy = RetentionPolicy.AnonymizeOnExpiration)]
    public string TaxId { get; set; } = string.Empty;
}

3. Register a durable audit store

IAuditStore is the persistence contract -- you own the implementation so audit records go exactly where your infrastructure requires (SQL, MongoDB, Azure Table Storage, etc.).

For EF Core-backed audit storage, use SensitiveFlow.Audit.EFCore. It registers an IAuditStore that also implements IBatchAuditStore, avoiding one database roundtrip per sensitive field.

builder.Services.AddEfCoreAuditStore(options =>
    options.UseSqlServer(builder.Configuration.GetConnectionString("AuditStorage")));
builder.Services.AddAuditStoreRetry();

Do not use an in-memory store in production. Audit records must survive process restarts. Losing audit history defeats the accountability the audit trail is meant to provide.

4. Register services

builder.Services.AddEfCoreAuditStore(options =>
    options.UseSqlServer(builder.Configuration.GetConnectionString("AuditStorage")));
builder.Services.AddAuditStoreRetry();
builder.Services.AddSensitiveFlowEFCore();           // SensitiveFlow.EFCore
builder.Services.AddSensitiveFlowAspNetCore();       // SensitiveFlow.AspNetCore
builder.Services.AddSensitiveFlowLogging();          // SensitiveFlow.Logging

5. Add the middleware

// Before UseAuthentication -- makes the pseudonymized IP token available to all handlers.
app.UseSensitiveFlowAudit();

6. Wire the interceptor into your DbContext

optionsBuilder.AddInterceptors(app.Services.GetRequiredService<SensitiveDataAuditInterceptor>());

Every SaveChanges on a field annotated with [PersonalData] or [SensitiveData] now produces an AuditRecord automatically.

Documentation

• Documentation index
• Getting Started
• Package reference
• AI skill guide

Design Principles

• Runtime behavior over compliance paperwork -- instruments what actually happens, not what should happen.
• Explicit metadata over implicit heuristics -- every classification is opt-in via attributes.
• Composition over lock-in -- each module is optional and independently testable.
• Safe defaults -- the IP address is never stored raw; the log redactor strips sensitive values before they reach any sink.
• Bring your own persistence -- IAuditStore and ITokenStore are contracts, not implementations. You choose the database.

License

MIT