opsgenie-sandbox.js

var async = require('async');
var request = require('request');
var config = {
    OPSGENIE_ENDPOINT: 'https://api.sandbox.opsgenie.com/v2/alerts',
    AQUA_CONSOLE_URL: 'https://cloud.aquasec.com'
};

var raw = function(apikey, payload, callback) {
    if (!apikey) return callback('No apikey provided');
    if (!payload) return callback('No payload provided');
    if (!payload.message) return callback('No payload message provided');
    if (!payload.description) return callback('No payload description provided');

    if (payload.message.length > 130) payload.message = payload.message.substring(0, 129);
    if (payload.description.length > 15000) payload.description = payload.description.substring(0, 14999);

    request({
        url: config.OPSGENIE_ENDPOINT,
        method: 'POST',
        headers: {
            Authorization: 'GenieKey ' + apikey
        },
        json: payload
    }, function(err, response){
        if (err) return callback(err);
        
        if (!response || !response.statusCode) return callback('Invalid response from Opsgenie');
        if (response.statusCode !== 202) return callback(response);
        callback(null, response);
    });
};

/*
 * results - called to send results for a new scan report
 * arguments:
 *     settings: an object containing the following properties:
 *         - endpoints
 *         - account_name
 *         - num_pass, num_warn, num_fail, num_unknown, num_new_risks
 *     callback
*/
var result = function(settings, callback) {
    if (!settings) return callback('No settings object provided');
    if (!settings.endpoints) return callback('No settings endpoints provided');
    if (!settings.account_name) return callback('No settings account_name provided');
    if (typeof settings.num_pass !== 'number') return callback('Settings num_pass is not a valid number');
    if (typeof settings.num_warn !== 'number') return callback('Settings num_warn is not a valid number');
    if (typeof settings.num_fail !== 'number') return callback('Settings num_fail is not a valid number');
    if (typeof settings.num_unknown !== 'number') return callback('Settings num_unknown is not a valid number');
    if (typeof settings.num_new_risks !== 'number') return callback('Settings num_new_risks is not a valid number');

    var message = '[INFO] New Scan for: ' + settings.account_name;
    var description = 'Results: ' + settings.num_pass + ' PASS; ' + settings.num_warn + ' WARN; ' + settings.num_fail + ' FAIL; ' + settings.num_unknown + ' UNKNOWN; ' + settings.num_new_risks + ' NEW';

    var payload = {
        message: message,
        description: description
    };

    async.each(settings.endpoints, function(apikey, cb){
        raw(apikey, payload, function(err){
            cb(err);
        });
    }, function(err){
        callback(err);
    });
};

/*
 * alert - called to send an alert for a test
 * arguments:
 *     settings: an object containing the following properties:
 *         - endpoints
 *         - account_name
 *         - test_name
 *         - test_description
 *         - result
 *         - scan_id
 *         - resources
 *     callback
*/
var alert = function(settings, callback) {
    if (!settings) return callback('No settings object provided');
    if (!settings.endpoints) return callback('No settings endpoints provided');
    if (!settings.account_name) return callback('No settings account_name provided');
    if (!settings.test_name) return callback('No settings test_name provided');
    if (!settings.test_description) return callback('No settings test_description provided');
    if (!settings.scan_id) return callback('No settings test_description provided');
    if (settings.result !== 1 && settings.result !== 2) return callback('Settings result is not a valid number');

    async.each(settings.endpoints, function(apikey, cb){
        var warnOrFail = settings.result === 1 ? 'WARN' : 'FAIL';
        var message = '[' + warnOrFail + '] ' + settings.test_name + ' on: ' + settings.account_name;
        var description = 'Affected Resources: ' + settings.resources.join(', ');

        var payload = {
            message: message,
            description: description
        };

        raw(apikey, payload, function(err){
            cb(err);
        });
    }, function(){
        callback();
    });
};

