Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

v1.6 #323

Merged
merged 285 commits into from
Apr 9, 2024
Merged

v1.6 #323

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
285 commits
Select commit Hold shift + click to select a range
da1286b
chore: generate docs for v1.6
jkowalleck Oct 15, 2023
ec1b169
Merge branch 'master' into 1.6-dev
jkowalleck Oct 15, 2023
5d8c05b
chore: generate docs for v1.6
jkowalleck Oct 15, 2023
8d1c9a4
Merges detectionContext properties with component evidence
bhess Oct 18, 2023
92ae29e
refactor: centralize version and version-range
jkowalleck Oct 15, 2023
29373d7
remove remaining confidenceLevel
bhess Oct 19, 2023
17019b0
Corrected strict schema violations
stevespringett Oct 21, 2023
fae707b
Merge branch '1.6-dev-cbom' into bhe-cbom-evidence
stevespringett Oct 21, 2023
419d536
Merges detectionContext properties with component evidence (#325)
stevespringett Oct 21, 2023
5af5623
CBOM: merges relatedCryptoMaterial and key asset types (#313)
stevespringett Oct 21, 2023
a8d1c65
refactor: centralize version and version-range (#322)
stevespringett Oct 21, 2023
6dac012
tests: enable more tests for v1.6
jkowalleck Oct 22, 2023
ad6f39d
docs: improve SPDX expression docs
jkowalleck Oct 24, 2023
9a95cff
docs: improve SPDX expression docs (#327)
stevespringett Oct 24, 2023
dd517f6
CBOM: adds 'parameterSetIdentifier' property, replacing 'variant'
bhess Nov 16, 2023
779121c
CBOM: adds 'parameterSetIdentifier' property, replacing 'variant' (#339)
stevespringett Nov 16, 2023
d39b039
Description and minor field updates
Nov 16, 2023
38950ae
Move comment to description
andreas-hilti Nov 19, 2023
d309ee9
Move comment to description (#344)
stevespringett Nov 26, 2023
77ab457
Merge branch '1.6-dev' into 1.6-dev-cbom
jkowalleck Nov 28, 2023
e8ae437
Merge branch '1.6-dev' into 1.6-dev-attestations
jkowalleck Nov 28, 2023
224f756
Review description fields of 'algorithmProperties'
bhess Nov 29, 2023
cbc6ee5
Review description fields of 'algorithmProperties' (#350)
jkowalleck Nov 30, 2023
ad47938
Added key to enum
stevespringett Dec 7, 2023
800ad2a
Commits as of last meeting
stevespringett Dec 12, 2023
32ffcc0
add 'combiner' as primitive
bhess Dec 12, 2023
915c7cc
Support for hybrids/combiners: add 'combiner' as primitive (#353)
stevespringett Dec 14, 2023
551d7ff
Updates from todays CBOM meeting
Dec 14, 2023
335dfab
Merge branch 'master' into 1.6-dev
jkowalleck Dec 15, 2023
0e1e922
Merge branch '1.6-dev' into 1.6-dev-cbom
jkowalleck Dec 15, 2023
0a54c3d
Merge branch '1.6-dev' into 1.6-dev-attestations
jkowalleck Dec 15, 2023
29a9a7d
Added attestation support to XSD and added JSON and XML test cases.
stevespringett Dec 21, 2023
7b6c563
Merge remote-tracking branch 'origin/1.6-dev-attestations' into 1.6-d…
stevespringett Dec 21, 2023
5be18a1
Added valid standard JSON and XML test cases and minor corrections to…
stevespringett Dec 21, 2023
89c0088
Added valid standard JSON and XML test cases and minor corrections to…
stevespringett Dec 22, 2023
c537c58
corrected parent
stevespringett Dec 22, 2023
1bac4d6
Corrected level ref
stevespringett Dec 22, 2023
423fefe
Added protobuf support and test cases
stevespringett Dec 27, 2023
55a7aad
Fixed evidence identity. Updated test cases
stevespringett Dec 27, 2023
6df7182
Removed unnecessary type for dataGovernance ref that resulted in warn…
stevespringett Dec 27, 2023
64d237e
Allowing allowUnionTypes to schema linting
stevespringett Dec 27, 2023
033f36d
Merge branch 'master' into 1.6-dev
jkowalleck Dec 27, 2023
0820650
Refactoring identity evidence. Adding back in strict union support in…
stevespringett Dec 28, 2023
163859d
Making suggested modifications to XML schema documentation
stevespringett Dec 28, 2023
2908720
Normalizing CBOM and porting to XML and Protobuf. Adding test files.
stevespringett Jan 5, 2024
0044906
Updating JSON Schema for Humans to latest release. Porting template c…
stevespringett Jan 8, 2024
deb1379
Initial commit for Ecma documentation generation
stevespringett Jan 8, 2024
d92e58e
Refactored JSON enum descriptions to use meta:enum
stevespringett Jan 11, 2024
a907216
Fixed unit tests
stevespringett Jan 11, 2024
6f4665c
Refactored JSON enum descriptions to use meta:enum (#362)
stevespringett Jan 11, 2024
ae45d7c
Add `source-distribution` element to `externalReferenceType` #98
tsjensen Dec 11, 2023
517e694
Add `source-distribution` element to `externalReferenceType` (#269)
jkowalleck Jan 12, 2024
fff3552
Added missing descriptions
stevespringett Jan 14, 2024
f65bdd4
Merge remote-tracking branch 'origin/1.6-dev' into 1.6-dev
stevespringett Jan 14, 2024
c65fed2
Updated template to support markdown in meta:enum descriptions.
stevespringett Jan 14, 2024
b2033e0
Changed opencre to openCre
stevespringett Jan 14, 2024
4ff0242
Merge branch '1.6-dev' into 1.6-dev-attestations
stevespringett Jan 14, 2024
b2ae699
1.6 dev attestations (#348)
stevespringett Jan 14, 2024
76bf8f9
Updating gitignore
stevespringett Jan 15, 2024
1302628
# Conflicts:
stevespringett Jan 15, 2024
ad68d99
Revert "# Conflicts:"
stevespringett Jan 16, 2024
e151ee4
Revert "Updating gitignore"
stevespringett Jan 16, 2024
1e6ea08
Merge branch '1.6-dev' into 1.6-dev-fix-evidence-identity
stevespringett Jan 16, 2024
63e48c4
Fixed evidence identity. Updated test cases (#359)
stevespringett Jan 16, 2024
81858fe
Removing support for protected-by dependency type
stevespringett Jan 22, 2024
82ddeb0
Updated signatureAlgorithm and subjectPublicKey to include 'Ref'.
stevespringett Jan 22, 2024
83daf62
Merge branch 'master' into 1.6-dev-cbom
stevespringett Jan 22, 2024
57ab8bf
Merge branch '1.6-dev' into 1.6-dev-cbom
stevespringett Jan 22, 2024
9a9fab8
Added missing evidence in XSD and Protobuf originally missed when por…
stevespringett Jan 23, 2024
3446cce
Made certificationLevel an array. Updated test cases.
stevespringett Jan 23, 2024
29fc0a6
Renamed lineNumber to line to align properties with those in callstac…
stevespringett Jan 23, 2024
d8ae85e
rework dependency type to `provides`
jkowalleck Jan 26, 2024
56e936e
rework dependency type to `provides` (#366)
stevespringett Jan 26, 2024
c6acc8d
1.6 dev cbom (#347)
stevespringett Jan 26, 2024
4dd5588
Tweak compliment to complement
msymons Feb 4, 2024
a7ee907
Tweak compliment to complement
msymons Feb 4, 2024
2a9d676
Tweak compliment to complement
msymons Feb 4, 2024
52a4ee2
Tweak compliment to complement
msymons Feb 4, 2024
abc03a5
docs: Tweak "compliment" to "complement" (#369)
stevespringett Feb 5, 2024
46ff114
fix #288 (#292)
stevespringett Feb 5, 2024
71b4754
fix: correcting title of counterClaim
idunbarh Feb 8, 2024
c418c2a
tests: test data and examples for valid and invalid property
jkowalleck Feb 9, 2024
e6ea842
tests: test data and examples for valid and invalid property
jkowalleck Feb 9, 2024
0981967
fix: in JSON, CycloneDX property has mandatory name and no additional…
jkowalleck Feb 9, 2024
e0dc610
Add descriptions for task types
mrutkows Feb 9, 2024
07cd714
Add descriptions for task types as comments in protobuf schema
mrutkows Feb 9, 2024
1c293d8
Add descriptions for task types as comments in v1.6 XSD schema
mrutkows Feb 9, 2024
233bcc5
Add descriptions for task types as comments in protobuf schema
mrutkows Feb 9, 2024
7224f3e
Add descriptions for task types as comments in protobuf schema
mrutkows Feb 9, 2024
6686375
1.6 dev fix properties json - fixes #371 (#375)
stevespringett Feb 9, 2024
8bebd15
fix: correcting title of `attestations[].map[].counterClaim` (#374)
stevespringett Feb 9, 2024
b9cf0d4
Add `meta:enum` descriptions for task types (#377)
jkowalleck Feb 10, 2024
e5a8713
Added enum descriptions provided by Cryptography FWG
stevespringett Feb 12, 2024
b90ef7a
Merge remote-tracking branch 'origin/1.6-dev' into 1.6-dev
stevespringett Feb 12, 2024
6c3f3e3
docs: describe `$.metadata.licenses`
jkowalleck Feb 14, 2024
4ca69c9
feat: devide metadata from its component
jkowalleck Feb 8, 2024
cbd6265
revert proposed changes on `metadata.supplier`
jkowalleck Feb 15, 2024
138e249
feat: external reference type for RFC9116
jkowalleck Feb 16, 2024
a957318
docs: fix malform/typo
jkowalleck Feb 16, 2024
d9e703f
docs: describe `$.metadata.licenses` (#378)
stevespringett Feb 17, 2024
25e2a5a
Merge branch '1.6-dev' into 1.6-dev_draft-devide_metadata_from_component
jkowalleck Feb 20, 2024
702653c
sam fix indended JSON data structures
jkowalleck Feb 20, 2024
4cc4e14
add JSON test data
jkowalleck Feb 20, 2024
5639eef
fix typo
jkowalleck Feb 20, 2024
cd1fbe9
xml
jkowalleck Feb 20, 2024
c8f97ce
protobuf
jkowalleck Feb 20, 2024
8b0f6e6
typo
jkowalleck Feb 20, 2024
b31cdb1
protobuff test case
jkowalleck Feb 20, 2024
23066d5
Added missing titles
stevespringett Feb 21, 2024
472d4c2
Merge remote-tracking branch 'origin/1.6-dev' into 1.6-dev
stevespringett Feb 21, 2024
0a983f3
Added support for tags along with unit tests.
stevespringett Feb 22, 2024
d7753f7
Add tags support (#383)
stevespringett Feb 22, 2024
f4049d8
Merge branch '1.6-dev' into 1.6-dev_draft-devide_metadata_from_component
stevespringett Feb 22, 2024
2734b3f
feat: decouple metadata from its component (#379)
stevespringett Feb 22, 2024
b5ae1b3
feat: external reference type for RFC-9116 (#381)
stevespringett Feb 22, 2024
7122df4
Removed ecma doc generation.
stevespringett Feb 22, 2024
751cc17
Minor doc change
stevespringett Feb 22, 2024
2873c49
Alignment of spec name with JSON schema
stevespringett Feb 22, 2024
64c4ea5
Update source-distribution description
stevespringett Feb 22, 2024
a1cc568
Update valid-attestation-1.6.json
stevespringett Feb 26, 2024
fab8888
Update valid-attestation-1.6.textproto
stevespringett Feb 26, 2024
d90b8d5
tests: add example cor component scope
jkowalleck Feb 28, 2024
8a168a4
docs: `metadata.licenses` rephrase
jkowalleck Mar 1, 2024
e20f63a
introduce QA pipeline for protobuf schemas (#385)
jkowalleck Mar 2, 2024
9b95168
tests: add headers to `*.textproto` file
jkowalleck Mar 2, 2024
0997735
add headers to `*.textproto` (#393)
stevespringett Mar 2, 2024
22e5825
tests: add example for component scope (#389)
stevespringett Mar 2, 2024
be68664
Corrected issue with XML schema to align to JSON and protobuf.
stevespringett Mar 2, 2024
f60380c
Merge remote-tracking branch 'origin/1.6-dev' into 1.6-dev
stevespringett Mar 2, 2024
d6835a9
Corrected title
stevespringett Mar 7, 2024
7bf6e28
Spelling and grammar checks
prabhu Mar 12, 2024
5ac4285
docs: spelling and grammar checks (#397)
stevespringett Mar 12, 2024
643e7f3
Spelling and grammar checks
prabhu Mar 12, 2024
8c4ff37
docs: Spelling and grammar checks (#398)
stevespringett Mar 13, 2024
a0e58b1
Minor doc updates
stevespringett Mar 14, 2024
742326b
fix: protobuf `Metadata.licenses` repeated
jkowalleck Mar 18, 2024
d0c2c86
test data
jkowalleck Mar 18, 2024
cda42cd
remove restriction on json schema
jkowalleck Mar 18, 2024
112057a
Propose new environmental consideration information for ML models
mrutkows Mar 7, 2024
ac3e92b
Propose new environmental consideration information for ML models
mrutkows Mar 7, 2024
c371e36
Propose new environmental consideration information for ML models
mrutkows Mar 7, 2024
89c47e2
Propose new environmental consideration information for ML models
mrutkows Mar 8, 2024
5bc5c89
Propose new environmental consideration information for ML models
mrutkows Mar 8, 2024
11447b4
Add XML schema for environmentalConsiderations of model cards
mrutkows Mar 21, 2024
1d47a9b
Add XML schema for co2MeasureType
mrutkows Mar 21, 2024
ce19f62
Add energyProviderType and postalAddressType to XML schema
mrutkows Mar 21, 2024
97500b3
Add energyConsumptionType to XML schema
mrutkows Mar 22, 2024
ac530ca
Assure json schema types do not allow additional props.
mrutkows Mar 22, 2024
248f4e0
Correct data type for energyMeasureType's element named value
mrutkows Mar 22, 2024
649367a
Correct data type within environmentalConsiderations to be an array o…
mrutkows Mar 22, 2024
48ea7f9
Correct data type within environmentalConsiderations to be an array o…
mrutkows Mar 22, 2024
ed2304b
Correct data type within environmentalConsiderations to be an array o…
mrutkows Mar 22, 2024
915481b
Correct data type within environmentalConsiderations to be an array o…
mrutkows Mar 22, 2024
c04e4ca
Correct data type within environmentalConsiderations to be an array o…
mrutkows Mar 22, 2024
535e72e
Fix description for energyCost element
mrutkows Mar 22, 2024
964173b
add bom-ref to postal address type
mrutkows Mar 22, 2024
a586728
Add missing descs. to formulation related types
mrutkows Mar 22, 2024
4403444
Add EnergyConsumptionType to protobuf sceham
mrutkows Mar 22, 2024
d10662e
Add EnergyConsumption, EnergyProvider and their ref. subtypes
mrutkows Mar 22, 2024
8ced6e8
Add PostalAddressType to protobuf
mrutkows Mar 22, 2024
6ea561d
Fix syntaax error in EnergyProviderType
mrutkows Mar 22, 2024
72f36e0
Fix zero value enums errors (i.e., should be suffixed with _UNSPECIFIED)
mrutkows Mar 22, 2024
7c701a2
Fix zero value enums errors (i.e., should be suffixed with _UNSPECIFIED)
mrutkows Mar 22, 2024
7237bc3
Fix zero value enums errors (i.e., should be suffixed with _UNSPECIFIED)
mrutkows Mar 22, 2024
1b8b886
Fix typo in EnergySourceType
mrutkows Mar 22, 2024
488489d
Fix typo in CO2_MEASURE_UNIT_TYPE_TONNES_CO2_EQUIVALENT enum defn.
mrutkows Mar 22, 2024
b870a93
Added support for license acknowledgements
stevespringett Mar 22, 2024
74803ec
Fixed unit tests
stevespringett Mar 22, 2024
f866a54
remove restriction on json's `$schema` annotation (#403)
stevespringett Mar 23, 2024
7a9208a
fix: protobuf `Metadata.licenses` repeated (#401)
stevespringett Mar 23, 2024
83691a6
Updated comment
stevespringett Mar 23, 2024
45db721
Added support for concluded value. Updated test cases.
stevespringett Mar 24, 2024
c71f22b
Add support for OmniBOR and Software Heritage persistent IDs
stevespringett Mar 24, 2024
7325eb1
docs: fix examples for `versionRange` according to VERS spec
jkowalleck Mar 25, 2024
628ed72
Use the best practice of using an unspecified value of 0 for enums
mrutkows Mar 25, 2024
3e545a3
Use the best practice of using an unspecified value of 0 for enums
mrutkows Mar 25, 2024
a3db74a
Adjust energy source types and add enum. definitions for values
mrutkows Mar 25, 2024
2c3e1c8
Adjust energy source types and add enum. definitions for values
mrutkows Mar 25, 2024
076ba71
Adjust energy source types and add enum. definitions for values
mrutkows Mar 25, 2024
3e01ce6
Increasing version range character limit per @prabhu request
stevespringett Mar 25, 2024
22299d0
docs: fix examples for `versionRange` according to VERS spec (#415)
stevespringett Mar 25, 2024
f381558
Correct double type defn. for energyConsumption
mrutkows Mar 25, 2024
597b956
Restore natural-gas as one of the energy sources
mrutkows Mar 25, 2024
3daf108
Add VSCode settings path to git ignore
mrutkows Mar 25, 2024
ac3e662
Added descriptions for ML learning types
stevespringett Mar 26, 2024
7fb317c
Added descriptions for ML learning types (#416)
stevespringett Mar 26, 2024
4a76e57
Add first example of env. consideration info.
mrutkows Mar 26, 2024
68757cc
Add LF at end of example JSON file and git ignore for linting warnings
mrutkows Mar 26, 2024
a20e982
Add ExternalReferences and Properties where they are needed for exten…
mrutkows Mar 26, 2024
1c15d63
Add valid tests to resources
mrutkows Mar 26, 2024
df4b536
foo
jkowalleck Mar 26, 2024
921e4da
Fix wrong type for publisher on json and xml schema tests
mrutkows Mar 26, 2024
1cdd16f
Fix wrong type for publisher on json and xml schema tests
mrutkows Mar 26, 2024
b8dfe00
Fix wrong type for publisher on json and xml schema tests
mrutkows Mar 26, 2024
998e58e
Merge pull request #1 from jkowalleck/energy_mod1
mrutkows Mar 26, 2024
6084dea
add description back in
jkowalleck Mar 26, 2024
e467a33
Updated tests to account for new organization element
mrutkows Mar 27, 2024
57d401f
Add type element to xml example
mrutkows Mar 27, 2024
347cc3e
Try a full supplier in XML example
mrutkows Mar 27, 2024
bb6d189
Try a full supplier in XML example
mrutkows Mar 27, 2024
00c8338
Try a full supplier in XML example
mrutkows Mar 27, 2024
f3cbda5
XML example attempt tp fix test error
mrutkows Mar 27, 2024
a88f91b
remove all but required fields from component
mrutkows Mar 27, 2024
ae5a631
build up xml test from scratch
mrutkows Mar 27, 2024
838a7be
build up xml test from scratch
mrutkows Mar 27, 2024
f9784ee
build up xml test from scratch
mrutkows Mar 27, 2024
f55385c
build up xml test from scratch
mrutkows Mar 27, 2024
b04b682
build up xml test from scratch
mrutkows Mar 27, 2024
c8e9d1c
build up xml test from scratch
mrutkows Mar 27, 2024
bbcfd93
build up xml test from scratch
mrutkows Mar 27, 2024
fdfe19f
build up xml test from scratch
mrutkows Mar 27, 2024
825a866
build up xml test from scratch
mrutkows Mar 27, 2024
c7793d1
fix examples
jkowalleck Mar 27, 2024
c299ad6
Merge remote-tracking branch 'origin/energy_mod2' into energy-fix-exa…
jkowalleck Mar 27, 2024
60af7d8
fix examples
jkowalleck Mar 27, 2024
394d698
build up xml test from scratch
mrutkows Mar 27, 2024
6779610
build up xml test from scratch
mrutkows Mar 27, 2024
44c8ba3
build up xml test from scratch
mrutkows Mar 27, 2024
4e2bff0
build up xml test from scratch
mrutkows Mar 27, 2024
8fca445
build up xml test from scratch
mrutkows Mar 27, 2024
3af31f1
Merge branch 'energy' into energy-fix-examples
mrutkows Mar 27, 2024
b822d87
Merge pull request #3 from jkowalleck/energy-fix-examples
mrutkows Mar 27, 2024
3525462
insert energyConsumptionsType (plural) into XSD to account for anon. …
mrutkows Mar 27, 2024
5d85af3
fix line-wrap in top of xml example
mrutkows Mar 27, 2024
6cd0302
fix/harmonize version length
jkowalleck Mar 27, 2024
641bd14
remove old example
mrutkows Mar 27, 2024
2a83cf9
Fix typo in name of test file
mrutkows Mar 27, 2024
f156ca5
1.6 bump bufbuild buf 1.30.0 (#418)
jkowalleck Mar 27, 2024
2b8fd26
fix/harmonize version length (#417)
stevespringett Mar 28, 2024
6e90b46
Added support for concluded value. Updated test cases. (#412)
stevespringett Mar 28, 2024
fc55713
Added support for license acknowledgements (#408)
stevespringett Mar 28, 2024
6f284bd
Propose new environmental consideration information for ML models (#395)
stevespringett Mar 29, 2024
6fcbd02
Changed to array. Updated examples
stevespringett Mar 29, 2024
f3e98d4
Changed omnibor to omniborId
stevespringett Mar 29, 2024
86b6ae1
Add support for OmniBOR and Software Heritage persistent IDs (#414)
stevespringett Mar 29, 2024
197d106
Minor doc corrections
stevespringett Mar 29, 2024
7c96e72
revisit new component identifiers
jkowalleck Mar 29, 2024
d980b09
fix: revisit new component identifiers (#419)
stevespringett Mar 29, 2024
60b0e46
Minor doc updates
stevespringett Mar 30, 2024
c8d57a4
Minor doc updates - titles, descriptions, etc
stevespringett Apr 2, 2024
176f1e4
Minor doc updates
stevespringett Apr 2, 2024
494661a
Correct property that included space
stevespringett Apr 3, 2024
f34a832
Clarification of descriptions
stevespringett Apr 3, 2024
2bb8bae
Correcting optional state for crypto assetType
stevespringett Apr 6, 2024
f5d959b
Explicit string type correction
stevespringett Apr 6, 2024
d278e70
Corrected maxOccurs with esn
stevespringett Apr 6, 2024
6c88ab9
Updated dependency attribute docs
prabhu Apr 6, 2024
b5c550e
Updated dependency attribute docs (#421)
stevespringett Apr 7, 2024
b3ea018
Updates to online docs
stevespringett Apr 9, 2024
4017ce4
Updated SPDX license list to 3.23
stevespringett Apr 9, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
13 changes: 11 additions & 2 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates

# https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
version: 2
updates:
- package-ecosystem: 'github-actions'
Expand All @@ -12,3 +11,13 @@ updates:
prefix: 'chore' ## prefix maximum string length of 15
include: 'scope'
open-pull-requests-limit: 999
- package-ecosystem: 'docker'
directory: '/'
schedule:
interval: 'weekly'
day: 'saturday'
labels: [ 'dependencies' ]
commit-message:
prefix: 'chore' ## prefix maximum string length of 15
include: 'scope'
open-pull-requests-limit: 999
28 changes: 28 additions & 0 deletions .github/workflows/test_proto.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# docs: https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions

name: CT ProtoBuf

on:
push:
branches: ['master', 'main']
pull_request:
workflow_dispatch:

concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true

defaults:
run:
working-directory: tools/src/test/proto

jobs:
test:
timeout-minutes: 30
runs-on: ubuntu-latest
steps:
- name: Checkout
# see https://github.com/actions/checkout
uses: actions/checkout@v4
- name: Run test
run: ./test.sh
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
.idea/
tools/target/
.vscode/
tools/target/
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,9 +68,9 @@ The officially supported media type for Protocol Buffer format is `application/x
## Related Work
[SPDX (Software Package Data Exchange)][spdx-url] is a specification that provides low-level details of components, including all files, hashes, authors, and copyrights. SPDX also defines over 300 open source license IDs. CycloneDX builds on top of the work SPDX has accomplished with license IDs, but varies greatly in its approach towards building a software bill of material specification.

[SWID (ISO/IEC 19770-2:2015)][swid-url] is used primarily to identify installed software and is the preferred format of the NVD. SWID tags are used in the National Vulnerability Database to describe vulnerable components. The CycloneDX specification compliments this work as CycloneDX documents can incorporate SWID tags and other high-level SWID metadata and optionally include entire SWID documents. Use of SWID tag ID's are useful in determining if a specific component has known vulnerabilities.
[SWID (ISO/IEC 19770-2:2015)][swid-url] is used primarily to identify installed software and is the preferred format of the NVD. SWID tags are used in the National Vulnerability Database to describe vulnerable components. The CycloneDX specification complements this work as CycloneDX documents can incorporate SWID tags and other high-level SWID metadata and optionally include entire SWID documents. Use of SWID tag ID's are useful in determining if a specific component has known vulnerabilities.

[CPE (Common Platform Enumeration)][cpe-url] is a specification that describes the vendor, name, and version for an application, operating system, or hardware device. CPE identifiers are used in the National Vulnerability Database to describe vulnerable components. The CycloneDX specification compliments this work as CycloneDX documents can easily be used to construct exact CPE identifiers that are useful in determining if a specific component has known vulnerabilities.
[CPE (Common Platform Enumeration)][cpe-url] is a specification that describes the vendor, name, and version for an application, operating system, or hardware device. CPE identifiers are used in the National Vulnerability Database to describe vulnerable components. The CycloneDX specification complements this work as CycloneDX documents can easily be used to construct exact CPE identifiers that are useful in determining if a specific component has known vulnerabilities.

## Copyright & License

Expand Down
7 changes: 4 additions & 3 deletions docgen/json/gen.sh
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
#!/bin/bash
rm -f -R docs
mkdir -p docs/{1.2,1.3,1.4,1.5}
mkdir -p docs/{1.2,1.3,1.4,1.5,1.6}

# Check to see if generate-schema-doc is executable and is in the path. If not, install JSON Schema for Humans.
if ! [ -x "$(command -v generate-schema-doc)" ]; then
pip3 install json-schema-for-humans==0.44.3
pip3 install json-schema-for-humans==0.47
fi

generate () {
Expand All @@ -27,4 +27,5 @@ generate () {
generate 1.2
generate 1.3
generate 1.4
generate 1.5
generate 1.5
generate 1.6
10 changes: 6 additions & 4 deletions docgen/json/templates/cyclonedx/base.html
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,12 @@
<meta property="og:type" content="website" />
<meta property="og:image" content="https://cyclonedx.org/theme/assets/images/CycloneDX-Twitter-Card.png" />
<link rel="icon" href="https://cyclonedx.org/cyclonedx-icon.png" type="image/png"/>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/bootstrap/4.6.0/css/bootstrap.min.css" integrity="sha512-P5MgMn1jBN01asBgU0z60Qk4QxiXo86+wlFahKrsQf37c9cro517WzVSPPV1tDKzhku2iJ2FVgL67wG03SGnNA==" crossorigin="anonymous" referrerpolicy="no-referrer" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/bootstrap/4.6.2/css/bootstrap.min.css" integrity="sha512-rt/SrQ4UNIaGfDyEXZtNcyWvQeOq0QLygHluFQcSjaGB04IxWhal71tKuzP6K8eYXYB6vJV4pHkXcmFGGQ1/0w==" crossorigin="anonymous" referrerpolicy="no-referrer" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css" integrity="sha512-SfTiTlX6kk+qitfevl/7LibUOeJWlt9rbyDn92a1DqWOw9vWG2MFoays0sgObmWazO5BQPiFucnnEAjpAB+/Sw==" crossorigin="anonymous" referrerpolicy="no-referrer" />
<link rel="stylesheet" type="text/css" href="schema_doc.css">
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.6.0/jquery.slim.js" integrity="sha512-HNbo1d4BaJjXh+/e6q4enTyezg5wiXvY3p/9Vzb20NIvkJghZxhzaXeffbdJuuZSxFhJP87ORPadwmU9aN3wSA==" crossorigin="anonymous" referrerpolicy="no-referrer"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/bootstrap/4.6.0/js/bootstrap.min.js" integrity="sha512-XKa9Hemdy1Ui3KSGgJdgMyYlUg1gM+QhL6cnlyTe2qzMCYm4nAZ1PsVerQzTTXzonUR+dmswHqgJPuwCq1MaAg==" crossorigin="anonymous" referrerpolicy="no-referrer"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/markdown-it/12.2.0/markdown-it.min.js" integrity="sha512-cTQeM/op796Fp1ZUxfech8gSMLT/HvrXMkRGdGZGQnbwuq/obG0UtcL04eByVa99qJik7WlnlQOr5/Fw5B36aw==" crossorigin="anonymous" referrerpolicy="no-referrer"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.7.1/jquery.slim.js" integrity="sha512-docBEeq28CCaXCXN7cINkyQs0pRszdQsVBFWUd+pLNlEk3LDlSDDtN7i1H+nTB8tshJPQHS0yu0GW9YGFd/CRg==" crossorigin="anonymous" referrerpolicy="no-referrer"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/bootstrap/4.6.2/js/bootstrap.min.js" integrity="sha512-7rusk8kGPFynZWu26OKbTeI+QPoYchtxsmPeBqkHIEXJxeun4yJ4ISYe7C6sz9wdxeE1Gk3VxsIWgCZTc+vX3g==" crossorigin="anonymous" referrerpolicy="no-referrer"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/markdown-it/13.0.2/markdown-it.min.js" integrity="sha512-ohlWmsCxOu0bph1om5eDL0jm/83eH09fvqLDhiEdiqfDeJbEvz4FSbeY0gLJSVJwQAp0laRhTXbUQG+ZUuifUQ==" crossorigin="anonymous" referrerpolicy="no-referrer"></script>
<script src="schema_doc.min.js"></script>
</head>
<body class="blue" data-spy="scroll" data-target=".js-scrollspy" onload="anchorOnLoad();" id="root">
Expand All @@ -40,11 +40,13 @@
v${version} (JSON)
</a>
<ul class="dropdown-menu" aria-labelledby="navbarScrollingDropdown">
<li><a class="dropdown-item" href="https://cyclonedx.org/docs/1.6/json/">v1.6 (JSON)</a></li>
<li><a class="dropdown-item" href="https://cyclonedx.org/docs/1.5/json/">v1.5 (JSON)</a></li>
<li><a class="dropdown-item" href="https://cyclonedx.org/docs/1.4/json/">v1.4 (JSON)</a></li>
<li><a class="dropdown-item" href="https://cyclonedx.org/docs/1.3/json/">v1.3 (JSON)</a></li>
<li><a class="dropdown-item" href="https://cyclonedx.org/docs/1.2/json/">v1.2 (JSON)</a></li>
<li><hr class="dropdown-divider"/></li>
<li><a class="dropdown-item" href="https://cyclonedx.org/docs/1.6/xml/">v1.6 (XML)</a></li>
<li><a class="dropdown-item" href="https://cyclonedx.org/docs/1.5/xml/">v1.5 (XML)</a></li>
<li><a class="dropdown-item" href="https://cyclonedx.org/docs/1.4/xml/">v1.4 (XML)</a></li>
<li><a class="dropdown-item" href="https://cyclonedx.org/docs/1.3/xml/">v1.3 (XML)</a></li>
Expand Down
138 changes: 70 additions & 68 deletions docgen/json/templates/cyclonedx/content.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,17 @@

{# Display type #}
{%- if not schema is combining -%}
<span class="badge value-type">Type: {{ type_name }}</span>
<span class="badge badge-dark value-type">Type: {{ type_name }}</span>
{%- endif -%}

{%- if schema.format -%}
<span class="badge badge-info value-type">Format: {{ schema.format }}</span>
{%- endif -%}

{# Display default #}
{%- set default_value = schema.default_value -%}
{%- if default_value -%}
{{ " " }}<span class="badge default-value">Default: {{ default_value }}</span>
{{ " " }}<span class="badge badge-success default-value">Default: {{ default_value }}</span>
{%- endif -%}
<br/>

Expand All @@ -37,80 +41,78 @@
{%- elif schema.refers_to -%}
{{ content(schema.refers_to_merged, True) }}
{%- else -%}
{# Handle having oneOf or allOf with only one condition #}
{%- if schema.kw_all_of and (schema.kw_all_of.array_items | length) == 1 -%}
{{ content(schema.kw_all_of.array_items[0]) }}
{%- elif schema.kw_any_of and (schema.kw_any_of.array_items | length) == 1 -%}
{{ content(schema.kw_any_of.array_items[0]) }}
{%- else -%}
{%- if schema.explicit_no_additional_properties -%}
{{ " " }}<span class="badge no-additional">No Additional Properties</span>
{%- endif -%}

{# Combining: allOf, anyOf, oneOf, not #}
{%- if schema.kw_all_of -%}
<div class="all-of-value" id="{{ schema.kw_all_of.html_id }}">{{ tabbed_section("allOf", schema.kw_all_of) }}</div>
{%- endif -%}
{%- if schema.kw_any_of -%}
<div class="any-of-value" id="{{ schema.kw_any_of.html_id }}">{{ tabbed_section("anyOf", schema.kw_any_of) }}</div>
{%- endif -%}
{%- if schema.kw_one_of -%}
<div class="one-of-value" id="{{ schema.kw_one_of.html_id }}">{{ tabbed_section("oneOf", schema.kw_one_of) }}</div>
{%- endif -%}
{%- if schema.kw_not -%}
{% include "section_not.html" %}
{%- endif -%}

{# Enum and const #}
{%- if schema.kw_enum -%}
<div class="enum-value" id="{{ schema.kw_enum.html_id }}">
<h4>Must be one of:</h4>
<ul class="list-group">
{%- for enum_choice in schema.kw_enum.array_items -%}
<li class="list-group-item enum-item">{{ enum_choice.literal | python_to_json }}</li>
{%- endfor -%}
</ul>
</div>
{%- endif -%}
{%- if schema.kw_const -%}
<span class="const-value" id="{{ schema.kw_const.html_id }}">Specific value: <code>{{ schema.kw_const.raw | python_to_json }}</code></span>
{%- endif -%}
{%- if schema.explicit_no_additional_properties -%}
{{ " " }}<span class="badge badge-info no-additional">No Additional Properties</span>
{%- endif -%}

{# Pattern (Regular Expression) #}
{%- if schema.kw_pattern -%}
<span class="pattern-value" id="{{ schema.kw_pattern.html_id }}">Must match regular expression: <code>{{ schema.kw_pattern.literal | escape }}</code></span>
{%- endif -%}
{# Combining: allOf, anyOf, oneOf, not #}
{%- if schema.kw_all_of -%}
<div class="all-of-value" id="{{ schema.kw_all_of.html_id }}">{{ tabbed_section("allOf", schema.kw_all_of) }}</div>
{%- endif -%}
{%- if schema.kw_any_of -%}
<div class="any-of-value" id="{{ schema.kw_any_of.html_id }}">{{ tabbed_section("anyOf", schema.kw_any_of) }}</div>
{%- endif -%}
{%- if schema.kw_one_of -%}
<div class="one-of-value" id="{{ schema.kw_one_of.html_id }}">{{ tabbed_section("oneOf", schema.kw_one_of) }}</div>
{%- endif -%}
{%- if schema.kw_not -%}
{% include "section_not.html" %}
{%- endif -%}

{# Conditional subschema, or if-then-else section #}
{%- if schema.has_conditional -%}
{% include "section_conditional_subschema.html" %}
{%- endif -%}
{# Enum and const #}
{%- if schema.kw_enum -%}
<div class="enum-value" id="{{ schema.kw_enum.html_id }}">
<h4>Must be one of:</h4>
<ul class="list-group">
{%- for enum_choice in schema.kw_enum.array_items -%}
<li class="list-group-item enum-item">
{%- if schema.kw_meta_enum -%}<strong>{%- endif -%}
{{ enum_choice.literal | python_to_json }}
{%- if schema.kw_meta_enum -%}</strong>
: {{ (schema.enum_description(enum_choice.literal) | get_description_literal) }}
{%- endif -%}
</li>
{%- endfor -%}
</ul>
</div>
{%- endif -%}
{%- if schema.kw_const -%}
<span class="const-value" id="{{ schema.kw_const.html_id }}">Specific value: <code>{{ schema.kw_const.raw | python_to_json }}</code></span>
{%- endif -%}

{# Required properties that are not defined under "properties". They will only be listed #}
{% include "section_undocumented_required_properties.html" %}
{# Pattern (Regular Expression) #}
{%- if schema.kw_pattern -%}
<span class="pattern-value" id="{{ schema.kw_pattern.html_id }}">Must match regular expression: <code>{{ schema.kw_pattern.literal | escape }}</code></span>
{%- endif -%}

{# Show the requested type(s) #}
{% include "badge_type.html" %}
{# Conditional subschema, or if-then-else section #}
{%- if schema.has_conditional -%}
{% include "section_conditional_subschema.html" %}
{%- endif -%}

{# Show array restrictions #}
{%- if type_name.startswith("array") -%}
{% include "section_array.html" %}
{%- endif -%}
{# Required properties that are not defined under "properties". They will only be listed #}
{% include "section_undocumented_required_properties.html" %}

{# Display examples #}
{%- set examples = schema.examples -%}
{%- if examples -%}
{% include "section_examples.html" %}
{%- endif -%}
{# Show the requested type(s) #}
{% include "badge_type.html" %}

{# Properties, pattern properties, additional properties #}
{%- for sub_property in schema.iterate_properties -%}
{# Custom modification to remove $ properties from documentation #}
{%- if not sub_property.property_display_name.startswith("$") -%}
{% include "section_properties.html" %}
{%- endif -%}
{%- endfor -%}
{# Show array restrictions #}
{%- if type_name.startswith("array") -%}
{% include "section_array.html" %}
{%- endif -%}

{# Display examples #}
{%- set examples = schema.examples -%}
{%- if examples -%}
{% include "section_examples.html" %}
{%- endif -%}

{# Properties, pattern properties, additional properties #}
{%- for sub_property in schema.iterate_properties -%}
{# Custom modification to remove $ properties from documentation #}
{%- if not sub_property.property_display_name.startswith("$") -%}
{% include "section_properties.html" %}
{%- endif -%}
{%- endfor -%}
{%- endif -%}
{%- endmacro -%}
4 changes: 2 additions & 2 deletions docgen/json/templates/cyclonedx/schema_doc.js
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ function setAnchor(anchorLinkDestination) {

function anchorOnLoad() {
// Added to onload on body, checks if there is an anchor link and if so, expand
let linkTarget = window.location.hash.split("?")[0].split("&")[0];
let linkTarget = decodeURIComponent(window.location.hash.split("?")[0].split("&")[0]);
if (linkTarget[0] === "#") {
linkTarget = linkTarget.substr(1);
}
Expand All @@ -37,7 +37,7 @@ function anchorLink(linkTarget) {
if($( this ).hasClass("collapse")) {
$( this ).collapse("show");
} else if ($( this ).hasClass("tab-pane")) {
// We have the pane and not the the tab itself, find the tab
// We have the pane and not the tab itself, find the tab
const tabToShow = $( "a[href='#" + $( this ).attr("id") + "']" );
if (tabToShow) {
tabToShow.tab("show");
Expand Down
2 changes: 1 addition & 1 deletion docgen/json/templates/cyclonedx/schema_doc.min.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading