README.md 2.5 KB
Newer Older
D
Dmitry Vyukov 已提交
1
# syzkaller - kernel fuzzer
D
Dmitry Vyukov 已提交
2

3
[![CI Status](https://github.com/google/syzkaller/workflows/ci/badge.svg)](https://github.com/google/syzkaller/actions?query=workflow/ci)
4
[![OSS-Fuzz](https://oss-fuzz-build-logs.storage.googleapis.com/badges/syzkaller.svg)](https://bugs.chromium.org/p/oss-fuzz/issues/list?q=label:Proj-syzkaller)
5 6 7 8
[![Go Report Card](https://goreportcard.com/badge/github.com/google/syzkaller)](https://goreportcard.com/report/github.com/google/syzkaller)
[![Coverage Status](https://codecov.io/gh/google/syzkaller/graph/badge.svg)](https://codecov.io/gh/google/syzkaller)
[![GoDoc](https://godoc.org/github.com/google/syzkaller?status.svg)](https://godoc.org/github.com/google/syzkaller)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE)
A
Andrey Konovalov 已提交
9

10
`syzkaller` (`[siːzˈkɔːlə]`) is an unsupervised coverage-guided kernel fuzzer.\
D
Dmitry Vyukov 已提交
11
Supported OSes: `Akaros`, `FreeBSD`, `Fuchsia`, `gVisor`, `Linux`, `NetBSD`, `OpenBSD`, `Windows`.
D
Dmitry Vyukov 已提交
12

D
Dmitry Vyukov 已提交
13
Mailing list: [syzkaller@googlegroups.com](https://groups.google.com/forum/#!forum/syzkaller) (join on [web](https://groups.google.com/forum/#!forum/syzkaller) or by [email](mailto:syzkaller+subscribe@googlegroups.com)).
D
Dmitry Vyukov 已提交
14

D
Dmitry Vyukov 已提交
15
Found bugs: [Akaros](docs/akaros/found_bugs.md), [Darwin/XNU](docs/darwin/README.md), [FreeBSD](docs/freebsd/found_bugs.md), [Linux](docs/linux/found_bugs.md), [NetBSD](docs/netbsd/found_bugs.md), [OpenBSD](docs/openbsd/found_bugs.md), [Windows](docs/windows/README.md).
D
Dmitry Vyukov 已提交
16

17
## Documentation
D
Dmitry Vyukov 已提交
18

19 20
Initially, syzkaller was developed with Linux kernel fuzzing in mind, but now
it's being extended to support other OS kernels as well.
21
Most of the documentation at this moment is related to the [Linux](docs/linux/setup.md) kernel.
22 23 24
For other OS kernels check:
[Akaros](docs/akaros/README.md),
[Darwin/XNU](docs/darwin/README.md),
25 26
[FreeBSD](docs/freebsd/README.md),
[Fuchsia](docs/fuchsia/README.md),
27
[NetBSD](docs/netbsd/README.md),
28
[OpenBSD](docs/openbsd/setup.md),
29
[Starnix](docs/starnix/README.md),
30
[Windows](docs/windows/README.md),
31
[gVisor](docs/gvisor/README.md).
32

33 34 35
- [How to install syzkaller](docs/setup.md)
- [How to use syzkaller](docs/usage.md)
- [How syzkaller works](docs/internals.md)
S
Space Meyer 已提交
36
- [How to install syzbot](docs/setup_syzbot.md)
37
- [How to contribute to syzkaller](docs/contributing.md)
38
- [How to report Linux kernel bugs](docs/linux/reporting_kernel_bugs.md)
D
Dmitry Vyukov 已提交
39 40
- [Tech talks and articles](docs/talks.md)
- [Research work based on syzkaller](docs/research.md)
D
Dmitry Vyukov 已提交
41

42 43
## Disclaimer

D
Dmitry Vyukov 已提交
44
This is not an official Google product.