Skip to content

Commit 7b78073

Browse files
authored
Merge pull request #161 from keszybz/voa-cleanps
2 parents 1a3288e + 6120958 commit 7b78073

1 file changed

Lines changed: 9 additions & 9 deletions

File tree

specs/file_hierarchy_for_the_verification_of_os_artifacts.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ The existence of multiple load paths allows system administrators and users to d
125125

126126
#### System mode
127127

128-
The priority of load paths in system mode follows the definition of ["Storage Directories and Overrides" in the Configuration Files Sepcification], which is also reflected in the following list of paths:
128+
The priority of load paths in system mode follows the definition of ["Storage Directories and Overrides" in the Configuration Files Specification], which is also reflected in the following list of paths:
129129

130130
- `/etc/voa/`
131131
- `/run/voa/`
@@ -155,7 +155,7 @@ VOA implementations must not consider symlinks under the following conditions an
155155

156156
- the symlink is for a file or directory in an ephemeral load path (i.e. `/run/voa/` and `$XDG_RUNTIME_DIR/voa/`),
157157
- the symlink is for a file or directory outside of the specified _load paths_,
158-
- the symlink is broken (aka. "dangling"),
158+
- the symlink is broken (a.k.a. "dangling"),
159159
- the file name of the symlink (also those of intermediate symlinks in the case of a symlink chain) does not match that of the target,
160160
- or the file type of the source and target of the fully resolved symlink do not match (e.g. a verifier file points to a directory, or a directory to a verifier file).
161161

@@ -229,7 +229,7 @@ Each of the following identifiers represents a subdirectory layer in that hierar
229229
The _os_ identifier is used to uniquely identify an Operating System (OS).
230230

231231
The identifier relies on data provided by the ubiquitous [os-release].
232-
The following keywords are understood and their value format follows that established by [os-release] (i.e. no spaces and no characters outside of `0–9`, `a–z`, `"."`, `"_"` and `"-"` are allowed):
232+
The following keywords are understood and their value format follows that established by [os-release] (i.e. no spaces and no characters outside of `0–9`, `a–z`, `"."`, `"_"`, and `"-"` are allowed):
233233

234234
- `ID`: name of OS (e.g. `arch` or `debian`)
235235
- `VERSION_ID`: the version of the OS (e.g. `1.0.0` or `24.12`)
@@ -280,7 +280,7 @@ Either two or one _purpose_ directories may exist per _role_:
280280
- One directory which contains _artifact verifiers_ (e.g. `package`), and a second directory which contains the corresponding _trust anchors_ (e.g. `trust-anchor-package`).
281281
- Just one directory which contains _artifact verifiers_ (e.g. `package`).
282282

283-
The _purpose_ directory name must not contain characters outside of `0–9`, `a–z`, `"."`, `"_"` and `"-"`.
283+
The _purpose_ directory name must not contain characters outside of `0–9`, `a–z`, `"."`, `"_"`, and `"-"`.
284284
VOA implementations must not consider invalid directories and should raise a warning if such a directory is encountered.
285285

286286
##### Two purpose directories: Verification relying on trust anchors
@@ -339,7 +339,7 @@ Specific examples for **context** are
339339

340340
If no specific context is required, the **context** directory `default` must be used.
341341

342-
Analogous to the os-release data, **context** strings may only contain `[a-z]`, `[0-9]`, `_`, `.` and `-`.
342+
Analogous to the os-release data, **context** strings may only contain `[a-z]`, `[0-9]`, `_`, `.`, and `-`.
343343

344344
For more in-depth discussion on the use of the _context_ identifier, see the [examples] section.
345345

@@ -358,7 +358,7 @@ Further specification work is required before implementing further technologies.
358358
Each technology specifies file suffixes for verifiers.
359359
Note that these suffixes may overlap.
360360

361-
A _technology_ directory name must not contain characters outside of `0–9`, `a–z`, `"."`, `"_"` and `"-"`.
361+
A _technology_ directory name must not contain characters outside of `0–9`, `a–z`, `"."`, `"_"`, and `"-"`.
362362
VOA implementations must not consider invalid directories and should raise a warning if such a directory is encountered.
363363

364364
#### OpenPGP
@@ -367,7 +367,7 @@ VOA implementations must not consider invalid directories and should raise a war
367367

368368
This technology is named `openpgp` in the VOA structure.
369369

370-
Most Linux distributions use OpenPGP, often combined with _PGPKI_ (aka. [Web of Trust (WoT)]), in which chains of trust are evaluated during signature validation.
370+
Most Linux distributions use OpenPGP, often combined with _PGPKI_ (a.k.a. [Web of Trust (WoT)]), in which chains of trust are evaluated during signature validation.
371371

372372
OpenPGP has a rich model of validity, both for certificates and signatures.
373373
Certificates can expire or be revoked by the key holder (via [OpenPGP certificate revocation]).
@@ -614,7 +614,7 @@ If the need arises, this specification should be extended accordingly.
614614
[CMS]: https://en.wikipedia.org/wiki/Cryptographic_Message_Syntax
615615
[NSS]: https://firefox-source-docs.mozilla.org/security/nss/index.html
616616
[OpenPGP certificate revocation]: https://openpgp.dev/book/certificates.html#revocations
617-
[OpenPGP signature revocation]: https://openpgp.dev/book/verification.html#revocations]
617+
[OpenPGP signature revocation]: https://openpgp.dev/book/verification.html#revocations
618618
[OpenPGP]: https://openpgp.org
619619
[OpenPGPv4]: https://datatracker.ietf.org/doc/html/rfc4880
620620
[OpenPGPv6]: https://datatracker.ietf.org/doc/html/rfc9580
@@ -639,7 +639,7 @@ If the need arises, this specification should be extended accordingly.
639639
[load paths]: #load-paths
640640
[masking]: #masking
641641
[merging]: #merging
642-
[os-release]: https://man.archlinux.org/man/os-release.5.en
642+
[os-release]: https://www.freedesktop.org/software/systemd/man/latest/os-release.html
643643
[os]: #os
644644
[overriding]: #overriding
645645
[point to point]: #point-to-point

0 commit comments

Comments
 (0)