@shieldiot/pulse-lib 1.0.5 → 1.0.6

package/src/lib/entities/AccountDTO.ts

@@ -1,49 +0,0 @@
-import { AccountStatusCode } from '../enums';
-import { FeatureCode } from '../enums';
-import { StringKeyValue } from '../common';
-import { AccountSettings } from '../entities';
-import { BaseEntity } from '../entities';
-import { AccountTypeCode } from '../enums';
-
-
-
-// AccountDTO includes additional data for display
-export class AccountDTO extends BaseEntity {
- 
-    // Account name 
-    public name: string;
- 
-    // The account identity in the external system (e.g. Billing, CRM etc) @json:externalId"` 
-    public externalId: string;
- 
-    // Account description 
-    public description: string;
- 
-    // Account Type: UNDEFINED | DEMO | TRIAL | PARTNER | CUSTOMER 
-    public type: AccountTypeCode;
- 
-    // Account status: UNDEFINED | ACTIVE | SUSPENDED 
-    public status: AccountStatusCode;
- 
-    // List of associated account groups (for feature toggle) 
-    public groups: string[];
- 
-    // List of all features from all the groups 
-    public features: FeatureCode[];
- 
-    // When the account will be expired [Epoch milliseconds Timestamp] (0 means no expiration time) 
-    public expiredOn: number;
- 
-    // Additional user defined tags 
-    public tags: string[];
- 
-    // List of custom attributes (key-value pairs) 
-    public labels: StringKeyValue[];
- 
-    // Account specific attributes 
-    public settings: AccountSettings;
- 
- 
-}
-
-

package/src/lib/entities/AccountSettings.ts

@@ -1,31 +0,0 @@
-import { HomePageViewCode } from '../enums';
-import { ComplianceReportSettings } from '../entities';
-import { TeaserPopUpSettings } from '../entities';
-
-
-
-// AccountSettings is a set of account attributes
-export class AccountSettings {
- 
-    // Account logo URL (starts with http) or embedded image (base64) 
-    public logo: string;
- 
-    // Default home page view 
-    public defaultHomePageView: HomePageViewCode;
- 
-    // ComplianceReportSettings specific attributes 
-    public complianceReportSettings: ComplianceReportSettings;
- 
-    // Teaser pop up settings attributes 
-    public teaserPopUpSettings: TeaserPopUpSettings;
- 
-     constructor(logo?: string, defaultHomePageView?: HomePageViewCode, complianceReportSettings?: ComplianceReportSettings, teaserPopUpSettings?: TeaserPopUpSettings) { 
-        if (logo !== undefined) { this.logo = logo; }
-        if (defaultHomePageView !== undefined) { this.defaultHomePageView = defaultHomePageView; }
-        if (complianceReportSettings !== undefined) { this.complianceReportSettings = complianceReportSettings; }
-        if (teaserPopUpSettings !== undefined) { this.teaserPopUpSettings = teaserPopUpSettings; }
-    }
-
-}
-
-

package/src/lib/entities/Action.ts

@@ -1,30 +0,0 @@
-import { DeviceActionCode } from '../enums';
-import { BaseEntity } from '../entities';
-
-
-
-// Action entity is a user action applied on an event or device
-export class Action extends BaseEntity {
- 
-    // Account Id 
-    public accountId: string;
- 
-    // Stream Id 
-    public streamId: string;
- 
-    // Event Id (in case action was applied on an event) 
-    public eventId: string;
- 
-    // Device Id (in case action was applied on a device) 
-    public deviceId: string;
- 
-    // Action type: UNDEFINED | REDIRECT | SUSPEND | BLOCK_IP ... 
-    public action: DeviceActionCode;
- 
-    // User id who applied the action 
-    public userId: string;
- 
- 
-}
-
-

package/src/lib/entities/Alert.ts

@@ -1,91 +0,0 @@
-import { SeverityTypeCode } from '../enums';
-import { EventStatusCode } from '../enums';
-import { StringKeyValue } from '../common';
-import { BaseEntity } from '../entities';
-import { TrafficDirectionCode } from '../enums';
-import { EventTypeCode } from '../enums';
-import { RuleTypeCode } from '../enums';
-import { GeoData } from '../common';
-import { EventCategoryCode } from '../enums';
-
-
-
-// Cyber event entity
-// The Event entity is created by multiple services (e.g. ip reputation, static rules, anomaly detection) by analyzing network statistics (usage and session data) and related to specific IP address.
-// Since it is not always clear what is the actual device with the IP address (RADIUS or DIAMETER logs can be provided later), we should be able to create event without device Id and assign the device Id later on.
-// For this purpose, when the device Id is not provided, the event will be created with the `unknown` value in the deviceId field and the eventId must follow the following pattern: streamId:timestamp:ip_address
-export class Alert extends BaseEntity {
- 
-    // Account Id 
-    public accountId: string;
- 
-    // Stream Id 
-    public streamId: string;
- 
-    // Device Id 
-    public deviceId: string;
- 
-    // Start window time [Epoch milliseconds Timestamp] 
-    public startTime: number;
- 
-    // End window time [Epoch milliseconds Timestamp] 
-    public endTime: number;
- 
-    // Event type: UNDEFINED | DDOS | PORT_SCANNING | DEVICE_TAKEOVER ... 
-    public type: EventTypeCode;
- 
-    // Event severity level: UNDEFINED | LOW | MEDIUM | HIGH | CRITICAL 
-    public severity: SeverityTypeCode;
- 
-    // Event current security score 
-    public score: number;
- 
-    // Probability score by IP reputation engine 
-    public probability: number;
- 
-    // Event workflow status: UNDEFINED | NEW | OPEN ... 
-    public status: EventStatusCode;
- 
-    // Rule type: UNDEFINED | SUSPICIOUS_IP | STATIC | ANOMALY 
-    public ruleType: RuleTypeCode;
- 
-    // Static Rule id (in case of SUSPICIOUS_IP, it should be the IP value) 
-    public ruleId: string;
- 
-    // The allocated IP for the device at the time of the event occurrence 
-    public sourceIp: string;
- 
-    // Target IP address for some of the events (e.g. suspicious IP) 
-    public targetIp: string;
- 
-    // GeoIP information based on MaxMind database 
-    public targetLocation: GeoData;
- 
-    // Event description 
-    public description: string;
- 
-    // Additional Event tags 
-    public tags: string[];
- 
-    // List of custom attributes (key-value pairs) 
-    public labels: StringKeyValue[];
- 
-    // Event category 
-    public category: EventCategoryCode;
- 
-    // Recommended action description to apply on the device 
-    public recommendedAction: string;
- 
-    // Denotes network traffic direction: UNDEFINED | INBOUND | OUTBOUND 
-    public trafficDirection: TrafficDirectionCode;
- 
-    // Contains confidence score of malicious IP detection. Value range: 0-100 
-    public confidenceScore: number;
- 
-    // Event occurrences count 
-    public occurrencesCount: boolean;
- 
- 
-}
-
-

package/src/lib/entities/AlertWithDevice.ts

@@ -1,92 +0,0 @@
-import { EventTypeCode } from '../enums';
-import { SeverityTypeCode } from '../enums';
-import { RuleTypeCode } from '../enums';
-import { EventStatusCode } from '../enums';
-import { GeoData } from '../common';
-import { StringKeyValue } from '../common';
-import { EventCategoryCode } from '../enums';
-import { TrafficDirectionCode } from '../enums';
-import { Device } from '../entities';
-import { BaseEntity } from '../entities';
-
-
-
-// AlertWithDevice entity is an event with the device information (for display only)
-export class AlertWithDevice extends BaseEntity {
- 
-    // Account Id 
-    public accountId: string;
- 
-    // Stream Id 
-    public streamId: string;
- 
-    // Device Id 
-    public deviceId: string;
- 
-    // Start window time [Epoch milliseconds Timestamp] 
-    public startTime: number;
- 
-    // End window time [Epoch milliseconds Timestamp] 
-    public endTime: number;
- 
-    // Event type: UNDEFINED | DDOS | PORT_SCANNING | DEVICE_TAKEOVER ... 
-    public type: EventTypeCode;
- 
-    // Event severity level: UNDEFINED | LOW | MEDIUM | HIGH | CRITICAL 
-    public severity: SeverityTypeCode;
- 
-    // Event current security score 
-    public score: number;
- 
-    // Probability score by IP reputation engine 
-    public probability: number;
- 
-    // Event workflow status: UNDEFINED | NEW | OPEN ... 
-    public status: EventStatusCode;
- 
-    // Rule type: UNDEFINED | SUSPICIOUS_IP | STATIC | ANOMALY 
-    public ruleType: RuleTypeCode;
- 
-    // Static Rule id (in case of SUSPICIOUS_IP, it should be the IP value) 
-    public ruleId: string;
- 
-    // The allocated IP for the device at the time of the event occurrence 
-    public sourceIp: string;
- 
-    // Target IP address for some of the events (e.g. suspicious IP) 
-    public targetIp: string;
- 
-    // GeoIP information based on MaxMind database 
-    public targetLocation: GeoData;
- 
-    // Event description 
-    public description: string;
- 
-    // Additional Event tags 
-    public tags: string[];
- 
-    // List of custom attributes (key-value pairs) 
-    public labels: StringKeyValue[];
- 
-    // Event category 
-    public category: EventCategoryCode;
- 
-    // Recommended action description to apply on the device 
-    public recommendedAction: string;
- 
-    // Denotes network traffic direction: UNDEFINED | INBOUND | OUTBOUND 
-    public trafficDirection: TrafficDirectionCode;
- 
-    // Contains confidence score of malicious IP detection. Value range: 0-100 
-    public confidenceScore: number;
- 
-    // Event occurrences count 
-    public occurrencesCount: boolean;
- 
-    // Device attached to the event 
-    public device: Device;
- 
- 
-}
-
-

package/src/lib/entities/ApiKey.ts

@@ -1,33 +0,0 @@
-import { StringKeyIntValue } from '../common';
-import { BaseEntity } from '../entities';
-
-
-
-// ApiKey entity is a structure representing the source data fields encapsulated in the API key
-export class ApiKey extends BaseEntity {
- 
-    // API Key name 
-    public name: string;
- 
-    // Default session token expiration TTL (in minutes), 0 means no TTL 
-    public ttl: number;
- 
-    // Access Control List - list of accessible resources with permissions flags (1:Read, 2:Create, 4:Update, 8:Delete, 16:Action) 
-    public acl: StringKeyIntValue[];
- 
-    // Key version (for key rotation) 
-    public version: number;
- 
-    // Flag to indicate if this a system key or user defined key 
-    public systemKey: boolean;
- 
-    // Flag to indicate if the key is enabled 
-    public enabled: boolean;
- 
-    // The API Key (this value is auto generated and not stored in the DB) 
-    public key: string;
- 
- 
-}
-
-

package/src/lib/entities/AuditLog.ts

@@ -1,39 +0,0 @@
-import { UserTypeCode } from '../enums';
-import { BaseEntity } from '../entities';
-
-
-
-// Audit Log - each entry represents a single action done by user
-export class AuditLog extends BaseEntity {
- 
-    // Account Id (empty if it is non-account entity) 
-    public accountId: string;
- 
-    // User Id 
-    public userId: string;
- 
-    // User type 
-    public userType: UserTypeCode;
- 
-    // Action that was performed 
-    public action: string;
- 
-    // Changed item type 
-    public itemType: string;
- 
-    // Changed item Id 
-    public itemId: string;
- 
-    // Item Name 
-    public itemName: string;
- 
-    // Item value before change [Json] 
-    public beforeChange: string;
- 
-    // Item delta after change [Json] 
-    public afterChange: string;
- 
- 
-}
-
-

package/src/lib/entities/BaseEntity.ts

@@ -1,24 +0,0 @@
-
-
-
-// Base entity includes common fields for all entities (persistence objects) in the system
-export class BaseEntity {
- 
-    // Entity Id 
-    public id: string;
- 
-    // When the entity was created [Epoch milliseconds Timestamp] 
-    public createdOn: number;
- 
-    // When the entity was updated [Epoch milliseconds Timestamp] 
-    public updatedOn: number;
- 
-     constructor(id?: string, createdOn?: number, updatedOn?: number) { 
-        if (id !== undefined) { this.id = id; }
-        if (createdOn !== undefined) { this.createdOn = createdOn; }
-        if (updatedOn !== undefined) { this.updatedOn = updatedOn; }
-    }
-
-}
-
-

package/src/lib/entities/BulkDevices.ts

@@ -1,17 +0,0 @@
-import { Device } from '../entities';
-
-
-
-// BulkDevices list of devices for bulk operations
-export class BulkDevices {
- 
-    // List of devices 
-    public values: Device[];
- 
-     constructor(values?: Device[]) { 
-        if (values !== undefined) { this.values = values; }
-    }
-
-}
-
-

package/src/lib/entities/Checkpoint.ts

