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.

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

Change Permissions Service 2.0 GetAccountsAllowedOnBehalfOf API #5196

Merged
merged 1 commit into from
Dec 21, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
22 changes: 20 additions & 2 deletions src/NuGetGallery/Services/ActionRequiringEntityPermissions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,12 @@ public PermissionsCheckResult CheckPermissions(IPrincipal currentPrincipal, User

protected abstract PermissionsCheckResult CheckPermissionsForEntity(User account, TEntity entity);

public bool TryGetAccountsAllowedOnBehalfOf(User currentUser, TEntity entity, out IEnumerable<User> accountsAllowedOnBehalfOf)
public PermissionsCheckResult CheckPermissionsOnBehalfOfAnyAccount(User currentUser, TEntity entity)
{
return CheckPermissionsOnBehalfOfAnyAccount(currentUser, entity, out var accountsAllowedOnBehalfOf);
}

public PermissionsCheckResult CheckPermissionsOnBehalfOfAnyAccount(User currentUser, TEntity entity, out IEnumerable<User> accountsAllowedOnBehalfOf)
{
accountsAllowedOnBehalfOf = new List<User>();

Expand All @@ -60,16 +65,19 @@ public bool TryGetAccountsAllowedOnBehalfOf(User currentUser, TEntity entity, ou

possibleAccountsOnBehalfOf = possibleAccountsOnBehalfOf.Distinct(new UserEqualityComparer());

var aggregateResult = PermissionsCheckResult.Unknown;

foreach (var accountOnBehalfOf in possibleAccountsOnBehalfOf)
{
var result = CheckPermissions(currentUser, accountOnBehalfOf, entity);
aggregateResult = ChoosePermissionsCheckResult(aggregateResult, result);
if (result == PermissionsCheckResult.Allowed)
{
(accountsAllowedOnBehalfOf as List<User>).Add(accountOnBehalfOf);
}
}

return accountsAllowedOnBehalfOf.Any();
return aggregateResult;
}

protected abstract IEnumerable<User> GetOwners(TEntity entity);
Expand All @@ -86,5 +94,15 @@ public int GetHashCode(User obj)
return obj.Key.GetHashCode();
}
}

private PermissionsCheckResult ChoosePermissionsCheckResult(PermissionsCheckResult current, PermissionsCheckResult next)
{
if (current == PermissionsCheckResult.Allowed || next == PermissionsCheckResult.Allowed)
{
return PermissionsCheckResult.Allowed;
}

return new[] { current, next }.Max();
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,14 @@ protected override PermissionsCheckResult CheckPermissionsForEntity(User account
return PermissionsHelpers.IsRequirementSatisfied(PackageRegistrationPermissionsRequirement, account, packageRegistration) ? PermissionsCheckResult.Allowed : PermissionsCheckResult.PackageRegistrationFailure;
}

public bool TryGetAccountsAllowedOnBehalfOf(User currentUser, Package package, out IEnumerable<User> accountsAllowedOnBehalfOf)
public PermissionsCheckResult CheckPermissionsOnBehalfOfAnyAccount(User currentUser, Package package)
{
return TryGetAccountsAllowedOnBehalfOf(currentUser, GetPackageRegistration(package), out accountsAllowedOnBehalfOf);
return CheckPermissionsOnBehalfOfAnyAccount(currentUser, GetPackageRegistration(package));
}

public PermissionsCheckResult CheckPermissionsOnBehalfOfAnyAccount(User currentUser, Package package, out IEnumerable<User> accountsAllowedOnBehalfOf)
{
return CheckPermissionsOnBehalfOfAnyAccount(currentUser, GetPackageRegistration(package), out accountsAllowedOnBehalfOf);
}

protected override IEnumerable<User> GetOwners(PackageRegistration packageRegistration)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,9 +49,14 @@ protected override PermissionsCheckResult CheckPermissionsForEntity(User account
PermissionsCheckResult.Allowed : PermissionsCheckResult.ReservedNamespaceFailure;
}

public bool TryGetAccountsAllowedOnBehalfOf(User currentUser, ActionOnNewPackageContext newPackageContext, out IEnumerable<User> accountsAllowedOnBehalfOf)
public PermissionsCheckResult CheckPermissionsOnBehalfOfAnyAccount(User currentUser, ActionOnNewPackageContext newPackageContext)
{
return TryGetAccountsAllowedOnBehalfOf(currentUser, GetReservedNamespaces(newPackageContext), out accountsAllowedOnBehalfOf);
return CheckPermissionsOnBehalfOfAnyAccount(currentUser, GetReservedNamespaces(newPackageContext));
}

public PermissionsCheckResult CheckPermissionsOnBehalfOfAnyAccount(User currentUser, ActionOnNewPackageContext newPackageContext, out IEnumerable<User> accountsAllowedOnBehalfOf)
{
return CheckPermissionsOnBehalfOfAnyAccount(currentUser, GetReservedNamespaces(newPackageContext), out accountsAllowedOnBehalfOf);
}

protected override IEnumerable<User> GetOwners(IReadOnlyCollection<ReservedNamespace> reservedNamespaces)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,17 @@ public interface IActionRequiringEntityPermissions<TEntity>
/// </returns>
PermissionsCheckResult CheckPermissions(IPrincipal currentPrincipal, User account, TEntity entity);

/// <summary>
/// Determines whether <paramref name="currentPrincipal"/> can perform this action on <paramref name="entity"/> on behalf of any <see cref="User"/>.
/// </summary>
/// <returns>True if and only if <paramref name="currentPrincipal"/> can perform this action on <paramref name="entity"/> on behalf of any <see cref="User"/>.</returns>
PermissionsCheckResult CheckPermissionsOnBehalfOfAnyAccount(User currentUser, TEntity entity);

/// <summary>
/// Determines whether <paramref name="currentPrincipal"/> can perform this action on <paramref name="entity"/> on behalf of any <see cref="User"/>.
/// </summary>
/// <param name="accountsAllowedOnBehalfOf">A <see cref="IEnumerable{User}"/> containing all accounts that <paramref name="currentUser"/> can perform this action on <paramref name="entity"/> on behalf of.</param>
/// <returns>True if and only if <paramref name="currentPrincipal"/> can perform this action on <paramref name="entity"/> on behalf of any <see cref="User"/>.</returns>
bool TryGetAccountsAllowedOnBehalfOf(User currentUser, TEntity entity, out IEnumerable<User> accountsAllowedOnBehalfOf);
PermissionsCheckResult CheckPermissionsOnBehalfOfAnyAccount(User currentUser, TEntity entity, out IEnumerable<User> accountsAllowedOnBehalfOf);
}
}
5 changes: 5 additions & 0 deletions src/NuGetGallery/Services/PermissionsCheckResult.cs
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,11 @@ public enum PermissionsCheckResult
/// </summary>
Allowed = default(int),

