20 |
404
21 |
22 |
Page not found :(
23 |
The requested page could not be found.
24 |
3 | 
9 |
10 | # Project
11 |
12 | _SecurityTemplate_ is a static website template for security pages, powered by Jekyll. It's easy to get started. Clone this repo, edit the configuration files and content to your liking, and publish with [GitHub Pages](https://pages.github.com) or on your own server platform.
13 |
14 | You can [set up a local environment](https://help.github.com/articles/setting-up-your-github-pages-site-locally-with-jekyll/) to test your _SecurityTemplate_ static site, and [push to GitHub](https://help.github.com/articles/using-jekyll-as-a-static-site-generator-with-github-pages/) if desired.
15 |
16 | This project is a rapidly evolving work in progress. We value [contributions](https://github.com/EdOverflow/security-template/blob/master/CONTRIBUTING.md) from the public.
17 |
18 | # Structure
19 |
20 | The template directory structure is as follows:
21 |
22 | ```
23 | .
24 | ├── 404.html # 404 page.
25 | ├── advisories.md # Security advisories list.
26 | ├── assets # Page assets.
27 | │ ├── css
28 | │ │ └── styles.css
29 | │ └── images
30 | │ └── icon.png
31 | ├── _config.yml # Config file with all your variables.
32 | ├── _drafts
33 | ├── Gemfile
34 | ├── Gemfile.lock
35 | ├── hof.md # Hall of fame page.
36 | ├── _includes
37 | │ └── advisory-list.html
38 | ├── index.md # Security policy.
39 | ├── _layouts
40 | │ ├── default.html
41 | │ └── post.html
42 | ├── LICENSE
43 | ├── _posts
44 | │ └── 2017-07-22-cve-2017-0914.md # Example security advisory.
45 | ├── README.md
46 | └── report.md
47 | ```
48 |
49 | 
50 |
51 |
52 | ## `config.yml`
53 |
54 | * `company_name` — replace this with your organization name
55 | * `email` — replace this with your security contact address
56 | * `bugcrowd_id` — replace this with your [Bugcrowd ID](https://docs.bugcrowd.com/v1.0/docs/embedded-submission-form), if applicable
57 | * `hackerone_url` and `bugcrowd_url` — the /report URL will redirect to one of these, if specified.
58 |
59 | ## `index.md`
60 |
61 | The index file is where your security policy lives. To learn more about writing good security policies, please refer to https://support.hackerone.com/hc/en-us/articles/205624665-How-do-we-write-a-good-policy-.
62 |
63 | ## `advisories.md`
64 |
65 | This is where you can list your security advisories. The list is updated every time you add a security advisory to the `_posts` folder.
66 |
67 | ## `report.md`
68 |
69 | This file should contain contact information for security researchers to use when reporting a security vulnerability. If a HackerOne or Bugcrowd URL is specified in `config.yml`, users will be redirected automatically. You can also use an embedded Bugcrowd submission form. Just uncomment the form, and add your Bugcrowd embed token under `bugcrowd_id` in `_config.yml`.
70 |
71 | ## `hof.md`
72 |
73 | This is your security acknowledgements page. List the details of security researchers that reported valid security issues (and wish to be listed publicly).
74 |
75 | ## `.well-known/security.txt`
76 |
77 | `security-template` contains a security.txt template file. _security.txt_ defines a standard to help organizations define the process for security researchers to safely disclose vulnerabilities via a simple text file. For more on this, please refer to https://securitytxt.org/.
78 |
79 | # Contributing
80 |
81 | We welcome contributions from the public.
82 |
83 | ### Using the issue tracker 💡
84 |
85 | The issue tracker is the preferred channel for bug reports and features requests.
86 |
87 | ### Issues and labels 🏷
88 |
89 | The bug tracker utilizes several labels to help organize and identify issues.
90 |
91 | ### Guidelines for bug reports 🐛
92 |
93 | Use the GitHub issue search — check if the issue has already been reported.
94 |
--------------------------------------------------------------------------------
/_layouts/default.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |