Skip to content

Commit 54cca6a

Browse files
authored
[docsy] Recover missing security pages and create Security section (#96)
1 parent b11cefd commit 54cca6a

File tree

9 files changed

+45
-13
lines changed

9 files changed

+45
-13
lines changed

content/en/docs/faq.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Frequently Asked Questions
33
LinkTitle: FAQ
4-
weight: 45
4+
weight: 450
55
description: Get your questions answered!
66
aliases: [/faq]
77
---
@@ -138,8 +138,8 @@ in [TAP 4](https://github.com/theupdateframework/taps/blob/master/tap4.md).
138138

139139
**12. Has there been a security audit of TUF?**
140140

141-
The [Security Audits](docs/overview/security) page links to a few of the
142-
security audits of TUF.
141+
The [Security Audits](docs/security/) page links to a few of the security audits
142+
of TUF.
143143

144144
**13. How can I try TUF?**
145145

content/en/docs/get-started/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Get started
3-
weight: 17
3+
weight: 200
44
description: Get started with TUF based on your role.
55
aliases: [/getting-started]
66
---

content/en/docs/get-started/adopter.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22
title: Adopter
33
weight: 15
44
description: Get started with TUF as an adopter.
5+
cSpell:ignore: RSTUF
56
---
67

7-
TUF provides a framework for integration of the
8-
[security](docs/overview/security) properties into new and existing content
9-
delivery systems.
8+
TUF provides a framework for integration of the [security](docs/security/)
9+
properties into new and existing content delivery systems.
1010

1111
While some [adoptions](/community/adoptions/) integrate TUF by implementing the
1212
framework from scratch, others start from either a TUF implementation or from a

content/en/docs/history.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: History
3-
weight: 18
3+
weight: 418
44
description: Learn TUF history and core principles
55
aliases: [/history]
66
---

content/en/docs/overview/_index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Overview
3-
weight: 10
3+
weight: 100
44
description: Find out what TUF is all about!
55
aliases: [/overview]
66
---
@@ -80,8 +80,8 @@ account, such as when:
8080
- An attacker compromises the key used to sign these files. Now you download a
8181
file that is properly signed, but is still malicious.
8282

83-
The [Security](docs/overview/security) section offers a full list of the attacks
84-
and updater weaknesses that TUF is designed to defend against.
83+
The [Security](docs/security/) section offers a full list of the attacks and
84+
updater weaknesses that TUF is designed to defend against.
8585

8686
### How does TUF secure updates?
8787

content/en/docs/overview/security.md renamed to content/en/docs/security/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Security
3-
weight: 35
3+
weight: 300
44
description: Security properties of TUF repositories
55
aliases: [/security]
66
---

content/en/docs/security/audits.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: Security audits
3+
linkTitle: Audits
4+
aliases: [/audits]
5+
---
6+
7+
Selected publicly available audit reports:
8+
9+
- [September 9, 2022 by X41](/audits/x41-python-tuf-audit-2022-09-09.pdf)
10+
- [August 7, 2018 by Cure53](https://github.com/theupdateframework/notary/blob/master/docs/resources/cure53_tuf_notary_audit_2018_08_07.pdf)
11+
covering TUF and Notary
12+
- [October 18, 2017 by NCC](https://www.nccgroup.trust/globalassets/our-research/us/public-reports/2017/ncc-group-kolide-the-update-framework-security-assessment.pdf)
13+
security assessment of TUF / Kolide.
14+
- [July 31, 2015 by NCC](https://github.com/theupdateframework/notary/blob/master/docs/resources/ncc_docker_notary_audit_2015_07_31.pdf)
15+
covering TUF and Notary.
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
title: Reporting issues
3+
aliases: [/reporting]
4+
---
5+
6+
Security issues can be reported by emailing
7+
8+
9+
If at all possible, please include the following information in the report:
10+
11+
- Description of the vulnerability.
12+
- Steps to reproduce the issue.
13+
14+
Optionally, emailed reports can be encrypted with PGP. Use this PGP key
15+
fingerprint:
16+
17+
**E9C0 59EC 0D32 64FA B35F 94AD 465B F9F6 F8EB 475A**.

content/en/docs/timeline.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Timeline
3-
weight: 19
3+
weight: 419
44
Description: See the project timeline
55
aliases: [/timeline]
66
---

0 commit comments

Comments
 (0)