Web
These are helpers for making various web requests.
Note that these helpers can be invoked directly from self.helpers
, e.g.:
self.helpers.request("https://www.evilcorp.com")
WebHelper
Main utility class for managing HTTP operations in BBOT. It serves as a wrapper around the BBOTAsyncClient, which itself is a subclass of httpx.AsyncClient. The class provides functionalities to make HTTP requests, download files, and handle cached wordlists.
Attributes:
-
parent_helper
(object
) –The parent helper object containing scan configurations.
-
http_debug
(bool
) –Flag to indicate whether HTTP debugging is enabled.
-
ssl_verify
(bool
) –Flag to indicate whether SSL verification is enabled.
-
web_client
(BBOTAsyncClient
) –An instance of BBOTAsyncClient for making HTTP requests.
-
client_only_options
(tuple
) –A tuple of options only applicable to the web client.
Examples:
Basic web request:
>>> response = await self.helpers.request("https://www.evilcorp.com")
Download file:
>>> filename = await self.helpers.download("https://www.evilcorp.com/passwords.docx")
Download wordlist (cached for 30 days by default):
>>> filename = await self.helpers.wordlist("https://www.evilcorp.com/wordlist.txt")
Source code in bbot/core/helpers/web.py
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 |
|
api_page_iter
async
api_page_iter(url, page_size=100, json=True, next_key=None, **requests_kwargs)
An asynchronous generator function for iterating through paginated API data.
This function continuously makes requests to a specified API URL, incrementing the page number or applying a custom pagination function, and yields the received data one page at a time. It is well-suited for APIs that provide paginated results.
Parameters:
-
url
(str
) –The initial API URL. Can contain placeholders for 'page', 'page_size', and 'offset'.
-
page_size
(int
, default:100
) –The number of items per page. Defaults to 100.
-
json
(bool
, default:True
) –If True, attempts to deserialize the response content to a JSON object. Defaults to True.
-
next_key
(callable
, default:None
) –A function that takes the last page's data and returns the URL for the next page. Defaults to None.
-
**requests_kwargs
–Arbitrary keyword arguments that will be forwarded to the HTTP request function.
Yields:
-
–
dict or httpx.Response: If 'json' is True, yields a dictionary containing the parsed JSON data. Otherwise, yields the raw HTTP response.
Note
The loop will continue indefinitely unless manually stopped. Make sure to break out of the loop once the last page has been received.
Examples:
>>> agen = api_page_iter('https://api.example.com/data?page={page}&page_size={page_size}')
>>> try:
>>> async for page in agen:
>>> subdomains = page["subdomains"]
>>> self.hugesuccess(subdomains)
>>> if not subdomains:
>>> break
>>> finally:
>>> agen.aclose()
Source code in bbot/core/helpers/web.py
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 |
|
beautifulsoup
beautifulsoup(markup, features='html.parser', builder=None, parse_only=None, from_encoding=None, exclude_encodings=None, element_classes=None, **kwargs)
Naviate, Search, Modify, Parse, or PrettyPrint HTML Content. More information at https://beautiful-soup-4.readthedocs.io/en/latest/
Parameters:
-
markup
–A string or a file-like object representing markup to be parsed.
-
features
–Desirable features of the parser to be used. This may be the name of a specific parser ("lxml", "lxml-xml", "html.parser", or "html5lib") or it may be the type of markup to be used ("html", "html5", "xml"). Defaults to 'html.parser'.
-
builder
–A TreeBuilder subclass to instantiate (or instance to use) instead of looking one up based on
features
. -
parse_only
–A SoupStrainer. Only parts of the document matching the SoupStrainer will be considered.
-
from_encoding
–A string indicating the encoding of the document to be parsed.
Returns:
-
soup
–An instance of the BeautifulSoup class
Todo
- Write tests for this function
Examples:
>>> soup = self.helpers.beautifulsoup(event.data["body"], "html.parser")
Perform an html parse of the 'markup' argument and return a soup instance
>>> email_type = soup.find(type="email")
Searches the soup instance for all occurances of the passed in argument
Source code in bbot/core/helpers/web.py
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 |
|
curl
async
curl(*args, **kwargs)
An asynchronous function that runs a cURL command with specified arguments and options.
This function constructs and executes a cURL command based on the provided parameters. It offers support for various cURL options such as headers, post data, and cookies.
Parameters:
-
*args
–Variable length argument list for positional arguments. Unused in this function.
-
url
(str
) –The URL for the cURL request. Mandatory.
-
raw_path
(bool
) –If True, activates '--path-as-is' in cURL. Defaults to False.
-
headers
(dict
) –A dictionary of HTTP headers to include in the request.
-
ignore_bbot_global_settings
(bool
) –If True, ignores the global settings of BBOT. Defaults to False.
-
post_data
(dict
) –A dictionary containing data to be sent in the request body.
-
method
(str
) –The HTTP method to use for the request (e.g., 'GET', 'POST').
-
cookies
(dict
) –A dictionary of cookies to include in the request.
-
path_override
(str
) –Overrides the request-target to use in the HTTP request line.
-
head_mode
(bool
) –If True, includes '-I' to fetch headers only. Defaults to None.
-
raw_body
(str
) –Raw string to be sent in the body of the request.
-
**kwargs
–Arbitrary keyword arguments that will be forwarded to the HTTP request function.
Returns:
-
str
–The output of the cURL command.
Raises:
-
CurlError
–If 'url' is not supplied.
Examples:
>>> output = await curl(url="https://example.com", headers={"X-Header": "Wat"})
>>> print(output)
Source code in bbot/core/helpers/web.py
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 |
|
download
async
download(url, **kwargs)
Asynchronous function for downloading files from a given URL. Supports caching with an optional time period in hours via the "cache_hrs" keyword argument. In case of successful download, returns the full path of the saved filename. If the download fails, returns None.
Parameters:
-
url
(str
) –The URL of the file to download.
-
filename
(str
) –The filename to save the downloaded file as. If not provided, will generate based on URL.
-
max_size
(str or int
) –Maximum filesize as a string ("5MB") or integer in bytes.
-
cache_hrs
(float
) –The number of hours to cache the downloaded file. A negative value disables caching. Defaults to -1.
-
method
(str
) –The HTTP method to use for the request, defaults to 'GET'.
-
raise_error
(bool
) –Whether to raise exceptions for HTTP connect, timeout errors. Defaults to False.
-
**kwargs
–Additional keyword arguments to pass to the httpx request.
Returns:
-
–
Path or None: The full path of the downloaded file as a Path object if successful, otherwise None.
Examples:
>>> filepath = await self.helpers.download("https://www.evilcorp.com/passwords.docx", cache_hrs=24)
Source code in bbot/core/helpers/web.py
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 |
|
is_spider_danger
is_spider_danger(source_event, url)
Determines whether visiting a URL could potentially trigger a web-spider-like happening.
This function assesses the depth and distance of a URL in relation to the parent helper's configuration settings for web spidering. If the URL exceeds the specified depth or distance, the function returns True, indicating a possible web-spider risk.
Parameters:
-
source_event
–The source event object that discovered the URL.
-
url
(str
) –The URL to evaluate for web-spider risk.
Returns:
-
bool
–True if visiting the URL might trigger a web-spider-like event, False otherwise.
Todo
- Write tests for this function
Examples:
>>> is_spider_danger(source_event_obj, "https://example.com/subpage")
True
>>> is_spider_danger(source_event_obj, "https://example.com/")
False
Source code in bbot/core/helpers/web.py
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 |
|
request
async
request(*args, **kwargs)
Asynchronous function for making HTTP requests, intended to be the most basic web request function used widely across BBOT and within this helper class. Handles various exceptions and timeouts that might occur during the request.
This function automatically respects the scan's global timeout, proxy, headers, etc. Headers you specify will be merged with the scan's. Your arguments take ultimate precedence, meaning you can override the scan's values if you want.
Parameters:
-
url
(str
) –The URL to send the request to.
-
method
(str
) –The HTTP method to use for the request. Defaults to 'GET'.
-
headers
(dict
) –Dictionary of HTTP headers to send with the request.
-
params
(dict
) –Dictionary, list of tuples, or bytes to send in the query string.
-
cookies
(dict
) –Dictionary or CookieJar object containing cookies.
-
json
(Any
) –A JSON serializable Python object to send in the body.
-
data
(dict
) –Dictionary, list of tuples, or bytes to send in the body.
-
files
(dict
) –Dictionary of 'name': file-like-objects for multipart encoding upload.
-
auth
(tuple
) –Auth tuple to enable Basic/Digest/Custom HTTP auth.
-
timeout
(float
) –The maximum time to wait for the request to complete.
-
proxies
(dict
) –Dictionary mapping protocol schemes to proxy URLs.
-
allow_redirects
(bool
) –Enables or disables redirection. Defaults to None.
-
stream
(bool
) –Enables or disables response streaming.
-
raise_error
(bool
) –Whether to raise exceptions for HTTP connect, timeout errors. Defaults to False.
-
client
(AsyncClient
) –A specific httpx.AsyncClient to use for the request. Defaults to self.web_client.
-
cache_for
(int
) –Time in seconds to cache the request. Not used currently. Defaults to None.
Raises:
-
TimeoutException
–If the request times out.
-
ConnectError
–If the connection fails.
-
RequestError
–For other request-related errors.
Returns:
-
–
httpx.Response or None: The HTTP response object returned by the httpx library.
Examples:
>>> response = await self.helpers.request("https://www.evilcorp.com")
>>> response = await self.helpers.request("https://api.evilcorp.com/", method="POST", data="stuff")
Note
If the web request fails, it will return None unless raise_error
is True
.
Source code in bbot/core/helpers/web.py
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 |
|
wordlist
async
wordlist(path, lines=None, **kwargs)
Asynchronous function for retrieving wordlists, either from a local path or a URL. Allows for optional line-based truncation and caching. Returns the full path of the wordlist file or a truncated version of it.
Parameters:
-
path
(str
) –The local or remote path of the wordlist.
-
lines
(int
, default:None
) –Number of lines to read from the wordlist. If specified, will return a truncated wordlist with this many lines.
-
cache_hrs
(float
) –Number of hours to cache the downloaded wordlist. Defaults to 720 hours (30 days) for remote wordlists.
-
**kwargs
–Additional keyword arguments to pass to the 'download' function for remote wordlists.
Returns:
-
Path
–The full path of the wordlist (or its truncated version) as a Path object.
Raises:
-
WordlistError
–If the path is invalid or the wordlist could not be retrieved or found.
Examples:
Fetching full wordlist
>>> wordlist_path = await self.helpers.wordlist("https://www.evilcorp.com/wordlist.txt")
Fetching and truncating to the first 100 lines
>>> wordlist_path = await self.helpers.wordlist("/root/rockyou.txt", lines=100)
Source code in bbot/core/helpers/web.py
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 |
|