Skip to content

Commit 122207f

Browse files
committed
feat(doc): add SECURITY.md
Add a `SECURITY.md` listing the security PGP key to be used for disclosures
1 parent 646661f commit 122207f

2 files changed

Lines changed: 18 additions & 9 deletions

File tree

CONTRIBUTING.md

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -98,16 +98,9 @@ All new features require testing. Tests should be unique and self-describing. If
9898
Security
9999
--------
100100

101-
Security is a high priority of BDK; disclosure of security vulnerabilities helps
102-
prevent user loss of funds.
101+
Given the critical nature of BDK as a wallet library, we take security very seriously.
103102

104-
Note that BDK is currently considered "pre-production" during this time, there
105-
is no special handling of security issues. Please simply open an issue on
106-
Github.
107-
108-
BDK requires all commits to be signed using PGP. Refer to
109-
[this guide](https://git-scm.com/book/en/v2/Git-Tools-Signing-Your-Work)
110-
if you don't have a PGP key set up with `git` yet.
103+
For information on how to report security vulnerabilities, please refer to the [Security Policy](SECURITY.md).
111104

112105
Testing
113106
-------

SECURITY.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Security Policy
2+
3+
To report security issues send an email to `security AT bitcoindevkit DOT org` (not for support).
4+
5+
The following key may be used to communicate sensitive information to developers:
6+
7+
| Name | Fingerprint |
8+
| ---- | ----------- |
9+
| `security@bitcoindevkit.org` | `7416 BB25 5E60 E40D 482E 591B 7201 8930 A1FB 3444` |
10+
11+
You can import the key by running the following command:
12+
```
13+
gpg --recv-keys 7416BB255E60E40D482E591B72018930A1FB3444 --keyserver hkps://keys.openpgp.org
14+
```
15+
16+
You can also download it from [our website](https://bitcoindevkit.org/foundation/pgp/#security-disclosures).

0 commit comments

Comments
 (0)