Skip to content

Commit 8eabe40

Browse files
authored
Create security.md (#521)
1 parent 81e38bf commit 8eabe40

File tree

4 files changed

+94
-15
lines changed

4 files changed

+94
-15
lines changed

.github/workflows/pr.yml

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,26 +15,29 @@ jobs:
1515
checks:
1616
runs-on: ${{ github.repository_owner == 'oneapi-src' && 'intel-ubuntu-latest' || 'ubuntu-latest' }}
1717
steps:
18-
- uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11
19-
- uses: actions/setup-python@0a5c61591373683505ea898e09a3ea4f39ef2b9c
18+
- uses: actions/checkout@v4.1.2
19+
- uses: actions/setup-python@v5.1.0
2020
with:
2121
python-version: '3.10'
2222
cache: 'pip'
2323
- name: Checks
24-
uses: pre-commit/action@646c83fcd040023954eafda54b4db0192ce70507
24+
uses: pre-commit/action@v3.0.1
2525

2626
build:
27+
permissions:
28+
# needed for upload-artifact
29+
actions: write
2730
runs-on: ${{ github.repository_owner == 'oneapi-src' && 'intel-ubuntu-latest' || 'ubuntu-latest' }}
2831
steps:
29-
- uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11
32+
- uses: actions/checkout@v4.1.2
3033
- name: Install ubuntu prerequisites
3134
run: |
3235
sudo apt update -qq
3336
xargs -a ubuntu-packages.txt sudo apt install -qq
3437
curl -s https://www.doxygen.nl/files/doxygen-1.9.6.linux.bin.tar.gz -o /tmp/dox.tgz
3538
sudo tar zxf /tmp/dox.tgz -C /usr/local
3639
sudo ln -s /usr/local/doxygen*/bin/* /usr/bin
37-
- uses: actions/setup-python@0a5c61591373683505ea898e09a3ea4f39ef2b9c
40+
- uses: actions/setup-python@v5.1.0
3841
with:
3942
python-version: '3.10'
4043
cache: 'pip'
@@ -57,23 +60,25 @@ jobs:
5760
cp -r build/html/* site/spec
5861
cp build/latex/*.pdf site/spec
5962
- name: Archive site
60-
uses: actions/upload-artifact@26f96dfa697d77e81fd5907df203aa23a56210a8
63+
uses: actions/upload-artifact@v4.3.1
6164
with:
6265
name: site
6366
path: site
6467

6568
publish_site:
69+
permissions:
70+
contents: write
6671
needs: [checks, build]
6772
if: ${{ github.ref == 'refs/heads/main' }}
6873
runs-on: ${{ github.repository_owner == 'oneapi-src' && 'intel-ubuntu-latest' || 'ubuntu-latest' }}
6974
steps:
7075
- name: Checkout gh-pages
71-
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11
76+
uses: actions/checkout@v4.1.2
7277
with:
7378
ref: gh-pages
7479
path: gh-pages
7580
- name: Retrieve site
76-
uses: actions/download-artifact@6b208ae046db98c579e8a3aa621ab581ff575935
81+
uses: actions/download-artifact@v4.1.4
7782
with:
7883
name: site
7984
path: gh-pages

.pre-commit-config.yaml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ exclude: LICENSES|source/elements
99

1010
repos:
1111
- repo: https://github.com/ambv/black
12-
rev: 23.3.0
12+
rev: 24.3.0
1313
hooks:
1414
- id: black
1515
- repo: https://github.com/pre-commit/pre-commit-hooks
16-
rev: v4.4.0
16+
rev: v4.6.0
1717
hooks:
1818
- id: trailing-whitespace
1919
- id: end-of-file-fixer
@@ -24,14 +24,14 @@ repos:
2424
hooks:
2525
- id: doc8
2626
- repo: https://github.com/fsfe/reuse-tool
27-
rev: v2.0.0
27+
rev: v3.0.2
2828
hooks:
2929
- id: reuse
3030
- repo: https://github.com/pycqa/flake8
31-
rev: 6.0.0
31+
rev: 7.0.0
3232
hooks:
3333
- id: flake8
3434
- repo: https://github.com/pycqa/isort
35-
rev: 5.12.0
35+
rev: 5.13.2
3636
hooks:
3737
- id: isort

README.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -126,11 +126,11 @@ Use the reuse_ tool
126126

127127
Code examples::
128128

129-
reuse addheader --copyright "Intel Corporation" --year 2020 --license MIT source/examples/host-task.cpp
129+
reuse addheader --copyright "Constributors to the oneapi-spec project" --license MIT source/examples/host-task.cpp
130130

131131
Doc sources::
132132

133-
reuse addheader --copyright "Intel Corporation" --year 2020 --license CC-BY-4.0 source/index.rst
133+
reuse addheader --copyright "Constributors to the oneapi-spec project" --license CC-BY-4.0 source/index.rst
134134

135135

136136
----------------

security.md

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
<!--
2+
SPDX-FileCopyrightText: 2024 Constributors to the oneapi-spec project
3+
4+
SPDX-License-Identifier: CC-BY-4.0
5+
-->
6+
7+
# Security Policy
8+
As an open-source project, we understand the importance of and responsibility
9+
for security. This Security policy outlines our guidelines and procedures for
10+
ensuring the highest level of Security and trust for our users.
11+
12+
## Supported Versions
13+
We regularly perform patch releases for the supported
14+
[latest version][1],
15+
which contain fixes for security vulnerabilities and important bugs. Prior
16+
releases might receive critical security fixes on a best-effort basis; however,
17+
we cannot guarantee that security fixes will get back-ported to these
18+
unsupported versions.
19+
20+
## Report a Vulnerability
21+
We are very grateful to the security researchers and users that report back
22+
security vulnerabilities. We investigate every report thoroughly.
23+
We strongly encourage you to report security vulnerabilities to us privately,
24+
before disclosing them on public forums or opening a public GitHub issue.
25+
Report a vulnerability to us in one of two ways:
26+
* Open a draft [**GitHub Security Advisory**][2]
27+
* Send e-mail to the following address: **[email protected]**.
28+
Along with the report, please include the following info:
29+
* A descriptive title.
30+
* Your name and affiliation (if any).
31+
* A description of the technical details of the vulnerabilities.
32+
* A minimal example of the vulnerability so we can reproduce your findings.
33+
* An explanation of who can exploit this vulnerability, and what they gain
34+
when doing so.
35+
* Whether this vulnerability is public or known to third parties. If it is,
36+
please provide details.
37+
38+
### When Should I Report a Vulnerability?
39+
* You think you discovered a potential security vulnerability in oneDNN.
40+
* You are unsure how the potential vulnerability affects oneDNN.
41+
* You think you discovered a vulnerability in another project or 3rd party
42+
component on which oneDNN depends. If the issue is not fixed in the 3rd party
43+
component, try to report directly there first.
44+
45+
### When Should I NOT Report a Vulnerability?
46+
* You got an automated scan hit and are unable to provide details.
47+
* You need help using oneDNN for security.
48+
* You need help applying security-related updates.
49+
* Your issue is not security-related.
50+
51+
## Security Reports Review Process
52+
Our goal is to respond quickly to your inquiry, and to coordinate a fix and
53+
disclosure with you. All confirmed security vulnerabilities will be addressed
54+
according to severity level and impact on oneDNN. Normally, security issues
55+
are fixed in the next planned release.
56+
57+
## Disclosure Policy
58+
We will publish security advisories using the
59+
[**GitHub Security Advisories feature**][3]
60+
to keep our community well-informed, and will credit you for your findings
61+
unless you prefer to stay anonymous. We request that you refrain from
62+
exploiting the vulnerability or making it public before the official disclosure.
63+
64+
We will disclose the vulnerabilities and/or bugs as soon as possible once
65+
mitigation is implemented and available.
66+
67+
## Feedback on This Policy
68+
If you have any suggestions on how this Policy could be improved, please submit
69+
an issue or a pull request to this repository. Please **do not** report
70+
potential vulnerabilities or security flaws via a pull request.
71+
72+
[1]: https://github.com/oneapi-src/oneapi-spec/releases/latest
73+
[2]: https://github.com/oneapi-src/oneapi-spec/security/advisories/new
74+
[3]: https://github.com/oneapi-src/oneapi-spec/security/advisories

0 commit comments

Comments
 (0)