/// <summary>
/// The permissions check failed for an unknown reason.
/// </summary>
Unknown,

/// <summary>
/// The current user does not have permissions to perform the action on the <see cref="User"/>.
/// </summary>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ protected override PermissionsCheckResult CheckPermissionsForEntity(User account
}
}

public class TheIsAllowedMethod
public class TheCheckPermissionsMethod
{
[Fact]
public void ReturnsAccountPermissionsFailureWhenAccountCheckFails()
Expand All @@ -67,14 +67,15 @@ private void AssertIsAllowed(ActionRequiringEntityPermissions<Entity> action, Pe
}
}

public class TheTryGetAccountsAllowedOnBehalfOfMethod
public class TheCheckPermissionsOnBehalfOfAnyAccountMethod
{
[Fact]
public void SuccessWithNullAccount()
{
var action = new TestableActionRequiringEntityPermissions(PermissionsRequirement.None, (account, entity) => PermissionsCheckResult.Allowed);

Assert.True(action.TryGetAccountsAllowedOnBehalfOf(null, null, out var accountsAllowedOnBehalfOf));
Assert.Equal(PermissionsCheckResult.Allowed, action.CheckPermissionsOnBehalfOfAnyAccount(null, null));
Assert.Equal(PermissionsCheckResult.Allowed, action.CheckPermissionsOnBehalfOfAnyAccount(null, null, out var accountsAllowedOnBehalfOf));
Assert.True(accountsAllowedOnBehalfOf.SequenceEqual(new User[] { null }));
}

Expand All @@ -83,7 +84,8 @@ public void FailureWithNullAccount()
{
var action = new TestableActionRequiringEntityPermissions(PermissionsRequirement.Unsatisfiable, (a, e) => PermissionsCheckResult.Allowed);

Assert.False(action.TryGetAccountsAllowedOnBehalfOf(null, null, out var accountsAllowedOnBehalfOf));
Assert.Equal(PermissionsCheckResult.AccountFailure, action.CheckPermissionsOnBehalfOfAnyAccount(null, null));
Assert.Equal(PermissionsCheckResult.AccountFailure, action.CheckPermissionsOnBehalfOfAnyAccount(null, null, out var accountsAllowedOnBehalfOf));
Assert.Empty(accountsAllowedOnBehalfOf);
}

Expand All @@ -94,18 +96,21 @@ public void SuccessWithNullEntity()

var action = new TestableActionRequiringEntityPermissions(PermissionsRequirement.None, (a, e) => PermissionsCheckResult.Allowed);

Assert.True(action.TryGetAccountsAllowedOnBehalfOf(user, null, out var accountsAllowedOnBehalfOf));
Assert.Equal(PermissionsCheckResult.Allowed, action.CheckPermissionsOnBehalfOfAnyAccount(user, null));
Assert.Equal(PermissionsCheckResult.Allowed, action.CheckPermissionsOnBehalfOfAnyAccount(user, null, out var accountsAllowedOnBehalfOf));
Assert.True(accountsAllowedOnBehalfOf.SequenceEqual(new[] { user }));
}

