[Serverless][Security Solution][Endpoint] Gate endpoint exceptions on rule details and API changes

[ashokaditya]

What this PR changes

Follow up of /pull/164107/

For serverless ES/Kibana, it gates exception list API for endpoint exceptions and restricts endpoint exceptions tab on Endpoint Security rule details based on project PLIs. If no endpoint PLIs, endpoint exceptions should not be accessible.

• Add upselling to app/security/exceptions/details/endpoint_list page
• Tests (WIP) - in a follow up PR

How to review

Best to follow along commits for a code review. Below are details to manually test the changes.

• Setup for Servlerless
  • Run yarn es serverless --kill --clean --license trial -E xpack.security.authc.api_key.enabled=true on a terminal window to start ES.
  • Copy config/serverless.security.yml to config/serverless.security.dev.yml
  • Run yarn serverless-security --no-base-path on another terminal window to start kibana in serverless mode
  • Log in using serverless_security user.

Tests (Serverless)

This needs to be tested with a custom user/role and not elastic_serverless which has superuser role.

1. PLI configs

{ product_line: 'security', product_tier: 'essentials' } or { product_line: 'security', product_tier: 'complete' }
and
{ product_line: 'endpoint', product_tier: 'essentials' } or { product_line: 'endpoint', product_tier: 'complete' }

• UX

  1. Navigate to Rules via http://localhost:5601/app/security/rules/. Click on Add Elastic rules.
  2. Select and add Endpoint Security rule.
  3. Click Endpoint Security and navigate to the rules details page, and you should see Endpoint exceptions tab. The tabs visible are Alerts, Endpoint exceptions, Rule exceptions, Execution results.
  4. Navigate to Rules>Shared Exception Lists > Endpoint Security Exception List via app/security/exceptions/details/endpoint_list and you should be able to see the page with any added endpoint exceptions.

• API requests (with user serverless_security)

  1. should get a status 200 onPOST api/exception_lists/items
  2. should get a status 200 on POST api/exception_lists/_export?id=endpoint_list&list_id=endpoint_list&namespace_type=agnostic&include_expired_exceptions=true
  3. should get a status 200 on PUT api/exception_lists/items
  4. should get a status 200 on DELETE api/exception_lists/items
  5. should get a status 200 on GET api/exception_lists/items/_find?list_id=endpoint_list&namespace_type=agnostic

2. PLI configs

{ product_line: 'security', product_tier: 'essentials' } or { product_line: 'security', product_tier: 'complete' }

• UX

  1. Navigate to Rules via http://localhost:5601/app/security/rules/. Click on Add Elastic rules.
  2. Select and add Endpoint Security rule.
  3. Click Endpoint Security and navigate to the rules details page, and you should not see Endpoint exceptions tab. The only tabs visible are Alerts, Rule exceptions, Execution results.
     
  4. Navigate to Rules>Shared Exception Lists > Endpoint Security Exception List via app/security/exceptions/details/endpoint_list and you should see an upsell message.
     

• API requests

  1. should get a status 403 onPOST api/exception_lists/items
  2. should get a status 403 on POST api/exception_lists/_export?id=endpoint_list&list_id=endpoint_list&namespace_type=agnostic&include_expired_exceptions=true
  3. should get a status 403 on PUT api/exception_lists/items
  4. should get a status 403 on DELETE api/exception_lists/items
  5. should get a status 403 on GET api/exception_lists/items/_find?list_id=endpoint_list&namespace_type=agnostic

---

Flaky FTRs
https://buildkite.com/elastic/kibana-flaky-test-suite-runner/builds/3248
https://buildkite.com/elastic/kibana-flaky-test-suite-runner/builds/3255

Checklist

• Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
• Unit or functional tests were updated or added to match the most common scenarios
• Any UI touched in this PR does not create any new axe failures (run axe in browser: FF, Chrome)
• If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the docker list
• This renders correctly on smaller devices using a responsive layout. (You can test this in your browser)
• This was checked for cross-browser compatibility

Risk Matrix

Delete this section if it is not applicable to this PR.

Before closing this PR, invite QA, stakeholders, and other developers to identify risks that should be tested prior to the change/feature release.

When forming the risk matrix, consider some of the following examples and how they may potentially impact the change:

Risk	Probability	Severity	Mitigation/Notes
Multiple Spaces—unexpected behavior in non-default Kibana Space.	Low	High	Integration tests will verify that all features are still supported in non-default Kibana Space and when user switches between spaces.
Multiple nodes—Elasticsearch polling might have race conditions when multiple Kibana nodes are polling for the same tasks.	High	Low	Tasks are idempotent, so executing them multiple times will not result in logical error, but will degrade performance. To test for this case we add plenty of unit tests around this logic and document manual testing procedure.
Code should gracefully handle cases when feature X or plugin Y are disabled.	Medium	High	Unit tests will verify that any feature flag or plugin combination still results in our service operational.
See more potential risk examples

