Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(pm): set correct AuthorName with API key #232

Merged
merged 6 commits into from
Sep 14, 2024
Merged

fix(pm): set correct AuthorName with API key #232

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
aa9c62c
fix(auth): set API key PrincipalName as sub claim
Fenrikur Sep 14, 2024
c127572
fix(pm): only admins may set AuthorName via API
Fenrikur Sep 14, 2024
02a15a8
fix(pm): prevent AuthorName from being empty
Fenrikur Sep 14, 2024
8db89ba
fix(auth): store name in "name" claim for API keys
Fenrikur Sep 14, 2024
d9b7180
Merge branch 'main' into bugfix/api-key-sender-name
Fenrikur Sep 14, 2024
72504b8
chore(logging): wording on api key match
Fenrikur Sep 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 14 additions & 12 deletions src/Eurofurence.App.Server.Web/Controllers/CommunicationController.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,26 +85,27 @@ public async Task<ActionResult> MarkMyPrivateMessageAsReadAsync(
/// with the same recipient uid, it will push a toast message to those devices.
/// The toast message content is defined by the `ToastTitle` and `ToastMessage` properties.
/// </remarks>
/// <param name="Request"></param>
/// <param name="request"></param>
/// <returns>The `Id` of the message that has been delivered.</returns>
/// <response code="400">Unable to parse `Request`</response>
[Authorize(AuthenticationSchemes = $"{ApiKeyAuthenticationDefaults.AuthenticationScheme},{OAuth2IntrospectionDefaults.AuthenticationScheme}", Roles = "Admin,PrivateMessageSender")]
[HttpPost("PrivateMessages")]
[HttpPost("PrivateMessages/:byRegistrationId")]
[ProducesResponseType(typeof(Guid), 200)]
public async Task<ActionResult> SendPrivateMessageAsync(
[FromBody] SendPrivateMessageByRegSysRequest Request,
[FromBody] SendPrivateMessageByRegSysRequest request,
CancellationToken cancellationToken = default)
{
if (Request == null) return BadRequest();
if (request == null) return BadRequest();

if (User.IsInRole("Attendee"))
// Only admins may set the AuthorName via the API
if (!User.IsInRole("Admin") || string.IsNullOrWhiteSpace(request.AuthorName))
{
Request.AuthorName = User.GetName();
request.AuthorName = User.GetName();
}

return Json(await _privateMessageService.SendPrivateMessageAsync(
Request,
request,
User.GetSubject(),
cancellationToken
));
Expand All @@ -118,25 +119,26 @@ public async Task<ActionResult> SendPrivateMessageAsync(
/// with the same recipient uid, it will push a toast message to those devices.
/// The toast message content is defined by the `ToastTitle` and `ToastMessage` properties.
/// </remarks>
/// <param name="Request"></param>
/// <param name="request"></param>
/// <returns>The `Id` of the message that has been delivered.</returns>
/// <response code="400">Unable to parse `Request`</response>
[Authorize(AuthenticationSchemes = $"{ApiKeyAuthenticationDefaults.AuthenticationScheme},{OAuth2IntrospectionDefaults.AuthenticationScheme}", Roles = "Admin,PrivateMessageSender")]
[HttpPost("PrivateMessages/:byIdentityId")]
[ProducesResponseType(typeof(Guid), 200)]
public async Task<ActionResult> SendPrivateMessageIdentityAsync(
[FromBody] SendPrivateMessageByIdentityRequest Request,
[FromBody] SendPrivateMessageByIdentityRequest request,
CancellationToken cancellationToken = default)
{
if (Request == null) return BadRequest();
if (request == null) return BadRequest();

if (User.IsInRole("Attendee"))
// Only admins may set the AuthorName via the API
if (!User.IsInRole("Admin") || string.IsNullOrWhiteSpace(request.AuthorName))
{
Request.AuthorName = User.GetName();
request.AuthorName = User.GetName();
}

return Json(await _privateMessageService.SendPrivateMessageAsync(
Request,
request,
User.GetSubject(),
cancellationToken
));
Expand Down
7 changes: 4 additions & 3 deletions src/Eurofurence.App.Server.Web/Identity/ApiKeyAuthenticationHandler.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,13 @@ protected override Task<AuthenticateResult> HandleAuthenticateAsync()

if (Options.ApiKeys.FirstOrDefault(apiKey => apiKey.Key == requestApiKey && DateTime.Now.CompareTo(apiKey.ValidUntil) <= 0) is { } apiKeyOptions)
{
Logger.LogInformation($"Configured API key for {apiKeyOptions.PrincipalName} with roles {string.Join(',', apiKeyOptions.Roles)} valid until {apiKeyOptions.ValidUntil}.");
Logger.LogInformation($"Matched API key for {apiKeyOptions.PrincipalName} with roles {string.Join(',', apiKeyOptions.Roles)} valid until {apiKeyOptions.ValidUntil}.");

var claims = new List<Claim>
{
new Claim(ClaimTypes.Name, apiKeyOptions.PrincipalName),
new Claim("sub", apiKeyOptions.PrincipalName)
new Claim("name", apiKeyOptions.PrincipalName),
new Claim("sub", $"{ApiKeyAuthenticationDefaults.AuthenticationScheme}:{apiKeyOptions.PrincipalName}"),
new Claim(ClaimTypes.Role, ApiKeyAuthenticationDefaults.AuthenticationScheme)
};

foreach (var role in apiKeyOptions.Roles)
Expand Down