Skip to content

Commit 552d339

Browse files
committed
+minor bugfixes in the documentation
1 parent fe68b1e commit 552d339

File tree

7 files changed

+10
-12
lines changed

7 files changed

+10
-12
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
* Different versions
1010
* Different implementations
1111
* Different operating systems' implementations
12+
1213
The fuzzer uses Python and runs on multiple OSs (Linux, Windows, OS X, and
1314
Freebsd). Its main goal is to detect issues based on diffential fuzzing aided
1415
with the extended capabilities to increase coverage. Still, it will found

docs/1.-Install.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -124,4 +124,4 @@ echo @echo off > C:\Windows\System32\canaryfile.bat & echo.echo canarytokencomma
124124
---
125125
# What's next?
126126

127-
You want to define [the input](https://github.com/IOActive/XDiFF/wiki/The-input)
127+
You want to define [the input](https://github.com/IOActive/XDiFF/wiki/2.-The-input)

docs/2.-The-input.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,4 +80,4 @@ Moreover, if the software may open network connections, you also want to define
8080

8181
# What's next?
8282

83-
You want to define [the software](https://github.com/IOActive/XDiFF/wiki/The-software)
83+
You want to define [the software](https://github.com/IOActive/XDiFF/wiki/3.-The-software)

docs/3.-The-software.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,18 +15,14 @@ This defines pieces of data in three columns:
1515
<pre>
1616
<b>Type</b> = ["File"]
1717
<b>OS</b> = ["darwin", "linux2", "freebsd11"]
18-
<b>Suffix</b> = [".sh"]
19-
</pre>
20-
18+
<b>Suffix</b> = [".sh"]</pre>
2119
2.4. **Filename**: if the software to be fuzzed reads information from a certain static filename, you can define it in here. Don't forget to run the fuzzer with only 1 thread when using this.
2220

2321
3. The third column defines the pieces of software to be fuzzed. If you want to fuzz mp3 files using mpg321 and mpg123, you can do it like this:
2422

2523
<pre>
2624
Bash = ["bash", "-c", "<b>-fuzzdata=echo $(([[test]]))</b>"]
27-
Ksh = ["ksh", "-c", "<b>-fuzzdata=echo $(([[test]]))</b>"]
28-
</pre>
29-
25+
Ksh = ["ksh", "-c", "<b>-fuzzdata=echo $(([[test]]))</b>"]</pre>
3026
First we set the name of the software to be fuzzed (***bash***, ***dash***, or ***ksh***). Then, we defined in an array the command and options to be executed. There is a special option named *-fuzzdata=* that indicates the fuzzer that the next piece of information is where we will be placed our fuzzed test case. The *[[test]]* will be replaced by a temporary file name containing a weird mp3 to fuzz the software on this example.
3127

3228
### Putting all the pieces together
@@ -41,4 +37,4 @@ This is how you could define the software category ***shells*** to be fuzzed usi
4137
---
4238
# What's next?
4339

44-
You want to [run the fuzzer](https://github.com/IOActive/XDiFF/wiki/Run-the-fuzzer)
40+
You want to [run the fuzzer](https://github.com/IOActive/XDiFF/wiki/4.-The-fuzzer)

docs/4.-The-fuzzer.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ Now the output should indicate now and then when new inputs are being generated
2121

2222
There are three additional important optional settings to be mentioned:
2323

24+
- [*-D*]: Print debugging information
2425
- [*-t 100*]: The amount of threads to be executed in parallel.
2526
- [*-T 10*]: The timeout per thread
2627
- [*-v*]: Use valgrind to execute the software to be fuzzed.
@@ -30,4 +31,4 @@ The combination of threads and the timeout is something to be defined per catego
3031
---
3132
# What's next?
3233

33-
You want to analyze [the output](https://github.com/IOActive/XDiFF/wiki/The-output)
34+
You want to analyze [the output](https://github.com/IOActive/XDiFF/wiki/5.-The-output)

docs/Changelog.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Changelog
22
Changes are listed in time order: newer changes are at the top, older changes are at the bottom.
33

4-
## Version: [1.2](https://github.com/IOActive/XDiFF/releases/tag/1.2)
4+
## Version: [1.2.0](https://github.com/IOActive/XDiFF/releases/tag/1.2)
55
- Changed main function names in the root directory
66
- Improved code, documentation, and (most of) the code is now tested. Tons of bugfixes.
77
- Added new analysis for error disclosure (analyze_error_disclosure) and path disclosure (analyze_path_disclosure_stderr)

xdiff_run.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ def help(err=""):
8383
print("XDiFF Syntax: ")
8484
print(os.path.basename(__file__) + " -d db.sqlite Choose the database")
8585
print("\t -c Python Software category to be fuzzed")
86-
print("\t [-D] Debug information")
86+
print("\t [-D] Print debugging information")
8787
print("\t [-r 0] Random inputs: radamsa & zzuf without newlines (faster)")
8888
print("\t [-r 1] Random inputs: radamsa & zzuf with newlines (slower)")
8989
print("\t [-r 2] Random inputs: radamsa without newlines (faster)")

0 commit comments

Comments
 (0)