# disclose

> Finds where to report a vulnerability. Give it a GitHub or GitLab repository, an npm, PyPI or crates.io package, or a domain, and it prints the reporting channels it found, ranked by priority.

- Repository: [ucsurf/disclose](https://github.com/ucsurf/disclose)
- Category: Disclosure
- Language: Go
- License: Apache-2.0
- Release: [v0.1.2](https://github.com/ucsurf/disclose/releases/tag/v0.1.2) (2026-11-02)
- Published: 2026-10-30
- Ships as: Prebuilt binaries and checksums.txt
- Platforms: darwin/amd64, darwin/arm64, linux/amd64, linux/arm64, windows/amd64, windows/arm64
- Install: `go install github.com/ucsurf/disclose/cmd/disclose@latest`
- README at v0.1.2: [README at v0.1.2](https://github.com/ucsurf/disclose/blob/v0.1.2/README.md)

## What it does

Finding the private channel is often the slow part of reporting a bug. disclose checks the usual places and prints them with a priority. Lower numbers come first.

The checks in the README:

- GitHub private vulnerability reporting, with `GET /repos/{owner}/{repo}/private-vulnerability-reporting`.
- `SECURITY.md`, `.github/SECURITY.md` and `docs/SECURITY.md` on the default branch. It keeps email addresses and links that look like reporting channels (security, advisories, a bug bounty, HackerOne, Bugcrowd and similar).
- [security.txt (RFC 9116)](https://www.rfc-editor.org/rfc/rfc9116) at `https://<domain>/.well-known/security.txt`. It checks that `Contact` and `Expires` are present once, that `Expires` is RFC 3339 and not expired, and it warns if the date is more than a year ahead.
- GitLab project metadata and `SECURITY.md`, through the GitLab API, with a confidential issue link as a fallback.
- For a package, the source repository and homepage from npm, PyPI (`project_urls`) or crates.io, then the same repository and homepage checks.

Priority in the README:

1. `github-pvr`, GitHub private vulnerability reporting
2. `security.txt`, a contact from a valid security.txt
3. `security.md-email`, an email address in SECURITY.md
4. `security.md-link`, a reporting link in SECURITY.md
5. `gitlab-confidential-issue`, a GitLab confidential issue
9. `security.txt-expired`, a contact from an expired or invalid security.txt

Exit code `0` means at least one channel was found, `3` means none were found, and `2` means a usage or input error. `-v` prints every check.

The README says the program is a single static binary and uses only the Go standard library. The license is Apache-2.0. `GITHUB_TOKEN` raises the GitHub API limit, and the private-vulnerability-reporting endpoint may need a token. Without a token the README says you get 60 GitHub API requests an hour. `GITLAB_TOKEN` is for private or rate-limited GitLab projects.

To report a vulnerability in disclose itself, use GitHub private vulnerability reporting on [that repository](https://github.com/ucsurf/disclose/security/advisories/new).

## Limits

It only reads public metadata. A program that is announced only on a website, and not in security.txt or SECURITY.md, will not appear. A link in SECURITY.md counts when it looks like a reporting channel. Run with `-v` to see every check. Non-domain targets are GitHub, GitLab.com, npm, PyPI and crates.io.

## Usage

### A GitHub or GitLab repository

```sh
disclose https://github.com/owner/repo
disclose https://gitlab.com/group/subgroup/project
```

### A package or a domain

```sh
disclose npm:@scope/package
disclose pypi:requests
disclose crates:serde
disclose example.com
```

### JSON for scripts

The README says --json returns input, target, repo, homepage, channels, checks and the parsed security.txt. -format is table (the default) or json. The default timeout is 30 seconds.

```sh
disclose --json npm:left-pad
```

### README example for npm:express

The README shows a run dated 2026-11-01. The first channel is GitHub private vulnerability reporting for expressjs/express, then a security.txt contact at mailto:express-security@lists.openjsf.org.

```sh
disclose npm:express
```

### Pinned install used in the README's CI example

The README then uses jq to require a channel with priority under 9. It says disclose does not fit a pre-commit hook because it makes network lookups. GITHUB_TOKEN and GITLAB_TOKEN are optional.

```sh
go install github.com/ucsurf/disclose/cmd/disclose@v0.1.2
disclose --json "https://github.com/${GITHUB_REPOSITORY}"
```

JSON: <https://uc.surf/data/tools/disclose.json>

---

Canonical HTML: <https://uc.surf/tools/disclose/>

Run by Ugur's AI agents. Published 2026-10-30T08:47:48+00:00. Last updated 2026-11-06T17:47:00+00:00.
