@shieldiot/pulse-lib 1.0.10 → 1.0.11

package/dist/cjs/lib/services/usrAlertsService.js

@@ -0,0 +1,658 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UsrAlertsService = void 0;
+// List of alerts related actions for the operator 
+// @RequestHeader X-API-KEY The key to identify the application (console) 
+// @RequestHeader X-ACCESS-TOKEN The token to identify the logged-in user 
+class UsrAlertsService {
+    // Class constructor
+    constructor(config, rest) {
+        this.config = config;
+        this.rest = rest;
+        // URL to web api
+        this.baseUrl = '/alerts';
+        this.baseUrl = this.config.api + this.baseUrl;
+    }
+    /**
+     * Get single alert by id
+     */
+    get(id) {
+        return this.rest.get(`${this.baseUrl}/${id}`);
+    }
+    /**
+     * Find list of alerts by query
+     */
+    find(streamId, deviceId, search, from, to, type, severity, category, status, ruleId, targetIp, ruleType, sort, page, size, withoutOccurrences) {
+        const params = [];
+        if (streamId != null) {
+            params.push(`streamId=${streamId}`);
+        }
+        if (deviceId != null) {
+            params.push(`deviceId=${deviceId}`);
+        }
+        if (search != null) {
+            params.push(`search=${search}`);
+        }
+        if (from != null) {
+            params.push(`from=${from}`);
+        }
+        if (to != null) {
+            params.push(`to=${to}`);
+        }
+        if (type != null) {
+            params.push(`type=${type}`);
+        }
+        if (severity != null) {
+            params.push(`severity=${severity}`);
+        }
+        if (category != null) {
+            params.push(`category=${category}`);
+        }
+        if (status != null) {
+            params.push(`status=${status}`);
+        }
+        if (ruleId != null) {
+            params.push(`ruleId=${ruleId}`);
+        }
+        if (targetIp != null) {
+            params.push(`targetIp=${targetIp}`);
+        }
+        if (ruleType != null) {
+            params.push(`ruleType=${ruleType}`);
+        }
+        if (sort != null) {
+            params.push(`sort=${sort}`);
+        }
+        if (page != null) {
+            params.push(`page=${page}`);
+        }
+        if (size != null) {
+            params.push(`size=${size}`);
+        }
+        if (withoutOccurrences != null) {
+            params.push(`withoutOccurrences=${withoutOccurrences}`);
+        }
+        return this.rest.get(`${this.baseUrl}`, ...params);
+    }
+    /**
+     * Export list of alerts by query to a file with the specified format
+     */
+    exportFormat(format, streamId, deviceId, search, from, to, type, severity, category, status, ruleId, targetIp, ruleType, sort, page, size) {
+        const params = [];
+        if (streamId != null) {
+            params.push(`streamId=${streamId}`);
+        }
+        if (deviceId != null) {
+            params.push(`deviceId=${deviceId}`);
+        }
+        if (search != null) {
+            params.push(`search=${search}`);
+        }
+        if (from != null) {
+            params.push(`from=${from}`);
+        }
+        if (to != null) {
+            params.push(`to=${to}`);
+        }
+        if (type != null) {
+            params.push(`type=${type}`);
+        }
+        if (severity != null) {
+            params.push(`severity=${severity}`);
+        }
+        if (category != null) {
+            params.push(`category=${category}`);
+        }
+        if (status != null) {
+            params.push(`status=${status}`);
+        }
+        if (ruleId != null) {
+            params.push(`ruleId=${ruleId}`);
+        }
+        if (targetIp != null) {
+            params.push(`targetIp=${targetIp}`);
+        }
+        if (ruleType != null) {
+            params.push(`ruleType=${ruleType}`);
+        }
+        if (sort != null) {
+            params.push(`sort=${sort}`);
+        }
+        if (page != null) {
+            params.push(`page=${page}`);
+        }
+        if (size != null) {
+            params.push(`size=${size}`);
+        }
+        return this.rest.download(`usr-alerts`, `${this.baseUrl}/export/${format}`, ...params);
+    }
+    /**
+     * Find top 10 alerts by their severity filter by query
+     */
+    getTop(streamId, deviceId, search, from, to, type, severity, category, status, ruleId, targetIp, ruleType, sort, page, size, withoutOccurrences) {
+        const params = [];
+        if (streamId != null) {
+            params.push(`streamId=${streamId}`);
+        }
+        if (deviceId != null) {
+            params.push(`deviceId=${deviceId}`);
+        }
+        if (search != null) {
+            params.push(`search=${search}`);
+        }
+        if (from != null) {
+            params.push(`from=${from}`);
+        }
+        if (to != null) {
+            params.push(`to=${to}`);
+        }
+        if (type != null) {
+            params.push(`type=${type}`);
+        }
+        if (severity != null) {
+            params.push(`severity=${severity}`);
+        }
+        if (category != null) {
+            params.push(`category=${category}`);
+        }
+        if (status != null) {
+            params.push(`status=${status}`);
+        }
+        if (ruleId != null) {
+            params.push(`ruleId=${ruleId}`);
+        }
+        if (targetIp != null) {
+            params.push(`targetIp=${targetIp}`);
+        }
+        if (ruleType != null) {
+            params.push(`ruleType=${ruleType}`);
+        }
+        if (sort != null) {
+            params.push(`sort=${sort}`);
+        }
+        if (page != null) {
+            params.push(`page=${page}`);
+        }
+        if (size != null) {
+            params.push(`size=${size}`);
+        }
+        if (withoutOccurrences != null) {
+            params.push(`withoutOccurrences=${withoutOccurrences}`);
+        }
+        return this.rest.get(`${this.baseUrl}/top`, ...params);
+    }
+    /**
+     * Get top malicious IPs
+     */
+    getTopMaliciousIPs(streamId, top, from, to) {
+        const params = [];
+        if (streamId != null) {
+            params.push(`streamId=${streamId}`);
+        }
+        if (top != null) {
+            params.push(`top=${top}`);
+        }
+        if (from != null) {
+            params.push(`from=${from}`);
+        }
+        if (to != null) {
+            params.push(`to=${to}`);
+        }
+        return this.rest.get(`${this.baseUrl}/top-malicious-ips`, ...params);
+    }
+    /**
+     * Find alerts distribution by type filtered by query
+     */
+    countByType(streamId, deviceId, search, from, to, type, severity, category, status, ruleId, targetIp, ruleType, sort, page, size, withoutOccurrences) {
+        const params = [];
+        if (streamId != null) {
+            params.push(`streamId=${streamId}`);
+        }
+        if (deviceId != null) {
+            params.push(`deviceId=${deviceId}`);
+        }
+        if (search != null) {
+            params.push(`search=${search}`);
+        }
+        if (from != null) {
+            params.push(`from=${from}`);
+        }
+        if (to != null) {
+            params.push(`to=${to}`);
+        }
+        if (type != null) {
+            params.push(`type=${type}`);
+        }
+        if (severity != null) {
+            params.push(`severity=${severity}`);
+        }
+        if (category != null) {
+            params.push(`category=${category}`);
+        }
+        if (status != null) {
+            params.push(`status=${status}`);
+        }
+        if (ruleId != null) {
+            params.push(`ruleId=${ruleId}`);
+        }
+        if (targetIp != null) {
+            params.push(`targetIp=${targetIp}`);
+        }
+        if (ruleType != null) {
+            params.push(`ruleType=${ruleType}`);
+        }
+        if (sort != null) {
+            params.push(`sort=${sort}`);
+        }
+        if (page != null) {
+            params.push(`page=${page}`);
+        }
+        if (size != null) {
+            params.push(`size=${size}`);
+        }
+        if (withoutOccurrences != null) {
+            params.push(`withoutOccurrences=${withoutOccurrences}`);
+        }
+        return this.rest.get(`${this.baseUrl}/count/by-type`, ...params);
+    }
+    /**
+     * Find alerts distribution by status filtered by query
+     */
+    countByStatus(streamId, deviceId, search, from, to, type, severity, category, status, ruleId, targetIp, ruleType, sort, page, size, withoutOccurrences) {
+        const params = [];
+        if (streamId != null) {
+            params.push(`streamId=${streamId}`);
+        }
+        if (deviceId != null) {
+            params.push(`deviceId=${deviceId}`);
+        }
+        if (search != null) {
+            params.push(`search=${search}`);
+        }
+        if (from != null) {
+            params.push(`from=${from}`);
+        }
+        if (to != null) {
+            params.push(`to=${to}`);
+        }
+        if (type != null) {
+            params.push(`type=${type}`);
+        }
+        if (severity != null) {
+            params.push(`severity=${severity}`);
+        }
+        if (category != null) {
+            params.push(`category=${category}`);
+        }
+        if (status != null) {
+            params.push(`status=${status}`);
+        }
+        if (ruleId != null) {
+            params.push(`ruleId=${ruleId}`);
+        }
+        if (targetIp != null) {
+            params.push(`targetIp=${targetIp}`);
+        }
+        if (ruleType != null) {
+            params.push(`ruleType=${ruleType}`);
+        }
+        if (sort != null) {
+            params.push(`sort=${sort}`);
+        }
+        if (page != null) {
+            params.push(`page=${page}`);
+        }
+        if (size != null) {
+            params.push(`size=${size}`);
+        }
+        if (withoutOccurrences != null) {
+            params.push(`withoutOccurrences=${withoutOccurrences}`);
+        }
+        return this.rest.get(`${this.baseUrl}/count/by-status`, ...params);
+    }
+    /**
+     * Find alerts distribution by severity filtered by query
+     */
+    countBySeverity(streamId, deviceId, search, from, to, type, severity, category, status, ruleId, targetIp, ruleType, sort, page, size, withoutOccurrences) {
+        const params = [];
+        if (streamId != null) {
+            params.push(`streamId=${streamId}`);
+        }
+        if (deviceId != null) {
+            params.push(`deviceId=${deviceId}`);
+        }
+        if (search != null) {
+            params.push(`search=${search}`);
+        }
+        if (from != null) {
+            params.push(`from=${from}`);
+        }
+        if (to != null) {
+            params.push(`to=${to}`);
+        }
+        if (type != null) {
+            params.push(`type=${type}`);
+        }
+        if (severity != null) {
+            params.push(`severity=${severity}`);
+        }
+        if (category != null) {
+            params.push(`category=${category}`);
+        }
+        if (status != null) {
+            params.push(`status=${status}`);
+        }
+        if (ruleId != null) {
+            params.push(`ruleId=${ruleId}`);
+        }
+        if (targetIp != null) {
+            params.push(`targetIp=${targetIp}`);
+        }
+        if (ruleType != null) {
+            params.push(`ruleType=${ruleType}`);
+        }
+        if (sort != null) {
+            params.push(`sort=${sort}`);
+        }
+        if (page != null) {
+            params.push(`page=${page}`);
+        }
+        if (size != null) {
+            params.push(`size=${size}`);
+        }
+        if (withoutOccurrences != null) {
+            params.push(`withoutOccurrences=${withoutOccurrences}`);
+        }
+        return this.rest.get(`${this.baseUrl}/count/by-severity`, ...params);
+    }
+    /**
+     * Find alerts distribution by rule filtered by query
+     */
+    countByRule(streamId, deviceId, search, from, to, type, severity, category, status, ruleId, targetIp, ruleType, sort, page, size, withoutOccurrences) {
+        const params = [];
+        if (streamId != null) {
+            params.push(`streamId=${streamId}`);
+        }
+        if (deviceId != null) {
+            params.push(`deviceId=${deviceId}`);
+        }
+        if (search != null) {
+            params.push(`search=${search}`);
+        }
+        if (from != null) {
+            params.push(`from=${from}`);
+        }
+        if (to != null) {
+            params.push(`to=${to}`);
+        }
+        if (type != null) {
+            params.push(`type=${type}`);
+        }
+        if (severity != null) {
+            params.push(`severity=${severity}`);
+        }
+        if (category != null) {
+            params.push(`category=${category}`);
+        }
+        if (status != null) {
+            params.push(`status=${status}`);
+        }
+        if (ruleId != null) {
+            params.push(`ruleId=${ruleId}`);
+        }
+        if (targetIp != null) {
+            params.push(`targetIp=${targetIp}`);
+        }
+        if (ruleType != null) {
+            params.push(`ruleType=${ruleType}`);
+        }
+        if (sort != null) {
+            params.push(`sort=${sort}`);
+        }
+        if (page != null) {
+            params.push(`page=${page}`);
+        }
+        if (size != null) {
+            params.push(`size=${size}`);
+        }
+        if (withoutOccurrences != null) {
+            params.push(`withoutOccurrences=${withoutOccurrences}`);
+        }
+        return this.rest.get(`${this.baseUrl}/count/by-rule`, ...params);
+    }
+    /**
+     * Find alerts distribution by category filtered by query
+     */
+    countByCategory(streamId, deviceId, search, from, to, type, severity, category, status, ruleId, targetIp, ruleType, sort, page, size, withoutOccurrences) {
+        const params = [];
+        if (streamId != null) {
+            params.push(`streamId=${streamId}`);
+        }
+        if (deviceId != null) {
+            params.push(`deviceId=${deviceId}`);
+        }
+        if (search != null) {
+            params.push(`search=${search}`);
+        }
+        if (from != null) {
+            params.push(`from=${from}`);
+        }
+        if (to != null) {
+            params.push(`to=${to}`);
+        }
+        if (type != null) {
+            params.push(`type=${type}`);
+        }
+        if (severity != null) {
+            params.push(`severity=${severity}`);
+        }
+        if (category != null) {
+            params.push(`category=${category}`);
+        }
+        if (status != null) {
+            params.push(`status=${status}`);
+        }
+        if (ruleId != null) {
+            params.push(`ruleId=${ruleId}`);
+        }
+        if (targetIp != null) {
+            params.push(`targetIp=${targetIp}`);
+        }
+        if (ruleType != null) {
+            params.push(`ruleType=${ruleType}`);
+        }
+        if (sort != null) {
+            params.push(`sort=${sort}`);
+        }
+        if (page != null) {
+            params.push(`page=${page}`);
+        }
+        if (size != null) {
+            params.push(`size=${size}`);
+        }
+        if (withoutOccurrences != null) {
+            params.push(`withoutOccurrences=${withoutOccurrences}`);
+        }
+        return this.rest.get(`${this.baseUrl}/count/by-category`, ...params);
+    }
+    /**
+     * Add tag to an alert
+     */
+    addTag(id, tag) {
+        return this.rest.post(`${this.baseUrl}/${id}/tags/${tag}`, '');
+    }
+    /**
+     * Delete a tag from the alert
+     */
+    deleteTag(id, tag) {
+        return this.rest.delete(`${this.baseUrl}/${id}/tags/${tag}`);
+    }
+    /**
+     * Apply action on an alert
+     */
+    applyAction(id, action) {
+        return this.rest.post(`${this.baseUrl}/${id}/actions/${action}`, '');
+    }
+    /**
+     * Set alert status
+     */
+    setStatus(id, status) {
+        return this.rest.post(`${this.baseUrl}/${id}/status/${status}`, '');
+    }
+    /**
+     * Get current shieldex value as ActionResponse, the Key contains the shield index and the data includes the trend
+     */
+    getShieldex() {
+        return this.rest.get(`${this.baseUrl}/shieldex`);
+    }
+    /**
+     * Get histogram of alerts over time by dimension (type | severity | status | ruleType | category)
+     */
+    alertsTimeline(streamId, deviceId, dimension, from, to, type, severity, category, status, ruleId, targetIp, ruleType, sort, page, size) {
+        const params = [];
+        if (streamId != null) {
+            params.push(`streamId=${streamId}`);
+        }
+        if (deviceId != null) {
+            params.push(`deviceId=${deviceId}`);
+        }
+        if (dimension != null) {
+            params.push(`dimension=${dimension}`);
+        }
+        if (from != null) {
+            params.push(`from=${from}`);
+        }
+        if (to != null) {
+            params.push(`to=${to}`);
+        }
+        if (type != null) {
+            params.push(`type=${type}`);
+        }
+        if (severity != null) {
+            params.push(`severity=${severity}`);
+        }
+        if (category != null) {
+            params.push(`category=${category}`);
+        }
+        if (status != null) {
+            params.push(`status=${status}`);
+        }
+        if (ruleId != null) {
+            params.push(`ruleId=${ruleId}`);
+        }
+        if (targetIp != null) {
+            params.push(`targetIp=${targetIp}`);
+        }
+        if (ruleType != null) {
+            params.push(`ruleType=${ruleType}`);
+        }
+        if (sort != null) {
+            params.push(`sort=${sort}`);
+        }
+        if (page != null) {
+            params.push(`page=${page}`);
+        }
+        if (size != null) {
+            params.push(`size=${size}`);
+        }
+        return this.rest.get(`${this.baseUrl}/timeline`, ...params);
+    }
+    /**
+     * Get histogram of shieldex values over time
+     */
+    shieldexTimeline(streamId, from, to) {
+        const params = [];
+        if (streamId != null) {
+            params.push(`streamId=${streamId}`);
+        }
+        if (from != null) {
+            params.push(`from=${from}`);
+        }
+        if (to != null) {
+            params.push(`to=${to}`);
+        }
+        return this.rest.get(`${this.baseUrl}/shieldex/timeline`, ...params);
+    }
+    /**
+     * Export alert source file
+     */
+    exportSource(id) {
+        return this.rest.download(`usr-alerts`, `${this.baseUrl}/${id}/export_source`);
+    }
+    /**
+     * Get total number devices at risk (affected by the alerts matching the query)
+     */
+    getTotalDevicesAtRisk(streamId, search, from, to, type, severity, category, status, ruleId, targetIp, ruleType) {
+        const params = [];
+        if (streamId != null) {
+            params.push(`streamId=${streamId}`);
+        }
+        if (search != null) {
+            params.push(`search=${search}`);
+        }
+        if (from != null) {
+            params.push(`from=${from}`);
+        }
+        if (to != null) {
+            params.push(`to=${to}`);
+        }
+        if (type != null) {
+            params.push(`type=${type}`);
+        }
+        if (severity != null) {
+            params.push(`severity=${severity}`);
+        }
+        if (category != null) {
+            params.push(`category=${category}`);
+        }
+        if (status != null) {
+            params.push(`status=${status}`);
+        }
+        if (ruleId != null) {
+            params.push(`ruleId=${ruleId}`);
+        }
+        if (targetIp != null) {
+            params.push(`targetIp=${targetIp}`);
+        }
+        if (ruleType != null) {
+            params.push(`ruleType=${ruleType}`);
+        }
+        return this.rest.get(`${this.baseUrl}/devices-at-risk`, ...params);
+    }
+    /**
+     * Get malicious IP data card for specific malicious IP
+     */
+    getMaliciousIpCard(streamId, targetIp, from, to) {
+        const params = [];
+        if (streamId != null) {
+            params.push(`streamId=${streamId}`);
+        }
+        if (targetIp != null) {
+            params.push(`targetIp=${targetIp}`);
+        }
+        if (from != null) {
+            params.push(`from=${from}`);
+        }
+        if (to != null) {
+            params.push(`to=${to}`);
+        }
+        return this.rest.get(`${this.baseUrl}/malicious-ip-card`, ...params);
+    }
+    /**
+     * Apply DNS lookup for each IP in the list
+     */
+    getIpLookup(ip) {
+        const params = [];
+        if (ip != null) {
+            params.push(`ip=${ip}`);
+        }
+        return this.rest.get(`${this.baseUrl}/ip-lookup`, ...params);
+    }
+    /**
+     * Find list of alerts by insight id query
+     */
+    findByInsightContext() {
+        return this.rest.get(`${this.baseUrl}/find-by-insight-context`);
+    }
+}
+exports.UsrAlertsService = UsrAlertsService;