Stratara.EventSourcing.Pipeline.CommandAudit 3.2.2

There is a newer version of this package available.
See the version list below for details.
dotnet add package Stratara.EventSourcing.Pipeline.CommandAudit --version 3.2.2
                    
NuGet\Install-Package Stratara.EventSourcing.Pipeline.CommandAudit -Version 3.2.2
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Stratara.EventSourcing.Pipeline.CommandAudit" Version="3.2.2" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Stratara.EventSourcing.Pipeline.CommandAudit" Version="3.2.2" />
                    
Directory.Packages.props
<PackageReference Include="Stratara.EventSourcing.Pipeline.CommandAudit" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Stratara.EventSourcing.Pipeline.CommandAudit --version 3.2.2
                    
#r "nuget: Stratara.EventSourcing.Pipeline.CommandAudit, 3.2.2"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package Stratara.EventSourcing.Pipeline.CommandAudit@3.2.2
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=Stratara.EventSourcing.Pipeline.CommandAudit&version=3.2.2
                    
Install as a Cake Addin
#tool nuget:?package=Stratara.EventSourcing.Pipeline.CommandAudit&version=3.2.2
                    
Install as a Cake Tool

Stratara.EventSourcing.Pipeline.CommandAudit

License: MIT.

Mediator pipeline behavior that records an audit row for every dispatched command in the Stratara event-sourced stack. Both arities are provided so consumers can register a single behavior pair and have it apply to all command shapes.

What's in the box

Type Purpose
AddCommandAuditing() The package's public surface — registers both behavior arities in one call.
CommandAuditBehavior<TRequest> (internal) Runs the audit-write step before delegating to next() for IRequest (commands without result).
CommandAuditBehavior<TRequest, TResult> (internal) Same, for IRequest<TResult> (commands with result + queries). Only records when the request also implements ICommandBase — queries flow through untouched.
CommandAuditWriter (internal) Opens a transaction on IWriteUnitOfWork, writes via ICommandAuditRepository.AddAsync, commits.

The behavior only audits commands — query requests reach the same generic interface but are filtered by the is ICommandBase check, so registering both behaviors application-wide is safe.

Quick start

// At composition time, alongside the other framework pipeline behaviors:
builder.Services.AddCommandAuditing();

That one call registers both behavior arities. The behavior types themselves are internal — they are an implementation detail, not something to name from your composition root.

The behaviors resolve IWriteUnitOfWork from DI (ships with Stratara.EventSourcing.EntityFrameworkCore in the default deployment). No additional registration is needed.

Dependencies

  • Stratara.Abstractions — for IPipelineBehavior<,>, IRequest/IRequest<T>, ICommandBase, IWriteUnitOfWork, ICommandAuditRepository.
  • JetBrains.Annotations[UsedImplicitly] on the public behavior classes (DI-instantiated, no static call site).

At runtime an IWriteUnitOfWork implementation must be registered — typically by referencing Stratara.EventSourcing.EntityFrameworkCore and calling AddWriteStore(IConfiguration).

Security note — command payload contents

The audit row stores CommandTypeName and the serialized CommandJson of the dispatched command. Whatever fields your commands carry land in the audit table. Sensitive data (passwords, tokens, API keys, encryption material) MUST NOT live on a command record — or must be marked with [EncryptData] so the registered ISecureJsonSerializer encrypts them before persistence.

The default Stratara registration uses ISecureJsonSerializer (AES-GCM + tenant-scoped AAD) for the audit serialization, so [EncryptData]-annotated properties are protected. Plain-text properties go to disk unencrypted — treat the audit table accordingly when designing command shapes.

Product Compatible and additional computed target framework versions.
.NET net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
4.0.0-preview.1 0 8/31/2026
3.4.0 69 8/28/2026
3.3.0 82 8/25/2026
3.2.3 82 8/22/2026
3.2.2 100 8/14/2026
3.2.1 100 8/2/2026
3.2.0 119 7/18/2026
3.1.7 112 7/1/2026
3.1.6 526 6/22/2026
3.1.5 123 6/22/2026
3.1.4 127 6/15/2026
3.1.3 121 6/10/2026
3.1.2 128 6/5/2026
3.1.1 208 6/1/2026
3.1.0 118 5/30/2026
3.0.23 112 5/28/2026

API keys can now be bootstrapped. Issuance always generated the key itself, which does not fit the
setups where server and caller have to share a key *before* either starts — container orchestration,
CI provisioning, self-hosted bundles, end-to-end test hosts. This release adds an import path for a
key the caller already holds, plus the canonical key format as public API so callers generate values
instead of inventing them.

### Added

- **`IApiKeyStore.ImportAsync` — store a machine key whose raw value the caller already holds.**
 Issuance generates the key itself, which is the wrong shape when server and caller must share it
 *before* either boots: container orchestration, CI provisioning, self-hosted bundles, end-to-end
 test hosts. Without this path, consumers bypassed the store and reimplemented its internals (the
 digest format and the machine-key membership row) — a copy that keeps compiling after the store
 changes and fails as a runtime 401. Import is idempotent, so it can run unconditionally on every
 boot: a value that is already stored returns the existing descriptor and the stored key is never
 mutated, so a changed configuration cannot escalate a key's roles or extend its expiry unnoticed.
 Revoked, expired, and foreign-tenant values are rejected rather than silently adopted, and
 concurrent replicas racing the same first import converge on one key. Machine keys only —
 `ApiKeyImportRequest` carries no `UserId`.
- **`ApiKeyFormat` (`Stratara.Abstractions.ApiKeys`) — the canonical raw-key format as public API.**
 `CreateRawKey()` generates `stk_` plus the Base64Url encoding of 32 CSPRNG bytes; `IsWellFormed()`
 checks that shape. `ImportAsync` accepts only well-formed values: the store keeps its stored
 digest unsalted because a generated key carries 256 bits of entropy, and a hand-picked value would
 quietly invalidate that. Generate keys out of band with `CreateRawKey()` and keep them in a secret
 store — the type lives in the abstractions package so host-builder and orchestration projects can
 reach it without referencing the storage implementation.
- **`InMemoryApiKeyStore` (`Stratara.Testing`) — the drop-in double for the API-key store**,
 mirroring issuance, import, fail-closed validation, revocation, and the erasure sweeps, and
 materializing machine keys into a membership store you can share and inspect.

### Changed

- **API-key lifecycle events are now logged** (`Stratara.Diagnostics` event-ID range 116_000):
 import, idempotent repeat, and a repeat that supplied different parameters. Key ids and tenant
 ids only — never the raw key or its digest.
- **For implementers of `IApiKeyStore`:** the interface gained `ImportAsync`. Custom implementations
 need the new member; callers are unaffected.