[Beats Management] APIs: Update beat (#19148)

* WIP checkin * WIP checkin * Add API integration test * Converting to Jest test * Fixing API for default case + adding test for it * Fixing copy pasta typos * Fixing variable name * Using a single index * Implementing GET /api/beats/agents API * Creating POST /api/beats/agents/verify API * Refactoring: extracting out helper functions * Expanding TODO note so I won't forget :) * Fixing file name * Updating mapping * Add API tests * Update template to allow version field for beat * Implement PUT /api/beats/agent/{beat ID} API * Make enroll beat code consistent with update beat code * Fixing minor typo in TODO comment * Allow version in request payload * Make sure beat is not updated in ES in error scenarios * Adding version as required field in Enroll Beat API payload * Using destructuring * Fixing rename that was accidentally reversed in conflict fixing
elastic · Aug 27, 2018 · 6e2c1a3 · 6e2c1a3
1 parent 2cea7a6
commit 6e2c1a3
Show file tree

Hide file tree

Showing 9 changed files with 256 additions and 10 deletions.
diff --git a/x-pack/plugins/beats/server/lib/index_template/beats_template.json b/x-pack/plugins/beats/server/lib/index_template/beats_template.json
@@ -54,6 +54,9 @@
             "type": {
               "type": "keyword"
             },
+            "version": {
+              "type": "keyword"
+            },
             "host_ip": {
               "type": "ip"
             },

diff --git a/x-pack/plugins/beats/server/routes/api/index.js b/x-pack/plugins/beats/server/routes/api/index.js
@@ -8,10 +8,12 @@ import { registerCreateEnrollmentTokensRoute } from './register_create_enrollmen
 import { registerEnrollBeatRoute } from './register_enroll_beat_route';
 import { registerListBeatsRoute } from './register_list_beats_route';
 import { registerVerifyBeatsRoute } from './register_verify_beats_route';
+import { registerUpdateBeatRoute } from './register_update_beat_route';
 
 export function registerApiRoutes(server) {
   registerCreateEnrollmentTokensRoute(server);
   registerEnrollBeatRoute(server);
   registerListBeatsRoute(server);
   registerVerifyBeatsRoute(server);
+  registerUpdateBeatRoute(server);
 }
diff --git a/x-pack/plugins/beats/server/routes/api/register_enroll_beat_route.js b/x-pack/plugins/beats/server/routes/api/register_enroll_beat_route.js
@@ -37,21 +37,16 @@ function deleteUsedEnrollmentToken(callWithInternalUser, enrollmentToken) {
   return callWithInternalUser('delete', params);
 }
 
-function persistBeat(callWithInternalUser, beat, beatId, accessToken, remoteAddress) {
+function persistBeat(callWithInternalUser, beat) {
   const body = {
     type: 'beat',
-    beat: {
-      ...omit(beat, 'enrollment_token'),
-      id: beatId,
-      access_token: accessToken,
-      host_ip: remoteAddress
-    }
+    beat
   };
 
   const params = {
     index: INDEX_NAMES.BEATS,
     type: '_doc',
-    id: `beat:${beatId}`,
+    id: `beat:${beat.id}`,
     body,
     refresh: 'wait_for'
   };
@@ -69,13 +64,15 @@ export function registerEnrollBeatRoute(server) {
         payload: Joi.object({
           enrollment_token: Joi.string().required(),
           type: Joi.string().required(),
+          version: Joi.string().required(),
           host_name: Joi.string().required()
         }).required()
       },
       auth: false
     },
     handler: async (request, reply) => {
       const callWithInternalUser = callWithInternalUserFactory(server);
+      const { beatId } = request.params;
       let accessToken;
 
       try {
@@ -90,7 +87,12 @@ export function registerEnrollBeatRoute(server) {
 
         accessToken = uuid.v4().replace(/-/g, "");
         const remoteAddress = request.info.remoteAddress;
-        await persistBeat(callWithInternalUser, request.payload, request.params.beatId, accessToken, remoteAddress);
+        await persistBeat(callWithInternalUser, {
+          ...omit(request.payload, 'enrollment_token'),
+          id: beatId,
+          access_token: accessToken,
+          host_ip: remoteAddress
+        });
 
         await deleteUsedEnrollmentToken(callWithInternalUser, enrollmentToken);
       } catch (err) {

diff --git a/x-pack/plugins/beats/server/routes/api/register_update_beat_route.js b/x-pack/plugins/beats/server/routes/api/register_update_beat_route.js
@@ -0,0 +1,98 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+
+import Joi from 'joi';
+import {  get } from 'lodash';
+import { INDEX_NAMES } from '../../../common/constants';
+import { callWithInternalUserFactory } from '../../lib/client';
+import { wrapEsError } from '../../lib/error_wrappers';
+
+async function getBeat(callWithInternalUser, beatId) {
+  const params = {
+    index: INDEX_NAMES.BEATS,
+    type: '_doc',
+    id: `beat:${beatId}`,
+    ignore: [ 404 ]
+  };
+
+  const response = await callWithInternalUser('get', params);
+  if (!response.found) {
+    return null;
+  }
+
+  return get(response, '_source.beat');
+}
+
+function persistBeat(callWithInternalUser, beat) {
+  const body = {
+    type: 'beat',
+    beat
+  };
+
+  const params = {
+    index: INDEX_NAMES.BEATS,
+    type: '_doc',
+    id: `beat:${beat.id}`,
+    body,
+    refresh: 'wait_for'
+  };
+  return callWithInternalUser('index', params);
+}
+
+// TODO: add license check pre-hook
+// TODO: write to Kibana audit log file (include who did the verification as well)
+export function registerUpdateBeatRoute(server) {
+  server.route({
+    method: 'PUT',
+    path: '/api/beats/agent/{beatId}',
+    config: {
+      validate: {
+        payload: Joi.object({
+          access_token: Joi.string().required(),
+          type: Joi.string(),
+          version: Joi.string(),
+          host_name: Joi.string(),
+          ephemeral_id: Joi.string(),
+          local_configuration_yml: Joi.string(),
+          metadata: Joi.object()
+        }).required()
+      },
+      auth: false
+    },
+    handler: async (request, reply) => {
+      const callWithInternalUser = callWithInternalUserFactory(server);
+      const { beatId } = request.params;
+
+      try {
+        const beat = await getBeat(callWithInternalUser, beatId);
+        if (beat === null) {
+          return reply({ message: 'Beat not found' }).code(404);
+        }
+
+        const isAccessTokenValid = beat.access_token === request.payload.access_token;
+        if (!isAccessTokenValid) {
+          return reply({ message: 'Invalid access token' }).code(401);
+        }
+
+        const isBeatVerified = beat.hasOwnProperty('verified_on');
+        if (!isBeatVerified) {
+          return reply({ message: 'Beat has not been verified' }).code(400);
+        }
+
+        const remoteAddress = request.info.remoteAddress;
+        await persistBeat(callWithInternalUser, {
+          ...beat,
+          ...request.payload,
+          host_ip: remoteAddress
+        });
+      } catch (err) {
+        return reply(wrapEsError(err));
+      }
+
+      reply().code(204);
+    }
+  });
+}
diff --git a/x-pack/plugins/beats/server/routes/api/register_verify_beats_route.js b/x-pack/plugins/beats/server/routes/api/register_verify_beats_route.js
@@ -82,7 +82,7 @@ function findVerifiedBeatIds(verifications, toBeVerifiedBeatIds) {
 }
 
 // TODO: add license check pre-hook
-// TODO: write to Kibana audit log file (include who did the verification as well)
+// TODO: write to Kibana audit log file
 export function registerVerifyBeatsRoute(server) {
   server.route({
     method: 'POST',

diff --git a/x-pack/test/api_integration/apis/beats/enroll_beat.js b/x-pack/test/api_integration/apis/beats/enroll_beat.js
@@ -24,10 +24,17 @@ export default function ({ getService }) {
     beforeEach(async () => {
       validEnrollmentToken = chance.word();
       beatId = chance.word();
+      const version = chance.integer({ min: 1, max: 10 })
+        + '.'
+        + chance.integer({ min: 1, max: 10 })
+        + '.'
+        + chance.integer({ min: 1, max: 10 });
+
       beat = {
         enrollment_token: validEnrollmentToken,
         type: 'filebeat',
         host_name: 'foo.bar.com',
+        version
       };
 
       await es.index({

diff --git a/x-pack/test/api_integration/apis/beats/index.js b/x-pack/test/api_integration/apis/beats/index.js
@@ -21,5 +21,6 @@ export default function ({ getService, loadTestFile }) {
     loadTestFile(require.resolve('./enroll_beat'));
     loadTestFile(require.resolve('./list_beats'));
     loadTestFile(require.resolve('./verify_beats'));
+    loadTestFile(require.resolve('./update_beat'));
   });
 }
diff --git a/x-pack/test/api_integration/apis/beats/update_beat.js b/x-pack/test/api_integration/apis/beats/update_beat.js
@@ -0,0 +1,130 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+
+import expect from 'expect.js';
+import {
+  ES_INDEX_NAME,
+  ES_TYPE_NAME
+} from './constants';
+
+export default function ({ getService }) {
+  const supertest = getService('supertest');
+  const chance = getService('chance');
+  const es = getService('es');
+  const esArchiver = getService('esArchiver');
+
+  describe('update_beat', () => {
+    let beat;
+    const archive = 'beats/list';
+
+    beforeEach('load beats archive', () => esArchiver.load(archive));
+    beforeEach(() => {
+      const version = chance.integer({ min: 1, max: 10 })
+        + '.'
+        + chance.integer({ min: 1, max: 10 })
+        + '.'
+        + chance.integer({ min: 1, max: 10 });
+
+      beat = {
+        access_token: '93c4a4dd08564c189a7ec4e4f046b975',
+        type: `${chance.word()}beat`,
+        host_name: `www.${chance.word()}.net`,
+        version,
+        ephemeral_id: chance.word()
+      };
+    });
+
+    afterEach('unload beats archive', () => esArchiver.unload(archive));
+
+    it('should update an existing verified beat', async () => {
+      const beatId = 'foo';
+      await supertest
+        .put(
+          `/api/beats/agent/${beatId}`
+        )
+        .set('kbn-xsrf', 'xxx')
+        .send(beat)
+        .expect(204);
+
+      const beatInEs = await es.get({
+        index: ES_INDEX_NAME,
+        type: ES_TYPE_NAME,
+        id: `beat:${beatId}`
+      });
+
+      expect(beatInEs._source.beat.id).to.be(beatId);
+      expect(beatInEs._source.beat.type).to.be(beat.type);
+      expect(beatInEs._source.beat.host_name).to.be(beat.host_name);
+      expect(beatInEs._source.beat.version).to.be(beat.version);
+      expect(beatInEs._source.beat.ephemeral_id).to.be(beat.ephemeral_id);
+    });
+
+    it('should return an error for an invalid access token', async () => {
+      const beatId = 'foo';
+      beat.access_token = chance.word();
+      const { body } = await supertest
+        .put(
+          `/api/beats/agent/${beatId}`
+        )
+        .set('kbn-xsrf', 'xxx')
+        .send(beat)
+        .expect(401);
+
+      expect(body.message).to.be('Invalid access token');
+
+      const beatInEs = await es.get({
+        index: ES_INDEX_NAME,
+        type: ES_TYPE_NAME,
+        id: `beat:${beatId}`
+      });
+
+      expect(beatInEs._source.beat.id).to.be(beatId);
+      expect(beatInEs._source.beat.type).to.not.be(beat.type);
+      expect(beatInEs._source.beat.host_name).to.not.be(beat.host_name);
+      expect(beatInEs._source.beat.version).to.not.be(beat.version);
+      expect(beatInEs._source.beat.ephemeral_id).to.not.be(beat.ephemeral_id);
+    });
+
+    it('should return an error for an existing but unverified beat', async () => {
+      const beatId = 'bar';
+      beat.access_token = '3c4a4dd08564c189a7ec4e4f046b9759';
+      const { body } = await supertest
+        .put(
+          `/api/beats/agent/${beatId}`
+        )
+        .set('kbn-xsrf', 'xxx')
+        .send(beat)
+        .expect(400);
+
+      expect(body.message).to.be('Beat has not been verified');
+
+      const beatInEs = await es.get({
+        index: ES_INDEX_NAME,
+        type: ES_TYPE_NAME,
+        id: `beat:${beatId}`
+      });
+
+      expect(beatInEs._source.beat.id).to.be(beatId);
+      expect(beatInEs._source.beat.type).to.not.be(beat.type);
+      expect(beatInEs._source.beat.host_name).to.not.be(beat.host_name);
+      expect(beatInEs._source.beat.version).to.not.be(beat.version);
+      expect(beatInEs._source.beat.ephemeral_id).to.not.be(beat.ephemeral_id);
+    });
+
+    it('should return an error for a non-existent beat', async () => {
+      const beatId = chance.word();
+      const { body } = await supertest
+        .put(
+          `/api/beats/agent/${beatId}`
+        )
+        .set('kbn-xsrf', 'xxx')
+        .send(beat)
+        .expect(404);
+
+      expect(body.message).to.be('Beat not found');
+    });
+  });
+}
diff --git a/x-pack/test/functional/es_archives/beats/list/mappings.json b/x-pack/test/functional/es_archives/beats/list/mappings.json
@@ -54,6 +54,9 @@
               "type": {
                 "type": "keyword"
               },
+              "version": {
+                "type": "keyword"
+              },
               "host_ip": {
                 "type": "ip"
               },