Skip to content

Commit e8ed8cc

Browse files
authored
adopt SSWG security guidelines (#31)
1 parent 54320b7 commit e8ed8cc

File tree

2 files changed

+50
-2
lines changed

2 files changed

+50
-2
lines changed

README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ a metrics backend for [swift-metrics](https://github.com/apple/swift-metrics) th
99
* [graphite](https://graphiteapp.org)
1010
* many others
1111

12-
## getting started
12+
## Getting started
1313

1414
create an instance of the `StatsdClient` and boostrap the `MertricsSystem` in your application's main:
1515

@@ -27,7 +27,7 @@ statsdClient.shutdown()
2727
```
2828

2929

30-
## architecture
30+
## Architecture
3131

3232
the statsd client uses [swift-nio](https://github.com/apple/swift-nio) to establish a UDP connection to the statsd server
3333

@@ -36,3 +36,8 @@ metrics types are mapped as follwoing:
3636
* Gauge -> Gauge
3737
* Recorder -> Histogram
3838
* Timer -> Timer
39+
40+
41+
## Security
42+
43+
Please see [SECURITY.md](SECURITY.md) for details on the security process.

SECURITY.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Security
2+
3+
This document specifies the security process for the Swift Service Lifecycle project.
4+
5+
## Disclosures
6+
7+
### Private Disclosure Process
8+
9+
The Swift Service Lifecycle 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 Swift Service Lifecycle.
18+
* You are unsure how a vulnerability affects Swift Service Lifecycle.
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)