fix(permissions): non admin access to view users [EE-5825] (#10353)

* fix(security): added restrictions to see user names [EE-5825]
pull/10370/head
Prabhat Khera 2023-09-25 09:08:37 +13:00 committed by GitHub
parent b60f32a25b
commit 78202cfb25
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 67 additions and 38 deletions

View File

@ -26,16 +26,20 @@ import (
// @failure 500 "Server error" // @failure 500 "Server error"
// @router /users [get] // @router /users [get]
func (handler *Handler) userList(w http.ResponseWriter, r *http.Request) *httperror.HandlerError { func (handler *Handler) userList(w http.ResponseWriter, r *http.Request) *httperror.HandlerError {
users, err := handler.DataStore.User().ReadAll()
if err != nil {
return httperror.InternalServerError("Unable to retrieve users from the database", err)
}
securityContext, err := security.RetrieveRestrictedRequestContext(r) securityContext, err := security.RetrieveRestrictedRequestContext(r)
if err != nil { if err != nil {
return httperror.InternalServerError("Unable to retrieve info from request context", err) return httperror.InternalServerError("Unable to retrieve info from request context", err)
} }
if !securityContext.IsAdmin && !securityContext.IsTeamLeader {
return httperror.Forbidden("Permission denied to access users list", err)
}
users, err := handler.DataStore.User().ReadAll()
if err != nil {
return httperror.InternalServerError("Unable to retrieve users from the database", err)
}
availableUsers := security.FilterUsers(users, securityContext) availableUsers := security.FilterUsers(users, securityContext)
for i := range availableUsers { for i := range availableUsers {
hideFields(&availableUsers[i]) hideFields(&availableUsers[i])
@ -43,7 +47,10 @@ func (handler *Handler) userList(w http.ResponseWriter, r *http.Request) *httper
endpointID, _ := request.RetrieveNumericQueryParameter(r, "environmentId", true) endpointID, _ := request.RetrieveNumericQueryParameter(r, "environmentId", true)
if endpointID == 0 { if endpointID == 0 {
return response.JSON(w, availableUsers) if securityContext.IsAdmin {
sanitizeUsers(users)
}
return response.JSON(w, users)
} }
// filter out users who do not have access to the specific endpoint // filter out users who do not have access to the specific endpoint
@ -61,6 +68,9 @@ func (handler *Handler) userList(w http.ResponseWriter, r *http.Request) *httper
for _, user := range availableUsers { for _, user := range availableUsers {
// the users who have the endpoint authorization // the users who have the endpoint authorization
if _, ok := user.EndpointAuthorizations[endpoint.ID]; ok { if _, ok := user.EndpointAuthorizations[endpoint.ID]; ok {
if securityContext.IsAdmin {
sanitizeUser(&user)
}
canAccessEndpoint = append(canAccessEndpoint, user) canAccessEndpoint = append(canAccessEndpoint, user)
continue continue
} }
@ -72,9 +82,27 @@ func (handler *Handler) userList(w http.ResponseWriter, r *http.Request) *httper
} }
if security.AuthorizedEndpointAccess(endpoint, endpointGroup, user.ID, teamMemberships) { if security.AuthorizedEndpointAccess(endpoint, endpointGroup, user.ID, teamMemberships) {
if securityContext.IsAdmin {
sanitizeUser(&user)
}
canAccessEndpoint = append(canAccessEndpoint, user) canAccessEndpoint = append(canAccessEndpoint, user)
} }
} }
return response.JSON(w, canAccessEndpoint) return response.JSON(w, canAccessEndpoint)
} }
func sanitizeUser(user *portainer.User) {
user.Password = ""
user.EndpointAuthorizations = nil
user.ThemeSettings = portainer.UserThemeSettings{}
user.PortainerAuthorizations = nil
user.UserTheme = ""
user.TokenIssueAt = 0
}
func sanitizeUsers(users []portainer.User) {
for i := range users {
sanitizeUser(&users[i])
}
}

View File

@ -111,28 +111,14 @@ func Test_userList(t *testing.T) {
} }
}) })
t.Run("standard user cannot list amdin users", func(t *testing.T) { t.Run("standard user cannot list users", func(t *testing.T) {
req := httptest.NewRequest(http.MethodGet, "/users", nil) req := httptest.NewRequest(http.MethodGet, "/users", nil)
req.Header.Add("Authorization", fmt.Sprintf("Bearer %s", jwt)) req.Header.Add("Authorization", fmt.Sprintf("Bearer %s", jwt))
rr := httptest.NewRecorder() rr := httptest.NewRecorder()
h.ServeHTTP(rr, req) h.ServeHTTP(rr, req)
is.Equal(http.StatusOK, rr.Code) is.Equal(http.StatusForbidden, rr.Code)
body, err := io.ReadAll(rr.Body)
is.NoError(err, "ReadAll should not return error")
var resp []portainer.User
err = json.Unmarshal(body, &resp)
is.NoError(err, "response should be list json")
is.Len(resp, 2)
if len(resp) > 0 {
for _, user := range resp {
is.NotEqual(portainer.AdministratorRole, user.Role)
}
}
}) })
// Case 2: the user is under an environment group and the environment group has endpoint access. // Case 2: the user is under an environment group and the environment group has endpoint access.

