Skip to content

Commit bbf01f6

Browse files
committed
Add guidance on the usage of generic-type purls
Resolves #66
1 parent 75e0e88 commit bbf01f6

1 file changed

Lines changed: 16 additions & 0 deletions

File tree

docs/purl.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -156,6 +156,22 @@ Red Hat. If the type qualifier is not set, it is assumed to be `jar` (as describ
156156
[POM documentation](https://maven.apache.org/pom.html)). The value in the `repository_url` should be Red
157157
Hat's Maven repository at [https://maven.repository.redhat.com/ga/](https://maven.repository.redhat.com/ga/).
158158

159+
## Generic components
160+
161+
The purl specification allows for the use of a `generic` purl type that can be used to identify any software component
162+
that does not fit into a specific package ecosystem. Components identified using the `generic` type normally point to
163+
specific artifacts like upstream source code. For example, the purl for the OpenSSL upstream source code repository
164+
would be:
165+
166+
```
167+
pkg:generic/openssl@3.0.7?download_url=https://openssl.org/source/openssl-3.0.7.tar.gz&checksum=sha256:83049d042a260e696f62406ac5c08bf706fd84383f945cf21bd61e9ed95c396e
168+
```
169+
170+
Each `generic` purl must include an exact location from where the artifact can be downloaded, and ideally a checksum
171+
that corresponds to the artifact.
172+
173+
The use of `generic` purls should be limited to components that are not available in any other purl type.
174+
159175
## Additional Notes
160176

161177
The guidelines highlighted in this document represent an ideal state across all of Red Hat-published security data

0 commit comments

Comments
 (0)