EasyReasy.Auth.Client 2.0.0

EasyReasy.Auth.Client

← Back to EasyReasy System

A lightweight .NET client library for authenticating with EasyReasy.Auth servers, designed for simplicity and automatic token management.

Overview

EasyReasy.Auth.Client provides a simple HTTP client wrapper that automatically handles authentication with EasyReasy.Auth servers. It supports both API key and username/password authentication, with automatic token refresh and retry logic.

Why Use EasyReasy.Auth.Client?

• Automatic authentication: Handles JWT token acquisition and renewal transparently
• Multiple auth methods: Support for API key and username/password authentication
• Token management: Automatic token refresh before expiration (5-minute buffer)
• Retry logic: Automatically retries requests on 401 Unauthorized with fresh tokens
• Simple API: Drop-in replacement for HttpClient with minimal code changes
• Flexible configuration: Customizable auth endpoints and HTTP client settings

Quick Start

1. Add to your project

Install via NuGet:

dotnet add package EasyReasy.Auth.Client

2. Create an authorized client

Credentials must carry something. Both credential constructors reject a null credential with ArgumentNullException and an empty one with ArgumentException: an empty credential carries nothing to authenticate with, so it is refused rather than sent. A whitespace-only credential is a value you supplied and is sent as given — the client does not decide what the server will accept.

API Key Authentication

using (HttpClient httpClient = AuthorizedHttpClient.CreateHttpClient("https://api.example.com/"))
{
    AuthorizedHttpClient authorizedClient = new AuthorizedHttpClient(httpClient, "your-api-key-here");

    // The client will automatically authenticate on first use
    HttpResponseMessage response = await authorizedClient.GetAsync("api/data");
}

Username/Password Authentication

using (HttpClient httpClient = AuthorizedHttpClient.CreateHttpClient("https://api.example.com/"))
{
    AuthorizedHttpClient authorizedClient = new AuthorizedHttpClient(
        httpClient, 
        username: "your-username", 
        password: "your-password");

    // The client will automatically authenticate on first use
    HttpResponseMessage response = await authorizedClient.GetAsync("api/data");
}

3. Use the client like a regular HttpClient

using (HttpClient httpClient = AuthorizedHttpClient.CreateHttpClient("https://api.example.com/"))
{
    AuthorizedHttpClient authorizedClient = new AuthorizedHttpClient(httpClient, "your-api-key");

    // GET requests
    HttpResponseMessage response = await authorizedClient.GetAsync("api/users");

    // POST requests
    StringContent content = new StringContent("{\"name\":\"John\"}", Encoding.UTF8, "application/json");
    HttpResponseMessage response = await authorizedClient.PostAsync("api/users", content);

    // Custom requests
    HttpRequestMessage request = new HttpRequestMessage(HttpMethod.Put, "api/users/123");
    request.Content = new StringContent("{\"name\":\"Jane\"}", Encoding.UTF8, "application/json");
    HttpResponseMessage response = await authorizedClient.SendAsync(request);
}

Advanced Usage

Custom Auth Endpoints

By default, the client uses the standard EasyReasy.Auth endpoints, as paths relative to the client's base address:

• API Key: api/auth/apikey
• Username/Password: api/auth/login

Keep your own endpoints relative too. A leading slash makes the path absolute against the host, discarding any path prefix in the base address — https://api.example.com/myapp plus /api/auth/login resolves to https://api.example.com/api/auth/login.

You can customize these endpoints:

using (HttpClient httpClient = AuthorizedHttpClient.CreateHttpClient("https://api.example.com/"))
{
    // Custom API key endpoint
    AuthorizedHttpClient apiKeyClient = new AuthorizedHttpClient(
        httpClient, 
        "your-api-key", 
        authEndpoint: "custom/auth/apikey");

    // Custom login endpoint
    AuthorizedHttpClient loginClient = new AuthorizedHttpClient(
        httpClient, 
        "username", 
        "password", 
        authEndpoint: "custom/auth/login");
}

Manual Authentication Control

You can manually control when authentication happens:

using (HttpClient httpClient = AuthorizedHttpClient.CreateHttpClient("https://api.example.com/"))
{
    AuthorizedHttpClient client = new AuthorizedHttpClient(httpClient, "api-key");

    // Force authentication now
    await client.EnsureAuthorizedAsync();

    // Check authentication type
    if (client.AuthenticationType == AuthorizedHttpClient.AuthType.ApiKey)
    {
        Console.WriteLine("Using API key authentication");
    }
}

