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.txt #2026

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions .well-known/security.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Our security address

This comment was marked as abuse.

This comment was marked as abuse.

Contact: mailto:[email protected]

# Our PGP key
Encryption: https://example.com/pgp-key.txt

# Our security policy
Policy: https://example.com/security-policy.html

12 changes: 12 additions & 0 deletions dist/doc/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,8 @@ A basic HTML5 Boilerplate site initially looks something like this:
│ └── vendor
│ ├── jquery.min.js
│ └── modernizr.min.js
├── .well-known
│ └── security.txt
├── .editorconfig
├── .htaccess
├── 404.html
Expand Down Expand Up @@ -121,6 +123,16 @@ technology powering it.

Edit this file to include any pages you need hidden from search engines.

### .well-known

RFC5785 [https://tools.ietf.org/html/rfc5785](https://tools.ietf.org/html/rfc5785) defines '.well-known' as a unique location for content discovery. It contains one file - security.txt.

### security.txt

When security risks in web services are discovered by independent security researchers who understand the severity of the risk, they often lack the channels to disclose them properly. As a result, security issues may be left unreported. Security.txt defines a standard to help organizations define the process for security researchers to disclose security vulnerabilities securely.

This comment was marked as abuse.


This template file should be updated per-site.

### Icons

Replace the default `favicon.ico`, `tile.png`, `tile-wide.png` and Apple
Expand Down
12 changes: 12 additions & 0 deletions src/doc/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,8 @@ A basic HTML5 Boilerplate site initially looks something like this:
│ └── vendor
│ ├── jquery.min.js
│ └── modernizr.min.js
├── .well-known
│ └── security.txt
├── .editorconfig
├── .htaccess
├── 404.html
Expand Down Expand Up @@ -121,6 +123,16 @@ technology powering it.

Edit this file to include any pages you need hidden from search engines.

### .well-known

RFC5785 [https://tools.ietf.org/html/rfc5785](https://tools.ietf.org/html/rfc5785) defines '.well-known' as a unique location for content discovery. It contains one file - security.txt.

### security.txt

When security risks in web services are discovered by independent security researchers who understand the severity of the risk, they often lack the channels to disclose them properly. As a result, security issues may be left unreported. Security.txt defines a standard to help organizations define the process for security researchers to disclose security vulnerabilities securely.

This template file should be updated per-site.

### Icons

Replace the default `favicon.ico`, `tile.png`, `tile-wide.png` and Apple
Expand Down