Auditify 0.1.0

Auditify

A lightweight, pluggable audit-trail library for Entity Framework Core 8+. Une bibliothèque légère et plug-and-play de traçabilité pour Entity Framework Core 8+.

🇬🇧 English

Overview

Auditify automatically captures entity changes (Added/Modified/Deleted) in your EF Core DbContext and persists them as structured audit logs. It supports sensitive data masking, soft-delete patterns, and automatic timestamp tracking — all configurable through a simple options API.

Features

• ✅ Automatic audit logging — Captures entity changes via EF Core SaveChangesInterceptor
• ✅ Sensitive data masking — Hides Password, Token, Secret, ApiKey values
• ✅ Soft delete support — Implements ISoftDelete interface
• ✅ Timestamp tracking — Implements IAuditableEntity (Created/Updated)
• ✅ Two integration modes — Interceptor (automatic) or UnitOfWork (explicit)
• ✅ Configurable — AuditifyOptions for fine-grained control
• ✅ DI ready — Simple AddAuditify() registration
• ✅ .NET 8 — Built for the latest .NET

Quick Start

1. Install

dotnet add package Auditify

2. Register services

// Minimal setup
services.AddAuditify();

Or with a custom DbContext:

services.AddAuditifyWithDbContext<YourDbContext>(options =>
{
    options.UseSqlServer(connectionString);
});

3. Configure the interceptor

builder.Services.AddDbContext<YourDbContext>(options =>
{
    options.UseSqlServer(connectionString)
           .AddInterceptors(
               services.BuildServiceProvider()
                       .GetRequiredService<PersistingAuditInterceptor>());
});

4. Customize options

services.AddAuditify(options =>
{
    options.SensitiveProperties = ["Password", "Token", "Secret", "ApiKey"];
    options.TrackIpAddress = true;
    options.TrackCorrelationId = true;
    options.AuditLogsTableName = "MyAuditLogs";
});

5. Use the UnitOfWork (optional)

public class YourService
{
    private readonly IUnitOfWork _uow;

    public YourService(IUnitOfWork uow) => _uow = uow;

    public async Task SaveAsync()
    {
        // Handles audit, soft delete, and timestamps automatically
        await _uow.AutomaticSavingAsync();
    }
}

Architecture

┌────────────────────────────────────────────┐
│             Your Application                │
├────────────────────────────────────────────┤
│  Auditify                                   │
│  ├── Core Layer (AuditService, Builder, …) │
│  ├── EF Core Integration (Interceptor, …)  │
│  ├── Configuration (AuditifyOptions)       │
│  └── DI Registration (AddAuditify)         │
└────────────────────────────────────────────┘

Namespaces

🇫🇷 Français

Vue d'ensemble

Auditify capture automatiquement les modifications d'entités (Ajoutées/Modifiées/Supprimées) dans votre DbContext EF Core et les persist sous forme de logs d'audit structurés. Elle prend en charge le masquage des données sensibles, le soft delete, et la gestion automatique des horodatages — le tout configurable via une API d'options simple.

Fonctionnalités

• ✅ Journalisation automatique — Capture les modifications via l'intercepteur EF Core
• ✅ Masquage des données sensibles — Cache les mots de passe, jetons, secrets
• ✅ Soft delete — Implémente l'interface ISoftDelete
• ✅ Horodatage — Implémente IAuditableEntity (Created/Updated)
• ✅ Deux modes d'intégration — Intercepteur (automatique) ou UnitOfWork (explicite)
• ✅ Configurable — AuditifyOptions pour un contrôle fin
• ✅ Prêt pour l'injection de dépendances — Simple appel AddAuditify()
• ✅ .NET 8 — Construit pour la dernière version de .NET

Démarrage rapide

1. Installation

dotnet add package Auditify

2. Enregistrement des services

// Configuration minimale
services.AddAuditify();

Ou avec un DbContext personnalisé :

services.AddAuditifyWithDbContext<VotreDbContext>(options =>
{
    options.UseSqlServer(connectionString);
});

3. Configuration de l'intercepteur

builder.Services.AddDbContext<VotreDbContext>(options =>
{
    options.UseSqlServer(connectionString)
           .AddInterceptors(
               services.BuildServiceProvider()
                       .GetRequiredService<PersistingAuditInterceptor>());
});

4. Personnalisation des options

services.AddAuditify(options =>
{
    options.SensitiveProperties = ["Password", "Token", "Secret", "ApiKey"];
    options.TrackIpAddress = true;
    options.TrackCorrelationId = true;
    options.AuditLogsTableName = "MesLogsAudit";
});

5. Utilisation du UnitOfWork (optionnel)

public class VotreService
{
    private readonly IUnitOfWork _uow;

    public VotreService(IUnitOfWork uow) => _uow = uow;

    public async Task SauvegarderAsync()
    {
        // Gère l'audit, le soft delete et les horodatages automatiquement
        await _uow.AutomaticSavingAsync();
    }
}

Licence

MIT — Copyright (c) 2026, NID BOUBKER Houssine

Built with ❤️ for the .NET ecosystem.