README and LICENSE

Signed-off-by: Vincent Batts <vbatts@hashbangbash.com>
This commit is contained in:
Vincent Batts 2018-06-06 12:38:36 -04:00
parent 66e91e3ddf
commit 2277ac5bf8
Signed by: vbatts
GPG key ID: 10937E57733F1362
2 changed files with 22 additions and 2 deletions

7
LICENSE Normal file
View file

@ -0,0 +1,7 @@
Copyright 2018 Vincent Batts
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

View file

@ -4,10 +4,23 @@ A simple filesystem walker to poke around system paths and cause the system to i
### Building
While you can `go get` the fuzz-walker binary itself, the walker functions are in plugins.
The easiest way to get started is by cloning this repo and running `make`.
You can easily:
```shell
go get git.thisco.de/vbatts/fuzz-walker
```
Additionally, you write your own walker functions as plugins.
See `git.thisco.de/vbatts/fuzz-walker/walker` package for data structures,
and `https://git.thisco.de/vbatts/fuzz-walker/src/master/walker/walkers/readFuzz/plugin.go` as an example.
This way you need no edit and recompile fuzz-walker itself over and over.
### running
I reckon you could run this on your host, but it's intended to push the bounds of what's allowed inside a container.
```shell
fuzz-walker
```
### LICENSE
See [LICENSE](./LICENSE)