Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/MozillaSecurity/avalanche
Avalanche is a document generator which uses context-free grammars to generate randomized outputs for fuzz-testing.
https://github.com/MozillaSecurity/avalanche
Last synced: 3 months ago
JSON representation
Avalanche is a document generator which uses context-free grammars to generate randomized outputs for fuzz-testing.
- Host: GitHub
- URL: https://github.com/MozillaSecurity/avalanche
- Owner: MozillaSecurity
- License: apache-2.0
- Created: 2016-07-13T20:47:54.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2021-05-01T01:32:52.000Z (over 3 years ago)
- Last Synced: 2024-04-24T18:26:20.340Z (7 months ago)
- Language: Python
- Homepage:
- Size: 232 KB
- Stars: 29
- Watchers: 14
- Forks: 13
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Avalanche
[](https://travis-ci.com/MozillaSecurity/avalanche)
[](https://codecov.io/gh/MozillaSecurity/avalanche)
Avalanche is a document generator which uses context-free grammars to generate
randomized outputs for fuzz-testing. See the examples folder for some working
grammars.
## Quickstart
Define your grammar in a text file (UTF-8 encoding). 'root' is the default start symbol.
###### Example my.gmr:
```
root "\n" \
"\n" \
content{10} \
"\n" \
""
content "<" (tagname) ' style="color:' colour ';">Hello world' @1 ">\n"
color "#" /[a-f0-9]{3}/
tagname 1 "b"
1 "blink"
1 "i"
1 "marquee"
1 "span"
```
###### How to generate:
```
with open('my.gmr') as fd:
g = Grammar(fd)
result = g.generate()
```
###### Example value of `result` from the above grammar:
```
Hello world
Hello world
Hello world
Hello world
Hello world
Hello world
Hello world
Hello world
Hello world
Hello world
```
## Syntax Cheatsheet
```
# TextSymbol
SymName "text" # generate u"text" in the output
# ChoiceSymbol
SymName .5 Defn1 # choose between generating Defn1 (1:3 odds)
1 Defn2 # or Defn2 (2:3 odds)
SymName2 + SymName # '+' imports choices & weights from SymName into SymName2
1 Defn3 # ie. choices are Defn1 (1:5), Defn2 (2:5) or Defn3 (1:5)
SymName3 (SubSym1 | SubSym2) # inline choice, SubSym1 & SubSym2 are generated equally
# this is also a grouping and can be repeated.
# ConcatSymbol
SymName SubSym1 SubSym2 # concat, generate SubSym1 then SubSym2
SymName SubSym1 ( SubSym2 SubSym3 ) # inline concat (grouping), SubSym2 & SubSym3 can be
# repeated using RepeatSymbol or referenced later in
# the same line using RefSymbol
# RepeatSymbol
SymName SubSym{a,b} # repeat SubSym a random number of times, between a and b
SymName SubSym{a} # repeat SubSym 'a' times
SymName SubSym? # shorthand for {0,1}
# RepeatSampleSymbol
SymName SubSym # repeatedly generate SubSym between [a,b] unique choices
# SubSym must be a choice or a concat containing exactly
# one choice
# RegexSymbol
SymName /[A-Za-z]{0,4}..?[^a-f]{2}/ # simple regex generator, generate from A-Za-z [0,4]
# times, '.' generates printable ASCII. [^] inverts
# characters. ? generates [0,1] instances, etc.
# Unicode ranges are supported.
# RefSymbol
SymName @SymName2 # returns a previously generated instance of SymName2
SymName ('abc') @1 # returns the value generated in a previous ConcatSymbol defined in the
# same line (numbered in order of opening bracket, starting at 1)
# FuncSymbol
SymName rndint(a,b) # rndint, rndflt, rndpow2, eval, id, push, pop are built-in,
# others can be passed as keyword args to the Grammar constructor
# args can be numeric literals, or symbol definitions
# Import
Blah import('another.gmr') # can use imported symnames like Blah.SymName
```
## About the name
Avalanche is French for "Avalanche".