Hide management sections based on cluster/index privileges

.github/CODEOWNERS

@@ -174,6 +174,7 @@
 /x-pack/plugins/security/ @elastic/kibana-security
 /x-pack/plugins/security/**/*.scss @elastic/kibana-core-ui-designers
 /x-pack/test/api_integration/apis/security/ @elastic/kibana-security
+/x-pack/test/ui_capabilities/ @elastic/kibana-security
 
 # Kibana Localization
 /src/dev/i18n/ @elastic/kibana-localization

examples/alerting_example/server/plugin.ts

@@ -38,7 +38,7 @@ export class AlertingExamplePlugin implements Plugin<void, void, AlertingExample
  alerts.registerType(alwaysFiringAlert);
  alerts.registerType(peopleInSpaceAlert);
 
- features.registerFeature({
+ features.registerKibanaFeature({
  id: ALERTING_EXAMPLE_APP_ID,
  name: i18n.translate('alertsExample.featureRegistry.alertsExampleFeatureName', {
  defaultMessage: 'Alerts Example',

src/core/MIGRATION.md

@@ -1284,7 +1284,7 @@ _See also: [Server's CoreSetup API Docs](/docs/development/core/server/kibana-pl
 
 | Legacy Platform | New Platform | Notes |
 | ---------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ | ----- |
-| `server.plugins.xpack_main.registerFeature` | [`plugins.features.registerFeature`](x-pack/plugins/features/server/plugin.ts) | |
+| `server.plugins.xpack_main.registerFeature` | [`plugins.features.registerKibanaFeature`](x-pack/plugins/features/server/plugin.ts) | |
 | `server.plugins.xpack_main.feature(pluginID).registerLicenseCheckResultsGenerator` | [`x-pack licensing plugin`](/x-pack/plugins/licensing/README.md) | |
 
 #### UI Exports

src/core/server/capabilities/merge_capabilities.ts

@@ -21,7 +21,7 @@ import { mergeWith } from 'lodash';
 import { Capabilities } from './types';
 
 export const mergeCapabilities = (...sources: Array<Partial<Capabilities>>): Capabilities =>
- mergeWith({}, ...sources, (a: any, b: any) => {
+ mergeWith({}, ...sources, (a: any, b: any, key: any) => {
  if (
  (typeof a === 'boolean' && typeof b === 'object') ||
  (typeof a === 'object' && typeof b === 'boolean')

src/plugins/management/public/plugin.ts

@@ -18,6 +18,7 @@
  */
 
 import { i18n } from '@kbn/i18n';
+import { BehaviorSubject } from 'rxjs';
 import { ManagementSetup, ManagementStart } from './types';
 import { FeatureCatalogueCategory, HomePublicPluginSetup } from '../../home/public';
 import {
@@ -27,6 +28,9 @@ import {
  DEFAULT_APP_CATEGORIES,
  PluginInitializerContext,
  AppMountParameters,
+ AppUpdater,
+ AppStatus,
+ AppNavLinkStatus,
 } from '../../../core/public';
 
 import {
@@ -41,6 +45,8 @@ interface ManagementSetupDependencies {
 export class ManagementPlugin implements Plugin<ManagementSetup, ManagementStart> {
  private readonly managementSections = new ManagementSectionsService();
 
+ private readonly appUpdater = new BehaviorSubject<AppUpdater>(() => ({}));
+
  constructor(private initializerContext: PluginInitializerContext) {}
 
  public setup(core: CoreSetup, { home }: ManagementSetupDependencies) {
@@ -68,6 +74,7 @@ export class ManagementPlugin implements Plugin<ManagementSetup, ManagementStart
  order: 9040,
  euiIconType: 'managementApp',
  category: DEFAULT_APP_CATEGORIES.management,
+ updater$: this.appUpdater,
  async mount(params: AppMountParameters) {
  const { renderApp } = await import('./application');
  const [coreStart] = await core.getStartServices();
@@ -87,6 +94,19 @@ export class ManagementPlugin implements Plugin<ManagementSetup, ManagementStart
 
  public start(core: CoreStart) {
  this.managementSections.start({ capabilities: core.application.capabilities });
+ const hasAnyEnabledApps = getSectionsServiceStartPrivate()
+ .getSectionsEnabled()
+ .some((section) => section.getAppsEnabled().length > 0);
+
+ if (!hasAnyEnabledApps) {
+ this.appUpdater.next(() => {
+ return {
+ status: AppStatus.inaccessible,
+ navLinkStatus: AppNavLinkStatus.hidden,
+ };
+ });
+ }
+
  return {};
  }
 }

test/common/services/security/test_user.ts

@@ -65,9 +65,9 @@ export async function createTestUserService(
  }
 
  return new (class TestUser {
- async restoreDefaults() {
+ async restoreDefaults(shouldRefreshBrowser: boolean = true) {
  if (isEnabled()) {
- await this.setRoles(config.get('security.defaultRoles'));
+ await this.setRoles(config.get('security.defaultRoles'), shouldRefreshBrowser);
  }
  }
 

test/functional/services/index.ts

@@ -42,6 +42,7 @@ import { FilterBarProvider } from './filter_bar';
 import { FlyoutProvider } from './flyout';
 import { GlobalNavProvider } from './global_nav';
 import { InspectorProvider } from './inspector';
+import { ManagementMenuProvider } from './management';
 import { QueryBarProvider } from './query_bar';
 import { RemoteProvider } from './remote';
 import { RenderableProvider } from './renderable';
@@ -91,4 +92,5 @@ export const services = {
  savedQueryManagementComponent: SavedQueryManagementComponentProvider,
  elasticChart: ElasticChartProvider,
  supertest: KibanaSupertestProvider,
+ managementMenu: ManagementMenuProvider,
 };

test/functional/services/management/index.ts

@@ -0,0 +1,20 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+export { ManagementMenuProvider } from './management_menu';

test/functional/services/management/management_menu.ts

@@ -0,0 +1,51 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { FtrProviderContext } from 'test/functional/ftr_provider_context';
+
+export function ManagementMenuProvider({ getService }: FtrProviderContext) {
+ const find = getService('find');
+
+ class ManagementMenu {
+ public async getSections() {
+ const sectionsElements = await find.allByCssSelector(
+ '.mgtSideBarNav > .euiSideNav__content > .euiSideNavItem'
+ );
+
+ const sections = [];
+
+ for (const el of sectionsElements) {
+ const sectionId = await (await el.findByClassName('euiSideNavItemButton')).getAttribute(
+ 'data-test-subj'
+ );
+ const sectionLinks = await Promise.all(
+ (await el.findAllByCssSelector('.euiSideNavItem > a.euiSideNavItemButton')).map((item) =>
+ item.getAttribute('data-test-subj')
+ )
+ );
+
+ sections.push({ sectionId, sectionLinks });
+ }
+
+ return sections;
+ }
+ }
+
+ return new ManagementMenu();
+}

x-pack/plugins/actions/server/authorization/actions_authorization.test.ts

@@ -85,7 +85,9 @@ describe('ensureAuthorized', () => {
  await actionsAuthorization.ensureAuthorized('create', 'myType');
 
  expect(authorization.actions.savedObject.get).toHaveBeenCalledWith('action', 'create');
- expect(checkPrivileges).toHaveBeenCalledWith(mockAuthorizationAction('action', 'create'));
+ expect(checkPrivileges).toHaveBeenCalledWith({
+ kibana: mockAuthorizationAction('action', 'create'),
+ });
 
  expect(auditLogger.actionsAuthorizationSuccess).toHaveBeenCalledTimes(1);
  expect(auditLogger.actionsAuthorizationFailure).not.toHaveBeenCalled();
@@ -131,10 +133,12 @@ describe('ensureAuthorized', () => {
  ACTION_TASK_PARAMS_SAVED_OBJECT_TYPE,
  'create'
  );
- expect(checkPrivileges).toHaveBeenCalledWith([
- mockAuthorizationAction(ACTION_SAVED_OBJECT_TYPE, 'get'),
- mockAuthorizationAction(ACTION_TASK_PARAMS_SAVED_OBJECT_TYPE, 'create'),
- ]);
+ expect(checkPrivileges).toHaveBeenCalledWith({
+ kibana: [
+ mockAuthorizationAction(ACTION_SAVED_OBJECT_TYPE, 'get'),
+ mockAuthorizationAction(ACTION_TASK_PARAMS_SAVED_OBJECT_TYPE, 'create'),
+ ],
+ });
 
  expect(auditLogger.actionsAuthorizationSuccess).toHaveBeenCalledTimes(1);
  expect(auditLogger.actionsAuthorizationFailure).not.toHaveBeenCalled();

x-pack/plugins/actions/server/authorization/actions_authorization.ts

@@ -42,11 +42,11 @@ export class ActionsAuthorization {
  const { authorization } = this;
  if (authorization?.mode?.useRbacForRequest(this.request)) {
  const checkPrivileges = authorization.checkPrivilegesDynamicallyWithRequest(this.request);
- const { hasAllRequested, username } = await checkPrivileges(
- operationAlias[operation]
+ const { hasAllRequested, username } = await checkPrivileges({
+ kibana: operationAlias[operation]
  ? operationAlias[operation](authorization)
- : authorization.actions.savedObject.get(ACTION_SAVED_OBJECT_TYPE, operation)
- );
+ : authorization.actions.savedObject.get(ACTION_SAVED_OBJECT_TYPE, operation),
+ });
  if (hasAllRequested) {
  this.auditLogger.actionsAuthorizationSuccess(username, operation, actionTypeId);
  } else {

x-pack/plugins/actions/server/plugin.ts

@@ -159,7 +159,7 @@ export class ActionsPlugin implements Plugin<Promise<PluginSetupContract>, Plugi
  );
  }
 
- plugins.features.registerFeature(ACTIONS_FEATURE);
+ plugins.features.registerKibanaFeature(ACTIONS_FEATURE);
  setupSavedObjects(core.savedObjects, plugins.encryptedSavedObjects);
 
  this.eventLogService = plugins.eventLog;

x-pack/plugins/alerting_builtins/server/plugin.test.ts

@@ -43,7 +43,7 @@ describe('AlertingBuiltins Plugin', () => {
  "name": "Index threshold",
  }
  `);
- expect(featuresSetup.registerFeature).toHaveBeenCalledWith(BUILT_IN_ALERTS_FEATURE);
+ expect(featuresSetup.registerKibanaFeature).toHaveBeenCalledWith(BUILT_IN_ALERTS_FEATURE);
  });
 
  it('should return a service in the expected shape', async () => {

x-pack/plugins/alerting_builtins/server/plugin.ts

@@ -27,7 +27,7 @@ export class AlertingBuiltinsPlugin implements Plugin<IService, IService> {
  core: CoreSetup,
  { alerts, features }: AlertingBuiltinsDeps
  ): Promise<IService> {
- features.registerFeature(BUILT_IN_ALERTS_FEATURE);
+ features.registerKibanaFeature(BUILT_IN_ALERTS_FEATURE);
 
  registerBuiltInAlertTypes({
  service: this.service,

x-pack/plugins/alerts/README.md

@@ -306,7 +306,7 @@ In addition, when users are inside your feature you might want to grant them acc
 You can control all of these abilities by assigning privileges to the Alerting Framework from within your own feature, for example:
 
 ```typescript
-features.registerFeature({
+features.registerKibanaFeature({
  id: 'my-application-id',
  name: 'My Application',
  app: [],
@@ -348,7 +348,7 @@ In this example we can see the following:
 It's important to note that any role can be granted a mix of `all` and `read` privileges accross multiple type, for example:
 
 ```typescript
-features.registerFeature({
+features.registerKibanaFeature({
  id: 'my-application-id',
  name: 'My Application',
  app: [],