BccCode.Privacy.EntityFrameworkCore 0.1.0

BccCode.Privacy.EntityFrameworkCore

Purpose-bound access to personal data in EF Core and PostgreSQL. A row is returned only when a basis covers its person for the organisation and process of the request; other organisations see only the data items shared with them. Queries and saves stay ordinary EF Core; the package adds a query filter, a save guard, and read views generated by your normal migrations.

Design: docs/architecture-proposal, pages 00 and 16. Version 0.x: the API will change. Licence: Apache 2.0. Targets .NET 10 and EF Core 10, so it runs in applications on .NET 10 and 11.

Use

public sealed class AppDbContext(DbContextOptions<AppDbContext> options, PrivacyScope scope)
    : DbContext(options), IPrivacyDbContext
{
    public PrivacyScope Scope { get; } = scope;            // one per request; fixed at the first command
    public PrivacyRules Rules { get; } = new PrivacyRules()
        .Group<Membership>("members", m => m.PersonId, m => m.OrganisationId, m => m.Id, activeWhile: m => m.Ended == null)
        .Process(1, new("membership.register")).Covers<PersonProfile>().Done();

    protected override void OnModelCreating(ModelBuilder b)
    {
        b.UsePrivacy();
        b.Entity<PersonProfile>(e =>
        {
            e.Personal(this, subject: x => x.PersonId, organisation: x => x.OrganisationId);
            e.Item(Items.Name, sortable: true, x => x.FirstName, x => x.LastName);   // shareable, by item
        });
    }
}

// options: .UseNpgsql(...).UsePrivacy()

Declare item keys once (public static readonly ItemKey Name = new("name");). A special-category table adds .EnforcedInDatabase(): PostgreSQL row-level security, so even raw SQL sees only the acting organisation's rows. Such a table cannot also be shared.

Supported operations

Each behaviour below is covered by a test in BccCode.Privacy.EntityFrameworkCore.Tests.

Starts and ends of bases: tested, and planned

Develop

Needs the .NET SDK from global.json and Docker (the tests start PostgreSQL 18 through Aspire).

dotnet test --project libraries/dotnet/BccCode.Privacy.EntityFrameworkCore.Tests

The sample application and its migrations are in the test project (Sample/). After changing the sample model, add a migration from libraries/dotnet:

dotnet tool restore
dotnet ef migrations add <Name> --project BccCode.Privacy.EntityFrameworkCore.Tests --output-dir Sample/Migrations

Published by .github/workflows/libraries-dotnet-publish.yml (tag prefix efcore-dotnet-v). The version is major.minor.n, where n counts commits under libraries/dotnet since the last change of minor version. A commit under libraries/dotnet whose subject starts with feat: or feat(<scope>): (paulhatch/semantic-version's default) starts the next minor version, as does a tag efcore-dotnet-v<major>.<minor>.0. The 0.1 line was started by a feat(efcore): commit.