Skip to content

Commit a17ffb1

Browse files
authored
Merge pull request #74 from oej/fix-req
Requirements: Add security txt, fix some issues
2 parents 6b90fd4 + 8af20d1 commit a17ffb1

File tree

1 file changed

+13
-6
lines changed

1 file changed

+13
-6
lines changed

doc/tea-requirements.md

+13-6
Original file line numberDiff line numberDiff line change
@@ -12,16 +12,21 @@ Based on an identifier a repository URL needs to be found. The identifier can be
1212

1313
At the base URL well known URLs (ref) needs to point to
1414

15-
- A lifecycle status document
15+
- A lifecycle status document (using OWASP Common Lifecycle Enumeration, CLE)
1616
- A version list. For each version, a URL will point to where a **collection** can be found
1717
- Vendor Discovery, returns a list of Vendors represented in the repository
18-
- Vendor Name
19-
- Vendor ID
18+
- Vendor Name
19+
- Vendor ID
20+
21+
As an alternative, discovery using a company's ordinary web site should be supported.
22+
This can be handled using the file security.txt (IETF RFC 9116)
2023

2124
## Artifact Discovery based on TEA collections
2225

2326
The API MUST provide a way to discover the artifacts that are available for retrieval or further query.
24-
Discovery SHOULD group artifacts together that represent a **collection** that are directly applicable to a given product. Collections are OPTIONAL. For example, a medical device that has:
27+
Discovery SHOULD group artifacts together that represent a **collection**
28+
that are directly applicable to a given product with a given version.
29+
Collections are OPTIONAL.
2530

2631
- SBOM - Software Bill of Material
2732
- CBOM - Cryptography Bill of Material
@@ -42,14 +47,16 @@ modifying collections, or deleting existing collections.
4247
## Artifact Retrieval
4348

4449
The API MUST provide a method in which to retrieve an artifact based on the identity of the artifact.
45-
For example, using CycloneDX BOM-Link to retrieve either the latest version or specific version of an artifact.
50+
For example, using CycloneDX BOM-Link to retrieve either the
51+
latest version or specific version of an artifact.
4652

4753
```text
4854
urn:cdx:serialNumber
4955
urn:cdx:serialNumber/version
5056
```
5157

52-
The API needs to provide support for update checks, i.e. to check if a document is updated without downloading. (possibly etag or HEAD method or similar)
58+
The API needs to provide support for update checks, i.e. to check if a document is
59+
updated without downloading. (possibly etag or HEAD method or similar)
5360
Authn/Authz MUST be supported
5461

5562
## Artifact Publishing

0 commit comments

Comments
 (0)