Skip to content

Commit 1558363

Browse files
Merge pull request #1731 from SgtCoDFish/oss-fuzz
Add some basic docs on oss-fuzz
2 parents a16779a + a10a1e9 commit 1558363

File tree

2 files changed

+22
-0
lines changed

2 files changed

+22
-0
lines changed
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
title: OSS-Fuzz Integration
3+
description: "Understanding cert-manager's integration with OSS-Fuzz"
4+
---
5+
6+
cert-manager integrates with [OSS-Fuzz](https://google.github.io/oss-fuzz/) for continuous fuzzing of its codebase. This integration helps identify and fix security vulnerabilities and bugs in the cert-manager code.
7+
8+
By way of example, [`GHSA-r4pg-vg54-wxx4`](https://github.com/cert-manager/cert-manager/security/advisories/GHSA-r4pg-vg54-wxx4) was discovered through OSS-Fuzz testing.
9+
10+
## How OSS-Fuzz is Configured
11+
12+
cert-manager's OSS-Fuzz configuration is defined in the [`google/oss-fuzz` repo](https://github.com/google/oss-fuzz/tree/master/projects/cert-manager).
13+
14+
Specifically, the configuration includes a `project.yaml` file which specifies metadata about the project and, importantly, who has access to view details about fuzz test failures. Failures are embargoed from being published for a period after being reported to prevent exploitation in the event that the failure is a security issue.
15+
16+
The cert-manager setup is based on the [guide for setting up a Go project](https://google.github.io/oss-fuzz/getting-started/new-project-guide/go-lang/).
17+
18+
Warning: Because the fuzz tests require Go code to be linked to C++, the setup is complex, doesn't look like "regular" Go code, and it's not trivial to follow!

content/docs/manifest.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -743,6 +743,10 @@
743743
"title": "Running End-to-End Tests",
744744
"path": "/docs/contributing/e2e.md"
745745
},
746+
{
747+
"title": "OSS-Fuzz Tests",
748+
"path": "/docs/contributing/oss-fuzz.md"
749+
},
746750
{
747751
"title": "Implementing External Issuers",
748752
"path": "/docs/contributing/external-issuers.md"

0 commit comments

Comments
 (0)