View File

@ -4,6 +4,7 @@ import { createMockTeams, createMockUsers } from '@/react-tools/test-mocks';
import { renderWithQueryClient } from '@/react-tools/test-utils'; import { renderWithQueryClient } from '@/react-tools/test-utils';
import { rest, server } from '@/setup-tests/server'; import { rest, server } from '@/setup-tests/server';
import { Role } from '@/portainer/users/types'; import { Role } from '@/portainer/users/types';
import { withUserProvider } from '@/react/test-utils/withUserProvider';
import { import {
ResourceControlOwnership, ResourceControlOwnership,
@ -143,11 +144,9 @@ async function renderComponent(
resourceType: ResourceControlType = ResourceControlType.Container, resourceType: ResourceControlType = ResourceControlType.Container,
resourceControl?: ResourceControlViewModel resourceControl?: ResourceControlViewModel
) { ) {
const WithUser = withUserProvider(AccessControlPanelDetails);
const queries = renderWithQueryClient( const queries = renderWithQueryClient(
<AccessControlPanelDetails <WithUser resourceControl={resourceControl} resourceType={resourceType} />
resourceControl={resourceControl}
resourceType={resourceType}
/>
); );
await expect(queries.findByText('Ownership')).resolves.toBeVisible(); await expect(queries.findByText('Ownership')).resolves.toBeVisible();

View File

@ -8,6 +8,7 @@ import { UserId } from '@/portainer/users/types';
import { TeamId } from '@/react/portainer/users/teams/types'; import { TeamId } from '@/react/portainer/users/teams/types';
import { useTeams } from '@/react/portainer/users/teams/queries'; import { useTeams } from '@/react/portainer/users/teams/queries';
import { useUsers } from '@/portainer/users/queries'; import { useUsers } from '@/portainer/users/queries';
import { pluralize } from '@/portainer/helpers/strings';
import { Link } from '@@/Link'; import { Link } from '@@/Link';
import { Tooltip } from '@@/Tip/Tooltip'; import { Tooltip } from '@@/Tip/Tooltip';
@ -43,6 +44,25 @@ export function AccessControlPanelDetails({
const users = useAuthorizedUsers(restrictedToUsers.map((ra) => ra.UserId)); const users = useAuthorizedUsers(restrictedToUsers.map((ra) => ra.UserId));
const teams = useAuthorizedTeams(restrictedToTeams.map((ra) => ra.TeamId)); const teams = useAuthorizedTeams(restrictedToTeams.map((ra) => ra.TeamId));
const teamsLength = teams.data ? teams.data.length : 0;
const unauthoisedTeams = restrictedToTeams.length - teamsLength;
let teamsMessage = teams.data && teams.data.join(', ');
if (unauthoisedTeams > 0 && teams.isFetched) {
teamsMessage += teamsLength > 0 ? ' and' : '';
teamsMessage += ` ${unauthoisedTeams} ${pluralize(
unauthoisedTeams,
'team'
)} you are not part of`;
}
const userMessage = users.data
? users.data.join(', ')
: `${restrictedToUsers.length} ${pluralize(
restrictedToUsers.length,
'user'
)}`;
return ( return (
<table className="table"> <table className="table">
<tbody> <tbody>
@ -62,17 +82,13 @@ export function AccessControlPanelDetails({
{restrictedToUsers.length > 0 && ( {restrictedToUsers.length > 0 && (
<tr data-cy="access-authorisedUsers"> <tr data-cy="access-authorisedUsers">
<td>Authorized users</td> <td>Authorized users</td>
<td aria-label="authorized-users"> <td aria-label="authorized-users">{userMessage}</td>
{users.data && users.data.join(', ')}
</td>
</tr> </tr>
)} )}
{restrictedToTeams.length > 0 && ( {restrictedToTeams.length > 0 && (
<tr data-cy="access-authorisedTeams"> <tr data-cy="access-authorisedTeams">
<td>Authorized teams</td> <td>Authorized teams</td>
<td aria-label="authorized-teams"> <td aria-label="authorized-teams">{teamsMessage}</td>
{teams.data && teams.data.join(', ')}
</td>
</tr> </tr>
)} )}
</tbody> </tbody>

View File

@ -32,7 +32,7 @@ export function EditDetails({
}: Props) { }: Props) {
const { user, isAdmin } = useUser(); const { user, isAdmin } = useUser();
const { users, teams, isLoading } = useLoadState(environmentId); const { users, teams, isLoading } = useLoadState(environmentId, isAdmin);
const handleChange = useCallback( const handleChange = useCallback(
(partialValues: Partial<typeof values>) => { (partialValues: Partial<typeof values>) => {
onChange({ ...values, ...partialValues }); onChange({ ...values, ...partialValues });
@ -41,7 +41,7 @@ export function EditDetails({
[values, onChange] [values, onChange]
); );
if (isLoading || !teams || !users) { if (isLoading || !teams || (isAdmin && !users) || !values.authorizedUsers) {
return null; return null;
} }
@ -61,7 +61,7 @@ export function EditDetails({
{isAdmin && ( {isAdmin && (
<UsersField <UsersField
name={withNamespace('authorizedUsers')} name={withNamespace('authorizedUsers')}
users={users} users={users || []}
onChange={(authorizedUsers) => handleChange({ authorizedUsers })} onChange={(authorizedUsers) => handleChange({ authorizedUsers })}
value={values.authorizedUsers} value={values.authorizedUsers}
errors={errors?.authorizedUsers} errors={errors?.authorizedUsers}

View File

@ -2,9 +2,9 @@ import { useTeams } from '@/react/portainer/users/teams/queries';
import { useUsers } from '@/portainer/users/queries'; import { useUsers } from '@/portainer/users/queries';
import { EnvironmentId } from '@/react/portainer/environments/types'; import { EnvironmentId } from '@/react/portainer/environments/types';
export function useLoadState(environmentId?: EnvironmentId) { export function useLoadState(environmentId?: EnvironmentId, enabled = true) {
const teams = useTeams(false, environmentId); const teams = useTeams(false, environmentId);
const users = useUsers(false, environmentId); const users = useUsers(false, environmentId, enabled);
return { return {
teams: teams.data, teams: teams.data,

View File

@ -18,7 +18,7 @@ export function ListView() {
<> <>
<PageHeader title="Teams" breadcrumbs={[{ label: 'Teams management' }]} /> <PageHeader title="Teams" breadcrumbs={[{ label: 'Teams management' }]} />
{usersQuery.data && teamsQuery.data && ( {isAdmin && usersQuery.data && teamsQuery.data && (
<CreateTeamForm users={usersQuery.data} teams={teamsQuery.data} /> <CreateTeamForm users={usersQuery.data} teams={teamsQuery.data} />
)} )}