Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add SECURITY.md #581

Closed
wants to merge 1 commit into from
Closed

Add SECURITY.md #581

wants to merge 1 commit into from

Conversation

elsehow
Copy link

@elsehow elsehow commented Dec 15, 2021

Addresses #580. Add an explicit disclosure process (adapted from Tendermint's) to build common expectations about how critical security issues are disclosed to the community, on what timeline, and via what channels.

@CLAassistant
Copy link

CLAassistant commented Dec 15, 2021

CLA assistant check
All committers have signed the CLA.

Comment on lines +6 to +7
- Ethan Frey `ethanfrey#9693`
- elsehow `elsehow#3115`
Copy link
Contributor

@ueco-jb ueco-jb Dec 15, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Ethan Frey `ethanfrey#9693`
- elsehow `elsehow#3115`
- Ethan Frey `ethanfrey#9693`
- Simon Warta `Simon | Confio#9061`
- elsehow `elsehow#3115`

@webmaster128

I appriciate you making this PR, but shouldn't recommended people be at least from CosmWasm circle? From issue I assume you're collaborating with @JakeHartnell, I recognize him.
@ethanfrey what do you think?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, this repo is maintained by Confio, it should be us getting those mails.

Happy if you use this proposal on cw-nfts. And if we spin off maintainership of other repos, happy for them to use other contact methods.

Copy link
Author

@elsehow elsehow Dec 15, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Indeed, I would prefer to not be on this list, all else equal. I added my own name so Ethan wouldn't be the only person on the hook.

If we move forward with this, it would be great to put together a list of folks who should be notified!

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this repo is maintained by Confio, it should be us getting those mails

I think this is a crucial point/decision. As long as Confio is the maintainer, we should use [email protected] as the only security contact as shown in https://github.com/CosmWasm/wasmd/blob/master/SECURITY.md.

Copy link
Member

@ethanfrey ethanfrey left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for the contribution and giving a nudge to better SECURITY files. This is a good initiative we have discussed internally but not seen any external interest in.

We have an official security.md for wasmd https://github.com/CosmWasm/wasmd/blob/master/SECURITY.md
and are discussing GPG keys for secure contacts.

Also trying to organize bug bounties to encourage responsible disclosure (but hacker one wouldn't accept CosmWasm...).

Not going to merge as is, but great initiative and inspiration. Especially the sections on Disclosure Policy and Process.


Please avoid opening public issues on GitHub that contain information about a potential security vulnerability as this makes it difficult to reduce the impact and harm of valid security issues.

### Coordinated Vulnerability Disclosure Policy
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is a nice proposal for disclosure policies.

- Avoid exploiting any vulnerabilities that you discover.
- Demonstrate good faith by not disrupting or degrading services built on top of cw-plus.

### Vulnerability Disclosure Process
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The process sounds reasonable, but I would like to discuss it with the rest of the Confio team first

@@ -0,0 +1,31 @@
# Critical bugs and security issues 💥

If you're here because you're trying to figure out how to notify us of a security issue, go to [Discord](https://discord.gg/VNyAnw7e), and alert:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have an official security.md for wasmd https://github.com/CosmWasm/wasmd/blob/master/SECURITY.md

It would be good to keep this in line with the other one. It currently has one official email, and we are working on securely distributing a GPG key to a few different team members so we can accept encypted messages as well.

I would not recommend reporting bugs on discord.

Comment on lines +6 to +7
- Ethan Frey `ethanfrey#9693`
- elsehow `elsehow#3115`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, this repo is maintained by Confio, it should be us getting those mails.

Happy if you use this proposal on cw-nfts. And if we spin off maintainership of other repos, happy for them to use other contact methods.

@elsehow
Copy link
Author

elsehow commented Dec 15, 2021

@ethanfrey Sounds great, thanks for having a look at it. Feel free to ping me as you discuss with Confio.

@ethanfrey
Copy link
Member

@webmaster128 @alpe I would love your feedback here.

In my mind, we take the parts we like here and add them to the wasmd SECURITY.md file. As well as adding the GPG key for the email.

Once that is finalised, we can then copy SECURITY.md to all the major repos (cosmwasm, cw-plus, wasmvm, etc)

There are some nice additions related to process here which I would be happy to see in the wasmd version as well

@alpe
Copy link
Contributor

alpe commented Jan 4, 2022

@webmaster128 @alpe I would love your feedback here.

In my mind, we take the parts we like here and add them to the wasmd SECURITY.md file. As well as adding the GPG key for the email.

Once that is finalised, we can then copy SECURITY.md to all the major repos (cosmwasm, cw-plus, wasmvm, etc)

There are some nice additions related to process here which I would be happy to see in the wasmd version as well

This PR contains a very good disclosure policy which we can adopt as well as a template for a process to discuss internally.
We should add legal information like "Not pursue or support any legal action related to your research" to the policy.

Wasmd contains only a very basic description, yet. It was supposed to get started with a process but there is more we can do before v1. I found https://snyk.io/blog/add-a-security-md-file-to-your-azure-repos/ a good overview in the past what else could be provided.

It makes sense for me to maintain a central SECURITY.md file with up to date information in one repo and provide only basic ones in all other project's repos that point to it.

ethanfrey added a commit to CosmWasm/wasmd that referenced this pull request Jan 5, 2022
@ethanfrey
Copy link
Member

That you for bringing this up.
Replacing with CosmWasm/wasmd#716 where we can continue conversation and where we can merge

ethanfrey added a commit to CosmWasm/wasmd that referenced this pull request Mar 2, 2022
@ethanfrey
Copy link
Member

Closed in favor of #624 now we added this to wasmd. Thanks for the inspiration

@ethanfrey ethanfrey closed this Mar 24, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants