BaseModule
The base class for all BBOT modules.
Attributes:
-
watched_events
(List
) –Event types to watch.
-
produced_events
(List
) –Event types to produce.
-
meta
(Dict
) –Metadata about the module, such as whether authentication is required and a description.
-
flags
(List
) –Flags indicating the type of module (must have at least "safe" or "aggressive" and "passive" or "active").
-
deps_pip
(List
) –Python dependencies to install via pip. Empty list by default.
-
deps_apt
(List
) –APT package dependencies to install. Empty list by default.
-
deps_shell
(List
) –Other dependencies installed via shell commands. Uses ansible.builtin.shell. Empty list by default.
-
deps_ansible
(List
) –Additional Ansible tasks for complex dependencies. Empty list by default.
-
accept_dupes
(bool
) –Whether to accept incoming duplicate events. Default is False.
-
suppress_dupes
(bool
) –Whether to suppress outgoing duplicate events. Default is True.
-
per_host_only
(bool
) –Limit the module to only scanning once per host. Default is False.
-
per_hostport_only
(bool
) –Limit the module to only scanning once per host:port. Default is False.
-
per_domain_only
(bool
) –Limit the module to only scanning once per domain. Default is False.
-
scope_distance_modifier
((int, None)
) –Modifies scope distance acceptance for events. Default is 0.
None == accept all events 2 == accept events up to and including the scan's configured search distance plus two 1 == accept events up to and including the scan's configured search distance plus one 0 == (DEFAULT) accept events up to and including the scan's configured search distance
-
target_only
(bool
) –Accept only the initial target event(s). Default is False.
-
in_scope_only
(bool
) –Accept only explicitly in-scope events. Default is False.
-
options
(Dict
) –Customizable options for the module, e.g., {"api_key": ""}. Empty dict by default.
-
options_desc
(Dict
) –Descriptions for options, e.g., {"api_key": "API Key"}. Empty dict by default.
-
max_event_handlers
(int
) –Maximum concurrent instances of handle_event() or handle_batch(). Default is 1.
-
batch_size
(int
) –Size of batches processed by handle_batch(). Default is 1.
-
batch_wait
(int
) –Seconds to wait before force-submitting a batch. Default is 10.
-
failed_request_abort_threshold
(int
) –Threshold for setting error state after failed HTTP requests (only takes effect when
request_with_fail_count()
is used. Default is 5. -
_preserve_graph
(bool
) –When set to True, accept events that may be duplicates but are necessary for construction of complete graph. Typically only enabled for output modules that need to maintain full chains of events, e.g.
neo4j
andjson
. Default is False. -
_stats_exclude
(bool
) –Whether to exclude this module from scan statistics. Default is False.
-
_qsize
(int
) –Outgoing queue size (0 for infinite). Default is 0.
-
_priority
(int
) –Priority level of events raised by this module, 1-5. Default is 3.
-
_name
(str
) –Module name, overridden automatically. Default is 'base'.
-
_type
(str
) –Module type, for differentiating between normal and output modules. Default is 'scan'.
Source code in bbot/modules/base.py
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 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 |
|
auth_secret
property
auth_secret
Indicates if the module is properly configured for authentication.
This read-only property should be used to check whether all necessary attributes (e.g., API keys, tokens, etc.) are configured to perform authenticated requests in the module. Commonly used in setup or initialization steps.
Returns:
-
bool
–True if the module is properly configured for authentication, otherwise False.
config
property
config
Property that provides easy access to the module's configuration in the scan's config.
This property serves as a shortcut to retrieve the module-specific configuration from
self.scan.config
. If no configuration is found for this module, an empty dictionary is returned.
Returns:
-
dict
–The configuration dictionary specific to this module.
finished
property
finished
Property indicating whether the module has finished processing.
This property checks three conditions to determine if the module is finished:
1. The module is not currently running (self.running
is False).
2. The number of incoming events in the queue is zero or less (self.num_incoming_events <= 0
).
3. The number of outgoing events in the queue is zero or less (self.outgoing_event_queue.qsize() <= 0
).
Returns:
-
bool
–True if the module has finished processing, False otherwise.
http_timeout
property
http_timeout
Convenience shortcut to http_timeout
in the config
memory_usage
property
memory_usage
Property that calculates the current memory usage of the module in bytes.
This property uses the get_size
function to estimate the memory consumption
of the module object. The depth of the object graph traversal is limited to 3 levels
to avoid performance issues. Commonly shared objects like self.scan
, self.helpers
,
are excluded from the calculation to prevent double-counting.
Returns:
-
int
–The estimated memory usage of the module in bytes.
priority
property
priority
Gets the priority level of the module as an integer.
The priority level is constrained to be between 1 and 5, inclusive. A lower value indicates a higher priority.
Returns:
-
int
–The priority level of the module, constrained between 1 and 5.
Examples:
>>> self.priority
3
running
property
running
Property indicating whether the module is currently processing data.
This property checks if the task counter (self._task_counter.value
) is greater than zero,
indicating that there are ongoing tasks in the module.
Returns:
-
bool
–True if the module is currently processing data, False otherwise.
status
property
status
Provides the current status of the module as a dictionary.
The dictionary contains the following keys
- 'events': A sub-dictionary with 'incoming' and 'outgoing' keys, representing the number of events in the respective queues.
- 'tasks': The current value of the task counter.
- 'errored': A boolean value indicating if the module is in an error state.
- 'running': A boolean value indicating if the module is currently processing data.
Returns:
-
dict
–A dictionary containing the current status of the module.
Examples:
>>> self.status
{'events': {'incoming': 5, 'outgoing': 2}, 'tasks': 3, 'errored': False, 'running': True}
__init__
__init__(scan)
Initializes a module instance.
Parameters:
-
scan
–The BBOT scan object associated with this module instance.
Attributes:
-
scan
–The scan object associated with this module.
-
errored
(bool
) –Whether the module has errored out. Default is False.
Source code in bbot/modules/base.py
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 |
|
cleanup
async
cleanup()
Asynchronously performs final cleanup operations after the scan is complete.
This method can be overridden to implement custom cleanup logic. It is called only once per scan and may not raise events.
Returns:
-
–
None
Note
This method is called only once per scan and may not raise events.
Source code in bbot/modules/base.py
266 267 268 269 270 271 272 273 274 275 276 277 |
|
critical
critical(*args, trace=True, **kwargs)
Logs a whole message in emboldened red text, and optionally the stack trace of the most recent exception.
Parameters:
-
*args
–Variable-length argument list to pass to the logger.
-
trace
(bool
, default:True
) –Whether to log the stack trace of the most recently caught exception. Defaults to True.
-
**kwargs
–Arbitrary keyword arguments to pass to the logger.
Examples:
>>> self.critical("This is a critical message")
>>> self.critical("This is a critical message with a trace", trace=False)
Source code in bbot/modules/base.py
1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 |
|
debug
debug(*args, trace=False, **kwargs)
Logs debug messages and optionally the stack trace of the most recent exception.
Parameters:
-
*args
–Variable-length argument list to pass to the logger.
-
trace
(bool
, default:False
) –Whether to log the stack trace of the most recently caught exception. Defaults to False.
-
**kwargs
–Arbitrary keyword arguments to pass to the logger.
Examples:
>>> self.debug("This is a debug message")
>>> self.debug("This is a debug message with a trace", trace=True)
Source code in bbot/modules/base.py
1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 |
|
emit_event
async
emit_event(*args, **kwargs)
Emit an event to the event queue and distribute it to interested modules.
This is how modules "return" data.
The method first creates an event object by calling self.make_event()
with the provided arguments.
Then, the event is queued for outgoing distribution using self.queue_outgoing_event()
.
Parameters:
-
*args
–Positional arguments to be passed to
self.make_event()
for event creation. -
**kwargs
–Keyword arguments to be passed for event creation or configuration of the emit action.
- on_success_callback: Optional callback function to execute upon successful event emission. - abort_if: Optional condition under which the event emission should be aborted. - quick: Optional flag to indicate whether the event should be processed quickly.
Examples:
>>> await self.emit_event("www.evilcorp.com", source=event, tags=["affiliate"])
>>> new_event = self.make_event("1.2.3.4", source=event)
>>> await self.emit_event(new_event)
Returns:
-
–
None
Raises:
-
ValidationError
–If the event cannot be validated (handled in
self.make_event()
).
Source code in bbot/modules/base.py
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 |
|
error
error(*args, trace=True, **kwargs)
Logs an error message, and optionally the stack trace of the most recent exception.
Parameters:
-
*args
–Variable-length argument list to pass to the logger.
-
trace
(bool
, default:True
) –Whether to log the stack trace of the most recently caught exception. Defaults to True.
-
**kwargs
–Arbitrary keyword arguments to pass to the logger.
Examples:
>>> self.error("This is an error message")
>>> self.error("This is an error message with a trace", trace=False)
Source code in bbot/modules/base.py
1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 |
|
filter_event
async
filter_event(event)
Asynchronously filters incoming events based on custom criteria.
Override this method for more granular control over which events are accepted by your module. This method is called automatically before handle_event()
for each incoming event that matches any in watched_events
.
Parameters:
-
event
(Event
) –The incoming Event object to be filtered.
Returns:
-
tuple
–A 2-tuple where the first value is a bool indicating whether the event should be accepted, and the second value is a string explaining the reason for its acceptance or rejection. By default, returns
(True, None)
to indicate acceptance without reason.
Note
This method should be overridden if the module requires custom logic for event filtering.
Source code in bbot/modules/base.py
224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 |
|
finish
async
finish()
Asynchronously performs final tasks as the scan nears completion.
This method can be overridden to execute any necessary finalization logic. For example, if the module relies on a word cloud, you might wait for the scan to finish to ensure the word cloud is most complete before running an operation.
Returns:
-
–
None
Source code in bbot/modules/base.py
240 241 242 243 244 245 246 247 248 249 250 251 |
|
get_per_domain_hash
get_per_domain_hash(event)
Computes a per-domain hash value for a given event. This method may be optionally overridden in subclasses.
Events with the same root domain will receive the same hash value.
Parameters:
-
event
(Event
) –The event object containing host, port, or parsed URL information.
Returns:
-
int
–The hash value computed for the domain.
Examples:
>>> event = self.make_event("https://www.example.com:8443")
>>> self.get_per_domain_hash(event)
Source code in bbot/modules/base.py
957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 |
|
get_per_host_hash
get_per_host_hash(event)
Computes a per-host hash value for a given event. This method may be optionally overridden in subclasses.
The function uses the event's host
to create a string to be hashed.
Parameters:
-
event
(Event
) –The event object containing host information.
Returns:
-
int
–The hash value computed for the host.
Examples:
>>> event = self.make_event("https://example.com:8443")
>>> self.get_per_host_hash(event)
Source code in bbot/modules/base.py
915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 |
|
get_per_hostport_hash
get_per_hostport_hash(event)
Computes a per-host:port hash value for a given event. This method may be optionally overridden in subclasses.
The function uses the event's host
, port
, and scheme
(for URLs) to create a string to be hashed.
The hash value is used for distinguishing events related to the same host.
Parameters:
-
event
(Event
) –The event object containing host, port, or parsed URL information.
Returns:
-
int
–The hash value computed for the host.
Examples:
>>> event = self.make_event("https://example.com:8443")
>>> self.get_per_hostport_hash(event)
Source code in bbot/modules/base.py
933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 |
|
get_watched_events
get_watched_events()
Retrieve the set of events that the module is interested in observing.
Override this method if the set of events the module should watch needs to be determined dynamically, e.g., based on configuration options or other runtime conditions.
Returns:
-
set
–The set of event types that this module will handle.
Source code in bbot/modules/base.py
353 354 355 356 357 358 359 360 361 362 363 |
|
handle_batch
async
handle_batch(*events)
Handles incoming events in batches for optimized processing.
This method is automatically called when multiple events that match any in watched_events
are encountered and the batch_size
attribute is set to a value greater than 1. Override this method to implement custom batch event-handling logic for your module.
Parameters:
-
*events
(Event
, default:()
) –A variable number of Event objects to be processed in a batch.
Note
This method should be overridden if the batch_size
attribute of the module is set to a value greater than 1.
Returns:
-
–
None
Source code in bbot/modules/base.py
208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 |
|
handle_event
async
handle_event(event)
Asynchronously handles incoming events that the module is configured to watch.
This method is automatically invoked when an event that matches any in watched_events
is encountered during a scan. Override this method to implement custom event-handling logic for your module.
Parameters:
-
event
(Event
) –The event object containing details about the incoming event.
Note
This method should be overridden if the batch_size
attribute of the module is set to 1.
Returns:
-
–
None
Source code in bbot/modules/base.py
192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 |
|
hugeinfo
hugeinfo(*args, trace=False, **kwargs)
Logs a whole message in emboldened blue text, and optionally the stack trace of the most recent exception.
Parameters:
-
*args
–Variable-length argument list to pass to the logger.
-
trace
(bool
, default:False
) –Whether to log the stack trace of the most recently caught exception. Defaults to False.
-
**kwargs
–Arbitrary keyword arguments to pass to the logger.
Examples:
>>> self.hugeinfo("This is a huge informational message")
>>> self.hugeinfo("This is a huge informational message with a trace", trace=True)
Source code in bbot/modules/base.py
1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 |
|
hugesuccess
hugesuccess(*args, trace=False, **kwargs)
Logs a whole message in emboldened green text, and optionally the stack trace of the most recent exception.
Parameters:
-
*args
–Variable-length argument list to pass to the logger.
-
trace
(bool
, default:False
) –Whether to log the stack trace of the most recently caught exception. Defaults to False.
-
**kwargs
–Arbitrary keyword arguments to pass to the logger.
Examples:
>>> self.hugesuccess("This is a huge success message")
>>> self.hugesuccess("This is a huge success message with a trace", trace=True)
Source code in bbot/modules/base.py
1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 |
|
hugeverbose
hugeverbose(*args, trace=False, **kwargs)
Logs a whole message in emboldened white text, and optionally the stack trace of the most recent exception.
Parameters:
-
*args
–Variable-length argument list to pass to the logger.
-
trace
(bool
, default:False
) –Whether to log the stack trace of the most recently caught exception. Defaults to False.
-
**kwargs
–Arbitrary keyword arguments to pass to the logger.
Examples:
>>> self.hugeverbose("This is a huge verbose message")
>>> self.hugeverbose("This is a huge verbose message with a trace", trace=True)
Source code in bbot/modules/base.py
1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 |
|
hugewarning
hugewarning(*args, trace=True, **kwargs)
Logs a whole message in emboldened orange text, and optionally the stack trace of the most recent exception.
Parameters:
-
*args
–Variable-length argument list to pass to the logger.
-
trace
(bool
, default:True
) –Whether to log the stack trace of the most recently caught exception. Defaults to True.
-
**kwargs
–Arbitrary keyword arguments to pass to the logger.
Examples:
>>> self.hugewarning("This is a huge warning message")
>>> self.hugewarning("This is a huge warning message with a trace", trace=False)
Source code in bbot/modules/base.py
1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 |
|
info
info(*args, trace=False, **kwargs)
Logs informational messages and optionally the stack trace of the most recent exception.
Parameters:
-
*args
–Variable-length argument list to pass to the logger.
-
trace
(bool
, default:False
) –Whether to log the stack trace of the most recently caught exception. Defaults to False.
-
**kwargs
–Arbitrary keyword arguments to pass to the logger.
Examples:
>>> self.info("This is an informational message")
>>> self.info("This is an informational message with a trace", trace=True)
Source code in bbot/modules/base.py
1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 |
|
log_table
log_table(*args, **kwargs)
Logs a table to the console and optionally writes it to a file.
This function generates a table using self.helpers.make_table
, then logs each line
of the table as an info-level log. If a table_name is provided, it also writes the table to a file.
Parameters:
-
*args
–Variable length argument list to be passed to
self.helpers.make_table
. -
**kwargs
–Arbitrary keyword arguments. If 'table_name' is specified, the table will be written to a file.
Returns:
-
str
–The generated table as a string.
Examples:
>>> self.log_table(['Header1', 'Header2'], [['row1col1', 'row1col2'], ['row2col1', 'row2col2']], table_name="my_table")
Source code in bbot/modules/base.py
1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 |
|
make_event
make_event(*args, **kwargs)
Create an event for the scan.
Raises a validation error if the event could not be created, unless raise_error is set to False.
Parameters:
-
*args
–Positional arguments to be passed to the scan's make_event method.
-
**kwargs
–Keyword arguments to be passed to the scan's make_event method.
-
raise_error
(bool
) –Whether to raise a validation error if the event could not be created. Defaults to False.
Examples:
>>> new_event = self.make_event("1.2.3.4", source=event)
>>> await self.emit_event(new_event)
Returns:
-
–
Event or None: The created event, or None if a validation error occurred and raise_error was False.
Raises:
-
ValidationError
–If the event could not be validated and raise_error is True.
Source code in bbot/modules/base.py
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 |
|
ping
async
ping()
Asynchronously checks the health of the configured API.
This method is used in conjunction with require_api_key() to verify that the API is not just configured, but also responsive. This method should include an assert statement to validate the API's health, typically by making a test request to a known endpoint.
Example Usage
In your implementation, if the API has a "/ping" endpoint: async def ping(self): r = await self.request_with_fail_count(f"{self.base_url}/ping") resp_content = getattr(r, "text", "") assert getattr(r, "status_code", 0) == 200, resp_content
Returns:
-
–
None
Raises:
-
AssertionError
–If the API does not respond as expected.
Source code in bbot/modules/base.py
306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 |
|
queue_event
async
queue_event(event, precheck=True)
Asynchronously queues an incoming event to the module's event queue for further processing.
The function performs an initial check to see if the event is acceptable for queuing.
If the event passes the check, it is put into the incoming_event_queue
.
Parameters:
-
event
–The event object to be queued.
Returns:
-
None
–The function doesn't return anything but modifies the state of the
incoming_event_queue
.
Examples:
>>> await self.queue_event(some_event)
Raises:
-
AttributeError
–If the module is not in an acceptable state to queue incoming events.
Source code in bbot/modules/base.py
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 |
|
queue_outgoing_event
async
queue_outgoing_event(event, **kwargs)
Queues an outgoing event to the module's outgoing event queue for further processing.
The function attempts to put the event into the outgoing_event_queue
immediately.
If it's not possible due to the current state of the module, an AttributeError is raised, and a debug log is generated.
Parameters:
-
event
–The event object to be queued.
-
**kwargs
–Additional keyword arguments to be associated with the event.
Returns:
-
None
–The function doesn't return anything but modifies the state of the
outgoing_event_queue
.
Examples:
>>> self.queue_outgoing_event(some_outgoing_event, abort_if=lambda e: "unresolved" in e.tags)
Raises:
-
AttributeError
–If the module is not in an acceptable state to queue outgoing events.
Source code in bbot/modules/base.py
818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 |
|
report
async
report()
Asynchronously executes a final task after the scan is complete but before cleanup.
This method can be overridden to aggregate data and raise summary events at the end of the scan.
Returns:
-
–
None
Note
This method is called only once per scan.
Source code in bbot/modules/base.py
253 254 255 256 257 258 259 260 261 262 263 264 |
|
request_with_fail_count
async
request_with_fail_count(*args, **kwargs)
Asynchronously perform an HTTP request while keeping track of consecutive failures.
This function wraps the self.helpers.request
method, incrementing a failure counter if
the request returns None. When the failure counter exceeds self.failed_request_abort_threshold
,
the module is set to an error state.
Parameters:
-
*args
–Positional arguments to pass to
self.helpers.request
. -
**kwargs
–Keyword arguments to pass to
self.helpers.request
.
Returns:
-
Any
–The response object or None if the request failed.
Raises:
-
None
–Sets the module to an error state when the failure threshold is reached.
Source code in bbot/modules/base.py
1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 |
|
require_api_key
async
require_api_key()
Asynchronously checks if an API key is required and valid.
Returns:
-
–
bool or tuple: Returns True if API key is valid and ready. Returns a tuple (None, "error message") otherwise.
Notes
- Fetches the API key from the configuration.
- Calls the 'ping()' method to test API accessibility.
- Sets the API key readiness status accordingly.
Source code in bbot/modules/base.py
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 |
|
set_error_state
set_error_state(message=None, clear_outgoing_queue=False)
Puts the module into an errored state where it cannot accept new events. Optionally logs a warning message.
The function sets the module's errored
attribute to True and logs a warning with the optional message.
It also clears the incoming event queue to prevent further processing and updates its status to False.
Parameters:
-
message
(str
, default:None
) –Additional message to be logged along with the warning.
Returns:
-
None
–The function doesn't return anything but updates the
errored
state and clears the incoming event queue.
Examples:
>>> self.set_error_state()
>>> self.set_error_state("Failed to connect to the server")
Notes
- The function sets
self._incoming_event_queue
to False to prevent its further use. - If the module was already in an errored state, the function will not reset the error state or the queue.
Source code in bbot/modules/base.py
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 |
|
setup
async
setup()
Performs one-time setup tasks for the module.
This method is responsible for preparing the module for its operation, which may include tasks such as downloading necessary resources, validating configuration parameters, or other preliminary checks.
Returns:
-
tuple
–- bool or None: A status indicating the outcome of the setup process. Returns
True
if the setup was successful,None
for a soft-fail where the module setup did not succeed but the scan will continue with the module disabled, andFalse
for a hard-fail where the setup failure causes the scan to abort. - str, optional: A reason for the setup failure, provided only when the setup does not
succeed (i.e., returns
None
orFalse
).
- bool or None: A status indicating the outcome of the setup process. Returns
Examples:
>>> async def setup(self):
>>> if not self.config.get("api_key"):
>>> # Soft-fail: Configuration missing an API key
>>> return None, "No API key specified"
>>> async def setup(self):
>>> try:
>>> wordlist = await self.helpers.wordlist("https://raw.githubusercontent.com/user/wordlist.txt")
>>> except WordlistError as e:
>>> # Hard-fail: Error retrieving wordlist
>>> return False, f"Error retrieving wordlist: {e}"
>>> async def setup(self):
>>> self.timeout = self.config.get("timeout", 5)
>>> # Success: Setup completed without issues
>>> return True
Source code in bbot/modules/base.py
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 |
|
stdout
stdout(*args, **kwargs)
Writes log messages directly to standard output.
This is typically reserved for output modules only, e.g. human
or json
.
Parameters:
-
*args
–Variable length argument list to be passed to
self.log.stdout
. -
**kwargs
–Arbitrary keyword arguments to be passed to
self.log.stdout
.
Examples:
>>> self.stdout("This will be printed to stdout")
Source code in bbot/modules/base.py
1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 |
|
success
success(*args, trace=False, **kwargs)
Logs a success message, and optionally the stack trace of the most recent exception.
Parameters:
-
*args
–Variable-length argument list to pass to the logger.
-
trace
(bool
, default:False
) –Whether to log the stack trace of the most recently caught exception. Defaults to False.
-
**kwargs
–Arbitrary keyword arguments to pass to the logger.
Examples:
>>> self.success("Operation completed successfully")
>>> self.success("Operation completed with a trace", trace=True)
Source code in bbot/modules/base.py
1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 |
|
trace
trace()
Logs the stack trace of the most recently caught exception.
This method captures the type, value, and traceback of the most recent exception and logs it using the trace level. It is typically used for debugging purposes.
Anything logged using this method will always be written to the scan's debug.log
, even if debugging is not enabled.
Examples:
>>> try:
>>> 1 / 0
>>> except ZeroDivisionError:
>>> self.trace()
Source code in bbot/modules/base.py
1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 |
|
verbose
verbose(*args, trace=False, **kwargs)
Logs messages and optionally the stack trace of the most recent exception.
Parameters:
-
*args
–Variable-length argument list to pass to the logger.
-
trace
(bool
, default:False
) –Whether to log the stack trace of the most recently caught exception. Defaults to False.
-
**kwargs
–Arbitrary keyword arguments to pass to the logger.
Examples:
>>> self.verbose("This is a verbose message")
>>> self.verbose("This is a verbose message with a trace", trace=True)
Source code in bbot/modules/base.py
1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 |
|
warning
warning(*args, trace=True, **kwargs)
Logs a warning message, and optionally the stack trace of the most recent exception.
Parameters:
-
*args
–Variable-length argument list to pass to the logger.
-
trace
(bool
, default:True
) –Whether to log the stack trace of the most recently caught exception. Defaults to True.
-
**kwargs
–Arbitrary keyword arguments to pass to the logger.
Examples:
>>> self.warning("This is a warning message")
>>> self.warning("This is a warning message with a trace", trace=False)
Source code in bbot/modules/base.py
1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 |
|