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 (7.8.x) #3128

Merged
merged 4 commits into from
Apr 26, 2019
Merged

Conversation

hjoliver
Copy link
Member

Close cylc/cylc-admin#11

Based on https://github.com/standard/standard/blob/master/SECURITY.md

For 7.8.x adds a note on the recent Jinja2 CVE and why it is not an issue for Cylc.
@kinow - do you think this is the appropriate place for such "alerts"?

@hjoliver hjoliver added this to the next-release milestone Apr 26, 2019
@hjoliver hjoliver requested a review from kinow April 26, 2019 05:28
@hjoliver hjoliver self-assigned this Apr 26, 2019
@kinow
Copy link
Member

kinow commented Apr 26, 2019

@kinow - do you think this is the appropriate place for such "alerts"?

Either here or in the Changelog. Perhaps Changelog would be better... otherwise if I wanted to install version 8.?.?, I would have to read the change log and the security.md... but if we mention the security issues there, then users/site admins can have a single point of truth? WDYT?

And about the text.... how I wish I could write like this - even in Portuguese. +1 to all, with one minor comment only. I think most Open Source projects have at least one private channel for security bugs. If one user in - say - New Zealand finds a security bug that could be used to compromise environments in other sites, then I think disclosing it publicly in a mailing list or issue tracker wouldn't be good to the other sites.

Though there is also less transparency this way, and some projects (Kernel I believe) treat security bugs more like normal bugs, unless it is one of those global bugs. I think it is possible to find bugs in the Kernel that reporters detail could be a security issue (but in the Kernel, possibly most memory bugs could be security bugs I think...).

But I think site admins might have a better opinion on how they would like to see security issues being disclosed in the project. I am happy to have a way to tell users what to do in such case 😁

@hjoliver
Copy link
Member Author

@kinow - good points; I'll give email addresses for disclosure, and move the Jinja2 note to the change log.

@hjoliver
Copy link
Member Author

Tweaked as discussed above. SECURITY.md now identical on both branches; Jinja2 CVE note now at top of 7.8.x change log.

@hjoliver hjoliver added the security security-related issues label Apr 26, 2019
@hjoliver
Copy link
Member Author

@MartinRyan - you probably need to be aware of this one (particularly the comment on the Jinja2 CVE) in case your security colleagues ask ...

Copy link
Member

@kinow kinow left a comment

Choose a reason for hiding this comment

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

Looks good to me. One minor comment but not a blocker IMO. 👏

CHANGES.md Outdated Show resolved Hide resolved
@matthewrmshin matthewrmshin merged commit bf7bd1b into cylc:7.8.x Apr 26, 2019
@hjoliver hjoliver deleted the add-security-md-78x branch April 30, 2019 21:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
security security-related issues
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants