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

SECURITY.md: insert an explicit URL #5502

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

SECURITY.md: insert an explicit URL #5502

wants to merge 1 commit into from

Conversation

ilyagr
Copy link
Contributor

@ilyagr ilyagr commented Jan 28, 2025

The previous "on this page" statement is wrong more often than not. Unfortunately there is no "Report a vulnerability" button on https://github.com/jj-vcs/jj/security/policy, and looking for such a button from https://github.com/jj-vcs/jj?tab=security-ov-file leads to confusion.

This is not the end of the world, but I don't see much security downside to clarifying it (that is, I don't think not having a link protects against phishing in any real way).

@ilyagr ilyagr force-pushed the ig/security-doc branch 3 times, most recently from e8baaa0 to 2c66e06 Compare January 28, 2025 08:02
@ilyagr ilyagr marked this pull request as ready for review January 28, 2025 08:03
SECURITY.md Outdated
Comment on lines 1 to 3
To report a security issue, please use the "Report a vulnerability" button on
this page. Our vulnerability management team will respond within 3 working days
of your report. If the issue is confirmed as a vulnerability, we will open a
Security Advisory. This project follows a 90 day disclosure timeline.
GitHub's Security tab for `jj`'s main repo, also accessible at
<https://github.com/jj-vcs/jj/security/advisories>. Our vulnerability management
Copy link
Member

Choose a reason for hiding this comment

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

What do you think about simplifying to "... button under Advisories."?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

How about this?

Because of my (armchair) concern about phishing, I also wanted to give people enough breadcrumbs to be able to find the right place without using the link, in case they feel (rightly or wrongly) worried about using the link.

Copy link
Member

Choose a reason for hiding this comment

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

I was thinking that the reader was accessed this doc via https://github.com/jj-vcs/jj/security/policy. I think you're saying that it may be useful to give the full instructions in case they find this doc in the source tree. Makes sense.

The previous "on this page" statement is wrong more often than not.
Unfortunately there is no "Report a vulnerability" button on
https://github.com/jj-vcs/jj/security/policy, and looking for such a
button from https://github.com/jj-vcs/jj?tab=security-ov-file leads to
confusion.

This is not the end of the world, but I don't see much security downside
to clarifying it (that is, I don't think *not* having a link protects
against phishing in any real way).
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.

2 participants