/*
 * event - called to send an event alert routing
 * arguments:
 *     settings: an object containing the following properties:
 *         - endpoints
 *         - account_name
 *         - event
 *         - original
 *         - account_type
 *         - cloud
 *     callback
*/
var event = function(settings, callback) {
    if (!settings) return callback('No settings object provided');
    if (!settings.endpoints) return callback('No settings endpoints provided');
    if (!settings.account_name) return callback('No settings account_name provided');
    if (!settings.event) return callback('No settings event provided');
    if (!settings.original) return callback('No settings original provided');
    if (!settings.cloud) return callback('No settings cloud provided');
    if (!settings.account_type) return callback('No settings account type provided');
    if (settings.event.result !== 1 && settings.event.result !== 2) return callback('Settings event result is not a valid number');

    async.eachLimit(settings.endpoints, 5, function(apikey, cb){
        var message = `Aqua Wave CSPM Event Alert for ${settings.cloud} ${settings.account_type}: ${settings.account_name} action: ${settings.event.action}`;
        var description = `${settings.account_type}: ` + settings.account_name + '; Action: ' + settings.event.action + '; Region: ' + settings.event.region + '; User: ' + settings.event.caller + '; IP Address: ' + settings.event.ip_address + '; Message: ' + settings.event.message;

        var payload = {
            message: message,
            description: description
        };

        raw(apikey, payload, function(err){
            cb(err);
        });
    }, function(){
        callback();
    });
};

/*
 * remediation_notification - called to send a remediation notification
 * arguments:
 *     settings: an object containing the following properties:
 *         - endpoints
 *         - cloud
 *         - account_id
 *         - account_name
 *         - remediated_resources
 *         - remediation_type
 *         - permissions
 *         - remediation_id
 *         - esult
 *         - caller
 *         - region
 *         - action
 *         - ip_address
 *         - message
 *         - created
 *     callback
*/
var remediation_notification = function(settings, callback) {
    if (!settings) return callback('No settings object provided');
    if (!settings.endpoints) return callback('No settings endpoints provided');
    if (!settings.names) return callback('No settings names provided');
    if (!settings.cloud) return callback('No settings cloud provided');
    if (!settings.account_id) return callback('No settings account_id provided');
    if (!settings.account_name) return callback('No settings account_name provided');
    if (!settings.remediated_resources) return callback('No settings remediated resources provided');
    if (!settings.remediation_type) return callback('No settings remediation type provided');
    if (!settings.permissions) return callback('No settings permissions provided');
    if (!settings.remediation_id) return callback('No settings remediation_id provided');
    if (settings.result !== 0 && settings.result !== 1) return callback('Settings result is not a valid number');
    if (!settings.created) return callback('No settings created provided');

    var type = (settings.type == 'dryrun') ? 'Dry run: ' : '';
    var verb = (settings.result == 0) ? 'succeeded' : 'failed';
    var verbAction = (settings.event_id) ? 'auto-remediation' : 'manual-remediation';

    var message = type + 'Aqua Wave CSPM ' + verbAction + ' ' + verb +  ' for account: ' + settings.account_name + ' (' + settings.account_id + ')';
    var description = (settings.message ? 'Auto-remediation triggered by event: ' + settings.message : 'Manual remediation triggered via the Aqua CSPM console');
    var details = {
        'Account:': settings.account_name,
        'Cloud:': settings.cloud.toUpperCase(),
        'Action:': settings.permissions,
        'Resources:': settings.remediated_resources,
        'Click here to view': config.AQUA_CONSOLE_URL + '/actions?remediation=' + settings.remediation_id
    };

    if (settings.event_id) {
        Object.assign(details, {
            'Type:' : 'Triggered via Event',
            'Region:' : settings.region,
            'User:' : settings.caller,
            'IP Address:' : settings.ip_address,
            'API Call:' : settings.action
        });
    }

    async.eachLimit(settings.endpoints, 5, function(apikey, cb){
        let integrationName = settings.names[settings.endpoints.indexOf(apikey)];
        var payload = {
            message: message,
            description: description,
            details: details
        };

        raw(apikey, payload, function(err){
            settings.remediation_file['integrations'].push({integration:integrationName, status:(err ? 2 : 0), host:config.OPSGENIE_ENDPOINT, err:(err ? err : '')});
            cb();
        });
    }, function(err){
        callback(err);
    });
};

var testConnection = function(integration, callback) {
    if (!integration) return callback('No integration object provided');
    if (!integration.opsgenie_apikey) return callback('No pagerduty api key found');
    var payload = {
        message: 'Connection Test',
        description: 'Aqua Wave Connection Test'
    };
    raw(integration.opsgenie_apikey, payload, function(err, result){
        if (err) {
            callback(err);
        } else {
            callback(null, result);
        }
    });
};

module.exports = {
    raw: raw,
    result: result,
    alert: alert,
    event: event,
    remediation_notification: remediation_notification,
    testConnection: testConnection
};