progmaweb
The site and account service of Progmasoft: a Next.js frontend and an ASP.NET Core API.
Clonegit clone https://git.progmasoft.com/progmaweb
mainroot / apps / api-tests / OAuthFlowTests.cs
// SPDX-FileCopyrightText: 2026 Progmasoft <support@progmasoft.com>
// SPDX-License-Identifier: AGPL-3.0-or-later
using System.Net;
using System.Net.Http.Headers;
using System.Net.Http.Json;
using System.Text.Json;
namespace Progmasoft.Progmaweb.Api.Tests;
public sealed class OAuthFlowTests
{
private static CancellationToken Cancel => TestContext.Current.CancellationToken;
[Fact]
public async Task AuthorizationCodeWithPkceIssuesTokensThatCarryOnlyTheGrantedClaims()
{
await using AccountApiFactory factory = new();
OAuthTestClient browser = new(factory);
await browser.RegisterAndSignInAsync("OAuthHolder1", "holder@example.com");
(string clientId, string? secret) = await browser.RegisterApplicationAsync();
(string verifier, string challenge) = OAuthTestClient.Pkce();
Uri redirect = await browser.AuthorizeAsync(clientId, "openid profile email offline_access",
challenge);
Assert.StartsWith(OAuthTestClient.RedirectUri, redirect.ToString(), StringComparison.Ordinal);
Assert.Equal("state-123", OAuthTestClient.Query(redirect, "state"));
string code = OAuthTestClient.Query(redirect, "code")!;
(HttpStatusCode status, JsonElement tokens) = await browser.TokenAsync(new Dictionary<string, string>
{
["grant_type"] = "authorization_code",
["code"] = code,
["redirect_uri"] = OAuthTestClient.RedirectUri,
["code_verifier"] = verifier,
["client_id"] = clientId,
["client_secret"] = secret!
});
Assert.True(status == HttpStatusCode.OK, tokens.ToString());
JsonElement identity = OAuthTestClient.Payload(tokens.GetProperty("id_token").GetString()!);
Assert.Equal($"https://{AccountApiFactory.OAuthHost}/", identity.GetProperty("iss").GetString());
Assert.Equal(clientId, identity.GetProperty("aud").GetString());
Assert.Equal("OAuthHolder1", identity.GetProperty("preferred_username").GetString());
Assert.Equal("holder@example.com", identity.GetProperty("email").GetString());
Assert.False(identity.GetProperty("email_verified").GetBoolean());
Assert.Equal("nonce-456", identity.GetProperty("nonce").GetString());
using HttpClient client = factory.CreateOAuthClient();
client.DefaultRequestHeaders.Authorization =
new AuthenticationHeaderValue("Bearer", tokens.GetProperty("access_token").GetString());
JsonElement user = await client.GetFromJsonAsync<JsonElement>("/connect/userinfo", Cancel);
Assert.Equal(identity.GetProperty("sub").GetString(), user.GetProperty("sub").GetString());
Assert.Equal("OAuthHolder1", user.GetProperty("name").GetString());
Assert.Equal("holder@example.com", user.GetProperty("email").GetString());
// The code is single use.
(HttpStatusCode reused, _) = await browser.TokenAsync(new Dictionary<string, string>
{
["grant_type"] = "authorization_code",
["code"] = code,
["redirect_uri"] = OAuthTestClient.RedirectUri,
["code_verifier"] = verifier,
["client_id"] = clientId,
["client_secret"] = secret!
});
Assert.Equal(HttpStatusCode.BadRequest, reused);
}
[Fact]
public async Task ScopesThatWereNotGrantedAreNotInTheTokens()
{
await using AccountApiFactory factory = new();
OAuthTestClient browser = new(factory);
await browser.RegisterAndSignInAsync("OAuthHolder2", "holder2@example.com");
(string clientId, string? secret) = await browser.RegisterApplicationAsync();
(string verifier, string challenge) = OAuthTestClient.Pkce();
Uri redirect = await browser.AuthorizeAsync(clientId, "openid", challenge);
(_, JsonElement tokens) = await browser.TokenAsync(new Dictionary<string, string>
{
["grant_type"] = "authorization_code",
["code"] = OAuthTestClient.Query(redirect, "code")!,
["redirect_uri"] = OAuthTestClient.RedirectUri,
["code_verifier"] = verifier,
["client_id"] = clientId,
["client_secret"] = secret!
});
JsonElement identity = OAuthTestClient.Payload(tokens.GetProperty("id_token").GetString()!);
Assert.False(identity.TryGetProperty("email", out _));
Assert.False(identity.TryGetProperty("preferred_username", out _));
Assert.False(tokens.TryGetProperty("refresh_token", out _));
}
[Fact]
public async Task RefreshTokensRotateAndAReusedOneIsRefused()
{
await using AccountApiFactory factory = new();
OAuthTestClient browser = new(factory);
await browser.RegisterAndSignInAsync("OAuthHolder3", "holder3@example.com");
(string clientId, string? secret) = await browser.RegisterApplicationAsync();
(string verifier, string challenge) = OAuthTestClient.Pkce();
Uri redirect = await browser.AuthorizeAsync(clientId, "openid offline_access", challenge);
(_, JsonElement first) = await browser.TokenAsync(new Dictionary<string, string>
{
["grant_type"] = "authorization_code",
["code"] = OAuthTestClient.Query(redirect, "code")!,
["redirect_uri"] = OAuthTestClient.RedirectUri,
["code_verifier"] = verifier,
["client_id"] = clientId,
["client_secret"] = secret!
});
string refresh = first.GetProperty("refresh_token").GetString()!;
Dictionary<string, string> refreshRequest = new()
{
["grant_type"] = "refresh_token",
["refresh_token"] = refresh,
["client_id"] = clientId,
["client_secret"] = secret!
};
(HttpStatusCode renewed, JsonElement second) = await browser.TokenAsync(refreshRequest);
Assert.Equal(HttpStatusCode.OK, renewed);
Assert.NotEqual(refresh, second.GetProperty("refresh_token").GetString());
(HttpStatusCode reused, JsonElement error) = await browser.TokenAsync(refreshRequest);
Assert.Equal(HttpStatusCode.BadRequest, reused);
Assert.Equal("invalid_grant", error.GetProperty("error").GetString());
}
[Fact]
public async Task AnAllowedApplicationSkipsTheConsentAndWithdrawingEndsItsTokens()
{
await using AccountApiFactory factory = new();
OAuthTestClient browser = new(factory);
await browser.RegisterAndSignInAsync("OAuthHolder4", "holder4@example.com");
(string clientId, string? secret) = await browser.RegisterApplicationAsync();
(string verifier, string challenge) = OAuthTestClient.Pkce();
Uri redirect = await browser.AuthorizeAsync(clientId, "openid offline_access", challenge);
(_, JsonElement tokens) = await browser.TokenAsync(new Dictionary<string, string>
{
["grant_type"] = "authorization_code",
["code"] = OAuthTestClient.Query(redirect, "code")!,
["redirect_uri"] = OAuthTestClient.RedirectUri,
["code_verifier"] = verifier,
["client_id"] = clientId,
["client_secret"] = secret!
});
HttpResponseMessage again = await browser.Browser.GetAsync(
OAuthTestClient.AuthorizePath(clientId, "openid offline_access", OAuthTestClient.Pkce().Challenge), Cancel);
Assert.Equal(HttpStatusCode.Redirect, again.StatusCode);
Assert.NotNull(OAuthTestClient.Query(again.Headers.Location!, "code"));
JsonElement allowed = await (await browser.SendAsync(HttpMethod.Get, "/api/v1/oauth/allowed"))
.Content.ReadFromJsonAsync<JsonElement>(Cancel);
JsonElement entry = Assert.Single(allowed.EnumerateArray());
Assert.Equal("Example Client", entry.GetProperty("displayName").GetString());
string authorizationId = entry.GetProperty("authorizationId").GetString()!;
HttpResponseMessage foreign = await browser.SendAsync(HttpMethod.Delete,
$"/api/v1/oauth/allowed/{authorizationId}", origin: "https://attacker.example");
Assert.Equal(HttpStatusCode.Forbidden, foreign.StatusCode);
OAuthTestClient stranger = new(factory);
await stranger.RegisterAndSignInAsync("OAuthStranger4", "stranger4@example.com");
Assert.Equal(HttpStatusCode.NotFound, (await stranger.SendAsync(HttpMethod.Delete,
$"/api/v1/oauth/allowed/{authorizationId}")).StatusCode);
HttpResponseMessage withdrawn = await browser.SendAsync(HttpMethod.Delete,
$"/api/v1/oauth/allowed/{authorizationId}");
Assert.Equal(HttpStatusCode.NoContent, withdrawn.StatusCode);
(HttpStatusCode refreshed, _) = await browser.TokenAsync(new Dictionary<string, string>
{
["grant_type"] = "refresh_token",
["refresh_token"] = tokens.GetProperty("refresh_token").GetString()!,
["client_id"] = clientId,
["client_secret"] = secret!
});
Assert.Equal(HttpStatusCode.BadRequest, refreshed);
}
[Fact]
public async Task DenyingTheConsentReturnsAccessDenied()
{
await using AccountApiFactory factory = new();
OAuthTestClient browser = new(factory);
await browser.RegisterAndSignInAsync("OAuthHolder5", "holder5@example.com");
(string clientId, _) = await browser.RegisterApplicationAsync();
Uri redirect = await browser.AuthorizeAsync(clientId, "openid email", OAuthTestClient.Pkce().Challenge, "deny");
Assert.Equal("access_denied", OAuthTestClient.Query(redirect, "error"));
Assert.Null(OAuthTestClient.Query(redirect, "code"));
}
[Fact]
public async Task TheConsentPageListsEachRequestedGrant()
{
await using AccountApiFactory factory = new();
OAuthTestClient browser = new(factory);
await browser.RegisterAndSignInAsync("OAuthHolder6", "holder6@example.com");
(string clientId, _) = await browser.RegisterApplicationAsync(
"profile email offline_access");
HttpResponseMessage authorize = await browser.Browser.GetAsync(OAuthTestClient.AuthorizePath(clientId,
"openid profile email offline_access",
OAuthTestClient.Pkce().Challenge), Cancel);
Uri consentPage = authorize.Headers.Location!;
Assert.True(OAuthTestClient.IsConsentPage(consentPage), consentPage.OriginalString);
JsonElement consent = await browser.Browser.GetFromJsonAsync<JsonElement>(
"/api/v1/oauth/consent" + consentPage.OriginalString["/consent".Length..], Cancel);
Assert.Equal(["profile", "email", "offline_access"],
consent.GetProperty("scopes").EnumerateArray().Select(scope => scope.GetString()));
Assert.Equal("Example Client", consent.GetProperty("displayName").GetString());
Assert.Equal("OAuthHolder6", consent.GetProperty("owner").GetString());
Assert.Equal("OAuthHolder6", consent.GetProperty("accountName").GetString());
Assert.Equal("https://client.example", consent.GetProperty("returnTo").GetString());
Assert.Equal("https://client.example", consent.GetProperty("homepage").GetString());
}
[Fact]
public async Task TheConsentPageDescribesOnlyRequestsTheApplicationCouldMake()
{
await using AccountApiFactory factory = new();
OAuthTestClient browser = new(factory);
await browser.RegisterAndSignInAsync("OAuthHolder10", "holder10@example.com");
(string clientId, _) = await browser.RegisterApplicationAsync("profile");
string Query(string redirectUri, string scope) =>
$"/api/v1/oauth/consent?client_id={clientId}&redirect_uri={Uri.EscapeDataString(redirectUri)}" +
$"&scope={Uri.EscapeDataString(scope)}";
Assert.Equal(HttpStatusCode.OK,
(await browser.Browser.GetAsync(Query(OAuthTestClient.RedirectUri, "openid profile"), Cancel)).StatusCode);
Assert.Equal(HttpStatusCode.BadRequest,
(await browser.Browser.GetAsync(Query("https://attacker.example/callback", "openid"), Cancel)).StatusCode);
Assert.Equal(HttpStatusCode.BadRequest,
(await browser.Browser.GetAsync(Query(OAuthTestClient.RedirectUri, "openid email"), Cancel)).StatusCode);
Assert.Equal(HttpStatusCode.BadRequest, (await browser.Browser.GetAsync(
"/api/v1/oauth/consent?client_id=pmo_missing&redirect_uri=https%3A%2F%2Fclient.example%2Fcallback",
Cancel)).StatusCode);
}
[Fact]
public async Task AConsentDecisionFromAnotherSiteIsRefused()
{
await using AccountApiFactory factory = new();
OAuthTestClient browser = new(factory);
await browser.RegisterAndSignInAsync("OAuthHolder11", "holder11@example.com");
(string clientId, _) = await browser.RegisterApplicationAsync("profile");
HttpResponseMessage authorize = await browser.Browser.GetAsync(
OAuthTestClient.AuthorizePath(clientId, "openid profile", OAuthTestClient.Pkce().Challenge), Cancel);
Uri consentPage = authorize.Headers.Location!;
HttpResponseMessage forged = await browser.DecideAsync(consentPage, "allow", "https://attacker.example");
Assert.Equal(HttpStatusCode.Forbidden, forged.StatusCode);
HttpResponseMessage blind = await browser.DecideAsync(consentPage, "allow", origin: null);
Assert.Equal(HttpStatusCode.Forbidden, blind.StatusCode);
}
[Fact]
public async Task APublicClientUsesPkceWithoutASecret()
{
await using AccountApiFactory factory = new();
OAuthTestClient browser = new(factory);
await browser.RegisterAndSignInAsync("OAuthHolder8", "holder8@example.com");
(string clientId, string? secret) = await browser.RegisterApplicationAsync("profile", kind: "desktop",
redirectUris: "com.example.app:/callback");
Assert.Null(secret);
(string verifier, string challenge) = OAuthTestClient.Pkce();
Uri redirect = await browser.AuthorizeAsync(clientId, "openid profile", challenge,
redirectUri: "com.example.app:/callback");
Assert.Equal("com.example.app", redirect.Scheme);
(HttpStatusCode status, _) = await browser.TokenAsync(new Dictionary<string, string>
{
["grant_type"] = "authorization_code",
["code"] = OAuthTestClient.Query(redirect, "code")!,
["redirect_uri"] = "com.example.app:/callback",
["code_verifier"] = verifier,
["client_id"] = clientId
});
Assert.Equal(HttpStatusCode.OK, status);
}
[Fact]
public async Task OnPostgreSqlTheTablesAreCreatedAndAReusedRefreshTokenRevokesItsChain()
{
await using PostgresTestDatabase database = await PostgresTestDatabase.CreateAsync();
await using AccountApiFactory factory = new(accountDatabase: database.ConnectionString);
OAuthTestClient browser = new(factory);
await browser.RegisterAndSignInAsync("PostgresHolder1", "postgres1@example.com");
(string clientId, string? secret) = await browser.RegisterApplicationAsync();
(string verifier, string challenge) = OAuthTestClient.Pkce();
Uri redirect = await browser.AuthorizeAsync(clientId, "openid profile offline_access", challenge);
(_, JsonElement first) = await browser.TokenAsync(new Dictionary<string, string>
{
["grant_type"] = "authorization_code",
["code"] = OAuthTestClient.Query(redirect, "code")!,
["redirect_uri"] = OAuthTestClient.RedirectUri,
["code_verifier"] = verifier,
["client_id"] = clientId,
["client_secret"] = secret!
});
Dictionary<string, string> Refresh(string token) => new()
{
["grant_type"] = "refresh_token",
["refresh_token"] = token,
["client_id"] = clientId,
["client_secret"] = secret!
};
(HttpStatusCode renewed, JsonElement second) =
await browser.TokenAsync(Refresh(first.GetProperty("refresh_token").GetString()!));
Assert.Equal(HttpStatusCode.OK, renewed);
// Reusing the first refresh token is taken for theft: the token issued from it stops working as well.
(HttpStatusCode reused, _) = await browser.TokenAsync(Refresh(first.GetProperty("refresh_token").GetString()!));
(HttpStatusCode chained, _) = await browser.TokenAsync(Refresh(second.GetProperty("refresh_token").GetString()!));
Assert.Equal(HttpStatusCode.BadRequest, reused);
Assert.Equal(HttpStatusCode.BadRequest, chained);
await using Npgsql.NpgsqlDataSource dataSource = database.OpenDataSource();
await using Npgsql.NpgsqlCommand version =
dataSource.CreateCommand("SELECT max(version) FROM oauth_schema_versions");
Assert.Equal(Progmasoft.OAuth.Storage.OAuthSchema.CurrentVersion,
(int)(await version.ExecuteScalarAsync(Cancel))!);
}
[Fact]
public async Task ClientCredentialsActAsTheApplicationAndTakeNoAccountScope()
{
await using AccountApiFactory factory = new();
OAuthTestClient browser = new(factory);
await browser.RegisterAndSignInAsync("OAuthHolder9", "holder9@example.com");
(string clientId, string? secret) = await browser.RegisterServiceAsync();
(HttpStatusCode status, JsonElement token) = await browser.TokenAsync(new Dictionary<string, string>
{
["grant_type"] = "client_credentials",
["client_id"] = clientId,
["client_secret"] = secret!
});
Assert.True(status == HttpStatusCode.OK, token.ToString());
(HttpStatusCode scoped, JsonElement error) = await browser.TokenAsync(new Dictionary<string, string>
{
["grant_type"] = "client_credentials",
["client_id"] = clientId,
["client_secret"] = secret!,
["scope"] = "profile"
});
// A service has no scope permission at all, so OpenIddict refuses the scope before the handler sees it.
Assert.Equal(HttpStatusCode.BadRequest, scoped);
Assert.Equal("invalid_request", error.GetProperty("error").GetString());
Assert.Contains("scope", error.GetProperty("error_description").GetString(), StringComparison.Ordinal);
(HttpStatusCode wrongSecret, _) = await browser.TokenAsync(new Dictionary<string, string>
{
["grant_type"] = "client_credentials",
["client_id"] = clientId,
["client_secret"] = "not-the-secret"
});
Assert.Equal(HttpStatusCode.Unauthorized, wrongSecret);
}
}