Skip to content

Commit 8201906

Browse files
committed
Adding security standards markdown and referencing both security and contributing guidelines from the root README.
1 parent 18ae2a2 commit 8201906

File tree

2 files changed

+57
-0
lines changed

2 files changed

+57
-0
lines changed

README.md

+14
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,8 @@ A library containing Swift types that encode to- and decode from [OpenAPI](https
2727
- [Generating OpenAPI Documents](#generating-openapi-documents)
2828
- [Semantic Diffing of OpenAPI Documents](#semantic-diffing-of-openapi-documents)
2929
- [Notes](#notes)
30+
- [Contributing](#contributing)
31+
- [Security](#security)
3032
- [Specification Coverage & Type Reference](#specification-coverage--type-reference)
3133

3234
## Usage
@@ -255,5 +257,17 @@ This library *is* opinionated about a few defaults when you use the Swift types,
255257

256258
See [**A note on dictionary ordering**](#a-note-on-dictionary-ordering) before deciding on an encoder/decoder to use with this library.
257259

260+
## Contributing
261+
Contributions to OpenAPIKit are welcome and appreciated! The project is mostly maintained by one person which means additional contributors have a huge impact on how much gets done how quickly.
262+
263+
Please see the [Contribution Guidelines](./CONTRIBUTING.md) for a few brief notes on contributing the the project.
264+
265+
## Security
266+
The OpenAPIKit project takes code security seriously. As part of the Swift Server Workground incubation program, this project follows a shared set of standards around receiving, reporting, and reacting to security vulnerabilies.
267+
268+
Please see [Security](./SECURITY.md) for information on how to report vulnerabilities to the OpenAPIKit project and what to expect after you do.
269+
270+
**Please do not report security vulnerabilities via GitHub issues.**
271+
258272
## Specification Coverage & Type Reference
259273
For a full list of OpenAPI Specification types annotated with whether OpenAPIKit supports them and relevant translations to OpenAPIKit types, see the [Specification Coverage](./documentation/specification_coverage.md) documentation. For detailed information on the OpenAPIKit types, see the [full type documentation](https://github.com/mattpolzin/OpenAPIKit/wiki).

SECURITY.md

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Security
2+
3+
This document specifies the security process for the OpenAPIKit project.
4+
5+
## Disclosures
6+
7+
### Private Disclosure Process
8+
9+
The OpenAPIKit maintainers ask that known and suspected vulnerabilities be
10+
privately and responsibly disclosed by emailing
11+
12+
with the all the required detail.
13+
**Do not file a public issue.**
14+
15+
#### When to report a vulnerability
16+
17+
* You think you have discovered a potential security vulnerability in OpenAPIKit.
18+
* You are unsure how a vulnerability affects OpenAPIKit.
19+
20+
#### What happens next?
21+
22+
* A member of the team will acknowledge receipt of the report within 3
23+
working days (United States). This may include a request for additional
24+
information about reproducing the vulnerability.
25+
* We will privately inform the Swift Server Work Group ([SSWG][sswg]) of the
26+
vulnerability within 10 days of the report as per their [security
27+
guidelines][sswg-security].
28+
* Once we have identified a fix we may ask you to validate it. We aim to do this
29+
within 30 days. In some cases this may not be possible, for example when the
30+
vulnerability exists at the protocol level and the industry must coordinate on
31+
the disclosure process.
32+
* If a CVE number is required, one will be requested from [MITRE][mitre]
33+
providing you with full credit for the discovery.
34+
* We will decide on a planned release date and let you know when it is.
35+
* Prior to release, we will inform major dependents that a security-related
36+
patch is impending.
37+
* Once the fix has been released we will publish a security advisory on GitHub
38+
and in the Server → Security Updates category on the [Swift forums][swift-forums-sec].
39+
40+
[sswg]: https://github.com/swift-server/sswg
41+
[sswg-security]: https://github.com/swift-server/sswg/blob/main/security/README.md
42+
[swift-forums-sec]: https://forums.swift.org/c/server/security-updates/
43+
[mitre]: https://cveform.mitre.org/

0 commit comments

Comments
 (0)