@@ -1,71 +0,0 @@
-import { BaseEntity } from '../entities';
-
-
-
-// Checkpoint represents parsing status in time that preserves parsing cycle statistics and last checkpoint (timestamp) to avoid parsing the same files over and over again
-export class Checkpoint extends BaseEntity {
- 
-    // Account Id 
-    public accountId: string;
- 
-    // Stream Id 
-    public streamId: string;
- 
-    // Timestamp marking checkpoint time [Epoch milliseconds Timestamp] 
-    public checkpoint: number;
- 
-    // First packet timestamp [Epoch milliseconds Timestamp] 
-    public firstPacketTime: number;
- 
-    // Last packet timestamp [Epoch milliseconds Timestamp] 
-    public lastPacketTime: number;
- 
-    // Checkpoint label (usually file name) 
-    public label: string;
- 
-    // General purpose description 
-    public description: string;
- 
-    // Total elapsed time (between updated and created time) 
-    public elapsed: number;
- 
-    // Total files parsed in this cycle 
-    public totalFiles: number;
- 
-    // Total packets parsed in this cycle 
-    public totalPackets: number;
- 
-    // Total usage records created 
-    public totalUsage: number;
- 
-    // Total session records created 
-    public totalSession: number;
- 
-    // Total RADIUS records created 
-    public totalRadius: number;
- 
-    // Total number of overlapped packets (their timestamp is earlier than the latest checkpoint) 
-    public overlappedPackets: number;
- 
-    // Total number of packets that failed parsing 
-    public failedPackets: number;
- 
-    // Total number of packets nor related to the tracked devices 
-    public irrelevantPackets: number;
- 
-    // Total number of packets that could not be mapped to device identity 
-    public unmappedPackets: number;
- 
-    // Total number of successfully processed packets 
-    public processedPackets: number;
- 
-    // Checkpoint state: 0 - created, 1 - in progress, 2 - completed 
-    public state: number;
- 
-    // Identity of the worker processed the file 
-    public processedBy: string;
- 
- 
-}
-
-

package/src/lib/entities/ComplianceReportSettings.ts

@@ -1,28 +0,0 @@
-
-
-
-// ComplianceReportSettings is a set of account's compliance report settings.
-export class ComplianceReportSettings {
- 
-    // Compliance report title 
-    public title: string;
- 
-    // Compliance report subtitle 
-    public subTitle: string;
- 
-    // Compliance report header 
-    public header: string;
- 
-    // Compliance report footer 
-    public footer: string;
- 
-     constructor(title?: string, subTitle?: string, header?: string, footer?: string) { 
-        if (title !== undefined) { this.title = title; }
-        if (subTitle !== undefined) { this.subTitle = subTitle; }
-        if (header !== undefined) { this.header = header; }
-        if (footer !== undefined) { this.footer = footer; }
-    }
-
-}
-
-

package/src/lib/entities/Condition.ts

@@ -1,28 +0,0 @@
-import { OperatorCode } from '../enums';
-
-
-
-export class Condition {
- 
-    // Field name 
-    public field: string;
- 
-    // Operator symbol: Eq(=), Neq(!), Gt(>), Gte(>=), Lt(<), Lte(<=), In(*), Not In(-), Between(#) 
-    public operator: OperatorCode;
- 
-    // Operand double values (more than one values applicable for operators: In(*), Not In(-), Range(#) 
-    public values: number[];
- 
-    // Operand string values (more than one values applicable for operators: In(*), Not In(-) 
-    public strings: string[];
- 
-     constructor(field?: string, operator?: OperatorCode, values?: number[], strings?: string[]) { 
-        if (field !== undefined) { this.field = field; }
-        if (operator !== undefined) { this.operator = operator; }
-        if (values !== undefined) { this.values = values; }
-        if (strings !== undefined) { this.strings = strings; }
-    }
-
-}
-
-

package/src/lib/entities/ConfigParam.ts

@@ -1,15 +0,0 @@
-import { BaseEntity } from '../entities';
-
-
-
-// ConfigParam stores a key-value pair as a system configuration parameter
-// The id is the key of the parameter
-export class ConfigParam extends BaseEntity {
- 
-    // configuration value 
-    public value: string;
- 
- 
-}
-
-

package/src/lib/entities/DNSRecord.ts

