adds consumer / owner field to alerts created by rule registry #11

dhurley14 · 2021-05-05T22:11:20Z

Summary

adds consumer / owner field to alerts created by rule registry

Check out the

Checklist

Delete any items that are not applicable to this PR.

For maintainers

This was checked for breaking API changes and was labeled appropriately

dhurley14 · 2021-05-05T22:16:59Z

x-pack/plugins/rule_registry/common/field_map/base_rule_field_map.ts

@@ -28,6 +28,7 @@ export const baseRuleFieldMap = {
  'kibana.rac.alert.severity.level': { type: 'keyword' },
  'kibana.rac.alert.severity.value': { type: 'long' },
  'kibana.rac.alert.status': { type: 'keyword' },
+  'kibana.rac.alert.owner': { type: 'keyword' },


adding owner to the alerts as data index mapping

dhurley14 · 2021-05-05T22:18:03Z

...s/rule_registry/server/rule_registry/rule_type_helpers/create_lifecycle_rule_type_factory.ts

+        const so = await options.services.savedObjectsClient.get<AlertAttributes>(
+          'alert',
+          rule.uuid
+        );
+
+        console.error('RULE REGISTRY CONSUMER', so.attributes.consumer);


Currently the consumer field is not available via params in the executor so we have to query for the rule and then acquire the consumer off of the rule's saved object attributes.

ref: elastic#98935 (comment)

dhurley14 · 2021-05-05T22:18:18Z

...s/rule_registry/server/rule_registry/rule_type_helpers/create_lifecycle_rule_type_factory.ts

@@ -169,7 +176,7 @@ export function createLifecycleRuleTypeFactory(): CreateLifecycleRuleType<BaseRu
              '@timestamp': timestamp,
              'event.kind': 'state',
              'kibana.rac.alert.id': alertId,
-              // 'owner': ''
+              'kibana.rac.alert.owner': so.attributes.consumer,


adding the consumer as the owner field on the alert here.

dhurley14 · 2021-05-05T22:18:48Z

x-pack/plugins/rule_registry/server/types.ts

+export interface AlertAttributes<T extends RuleParams = RuleParams> {
+  // actions: RuleAlertAction[];
+  consumer: string;
+  enabled: boolean;
+  name: string;
+  tags: string[];
+  createdBy: string;
+  createdAt: string;
+  updatedBy: string;
+  schedule: {
+    interval: string;
+  };
+  throttle: string;
+  params: T;
+}


typing out the rule attributes from the saved object, used when querying for the rule SO to acquire the consumer.

dhurley14 · 2021-05-05T22:19:33Z

x-pack/plugins/security_solution/server/lib/detection_engine/signals/build_signal.ts

@@ -80,7 +80,7 @@ export const removeClashes = (doc: BaseSignalHit): BaseSignalHit => {
 export const buildSignal = (
  docs: BaseSignalHit[],
  rule: RulesSchema,
-  owner: typeof SERVER_APP_ID
+  owner: string // typeof SERVER_APP_ID


increasing scope of this type to string since it is possible something else could be the consumer of a siem rule.

dhurley14 · 2021-05-05T22:20:05Z

x-pack/plugins/security_solution/server/lib/detection_engine/signals/types.ts

@@ -227,6 +227,7 @@ export interface SignalHit {

 export interface AlertAttributes<T extends RuleParams = RuleParams> {
  actions: RuleAlertAction[];
+  consumer: string;


exposing the consumer field from the rule SO attributes in the type here.

yctercero

LGTM - this is awesome, thanks Devin.

WIP - trying to fix integration tests, broken authz for observer user / role updates authz feature builder to what ying had before we messed it up in our branch fixes integration tests add rac api access to apm adds getIndex functionality which requires the asset name to be passed in, same style as in the rule registry data client, adds update integration tests fix small merge conflict and update shell script fix merge conflict in alerting test file fix most type errors fix the rest of the type failures fix integration tests fix integration tests fix type error with feature registration in apm fix integration tests in apm and security solution fix type checker fix jest tests for apm remove console.error statements for eslint fix type check update security solution jest tests cleaning up PR and adding basic unit tests still need to clean up types in tests and update one test file fixes snapshot for signals template fix tests fix type check failures update cypress test undo changes in alert authz class, updates alert privilege in apm feature to 'read', utilizes the 'rule' object available in executor params over querying for the rule SO directly remove verbose logging from detection api integration tests fix type fix jest tests, adds missing mocked rule object to alert executor params [RAC] [RBAC] adds function to get alerts-as-data index name (#6) * WIP - test script and route in rule registry to pull index name. I need to test out adding this route within the APM and sec sol plugins specifically and see if they spit back the same .alerts index but with the appropriate asset name despite not providing one. WIP - DO NOT DELETE THIS CODE minor cleanup updates client to require passing in index name, which is now available through the alerts as data client function getAlertsIndex fix types * remove outdated comment update README, adds integration test (skipped) for testing authz with search strategy (#8) * WIP * update README, adds integration test (skipped) for testing authz with search strategy * fix rebase issues * adds typedoc docs * adds SKIPPED integration test for timeline search strategy to be unskipped once authorization is added to search strategy * removes unused references to the rule data client within the rule registry squashed commit (#11) * clean up commented out code, update PR per initial comments * introduce index param to get route again, allowing user to specify index to search * updating feature privileges UI to allow user to have all, read, none on alerts Co-authored-by: Yara Tercero <[email protected]>

WIP - trying to fix integration tests, broken authz for observer user / role updates authz feature builder to what ying had before we messed it up in our branch fixes integration tests add rac api access to apm adds getIndex functionality which requires the asset name to be passed in, same style as in the rule registry data client, adds update integration tests fix small merge conflict and update shell script fix merge conflict in alerting test file fix most type errors fix the rest of the type failures fix integration tests fix integration tests fix type error with feature registration in apm fix integration tests in apm and security solution fix type checker fix jest tests for apm remove console.error statements for eslint fix type check update security solution jest tests cleaning up PR and adding basic unit tests still need to clean up types in tests and update one test file fixes snapshot for signals template fix tests fix type check failures update cypress test undo changes in alert authz class, updates alert privilege in apm feature to 'read', utilizes the 'rule' object available in executor params over querying for the rule SO directly remove verbose logging from detection api integration tests fix type fix jest tests, adds missing mocked rule object to alert executor params [RAC] [RBAC] adds function to get alerts-as-data index name (#6) * WIP - test script and route in rule registry to pull index name. I need to test out adding this route within the APM and sec sol plugins specifically and see if they spit back the same .alerts index but with the appropriate asset name despite not providing one. WIP - DO NOT DELETE THIS CODE minor cleanup updates client to require passing in index name, which is now available through the alerts as data client function getAlertsIndex fix types * remove outdated comment update README, adds integration test (skipped) for testing authz with search strategy (#8) * WIP * update README, adds integration test (skipped) for testing authz with search strategy * fix rebase issues * adds typedoc docs * adds SKIPPED integration test for timeline search strategy to be unskipped once authorization is added to search strategy * removes unused references to the rule data client within the rule registry squashed commit (#11) * clean up commented out code, update PR per initial comments * introduce index param to get route again, allowing user to specify index to search * updating feature privileges UI to allow user to have all, read, none on alerts Co-authored-by: Yara Tercero <[email protected]> update tests WIP - updated shell scripts fixes scripts fix update route indexName -> index Merge pull request #12 from yctercero/rbac_update_tests Updates tests that were previously failing and addresses some feedback.

adds consumer / owner field to alerts created by rule registry

e8c05ad

dhurley14 commented May 5, 2021

View reviewed changes

dhurley14 changed the title ~~adding alerts actions to security plugin~~ adds consumer / owner field to alerts created by rule registry May 5, 2021

dhurley14 marked this pull request as ready for review May 5, 2021 22:24

dhurley14 self-assigned this May 5, 2021

yctercero approved these changes May 6, 2021

View reviewed changes

dhurley14 merged commit 68dc7d1 into yctercero:rac_rbac_poc May 6, 2021

dhurley14 deleted the create-alerts-rule-registry branch May 6, 2021 02:25

dhurley14 added a commit that referenced this pull request May 12, 2021

adds consumer / owner field to alerts created by rule registry (#11)

87ac3e9

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

adds consumer / owner field to alerts created by rule registry #11

adds consumer / owner field to alerts created by rule registry #11

dhurley14 commented May 5, 2021 •

edited

Loading

dhurley14 May 5, 2021

dhurley14 May 5, 2021

dhurley14 May 5, 2021

dhurley14 May 5, 2021

dhurley14 May 5, 2021

dhurley14 May 5, 2021

yctercero left a comment

adds consumer / owner field to alerts created by rule registry #11

adds consumer / owner field to alerts created by rule registry #11

Conversation

dhurley14 commented May 5, 2021 • edited Loading

Summary

Checklist

For maintainers

dhurley14 May 5, 2021

Choose a reason for hiding this comment

dhurley14 May 5, 2021

Choose a reason for hiding this comment

dhurley14 May 5, 2021

Choose a reason for hiding this comment

dhurley14 May 5, 2021

Choose a reason for hiding this comment

dhurley14 May 5, 2021

Choose a reason for hiding this comment

dhurley14 May 5, 2021

Choose a reason for hiding this comment

yctercero left a comment

Choose a reason for hiding this comment

dhurley14 commented May 5, 2021 •

edited

Loading