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

Properly encode links to edit user page #81562

Merged
merged 5 commits into from
Oct 26, 2020
Merged

Properly encode links to edit user page #81562

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c66c449
Properly encode links to edit user
legrego Oct 23, 2020
85463f2
fix roles display
legrego Oct 23, 2020
42adf7c
Revert "fix roles display"
legrego Oct 26, 2020
adbcbbb
Merge branch 'master' of github.com:elastic/kibana into security/user…
legrego Oct 26, 2020
13be3a0
properly encode role names too
legrego Oct 26, 2020
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
33 changes: 29 additions & 4 deletions x-pack/plugins/security/public/management/roles/roles_grid/roles_grid_page.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,11 @@ describe('<RolesGridPage />', () => {
kibana: [{ base: [], spaces: [], feature: {} }],
transient_metadata: { enabled: false },
},
{
name: 'special%chars%role',
elasticsearch: { cluster: [], indices: [], run_as: [] },
kibana: [{ base: [], spaces: [], feature: {} }],
},
]);
});

Expand Down Expand Up @@ -121,7 +126,7 @@ describe('<RolesGridPage />', () => {
expect(wrapper.find(PermissionDenied)).toMatchSnapshot();
});

it('renders role actions as appropriate', async () => {
it('renders role actions as appropriate, escaping when necessary', async () => {
const wrapper = mountWithIntl(
<RolesGridPage
rolesAPIClient={apiClientMock}
Expand All @@ -137,16 +142,26 @@ describe('<RolesGridPage />', () => {

expect(wrapper.find(PermissionDenied)).toHaveLength(0);

const editButton = wrapper.find('EuiButtonIcon[data-test-subj="edit-role-action-test-role-1"]');
let editButton = wrapper.find('EuiButtonIcon[data-test-subj="edit-role-action-test-role-1"]');
expect(editButton).toHaveLength(1);
expect(editButton.prop('href')).toBe('/edit/test-role-1');

const cloneButton = wrapper.find(
'EuiButtonIcon[data-test-subj="clone-role-action-test-role-1"]'
editButton = wrapper.find(
'EuiButtonIcon[data-test-subj="edit-role-action-special%chars%role"]'
);
expect(editButton).toHaveLength(1);
expect(editButton.prop('href')).toBe('/edit/special%25chars%25role');

let cloneButton = wrapper.find('EuiButtonIcon[data-test-subj="clone-role-action-test-role-1"]');
expect(cloneButton).toHaveLength(1);
expect(cloneButton.prop('href')).toBe('/clone/test-role-1');

cloneButton = wrapper.find(
'EuiButtonIcon[data-test-subj="clone-role-action-special%chars%role"]'
);
expect(cloneButton).toHaveLength(1);
expect(cloneButton.prop('href')).toBe('/clone/special%25chars%25role');

expect(
wrapper.find('EuiButtonIcon[data-test-subj="edit-role-action-disabled-role"]')
).toHaveLength(1);
Expand Down Expand Up @@ -182,6 +197,11 @@ describe('<RolesGridPage />', () => {
kibana: [{ base: [], spaces: [], feature: {} }],
metadata: { _reserved: true },
},
{
name: 'special%chars%role',
elasticsearch: { cluster: [], indices: [], run_as: [] },
kibana: [{ base: [], spaces: [], feature: {} }],
},
{
name: 'test-role-1',
elasticsearch: { cluster: [], indices: [], run_as: [] },
Expand All @@ -198,6 +218,11 @@ describe('<RolesGridPage />', () => {
kibana: [{ base: [], spaces: [], feature: {} }],
transient_metadata: { enabled: false },
},
{
name: 'special%chars%role',
elasticsearch: { cluster: [], indices: [], run_as: [] },
kibana: [{ base: [], spaces: [], feature: {} }],
},
{
name: 'test-role-1',
elasticsearch: { cluster: [], indices: [], run_as: [] },
Expand Down
2 changes: 1 addition & 1 deletion x-pack/plugins/security/public/management/roles/roles_grid/roles_grid_page.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ interface State {
}

const getRoleManagementHref = (action: 'edit' | 'clone', roleName?: string) => {
return `/${action}${roleName ? `/${roleName}` : ''}`;
return `/${action}${roleName ? `/${encodeURIComponent(roleName)}` : ''}`;
};

export class RolesGridPage extends Component<Props, State> {
Expand Down
32 changes: 32 additions & 0 deletions x-pack/plugins/security/public/management/users/users_grid/users_grid_page.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,38 @@ describe('UsersGridPage', () => {
expect(findTestSubject(wrapper, 'userDisabled')).toHaveLength(0);
});

it('generates valid links when usernames contain special characters', async () => {
const apiClientMock = userAPIClientMock.create();
apiClientMock.getUsers.mockImplementation(() => {
return Promise.resolve<User[]>([
{
username: 'username with some fun characters!@#$%^&*()',
email: '[email protected]',
full_name: 'foo bar',
roles: ['kibana_user'],
enabled: true,
},
]);
});

const wrapper = mountWithIntl(
<UsersGridPage
userAPIClient={apiClientMock}
rolesAPIClient={rolesAPIClientMock.create()}
notifications={coreStart.notifications}
history={history}
navigateToApp={coreStart.application.navigateToApp}
/>
);

await waitForRender(wrapper);

const link = findTestSubject(wrapper, 'userRowUserName');
expect(link.props().href).toMatchInlineSnapshot(
`"/edit/username%20with%20some%20fun%20characters!%40%23%24%25%5E%26*()"`
);
});

it('renders a forbidden message if user is not authorized', async () => {
const apiClient = userAPIClientMock.create();
apiClient.getUsers.mockRejectedValue({ body: { statusCode: 403 } });
Expand Down
2 changes: 1 addition & 1 deletion x-pack/plugins/security/public/management/users/users_grid/users_grid_page.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ export class UsersGridPage extends Component<Props, State> {
render: (username: string) => (
<EuiLink
data-test-subj="userRowUserName"
{...reactRouterNavigate(this.props.history, `/edit/${username}`)}
{...reactRouterNavigate(this.props.history, `/edit/${encodeURIComponent(username)}`)}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

question: how do you feel about doing the same for the role name in Roles Grid? I see we don't do encoding there. I know Kibana UI doesn't allow creating roles with such names, but ES API does. At least I managed to create role with such a name using Kibana DevTools and it broke our UI:

POST /_security/role/my_admin%25role
{
  "cluster": ["all"],
  "indices": [
    {
      "names": [ "index1", "index2" ],
      "privileges": ["all"]
    }
  ],
  "applications": [
    {
      "application": "myapp",
      "privileges": [ "admin", "read" ],
      "resources": [ "*" ]
    }
  ]
}

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great idea, will do!

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done in 13be3a0 (#81562)

>
{username}
</EuiLink>
Expand Down