Add hash parameter to GET/agents/groups/:group_id/files API call

CHANGELOG.md

@@ -6,6 +6,7 @@ All notable changes to this project will be documented in this file.
 ### Added
 - Added support for queries in agents, rootcheck and syscheck API requests ([#128](https:/wazuh/wazuh-api/pull/128))
 - Added API support for multigroups ([#159](https:/wazuh/wazuh-api/pull/159))
+- Add `hash` parameter to GET/agents/groups/:group_id/files API call ([#166](https:/wazuh/wazuh-api/pull/166))
 - Add GET/agents/:agent_id/config/:component/:configuration call ([#72](https:/wazuh/wazuh-api/pull/72)).
 
 ### Changed

controllers/agents.js

@@ -231,8 +231,8 @@ router.get('/groups/:group_id/configuration', cache(), function(req, res) {
  * @apiName GetAgentGroupFile
  * @apiGroup Groups
  *
- * @apiParam {String} group_id Group ID.
- * @apiParam {String} file_name Filename
+ * @apiParam {String} [group_id] Group ID.
+ * @apiParam {String} [file_name] Filename
  * @apiParam {String="conf","rootkit_files", "rootkit_trojans", "rcl"} [type] Type of file.
  *
  * @apiDescription Returns the specified file belonging to the group parsed to JSON.
@@ -274,6 +274,7 @@ router.get('/groups/:group_id/files/:filename', cache(), function(req, res) {
  * @apiParam {Number} [limit=500] Maximum number of elements to return.
  * @apiParam {String} [sort] Sorts the collection by a field or fields (separated by comma). Use +/- at the beginning to list in ascending or descending order.
  * @apiParam {String} [search] Looks for elements with the specified string.
+ * @apiParam {String} [hash] Hash algorithm to use to calculate files checksums.
  *
  * @apiDescription Returns the files belonging to the group.
  *
@@ -287,7 +288,7 @@ router.get('/groups/:group_id/files', cache(), function(req, res) {
  req.apicacheGroup = "agents";
 
  var data_request = {'function': '/agents/groups/:group_id/files', 'arguments': {}};
- var filters = {'offset': 'numbers', 'limit': 'numbers', 'sort':'sort_param', 'search':'search_param'};
+ var filters = {'offset': 'numbers', 'limit': 'numbers', 'sort':'sort_param', 'search':'search_param', 'hash':'names'};
 
  if (!filter.check(req.query, filters, req, res)) // Filter with error
  return;
@@ -300,6 +301,8 @@ router.get('/groups/:group_id/files', cache(), function(req, res) {
  data_request['arguments']['sort'] = filter.sort_param_to_json(req.query.sort);
  if ('search' in req.query)
  data_request['arguments']['search'] = filter.search_param_to_json(req.query.search);
+ if ('hash' in req.query)
+ data_request['arguments']['hash_algorithm'] = req.query.hash;
 
  if (!filter.check(req.params, {'group_id':'names'}, req, res)) // Filter with error
  return;

test/test_agents.js

@@ -1144,6 +1144,7 @@ describe('Agents', function() {
 
  res.body.data.should.be.an.array;
  res.body.data.should.have.properties(['totalItems','items']);
+ res.body.data[0].should.have.properties(['count','mergedSum','configSum','name']);
  res.body.data.items.should.be.instanceOf(Array);
 
  done();
@@ -1165,6 +1166,38 @@ describe('Agents', function() {
  });
  });
 
+ it('Hash algorithm', function(done) {
+ request(common.url)
+ .get("/agents/groups?hash=sha256")
+ .auth(common.credentials.user, common.credentials.password)
+ .expect("Content-type",/json/)
+ .expect(200)
+ .end(function(err,res){
+ if (err) return done(err);
+
+ res.body.should.have.properties(['error', 'data']);
+ res.body.error.should.equal(0);
+ res.body.data.should.have.properties(['totalItems','items']);
+ res.body.data.items[0].should.have.properties(['count','mergedSum','configSum','name']);
+ done();
+ });
+ });
+
+ it('Wrong Hash algorithm', function(done) {
+ request(common.url)
+ .get("/agents/groups?hash=aaaaaa")
+ .auth(common.credentials.user, common.credentials.password)
+ .expect("Content-type",/json/)
+ .expect(200)
+ .end(function(err,res){
+ if (err) return done(err);
+
+ res.body.should.have.properties(['error', 'message']);
+ res.body.error.should.equal(1723);
+ done();
+ });
+ });
+
  }); // GET/agents/groups
 
  describe('GET/agents/groups/:group_id', function() {
@@ -1337,6 +1370,7 @@ describe('Agents', function() {
 
  res.body.should.have.properties(['error', 'data']);
  res.body.error.should.equal(0);
+ res.body.data[0].should.have.properties(['hash','filename']);
  done();
  });
  });
@@ -1371,6 +1405,38 @@ describe('Agents', function() {
  });
  });
 
+ it('Hash algorithm', function(done) {
+ request(common.url)
+ .get("/agents/groups/webserver/files?hash=sha256")
+ .auth(common.credentials.user, common.credentials.password)
+ .expect("Content-type",/json/)
+ .expect(200)
+ .end(function(err,res){
+ if (err) return done(err);
+
+ res.body.should.have.properties(['error', 'data']);
+ res.body.error.should.equal(0);
+ res.body.data.should.have.properties(['totalItems','items']);
+ res.body.data.items[0].should.have.properties(['hash','filename']);
+ done();
+ });
+ });
+
+ it('Wrong Hash algorithm', function(done) {
+ request(common.url)
+ .get("/agents/groups/webserver/files?hash=aaaaaa")
+ .auth(common.credentials.user, common.credentials.password)
+ .expect("Content-type",/json/)
+ .expect(200)
+ .end(function(err,res){
+ if (err) return done(err);
+
+ res.body.should.have.properties(['error', 'message']);
+ res.body.error.should.equal(1723);
+ done();
+ });
+ });
+
  }); // GET/agents/groups/:group_id/files
 
  describe('GET/agents/groups/:group_id/files/:filename', function() {