-
Notifications
You must be signed in to change notification settings - Fork 33
Expand file tree
/
Copy pathtest_api.py
More file actions
727 lines (556 loc) · 21.8 KB
/
test_api.py
File metadata and controls
727 lines (556 loc) · 21.8 KB
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
"""Tests the Python interface for DomainTools APIs"""
from os import environ
import json
import pytest
from datetime import datetime, timedelta, timezone
from inspect import isgenerator
from domaintools import API, exceptions
from tests.settings import api, feeds_api, vcr
@vcr.use_cassette
def test_account_information():
with api.account_information() as account_information:
assert "products" in account_information
for product in account_information:
assert "id" in product
assert "per_month_limit" in product
assert "absolute_limit" in product
assert "usage" in product
assert "expiration_date" in product
@vcr.use_cassette
def test_available_api_calls():
available_api_calls = api.available_api_calls()
# Not sure what else to check for as this is highly dependent on your API_KEY but at least account_information
# should be there.
assert "account_information" in available_api_calls
@vcr.use_cassette
def test_brand_monitor():
api_call = api.brand_monitor("google")
with api_call as response:
assert "query" in response
assert "limit" in response
assert "total" in response
assert "exclude" in response
assert "new" in response
assert "on-hold" in response
assert "utf8" in response
assert "date" in response
for alert in api_call:
assert "domain" in alert
assert "status" in alert
@vcr.use_cassette
def test_domain_profile():
with api.domain_profile("google.com") as response:
assert "history" in response
assert "server" in response
assert "name_servers" in response
assert "website_data" in response
assert "seo" in response
assert "registration" in response
assert "registrant" in response
history = response["history"]
assert "whois" in history
assert "registrar" in history
assert "name_server" in history
assert "ip_address" in history
@vcr.use_cassette
def test_domain_search():
api_call = api.domain_search("google")
with api_call as response:
assert "results" in response
assert "query_info" in response
for domain in api_call:
assert "hashad_tlds" in domain
assert "has_number" in domain
assert "char_count" in domain
assert "tlds" in domain
assert "sld" in domain
assert "has_deleted" in domain
assert "has_active" in domain
assert "has_hyphen" in domain
assert "tlds_count" in domain
exclude_list = ["domaintools", "ff1toolsdomain"]
api_call = api.domain_search("domain tools", exclude_query=exclude_list)
with api_call as response:
for domain in response:
assert domain["sld"] not in exclude_list
@vcr.use_cassette
def test_hosting_history():
api_call = api.hosting_history("google.com")
with api_call as result:
assert "domain_name" in result
assert "registrar_history" in result
assert "nameserver_history" in result
assert "ip_history" in result
for history_section, history_item in api_call:
assert str(history_section)
assert isinstance(history_item, dict)
@vcr.use_cassette
def test_ip_monitor():
api_call = api.ip_monitor("65.55.53.233")
with api_call as results:
assert results["ip_address"] == "65.55.53.233"
assert "alerts" in results
assert "date" in results
assert "limit" in results
assert "page" in results
assert "page_count" in results
assert "total" in results
for result in api_call:
assert result
@vcr.use_cassette
def test_name_server_monitor():
api_call = api.name_server_monitor("google.com")
with api_call as results:
assert "limit" in results
assert "date" in results
assert "name_server" in results
assert "total" in results
assert "page" in results
assert "alerts" in results
for alert in api_call:
assert alert
@vcr.use_cassette
def test_parsed_whois():
api_call = api.parsed_whois("google.com")
with api_call as result:
assert "registrant" in result
assert "registration" in result
assert "name_servers" in result
assert "whois" in result
assert "parsed_whois" in result
assert "record_source" in result
for key, value in api_call.items():
assert key
assert isinstance(result.flattened(), dict)
@vcr.use_cassette
def test_parsed_domain_rdap():
api_call = api.parsed_domain_rdap("google.com")
with api_call as result:
for key in (
"handle",
"domain_statuses",
"creation_date",
"last_changed_date",
"expiration_date",
"nameservers",
"conformance",
"emails",
"email_domains",
"unclassified_emails",
"registrar",
"contacts",
):
assert key in result.get("parsed_domain_rdap")
for key, value in result.items():
assert key
assert isinstance(result.flattened(), dict)
@vcr.use_cassette
def test_registrant_monitor():
api_call = api.registrant_monitor("google")
with api_call as result:
assert "query" in result
assert "limit" in result
assert "total" in result
assert "date" in result
assert "alerts" in result
for alert in api_call:
assert "domain" in alert
assert "match_type" in alert
assert "current_owner" in alert
assert "created" in alert
assert "modified" in alert
assert "last_owner" in alert
@vcr.use_cassette
def test_reputation():
api_call = api.reputation("google.com")
with api_call as risk_data:
assert risk_data["risk_score"] == 0
assert risk_data["domain"] == "google.com"
assert int(api_call) == 0
assert float(api_call) == 0.0
@vcr.use_cassette
def test_reverse_ip():
with api.reverse_ip("google.com") as results:
assert "ip_addresses" in results
@vcr.use_cassette
def test_host_domains():
with api.host_domains(ip="199.30.228.112") as results:
assert "ip_addresses" in results
@vcr.use_cassette
def test_reverse_ip_whois():
api_call = api.reverse_ip_whois(query="DomainTools")
with api_call as results:
assert "page" in results
assert "has_more_pages" in results
assert "record_count" in results
assert "records" in results
for record in api_call:
assert "ip_to" in record
assert "country" in record
assert "organization" in record
assert "record_date" in record
assert "range" in record
assert "record_ip" in record
assert "server" in record
assert "ip_from" in record
assert len(api_call) > 0
with api.reverse_ip_whois(ip="65.55.53.233") as result:
assert "ip_to_alloc" in result
assert "range" in result
assert "ip_from_alloc" in result
assert "server" in result
assert "whois_record" in result
assert "organization" in result
assert "record_date" in result
assert "country" in result
assert "ip_to" in result
assert "ip_from" in result
with pytest.raises(ValueError):
api.reverse_ip_whois(ip="8.8.8.8", query="Google")
@vcr.use_cassette
def test_reverse_name_server():
api_call = api.reverse_name_server("google.com")
with api_call as result:
assert "name_server" in result
assert "primary_domains" in result
assert "secondary_domains" in result
for primary_domain in api_call:
assert primary_domain
@vcr.use_cassette
def test_reverse_whois():
api_call = api.reverse_whois("Google")
with api_call as result:
assert "domain_count" in result
for domain in result:
assert domain
@vcr.use_cassette
def test_whois():
api_call = api.whois("google.com")
with api_call as whois:
assert "registrant" in whois
assert "name_servers" in whois
assert "whois" in whois
assert "record_source" in whois
assert "abusecomplaints@markmonitor.com" in api_call.emails()
@vcr.use_cassette
def test_whois_history():
api_call = api.whois_history("woot.com")
with api_call as results:
assert "record_count" in results
assert "history" in results
for history_item in api_call:
assert "date" in history_item
assert "is_private" in history_item
assert "whois" in history_item
@vcr.use_cassette
def test_dict_like_behaviour():
with api.whois("google.com") as whois_google:
assert len(whois_google.items())
assert len(whois_google.keys())
assert len(whois_google.values())
assert "registrant" in whois_google
whois_google.update({"registrant": "override"})
assert whois_google["registrant"] == "override"
del whois_google["registrant"]
assert "registrant" not in whois_google
whois_google["registrant"] = "me"
assert whois_google["registrant"] == "me"
assert isinstance(whois_google.pop("whois", {}), dict)
@vcr.use_cassette
def test_exception_handling():
exception = None
api_call = api.reverse_ip("ss")
assert api_call.status == 400
try:
api_call.data()
except Exception as e:
exception = e
assert exception
assert exception.code == 400
assert "not understand" in exception.reason["error"]["message"]
with pytest.raises(exceptions.NotFoundException):
api._results("i_made_this_product_up", "/v1/steianrstierstnrsiatiarstnsto.com/whois").data()
with pytest.raises(exceptions.NotAuthorizedException):
API("notauser", "notakey").domain_search("amazon").data()
with pytest.raises(
ValueError,
match=r"Invalid value 'notahash' for 'key_sign_hash'. Values available are sha1,sha256",
):
API("notauser", "notakey", always_sign_api_key=True, key_sign_hash="notahash").domain_search("amazon")
@vcr.use_cassette
def test_md5_is_not_supported():
with pytest.raises(
ValueError,
match=r"Invalid value 'md5' for 'key_sign_hash'. Values available are sha1,sha256",
):
API("notauser", "notakey", always_sign_api_key=True, key_sign_hash="md5").domain_search("amazon")
# @vcr.use_cassette
# def test_rate_limiting():
# domain_searches = ["google"] * 31
# for domain_search in domain_searches:
# api.domain_search(domain_search).data()
@vcr.use_cassette
def test_no_https():
with pytest.raises(
Exception,
match=r"The DomainTools API endpoints no longer support http traffic. Please make sure https=True.",
):
API(
environ.get("TEST_USER", "test_user"),
environ.get("TEST_KEY", "test_key"),
https=False,
)
@vcr.use_cassette
def test_formats():
with api.domain_search("google") as data:
assert "{" in str(data.json)
assert "<" in str(data.xml)
assert "<title>" in str(data.html)
assert "\n" in str(data.as_list())
@vcr.use_cassette
@pytest.mark.skip(reason="Iris endpoint is already deprecated in light of enrich and investigate")
def test_iris():
with pytest.raises(ValueError):
api.iris()
with api.iris(domain="google.com") as results:
assert results
for result in results:
assert "domain" in result
assert str(result["domain"])
@vcr.use_cassette
def test_risk():
with api.risk(domain="google.com") as result:
assert result
assert int(result) == 0
with api.risk(domain="hug.rest") as result:
assert result
assert int(result) > 0
@vcr.use_cassette
def test_risk_evidence():
with api.risk_evidence(domain="google.com") as result:
assert result
assert list(result) == [{"name": "zerolist", "risk_score": 0}]
@vcr.use_cassette
def test_iris_enrich():
with pytest.raises(ValueError):
api.iris_enrich()
enriched_data = api.iris_enrich("google.com")
assert enriched_data["results_count"]
for result in enriched_data:
assert result["domain"] == "google.com"
@vcr.use_cassette
def test_iris_enrich_cli():
with pytest.raises(ValueError):
api.iris_enrich()
enriched_data = api.iris_enrich("google.com")
assert enriched_data["results_count"]
for result in enriched_data:
assert result["domain"] == "google.com"
@vcr.use_cassette
def test_iris_investigate():
with pytest.raises(ValueError):
api.iris_investigate()
investigation_results = api.iris_investigate(domains=["amazon.com", "google.com"])
assert investigation_results["results_count"]
for result in investigation_results:
assert result["domain"] in ["amazon.com", "google.com"]
@vcr.use_cassette
def test_iris_detect_monitors():
with pytest.raises(ValueError):
api.iris_detect_monitors(include_counts=True)
detect_results = api.iris_detect_monitors()
assert detect_results["total_count"] >= 1
detect_results = api.iris_detect_monitors(sort=["domain_counts_discovered", "term"])
assert detect_results["monitors"][0]["term"] == "google"
@vcr.use_cassette
def test_iris_detect_new_domains():
detect_results = api.iris_detect_new_domains(monitor_id="nAwmQg2pqg", sort=["risk_score"], order="desc")
assert detect_results["watchlist_domains"][0]["risk_score"] == 100
@vcr.use_cassette
def test_iris_detect_watched_domains():
detect_results = api.iris_detect_watched_domains()
assert detect_results["count"] >= 0
detect_results = api.iris_detect_watched_domains(
monitor_id="nAwmQg2pqg", sort=["risk_score"], order="desc"
)
assert len(detect_results["watchlist_domains"]) == 3
detect_results = api.iris_detect_watched_domains(escalation_types="blocked")
assert detect_results["count"] == 1
@vcr.use_cassette
def test_iris_detect_manage_watchlist_domains():
detect_results = api.iris_detect_manage_watchlist_domains(
watchlist_domain_ids=["gae08rdVWG"], state="watched"
)
assert detect_results["watchlist_domains"][0]["state"] == "watched"
@vcr.use_cassette
def test_iris_detect_escalate_domains():
# If you rerun this test without VCR, it will fail because the domain is already escalated
detect_results = api.iris_detect_escalate_domains(
watchlist_domain_ids=["OWxzqKqQEY"], escalation_type="blocked"
)
assert detect_results["escalations"][0]["escalation_type"] == "blocked"
detect_results = api.iris_detect_escalate_domains(
watchlist_domain_ids=["OWxzqKqQEY"], escalation_type="google_safe"
)
assert detect_results["escalations"][0]["escalation_type"] == "google_safe"
@vcr.use_cassette
def test_iris_detect_ignored_domains():
detect_results = api.iris_detect_ignored_domains()
assert detect_results["count"] >= 1
detect_results = api.iris_detect_ignored_domains(monitor_id="DKObxJVjYJ")
assert detect_results["count"] >= 1
@vcr.use_cassette
def test_limit_exceeded():
with pytest.raises(exceptions.ServiceException):
response = api.iris_investigate(ip="8.8.8.8")
response.response()
@vcr.use_cassette
def test_newly_observed_domains_feed():
results = feeds_api.nod(after="-60", top=5)
total_count = 0
for response in results.response():
assert results.status == 200
rows = response.strip().split("\n")
assert response is not None
total_count += 1
for row in rows:
feed_result = json.loads(row)
assert "timestamp" in feed_result.keys()
assert "domain" in feed_result.keys()
assert total_count == 5
@vcr.use_cassette
def test_newly_observed_hosts_feed():
results = feeds_api.noh(after="-60", top=5)
total_count = 0
for response in results.response():
assert results.status == 200
rows = response.strip().split("\n")
assert response is not None
total_count += 1
for row in rows:
feed_result = json.loads(row)
assert "timestamp" in feed_result.keys()
assert "domain" in feed_result.keys()
assert total_count == 5
@vcr.use_cassette
@pytest.mark.skip(reason="Failing test due to unknown reason. Still investigating the root-cause.")
def test_newly_observed_domains_feed_pagination():
now_utc = datetime.now(timezone.utc)
one_hour_ago = now_utc - timedelta(hours=1)
after = one_hour_ago.strftime("%Y-%m-%dT%H:%M:%SZ")
results = feeds_api.nod(sessionID="integrations-testing", after=after)
page_count = 0
for response in results.response():
response = response.strip()
assert response is not None
page_count += 1
feed_result = json.loads(response)
assert "timestamp" in feed_result.keys()
assert "domain" in feed_result.keys()
assert page_count >= 1
@vcr.use_cassette
def test_newly_active_domains_feed():
results = feeds_api.nad(after="-60", top=5)
for response in results.response():
assert results.status == 200
response = response.strip()
assert response is not None
feed_result = json.loads(response)
assert "timestamp" in feed_result.keys()
assert "domain" in feed_result.keys()
@vcr.use_cassette
def test_domainrdap_feed():
results = feeds_api.domainrdap(after="-60", top=2)
for response in results.response():
assert results.status == 200
response = response.strip()
assert response is not None
feed_result = json.loads(response)
assert "timestamp" in feed_result.keys()
assert "domain" in feed_result.keys()
assert "parsed_record" in feed_result.keys()
assert "domain" in feed_result["parsed_record"]["parsed_fields"]
assert "emails" in feed_result["parsed_record"]["parsed_fields"]
assert "contacts" in feed_result["parsed_record"]["parsed_fields"]
@vcr.use_cassette
def test_domain_discovery_feed():
results = feeds_api.domaindiscovery(after="-60", top=5)
for response in results.response():
assert results.status == 200
response = response.strip()
assert response is not None
feed_result = json.loads(response)
assert "timestamp" in feed_result.keys()
assert "domain" in feed_result.keys()
@vcr.use_cassette
def test_domainrdap_feed_not_api_header_auth():
results = feeds_api.domainrdap(after="-60", sessiondID="integrations-testing", top=5)
for response in results.response():
assert results.status == 200
response = response.strip()
assert response is not None
feed_result = json.loads(response)
assert "timestamp" in feed_result.keys()
assert "domain" in feed_result.keys()
assert "parsed_record" in feed_result.keys()
assert "domain" in feed_result["parsed_record"]["parsed_fields"]
assert "emails" in feed_result["parsed_record"]["parsed_fields"]
assert "contacts" in feed_result["parsed_record"]["parsed_fields"]
@vcr.use_cassette
def test_verify_response_is_a_generator():
results = feeds_api.domaindiscovery(after="-60")
assert isgenerator(results.response())
@vcr.use_cassette
def test_feeds_endpoint_should_non_header_auth_be_the_default():
results = feeds_api.domaindiscovery(after="-60", endpoint="download", top=5)
for response in results.response():
assert results.status == 200
response = response.strip()
assert response is not None
feed_result = json.loads(response)
assert "download_name" in feed_result["response"].keys()
assert "files" in feed_result["response"].keys()
@vcr.use_cassette
def test_feeds_endpoint_should_raise_error_if_no_required_params():
with pytest.raises(ValueError) as excinfo:
feeds_api.domaindiscovery()
assert str(excinfo.value) == "sessionID or after or before must be provided"
@vcr.use_cassette
def test_feeds_endpoint_should_raise_error_if_asked_csv_format_for_download_api():
with pytest.raises(ValueError) as excinfo:
feeds_api.domaindiscovery(after="-60", output_format="csv", endpoint="download")
assert str(excinfo.value) == "csv format is not available in download API."
@vcr.use_cassette
def test_realtime_domain_risk():
results = feeds_api.realtime_domain_risk(after="-60", top=5)
for response in results.response():
assert results.status == 200
response = response.strip()
assert response is not None
feed_result = json.loads(response)
assert "timestamp" in feed_result.keys()
assert "domain" in feed_result.keys()
assert "phishing_risk" in feed_result.keys()
assert "malware_risk" in feed_result.keys()
assert "proximity_risk" in feed_result.keys()
assert "overall_risk" in feed_result.keys()
@vcr.use_cassette
def test_domain_hotlist():
results = feeds_api.domainhotlist(after="-60", top=5)
for response in results.response():
assert results.status == 200
response = response.strip()
assert response is not None
feed_result = json.loads(response)
assert "timestamp" in feed_result.keys()
assert "domain" in feed_result.keys()
assert "phishing_risk" in feed_result.keys()
assert "malware_risk" in feed_result.keys()
assert "proximity_risk" in feed_result.keys()
assert "overall_risk" in feed_result.keys()
@vcr.use_cassette
def test_feeds_endpoint_should_raise_error_if_signed_api_key_is_used():
feeds_api.always_sign_api_key = True
with pytest.raises(ValueError) as excinfo:
feeds_api.domaindiscovery(after="-60")
assert str(excinfo.value) == "Real Time Threat Feeds do not support signed API keys."