🎩 You're Invited:Meet the Socket team at Black Hat in Las Vegas, August 3-6.RSVP →
@secvisogram/csaf-validator-service
Advanced tools
@secvisogram/csaf-validator-service - npm Package Compare versions
@@ -32,4 +32,16 @@ import * as schemaTests from '@secvisogram/csaf-validator-lib/schemaTests.js' | ||
| const swaggerInfo = { | ||
| description: | ||
| "This endpoint is intended to validate a document against the specified tests. In the list of tests provide at least one object, where each object is used to run either a single test or an entire preset. For 'name' provide the test's or the preset's name, and as 'type' provide accordingly either 'test' or 'preset'. For the value of the property 'document' just provide the json of your CSAF document.", | ||
| description: `This endpoint validates a CSAF document against a selected set of tests. \ | ||
| In the 'tests' array, provide at least one entry. Each entry runs either a single named test (type 'test') or a named preset (type 'preset') that expands to a fixed group of tests. \ | ||
| Duplicate tests resulting from overlapping entries are automatically removed. | ||
| **Available presets and their contents:** | ||
| - \`schema\` – \`csaf_2_0\` and \`csaf_2_0_strict\` (JSON Schema validation; strict variant disallows additional properties) | ||
| - \`mandatory\` – all mandatory tests (section 6.1) | ||
| - \`optional\` – all optional tests (section 6.2) | ||
| - \`informative\` – all informative tests (section 6.3) | ||
| - \`basic\` – \`csaf_2_0_strict\` (JSON Schema validation: strict variant disallows additional properties) plus all mandatory tests (test 6.1.8 is already covered by the schema test and is excluded) | ||
| - \`extended\` – everything in \`basic\` plus all optional tests | ||
| - \`full\` – everything in \`extended\` plus all informative tests | ||
| Use \`GET /api/v1/tests\` to retrieve a list of all individual test names and the atomic preset each belongs to.`, | ||
| summary: 'Validate document.', | ||
@@ -42,2 +54,8 @@ } | ||
| required: ['document', 'tests'], | ||
| examples: [ | ||
| { | ||
| tests: [{ name: 'full', type: 'preset' }], | ||
| document: { document: { category: 'csaf_base', csaf_version: '2.0' } }, | ||
| }, | ||
| ], | ||
| properties: { | ||
@@ -44,0 +62,0 @@ tests: { |
| export const openApiInfo = /** @type {const} */ ({ | ||
| title: 'CSAF Validator Service', | ||
| version: '2.0.26', | ||
| version: '2.0.27', | ||
| description: | ||
@@ -5,0 +5,0 @@ 'This is a service to validate documents against the CSAF standard.', |
| = CSAF Validator Service | ||
| secvisogram@bsi.bund.de | ||
| 2.0.26 | ||
| 2.0.27 | ||
| :toc: left | ||
@@ -109,3 +109,3 @@ :numbered: | ||
| This endpoint is intended to validate a document against the specified tests. In the list of tests provide at least one object, where each object is used to run either a single test or an entire preset. For 'name' provide the test's or the preset's name, and as 'type' provide accordingly either 'test' or 'preset'. For the value of the property 'document' just provide the json of your CSAF document. | ||
| This endpoint validates a CSAF document against a selected set of tests. In the 'tests' array, provide at least one entry. Each entry runs either a single named test (type 'test') or a named preset (type 'preset') that expands to a fixed group of tests. Duplicate tests resulting from overlapping entries are automatically removed. **Available presets and their contents:** - `schema` – `csaf_2_0` and `csaf_2_0_strict` (JSON Schema validation; strict variant disallows additional properties) - `mandatory` – all mandatory tests (section 6.1) - `optional` – all optional tests (section 6.2) - `informative` – all informative tests (section 6.3) - `basic` – `csaf_2_0_strict` (JSON Schema validation: strict variant disallows additional properties) plus all mandatory tests (test 6.1.8 is already covered by the schema test and is excluded) - `extended` – everything in `basic` plus all optional tests - `full` – everything in `extended` plus all informative tests Use `GET /api/v1/tests` to retrieve a list of all individual test names and the atomic preset each belongs to. | ||
@@ -112,0 +112,0 @@ |
@@ -186,3 +186,3 @@ <!doctype html> | ||
| <div class="app-desc">Contact Info: <a href="secvisogram@bsi.bund.de">secvisogram@bsi.bund.de</a></div> | ||
| <div class="app-desc">Version: 2.0.26</div> | ||
| <div class="app-desc">Version: 2.0.27</div> | ||
| <div class="app-desc">BasePath:</div> | ||
@@ -254,3 +254,15 @@ <div class="license-info">MIT</div> | ||
| <div class="method-summary">Validate document. (<span class="nickname">apiV1ValidatePost</span>)</div> | ||
| <div class="method-notes">This endpoint is intended to validate a document against the specified tests. In the list of tests provide at least one object, where each object is used to run either a single test or an entire preset. For 'name' provide the test's or the preset's name, and as 'type' provide accordingly either 'test' or 'preset'. For the value of the property 'document' just provide the json of your CSAF document.</div> | ||
| <div class="method-notes"><p>This endpoint validates a CSAF document against a selected set of tests. In the 'tests' array, provide at least one entry. Each entry runs either a single named test (type 'test') or a named preset (type 'preset') that expands to a fixed group of tests. Duplicate tests resulting from overlapping entries are automatically removed.</p> | ||
| <p><strong>Available presets and their contents:</strong></p> | ||
| <ul> | ||
| <li><code>schema</code> – <code>csaf_2_0</code> and <code>csaf_2_0_strict</code> (JSON Schema validation; strict variant disallows additional properties)</li> | ||
| <li><code>mandatory</code> – all mandatory tests (section 6.1)</li> | ||
| <li><code>optional</code> – all optional tests (section 6.2)</li> | ||
| <li><code>informative</code> – all informative tests (section 6.3)</li> | ||
| <li><code>basic</code> – <code>csaf_2_0_strict</code> (JSON Schema validation: strict variant disallows additional properties) plus all mandatory tests (test 6.1.8 is already covered by the schema test and is excluded)</li> | ||
| <li><code>extended</code> – everything in <code>basic</code> plus all optional tests</li> | ||
| <li><code>full</code> – everything in <code>extended</code> plus all informative tests</li> | ||
| </ul> | ||
| <p>Use <code>GET /api/v1/tests</code> to retrieve a list of all individual test names and the atomic preset each belongs to.</p> | ||
| </div> | ||
@@ -257,0 +269,0 @@ |
+1
-1
@@ -40,3 +40,3 @@ { | ||
| }, | ||
| "version": "2.0.26" | ||
| "version": "2.0.27" | ||
| } |
Sorry, the diff of this file is too big to display
New alerts
Long strings
Supply chain riskContains long string literals, which may be a sign of obfuscated or packed code.
URL strings
Supply chain riskPackage contains fragments of external URLs or IP addresses, which the package may be accessing at runtime.
Fixed alerts
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
URL strings
Supply chain riskPackage contains fragments of external URLs or IP addresses, which the package may be accessing at runtime.
Improved metrics
- Total package byte prevSize
167866
1.65%- Lines of code
3086
0.82%- Number of medium supply chain risk alerts
1
-50%Worsened metrics
- Number of low supply chain risk alerts
4
33.33%No dependency changes