Skip to content

Add SECURITY.md - #2243

Open
jonatack wants to merge 1 commit into
bitcoin:masterfrom
jonatack:2026-08-add-security_md-document
Open

Add SECURITY.md#2243
jonatack wants to merge 1 commit into
bitcoin:masterfrom
jonatack:2026-08-add-security_md-document

Conversation

@jonatack

@jonatack jonatack commented Aug 8, 2026

Copy link
Copy Markdown
Member

This information is already in BIPs 2 and 3, but ISTM that an explicit SECURITY file would conform to current best practice.

I did not include a section about gpg keys to communicate sensitive information; if wanted, it could be added here or later.

@murchandamus

murchandamus commented Aug 8, 2026

Copy link
Copy Markdown
Member

I’m not sure I understand the motivation here. Since we don’t ship a software project, what responsible disclosures could we possibly get?

@jonatack

jonatack commented Aug 8, 2026

Copy link
Copy Markdown
Member Author

No strong opinion but idea is, what if an issue is found in a specification (or its example implementation) here that could lead to a potential vulnerability/exploit in an implementation.

@ajtowns

ajtowns commented Aug 9, 2026

Copy link
Copy Markdown
Contributor

I would think that for a deployed standard, contacting the implementations directly initially would be wise, then adding a "this spec should not be implemented" warning until full disclosure is reasonable. I don't think adding the BIP editors as middlemen for contacting implementations is likely to help anyone out -- half the time it seems like BIP editors have a hard enough job getting into contact with BIP authors as it is even when there's not some looming disaster...

@jonatack

jonatack commented Aug 9, 2026

Copy link
Copy Markdown
Member Author

for a deployed standard, contacting the implementations directly initially would be wise

Yes. It might be worthwhile to state this here.

then adding a "this spec should not be implemented" warning until full disclosure is reasonable

The red team or the implementation would need to contact us privately, so having the contact emails easily findable like here seems useful.

@jonatack jonatack added the Process Trying to update process or stuck due to disagreement about Process label Aug 9, 2026
@ajtowns

ajtowns commented Aug 9, 2026

Copy link
Copy Markdown
Contributor

then adding a "this spec should not be implemented" warning until full disclosure is reasonable

The red team or the implementation would need to contact us privately, so having the contact emails easily findable like here seems useful.

If your goal is to publicly update a spec to recommend everyone stop using it, then I don't think there's anything that needs to be done in private. Probably having one of the (co-)authors open a PR with the extra text and merging it as soon as it's verified it's not an impersonator is the ideal outcome. If the authors aren't in the loop, I think marking a BIP as having security issues wouldn't actually comply with BIP 3 processes anyway?

@edilmedeiros

Copy link
Copy Markdown

I believe IETF has a reasonable advisor and process.

tldr:

While the preferred approach to reporting IETF protocol vulnerabilities is to contact the person or group responsible for the document, as a last resort, reports can always be sent by email to protocol-vulnerability@ietf.org. The IETF Security Area Directors will make their best effort to triage the report.

I believe having a single email for security reports is considered a best practice instead of many individual emails. Never understood it completely because that single email distributor can be compromised.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Process Trying to update process or stuck due to disagreement about Process

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants