forked from midnightslacker/SigSciApiPy
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathSigSci.py
executable file
·2127 lines (1720 loc) · 88 KB
/
SigSci.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#!/usr/bin/env python
"""
Signal Sciences Python API Client
"""
from __future__ import print_function
import argparse
import csv
import datetime
import time
import calendar
import json
import os
import sys
import math
from configparser import ConfigParser
from builtins import str
import requests
# API Query settings
# For help with time search syntax see:
# https://dashboard.signalsciences.net/documentation/knowledge-base/search-syntax#time
FROM = None # example: FROM = '-6h'
UNTIL = None # example: UNTIL = '-4h'
TAGS = None # example <array>: TAGS = ['SQLI', 'XSS', 'TRAVERSAL']
CTAGS = None # example: CTAGS = 'bad-bot failed-login'
SERVER = None # example: SERVER = 'example.com'
IP = None # example: IP = '66.228.162.36'
LIMIT = None # example: LIMIT = 250
AGENT_CODE = None # example: 200
FIELD = None # example: FIELD = 'all'
FILE = None # example: FILE = '/tmp/sigsci.json'
FORMAT = None # example: FORMAT = 'csv'
PRETTY = None # PRETTY = True
SORT = None # example: SORT = 'asc'
###########################################
# default for retrieving agent metrics
AGENTS = False
# default for feed requests
FEED = False
# default for feed requests version 2
FEED2 = False
# defaults for polling
POLL_REQUESTS = False
POLL_EVENTS = False
# default for timeseries
TIMESERIES = False
ROLLUP = 60
# list events
LIST_EVENTS = False
EVENT_BY_ID = None
# default for custom alerts
CUSTOM_ALERTS = False
CUSTOM_ALERTS_ADD = False
CUSTOM_ALERTS_DELETE = False
# default for whitelist parameters
WHITELIST_PARAMETERS = False
WHITELIST_PARAMETERS_ADD = False
WHITELIST_PARAMETERS_DELETE = False
# default for whitelist paths
WHITELIST_PATHS = False
WHITELIST_PATHS_ADD = False
WHITELIST_PATHS_DELETE = False
# default for whitelist
WHITELIST = False
WHITELIST_ADD = False
WHITELIST_DELETE = False
# default for blacklist
BLACKLIST = False
BLACKLIST_ADD = False
BLACKLIST_DELETE = False
# default for request rules
REQUEST_RULES = False
REQUEST_RULES_ADD = False
REQUEST_RULES_DELETE = False
# default for signal rules
SIGNAL_RULES = False
SIGNAL_RULES_ADD = False
SIGNAL_RULES_DELETE = False
# default for redactions
REDACTIONS = False
REDACTIONS_ADD = False
REDACTIONS_DELETE = False
# default for integrations
INTEGRATIONS = False
# default for headerlinks
HEADERLINKS = False
# default for members
MEMBERS = False
MEMBERS_ADD = False
MEMBERS_DELETE = False
# default for health
HEALTH = False
###########################################
sys.dont_write_bytecode = True
class Authn:
def __init__(self):
self.cookies = {}
class SigSciAPI():
"""
SigSciAPI()
Methods:
authenticate()
sigsci.parse_init_time()
build_search_query()
get_requests()
Example:
sigsci = SigSciAPI()
sigsci.email = '[email protected]'
sigsci.pword = 'c0mpl3x'
sigsci.corp = 'foo_bar'
sigsci.site = 'www.bar.com'
sigsci.limit = 1000
sigsci.file = '/tmp/foo.json'
if sigsci.authenticate():
sigsci.from='-4h'
sigsci.until='-2h'
sigsci.tags=['SQLI', 'XSS']
sigsci.parse_init_time()
sigsci.get_requests()
"""
base = 'https://dashboard.signalsciences.net'
url = base + '/api/'
version = 'v0'
base_url = None
authn = None
token = None
email = None
pword = None
api_token = None
corp = None
site = None
query = 'from:-6h '
query_params = None
feed = None
feed2 = None
timeseries = None
from_time = '-1h'
until_time = None
until_specified = False
tags = None
ctags = None
server = None
ip = None
limit = 999
agent_code = None
field = 'data'
file = None
format = 'json'
pretty = False
sort = 'asc'
agent_version = None
ua = None
xheaders = {}
event_by_id = None
# api end points
LOGIN_EP = '/auth'
LOGOUT_EP = '/auth/logout'
CORPS_EP = '/corps/'
SITES_EP = '/sites/'
MEMBERS_EP = '/members'
USERS_EP = '/users'
REQEUSTS_EP = '/requests'
AGENTS_EP = '/agents'
FEED_EP = '/feed/requests'
ALERTS_EP = '/alerts'
RULES_EP = '/advancedRules'
CORP_RULES_EP = '/rules'
REQUEST_RULES_EP = '/requestRules'
SIGNAL_RULES_EP = '/signalRules'
CORP_RULE_LISTS_EP = '/lists'
RULE_LISTS_EP = '/lists'
CORP_SIGNALS_EP = '/tags'
TAGS_EP = '/tags'
TIMESERIES_EP = '/timeseries/requests'
EVENTS_EP = '/events'
WLPARAMS_EP = '/paramwhitelist'
WLPATHS_EP = '/pathwhitelist'
WHITELIST_EP = '/whitelist'
BLACKLIST_EP = '/blacklist'
REDACTIONS_EP = '/redactions'
INTEGRATIONS_EP = '/integrations'
HEADERLINKS_EP = '/headerLinks'
HEALTH_EP = '/health'
REPORTS_EP = '/reports/attacks'
CONFIGURED_TEMPLATES_EP = '/configuredtemplates'
def authenticate(self):
"""
SigSciAPI.authenticate()
Before calling, set:
SigSciAPI.email
SigSciAPI.pword or SigSciAPI.api_token
Stores auth token in:
SigSciAPI.authn.token
"""
if self.api_token is not None:
self.authn = Authn()
return True
else:
self.authn = requests.post(self.base_url + self.LOGIN_EP,
data={'email': self.email, 'password': self.pword},
allow_redirects=False)
if self.authn.status_code == 401:
print(self.authn.json()['message'])
return False
elif self.authn.status_code == 403:
print(self.authn.json()['message'])
return False
elif self.authn.status_code != 200:
print('Unexpected status: %s response: %s' % (self.authn.status_code, self.authn.text))
return False
self.token = self.authn.json()['token']
return True
def get_headers(self):
headers = {'Content-type': 'application/json', 'User-Agent': self.ua}
if self.token is not None:
headers['Authorization'] = 'Bearer %s' % self.token
if self.api_token is not None:
headers['X-Api-User'] = self.email
headers['X-Api-Token'] = self.api_token
if self.xheaders:
headers.update(self.xheaders)
return headers
def set_headers(self, headers):
self.xheaders.update(headers)
def build_search_query(self):
"""
SigSciAPI.build_search_query()
For from_time and until_time syntax see:
https://dashboard.signalsciences.net/documentation/knowledge-base/search-syntax#time
Default values (query):
SigSciAPI.from_time = -1h
SigSciAPI.until_time = None
SigSciAPI.tags = <all tags>
"""
if self.from_time is not None:
self.query = 'from:%s ' % str(self.from_time)
if self.until_time is not None:
self.query += 'until:%s ' % str(self.until_time)
if self.server is not None:
self.query += 'server:%s ' % str(self.server)
if self.ip is not None:
self.query += 'ip:%s ' % str(self.ip)
if self.agent_code is not None:
self.query += 'agentcode:%s ' % str(self.agent_code)
if self.tags is not None:
for tag in self.tags:
if tag.startswith('-'):
self.query += '-tag:{} '.format(tag.replace('-', ''))
else:
self.query += 'tag:{} '.format(tag)
if self.ctags is not None:
for tag in self.ctags:
if tag.startswith('-'):
self.query += '-tag:{} '.format(tag.replace('-', ''))
else:
self.query += 'tag:{} '.format(tag)
# force sort time-asc so we can properly capture last_epoch
self.query += 'sort:time-asc'
def get_requests(self):
# https://docs.signalsciences.net/api/#_corps__corpName__sites__siteName__requests_get
# /corps/{corpName}/sites/{siteName}/requests
self.query_api()
def query_api(self):
"""
SigSciAPI.query_api()
Before calling, set:
(Required):
SigSciAPI.corp
SigSciAPI.site
(Optional):
SigSciAPI.query
SigSciAPI.limit
SigSciAPI.file
"""
# https://docs.signalsciences.net/api/#_corps__corpName__sites__siteName__requests_get
# /corps/{corpName}/sites/{siteName}/requests
try:
url = None
if self.field == 'data':
self.limit = 1000
last_epoch = 0
loop_count = 0
get_next = True
now = datetime.datetime.utcnow().replace(second=0, microsecond=0)
now_epoch = calendar.timegm(now.utctimetuple())
if self.file is not None:
outfile = open(self.file, 'w')
if self.format == 'json':
outfile.write('[')
while last_epoch <= self.until_time and get_next:
self.build_search_query()
url = self.base_url + self.CORPS_EP + self.corp + self.SITES_EP + self.site + self.REQEUSTS_EP + '?q=' + str(self.query).strip()
if self.limit is not None:
url += '&limit=' + str(self.limit)
r = requests.get(url, cookies=self.authn.cookies, headers=self.get_headers())
j = json.loads(r.text)
# check for API call error
if 'message' in j:
raise ValueError(j['message'])
# get timestamp of last record
record_count = 0
for record in j['data']:
record_count += 1
last_timestamp = datetime.datetime.strptime(record['timestamp'], '%Y-%m-%dT%H:%M:%SZ')
last_epoch = calendar.timegm(last_timestamp.utctimetuple())
# output to file or stdout
if self.format == 'json':
if loop_count == 0:
if self.file is not None:
outfile.write('{}'.format(json.dumps(record)))
else:
print('{}'.format(json.dumps(record)))
else:
if self.file is not None:
outfile.write(',{}'.format(json.dumps(record)))
else:
print(',{}'.format(json.dumps(record)))
elif self.format == 'csv':
if self.file is not None:
csvwriter = csv.writer(outfile)
else:
csvwriter = csv.writer(sys.stdout)
tag_list = ''
detector = record['tags']
for t in detector:
tag_list = tag_list + t['type'] + '|'
# default, output fields for requests
csvwriter.writerow([str(record['timestamp']), str(record['id']), str(record['remoteIP']), str(record['remoteCountryCode']), str(record['path']).encode('utf8'), str(tag_list[:-1]), str(record['responseCode']), str(record['agentResponseCode'])])
else:
print('Error: Invalid output format!')
loop_count += 1
# set from_time for next iteration
if record_count < 1000:
# shift to next window
self.from_time = int(self.from_time) + (86400 * 7)
self.until_time = int(self.from_time) + (86400 * 7)
else:
self.from_time = last_epoch
if self.from_time > self.until_time or self.from_time > now_epoch:
get_next = False
# force limit to 1000 on subsequent iterations to reduce the number of api calls
self.limit = 1000
if self.file is not None:
if self.format == 'json':
outfile.write(']')
outfile.close()
else:
self.build_search_query()
url = self.base_url + self.CORPS_EP + self.corp + self.SITES_EP + self.site + self.REQEUSTS_EP + '?q=' + str(self.query).strip()
if self.limit is not None:
url += '&limit=' + str(self.limit)
r = requests.get(url, cookies=self.authn.cookies, headers=self.get_headers())
j = json.loads(r.text)
# output the results
self.output_results(j[self.field])
except Exception as e:
print('Error: %s ' % str(e))
print('Query: %s ' % url)
sys.exit()
def raw_query_api(self, raw_query):
"""
SigSciAPI.raw_query_api()
"""
# https://docs.signalsciences.net/api/#_corps__corpName__sites__siteName__requests_get
# /corps/{corpName}/sites/{siteName}/requests
try:
url = None
query_params = raw_query.split(" ")
query = ""
for param in query_params:
if param.startswith("from:"):
self.from_time = param.split(":")[1]
elif param.startswith("until:"):
self.until_time = param.split(":")[1]
else:
query = "{} ".format(param)
self.parse_init_time()
if self.field == 'data':
self.limit = 1000
last_epoch = 0
loop_count = 0
get_next = True
now = datetime.datetime.utcnow().replace(second=0, microsecond=0)
now_epoch = calendar.timegm(now.utctimetuple())
if self.file is not None:
outfile = open(self.file, 'w')
if self.format == 'json':
outfile.write('[')
while last_epoch <= self.until_time and get_next:
self.build_search_query()
print(self.query)
url = self.base_url + self.CORPS_EP + self.corp + self.SITES_EP + self.site + self.REQEUSTS_EP + '?q=' + str("{} {}".format(self.query, query)).strip()
if self.limit is not None:
url += '&limit=' + str(self.limit)
r = requests.get(url, cookies=self.authn.cookies, headers=self.get_headers())
j = json.loads(r.text)
# check for API call error
if 'message' in j:
raise ValueError(j['message'])
# get timestamp of last record
record_count = 0
for record in j['data']:
record_count += 1
last_timestamp = datetime.datetime.strptime(record['timestamp'], '%Y-%m-%dT%H:%M:%SZ')
last_epoch = calendar.timegm(last_timestamp.utctimetuple())
# output to file or stdout
if self.format == 'json':
if loop_count == 0:
if self.file is not None:
outfile.write('{}'.format(json.dumps(record)))
else:
print('{}'.format(json.dumps(record)))
else:
if self.file is not None:
outfile.write(',{}'.format(json.dumps(record)))
else:
print(',{}'.format(json.dumps(record)))
elif self.format == 'csv':
if self.file is not None:
csvwriter = csv.writer(outfile)
else:
csvwriter = csv.writer(sys.stdout)
tag_list = ''
detector = record['tags']
for t in detector:
tag_list = tag_list + t['type'] + '|'
# default, output fields for requests
csvwriter.writerow([str(record['timestamp']), str(record['id']), str(record['remoteIP']), str(record['remoteCountryCode']), str(record['path']).encode('utf8'), str(tag_list[:-1]), str(record['responseCode']), str(record['agentResponseCode'])])
else:
print('Error: Invalid output format!')
loop_count += 1
# set from_time for next iteration
if record_count < 1000:
# shift to next window
self.from_time = int(self.from_time) + (86400 * 7)
self.until_time = int(self.from_time) + (86400 * 7)
else:
self.from_time = last_epoch
if self.from_time > self.until_time or self.from_time > now_epoch:
get_next = False
# force limit to 1000 on subsequent iterations to reduce the number of api calls
self.limit = 1000
if self.file is not None:
if self.format == 'json':
outfile.write(']')
outfile.close()
else:
print("what")
self.build_search_query()
print(self.query)
url = self.base_url + self.CORPS_EP + self.corp + self.SITES_EP + self.site + self.REQEUSTS_EP + '?q=' + str("{} {}".format(self.query, query)).strip()
if self.limit is not None:
url += '&limit=' + str(self.limit)
r = requests.get(url, cookies=self.authn.cookies, headers=self.get_headers())
j = json.loads(r.text)
# output the results
self.output_results(j[self.field])
except Exception as e:
print('Error: %s ' % str(e))
print('Query: %s ' % url)
sys.exit()
def get_feed_requests(self):
"""
SigSciAPI.get_feed_requests()
Before calling, set:
(Required):
SigSciAPI.corp
SigSciAPI.site
(Optional):
SigSciAPI.from_time
SigSciAPI.until_time
SigSciAPI.tags
SigSciAPI.file
SigSciAPI.format
"""
# https://dashboard.signalsciences.net/documentation/api#_corps__corpName__sites__siteName__feed_requests_get
# /corps/{corpName}/sites/{siteName}/feed/requests
try:
self.query_params = 'from=%s' % str(self.from_time)
self.query_params += '&until=%s' % str(self.until_time)
if self.tags is not None:
self.query_params += '&tags='
self.query_params += ','.join(self.tags)
if self.ctags is not None:
if self.tags is None:
self.query_params += '&tags='
self.query_params += ','.join(self.ctags)
url = self.base_url + self.CORPS_EP + self.corp + self.SITES_EP + self.site + self.FEED_EP + '?' + str(self.query_params).strip()
try:
# try block attempts to handle unexpected connection issues
r = requests.get(url, cookies=self.authn.cookies, headers=self.get_headers())
except Exception:
# try again
r = requests.get(url, cookies=self.authn.cookies, headers=self.get_headers())
j = json.loads(r.text)
if 'message' in j:
raise ValueError(j['message'])
self.output_results(j['data'])
# get all next
next_ref = j['next']
while next_ref['uri'].strip() != '':
url = self.base + next_ref['uri']
try:
# try block attempts to handle unexpected connection issues
r = requests.get(url, headers=self.get_headers())
except Exception:
# try again
r = requests.get(url, headers=self.get_headers())
j = json.loads(r.text)
if 'message' in j:
raise ValueError(j['message'])
self.output_results(j)
next_ref = j['next']
except Exception as e:
print('Error: %s ' % str(e))
print('Query: %s ' % url)
def get_feed_requests2(self):
"""
SigSciAPI.get_feed_requests2()
Version 2 of Feed Output
Before calling, set:
(Required):
SigSciAPI.corp
SigSciAPI.site
(Optional):
SigSciAPI.from_time
SigSciAPI.until_time
SigSciAPI.tags
SigSciAPI.file
SigSciAPI.format
"""
# https://dashboard.signalsciences.net/documentation/api#_corps__corpName__sites__siteName__feed_requests_get
# /corps/{corpName}/sites/{siteName}/feed/requests
try:
self.query_params = 'from=%s' % str(self.from_time)
self.query_params += '&until=%s' % str(self.until_time)
if self.tags is not None:
self.query_params += '&tags='
self.query_params += ','.join(self.tags)
if self.ctags is not None:
if self.tags is None:
self.query_params += '&tags='
self.query_params += ','.join(self.ctags)
url = self.base_url + self.CORPS_EP + self.corp + self.SITES_EP + self.site + self.FEED_EP + '?' + str(self.query_params).strip()
try:
# try block attempts to handle unexpected connection issues
r = requests.get(url, cookies=self.authn.cookies, headers=self.get_headers())
except Exception:
# try again
r = requests.get(url, cookies=self.authn.cookies, headers=self.get_headers())
j = json.loads(r.text)
if 'message' in j:
raise ValueError(j['message'])
d = j['data']
for x in d:
self.output_results(x)
# get all next
next_ref = j['next']
while next_ref['uri'].strip() != '':
url = self.base + next_ref['uri']
try:
# try block attempts to handle unexpected connection issues
r = requests.get(url, headers=self.get_headers())
# Reauthenticate if token expires early
if r.status_code == 401:
if sigsci.authenticate():
r = requests.get(url, headers=self.get_headers())
except Exception:
# try again
r = requests.get(url, headers=self.get_headers())
# Reauthenticate if token expires early
if r.status_code == 401:
if sigsci.authenticate():
r = requests.get(url, headers=self.get_headers())
j = json.loads(r.text)
if 'message' in j:
raise ValueError(j['message'])
d = j['data']
for x in d:
self.output_results(x)
next_ref = j['next']
except Exception as e:
print('Error: %s ' % str(e))
print('Query: %s ' % url)
def get_overview_report(self):
# https://docs.signalsciences.net/api/#get-overview-report-data
# GET /corps/{corpName}/reports/attacks
try:
url = self.base_url + self.CORPS_EP + self.corp + self.REPORTS_EP
r = requests.get(url, cookies=self.authn.cookies, headers=self.get_headers())
j = json.loads(r.text)
self.json_out(j)
except Exception as e:
print('Error: %s ' % str(e))
print('Query: %s ' % url)
sys.exit()
def poll_req_continuously(self):
"""
SigSciAPI.poll_req_continuously()
Polling with Version 2 of Feed Output
Before calling, set:
(Required):
SigSciAPI.corp
SigSciAPI.site
"""
prev_set = {}
curr_set = {}
try:
while True:
# https://dashboard.signalsciences.net/documentation/api#_corps__corpName__sites__siteName__feed_requests_get
# /corps/{corpName}/sites/{siteName}/feed/requests
self.from_time = '-7m'
self.until_time = '-5m'
self.parse_init_time()
self.query_params = 'from=%s' % str(self.from_time)
self.query_params += '&until=%s' % str(self.until_time)
url = self.base_url + self.CORPS_EP + self.corp + self.SITES_EP + self.site + self.FEED_EP + '?' + str(self.query_params).strip()
try:
# try block attempts to handle unexpected connection issues
r = requests.get(url, cookies=self.authn.cookies, headers=self.get_headers())
# Reauthenticate if token expires early
if r.status_code == 401:
if sigsci.authenticate():
r = requests.get(url, cookies=self.authn.cookies, headers=self.get_headers())
except Exception:
# try again
r = requests.get(url, cookies=self.authn.cookies, headers=self.get_headers())
# Reauthenticate if token expires early
if r.status_code == 401:
if sigsci.authenticate():
r = requests.get(url, cookies=self.authn.cookies, headers=self.get_headers())
j = json.loads(r.text)
if 'message' in j:
raise ValueError(j['message'])
d = j['data']
for x in d:
curr_set[x['id']] = x
# get all next
next_ref = j['next']
while next_ref['uri'].strip() != '':
url = self.base + next_ref['uri']
try:
# try block attempts to handle unexpected connection issues
r = requests.get(url, cookies=self.authn.cookies, headers=self.get_headers())
# Reauthenticate if token expires early
if r.status_code == 401:
if sigsci.authenticate():
r = requests.get(url, cookies=self.authn.cookies, headers=self.get_headers())
except Exception:
# try again
r = requests.get(url, cookies=self.authn.cookies, headers=self.get_headers())
# Reauthenticate if token expires early
if r.status_code == 401:
if sigsci.authenticate():
r = requests.get(url, cookies=self.authn.cookies, headers=self.get_headers())
j = json.loads(r.text)
if 'message' in j:
raise ValueError(j['message'])
d = j['data']
for x in d:
curr_set[x['id']] = x
next_ref = j['next']
for id in curr_set:
if id not in prev_set:
# we've haven't seen this request, output it
self.output_results(curr_set[id])
# swap curr to prev
prev_set = curr_set
curr_set = {}
time.sleep(60)
except Exception as e:
print('Error: %s ' % str(e))
print('Query: %s ' % url)
sys.exit()
def poll_ev_continuously(self):
"""
SigSciAPI.poll_ev_continuously()
Polling events
Before calling, set:
(Required):
SigSciAPI.corp
SigSciAPI.site
"""
prev_set = {}
curr_set = {}
try:
while True:
self.from_time = '-7m'
self.until_time = '-5m'
self.parse_init_time()
query_params = '?limit=1000'
query_params += '&from=%s' % str(self.from_time)
query_params += '&until=%s' % str(self.until_time)
url = self.base_url + self.CORPS_EP + self.corp + self.SITES_EP + self.site + self.EVENTS_EP + query_params
try:
# try block attempts to handle unexpected connection issues
r = requests.get(url, cookies=self.authn.cookies, headers=self.get_headers())
# Reauthenticate if token expires early
if r.status_code == 401:
if sigsci.authenticate():
r = requests.get(url, cookies=self.authn.cookies, headers=self.get_headers())
except Exception:
# try again
r = requests.get(url, cookies=self.authn.cookies, headers=self.get_headers())
# Reauthenticate if token expires early
if r.status_code == 401:
if sigsci.authenticate():
r = requests.get(url, cookies=self.authn.cookies, headers=self.get_headers())
j = json.loads(r.text)
if 'message' in j:
raise ValueError(j['message'])
d = j['data']
for x in d:
curr_set[x['id']] = x
for id in curr_set:
if id not in prev_set:
# we've haven't seen this event, output it
self.output_results(curr_set[id])
# swap curr to prev
prev_set = curr_set
curr_set = {}
time.sleep(60)
except Exception as e:
print('Error: %s ' % str(e))
print('Query: %s ' % url)
sys.exit()
def get_timeseries(self, tags, rollup=60):
"""
SigSciAPI.get_timeseries(tag, rollup)
Before calling, set:
(Required):
SigSciAPI.corp
SigSciAPI.site
SigSciAPI.tags
(Optional):
SigSciAPI.from_time
SigSciAPI.until_time
SigSciAPI.file
SigSciAPI.format
"""
# https://dashboard.signalsciences.net/documentation/api#_corps__corpName__sites__siteName__timeseries_requests_get
# /corps/{corpName}/sites/{siteName}/timeseries/requests
try:
self.query_params = '?rollup={}'.format(str(rollup).strip())
if self.from_time is not None:
self.query_params += '&from={}'.format(str(self.from_time))
if self.until_time is not None:
self.query_params += '&until={}'.format(str(self.until_time))
for tag in tags:
self.query_params += '&tag={}'.format(tag)
url = self.base_url + self.CORPS_EP + self.corp + self.SITES_EP + self.site + self.TIMESERIES_EP + self.query_params
r = requests.get(url, cookies=self.authn.cookies, headers=self.get_headers())
j = json.loads(r.text)
if 'message' in j:
raise ValueError(j['message'])
self.json_out(j)
except Exception as e:
print('Error: %s ' % str(e))
print('Query: %s ' % url)
sys.exit()
def get_list_events(self, tag=None):
"""
SigSciAPI.get_list_events(tag)
Before calling, set:
(Required):
SigSciAPI.corp
SigSciAPI.site
(Optional):
SigSciAPI.tags
SigSciAPI.from_time
SigSciAPI.until_time
SigSciAPI.file
SigSciAPI.format
"""
# https://dashboard.signalsciences.net/documentation/api#_corps__corpName__sites__siteName__events_get
# /corps/{corpName}/sites/{siteName}/events
try:
query_params = '?limit=' + str(self.limit)
if self.from_time is not None:
query_params += '&from=%s' % str(self.from_time)
if self.until_time is not None:
query_params += '&until=%s' % str(self.until_time)
if tag is not None:
query_params += '&tag=%s' % (str(tag).strip())
url = self.base_url + self.CORPS_EP + self.corp + self.SITES_EP + self.site + self.EVENTS_EP + query_params
r = requests.get(url, cookies=self.authn.cookies, headers=self.get_headers())
j = json.loads(r.text)
if 'message' in j:
raise ValueError(j['message'])
self.output_results(j)
except Exception as e:
print('Error: %s ' % str(e))
print('Query: %s ' % url)
sys.exit()
def get_event_by_id(self):
"""
SigSciAPI.get_event_by_id()
Before calling, set:
(Required):
SigSciAPI.corp
SigSciAPI.site
SigSciAPI.event_id
(Optional):
SigSciAPI.file