@shieldiot/pulse-lib 1.0.5 → 1.0.7

package/src/lib/common/AccountRole.ts

@@ -1,25 +0,0 @@
-import { MemberRoleCode } from '../enums';
-
-
-
-// Account role represents the role of the user in the account
-export class AccountRole {
- 
-    // Account Id 
-    public accountId: string;
- 
-    // Account Name (for display only) 
-    public accountName: string;
- 
-    // User role in the account: UNDEFINED | ADMIN | OPERATOR | VIEWER 
-    public role: MemberRoleCode;
- 
-     constructor(accountId?: string, accountName?: string, role?: MemberRoleCode) { 
-        if (accountId !== undefined) { this.accountId = accountId; }
-        if (accountName !== undefined) { this.accountName = accountName; }
-        if (role !== undefined) { this.role = role; }
-    }
-
-}
-
-

package/src/lib/common/ConsumptionData.ts

@@ -1,24 +0,0 @@
-
-
-
-// A set of input, output data values
-export class ConsumptionData {
- 
-    // Incoming traffic in Kb 
-    public dataIn: number;
- 
-    // Outgoing traffic in Kb 
-    public dataOut: number;
- 
-    // Total traffic in Kb 
-    public total: number;
- 
-     constructor(dataIn?: number, dataOut?: number, total?: number) { 
-        if (dataIn !== undefined) { this.dataIn = dataIn; }
-        if (dataOut !== undefined) { this.dataOut = dataOut; }
-        if (total !== undefined) { this.total = total; }
-    }
-
-}
-
-

package/src/lib/common/ConsumptionTimeDataPoint.ts

@@ -1,21 +0,0 @@
-import { ConsumptionData } from '../common';
-
-
-
-// ConsumptionTimeDataPoint model represents a 2 dimensions datapoint in time
-export class ConsumptionTimeDataPoint {
- 
-    // Sata point timestamp [Epoch milliseconds Timestamp] 
-    public timestamp: number;
- 
-    // Consumption data 
-    public value: ConsumptionData;
- 
-     constructor(timestamp?: number, value?: ConsumptionData) { 
-        if (timestamp !== undefined) { this.timestamp = timestamp; }
-        if (value !== undefined) { this.value = value; }
-    }
-
-}
-
-

package/src/lib/common/DeviceConfig.ts

@@ -1,22 +0,0 @@
-import { DevicesAtRiskConfig } from '../common';
-import { DeviceScoreConfig } from '../common';
-
-
-
-// DeviceConfig is a set of device related configurations
-export class DeviceConfig {
- 
-    // Devices at risk configuration 
-    public devicesAtRiskConfig: DevicesAtRiskConfig;
- 
-    // Device score configurations 
-    public deviceScoreConfig: DeviceScoreConfig;
- 
-     constructor(devicesAtRiskConfig?: DevicesAtRiskConfig, deviceScoreConfig?: DeviceScoreConfig) { 
-        if (devicesAtRiskConfig !== undefined) { this.devicesAtRiskConfig = devicesAtRiskConfig; }
-        if (deviceScoreConfig !== undefined) { this.deviceScoreConfig = deviceScoreConfig; }
-    }
-
-}
-
-

package/src/lib/common/DeviceScoreConfig.ts

@@ -1,24 +0,0 @@
-
-
-
-// DeviceScoreConfig is a set of parameters for device score config
-export class DeviceScoreConfig {
- 
-    // device score alpha factor 
-    public deviceScoreAlphaFactor: number;
- 
-    // occurrence threshold 
-    public occurrenceThreshold: number;
- 
-    // ruleCount threshold 
-    public ruleCountThreshold: number;
- 
-     constructor(deviceScoreAlphaFactor?: number, occurrenceThreshold?: number, ruleCountThreshold?: number) { 
-        if (deviceScoreAlphaFactor !== undefined) { this.deviceScoreAlphaFactor = deviceScoreAlphaFactor; }
-        if (occurrenceThreshold !== undefined) { this.occurrenceThreshold = occurrenceThreshold; }
-        if (ruleCountThreshold !== undefined) { this.ruleCountThreshold = ruleCountThreshold; }
-    }
-
-}
-
-

package/src/lib/common/DevicesAtRiskConfig.ts

@@ -1,16 +0,0 @@
-
-
-
-// DevicesAtRiskConfig is int of minimal score for device to be at risk
-export class DevicesAtRiskConfig {
- 
-    // Minimal score for device to be at risk 
-    public minScore: number;
- 
-     constructor(minScore?: number) { 
-        if (minScore !== undefined) { this.minScore = minScore; }
-    }
-
-}
-
-

package/src/lib/common/EventSeverityConfig.ts

@@ -1,17 +0,0 @@
-import { SeverityIntervalTuple } from '../common';
-
-
-
-// EventSeverityConfig is a list of event severity configuration
-export class EventSeverityConfig {
- 
-    // List of severity configurations key-value. Value of type Interval 
-    public severityConfigs: SeverityIntervalTuple[];
- 
-     constructor(severityConfigs?: SeverityIntervalTuple[]) { 
-        if (severityConfigs !== undefined) { this.severityConfigs = severityConfigs; }
-    }
-
-}
-
-

package/src/lib/common/FloatKeyValue.ts

@@ -1,20 +0,0 @@
-
-
-
-// Key Value float tuple
-export class FloatKeyValue {
- 
-    // Key of tuple 
-    public key: number;
- 
-    // Value of tuple 
-    public value: number;
- 
-     constructor(key?: number, value?: number) { 
-        if (key !== undefined) { this.key = key; }
-        if (value !== undefined) { this.value = value; }
-    }
-
-}
-
-

package/src/lib/common/GeoData.ts

@@ -1,38 +0,0 @@
-import { Location } from '../common';
-
-
-
-// GeoData model represents Geographic data associated with IP
-// This structure is based on the Elasticsearch GeoIP pipeline fetching data from MaxMind database
-export class GeoData {
- 
-    // Country ISO code 
-    public country_iso_code: string;
- 
-    // Country name 
-    public country_name: string;
- 
-    // Region ISO code 
-    public region_iso_code: string;
- 
-    // Region name 
-    public region_name: string;
- 
-    // City name 
-    public city_name: string;
- 
-    // WGS-84 Geo Location 
-    public location: Location;
- 
-     constructor(countryIsoCode?: string, countryName?: string, regionIsoCode?: string, regionName?: string, cityName?: string, location?: Location) { 
-        if (countryIsoCode !== undefined) { this.country_iso_code = countryIsoCode; }
-        if (countryName !== undefined) { this.country_name = countryName; }
-        if (regionIsoCode !== undefined) { this.region_iso_code = regionIsoCode; }
-        if (regionName !== undefined) { this.region_name = regionName; }
-        if (cityName !== undefined) { this.city_name = cityName; }
-        if (location !== undefined) { this.location = location; }
-    }
-
-}
-
-

package/src/lib/common/GraphSeries.ts

@@ -1,21 +0,0 @@
-import { IntKeySeriesDataValue } from '../common';
-
-
-
-// GraphSeries model represents a generic set of data points over interval
-export class GraphSeries {
- 
-    // Name of the graph series 
-    public name: string;
- 
-    // Custom attributes (key-value pairs) 
-    public values: IntKeySeriesDataValue[];
- 
-     constructor(name?: string, values?: IntKeySeriesDataValue[]) { 
-        if (name !== undefined) { this.name = name; }
-        if (values !== undefined) { this.values = values; }
-    }
-
-}
-
-

package/src/lib/common/Indicator.ts