@@ -1,40 +0,0 @@
-import { BaseEntity } from '../entities';
-
-
-
-// DNSRecord represents network statistics of DNS requests
-// The createdOn field represents the first communication time of the device within this time window
-// The updatedOn field represents the last communication time of the device within this time window
-export class DNSRecord extends BaseEntity {
- 
-    // Indication to the source location of the record 
-    public source: string;
- 
-    // Device Id 
-    public deviceId: string;
- 
-    // Device IP 
-    public deviceIp: string;
- 
-    // Account Id 
-    public accountId: string;
- 
-    // Stream Id 
-    public streamId: string;
- 
-    // Start window time [Epoch milliseconds Timestamp] 
-    public startTime: number;
- 
-    // End window time [Epoch milliseconds Timestamp] 
-    public endTime: number;
- 
-    // Fully Qualified Domain Name 
-    public fqdn: string;
- 
-    // List of A records 
-    public records: string[];
- 
- 
-}
-
-

package/src/lib/entities/DataIngestion.ts

@@ -1,63 +0,0 @@
-import { DeviceTypeCode } from '../enums';
-import { DeviceCreationCode } from '../enums';
-import { DeviceIdentityCode } from '../enums';
-
-
-
-// DataIngestion is the ingestion pipeline configuration
-export class DataIngestion {
- 
-    // Input files locations 
-    public inputURI: string;
- 
-    // File format: pcap / pcapng (default) 
-    public format: string;
- 
-    // Where to archive processed files 
-    public archiveURI: string;
- 
-    // Input files extensions (filter by extensions) - ignore if empty 
-    public inputFilesExt: string[];
- 
-    // List of IoT devices subnets - ignore if empty 
-    public subNets: string[];
- 
-    // List of subnets or IPs to exclude 
-    public exclude: string[];
- 
-    // Usage time window for aggregation (in seconds) 
-    public usageTimeWindowSec: number;
- 
-    // Session time window for aggregation (in seconds) 
-    public sessionTimeWindowSec: number;
- 
-    // Cron schedule template in 6 segment format (see: https://en.wikipedia.org/wiki/Cron) - leave empty for immediate processing 
-    public schedule: string;
- 
-    // Default device type: UNDEFINED | OTHER | CONTROLLER | METER | SENSOR ... 
-    public defaultDeviceType: DeviceTypeCode;
- 
-    // Device creation policy based on the PCP parsing (NONE | IP | SID | EID) 
-    public deviceCreationPolicy: DeviceCreationCode;
- 
-    // How to identify devices during the PCAP parsing (NONE | IP | SID | EID) 
-    public deviceIdentityPolicy: DeviceIdentityCode;
- 
-     constructor(inputURI?: string, format?: string, archiveURI?: string, inputFilesExt?: string[], subNets?: string[], exclude?: string[], usageTimeWindowSec?: number, sessionTimeWindowSec?: number, schedule?: string, defaultDeviceType?: DeviceTypeCode, deviceCreationPolicy?: DeviceCreationCode, deviceIdentityPolicy?: DeviceIdentityCode) { 
-        if (inputURI !== undefined) { this.inputURI = inputURI; }
-        if (format !== undefined) { this.format = format; }
-        if (archiveURI !== undefined) { this.archiveURI = archiveURI; }
-        if (inputFilesExt !== undefined) { this.inputFilesExt = inputFilesExt; }
-        if (subNets !== undefined) { this.subNets = subNets; }
-        if (exclude !== undefined) { this.exclude = exclude; }
-        if (usageTimeWindowSec !== undefined) { this.usageTimeWindowSec = usageTimeWindowSec; }
-        if (sessionTimeWindowSec !== undefined) { this.sessionTimeWindowSec = sessionTimeWindowSec; }
-        if (schedule !== undefined) { this.schedule = schedule; }
-        if (defaultDeviceType !== undefined) { this.defaultDeviceType = defaultDeviceType; }
-        if (deviceCreationPolicy !== undefined) { this.deviceCreationPolicy = deviceCreationPolicy; }
-        if (deviceIdentityPolicy !== undefined) { this.deviceIdentityPolicy = deviceIdentityPolicy; }
-    }
-
-}
-
-

package/src/lib/entities/DataPointOfDeviceReport.ts

@@ -1,21 +0,0 @@
-import { DeviceReport } from '../entities';
-
-
-
-// TimeSeriesOfDeviceReport model represents a time series of DeviceReport
-export class DataPointOfDeviceReport {
- 
-    // Sata point timestamp [Epoch milliseconds Timestamp] 
-    public timestamp: number;
- 
-    // Device report value 
-    public value: DeviceReport;
- 
-     constructor(timestamp?: number, value?: DeviceReport) { 
-        if (timestamp !== undefined) { this.timestamp = timestamp; }
-        if (value !== undefined) { this.value = value; }
-    }
-
-}
-
-