Handling Authorization Issues

Sometimes the server may reject a token even when the client thinks it's still valid. The client provides methods to handle these scenarios:

using (HttpClient httpClient = AuthorizedHttpClient.CreateHttpClient("https://api.example.com/"))
{
    AuthorizedHttpClient client = new AuthorizedHttpClient(httpClient, "api-key");

    // GetAsync already renews the token and retries once when the API answers 401.
    HttpResponseMessage response = await client.GetAsync("api/data");

    if (response.StatusCode == HttpStatusCode.Unauthorized)
    {
        // Still rejected: clear all state, sign in afresh, and try once more.
        await client.ForceReauthorizeAsync();
        response = await client.GetAsync("api/data");
    }
}

Force Authorization Methods

• ForceAuthorizeAsync(): Bypasses the token-expiry check and authenticates again. Useful when the server rejects a token that the client thinks is still valid. If another authorization finished while this call waited for it, the call takes that outcome instead of making its own: it returns after a success, whose token is newer than the rejected one, and throws that attempt's exception after a failure.

• ForceReauthorizeAsync(): Clears all current authorization state and performs a completely fresh authentication, even when another authorization finished while it waited. This ensures no residual state interferes with the new authentication.

On a client constructed from an AuthResponse, ForceAuthorizeAsync() redeems the refresh token first, so it renews the session when the server accepts it. ForceReauthorizeAsync() clears the refresh token before authorizing, and such a client has no credentials to fall back on, so it always throws SessionNotRenewableException and spends a session that may still have been good. Use ForceAuthorizeAsync() there.

// Force fresh authentication without clearing state
await client.ForceAuthorizeAsync();

// Clear all state and perform fresh authentication
await client.ForceReauthorizeAsync();

When the Address Is Not an Auth Server

A base address that points at something other than an auth server does not fail as a connection error. A host that answers the auth path with a redirect to its own sign-in page returns 200 carrying HTML — a success by every check the client can make — so the body reaches the parser and fails there. So does a body that parses but is not an auth response: no token, or an expiresAt that is not a date and time.

That case throws InvalidAuthResponseException, carrying what separates it from a genuinely corrupt response from the right server:

The failure the parse reported is kept as the inner exception: an ArgumentException from AuthResponse.FromJson, which itself carries the JsonException when the body failed to parse at all. A body that parses but is not an auth response has no JsonException under it — what was wrong with it is in the ArgumentException's message.

The body is read under a cap of 64 K characters. An auth response is a token, an expiry and a refresh token, so nothing near that size is one; a longer body is read only that far and reported as the body that is not an auth response. The same cap and the same redaction apply to the body of an unsuccessful answer, which reaches the message of the SignInRefusedException or HttpRequestException reporting it.

Redaction reads the text rather than a parsed document, which is what lets it blank a token in a body no parser will accept — one cut off mid-value, or JSON embedded in a page. The cost is an outer bound on what it can recognise: an unquoted HTML attribute value, and a value whose name is out of reach behind an unescaped quote earlier in a malformed body, are not blanked. Treat the snippet as a diagnosis, not as something safe to forward anywhere a full body would not be.

try
{
    await client.EnsureAuthorizedAsync();
}
catch (InvalidAuthResponseException exception)
{
    // A consumer can say the thing the library cannot know:
    if (exception.RequestUri?.Host == "example.com")
        Console.WriteLine("That domain serves the public site. The API is at https://app.example.com/.");
    else
        Console.WriteLine(exception.Message);
}

The same exception covers the refresh endpoint. An unsuccessful status there is judged by the same rule as sign-in (see Refused or failed). A refusal makes the client fall back — to full re-authentication when it holds credentials, and to a SessionNotRenewableException when it was constructed pre-authorized and so has none. Any other unsuccessful status keeps the refresh token: a client with credentials still signs in, and a client without throws HttpRequestException with that status; see Persisting Auth State with Callbacks. A success carrying something that is not an auth response is neither: that is the endpoint not being one, which re-authenticating against the same address would only repeat, so it throws here instead of falling back.

Persisting Auth State with Callbacks

All constructors accept an optional onAuthResponseChanged callback that fires whenever the auth state changes — on initial authentication, token refresh, or re-auth. This is useful for CLI tools and long-running processes that want to persist the token to disk:

using (HttpClient httpClient = AuthorizedHttpClient.CreateHttpClient("https://api.example.com/"))
{
    // First launch: authenticate with API key and persist the token
    AuthorizedHttpClient client = new AuthorizedHttpClient(
        httpClient,
        "your-api-key",
        onAuthResponseChanged: authResponse =>
        {
            File.WriteAllText("auth-state.json", authResponse.ToJson());
        });

    await client.GetAsync("api/data");
}

// Subsequent launches: reuse the persisted token
string savedJson = File.ReadAllText("auth-state.json");
AuthResponse savedAuth = AuthResponse.FromJson(savedJson);

using (HttpClient httpClient = AuthorizedHttpClient.CreateHttpClient("https://api.example.com/"))
{
    AuthorizedHttpClient client = new AuthorizedHttpClient(
        httpClient,
        savedAuth,
        onAuthResponseChanged: authResponse =>
        {
            // Keeps the persisted state up to date on transparent token refreshes
            File.WriteAllText("auth-state.json", authResponse.ToJson());
        });

    await client.GetAsync("api/data");
}

AuthResponse.FromJson throws ArgumentException for JSON it cannot read as an auth response: not JSON at all, the literal null, a token or expiresAt that is missing or written out as null, or an expiresAt that is not an ISO 8601 date and time. A file truncated or overwritten by something else reads every one of those ways. Handle it where the persisted state is loaded, and fall back to authenticating from credentials.

Reading the expiry is part of that check, so an instance that came from FromJson always has one: use AuthResponse.ExpirationTime for the expiry as a DateTime rather than parsing ExpiresAt again. It is always UTC, whatever offset the wire value carried — ExpiresAt parsed with a general date parser comes back as a local time for an offset-bearing value, and comparing that against a UTC clock is hours wrong on a machine that is not on UTC. Building an AuthResponse in code skips the check: ExpirationTime throws FormatException for a value that is not an ISO 8601 date and time, and the pre-authorized constructor throws it where it reads one, before it has touched the HttpClient you passed in.

What counts as readable is a full calendar date, then T or a space, then the time, with or without an offset — what a server writes with the round-trip ("O") format. A bare time of day and a date in a local convention are refused rather than read as some point in time that means nothing.

A client constructed from an AuthResponse holds no credentials. It works for as long as its token is valid and its refresh token is accepted; once the token has expired with no refresh token left to redeem, or with one the server refused, there is nothing to re-authenticate with and the next request throws SessionNotRenewableException. That is the point at which a new client has to be constructed from credentials — it is not a failure the client can retry past. When the server refused the refresh token, its answer is carried as an HttpRequestException in InnerException, with StatusCode set; when the client had no refresh token, InnerException is null. A 404 there points at a misconfigured refreshEndpoint rather than a spent session.

A refresh the server failed rather than refused (see Refused or failed) does not spend the session. The client keeps the refresh token and throws HttpRequestException with StatusCode set to the answer, and the next call tries the same refresh token again. A refresh that never reached the server keeps it too, and surfaces as the HttpRequestException from HttpClient, with StatusCode null.

try
{
    await client.GetAsync("api/data");
}
catch (SessionNotRenewableException)
{
    // The saved session is spent: delete auth-state.json and sign in again from credentials.
}
catch (HttpRequestException exception) when (exception.StatusCode is not null)
{
    // The server answered but could not renew now. The session is intact; retry later.
}

Token Expiration

The client automatically handles token expiration:

1. Detects when token expires within 5 minutes
2. Automatically re-authenticates before making requests
3. Retries failed requests once with a fresh token

Requests that find the token expired at the same time share one authorization attempt. If it fails, every request that was waiting for it and still needs a token throws that attempt's exception instead of sending the sign-in or refresh again, so a burst of requests behind a 429 or 5xx does not send one more auth request each. A request that starts after the failed attempt finished tries again. Requests retrying after a 401 share the attempt's outcome either way: one renewal serves them all. An attempt cancelled through its own caller's CancellationToken is not shared; the next waiting request makes its own.

Logging Out

LogoutAsync() posts the current refresh token to the server's logout endpoint (default /api/auth/logout) and then clears all local auth state. The server call is best-effort — HTTP failures do not prevent local state from being cleared, so the client always ends up in an unauthenticated state after the call.

using HttpClient httpClient = AuthorizedHttpClient.CreateHttpClient("https://api.example.com/");
using AuthorizedHttpClient client = new AuthorizedHttpClient(
    httpClient, username: "user", password: "pass");

await client.GetAsync("api/data");

// Later — revoke the refresh token family and clear local state.
await client.LogoutAsync();

// Subsequent requests will trigger a fresh authentication flow
// (only possible when the client has credentials — API key or username/password.
// A pre-authorized client cannot re-authenticate after logout: its next request
// throws SessionNotRenewableException.)

You can override the logout endpoint path via the logoutEndpoint constructor parameter if your server mounts it elsewhere.

Best Practices

1. HttpClient Lifecycle Management

The AuthorizedHttpClient doesn't dispose the underlying HttpClient. Manage the HttpClient lifecycle according to your application's needs:

// For long-lived applications
HttpClient httpClient = AuthorizedHttpClient.CreateHttpClient("https://api.example.com/");

// Reuse the same AuthorizedHttpClient instance
AuthorizedHttpClient authorizedClient = new AuthorizedHttpClient(httpClient, "api-key");

// Use throughout your application
// Don't dispose the AuthorizedHttpClient unless you're done with the HttpClient

2. Error Handling

Always handle authentication and network errors:

using (HttpClient httpClient = AuthorizedHttpClient.CreateHttpClient("https://api.example.com/"))
{
    AuthorizedHttpClient authorizedClient = new AuthorizedHttpClient(httpClient, "api-key");
    
    try
    {
        HttpResponseMessage response = await authorizedClient.GetAsync("api/data");

        // Checked here rather than with EnsureSuccessStatusCode(), which would throw an HttpRequestException
        // with StatusCode set and land your own API's failure in the auth-server branch below.
        if (!response.IsSuccessStatusCode)
        {
            Console.WriteLine($"api/data failed: {(int)response.StatusCode}");
            return;
        }

        string content = await response.Content.ReadAsStringAsync();
        // Process response
    }
    catch (SignInRefusedException exception)
    {
        // The sign-in endpoint refused the credentials (see "Refused or failed" below).
        // Sending them again will be refused again; fix the credentials.
        Console.WriteLine($"Sign-in refused: {(int)exception.StatusCode}");
    }
    catch (InvalidAuthResponseException exception)
    {
        // The address answered, successfully, with something that is not an auth response — so it is
        // most likely not an auth server. Say the host-specific thing here: the library knows the
        // address answered wrongly, and you know which addresses are supposed to be yours.
        Console.WriteLine($"{exception.RequestUri} is not the API. Check the configured server address.");
    }
    catch (HttpRequestException exception) when (exception.StatusCode is not null)
    {
        // The auth server failed rather than refused (see "Refused or failed" below). Retrying later may succeed.
        Console.WriteLine($"Auth server unavailable: {(int)exception.StatusCode}");
    }
    catch (HttpRequestException)
    {
        // A transport failure, such as a refused connection or a DNS failure: StatusCode is null.
    }
}

Refused or failed

An unsuccessful answer from the sign-in or refresh endpoint is either a refusal or a failure, by one rule for both endpoints:

• Refused: any 4xx other than 408 and 429, 401 included. The server judged the request; sending it again gets the same answer. Sign-in throws SignInRefusedException; a refused refresh clears the refresh token.
• Failed: every other unsuccessful status — 408, 429, 5xx, and a 3xx the handler did not follow. The server judged nothing, and retrying later may succeed. It throws HttpRequestException with StatusCode set, and a refresh answered this way keeps the refresh token.

SignInRefusedException, SessionNotRenewableException and InvalidAuthResponseException all derive from AuthClientException: outcomes that retrying the same request will not change — credentials refused, a session spent, or an address that is not an auth server. One catch (AuthClientException) handles them all. What is left is HttpRequestException, which retrying may fix. Every unsuccessful status this client throws as one carries StatusCode, and a transport failure from HttpClient leaves it null. So around the client's own calls, exception.StatusCode is not null separates "the server answered with a failure" from "the request did not complete". HttpRequestError cannot make that split, since both can read Unknown.

Note that construction itself throws when a credential carries nothing — ArgumentNullException for null, ArgumentException for an empty string. If your credentials come from configuration that may be unset, validate them before constructing the client, or the throw lands on the constructor line rather than inside the try above.

Migration

From 1.8.0

2.0.0 is a breaking release. Every authorization outcome that retrying the same request will not change is now an AuthClientException (see Refused or failed), and nothing the client throws derives from InvalidOperationException or UnauthorizedAccessException any more. Each exception message is rewritten, so if you match on message text, match on type and StatusCode instead.

So:

• Replace catch (UnauthorizedAccessException) around the client with catch (SignInRefusedException), and read StatusCode for which refusal it was.
• Replace catch (InvalidOperationException) for a spent session with catch (SessionNotRenewableException). A catch (InvalidOperationException) no longer catches it.
• A catch (HttpRequestException) that handled refused sign-ins no longer sees refusals; catch SignInRefusedException for those.
• Or catch AuthClientException once for every outcome that retrying will not change.

A client with credentials whose refresh fails rather than is refused keeps its refresh token and falls back to signing in, as any unsuccessful refresh did before. SessionNotRenewableException and SignInRefusedException have public constructors, so a fake in your own tests can throw one.

The waiting-call row is described in Token Expiration: a call that waited through a failed attempt can now see a failure its own retry would not have hit, and a call that starts after the attempt finished tries again. ForceAuthorizeAsync(), which the send methods call after a 401, also returns without a new attempt when another call's attempt succeeded while it waited; ForceReauthorizeAsync() always makes its own attempt.

From 1.7.0

AuthResponse.FromJson now rejects JSON that is not an auth response. It previously returned an instance whose non-nullable properties were null when the JSON carried no token or no expiresAt, and returned one carrying an unreadable expiresAt unchecked — both failed later, at the first use, with an exception naming nothing that could be acted on. All of those now throw ArgumentException, as does an expiresAt that is not an ISO 8601 date and time and a field written out as null. If you were relying on the old behaviour to hold a half-populated response, read the fields from your own model instead.

An expiry is read as UTC. AuthResponse.ExpirationTime returns the instant the wire value names, converted from whatever offset it carried; the client's own expiry checks use it. A server sending a non-UTC round-trip value was previously compared against a UTC clock as though it were UTC, so its tokens read as valid for the length of the offset after they expired. If you were compensating for that skew, stop.

An auth or refresh endpoint that answers successfully with something that is not an auth response now throws InvalidAuthResponseException. It previously surfaced as a bare ArgumentException about deserialization, naming neither the address that answered nor what it said. The new exception carries both; see When the Address Is Not an Auth Server. A catch (ArgumentException) around an authenticating call no longer catches it.

Bodies from an auth endpoint are read under a 64 K character cap, and redacted before they reach a message. This covers the unsuccessful branch too, so the body quoted in an UnauthorizedAccessException or HttpRequestException message is now capped and has secret-looking values replaced with [REDACTED]. If you were parsing the full error body out of the message, read it from the server's response instead.

AuthResponse.ToString() writes the refresh token as null when there is none, rather than leaving the field out. Both forms are redacted; only the shape of the log line changed.

From 1.6.0

Both credential constructors now reject an empty credential. new AuthorizedHttpClient(httpClient, "") and new AuthorizedHttpClient(httpClient, "", "") previously constructed successfully and failed later, at the first request; they now throw ArgumentException at construction. null continues to throw ArgumentNullException, and a whitespace-only credential is still sent to the server unchanged.

If you were relying on the old behaviour to defer credential validation to the server, move that check ahead of the constructor.

The username/password constructor now normalizes the base address. It previously skipped the trailing-slash normalization the other two constructors perform, so a base address carrying a path prefix (https://api.example.com/myapp) lost that prefix when the auth endpoint was appended — the login POST went to https://api.example.com/api/auth/login. If you worked around this by passing an absolute authEndpoint, or by adding the trailing slash yourself, that workaround is no longer needed (and remains harmless).

The request models now pin their wire field names. LoginAuthRequest and ApiKeyAuthRequest carry [JsonPropertyName] attributes and expose the names as constants (UsernameFieldName, PasswordFieldName, ApiKeyFieldName, ClientIdFieldName), matching the server-side models. The body this client sends is unchanged; it can no longer drift if a property is renamed or if JsonSerializerSettings.CurrentOptions is assigned a different naming policy.