github.com/google/syzkaller@v0.0.0-20240517125934-c0f1611a36d6/README.md (about)

     1  # syzkaller - kernel fuzzer
     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  [![Go Report Card](https://goreportcard.com/badge/github.com/google/syzkaller)](https://goreportcard.com/report/github.com/google/syzkaller)
     6  [![Coverage Status](https://codecov.io/gh/google/syzkaller/graph/badge.svg)](https://codecov.io/gh/google/syzkaller)
     7  [![GoDoc](https://godoc.org/github.com/google/syzkaller?status.svg)](https://godoc.org/github.com/google/syzkaller)
     8  [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE)
     9  
    10  `syzkaller` (`[siːzˈkɔːlə]`) is an unsupervised coverage-guided kernel fuzzer.\
    11  Supported OSes: `FreeBSD`, `Fuchsia`, `gVisor`, `Linux`, `NetBSD`, `OpenBSD`, `Windows`.
    12  
    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)).
    14  
    15  Found bugs: [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).
    16  
    17  ## Documentation
    18  
    19  Initially, syzkaller was developed with Linux kernel fuzzing in mind, but now
    20  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  For other OS kernels check:
    23  [Darwin/XNU](docs/darwin/README.md),
    24  [FreeBSD](docs/freebsd/README.md),
    25  [Fuchsia](docs/fuchsia/README.md),
    26  [NetBSD](docs/netbsd/README.md),
    27  [OpenBSD](docs/openbsd/setup.md),
    28  [Starnix](docs/starnix/README.md),
    29  [Windows](docs/windows/README.md),
    30  [gVisor](docs/gvisor/README.md).
    31  [Akaros](docs/akaros/README.md),
    32  
    33  - [How to install syzkaller](docs/setup.md)
    34  - [How to use syzkaller](docs/usage.md)
    35  - [How syzkaller works](docs/internals.md)
    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)
    39  - [Tech talks and articles](docs/talks.md)
    40  - [Research work based on syzkaller](docs/research.md)
    41  
    42  ## Disclaimer
    43  
    44  This is not an official Google product.