wazuh-kibana-app/server/initialize.js
2018-04-18 18:07:44 +02:00

642 lines
28 KiB
JavaScript

const needle = require('needle');
const colors = require('ansicolors');
const blueWazuh = colors.blue('wazuh');
const fs = require('fs');
const yml = require('js-yaml');
const path = require('path');
const { log } = require('./logger');
const KIBANA_TEMPLATE = './integration-files/kibana-template';
import knownFields from './integration-files/known-fields';
import { ElasticWrapper } from './lib/elastic-wrapper';
module.exports = (server, options) => {
// Elastic JS Client
const wzWrapper = new ElasticWrapper(server);
log('[initialize]', `Kibana index: ${wzWrapper.WZ_KIBANA_INDEX}`, 'info');
server.log([blueWazuh, 'initialize', 'info'], `Kibana index: ${wzWrapper.WZ_KIBANA_INDEX}`);
let objects = {};
let app_objects = {};
let kibana_template = {};
let packageJSON = {};
let configurationFile = {};
let pattern = null;
let forceDefaultPattern = true;
// Read config from package.json and config.yml
try {
configurationFile = yml.load(fs.readFileSync(path.join(__dirname, '../config.yml'), { encoding: 'utf-8' }));
global.loginEnabled = (configurationFile && typeof configurationFile['login.enabled'] !== 'undefined') ? configurationFile['login.enabled'] : false;
pattern = (configurationFile && typeof configurationFile.pattern !== 'undefined') ? configurationFile.pattern : 'wazuh-alerts-3.x-*';
forceDefaultPattern = (configurationFile && typeof configurationFile['force.default'] !== 'undefined') ? configurationFile['force.default'] : true;
packageJSON = require('../package.json');
} catch (e) {
log('[initialize]', e.message || e);
server.log([blueWazuh, 'initialize', 'error'], 'Something went wrong while reading the configuration.' + e.message);
}
if (typeof global.sessions === 'undefined') {
global.sessions = {};
}
global.protectedRoute = req => {
if (!loginEnabled) return true;
const session = (req.headers && req.headers.code) ? sessions[req.headers.code] : null;
if (!session) return false;
const timeElapsed = (new Date() - session.created) / 1000;
if (timeElapsed >= session.exp) {
delete sessions[req.payload.code];
return false;
}
return true;
}
const defaultIndexPattern = pattern || "wazuh-alerts-3.x-*";
/**
* Refresh known fields for all valid index patterns.
* Optionally forces the wazuh-alerts-3.x-* creation.
*/
const checkKnownFields = async () => {
try {
const xpack = await wzWrapper.getPlugins();
log('[initialize][checkKnownFields]', `x-pack enabled: ${typeof xpack === 'string' && xpack.includes('x-pack') ? 'yes' : 'no'}`,'info')
server.log([blueWazuh, 'initialize', 'info'], `x-pack enabled: ${typeof xpack === 'string' && xpack.includes('x-pack') ? 'yes' : 'no'}`);
const indexPatternList = await wzWrapper.getAllIndexPatterns();
log('[initialize][checkKnownFields]', `Found ${indexPatternList.hits.total} index patterns`,'info')
server.log([blueWazuh, 'initialize', 'info'], `Found ${indexPatternList.hits.total} index patterns`);
let list = [];
if(indexPatternList && indexPatternList.hits && indexPatternList.hits.hits){
const minimum = ["@timestamp", "full_log", "manager.name", "agent.id"];
if(indexPatternList.hits.hits.length > 0) {
for(const index of indexPatternList.hits.hits){
let valid, parsed;
try{
parsed = JSON.parse(index._source['index-pattern'].fields)
} catch (error){
continue;
}
valid = parsed.filter(item => minimum.includes(item.name));
if(valid.length === 4){
list.push({
id : index._id.split('index-pattern:')[1],
title: index._source['index-pattern'].title
})
}
}
}
}
log('[initialize][checkKnownFields]', `Found ${list.length} valid index patterns for Wazuh alerts`,'info')
server.log([blueWazuh, 'initialize', 'info'], `Found ${list.length} valid index patterns for Wazuh alerts`);
const defaultExists = list.filter(item => item.title === defaultIndexPattern);
if(defaultExists.length === 0 && forceDefaultPattern){
log('[initialize][checkKnownFields]', `Default index pattern not found, creating it...`,'info')
server.log([blueWazuh, 'initialize', 'info'], `Default index pattern not found, creating it...`);
await createIndexPattern();
log('[initialize][checkKnownFields]', 'Waiting for default index pattern creation to complete...','info')
server.log([blueWazuh, 'initialize', 'info'], 'Waiting for default index pattern creation to complete...');
let waitTill = new Date(new Date().getTime() + 0.5 * 1000);
let tmplist = null;
while(waitTill > new Date()){
tmplist = await wzWrapper.searchIndexPatternById(defaultIndexPattern);
if(tmplist.hits.total >= 1) break;
else waitTill = new Date(new Date().getTime() + 0.5 * 1000);
}
server.log([blueWazuh, 'initialize', 'info'], 'Index pattern created...');
list.push({
id : tmplist.hits.hits[0]._id.split('index-pattern:')[1],
title: tmplist.hits.hits[0]._source['index-pattern'].title
})
} else {
log('[initialize][checkKnownFields]', `Default index pattern found`,'info')
server.log([blueWazuh, 'initialize', 'info'], `Default index pattern found`);
}
for(const item of list){
if(item.title.includes('wazuh-monitoring-*') || item.id.includes('wazuh-monitoring-*')) continue;
log('[initialize][checkKnownFields]', `Refreshing known fields for "index-pattern:${item.title}"`,'info')
server.log([blueWazuh, 'initialize', 'info'], `Refreshing known fields for "index-pattern:${item.title}"`);
await wzWrapper.updateIndexPatternKnownFields('index-pattern:' + item.id);
}
log('[initialize][checkKnownFields]', 'App ready to be used.','info')
server.log([blueWazuh, 'initialize', 'info'], 'App ready to be used.');
return;
} catch (error){
log('[initialize][checkKnownFields]', error.message || error);
server.log([blueWazuh, 'server', 'error'], 'Error importing objects into elasticsearch.' + error.message || error);
}
};
// Creates the default index pattern
const createIndexPattern = async () => {
try {
log('[initialize][createIndexPattern]', `Creating index pattern: ${defaultIndexPattern}`,'info')
server.log([blueWazuh, 'initialize', 'info'], `Creating index pattern: ${defaultIndexPattern}`);
await wzWrapper.createIndexPattern(defaultIndexPattern);
log('[initialize][createIndexPattern]', `Created index pattern: ${defaultIndexPattern}`,'info')
server.log([blueWazuh, 'initialize', 'info'], 'Created index pattern: ' + defaultIndexPattern);
} catch (error){
log('[initialize][createIndexPattern]', error.message || error);
server.log([blueWazuh, 'initialize', 'error'], 'Error creating index-pattern.');
}
};
// Save Wazuh App setup
const saveConfiguration = async () => {
try{
const shards = configurationFile && typeof configurationFile["wazuh-version.shards"] !== 'undefined' ?
configurationFile["wazuh-version.shards"] :
1;
const replicas = configurationFile && typeof configurationFile["wazuh-version.replicas"] !== 'undefined' ?
configurationFile["wazuh-version.replicas"] :
1;
const shard_configuration = {
settings: {
index: {
number_of_shards : shards,
number_of_replicas: replicas
}
}
};
await wzWrapper.createWazuhVersionIndex(shard_configuration);
const commonDate = new Date().toISOString();
const configuration = {
name : 'Wazuh App',
'app-version' : packageJSON.version,
revision : packageJSON.revision,
installationDate: commonDate,
lastRestart : commonDate
};
try{
await wzWrapper.insertWazuhVersionConfiguration(configuration);
log('[initialize][saveConfiguration]', 'Wazuh configuration inserted','info')
server.log([blueWazuh, 'initialize', 'info'], 'Wazuh configuration inserted');
} catch (error){
log('[initialize][saveConfiguration]', error.message || error);
server.log([blueWazuh, 'initialize', 'error'], 'Could not insert Wazuh configuration');
}
return;
} catch (error){
log('[initialize][saveConfiguration]', error.message || error);
server.log([blueWazuh, 'initialize', 'error'], 'Error creating index .wazuh-version.');
}
};
const checkWazuhIndex = async () => {
try{
log('[initialize][checkWazuhIndex]', 'Checking .wazuh index.','info')
server.log([blueWazuh, 'initialize', 'info'], 'Checking .wazuh index.');
const result = await wzWrapper.checkIfIndexExists('.wazuh');
if (!result) {
const shards = configurationFile && typeof configurationFile["wazuh.shards"] !== 'undefined' ?
configurationFile["wazuh.shards"] :
1;
const replicas = configurationFile && typeof configurationFile["wazuh.replicas"] !== 'undefined' ?
configurationFile["wazuh.replicas"] :
1;
let configuration = {
"settings": {
"index": {
"number_of_shards": shards,
"number_of_replicas": replicas
}
}
};
try{
await wzWrapper.createWazuhIndex(configuration);
log('[initialize][checkWazuhIndex]', 'Index .wazuh created.','info')
server.log([blueWazuh, 'initialize', 'info'], 'Index .wazuh created.');
} catch(error) {
throw new Error('Error creating index .wazuh.');
}
} else { // The .wazuh index exists, we now proceed to check whether it's from an older version
try{
await wzWrapper.getOldWazuhSetup();
// Reindex!
return reindexOldVersion();
} catch(error) {
if (error.message && error.message !== 'Not Found') {
throw new Error(error.message || error);
}
server.log([blueWazuh, 'initialize', 'info'], 'No older .wazuh index found -> no need to reindex.');
}
}
} catch (error) {
return Promise.reject(error);
}
}
const checkWazuhVersionIndex = async () => {
try {
log('[initialize][checkWazuhVersionIndex]', 'Checking .wazuh-version index.','info')
server.log([blueWazuh, 'initialize', 'info'], 'Checking .wazuh-version index.');
try{
await wzWrapper.getWazuhVersionIndex();
} catch (error) {
log('[initialize][checkWazuhVersionIndex]','.wazuh-version document does not exist. Initializating configuration...','info');
server.log([blueWazuh, 'initialize', 'info'], '.wazuh-version document does not exist. Initializating configuration...');
// Save Setup Info
await saveConfiguration(defaultIndexPattern);
}
server.log([blueWazuh, 'initialize', 'info'], '.wazuh-version document already exists. Updating version information...');
await wzWrapper.updateWazuhVersionIndexLastRestart(packageJSON.version,packageJSON.revision);
server.log([blueWazuh, 'initialize', 'info'], 'Successfully updated .wazuh-version index');
} catch (error) {
return Promise.reject(error);
}
}
// Init function. Check for "wazuh-version" document existance.
const init = async () => {
try {
await Promise.all([
checkWazuhIndex(),
checkWazuhVersionIndex(),
checkKnownFields()
]);
} catch (error){
log('[initialize][init]', error.message || error);
server.log([blueWazuh, '[initialize][init]', 'error'], error.message || error);
return Promise.reject(error)
}
};
const createKibanaTemplate = () => {
log('[initialize][createKibanaTemplate]', `Creating template for ${wzWrapper.WZ_KIBANA_INDEX}`,'info')
server.log([blueWazuh, 'initialize', 'info'], `Creating template for ${wzWrapper.WZ_KIBANA_INDEX}`);
try {
kibana_template = require(KIBANA_TEMPLATE);
kibana_template.template = wzWrapper.WZ_KIBANA_INDEX + '*'
} catch (error) {
log('[initialize][createKibanaTemplate]', error.message || error);
server.log([blueWazuh, 'initialize', 'error'], `Could not read the ${wzWrapper.WZ_KIBANA_INDEX} template file.`);
server.log([blueWazuh, 'initialize', 'error'], 'Exception: ' + error.message || error);
}
return wzWrapper.putWazuhKibanaTemplate(kibana_template);
};
const createEmptyKibanaIndex = async () => {
try {
await wzWrapper.createEmptyKibanaIndex()
log('[initialize][checkKibanaStatus]', `Successfully created ${wzWrapper.WZ_KIBANA_INDEX} index.`,'info')
server.log([blueWazuh, 'initialize', 'info'], `Successfully created ${wzWrapper.WZ_KIBANA_INDEX} index.`);
await init();
return;
} catch (error) {
return Promise.reject(new Error(`Error creating ${wzWrapper.WZ_KIBANA_INDEX} index due to ${error.message || error}`))
}
}
const fixKibanaTemplate = async () => {
try {
await createKibanaTemplate();
log('[initialize][checkKibanaStatus]', `Successfully created ${wzWrapper.WZ_KIBANA_INDEX} template.`,'info')
server.log([blueWazuh, 'initialize', 'info'], `Successfully created ${wzWrapper.WZ_KIBANA_INDEX} template.`);
await createEmptyKibanaIndex();
return;
} catch (error) {
return Promise.reject(new Error(`Error creating template for ${wzWrapper.WZ_KIBANA_INDEX} due to ${error.message || error}`))
}
}
const getTemplateByName = async () => {
try {
await wzWrapper.getTemplateByName('wazuh-kibana')
log('[initialize][checkKibanaStatus]', `No need to create the ${wzWrapper.WZ_KIBANA_INDEX} template, already exists.`,'info')
server.log([blueWazuh, 'initialize', 'info'], `No need to create the ${wzWrapper.WZ_KIBANA_INDEX} template, already exists.`);
await createEmptyKibanaIndex();
return;
} catch (error) {
log('[initialize][checkKibanaStatus]', error.message || error);
return fixKibanaTemplate();
}
}
// Does Kibana index exist?
const checkKibanaStatus = async () => {
try {
const data = await wzWrapper.checkIfIndexExists(wzWrapper.WZ_KIBANA_INDEX);
if (data) {
// It exists, initialize!
await init();
} else {
// No Kibana index created...
log('[initialize][checkKibanaStatus]', 'Didn\'t find ' + wzWrapper.WZ_KIBANA_INDEX + ' index...','info')
server.log([blueWazuh, 'initialize', 'info'], 'Didn\'t find ' + wzWrapper.WZ_KIBANA_INDEX + ' index...');
await getTemplateByName();
}
} catch (error) {
log('[initialize][checkKibanaStatus]',error.message || error);
server.log([blueWazuh, 'initialize (checkKibanaStatus)', 'error'], error.message || error);
}
};
// Wait until Elasticsearch js is ready
const checkStatus = async () => {
try{
await server.plugins.elasticsearch.waitUntilReady();
return checkKibanaStatus();
} catch (error){
log('[initialize][checkStatus]',error.message || error);
server.log([blueWazuh, 'initialize', 'info'], 'Waiting for elasticsearch plugin to be ready...');
setTimeout(() => checkStatus(), 3000);
}
};
const updateClusterInformation = async config => {
try {
await wzWrapper.updateWazuhIndexDocument(config.id,{
'doc': {
"api_user" : config.api_user,
"api_password": config.api_password,
"url" : config.url,
"api_port" : config.api_port,
"manager" : config.manager,
"cluster_info": {
"manager": config.manager,
"node" : config.cluster_info.node,
"cluster": config.cluster_info.cluster,
"status" : config.cluster_info.status
},
}
})
log('[initialize][updateClusterInformation]', `Successfully updated proper cluster information for ${config.manager}`,'info')
server.log([blueWazuh, 'updateClusterInformation', 'info'], `Successfully updated proper cluster information for ${config.manager}`);
return;
} catch (error) {
return Promise.reject(new Error(`Could not update proper cluster information for ${config.manager} due to ${error.message || error}`))
}
}
const updateSingleHostInformation = async config => {
try {
await wzWrapper.updateWazuhIndexDocument(config.id, {
'doc': {
"api_user" : config.api_user,
"api_password": config.api_password,
"url" : config.url,
"api_port" : config.api_port,
"manager" : config.manager,
"cluster_info": {
"manager": config.manager,
"node" : "nodata",
"cluster": "nodata",
"status" : "disabled"
},
}
})
log('[initialize][updateSingleHostInformation]', `Successfully updated proper single host information for ${config.manager}`,'info')
server.log([blueWazuh, 'updateSingleHostInformation', 'info'], `Successfully updated proper single host information for ${config.manager}`);
return;
} catch (error) {
return Promise.reject(new Error(`Could not update proper single host information for ${config.manager} due to ${error.message || error}`))
}
}
const getNodeInformation = async config => {
try {
const response = await needle('get', `${config.url}:${config.api_port}/cluster/node`, {}, {
username: config.api_user,
password: Buffer.from(config.api_password, 'base64').toString("ascii"),
rejectUnauthorized: !config.insecure
})
if (!response.body.error) {
config.cluster_info = {};
config.cluster_info.status = 'enabled';
config.cluster_info.manager = config.manager;
config.cluster_info.node = response.body.data.node;
config.cluster_info.cluster = response.body.data.cluster;
} else if (response.body.error) {
log('[initialize][getNodeInformation]', response.body.error || response.body);
server.log([blueWazuh, 'reindex', 'error'], `Could not get cluster/node information for ${config.manager}`);
}
return;
} catch (error) {
return Promise.reject(error)
}
}
const getClusterStatus = async config => {
try {
const response = await needle('get', `${config.url}:${config.api_port}/cluster/status`, {}, { // Checking the cluster status
username: config.api_user,
password: Buffer.from(config.api_password, 'base64').toString("ascii"),
rejectUnauthorized: !config.insecure
})
if (!response.body.error) {
if (response.body.data.enabled === 'yes') { // If cluster mode is active
return getNodeInformation(config)
}
else { // Cluster mode is not active
config.cluster_info = {};
config.cluster_info.status = 'disabled';
config.cluster_info.cluster = 'Disabled';
config.cluster_info.manager = config.manager;
}
// We filled data for the API, let's insert it now
return updateClusterInformation(config)
} else {
log('[initialize][getClusterStatus]', `Could not get cluster/status information for ${config.manager}`)
server.log([blueWazuh, 'reindex', 'error'], `Could not get cluster/status information for ${config.manager}`);
return;
}
} catch (error) {
return Promise.reject(error);
}
}
const checkVersion = async config => {
try {
const response = await needle('get', `${config.url}:${config.api_port}/version`, {}, {
username: config.api_user,
password: Buffer.from(config.api_password, 'base64').toString("ascii"),
rejectUnauthorized: !config.insecure
})
log('[initialize][checkVersion]', `API is reachable ${config.manager}`,'info')
server.log([blueWazuh, 'reindex', 'info'], `API is reachable ${config.manager}`);
if (parseInt(response.body.error) === 0 && response.body.data) {
return getClusterStatus(config)
} else {
log('[initialize][checkVersion]', `The API responded with some kind of error for ${config.manager}`)
server.log([blueWazuh, 'reindex', 'error'], `The API responded with some kind of error for ${config.manager}`);
return;
}
} catch (error) {
log('[initialize][checkVersion]', error.message || error);
server.log([blueWazuh, 'reindex', 'info'], `API is NOT reachable ${config.manager}`);
// We weren't able to reach the API, reorganize data and fill with sample node and cluster name information
return updateSingleHostInformation(config);
}
}
const reachAPI = async config => {
try {
const id = config._id;
config = config._source;
config.id = id;
log('[initialize][reachAPI]', `Reaching ${config.manager}`,'info')
server.log([blueWazuh, 'reindex', 'info'], `Reaching ${config.manager}`);
if (config.cluster_info === undefined) {
// No cluster_info in the API configuration data -> 2.x version
await checkVersion(config)
} else { // 3.x version
// Nothing to be done, cluster_info is present
log('[initialize][reachAPI]', `Nothing to be done for ${config.manager} as it is already a 3.x version.`,'info')
server.log([blueWazuh, 'reindex', 'info'], `Nothing to be done for ${config.manager} as it is already a 3.x version.`);
}
return;
} catch (error) {
return Promise.reject(error);
}
};
// Reindex a .wazuh index from 2.x-5.x or 3.x-5.x to .wazuh and .wazuh-version in 3.x-6.x
const reindexOldVersion = async () => {
try {
log('[initialize][reindexOldVersion]', `Old version detected. Proceeding to reindex.`,'info')
server.log([blueWazuh, 'reindex', 'info'], `Old version detected. Proceeding to reindex.`);
const configuration = {
source: {
index: '.wazuh',
type : 'wazuh-configuration'
},
dest: {
index: '.old-wazuh'
}
};
// Backing up .wazuh index
await wzWrapper.reindexWithCustomConfiguration(configuration);
log('[initialize][reindexOldVersion]', 'Successfully backed up .wazuh index','info')
// And...this response does not take into acount new index population so...let's wait for it
server.log([blueWazuh, 'reindex', 'info'], 'Successfully backed up .wazuh index');
setTimeout(() => swapIndex(), 3000);
} catch(error) {
log('[initialize][reindexOldVersion]', error.message || error);
server.log([blueWazuh, 'reindex', 'error'], 'Could not begin the reindex process: ' + error.message || error);
}
};
const swapIndex = async () => {
try {
// Deleting old .wazuh index
log('[initialize][swapIndex]', 'Deleting old .wazuh index','info');
server.log([blueWazuh, 'reindex', 'info'], 'Deleting old .wazuh index.');
await wzWrapper.deleteIndexByName('.wazuh');
const configuration = {
"source": {
"index": ".old-wazuh",
"type": "wazuh-configuration"
},
"dest": {
"index": ".wazuh"
},
"script": {
"source": "ctx._id = new Date().getTime()",
"lang": "painless"
}
};
log('[initialize][swapIndex]', 'Reindexing into the new .wazuh','info');
server.log([blueWazuh, 'reindex', 'info'], 'Reindexing into the new .wazuh');
// Reindexing from .old-wazuh where the type of document is wazuh-configuration into the new index .wazuh
await wzWrapper.reindexWithCustomConfiguration(configuration);
// Now we need to properly replace the cluster_info into the configuration -> improvement: pagination?
// And...this response does not take into acount new index population so...let's wait for it
setTimeout(() => reachAPIs(), 3000);
} catch(error) {
log('[initialize][swapIndex]', error.message || error);
server.log([blueWazuh, 'reindex', 'error'], 'Could not reindex the new .wazuh: ' + error.message || error);
}
};
const reachAPIs = async () => {
try{
const data = await wzWrapper.searchIndexByName('.wazuh');
const promises = [];
for (let item of data.hits.hits) {
promises.push(reachAPI(item));
}
await Promise.all(promises);
} catch(error){
log('[initialize][reachAPIs]', error.message || error);
server.log([blueWazuh, 'reindex', 'error'], 'Something happened while getting old API configuration data: ' + error.message || error);
}
};
// Check Kibana index and if it is prepared, start the initialization of Wazuh App.
checkStatus();
};