For maintainers

• This was checked for breaking API changes and was labeled appropriately

[ashokaditya]

@elasticmachin a merge upstream

[banderror]

Hey @ashokaditya, thank you for implementing these PLI checks. From the Rule Management side, we don't really own the exceptions functionality, so I was primarily looking into the diff and overall code of the Rule Details page. I have a few suggestions for relatively simple refactoring that could improve code ownership for endpoint exceptions.

I will do some basic testing based on the PR description, thank you for providing these instructions.

[banderror]

I did some testing of the changes on the Rule Details page and it LGTM 👍

@ashokaditya I wasn't able to run Serverless Kibana using the provided instructions in the description. That's probably my lack of knowledge of how to run Kibana in Serverless. I had to comment out everything in kibana.dev.yml and log in as elastic_serverless. How do we login as serverless_security?

The Endpoint exceptions tab on the Rule Details page worked fine with the following config:

xpack.securitySolutionServerless.productTypes:
  [
    { product_line: 'security', product_tier: 'complete' },
    # { product_line: 'endpoint', product_tier: 'complete' },
  ]

I was able to open this "tab" using its direct URL, but it showed that I should upgrade to Endpoint Essentials. The tab itself was hidden 👍

Nit: the UI is slightly different for the endpoint list page

[ashokaditya]

Thanks for the review @banderror. I've managed to refactor as you suggested. Here are some thoughts on testing locally.

I did some testing of the changes on the Rule Details page and it LGTM 👍

@ashokaditya I wasn't able to run Serverless Kibana using the provided instructions in the description. That's probably my lack of knowledge of how to run Kibana in Serverless. I had to comment out everything in kibana.dev.yml and log in as elastic_serverless. How do we login as serverless_security?

You tested it the correct way @banderror. elastic_serverless is actually superuser so one needs to test APIs with custom user/roles (which is still being worked on by the core team to allow devs to do this easily).

For now, I'm testing this locally by

1. Running ES snapshot/ESS kibana,
2. Add Endpoint Security rule
3. Add some endpoint exceptions using exception_list API with elastic:changeme,
4. Creating roles/users using APIs (PUT api/security/role/:rolename, POST /internal/security/users/:username) and then, while the ES snapshot is running,
5. I switch to serverless kibana with yarn serverless-security --no-base-path and the log in with the created custom user(with the custom role).

Note: To be able to do the above switch one also needs to comment out this block

I know this is tedious for manual testing, but it works reliably for now. Feel free to try it out if you like.

The Endpoint exceptions tab on the Rule Details page worked fine with the following config:

xpack.securitySolutionServerless.productTypes:
  [
    { product_line: 'security', product_tier: 'complete' },
    # { product_line: 'endpoint', product_tier: 'complete' },
  ]

Superb 👍🏼.

I was able to open this "tab" using its direct URL, but it showed that I should upgrade to Endpoint Essentials. The tab itself was hidden 👍

Excellent. This is expected.

Nit: the UI is slightly different for the endpoint list page

Quite right! We will update this later along with the text info. These changes only affect the serverless UX anyway.

[banderror]

Thank you for addressing my comments @ashokaditya, LGTM 👍

[kibana-ci]

💚 Build Succeeded

• Buildkite Build
• Commit: c3eca1a

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
securitySolution	4604	4607	+3
securitySolutionServerless	436	438	+2
total			+5

Public APIs missing comments

Total count of every public API that lacks a comment. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats comments for more detailed information.

id	before	after	diff
fleet	1082	1083	+1

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id	before	after	diff
securitySolution	13.0MB	13.0MB	+2.3KB
securitySolutionServerless	290.0KB	304.7KB	+14.7KB
total			+16.9KB

Public APIs missing exports

Total count of every type that is part of your API that should be exported but is not. This will cause broken links in the API documentation system. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats exports for more detailed information.

id	before	after	diff
fleet	41	42	+1

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id	before	after	diff
fleet	146.3KB	146.7KB	+451.0B
securitySolutionServerless	42.1KB	42.5KB	+410.0B
total			+861.0B

Unknown metric groups

API count

id	before	after	diff
fleet	1200	1201	+1

async chunk count

id	before	after	diff
securitySolutionServerless	45	47	+2

ESLint disabled line counts

id	before	after	diff
securitySolutionServerless	39	40	+1

Total ESLint disabled count

id	before	after	diff
securitySolutionServerless	39	40	+1

History

• 💔 Build #164457 failed fdaf8bb
• 💔 Build #164346 failed 67cfaf1
• 💔 Build #164324 failed 6ea0aaf
• 💔 Build #164291 failed 864e4ed
• 💛 Build #164222 was flaky 71050df
• 💛 Build #164141 was flaky 35d0a11

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

cc @ashokaditya