[ML] Changing all calls to ML endpoints to use internal user (#70487)

* [ML] Changing all calls to ML endpoints to use internal user * updating alerting * updating documentation * [ML] Changing all calls to ML endpoints to use internal user * updating alerting * updating documentation * fixing missed types * adding authorization headers to endpoint calls * correcting has privileges call * updating security tests * odd eslint error * adding auth header to module setup * fixing missing auth argument * fixing delete DFA job permission checks * removing debug test tag * removing additional ml privilege checks * adding authorization header to _evaluate * updating alerting cluster client name * code clean up * changing authorizationHeader name * updating alterting documentation * fixing secondary credentials * adding management links * updating SIEM telemetry * fixing merge conflicts * granting access to index patterns Co-authored-by: Elastic Machine <[email protected]>
elastic · Jul 14, 2020 · a1e511a · a1e511a
1 parent 67f466a
commit a1e511a
Show file tree

Hide file tree

Showing 99 changed files with 965 additions and 972 deletions.
diff --git a/x-pack/plugins/actions/README.md b/x-pack/plugins/actions/README.md
@@ -160,7 +160,7 @@ This is the primary function for an action type. Whenever the action needs to ex
 | config                                  | The decrypted configuration given to an action. This comes from the action saved object that is partially or fully encrypted within the data store. If you would like to validate the config before being passed to the executor, define `validate.config` within the action type.                                                              |
 | params                                  | Parameters for the execution. These will be given at execution time by either an alert or manually provided when calling the plugin provided execute function.                                                                                                                                                                                  |
 | services.callCluster(path, opts)        | Use this to do Elasticsearch queries on the cluster Kibana connects to. This function is the same as any other `callCluster` in Kibana but runs in the context of the user who is calling the action when security is enabled.                                                                                                                  |
-| services.getScopedCallCluster           | This function scopes an instance of CallCluster by returning a `callCluster(path, opts)` function that runs in the context of the user who is calling the action when security is enabled. This must only be called with instances of CallCluster provided by core.                                                                             |
+| services.getLegacyScopedClusterClient   | This function returns an instance of the LegacyScopedClusterClient scoped to the user who is calling the action when security is enabled.                                                                                                                                                                                                       |
 | services.savedObjectsClient             | This is an instance of the saved objects client. This provides the ability to do CRUD on any saved objects within the same space the alert lives in.<br><br>The scope of the saved objects client is tied to the user in context calling the execute API or the API key provided to the execute plugin function (only when security isenabled). |
 | services.log(tags, [data], [timestamp]) | Use this to create server logs. (This is the same function as server.log)                                                                                                                                                                                                                                                                       |
 

diff --git a/x-pack/plugins/actions/server/mocks.ts b/x-pack/plugins/actions/server/mocks.ts
@@ -38,7 +38,7 @@ const createServicesMock = () => {
     }
   > = {
     callCluster: elasticsearchServiceMock.createLegacyScopedClusterClient().callAsCurrentUser,
-    getScopedCallCluster: jest.fn(),
+    getLegacyScopedClusterClient: jest.fn(),
     savedObjectsClient: savedObjectsClientMock.create(),
   };
   return mock;

diff --git a/x-pack/plugins/actions/server/plugin.ts b/x-pack/plugins/actions/server/plugin.ts
@@ -307,8 +307,8 @@ export class ActionsPlugin implements Plugin<Promise<PluginSetupContract>, Plugi
     return (request) => ({
       callCluster: elasticsearch.legacy.client.asScoped(request).callAsCurrentUser,
       savedObjectsClient: getScopedClient(request),
-      getScopedCallCluster(clusterClient: ILegacyClusterClient) {
-        return clusterClient.asScoped(request).callAsCurrentUser;
+      getLegacyScopedClusterClient(clusterClient: ILegacyClusterClient) {
+        return clusterClient.asScoped(request);
       },
     });
   }

diff --git a/x-pack/plugins/actions/server/types.ts b/x-pack/plugins/actions/server/types.ts
@@ -25,9 +25,7 @@ export type SpaceIdToNamespaceFunction = (spaceId?: string) => string | undefine
 export interface Services {
   callCluster: ILegacyScopedClusterClient['callAsCurrentUser'];
   savedObjectsClient: SavedObjectsClientContract;
-  getScopedCallCluster(
-    clusterClient: ILegacyClusterClient
-  ): ILegacyScopedClusterClient['callAsCurrentUser'];
+  getLegacyScopedClusterClient(clusterClient: ILegacyClusterClient): ILegacyScopedClusterClient;
 }
 
 declare module 'src/core/server' {

diff --git a/x-pack/plugins/alerts/README.md b/x-pack/plugins/alerts/README.md
@@ -103,7 +103,7 @@ This is the primary function for an alert type. Whenever the alert needs to exec
 |---|---|
 |services.callCluster(path, opts)|Use this to do Elasticsearch queries on the cluster Kibana connects to. This function is the same as any other `callCluster` in Kibana but in the context of the user who created the alert when security is enabled.|
 |services.savedObjectsClient|This is an instance of the saved objects client. This provides the ability to do CRUD on any saved objects within the same space the alert lives in.<br><br>The scope of the saved objects client is tied to the user who created the alert (only when security isenabled).|
-|services.getScopedCallCluster|This function scopes an instance of CallCluster by returning a `callCluster(path, opts)` function that runs in the context of the user who created the alert when security is enabled. This must only be called with instances of CallCluster provided by core.|
+|services.getLegacyScopedClusterClient|This function returns an instance of the LegacyScopedClusterClient scoped to the user who created the alert when security is enabled.|
 |services.alertInstanceFactory(id)|This [alert instance factory](#alert-instance-factory) creates instances of alerts and must be used in order to execute actions. The id you give to the alert instance factory is a unique identifier to the alert instance.|
 |services.log(tags, [data], [timestamp])|Use this to create server logs. (This is the same function as server.log)|
 |startedAt|The date and time the alert type started execution.|

diff --git a/x-pack/plugins/alerts/server/mocks.ts b/x-pack/plugins/alerts/server/mocks.ts
@@ -59,7 +59,7 @@ const createAlertServicesMock = () => {
       .fn<jest.Mocked<AlertInstance>, [string]>()
       .mockReturnValue(alertInstanceFactoryMock),
     callCluster: elasticsearchServiceMock.createLegacyScopedClusterClient().callAsCurrentUser,
-    getScopedCallCluster: jest.fn(),
+    getLegacyScopedClusterClient: jest.fn(),
     savedObjectsClient: savedObjectsClientMock.create(),
   };
 };

diff --git a/x-pack/plugins/alerts/server/plugin.ts b/x-pack/plugins/alerts/server/plugin.ts
@@ -273,8 +273,8 @@ export class AlertingPlugin {
     return (request) => ({
       callCluster: elasticsearch.legacy.client.asScoped(request).callAsCurrentUser,
       savedObjectsClient: this.getScopedClientWithAlertSavedObjectType(savedObjects, request),
-      getScopedCallCluster(clusterClient: ILegacyClusterClient) {
-        return clusterClient.asScoped(request).callAsCurrentUser;
+      getLegacyScopedClusterClient(clusterClient: ILegacyClusterClient) {
+        return clusterClient.asScoped(request);
       },
     });
   }

diff --git a/x-pack/plugins/alerts/server/types.ts b/x-pack/plugins/alerts/server/types.ts
@@ -40,9 +40,7 @@ declare module 'src/core/server' {
 export interface Services {
   callCluster: ILegacyScopedClusterClient['callAsCurrentUser'];
   savedObjectsClient: SavedObjectsClientContract;
-  getScopedCallCluster(
-    clusterClient: ILegacyClusterClient
-  ): ILegacyScopedClusterClient['callAsCurrentUser'];
+  getLegacyScopedClusterClient(clusterClient: ILegacyClusterClient): ILegacyScopedClusterClient;
 }
 
 export interface AlertServices extends Services {

diff --git a/x-pack/plugins/apm/server/lib/helpers/setup_request.ts b/x-pack/plugins/apm/server/lib/helpers/setup_request.ts
@@ -112,7 +112,7 @@ function getMlSetup(context: APMRequestHandlerContext, request: KibanaRequest) {
     return;
   }
   const ml = context.plugins.ml;
-  const mlClient = ml.mlClient.asScoped(request).callAsCurrentUser;
+  const mlClient = ml.mlClient.asScoped(request);
   return {
     mlSystem: ml.mlSystemProvider(mlClient, request),
     anomalyDetectors: ml.anomalyDetectorsProvider(mlClient, request),

diff --git a/x-pack/plugins/infra/server/plugin.ts b/x-pack/plugins/infra/server/plugin.ts
@@ -152,12 +152,9 @@ export class InfraServerPlugin {
     core.http.registerRouteHandlerContext(
       'infra',
       (context, request): InfraRequestHandlerContext => {
-        const mlSystem =
-          context.ml &&
-          plugins.ml?.mlSystemProvider(context.ml?.mlClient.callAsCurrentUser, request);
+        const mlSystem = context.ml && plugins.ml?.mlSystemProvider(context.ml?.mlClient, request);
         const mlAnomalyDetectors =
-          context.ml &&
-          plugins.ml?.anomalyDetectorsProvider(context.ml?.mlClient.callAsCurrentUser, request);
+          context.ml && plugins.ml?.anomalyDetectorsProvider(context.ml?.mlClient, request);
         const spaceId = plugins.spaces?.spacesService.getSpaceId(request) || 'default';
 
         return {

diff --git a/x-pack/plugins/ml/common/types/capabilities.ts b/x-pack/plugins/ml/common/types/capabilities.ts
@@ -5,6 +5,7 @@
  */
 
 import { KibanaRequest } from 'kibana/server';
+import { PLUGIN_ID } from '../constants/app';
 
 export const userMlCapabilities = {
   canAccessML: false,
@@ -69,16 +70,31 @@ export function getDefaultCapabilities(): MlCapabilities {
 export function getPluginPrivileges() {
   const userMlCapabilitiesKeys = Object.keys(userMlCapabilities);
   const adminMlCapabilitiesKeys = Object.keys(adminMlCapabilities);
-  const allMlCapabilities = [...adminMlCapabilitiesKeys, ...userMlCapabilitiesKeys];
+  const allMlCapabilitiesKeys = [...adminMlCapabilitiesKeys, ...userMlCapabilitiesKeys];
+  // TODO: include ML in base privileges for the `8.0` release: https://github.com/elastic/kibana/issues/71422
+  const privilege = {
+    app: [PLUGIN_ID, 'kibana'],
+    excludeFromBasePrivileges: true,
+    management: {
+      insightsAndAlerting: ['jobsListLink'],
+    },
+    catalogue: [PLUGIN_ID],
+    savedObject: {
+      all: [],
+      read: ['index-pattern', 'search'],
+    },
+  };
 
   return {
+    admin: {
+      ...privilege,
+      api: allMlCapabilitiesKeys.map((k) => `ml:${k}`),
+      ui: allMlCapabilitiesKeys,
+    },
     user: {
-      ui: userMlCapabilitiesKeys,
+      ...privilege,
       api: userMlCapabilitiesKeys.map((k) => `ml:${k}`),
-    },
-    admin: {
-      ui: allMlCapabilities,
-      api: allMlCapabilities.map((k) => `ml:${k}`),
+      ui: userMlCapabilitiesKeys,
     },
   };
 }

diff --git a/x-pack/plugins/ml/common/types/kibana.ts b/x-pack/plugins/ml/common/types/kibana.ts
@@ -11,8 +11,6 @@ import { IndexPatternAttributes } from 'src/plugins/data/common';
 
 export type IndexPatternTitle = string;
 
-export type callWithRequestType = (action: string, params?: any) => Promise<any>;
-
 export interface Route {
   id: string;
   k7Breadcrumbs: () => any;

diff --git a/x-pack/plugins/ml/jsconfig.json b/x-pack/plugins/ml/jsconfig.json
diff --git a/x-pack/plugins/ml/public/application/capabilities/check_capabilities.ts b/x-pack/plugins/ml/public/application/capabilities/check_capabilities.ts
@@ -16,8 +16,8 @@ let _capabilities: MlCapabilities = getDefaultCapabilities();
 
 export function checkGetManagementMlJobsResolver() {
   return new Promise<{ mlFeatureEnabledInSpace: boolean }>((resolve, reject) => {
-    getManageMlCapabilities().then(
-      ({ capabilities, isPlatinumOrTrialLicense, mlFeatureEnabledInSpace }) => {
+    getManageMlCapabilities()
+      .then(({ capabilities, isPlatinumOrTrialLicense, mlFeatureEnabledInSpace }) => {
         _capabilities = capabilities;
         // Loop through all capabilities to ensure they are all set to true.
         const isManageML = Object.values(_capabilities).every((p) => p === true);
@@ -28,62 +28,80 @@ export function checkGetManagementMlJobsResolver() {
           window.location.href = ACCESS_DENIED_PATH;
           return reject();
         }
-      }
-    );
+      })
+      .catch((e) => {
+        window.location.href = ACCESS_DENIED_PATH;
+        return reject();
+      });
   });
 }
 
 export function checkGetJobsCapabilitiesResolver(): Promise<MlCapabilities> {
   return new Promise((resolve, reject) => {
-    getCapabilities().then(({ capabilities, isPlatinumOrTrialLicense }) => {
-      _capabilities = capabilities;
-      // the minimum privilege for using ML with a platinum or trial license is being able to get the transforms list.
-      // all other functionality is controlled by the return capabilities object.
-      // if the license is basic (isPlatinumOrTrialLicense === false) then do not redirect,
-      // allow the promise to resolve as the separate license check will redirect then user to
-      // a basic feature
-      if (_capabilities.canGetJobs || isPlatinumOrTrialLicense === false) {
-        return resolve(_capabilities);
-      } else {
+    getCapabilities()
+      .then(({ capabilities, isPlatinumOrTrialLicense }) => {
+        _capabilities = capabilities;
+        // the minimum privilege for using ML with a platinum or trial license is being able to get the transforms list.
+        // all other functionality is controlled by the return capabilities object.
+        // if the license is basic (isPlatinumOrTrialLicense === false) then do not redirect,
+        // allow the promise to resolve as the separate license check will redirect then user to
+        // a basic feature
+        if (_capabilities.canGetJobs || isPlatinumOrTrialLicense === false) {
+          return resolve(_capabilities);
+        } else {
+          window.location.href = '#/access-denied';
+          return reject();
+        }
+      })
+      .catch((e) => {
         window.location.href = '#/access-denied';
         return reject();
-      }
-    });
+      });
   });
 }
 
 export function checkCreateJobsCapabilitiesResolver(): Promise<MlCapabilities> {
   return new Promise((resolve, reject) => {
-    getCapabilities().then(({ capabilities, isPlatinumOrTrialLicense }) => {
-      _capabilities = capabilities;
-      // if the license is basic (isPlatinumOrTrialLicense === false) then do not redirect,
-      // allow the promise to resolve as the separate license check will redirect then user to
-      // a basic feature
-      if (_capabilities.canCreateJob || isPlatinumOrTrialLicense === false) {
-        return resolve(_capabilities);
-      } else {
-        // if the user has no permission to create a job,
-        // redirect them back to the Transforms Management page
+    getCapabilities()
+      .then(({ capabilities, isPlatinumOrTrialLicense }) => {
+        _capabilities = capabilities;
+        // if the license is basic (isPlatinumOrTrialLicense === false) then do not redirect,
+        // allow the promise to resolve as the separate license check will redirect then user to
+        // a basic feature
+        if (_capabilities.canCreateJob || isPlatinumOrTrialLicense === false) {
+          return resolve(_capabilities);
+        } else {
+          // if the user has no permission to create a job,
+          // redirect them back to the Transforms Management page
+          window.location.href = '#/jobs';
+          return reject();
+        }
+      })
+      .catch((e) => {
         window.location.href = '#/jobs';
         return reject();
-      }
-    });
+      });
   });
 }
 
 export function checkFindFileStructurePrivilegeResolver(): Promise<MlCapabilities> {
   return new Promise((resolve, reject) => {
-    getCapabilities().then(({ capabilities }) => {
-      _capabilities = capabilities;
-      // the minimum privilege for using ML with a basic license is being able to use the datavisualizer.
-      // all other functionality is controlled by the return _capabilities object
-      if (_capabilities.canFindFileStructure) {
-        return resolve(_capabilities);
-      } else {
+    getCapabilities()
+      .then(({ capabilities }) => {
+        _capabilities = capabilities;
+        // the minimum privilege for using ML with a basic license is being able to use the datavisualizer.
+        // all other functionality is controlled by the return _capabilities object
+        if (_capabilities.canFindFileStructure) {
+          return resolve(_capabilities);
+        } else {
+          window.location.href = '#/access-denied';
+          return reject();
+        }
+      })
+      .catch((e) => {
         window.location.href = '#/access-denied';
         return reject();
-      }
-    });
+      });
   });
 }
 

diff --git a/x-pack/plugins/ml/public/application/services/new_job_capabilities_service.ts b/x-pack/plugins/ml/public/application/services/new_job_capabilities_service.ts
@@ -20,7 +20,7 @@ import {
 import { ml } from './ml_api_service';
 import { getIndexPatternAndSavedSearch } from '../util/index_utils';
 
-// called in the angular routing resolve block to initialize the
+// called in the routing resolve block to initialize the
 // newJobCapsService with the currently selected index pattern
 export function loadNewJobCapabilities(
   indexPatternId: string,