@@ -1,32 +0,0 @@
-
-
-
-// Indicator model represents a feature and feature value within a normal range
-export class Indicator {
- 
-    // Feature name 
-    public name: string;
- 
-    // Level of Significance 
-    public significance: number;
- 
-    // Min normal value 
-    public min: number;
- 
-    // Max normal value 
-    public max: number;
- 
-    // Actual value of the feature 
-    public actual: number;
- 
-     constructor(name?: string, significance?: number, min?: number, max?: number, actual?: number) { 
-        if (name !== undefined) { this.name = name; }
-        if (significance !== undefined) { this.significance = significance; }
-        if (min !== undefined) { this.min = min; }
-        if (max !== undefined) { this.max = max; }
-        if (actual !== undefined) { this.actual = actual; }
-    }
-
-}
-
-

package/src/lib/common/IntKeySeriesDataValue.ts

@@ -1,21 +0,0 @@
-import { SeriesData } from '../common';
-
-
-
-// Key: int Value SeriesData  tuple
-export class IntKeySeriesDataValue {
- 
-    // Key of tuple 
-    public key: number;
- 
-    // Value of tuple 
-    public value: SeriesData;
- 
-     constructor(key?: number, value?: SeriesData) { 
-        if (key !== undefined) { this.key = key; }
-        if (value !== undefined) { this.value = value; }
-    }
-
-}
-
-

package/src/lib/common/IntKeyValue.ts

@@ -1,20 +0,0 @@
-
-
-
-// Key Value int tuple
-export class IntKeyValue {
- 
-    // Key of tuple 
-    public key: number;
- 
-    // Value of tuple 
-    public value: number;
- 
-     constructor(key?: number, value?: number) { 
-        if (key !== undefined) { this.key = key; }
-        if (value !== undefined) { this.value = value; }
-    }
-
-}
-
-

package/src/lib/common/Interval.ts

@@ -1,20 +0,0 @@
-
-
-
-// Interval represents a finite int window (from - to)
-export class Interval {
- 
-    // Start window interval 
-    public from: number;
- 
-    // End window interval 
-    public to: number;
- 
-     constructor(from?: number, to?: number) { 
-        if (from !== undefined) { this.from = from; }
-        if (to !== undefined) { this.to = to; }
-    }
-
-}
-
-

package/src/lib/common/Link.ts

@@ -1,41 +0,0 @@
-import { SeverityTypeCode } from '../enums';
-
-
-
-// Link represents a relation between two nodes
-export class Link {
- 
-    // Link Id 
-    public id: string;
- 
-    // Link name 
-    public name: string;
- 
-    // Source Node Id (from) 
-    public src: string;
- 
-    // Destination Node Id (to) 
-    public dst: string;
- 
-    // Link numeric value 
-    public value: number;
- 
-    // Severity level: UNDEFINED | LOW | MEDIUM | HIGH | CRITICAL 
-    public severity: SeverityTypeCode;
- 
-    // Number of events for the time period (calculated field) 
-    public eventCount: number;
- 
-     constructor(id?: string, name?: string, src?: string, dst?: string, value?: number, severity?: SeverityTypeCode, eventCount?: number) { 
-        if (id !== undefined) { this.id = id; }
-        if (name !== undefined) { this.name = name; }
-        if (src !== undefined) { this.src = src; }
-        if (dst !== undefined) { this.dst = dst; }
-        if (value !== undefined) { this.value = value; }
-        if (severity !== undefined) { this.severity = severity; }
-        if (eventCount !== undefined) { this.eventCount = eventCount; }
-    }
-
-}
-
-

package/src/lib/common/Location.ts

@@ -1,20 +0,0 @@
-
-
-
-// WGS-84 Geo Location
-export class Location {
- 
-    // Latitude 
-    public lat: number;
- 
-    // Longitude 
-    public lon: number;
- 
-     constructor(lat?: number, lon?: number) { 
-        if (lat !== undefined) { this.lat = lat; }
-        if (lon !== undefined) { this.lon = lon; }
-    }
-
-}
-
-

package/src/lib/common/LoginParams.ts

@@ -1,24 +0,0 @@
-
-
-
-// Login parameters data model
-export class LoginParams {
- 
-    // User email 
-    public email: string;
- 
-    // User password 
-    public password: string;
- 
-    // Access token - in case of re-login with existing token 
-    public accessToken: string;
- 
-     constructor(email?: string, password?: string, accessToken?: string) { 
-        if (email !== undefined) { this.email = email; }
-        if (password !== undefined) { this.password = password; }
-        if (accessToken !== undefined) { this.accessToken = accessToken; }
-    }
-
-}
-
-

