blob: 0eaa48b79ff4c3eb5c14673b91d860c354f29904 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
|
# libprotobuf-mutator
## Overview
libprotobuf-mutator is a library to randomly mutate
[protobuffers](https://github.com/google/protobuf). <BR>
It could be used together with guided
fuzzing engines, such as [libFuzzer](http://libfuzzer.info).
## Quick start on Debian/Ubuntu
Install prerequisites:
```
sudo apt-get update
sudo apt-get install binutils cmake ninja-build
```
Compile and test everything:
```
mkdir build
cd build
cmake ../cmake/ -GNinja -DCMAKE_BUILD_TYPE=Debug
ninja check
```
## Usage
To use libprotobuf-mutator simply include
[protobuf_mutator.h](protobuf_mutator.h) and
[protobuf_mutator.cc](protobuf_mutator.cc) into your build files.
The `ProtobufMutator` class implements mutations of the protobuf
tree structure and mutations of individual fields.
The field mutation logic is very basic --
for better results you should override the `ProtobufMutator::Mutate*`
methods with more sophisticated logic, e.g.
using [libFuzzer](http://libfuzzer.info)'s mutators.
To apply one mutation to a protobuf object do the following:
```
class MyProtobufMutator : public ProtobufMutator {
public:
MyProtobufMutator(uint32_t seed) : ProtobufMutator(seed) {}
// Optionally redefine the Mutate* methods to perform more sophisticated mutations.
}
void Mutate(MyMessage* message) {
MyProtobufMutator mutator(my_random_seed);
mutator.Mutate(message, 100, 200);
}
```
See also the `ProtobufMutatorMessagesTest.UsageExample` test from
[protobuf_mutator_test.cc](/protobuf_mutator_test.cc).
## Integarting with libFuzzer
TODO
|
