Skip to content

Commit 99005b0

Browse files
committed
Adding security-insights.yml starter template
This template gives new OSSF projects a headstart in defining a valid and valuable https://openssf.org/projects/security-insights-spec/ This closes ossf/security-baseline#20 Signed-off-by: Travis Truman <[email protected]>
1 parent d1fb6d3 commit 99005b0

File tree

1 file changed

+60
-0
lines changed

1 file changed

+60
-0
lines changed

security-insights.yml

+60
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# https://openssf.org/projects/security-insights-spec/
2+
#
3+
# This specification provides a mechanism for projects to report information about
4+
# their security in a machine-processable way. It is formatted as a YAML file to
5+
# make it easy to read and edit by humans.
6+
7+
# The data tracked within this specification is intended to fill the gaps between
8+
# simplified solutions such as SECURITY.md and comprehensive automatable solutions
9+
# such as SBOMs. In that gap lay elements that must be self-reported by projects
10+
# to allow end-users to make informed security decisions.
11+
12+
# See https://github.com/ossf/security-insights-spec/blob/v2.0.0/specification/header.md
13+
header:
14+
schema-version: 2.0.0
15+
last-updated: '2021-09-01' #TODO: update with last updated
16+
last-reviewed: '2022-09-01' #TODO: update with last reviewed
17+
url: https://foo.bar/foo/bar #TODO: update with your project URL
18+
comment: |
19+
This file contains the minimum information for both project and repository.
20+
It not required to include both a project and repository section if the project
21+
section is intended to be inherited by repositories via header.project-si-source
22+
23+
# See https://github.com/ossf/security-insights-spec/blob/v2.0.0/specification/project.md
24+
project:
25+
name: FooBar #TODO: update with your project name
26+
administrators: #TODO: update with your project administrators
27+
- name: Joe Dohn
28+
affiliation: Foo
29+
30+
social: https://bsky.com/joebob
31+
primary: true
32+
repositories: #TODO: update with your project repositories
33+
- name: Foo
34+
url: https://my.vcs/foobar/foo
35+
comment: |
36+
Foo is the core repo for FooBar.
37+
vulnerability-reporting: #TODO: update with your project vulnerability reporting details
38+
reports-accepted: true
39+
bug-bounty-available: true
40+
41+
# See https://github.com/ossf/security-insights-spec/blob/v2.0.0/specification/repository.md
42+
repository: #TODO: update with your repository details
43+
url: https://my.vcs/foobar/foo
44+
status: active
45+
accepts-change-request: true
46+
accepts-automated-change-request: true
47+
core-team:
48+
- name: Alice White
49+
affiliation: Foo Bar
50+
51+
social: https://bsky.com/alicewhite
52+
primary: true
53+
license:
54+
url: https://foo.bar/LICENSE
55+
expression: Apache-2.0
56+
security:
57+
assessments:
58+
self:
59+
comment: |
60+
Self assessment has not yet been completed.

0 commit comments

Comments
 (0)