package/src/lib/common/MaliciousIPCard.ts

@@ -1,45 +0,0 @@
-import { IntDistribution } from '../entities';
-
-
-
-// MaliciousIPCard is a data structure representing malicious IP card
-export class MaliciousIPCard {
- 
-    // The malicious IP 
-    public maliciousIp: string;
- 
-    // The malicious IP DNS name (can be comma-separated list of names) 
-    public maliciousIpDns: string;
- 
-    // Country code 
-    public countryCode: string;
- 
-    // Ip description 
-    public ipDescription: string;
- 
-    // Last Event Time 
-    public lastEventTime: number;
- 
-    // Attack Categories list 
-    public attackCategories: string[];
- 
-    // Number Of Devices 
-    public numberOfDevices: number;
- 
-    // Events By Severity Breakdown 
-    public eventsBySeverityBreakdown: IntDistribution;
- 
-     constructor(maliciousIp?: string, maliciousIpDns?: string, countryCode?: string, ipDescription?: string, lastEventTime?: number, attackCategories?: string[], numberOfDevices?: number, eventsBySeverityBreakdown?: IntDistribution) { 
-        if (maliciousIp !== undefined) { this.maliciousIp = maliciousIp; }
-        if (maliciousIpDns !== undefined) { this.maliciousIpDns = maliciousIpDns; }
-        if (countryCode !== undefined) { this.countryCode = countryCode; }
-        if (ipDescription !== undefined) { this.ipDescription = ipDescription; }
-        if (lastEventTime !== undefined) { this.lastEventTime = lastEventTime; }
-        if (attackCategories !== undefined) { this.attackCategories = attackCategories; }
-        if (numberOfDevices !== undefined) { this.numberOfDevices = numberOfDevices; }
-        if (eventsBySeverityBreakdown !== undefined) { this.eventsBySeverityBreakdown = eventsBySeverityBreakdown; }
-    }
-
-}
-
-

package/src/lib/common/MaliciousIPData.ts

@@ -1,28 +0,0 @@
-
-
-
-// MaliciousIPData is a data structure representing malicious IP and its statistics
-export class MaliciousIPData {
- 
-    // The malicious IP 
-    public ip: string;
- 
-    // Total related events 
-    public totalEvents: number;
- 
-    // Total related devices 
-    public totalDevices: number;
- 
-    // Total suspicious IPs 
-    public totalMaliciousIPs: number;
- 
-     constructor(iP?: string, totalEvents?: number, totalDevices?: number, totalMaliciousIPs?: number) { 
-        if (iP !== undefined) { this.ip = iP; }
-        if (totalEvents !== undefined) { this.totalEvents = totalEvents; }
-        if (totalDevices !== undefined) { this.totalDevices = totalDevices; }
-        if (totalMaliciousIPs !== undefined) { this.totalMaliciousIPs = totalMaliciousIPs; }
-    }
-
-}
-
-

package/src/lib/common/NetworkMap.ts

@@ -1,22 +0,0 @@
-import { Node } from '../common';
-import { Link } from '../common';
-
-
-
-// NetworkMap is a data structure representing a set of nodes and vertex representing a network
-export class NetworkMap {
- 
-    // List of nodes 
-    public nodes: Node[];
- 
-    // List of links 
-    public links: Link[];
- 
-     constructor(nodes?: Node[], links?: Link[]) { 
-        if (nodes !== undefined) { this.nodes = nodes; }
-        if (links !== undefined) { this.links = links; }
-    }
-
-}
-
-

package/src/lib/common/Node.ts