[Fact]
public void FailureWithNullEntity()
{
var failureResult = (PermissionsCheckResult)99;
var user = new User { Key = 1 };

var action = new TestableActionRequiringEntityPermissions(PermissionsRequirement.None, (a, e) => (PermissionsCheckResult)99);

Assert.False(action.TryGetAccountsAllowedOnBehalfOf(user, null, out var accountsAllowedOnBehalfOf));
Assert.Equal(failureResult, action.CheckPermissionsOnBehalfOfAnyAccount(user, null));
Assert.Equal(failureResult, action.CheckPermissionsOnBehalfOfAnyAccount(user, null, out var accountsAllowedOnBehalfOf));
Assert.Empty(accountsAllowedOnBehalfOf);
}

Expand All @@ -116,7 +121,8 @@ public void OrganizationsOfCurrentUserArePossibleAccounts()

var action = new TestableActionRequiringEntityPermissions(PermissionsRequirement.None, (a, e) => PermissionsCheckResult.Allowed);

Assert.True(action.TryGetAccountsAllowedOnBehalfOf(user, null, out var accountsAllowedOnBehalfOf));
Assert.Equal(PermissionsCheckResult.Allowed, action.CheckPermissionsOnBehalfOfAnyAccount(user, null));
Assert.Equal(PermissionsCheckResult.Allowed, action.CheckPermissionsOnBehalfOfAnyAccount(user, null, out var accountsAllowedOnBehalfOf));
Assert.True(accountsAllowedOnBehalfOf.SequenceEqual(new[] { user, organization }));
}

Expand All @@ -127,7 +133,8 @@ public void OwnersOfEntityArePossibleAccounts()

var action = new TestableActionRequiringEntityPermissions(PermissionsRequirement.None, (a, e) => PermissionsCheckResult.Allowed);

Assert.True(action.TryGetAccountsAllowedOnBehalfOf(null, entity, out var accountsAllowedOnBehalfOf));
Assert.Equal(PermissionsCheckResult.Allowed, action.CheckPermissionsOnBehalfOfAnyAccount(null, entity));
Assert.Equal(PermissionsCheckResult.Allowed, action.CheckPermissionsOnBehalfOfAnyAccount(null, entity, out var accountsAllowedOnBehalfOf));
Assert.True(accountsAllowedOnBehalfOf.SequenceEqual(new[] { null, entityOwner }));
}

Expand All @@ -139,7 +146,8 @@ public void OrganizationsOfCurrentUserAndOwnersOfEntityArePossibleAccounts()

var action = new TestableActionRequiringEntityPermissions(PermissionsRequirement.None, (a, e) => PermissionsCheckResult.Allowed);

Assert.True(action.TryGetAccountsAllowedOnBehalfOf(user, entity, out var accountsAllowedOnBehalfOf));
Assert.Equal(PermissionsCheckResult.Allowed, action.CheckPermissionsOnBehalfOfAnyAccount(user, entity));
Assert.Equal(PermissionsCheckResult.Allowed, action.CheckPermissionsOnBehalfOfAnyAccount(user, entity, out var accountsAllowedOnBehalfOf));
Assert.True(accountsAllowedOnBehalfOf.SequenceEqual(new[] { user, entityOwner, organization }));
}

Expand All @@ -166,7 +174,8 @@ public void AccountsAllowedOnBehalfOfIsPopulatedWithExpectedAccounts(int expecte
var action = new TestableActionRequiringEntityPermissions(PermissionsRequirement.None,
(a, e) => expectedAccountsList.Any(u => u.MatchesUser(a)) ? PermissionsCheckResult.Allowed : (PermissionsCheckResult)99);

Assert.True(action.TryGetAccountsAllowedOnBehalfOf(user, entity, out var accountsAllowedOnBehalfOf));
Assert.Equal(PermissionsCheckResult.Allowed, action.CheckPermissionsOnBehalfOfAnyAccount(user, entity));
Assert.Equal(PermissionsCheckResult.Allowed, action.CheckPermissionsOnBehalfOfAnyAccount(user, entity, out var accountsAllowedOnBehalfOf));
Assert.True(accountsAllowedOnBehalfOf.SequenceEqual(expectedAccountsList));
}

Expand Down