FederatedAuthRealm.Sdk 0.4.16

Federated Auth Realm - SDK (.NET)

A lightweight .NET implementation of the Federated Auth Realm SDK.
It mirrors the TypeScript SDK feature set and provides a strongly typed, task-based API for authenticating users, refreshing sessions, and interacting with the SRWP discovery network.

Project layout

├── FederatedAuthRealm.Sdk.sln          # Solution file
└── src
    └── FederatedAuthRealm.Sdk
        ├── FederatedAuthRealmClient.cs # High-level auth client
        ├── SRWPDiscoveryClient.cs      # SRWP discovery helper
        ├── Models/                     # Shared contracts/enums
        ├── Storage/                    # Token storage abstractions
        └── Utils/JwtUtils.cs           # Minimal JWT helpers

Getting started

1. Build the library

   dotnet build
   

2. Reference the SDK

   Add a project reference to src/FederatedAuthRealm.Sdk/FederatedAuthRealm.Sdk.csproj or pack it into a NuGet package as needed.

Usage

using SavantRealms.FederatedAuthRealm.Sdk;
using SavantRealms.FederatedAuthRealm.Sdk.Models;

var client = new FederatedAuthRealmClient(new FederatedAuthRealmClientConfig
{
    BaseUrl = "https://api.federatedauthrealm.com",
    AppKey = "federated-auth-realm",
    OnSessionExpired = () => Console.WriteLine("Session expired"),
});

var response = await client.LoginAsync(new LoginRequest
{
    Email = "admin@example.com",
    Password = "Str0ngPassword!",
});

Console.WriteLine($"Authenticated as {response.User?.Email}");

Managing storage

The SDK uses an in-memory storage provider by default. You can plug in your own implementation (for example, wrapping ASP.NET Core IDistributedCache) by implementing IStorageProvider and supplying it via the FederatedAuthRealmClientConfig.

Discovery client

using SavantRealms.FederatedAuthRealm.Sdk;
using SavantRealms.FederatedAuthRealm.Sdk.Models;

var discovery = new SRWPDiscoveryClient("https://srwp.example.com");
var knownRealms = await discovery.GetKnownRealmsAsync();
await discovery.WhisperAsync(new SRWPWhisperRequest
{
    SourceRealm = "federated-auth-realm",
    SourceUrl = "https://api.federatedauthrealm.com",
    Timestamp = DateTimeOffset.UtcNow.ToUnixTimeMilliseconds(),
    KnownRealms = knownRealms,
});

Running tests

• Everything (format verification + analyzers + tests):

  ./scripts/check-all.sh
  

• Format sources in-place:

  ./scripts/format.sh
  

• Run the test suite:

  ./scripts/test.sh
  

Git hooks & workflow automation

The repository contains local git hooks under .githooks. Install them with:

./scripts/install-hooks.sh

This sets core.hooksPath and wires up:

• pre-commit → scripts/check-all.sh
• pre-push → scripts/test.sh

Publishing helper

./scripts/publish.sh mirrors the TypeScript/JavaScript SDK publish flow:

1. Restores dependencies and runs both style/analyzer formatters.
2. Executes the test suite.
3. Packs the library into ./dist/*.nupkg.
4. Optionally pushes the package to NuGet when NUGET_API_KEY (and optional NUGET_SOURCE) are provided.
   Use DRY_RUN=true to skip publishing.

Example usage:

# Build/test/pack only
./scripts/publish.sh

# Publish to nuget.org
NUGET_API_KEY=XXXXX ./scripts/publish.sh

# Publish to a custom feed
NUGET_API_KEY=XXXXX NUGET_SOURCE="https://example.com/v3/index.json" ./scripts/publish.sh