Skip to content
Snippets Groups Projects
Commit a09d92d9 authored by Niels Möller's avatar Niels Möller
Browse files

Merge branch 'nisse/relative-os_pkg_url' into 'main'

Document that a descriptor's os_pkg_url may be relative, and how it is resolved

See merge request system-transparency/project/docs!49
parents 00bdb60f 3bb45b47
No related branches found
No related tags found
No related merge requests found
......@@ -115,6 +115,21 @@ certificates and signatures.
The OS package URL field specifies where the zip archive can be downloaded using
HTTP(S). For example, `https://ospkg.example.org/debian-stable.zip`.
If the URL is not absolute (i.e., not starting with scheme and host), it
is resolved using the the URL of the descriptor file as the "base URI".
E.g., if the descriptor file was downloaded from
`https://ospkg.example.org/debian-stable.json`, and the OS package URL
in the descriptor is `debian-stable.zip`, that is resolved to
`https://ospkg.example.org/debian-stable.zip` before download. See
[Reference Resolution](https://www.rfc-editor.org/rfc/rfc3986#section-5)
for the precise resolution rules.
**Compatibility note**: ST docs version v0.2.5 and earlier, part of the
st-1.0.0 collection release, did not specify any "base URI" to use for
resolving relative URLs, and hence implicitly required an absolute URL
for the `os_pkg_url`. When compatibility with the st-1.0.0 components is
desired, avoid using a relative URL in the descriptor.
### Example
```json
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment