Skip to content

Commit b6ded33

Browse files
lidelBigLep
andauthored
docs: add SECURITY.md (#9062)
* docs: add SECURITY.md This moves existing security policy from README to SECURITY.md which has a special meaning on Github: https://docs.github.com/en/code-security/getting-started/adding-a-security-policy-to-your-repository * style: editoral fix Co-authored-by: Steve Loeppky <biglep@protocol.ai>
1 parent 862ce6b commit b6ded33

File tree

2 files changed

+34
-14
lines changed

2 files changed

+34
-14
lines changed

README.md

+14-14
Original file line numberDiff line numberDiff line change
@@ -47,24 +47,26 @@ Before opening an issue, consider using one of the following locations to ensure
4747
- [Other package managers](#other-package-managers)
4848
- [Guix](#guix)
4949
- [Snap](#snap)
50-
- [macOS package managers](#macos-package-managers)
51-
- [MacPorts](#MacPorts)
52-
- [Nix](#nix-macos)
53-
- [Homebrew](#Homebrew)
50+
- [macOS package managers](#macos-package-managers)
51+
- [MacPorts](#macports)
52+
- [Nix](#nix-macos)
53+
- [Homebrew](#homebrew)
5454
- [Windows package managers](#windows-package-managers)
5555
- [Chocolatey](#chocolatey)
5656
- [Scoop](#scoop)
57-
- [Install prebuilt binaries](#install-prebuilt-binaries)
57+
- [Install prebuilt binaries](#install-prebuilt-binaries)
5858
- [Build from Source](#build-from-source)
5959
- [Install Go](#install-go)
6060
- [Download and Compile IPFS](#download-and-compile-ipfs)
61-
- [Cross Compiling](#cross-compiling)
62-
- [OpenSSL](#openssl)
61+
- [Cross Compiling](#cross-compiling)
62+
- [OpenSSL](#openssl)
6363
- [Troubleshooting](#troubleshooting)
6464
- [Updating go-ipfs](#updating-go-ipfs)
65+
- [Using ipfs-update](#using-ipfs-update)
66+
- [Downloading IPFS builds using IPFS](#downloading-ipfs-builds-using-ipfs)
6567
- [Getting Started](#getting-started)
66-
- [Some things to try](#some-things-to-try)
6768
- [Usage](#usage)
69+
- [Some things to try](#some-things-to-try)
6870
- [Troubleshooting](#troubleshooting-1)
6971
- [Packages](#packages)
7072
- [Development](#development)
@@ -78,11 +80,7 @@ Before opening an issue, consider using one of the following locations to ensure
7880

7981
## Security Issues
8082

81-
The IPFS protocol and its implementations are still in heavy development. This means that there may be problems in our protocols, or there may be mistakes in our implementations. And -- though IPFS is not production-ready yet -- many people are already running nodes in their machines. So we take security vulnerabilities very seriously. If you discover a security issue, please bring it to our attention right away!
82-
83-
If you find a vulnerability that may affect live deployments -- for example, by exposing a remote execution exploit -- please send your report privately to security@ipfs.io. Please DO NOT file a public issue.
84-
85-
If the issue is a protocol weakness that cannot be immediately exploited or something not yet deployed, just discuss it openly.
83+
Please follow [`SECURITY.md`](SECURITY.md).
8684

8785
## Install
8886

@@ -168,7 +166,9 @@ $ sudo snap install ipfs
168166

169167
The snap sets `IPFS_PATH` to `SNAP_USER_COMMON`, which is usually `~/snap/ipfs/common`. If you want to use `~/.ipfs` instead, you can bind-mount it to `~/snap/ipfs/common` like this:
170168

171-
```sudo mount --bind ~/.ipfs ~/snap/ipfs/common```
169+
```
170+
$ sudo mount --bind ~/.ipfs ~/snap/ipfs/common
171+
```
172172

173173
If you want something more sophisticated to escape the snap confinement, we recommend using a different method to install `go-ipfs` so that it is not subject to snap confinement.
174174

SECURITY.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Security Policy
2+
3+
The IPFS protocol and its implementations are still in heavy development. This
4+
means that there may be problems in our protocols, or there may be mistakes in
5+
our implementations. We take security
6+
vulnerabilities very seriously. If you discover a security issue, please bring
7+
it to our attention right away!
8+
9+
## Reporting a Vulnerability
10+
11+
If you find a vulnerability that may affect live deployments -- for example, by
12+
exposing a remote execution exploit -- please **send your report privately** to
13+
security@ipfs.io. Please **DO NOT file a public issue**.
14+
15+
If the issue is a protocol weakness that cannot be immediately exploited or
16+
something not yet deployed, just discuss it openly.
17+
18+
## Reporting a non security bug
19+
20+
For non-security bugs, please simply file a GitHub [issue](https://github.com/ipfs/go-ipfs/issues/new/choose).

0 commit comments

Comments
 (0)