Skip to content
This repository was archived by the owner on Jan 6, 2023. It is now read-only.

Commit c5e3d38

Browse files
committed
Updated the 'README.md' file for the new release.
1 parent 62749a0 commit c5e3d38

File tree

1 file changed

+15
-10
lines changed

1 file changed

+15
-10
lines changed

README.md

+15-10
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,15 @@
22
## Summary
33
The Binary String Toolkit or BST for short is a rather simple utility to
44
convert binary strings to various formats suitable for later inclusions in
5-
source codes such as those used to develop exploits in the security field.
5+
source codes, such as those used to develop exploits in the security field.
66

77
## Features
88
* Dump files content to standard output in a binary string format.
99
* Convert a plain hexadecimal input to an escaped binary string.
10-
* Output a bad character sequence in various format for inclusion in exploit
11-
codes.
12-
* Limit output binary string width for better readability in source codes.
10+
* Output a sequence of bad characters for testing proof of concept code.
11+
* Limit the width of binary strings for better readability in source codes.
1312
* Format output in your favorite programming language's syntax.
14-
* Perform binary string variable block indentation.
13+
* Perform binary variable block indentation.
1514

1615
## Dependencies
1716
* POSIX C Library
@@ -22,7 +21,7 @@ source codes such as those used to develop exploits in the security field.
2221
* Git
2322

2423
## Building
25-
To build and install the 'bstrings' binary:
24+
To build and install the 'bstrings' binary, simply do:
2625
```
2726
$ git clone https://github.com/e3prom/bst
2827
$ cd bst
@@ -34,9 +33,10 @@ $ make install
3433
## Usage
3534
The below example show how an assembled shellcode can be quickly dumped (-D)
3635
to standard output in a hexadecimal escaped (-x) binary string of 16 hexadecimal
37-
digits width (8 bytes), with python syntax formatting and an indentation of 4
38-
space characters:
36+
digits width (or 8 bytes), with Python syntax formatting and an indentation of
37+
4 space characters:
3938
```
39+
$ bstrings --verbose -x -D lnx-execve-setreuid-x86_64 -w8 -i 4 --syntax=python
4040
[*] Convert hexadecimal input to an escaped binary string.
4141
[+] Binary string width is limited to 8 bytes.
4242
[+] Output binary string using python language syntax.
@@ -51,8 +51,9 @@ space characters:
5151
```
5252

5353
You can also use bstrings to output an automatically indented bad character
54-
sequence in your favorite programming language:
54+
sequence, and thus in your favorite programming language:
5555
```
56+
$ bstrings --verbose -b -w12 -i 4 --syntax=c -n badchar
5657
[*] Generating bad character binary string.
5758
[+] Binary string width is limited to 12 bytes.
5859
unsigned char badchar[] =
@@ -80,7 +81,7 @@ sequence in your favorite programming language:
8081
"\xfd\xfe\xff"
8182
```
8283

83-
For a list of supported command-line options, simply use the '--help' switch:
84+
For a list of supported command-line options, simply execute bstrings with the '--help' switch:
8485
```
8586
$ bstrings --help
8687
Usage: ./bstrings [OPTION]...
@@ -108,5 +109,9 @@ Usage: ./bstrings [OPTION]...
108109
109110
```
110111

112+
## Contribution
113+
Feel free to contribute to this project by submitting your codes and by reporting
114+
issues or bugs.
115+
111116
## Software License
112117
This software is licensed under the terms of the GNU General Public License.

0 commit comments

Comments
 (0)