Skip to content

docs: add SECURITY policy #891

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

Merged
merged 1 commit into from
Apr 7, 2022
Merged

docs: add SECURITY policy #891

merged 1 commit into from
Apr 7, 2022

Conversation

jsjoeio
Copy link
Contributor

@jsjoeio jsjoeio commented Apr 6, 2022

This PR adds a basic SECURITY policy for coder.

Note: I decided to not add Dependabot since I believe we're going to explore Socket. I'm meeting with the team next week and I will come back with more information. For the first public release, I believe this should be sufficient.

Fixes #656

@jsjoeio jsjoeio added the docs Area: coder.com/docs label Apr 6, 2022
@jsjoeio jsjoeio self-assigned this Apr 6, 2022
@codecov
Copy link

codecov bot commented Apr 6, 2022

Codecov Report

Merging #891 (537afc2) into main (770d212) will decrease coverage by 0.03%.
The diff coverage is n/a.

❗ Current head 537afc2 differs from pull request most recent head a8c6093. Consider uploading reports for the commit a8c6093 to get more accurate results

@@            Coverage Diff             @@
##             main     #891      +/-   ##
==========================================
- Coverage   65.60%   65.56%   -0.04%     
==========================================
  Files         213      216       +3     
  Lines       13650    13734      +84     
  Branches      103      103              
==========================================
+ Hits         8955     9005      +50     
- Misses       3782     3802      +20     
- Partials      913      927      +14     
Flag Coverage Δ
unittest-go- 65.29% <ø> (?)
unittest-go-macos-latest 52.89% <ø> (-0.03%) ⬇️
unittest-go-postgres- ?
unittest-go-ubuntu-latest 55.25% <ø> (-0.11%) ⬇️
unittest-go-windows-2022 52.13% <ø> (?)
unittest-js 58.87% <ø> (ø)
Impacted Files Coverage Δ
provisionersdk/serve.go 35.13% <0.00%> (-8.11%) ⬇️
provisionersdk/transport.go 78.72% <0.00%> (-6.39%) ⬇️
cli/cliui/agent.go 77.19% <0.00%> (-5.27%) ⬇️
codersdk/client.go 54.54% <0.00%> (-5.20%) ⬇️
codersdk/workspaces.go 59.09% <0.00%> (-4.55%) ⬇️
coderd/workspaces.go 53.66% <0.00%> (-2.53%) ⬇️
provisioner/echo/serve.go 54.40% <0.00%> (-2.40%) ⬇️
peer/conn.go 79.18% <0.00%> (-2.29%) ⬇️
peerbroker/proxy.go 57.55% <0.00%> (-0.59%) ⬇️
coderd/provisionerdaemons.go 58.51% <0.00%> (-0.51%) ⬇️
... and 12 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 770d212...a8c6093. Read the comment docs.

@jsjoeio jsjoeio force-pushed the jsjoeio/add-security branch 2 times, most recently from c9480d3 to c9b2156 Compare April 6, 2022 17:56
@jsjoeio jsjoeio requested review from a team April 6, 2022 17:57
Copy link
Member

@kylecarbs kylecarbs left a comment

Choose a reason for hiding this comment

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

I'm hesitant to promote adding this until we can give any true assurances to customers, or we should state that here. Maybe @ketang has some ideas.

@jsjoeio
Copy link
Contributor Author

jsjoeio commented Apr 6, 2022

I'm hesitant to promote adding this until we can give any true assurances to customers, or we should state that here. Maybe @ketang has some ideas.

@kylecarbs more than happy to change the wording - feel free to make a suggestion! Having this though ensures customers know how they can get in touch so the bare minimum should at least include the Report a Vulnerability part.

@kylecarbs
Copy link
Member

Fair enough. I agree something is much better than nothing. I shall review!

@jsjoeio jsjoeio force-pushed the jsjoeio/add-security branch from c9b2156 to 537afc2 Compare April 6, 2022 22:19
@jsjoeio jsjoeio marked this pull request as ready for review April 6, 2022 22:19
Copy link
Member

@kylecarbs kylecarbs left a comment

Choose a reason for hiding this comment

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

Just a minor nit!

docs/SECURITY.md Outdated
@@ -0,0 +1,8 @@
# Security Policy

The Coder team wants to keep the coder project secure and safe for end-users.
Copy link
Member

Choose a reason for hiding this comment

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

I'd rephrase this to something like:

"Keeping your code secure is core to what we do. If you find a vulnerability, please send an email to security@coder.com, and our team will respond to you."

It combines both paragraphs, which I think is fine.

Copy link
Member

Choose a reason for hiding this comment

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

Feels funny to have this in its own doc and not just in the readme as a section

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 GitHub does something special with this doc if it's in the location.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'll rephrase that then merge!

Feels funny to have this in its own doc and not just in the readme as a section

I think that's just how they find them more easily. Docs

@jsjoeio jsjoeio force-pushed the jsjoeio/add-security branch from 537afc2 to a8c6093 Compare April 7, 2022 15:16
@jsjoeio jsjoeio enabled auto-merge (squash) April 7, 2022 15:17
@jsjoeio jsjoeio merged commit 14dec17 into main Apr 7, 2022
@jsjoeio jsjoeio deleted the jsjoeio/add-security branch April 7, 2022 15:26
@misskniss misskniss added this to the V2 Beta milestone May 15, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Area: coder.com/docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Set up the security policy
6 participants