@@ -1,54 +0,0 @@
-import { DeviceTypeCode } from '../enums';
-import { StringKeyValue } from '../common';
-
-
-
-// Node represents a vertex in a network map
-export class Node {
- 
-    // Node Id 
-    public id: string;
- 
-    // Node name 
-    public name: string;
- 
-    // Node IP 
-    public ip: string;
- 
-    // Device type (for nodes representing a device) 
-    public type: DeviceTypeCode;
- 
-    // Device current security score 
-    public score: number;
- 
-    // List of device tags 
-    public tags: string[];
- 
-    // Custom attributes (key-value pairs) 
-    public labels: StringKeyValue[];
- 
-    // Number of events for the time period (calculated field) 
-    public eventCount: number;
- 
-    // Is aggregated node 
-    public isGroup: boolean;
- 
-    // 
-    public deviceCount: number;
- 
-     constructor(id?: string, name?: string, ip?: string, type?: DeviceTypeCode, score?: number, tags?: string[], labels?: StringKeyValue[], eventCount?: number, isGroup?: boolean, deviceCount?: number) { 
-        if (id !== undefined) { this.id = id; }
-        if (name !== undefined) { this.name = name; }
-        if (ip !== undefined) { this.ip = ip; }
-        if (type !== undefined) { this.type = type; }
-        if (score !== undefined) { this.score = score; }
-        if (tags !== undefined) { this.tags = tags; }
-        if (labels !== undefined) { this.labels = labels; }
-        if (eventCount !== undefined) { this.eventCount = eventCount; }
-        if (isGroup !== undefined) { this.isGroup = isGroup; }
-        if (deviceCount !== undefined) { this.deviceCount = deviceCount; }
-    }
-
-}
-
-

package/src/lib/common/SeriesData.ts

@@ -1,22 +0,0 @@
-import { Interval } from '../common';
-import { StringKeyIntValue } from '../common';
-
-
-
-// SeriesData model represents a generic datapoint in interval range
-export class SeriesData {
- 
-    // Data interval 
-    public interval: Interval;
- 
-    // Custom attributes (key-value pairs) 
-    public values: StringKeyIntValue[];
- 
-     constructor(interval?: Interval, values?: StringKeyIntValue[]) { 
-        if (interval !== undefined) { this.interval = interval; }
-        if (values !== undefined) { this.values = values; }
-    }
-
-}
-
-

package/src/lib/common/SessionTransform.ts

@@ -1,29 +0,0 @@
-import { ZScore } from '../common';
-
-
-
-// Session data transformation parameters (to calculate z-score)
-export class SessionTransform {
- 
-    // ZScore parameters for incoming packets (to the device) 
-    public packetsIn: ZScore;
- 
-    // ZScore parameters for outgoing packets (from the device) 
-    public packetsOut: ZScore;
- 
-    // ZScore parameters for total number of incoming bytes (to the device) 
-    public bytesIn: ZScore;
- 
-    // ZScore parameters for total number of outgoing bytes (from the device) 
-    public bytesOut: ZScore;
- 
-     constructor(packetsIn?: ZScore, packetsOut?: ZScore, bytesIn?: ZScore, bytesOut?: ZScore) { 
-        if (packetsIn !== undefined) { this.packetsIn = packetsIn; }
-        if (packetsOut !== undefined) { this.packetsOut = packetsOut; }
-        if (bytesIn !== undefined) { this.bytesIn = bytesIn; }
-        if (bytesOut !== undefined) { this.bytesOut = bytesOut; }
-    }
-
-}
-
-

package/src/lib/common/SeverityIntervalTuple.ts

@@ -1,22 +0,0 @@
-import { SeverityTypeCode } from '../enums';
-import { Interval } from '../common';
-
-
-
-// SeverityIntervalTuple  is tuple of SeverityTypeCode and Interval
-export class SeverityIntervalTuple {
- 
-    // Event severity type code 
-    public severity: SeverityTypeCode;
- 
-    // Severity interval from-to 
-    public interval: Interval;
- 
-     constructor(severity?: SeverityTypeCode, interval?: Interval) { 
-        if (severity !== undefined) { this.severity = severity; }
-        if (interval !== undefined) { this.interval = interval; }
-    }
-
-}
-
-