Add API Key Management and Enable Index Sync via Scheduled Task

[CAWilson94]

Summary

This PR adds in API key management and runs plain index sync on task execution. Thanks to @jaredburgettelastic for the below changes 🚀 :

Key Changes

Tasks now call plainIndexSync to sync index users at specified intervals — this is the main functionality change. The following updates support it:

• Added support for scoped API key usage via getClientfromApiKey in the getApiKeyManager
• Using createInternalRepository for API key generation, to allow for internal kibana user to create saved object client.
• API keys now store a snapshot of the user’s privileges by passing {} to role_descriptors.
• Updated the find method in MonitoringEntitySourceDescriptorClient to use a namespace-scoped saved objects client.

Further work, Testing and Review

Testing updates upcoming in #225783
Note: Any other further updates @jeramysoucy should be notified for review (same for testing updates above)

⚠️ Important Note

You must fully restart Elasticsearch and Kibana after pulling these changes to regenerate the API key with the updated privileges.

While taking a privilege snapshot is known to be problematic (e.g., privileges can get out of sync if updated later), it’s a known issue and consistent with the current behavior in the Entity Store. @tiansivive raised 🚀

How to Test:

Steps Taken from #221610

• Pull branch into local machine
• Security experimental flag enable: 'privilegeMonitoringEnabled'
• Start up ElasticSearch and Kibana

1. Optional - create the default index, this should just skip if you don't make it.

POST entity_analytics.privileged_monitoring/_doc
{
  "user": {
    "name": "default name"
  }
}

2. Create test index/ indicies

PUT /tatooine-
{
  "mappings": {
    "properties": {
      "user": {
        "properties": {
          "name": {
            "type": "keyword",
            "fields": {
              "text": {
                "type": "text"
              }
            }
          }
        }
      }
    }
  }
}

POST tatooine-/_bulk
{ "index": {} }
{ "user": { "name": "Luke Skywalker" } }
{ "index": {} }
{ "user": { "name": "Leia Organa" } }
{ "index": {} }
{ "user": { "name": "Han Solo" } }
{ "index": {} }
{ "user": { "name": "Chewbacca" } }
{ "index": {} }
{ "user": { "name": "Obi-Wan Kenobi" } }
{ "index": {} }
{ "user": { "name": "Yoda" } }
{ "index": {} }
{ "user": { "name": "R2-D2" } }
{ "index": {} }
{ "user": { "name": "C-3PO" } }
{ "index": {} }
{ "user": { "name": "Darth Vader" } }

3. Register Monitoring Entity Source Saved Objects

POST kbn:/api/entity_analytics/monitoring/entity_source
{
  "type": "index",
  "name": "StarWars",
  "managed": true,
  "indexPattern": "tatooine-",
  "enabled": true,
 "matchers": [
    {
      "fields": ["user.role"],
      "values": ["admin"]
    }
  ],
  "filter": {}
}

- OPTIONAL: You can check what is in the monitoring entity_source SO:

GET kbn:/api/entity_analytics/monitoring/entity_source/list

4. Initialise monitoring engine:

POST kbn:/api/entity_analytics/monitoring/engine/init {}

5. Verify Users in Monitoring Index

• Check the list of synced user, should include:
• • The created users
• • The default user (if you created it)

GET kbn:/api/entity_analytics/monitoring/users/list

e.g. output:

[
 {
   "id": "FkMJoZcB7muj1aiwb_eQ",
   "user": {
     "name": "C-3PO",
     "is_privileged": true
   },
   "labels": {
     "sources": [
       "index"
     ],
     "source_indices": [
       "tatooine-"
     ],
   }
 },
 {
   "id": "F0MJoZcB7muj1aiwb_eQ",
   "user": {
     "name": "Chewbacca", 
      "is_privileged": true
   },
   "labels": {
     "sources": [
       "index"
     ],
     "source_indices": [
       "tatooine-"
     ],     
   }
 },
// ... more here 

Testing: Removing Stale Users

The engine should soft delete users from the internal index if they no longer appear in the synced sources - e.g. label as monitoring.privileged_users: "not_monitored"
Example:

• Delete users in index:

POST tatooine-/_delete_by_query
{
 "query": {
   "terms": {
     "user.name": ["Chewbacca", "Han Solo"]
   }
 }
}

• re-run engine init

POST kbn:/api/entity_analytics/monitoring/engine/init
{}

-Fetch the updated user list:

GET kbn:/api/entity_analytics/monitoring/users/list

You should now only see both Chewbacca and Han Solo are no longer privileged:

// ..
{
   "id": "GUMJoZcB7muj1aiwb_eQ",
   "user": {
     "name": "Han Solo"
     "is_privileged": false 
   },
   "labels": {
     "sources": [],
     "source_indices": [],
   }
 }
]

Recurring Sync

Current interval is 10m, change this interval to 30s / shorter interval for testing -
x-pack/solutions/security/plugins/security_solution/server/lib/entity_analytics/privilege_monitoring/constants.ts under 'INTERVAL'.

Should be able to add some more indicies/ delete some users from current indicies and see results from the same users list above, on index sync as well as this log "[Privilege Monitoring] Running privilege monitoring task" running every x chosen INTERVAL occurrence.

[tiansivive]

Thanks everyone for the collab! I left some comments

[elasticmachine]

Pinging @elastic/security-solution (Team: SecuritySolution)

[elasticmachine]

Pinging @elastic/security-entity-analytics (Team:Entity Analytics)

[CAWilson94]

Thanks for the changes! It's looking good. I just highlighted a few other nits to look at before I approve.

@rudolf Thanks! Updated them now :D

[jeramysoucy]

Thanks for all the updates and for your patience on this one! Last question for you is if you've considered adding any unit or integration tests for the new functionality/types. I saw the updated authorization api integration tests, but I didn't see any unit or integration tests for the other changes (I may be looking in wrong place).

[CAWilson94]

Thanks for all the updates and for your patience on this one! Last question for you is if you've considered adding any unit or integration tests for the new functionality/types. I saw the updated authorization api integration tests, but I didn't see any unit or integration tests for the other changes (I may be looking in wrong place).

Hey, thanks to you too for all the direction and help here! Really appreciate it all 🚀 Yes there is a separate ticket out for this here - #225680. The plan will be pull this down and merge it in and cover it along with this larger refactor and testing. @jeramysoucy

[jeramysoucy]

Approving with note that test coverage to be implemented in #225680

If further changes are made, please re-request a review before merging.

[rudolf]

Approving for Core changes related to registering new SO type.

[elasticmachine]

💚 Build Succeeded

• Buildkite Build
• Commit: 6ff9628

Metrics [docs]

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
securitySolution	130	131	+1

Unknown metric groups

API count

id	before	after	diff
securitySolution	199	200	+1

References to deprecated APIs

id	before	after	diff
securitySolution	344	345	+1

History

• 💚 Build #315725 succeeded e046a0d
• 💔 Build #315501 failed 6967e5e
• 💔 Build #315446 failed 23835ee
• 💔 Build #315430 failed 96be1ee
• 💔 Build #315377 failed d6b3fb0
• 💚 Build #314786 succeeded 5a241ff

[CAWilson94]

#225680

Hey, sorry @jeramysoucy, I told you the wrong ticket earlier - this will be the issue to watch https://github.com/elastic/security-team/issues/12251?issue=elastic%7Csecurity-team%7C12887

[kibanamachine]

Starting backport for target branches: 9.1

https://github.com/elastic/kibana/actions/runs/16119924237

[kibanamachine]

💚 All backports created successfully

Status	Branch	Result
✅	9.1

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation