@shieldiot/ngx-pulseiot-lib 2.18.1119 → 2.18.1121
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/esm2022/lib/services/SysFeaturesService.mjs +1 -1
- package/esm2022/lib/services/SysIdsRulesService.mjs +11 -5
- package/esm2022/lib/services/UsrEventsService.mjs +178 -16
- package/fesm2022/shieldiot-ngx-pulseiot-lib.mjs +187 -19
- package/fesm2022/shieldiot-ngx-pulseiot-lib.mjs.map +1 -1
- package/lib/services/SysFeaturesService.d.ts +3 -3
- package/lib/services/SysIdsRulesService.d.ts +9 -5
- package/lib/services/UsrEventsService.d.ts +23 -20
- package/package.json +1 -1
|
@@ -4913,17 +4913,23 @@ class SysIdsRulesService {
|
|
|
4913
4913
|
/**
|
|
4914
4914
|
* Find rules by query
|
|
4915
4915
|
*/
|
|
4916
|
-
find(
|
|
4916
|
+
find(streamId, search, eventSeverity, activityStatus, eventType, sort, page, size) {
|
|
4917
4917
|
const params = [];
|
|
4918
|
-
if (accountId != null) {
|
|
4919
|
-
params.push(`accountId=${accountId}`);
|
|
4920
|
-
}
|
|
4921
4918
|
if (streamId != null) {
|
|
4922
4919
|
params.push(`streamId=${streamId}`);
|
|
4923
4920
|
}
|
|
4924
4921
|
if (search != null) {
|
|
4925
4922
|
params.push(`search=${search}`);
|
|
4926
4923
|
}
|
|
4924
|
+
if (eventSeverity != null) {
|
|
4925
|
+
params.push(`eventSeverity=${eventSeverity}`);
|
|
4926
|
+
}
|
|
4927
|
+
if (activityStatus != null) {
|
|
4928
|
+
params.push(`activityStatus=${activityStatus}`);
|
|
4929
|
+
}
|
|
4930
|
+
if (eventType != null) {
|
|
4931
|
+
params.push(`eventType=${eventType}`);
|
|
4932
|
+
}
|
|
4927
4933
|
if (sort != null) {
|
|
4928
4934
|
params.push(`sort=${sort}`);
|
|
4929
4935
|
}
|
|
@@ -6553,7 +6559,7 @@ class UsrEventsService {
|
|
|
6553
6559
|
/**
|
|
6554
6560
|
* Find events by query
|
|
6555
6561
|
*/
|
|
6556
|
-
find(streamId, deviceId, alertId, search, from, to, type, severity, sort, page, size) {
|
|
6562
|
+
find(streamId, deviceId, alertId, search, from, to, type, severity, category, status, ruleId, targetIp, ruleType, sort, page, size) {
|
|
6557
6563
|
const params = [];
|
|
6558
6564
|
if (streamId != null) {
|
|
6559
6565
|
params.push(`streamId=${streamId}`);
|
|
@@ -6579,6 +6585,21 @@ class UsrEventsService {
|
|
|
6579
6585
|
if (severity != null) {
|
|
6580
6586
|
params.push(`severity=${severity}`);
|
|
6581
6587
|
}
|
|
6588
|
+
if (category != null) {
|
|
6589
|
+
params.push(`category=${category}`);
|
|
6590
|
+
}
|
|
6591
|
+
if (status != null) {
|
|
6592
|
+
params.push(`status=${status}`);
|
|
6593
|
+
}
|
|
6594
|
+
if (ruleId != null) {
|
|
6595
|
+
params.push(`ruleId=${ruleId}`);
|
|
6596
|
+
}
|
|
6597
|
+
if (targetIp != null) {
|
|
6598
|
+
params.push(`targetIp=${targetIp}`);
|
|
6599
|
+
}
|
|
6600
|
+
if (ruleType != null) {
|
|
6601
|
+
params.push(`ruleType=${ruleType}`);
|
|
6602
|
+
}
|
|
6582
6603
|
if (sort != null) {
|
|
6583
6604
|
params.push(`sort=${sort}`);
|
|
6584
6605
|
}
|
|
@@ -6593,7 +6614,7 @@ class UsrEventsService {
|
|
|
6593
6614
|
/**
|
|
6594
6615
|
* Export events by query to a file in a stream of CSV | JSON | XML | XLSX
|
|
6595
6616
|
*/
|
|
6596
|
-
export(format, streamId, deviceId, alertId, search, from, to, type, severity, sort, page, size) {
|
|
6617
|
+
export(format, streamId, deviceId, alertId, search, from, to, type, severity, category, status, ruleId, targetIp, ruleType, sort, page, size) {
|
|
6597
6618
|
const params = [];
|
|
6598
6619
|
if (streamId != null) {
|
|
6599
6620
|
params.push(`streamId=${streamId}`);
|
|
@@ -6619,6 +6640,21 @@ class UsrEventsService {
|
|
|
6619
6640
|
if (severity != null) {
|
|
6620
6641
|
params.push(`severity=${severity}`);
|
|
6621
6642
|
}
|
|
6643
|
+
if (category != null) {
|
|
6644
|
+
params.push(`category=${category}`);
|
|
6645
|
+
}
|
|
6646
|
+
if (status != null) {
|
|
6647
|
+
params.push(`status=${status}`);
|
|
6648
|
+
}
|
|
6649
|
+
if (ruleId != null) {
|
|
6650
|
+
params.push(`ruleId=${ruleId}`);
|
|
6651
|
+
}
|
|
6652
|
+
if (targetIp != null) {
|
|
6653
|
+
params.push(`targetIp=${targetIp}`);
|
|
6654
|
+
}
|
|
6655
|
+
if (ruleType != null) {
|
|
6656
|
+
params.push(`ruleType=${ruleType}`);
|
|
6657
|
+
}
|
|
6622
6658
|
if (sort != null) {
|
|
6623
6659
|
params.push(`sort=${sort}`);
|
|
6624
6660
|
}
|
|
@@ -6639,7 +6675,7 @@ class UsrEventsService {
|
|
|
6639
6675
|
/**
|
|
6640
6676
|
* Get top 10 events by their severity and time
|
|
6641
6677
|
*/
|
|
6642
|
-
findTop(streamId, deviceId, search, from, to, type, severity, sort, page, size) {
|
|
6678
|
+
findTop(streamId, deviceId, alertId, search, from, to, type, severity, category, status, ruleId, targetIp, ruleType, sort, page, size) {
|
|
6643
6679
|
const params = [];
|
|
6644
6680
|
if (streamId != null) {
|
|
6645
6681
|
params.push(`streamId=${streamId}`);
|
|
@@ -6647,6 +6683,9 @@ class UsrEventsService {
|
|
|
6647
6683
|
if (deviceId != null) {
|
|
6648
6684
|
params.push(`deviceId=${deviceId}`);
|
|
6649
6685
|
}
|
|
6686
|
+
if (alertId != null) {
|
|
6687
|
+
params.push(`alertId=${alertId}`);
|
|
6688
|
+
}
|
|
6650
6689
|
if (search != null) {
|
|
6651
6690
|
params.push(`search=${search}`);
|
|
6652
6691
|
}
|
|
@@ -6662,6 +6701,21 @@ class UsrEventsService {
|
|
|
6662
6701
|
if (severity != null) {
|
|
6663
6702
|
params.push(`severity=${severity}`);
|
|
6664
6703
|
}
|
|
6704
|
+
if (category != null) {
|
|
6705
|
+
params.push(`category=${category}`);
|
|
6706
|
+
}
|
|
6707
|
+
if (status != null) {
|
|
6708
|
+
params.push(`status=${status}`);
|
|
6709
|
+
}
|
|
6710
|
+
if (ruleId != null) {
|
|
6711
|
+
params.push(`ruleId=${ruleId}`);
|
|
6712
|
+
}
|
|
6713
|
+
if (targetIp != null) {
|
|
6714
|
+
params.push(`targetIp=${targetIp}`);
|
|
6715
|
+
}
|
|
6716
|
+
if (ruleType != null) {
|
|
6717
|
+
params.push(`ruleType=${ruleType}`);
|
|
6718
|
+
}
|
|
6665
6719
|
if (sort != null) {
|
|
6666
6720
|
params.push(`sort=${sort}`);
|
|
6667
6721
|
}
|
|
@@ -6676,7 +6730,7 @@ class UsrEventsService {
|
|
|
6676
6730
|
/**
|
|
6677
6731
|
* Get top 10 events by their severity and time
|
|
6678
6732
|
*/
|
|
6679
|
-
findTopMaliciousIPs(streamId, top) {
|
|
6733
|
+
findTopMaliciousIPs(streamId, top, from, to) {
|
|
6680
6734
|
const params = [];
|
|
6681
6735
|
if (streamId != null) {
|
|
6682
6736
|
params.push(`streamId=${streamId}`);
|
|
@@ -6684,12 +6738,18 @@ class UsrEventsService {
|
|
|
6684
6738
|
if (top != null) {
|
|
6685
6739
|
params.push(`top=${top}`);
|
|
6686
6740
|
}
|
|
6741
|
+
if (from != null) {
|
|
6742
|
+
params.push(`from=${from}`);
|
|
6743
|
+
}
|
|
6744
|
+
if (to != null) {
|
|
6745
|
+
params.push(`to=${to}`);
|
|
6746
|
+
}
|
|
6687
6747
|
return this.rest.get(`${this.baseUrl}/top-malicious-ips`, ...params);
|
|
6688
6748
|
}
|
|
6689
6749
|
/**
|
|
6690
6750
|
* Get events distribution by type filtered by query
|
|
6691
6751
|
*/
|
|
6692
|
-
countByType(streamId, deviceId, alertId, search, from, to, type, severity) {
|
|
6752
|
+
countByType(streamId, deviceId, alertId, search, from, to, type, severity, category, status, ruleId, targetIp, ruleType) {
|
|
6693
6753
|
const params = [];
|
|
6694
6754
|
if (streamId != null) {
|
|
6695
6755
|
params.push(`streamId=${streamId}`);
|
|
@@ -6715,12 +6775,27 @@ class UsrEventsService {
|
|
|
6715
6775
|
if (severity != null) {
|
|
6716
6776
|
params.push(`severity=${severity}`);
|
|
6717
6777
|
}
|
|
6778
|
+
if (category != null) {
|
|
6779
|
+
params.push(`category=${category}`);
|
|
6780
|
+
}
|
|
6781
|
+
if (status != null) {
|
|
6782
|
+
params.push(`status=${status}`);
|
|
6783
|
+
}
|
|
6784
|
+
if (ruleId != null) {
|
|
6785
|
+
params.push(`ruleId=${ruleId}`);
|
|
6786
|
+
}
|
|
6787
|
+
if (targetIp != null) {
|
|
6788
|
+
params.push(`targetIp=${targetIp}`);
|
|
6789
|
+
}
|
|
6790
|
+
if (ruleType != null) {
|
|
6791
|
+
params.push(`ruleType=${ruleType}`);
|
|
6792
|
+
}
|
|
6718
6793
|
return this.rest.get(`${this.baseUrl}/count/by-type`, ...params);
|
|
6719
6794
|
}
|
|
6720
6795
|
/**
|
|
6721
6796
|
* Get events distribution by status filtered by query
|
|
6722
6797
|
*/
|
|
6723
|
-
countByStatus(streamId, deviceId, alertId, search, from, to, type, severity) {
|
|
6798
|
+
countByStatus(streamId, deviceId, alertId, search, from, to, type, severity, category, status, ruleId, targetIp, ruleType) {
|
|
6724
6799
|
const params = [];
|
|
6725
6800
|
if (streamId != null) {
|
|
6726
6801
|
params.push(`streamId=${streamId}`);
|
|
@@ -6746,12 +6821,27 @@ class UsrEventsService {
|
|
|
6746
6821
|
if (severity != null) {
|
|
6747
6822
|
params.push(`severity=${severity}`);
|
|
6748
6823
|
}
|
|
6824
|
+
if (category != null) {
|
|
6825
|
+
params.push(`category=${category}`);
|
|
6826
|
+
}
|
|
6827
|
+
if (status != null) {
|
|
6828
|
+
params.push(`status=${status}`);
|
|
6829
|
+
}
|
|
6830
|
+
if (ruleId != null) {
|
|
6831
|
+
params.push(`ruleId=${ruleId}`);
|
|
6832
|
+
}
|
|
6833
|
+
if (targetIp != null) {
|
|
6834
|
+
params.push(`targetIp=${targetIp}`);
|
|
6835
|
+
}
|
|
6836
|
+
if (ruleType != null) {
|
|
6837
|
+
params.push(`ruleType=${ruleType}`);
|
|
6838
|
+
}
|
|
6749
6839
|
return this.rest.get(`${this.baseUrl}/count/by-status`, ...params);
|
|
6750
6840
|
}
|
|
6751
6841
|
/**
|
|
6752
6842
|
* Get events distribution by severity filtered by query
|
|
6753
6843
|
*/
|
|
6754
|
-
countBySeverity(streamId, deviceId, alertId, search, from, to, type, severity) {
|
|
6844
|
+
countBySeverity(streamId, deviceId, alertId, search, from, to, type, severity, category, status, ruleId, targetIp, ruleType) {
|
|
6755
6845
|
const params = [];
|
|
6756
6846
|
if (streamId != null) {
|
|
6757
6847
|
params.push(`streamId=${streamId}`);
|
|
@@ -6777,12 +6867,27 @@ class UsrEventsService {
|
|
|
6777
6867
|
if (severity != null) {
|
|
6778
6868
|
params.push(`severity=${severity}`);
|
|
6779
6869
|
}
|
|
6870
|
+
if (category != null) {
|
|
6871
|
+
params.push(`category=${category}`);
|
|
6872
|
+
}
|
|
6873
|
+
if (status != null) {
|
|
6874
|
+
params.push(`status=${status}`);
|
|
6875
|
+
}
|
|
6876
|
+
if (ruleId != null) {
|
|
6877
|
+
params.push(`ruleId=${ruleId}`);
|
|
6878
|
+
}
|
|
6879
|
+
if (targetIp != null) {
|
|
6880
|
+
params.push(`targetIp=${targetIp}`);
|
|
6881
|
+
}
|
|
6882
|
+
if (ruleType != null) {
|
|
6883
|
+
params.push(`ruleType=${ruleType}`);
|
|
6884
|
+
}
|
|
6780
6885
|
return this.rest.get(`${this.baseUrl}/count/by-severity`, ...params);
|
|
6781
6886
|
}
|
|
6782
6887
|
/**
|
|
6783
6888
|
* Get events distribution by rule filtered by query
|
|
6784
6889
|
*/
|
|
6785
|
-
countByRule(streamId, deviceId, alertId, search, from, to, type, severity) {
|
|
6890
|
+
countByRule(streamId, deviceId, alertId, search, from, to, type, severity, category, status, ruleId, targetIp, ruleType) {
|
|
6786
6891
|
const params = [];
|
|
6787
6892
|
if (streamId != null) {
|
|
6788
6893
|
params.push(`streamId=${streamId}`);
|
|
@@ -6808,12 +6913,27 @@ class UsrEventsService {
|
|
|
6808
6913
|
if (severity != null) {
|
|
6809
6914
|
params.push(`severity=${severity}`);
|
|
6810
6915
|
}
|
|
6916
|
+
if (category != null) {
|
|
6917
|
+
params.push(`category=${category}`);
|
|
6918
|
+
}
|
|
6919
|
+
if (status != null) {
|
|
6920
|
+
params.push(`status=${status}`);
|
|
6921
|
+
}
|
|
6922
|
+
if (ruleId != null) {
|
|
6923
|
+
params.push(`ruleId=${ruleId}`);
|
|
6924
|
+
}
|
|
6925
|
+
if (targetIp != null) {
|
|
6926
|
+
params.push(`targetIp=${targetIp}`);
|
|
6927
|
+
}
|
|
6928
|
+
if (ruleType != null) {
|
|
6929
|
+
params.push(`ruleType=${ruleType}`);
|
|
6930
|
+
}
|
|
6811
6931
|
return this.rest.get(`${this.baseUrl}/count/by-rule`, ...params);
|
|
6812
6932
|
}
|
|
6813
6933
|
/**
|
|
6814
6934
|
* Get events distribution by category filtered by query
|
|
6815
6935
|
*/
|
|
6816
|
-
countByCategory(streamId, deviceId, alertId, search, from, to, type, severity) {
|
|
6936
|
+
countByCategory(streamId, deviceId, alertId, search, from, to, type, severity, category, status, ruleId, targetIp, ruleType) {
|
|
6817
6937
|
const params = [];
|
|
6818
6938
|
if (streamId != null) {
|
|
6819
6939
|
params.push(`streamId=${streamId}`);
|
|
@@ -6839,6 +6959,21 @@ class UsrEventsService {
|
|
|
6839
6959
|
if (severity != null) {
|
|
6840
6960
|
params.push(`severity=${severity}`);
|
|
6841
6961
|
}
|
|
6962
|
+
if (category != null) {
|
|
6963
|
+
params.push(`category=${category}`);
|
|
6964
|
+
}
|
|
6965
|
+
if (status != null) {
|
|
6966
|
+
params.push(`status=${status}`);
|
|
6967
|
+
}
|
|
6968
|
+
if (ruleId != null) {
|
|
6969
|
+
params.push(`ruleId=${ruleId}`);
|
|
6970
|
+
}
|
|
6971
|
+
if (targetIp != null) {
|
|
6972
|
+
params.push(`targetIp=${targetIp}`);
|
|
6973
|
+
}
|
|
6974
|
+
if (ruleType != null) {
|
|
6975
|
+
params.push(`ruleType=${ruleType}`);
|
|
6976
|
+
}
|
|
6842
6977
|
return this.rest.get(`${this.baseUrl}/count/by-category`, ...params);
|
|
6843
6978
|
}
|
|
6844
6979
|
/**
|
|
@@ -6850,7 +6985,7 @@ class UsrEventsService {
|
|
|
6850
6985
|
/**
|
|
6851
6986
|
* Get events histogram over the provided time period
|
|
6852
6987
|
*/
|
|
6853
|
-
eventsTimeline(streamId, deviceId, alertId, dimension,
|
|
6988
|
+
eventsTimeline(streamId, deviceId, alertId, dimension, from, to, type, severity, category, status, ruleId, targetIp, ruleType) {
|
|
6854
6989
|
const params = [];
|
|
6855
6990
|
if (streamId != null) {
|
|
6856
6991
|
params.push(`streamId=${streamId}`);
|
|
@@ -6864,9 +6999,6 @@ class UsrEventsService {
|
|
|
6864
6999
|
if (dimension != null) {
|
|
6865
7000
|
params.push(`dimension=${dimension}`);
|
|
6866
7001
|
}
|
|
6867
|
-
if (search != null) {
|
|
6868
|
-
params.push(`search=${search}`);
|
|
6869
|
-
}
|
|
6870
7002
|
if (from != null) {
|
|
6871
7003
|
params.push(`from=${from}`);
|
|
6872
7004
|
}
|
|
@@ -6879,22 +7011,43 @@ class UsrEventsService {
|
|
|
6879
7011
|
if (severity != null) {
|
|
6880
7012
|
params.push(`severity=${severity}`);
|
|
6881
7013
|
}
|
|
7014
|
+
if (category != null) {
|
|
7015
|
+
params.push(`category=${category}`);
|
|
7016
|
+
}
|
|
7017
|
+
if (status != null) {
|
|
7018
|
+
params.push(`status=${status}`);
|
|
7019
|
+
}
|
|
7020
|
+
if (ruleId != null) {
|
|
7021
|
+
params.push(`ruleId=${ruleId}`);
|
|
7022
|
+
}
|
|
7023
|
+
if (targetIp != null) {
|
|
7024
|
+
params.push(`targetIp=${targetIp}`);
|
|
7025
|
+
}
|
|
7026
|
+
if (ruleType != null) {
|
|
7027
|
+
params.push(`ruleType=${ruleType}`);
|
|
7028
|
+
}
|
|
6882
7029
|
return this.rest.get(`${this.baseUrl}/timeline`, ...params);
|
|
6883
7030
|
}
|
|
6884
7031
|
/**
|
|
6885
7032
|
* Get shieldex histogram over the provided time period
|
|
6886
7033
|
*/
|
|
6887
|
-
shieldexTimeline(streamId) {
|
|
7034
|
+
shieldexTimeline(streamId, from, to) {
|
|
6888
7035
|
const params = [];
|
|
6889
7036
|
if (streamId != null) {
|
|
6890
7037
|
params.push(`streamId=${streamId}`);
|
|
6891
7038
|
}
|
|
7039
|
+
if (from != null) {
|
|
7040
|
+
params.push(`from=${from}`);
|
|
7041
|
+
}
|
|
7042
|
+
if (to != null) {
|
|
7043
|
+
params.push(`to=${to}`);
|
|
7044
|
+
}
|
|
6892
7045
|
return this.rest.get(`${this.baseUrl}/shieldex/timeline`, ...params);
|
|
6893
7046
|
}
|
|
6894
7047
|
/**
|
|
6895
7048
|
* Get devices at risk number for specific events criteria
|
|
6896
7049
|
*/
|
|
6897
|
-
getDevicesAtRisk(streamId, search, from, to, type, severity) {
|
|
7050
|
+
getDevicesAtRisk(streamId, search, from, to, type, severity, category, status, ruleId, targetIp, ruleType) {
|
|
6898
7051
|
const params = [];
|
|
6899
7052
|
if (streamId != null) {
|
|
6900
7053
|
params.push(`streamId=${streamId}`);
|
|
@@ -6914,6 +7067,21 @@ class UsrEventsService {
|
|
|
6914
7067
|
if (severity != null) {
|
|
6915
7068
|
params.push(`severity=${severity}`);
|
|
6916
7069
|
}
|
|
7070
|
+
if (category != null) {
|
|
7071
|
+
params.push(`category=${category}`);
|
|
7072
|
+
}
|
|
7073
|
+
if (status != null) {
|
|
7074
|
+
params.push(`status=${status}`);
|
|
7075
|
+
}
|
|
7076
|
+
if (ruleId != null) {
|
|
7077
|
+
params.push(`ruleId=${ruleId}`);
|
|
7078
|
+
}
|
|
7079
|
+
if (targetIp != null) {
|
|
7080
|
+
params.push(`targetIp=${targetIp}`);
|
|
7081
|
+
}
|
|
7082
|
+
if (ruleType != null) {
|
|
7083
|
+
params.push(`ruleType=${ruleType}`);
|
|
7084
|
+
}
|
|
6917
7085
|
return this.rest.get(`${this.baseUrl}/devices-at-risk`, ...params);
|
|
6918
7086
|
}
|
|
6919
7087
|
/**
|