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 security policy #35

Merged
merged 2 commits into from
Jul 25, 2020

Conversation

tallclair
Copy link
Member

Now that github has official support for security policies, some users may expect to find disclosure protocols there. We should make sure every one of our repos links the security policy to https://kubernetes.io/docs/reference/issues-security/security/#report-a-vulnerability to avoid accidental disclosures.

I was originally thinking of merging SECRUITY_CONTACTS into SECURITY.md, but the future of SECURITY_CONTACTS is under active discussion. I'm also worried that people looking for who to contact might reach out to security contacts rather than following our disclosure process (part of the larger discussion).

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Jul 23, 2020
@k8s-ci-robot k8s-ci-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Jul 23, 2020
@k8s-ci-robot
Copy link
Contributor

@tallclair: The label(s) committee/project-security cannot be applied, because the repository doesn't have them

In response to this:

/committee project-security

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@tallclair
Copy link
Member Author

/committee product-security

@k8s-ci-robot k8s-ci-robot added the committee/security-response Denotes an issue or PR intended to be handled by the product security committee. label Jul 23, 2020
@joelsmith
Copy link
Contributor

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jul 25, 2020
Copy link
Member

@nikhita nikhita 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!

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: joelsmith, nikhita, tallclair

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jul 25, 2020
@nikhita
Copy link
Member

nikhita commented Jul 25, 2020

Bump -- GitHub's search API hasn't been consistent these days, which means prow doesn't pick up PRs with approved and lgtm labels correctly sometimes :/

@k8s-ci-robot k8s-ci-robot merged commit 09f43d4 into kubernetes:master Jul 25, 2020
@dims
Copy link
Member

dims commented Jul 26, 2020

@nuthinking @neovintage this is what i mentioned when we were talking last week. we see the glitches from GitHub's search API pretty regularly and our bots have trouble due to the changes in behavior :(

@tallclair
Copy link
Member Author

Is there any tooling to help update all our repos with the new file, or do I need to script it up myself?

@joelsmith
Copy link
Contributor

joelsmith commented Jul 27, 2020

I have a python bash script that checks out all the repos (if they haven't been checked out), fetches, rebases. Then I use traditional tools to edit the files. Then I use hub and sleep in a bash loop to open PRs. It's pretty ghetto, but works well enough for my purposes. I'm happy to do the mass addition for you if you like, or if you prefer, I can send you my script to use as a starting point.

@tallclair
Copy link
Member Author

Thanks Joel. If you have bandwidth to handle it, that would be great. Alternatively, we might want to wait and see where the SECRUITY_CONTACTS discussion leads, and batch those updates together (although that one might require more manual edits).

@joelsmith
Copy link
Contributor

Yep, I can handle it. Better that only one of has to fork every single k8s repo ;-)

@joelsmith
Copy link
Contributor

All PRs are now open and they all link back to the master issue: kubernetes/committee-security-response#105

Do we need to do the same thing for any other GitHub orgs, such as kubernetes-sigs?

@tallclair
Copy link
Member Author

Thanks! I think we should probably add it for kubernetes-sigs too, even if a lot of those projects aren't eligible for bug-bounty.

@joelsmith
Copy link
Contributor

joelsmith commented Jul 28, 2020

There are a lot of kubernetes-sigs repos. I wonder if instead of opening a PR against each with the added file, what if we create a kubernetes-sig/.github repo? Apparently, if you create a repo named .github in your org, you can put an org-wide default SECURITY.md (along with other similar policy docs). Then individual sigs can override it as needed, and we don't have to make sure that new repos there get the file added.

According to the docs:

You can create a default security policy for your organization or user account. For more information, see "Creating a default community health file."

The linked doc says:

You can add default community health files to the root of a public repository called .github that is owned by an organization or user account.
GitHub will use and display default files for any public repository owned by the account that does not have its own file of that type in any of the following places:

  • the root of the repository
  • the .github folder
  • the docs folder

@nikhita
Copy link
Member

nikhita commented Jul 29, 2020

I wonder if instead of opening a PR against each with the added file, what if we create a kubernetes-sig/.github repo? Apparently, if you create a repo named .github in your org, you can put an org-wide default SECURITY.md (along with other similar policy docs).

👍 💯

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. committee/security-response Denotes an issue or PR intended to be handled by the product security committee. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants