Implement commands expansion logic #229
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
QU3B1M
changed the title
Update RestPostCommandAction to consume the new Search class
Separate search-related code to a new function Add docstrings and validations
Convert the Target.type to Enum to validate possible values
Improve error messages
Agents are part of group
|
Agent assigned to a group more than once:Group $ curl -s http://localhost:9200/wazuh-agents/_search | grep group004
"groups": ["group001","group004","group000","group004"],
"groups": ["group004","group001","group000"],
"groups": ["group004","group004"],Indexing command: curl -s http://localhost:9200/_plugins/_command_manager/commands -H 'Content-Type: application/json' -d '{
"commands": [
{
"source": "Engine",
"user": "user53",
"target": {
"id": "group004",
"type": "group"
},
"action": {
"name": "restart",
"args": {
"arg1": "/path/to/executable/arg6"
},
"version": "v4"
},
"timeout": 30
}
]
}' | jq
{
"_index": "wazuh-commands",
"_orders": [
{
"_id": "_6iXp5QBytahsG79A-l6"
},
{
"_id": "AKiXp5QBytahsG79A-p6"
},
{
"_id": "AaiXp5QBytahsG79A-p6"
}
],
"result": "OK"
}Only 3 commands are created: $ curl -s http://localhost:9200/wazuh-commands/_search | jq '.hits.hits[] | select(._id == "_6iXp5QBytahsG79A-l6" or ._id == "AKiXp5QBytahsG79A-p6" or ._id == "AaiXp5QBytahsG79A-p6") | ._source'
{
"agent": {
"groups": [
"group004",
"group004"
]
},
"@timestamp": "2025-01-27T11:47:59Z",
"delivery_timestamp": "2025-01-27T11:48:29Z",
"command": {
"action": {
"args": {
"arg1": "/path/to/executable/arg6"
},
"name": "restart",
"version": "v4"
},
"source": "Engine",
"user": "user53",
"order_id": "_qiXp5QBytahsG79A-l3",
"request_id": "_aiXp5QBytahsG79A-l3",
"timeout": 30,
"target": {
"id": "group004",
"type": "group"
},
"status": "failure"
}
}
{
"agent": {
"groups": [
"group001",
"group004",
"group000",
"group004"
]
},
"@timestamp": "2025-01-27T11:47:59Z",
"delivery_timestamp": "2025-01-27T11:48:29Z",
"command": {
"action": {
"args": {
"arg1": "/path/to/executable/arg6"
},
"name": "restart",
"version": "v4"
},
"source": "Engine",
"user": "user53",
"order_id": "_qiXp5QBytahsG79A-l3",
"request_id": "_aiXp5QBytahsG79A-l3",
"timeout": 30,
"target": {
"id": "group004",
"type": "group"
},
"status": "failure"
}
}
{
"agent": {
"groups": [
"group004",
"group001",
"group000"
]
},
"@timestamp": "2025-01-27T11:47:59Z",
"delivery_timestamp": "2025-01-27T11:48:29Z",
"command": {
"action": {
"args": {
"arg1": "/path/to/executable/arg6"
},
"name": "restart",
"version": "v4"
},
"source": "Engine",
"user": "user53",
"order_id": "_qiXp5QBytahsG79A-l3",
"request_id": "_aiXp5QBytahsG79A-l3",
"timeout": 30,
"target": {
"id": "group004",
"type": "group"
},
"status": "failure"
}
}
|
AlexRuiz7
requested changes
Feb 4, 2025
| * @return an Orders object containing the generated orders. | ||
| */ | ||
| @SuppressWarnings("unchecked") | ||
| private static Orders commandsToOrders(NodeClient client, List<Command> commands) { |
There was a problem hiding this comment.
Commands expansion should be moved elsewhere, instead of RestPostCommandAction.java.
Probably Orders model, as it is the return type.
Comment on lines
-127
to
-134
|
|
||
| /// Commands expansion | ||
| /// ================== | ||
| /// Transforms the array of commands to orders. | ||
| /// While commands can be targeted to groups of agents, orders are targeted to individual | ||
| // agents. | ||
| /// Given a group of agents A with N agents, a total of N orders are generated. One for each | ||
| // agent. |
There was a problem hiding this comment.
These comments in the code help to understand the data flow and the responsibilities of this endpoint. Please, add them back.
Comment on lines
+171
to
+184
| private static List<Command> getCommandList(RestRequest request) throws IOException { | ||
| // Request parsing | ||
| XContentParser parser = request.contentParser(); | ||
| List<Command> commands = new ArrayList<>(); | ||
| ensureExpectedToken(XContentParser.Token.START_OBJECT, parser.nextToken(), parser); | ||
| parser.nextToken(); | ||
| if (parser.nextToken() == XContentParser.Token.START_ARRAY) { | ||
| commands = Command.parseToArray(parser); | ||
| } else { | ||
| log.error("Token does not match {}", parser.currentToken()); | ||
| } | ||
|
|
||
| return commands; | ||
| } |
There was a problem hiding this comment.
Parsing should be done in the model classes only.
| channel.sendResponse( | ||
| new BytesRestResponse( | ||
| RestStatus.BAD_REQUEST, | ||
| "Cannot generate orders. Invalid agent IDs or groups.")); |
There was a problem hiding this comment.
In which case an Agent ID is invalid?
| channel.sendResponse( | ||
| new BytesRestResponse( | ||
| RestStatus.BAD_REQUEST, | ||
| "No valid commands detected in the request body.")); |
There was a problem hiding this comment.
"No commands provided" is shorter and translates better to the condition being checked.
AlexRuiz7
requested changes
Feb 4, 2025
There was a problem hiding this comment.
la expansión de comandos no es correcta.
En una prueba que he hecho, he enviado el comando:
The commands expansion is not working as intended.
I tested using this command:
{
"commands": [
{
"action": {
"args": {},
"name": "restart",
"version": "5.0.0"
},
"source": "Users/Services",
"user": "Management API",
"timeout": 100,
"target": {
"id": "group001",
"type": "group"
}
}
]
}One of the expanded commands is:
{
"_index": "wazuh-commands",
"_id": "J4LK0JQBHI2QBvqR03xq",
"_score": 1,
"_source": {
"agent": {
"groups": [
"group000",
"group001"
]
},
"command": {
"source": "Users/Services",
"user": "Management API",
"target": {
"type": "group",
"id": "group001"
},
"action": {
"name": "restart",
"args": {
},
"version": "5.0.0"
},
"timeout": 100,
"status": "pending",
"order_id": "JoLK0JQBHI2QBvqR03xU",
"request_id": "JYLK0JQBHI2QBvqR03xU"
},
"@timestamp": "2025-02-04T11:49:00Z",
"delivery_timestamp": "2025-02-04T11:50:40Z"
}
}The result should be a command targeted to an specific agent, but it is not.
"target": {
"type": "agent",
"id": "<agent-id>"
}
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Detect the commands which target type is
group, search in the.agentsindex for the agents of each group and generate the corresponding Orders.Renamed the
Documentclass toOrders, replacing the previously unused Orders class.Working validations
Command expansion
Group used for the test:
group000Request
{ "commands": [ { "source": "Engine", "user": "user53", "target": { "id": "group000", "type": "group" }, "action": { "name": "restart", "args": { "arg1": "/path/to/executable/arg6" }, "version": "v4" }, "timeout": 30 } ] }Response
{ "_index": ".commands", "_orders": [ { "_id": "WS5fjpQBDZQg8-hA8AYd" }, { "_id": "Wi5fjpQBDZQg8-hA8AYe" } ], "result": "OK" }Command creation log
Command indexed
% curl http://127.0.0.1:9200/.commands/_search {"took":2,"timed_out":false,"_shards":{"total":1,"successful":1,"skipped":0,"failed":0},"hits":{"total":{"value":2,"relation":"eq"},"max_score":1.0,"hits":[{"_index":".commands","_id":"WS5fjpQBDZQg8-hA8AYd","_score":1.0,"_source":{"agent":{"groups":["group000","group001","group003"]},"@timestamp":"2025-01-22T14:17:19Z","delivery_timestamp":"2025-01-22T14:17:49Z","command":{"action":{"args":{"arg1":"/path/to/executable/arg6"},"name":"restart","version":"v4"},"source":"Engine","user":"user53","order_id":"WC5fjpQBDZQg8-hA8AYP","request_id":"Vy5fjpQBDZQg8-hA8AYP","timeout":30,"target":{"id":"group000","type":"group"},"status":"failure"}}},{"_index":".commands","_id":"Wi5fjpQBDZQg8-hA8AYe","_score":1.0,"_source":{"agent":{"groups":["group000","group002","group002"]},"@timestamp":"2025-01-22T14:17:19Z","delivery_timestamp":"2025-01-22T14:17:49Z","command":{"action":{"args":{"arg1":"/path/to/executable/arg6"},"name":"restart","version":"v4"},"source":"Engine","user":"user53","order_id":"WC5fjpQBDZQg8-hA8AYP","request_id":"Vy5fjpQBDZQg8-hA8AYP","timeout":30,"target":{"id":"group000","type":"group"},"status":"failure"}}}]}}Command expansion - Group assigned to the same agent more than once
Using the group
001{ "commands": [ { "source": "Engine", "user": "user53", "target": { "id": "group001", "type": "group" }, "action": { "name": "restart", "args": { "arg1": "/path/to/executable/arg6" }, "version": "v4" }, "timeout": 30 } ] }{ "_index": ".commands", "_orders": [ { "_id": "wP9ojpQBpOpp5jjTDc0s" }, { "_id": "wf9ojpQBpOpp5jjTDc0t" }, { "_id": "wv9ojpQBpOpp5jjTDc0t" }, { "_id": "w_9ojpQBpOpp5jjTDc0t" }, { "_id": "xP9ojpQBpOpp5jjTDc0t" } ], "result": "OK" }Basic command creation
Using agent id:
agent94{ "commands": [ { "source": "Engine", "user": "user53", "target": { "id": "agent94", "type": "agent" }, "action": { "name": "restart", "args": { "arg1": "/path/to/executable/arg6" }, "version": "v4" }, "timeout": 30 } ] }{ "_index": ".commands", "_orders": [ { "_id": "SQJ1jpQBrXbQNgi-ZGvv" } ], "result": "OK" }Issues Resolved
Resolves #88