Skip to content

[PM-34255] - SCIM Api Key Fix #7403

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

Merged
jrmccannon merged 1 commit into from
Apr 8, 2026
Merged

[PM-34255] - SCIM Api Key Fix #7403

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
24 changes: 9 additions & 15 deletions src/Api/AdminConsole/Controllers/OrganizationsController.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -407,17 +407,14 @@ public async Task<ApiKeyResponseModel> ApiKey(string id, [FromBody] Organization
throw new UnauthorizedAccessException();
}

if (model.Type != OrganizationApiKeyType.Scim
&& !await _userService.VerifySecretAsync(user, model.Secret))
if (!await _userService.VerifySecretAsync(user, model.Secret))
{
await Task.Delay(2000);
throw new BadRequestException("MasterPasswordHash", "Invalid password.");
}
else
{
var response = new ApiKeyResponseModel(organizationApiKey);
return response;
}

var response = new ApiKeyResponseModel(organizationApiKey);
return response;
}

[HttpGet("{id}/api-key-information/{type?}")]
Expand Down Expand Up @@ -460,18 +457,15 @@ public async Task<ApiKeyResponseModel> RotateApiKey(string id, [FromBody] Organi
throw new UnauthorizedAccessException();
}

if (model.Type != OrganizationApiKeyType.Scim
&& !await _userService.VerifySecretAsync(user, model.Secret))
if (!await _userService.VerifySecretAsync(user, model.Secret))
{
await Task.Delay(2000);
throw new BadRequestException("MasterPasswordHash", "Invalid password.");
}
else
{
await _rotateOrganizationApiKeyCommand.RotateApiKeyAsync(organizationApiKey);
var response = new ApiKeyResponseModel(organizationApiKey);
return response;
}

await _rotateOrganizationApiKeyCommand.RotateApiKeyAsync(organizationApiKey);
var response = new ApiKeyResponseModel(organizationApiKey);
return response;
}

private async Task<bool> HasApiKeyAccessAsync(Guid orgId, OrganizationApiKeyType? type)
Expand Down
111 changes: 111 additions & 0 deletions test/Api.Test/AdminConsole/Controllers/OrganizationsControllerTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
ο»Ώusing System.Security.Claims;
using Bit.Api.AdminConsole.Controllers;
using Bit.Api.AdminConsole.Models.Request.Organizations;
using Bit.Api.Auth.Models.Request.Accounts;
using Bit.Api.Models.Request.Organizations;
using Bit.Core;
Expand All @@ -8,6 +9,7 @@
using Bit.Core.AdminConsole.Enums.Provider;
using Bit.Core.AdminConsole.Models.Business;
using Bit.Core.AdminConsole.Models.Data.Organizations.Policies;
using Bit.Core.AdminConsole.OrganizationFeatures.OrganizationApiKeys.Interfaces;
using Bit.Core.AdminConsole.OrganizationFeatures.Organizations.Interfaces;
using Bit.Core.AdminConsole.OrganizationFeatures.OrganizationUsers.Interfaces;
using Bit.Core.AdminConsole.OrganizationFeatures.Policies;
Expand Down Expand Up @@ -257,4 +259,113 @@ await sutProvider.GetDependency<IOrganizationService>()
s.LimitItemDeletion == model.LimitItemDeletion &&
s.AllowAdminAccessToAllCollectionItems == model.AllowAdminAccessToAllCollectionItems));
}

[Theory, BitAutoData]
public async Task ApiKey_ScimType_InvalidSecret_ThrowsBadRequest(
SutProvider<OrganizationsController> sutProvider,
Organization organization,
OrganizationApiKey organizationApiKey,
User user)
{
organization.PlanType = PlanType.EnterpriseAnnually;
var model = new OrganizationApiKeyRequestModel
{
Type = OrganizationApiKeyType.Scim,
MasterPasswordHash = "invalid-hash"
};

sutProvider.GetDependency<ICurrentContext>().ManageScim(organization.Id).Returns(true);
sutProvider.GetDependency<IOrganizationRepository>().GetByIdAsync(organization.Id).Returns(organization);
sutProvider.GetDependency<IGetOrganizationApiKeyQuery>()
.GetOrganizationApiKeyAsync(organization.Id, OrganizationApiKeyType.Scim)
.Returns(organizationApiKey);

var userService = sutProvider.GetDependency<IUserService>();
userService.GetUserByPrincipalAsync(Arg.Any<ClaimsPrincipal>()).Returns(user);
userService.VerifySecretAsync(user, model.Secret).Returns(false);

await Assert.ThrowsAsync<BadRequestException>(
() => sutProvider.Sut.ApiKey(organization.Id.ToString(), model));
}

[Theory, BitAutoData]
public async Task ApiKey_ScimType_ValidSecret_ReturnsApiKey(
SutProvider<OrganizationsController> sutProvider,
Organization organization,
OrganizationApiKey organizationApiKey,
User user)
{
organization.PlanType = PlanType.EnterpriseAnnually;
var model = new OrganizationApiKeyRequestModel
{
Type = OrganizationApiKeyType.Scim,
MasterPasswordHash = "valid-hash"
};

sutProvider.GetDependency<ICurrentContext>().ManageScim(organization.Id).Returns(true);
sutProvider.GetDependency<IOrganizationRepository>().GetByIdAsync(organization.Id).Returns(organization);
sutProvider.GetDependency<IGetOrganizationApiKeyQuery>()
.GetOrganizationApiKeyAsync(organization.Id, OrganizationApiKeyType.Scim)
.Returns(organizationApiKey);
var userService = sutProvider.GetDependency<IUserService>();
userService.GetUserByPrincipalAsync(Arg.Any<ClaimsPrincipal>()).Returns(user);
userService.VerifySecretAsync(user, model.Secret).Returns(true);

var result = await sutProvider.Sut.ApiKey(organization.Id.ToString(), model);

Assert.Equal(organizationApiKey.ApiKey, result.ApiKey);
}

[Theory, BitAutoData]
public async Task RotateApiKey_ScimType_InvalidSecret_ThrowsBadRequest(
SutProvider<OrganizationsController> sutProvider,
Organization organization,
OrganizationApiKey organizationApiKey,
User user)
{
var model = new OrganizationApiKeyRequestModel
{
Type = OrganizationApiKeyType.Scim,
MasterPasswordHash = "invalid-hash"
};

sutProvider.GetDependency<ICurrentContext>().ManageScim(organization.Id).Returns(true);
sutProvider.GetDependency<IOrganizationRepository>().GetByIdAsync(organization.Id).Returns(organization);
sutProvider.GetDependency<IGetOrganizationApiKeyQuery>()
.GetOrganizationApiKeyAsync(organization.Id, OrganizationApiKeyType.Scim)
.Returns(organizationApiKey);
var userService = sutProvider.GetDependency<IUserService>();
userService.GetUserByPrincipalAsync(Arg.Any<ClaimsPrincipal>()).Returns(user);
userService.VerifySecretAsync(user, model.Secret).Returns(false);

await Assert.ThrowsAsync<BadRequestException>(
() => sutProvider.Sut.RotateApiKey(organization.Id.ToString(), model));
}

[Theory, BitAutoData]
public async Task RotateApiKey_ScimType_ValidSecret_ReturnsApiKey(
SutProvider<OrganizationsController> sutProvider,
Organization organization,
OrganizationApiKey organizationApiKey,
User user)
{
var model = new OrganizationApiKeyRequestModel
{
Type = OrganizationApiKeyType.Scim,
MasterPasswordHash = "valid-hash"
};

sutProvider.GetDependency<ICurrentContext>().ManageScim(organization.Id).Returns(true);
sutProvider.GetDependency<IOrganizationRepository>().GetByIdAsync(organization.Id).Returns(organization);
sutProvider.GetDependency<IGetOrganizationApiKeyQuery>()
.GetOrganizationApiKeyAsync(organization.Id, OrganizationApiKeyType.Scim)
.Returns(organizationApiKey);
var userService = sutProvider.GetDependency<IUserService>();
userService.GetUserByPrincipalAsync(Arg.Any<ClaimsPrincipal>()).Returns(user);
userService.VerifySecretAsync(user, model.Secret).Returns(true);

var result = await sutProvider.Sut.RotateApiKey(organization.Id.ToString(), model);

Assert.Equal(organizationApiKey.ApiKey, result.ApiKey);
}
}
Loading