mirror of
https://github.com/gocsaf/csaf.git
synced 2025-12-22 11:55:40 +01:00
Merge branch 'main' into sha-handling
This commit is contained in:
commit
1d1c5698da
16 changed files with 308 additions and 72 deletions
8
.github/workflows/itest.yml
vendored
8
.github/workflows/itest.yml
vendored
|
|
@ -7,9 +7,9 @@ jobs:
|
||||||
steps:
|
steps:
|
||||||
|
|
||||||
- name: Set up Go
|
- name: Set up Go
|
||||||
uses: actions/setup-go@v3
|
uses: actions/setup-go@v5
|
||||||
with:
|
with:
|
||||||
go-version: 1.22.0
|
go-version: '^1.23.6'
|
||||||
|
|
||||||
- name: Set up Node.js
|
- name: Set up Node.js
|
||||||
uses: actions/setup-node@v3
|
uses: actions/setup-node@v3
|
||||||
|
|
@ -17,7 +17,7 @@ jobs:
|
||||||
node-version: 16
|
node-version: 16
|
||||||
|
|
||||||
- name: Checkout
|
- name: Checkout
|
||||||
uses: actions/checkout@v3
|
uses: actions/checkout@v4
|
||||||
|
|
||||||
- name: Execute the scripts
|
- name: Execute the scripts
|
||||||
run: |
|
run: |
|
||||||
|
|
@ -36,7 +36,7 @@ jobs:
|
||||||
shell: bash
|
shell: bash
|
||||||
|
|
||||||
- name: Upload test results
|
- name: Upload test results
|
||||||
uses: actions/upload-artifact@v3
|
uses: actions/upload-artifact@v4
|
||||||
with:
|
with:
|
||||||
name: checker-results
|
name: checker-results
|
||||||
path: |
|
path: |
|
||||||
|
|
|
||||||
10
.github/workflows/release.yml
vendored
10
.github/workflows/release.yml
vendored
|
|
@ -7,23 +7,23 @@ on:
|
||||||
jobs:
|
jobs:
|
||||||
releases-matrix:
|
releases-matrix:
|
||||||
name: Release Go binaries
|
name: Release Go binaries
|
||||||
runs-on: ubuntu-20.04
|
runs-on: ubuntu-22.04
|
||||||
permissions:
|
permissions:
|
||||||
contents: write
|
contents: write
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout
|
- name: Checkout
|
||||||
uses: actions/checkout@v3
|
uses: actions/checkout@v4
|
||||||
|
|
||||||
- name: Set up Go
|
- name: Set up Go
|
||||||
uses: actions/setup-go@v3
|
uses: actions/setup-go@v5
|
||||||
with:
|
with:
|
||||||
go-version: '^1.21.0'
|
go-version: '^1.23.6'
|
||||||
|
|
||||||
- name: Build
|
- name: Build
|
||||||
run: make dist
|
run: make dist
|
||||||
|
|
||||||
- name: Upload release assets
|
- name: Upload release assets
|
||||||
uses: softprops/action-gh-release@v1
|
uses: softprops/action-gh-release@v2
|
||||||
with:
|
with:
|
||||||
files: |
|
files: |
|
||||||
dist/csaf-*.zip
|
dist/csaf-*.zip
|
||||||
|
|
|
||||||
73
LICENSE-Apache-2.0.txt
Normal file
73
LICENSE-Apache-2.0.txt
Normal file
|
|
@ -0,0 +1,73 @@
|
||||||
|
Apache License
|
||||||
|
Version 2.0, January 2004
|
||||||
|
http://www.apache.org/licenses/
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||||
|
|
||||||
|
1. Definitions.
|
||||||
|
|
||||||
|
"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.
|
||||||
|
|
||||||
|
"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
|
||||||
|
|
||||||
|
"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
|
||||||
|
|
||||||
|
"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.
|
||||||
|
|
||||||
|
"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.
|
||||||
|
|
||||||
|
"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.
|
||||||
|
|
||||||
|
"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).
|
||||||
|
|
||||||
|
"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.
|
||||||
|
|
||||||
|
"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."
|
||||||
|
|
||||||
|
"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.
|
||||||
|
|
||||||
|
2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.
|
||||||
|
|
||||||
|
3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.
|
||||||
|
|
||||||
|
4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:
|
||||||
|
|
||||||
|
(a) You must give any other recipients of the Work or Derivative Works a copy of this License; and
|
||||||
|
|
||||||
|
(b) You must cause any modified files to carry prominent notices stating that You changed the files; and
|
||||||
|
|
||||||
|
(c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and
|
||||||
|
|
||||||
|
(d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.
|
||||||
|
|
||||||
|
You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.
|
||||||
|
|
||||||
|
5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.
|
||||||
|
|
||||||
|
6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.
|
||||||
|
|
||||||
|
7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.
|
||||||
|
|
||||||
|
8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.
|
||||||
|
|
||||||
|
9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
APPENDIX: How to apply the Apache License to your work.
|
||||||
|
|
||||||
|
To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives.
|
||||||
|
|
||||||
|
Copyright [yyyy] [name of copyright owner]
|
||||||
|
|
||||||
|
Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
you may not use this file except in compliance with the License.
|
||||||
|
You may obtain a copy of the License at
|
||||||
|
|
||||||
|
http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
|
||||||
|
Unless required by applicable law or agreed to in writing, software
|
||||||
|
distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
See the License for the specific language governing permissions and
|
||||||
|
limitations under the License.
|
||||||
|
|
@ -20,7 +20,7 @@
|
||||||
|
|
||||||
# csaf
|
# csaf
|
||||||
|
|
||||||
Implements a [CSAF](https://csaf.io/)
|
Implements a [CSAF](https://oasis-open.github.io/csaf-documentation/)
|
||||||
([specification v2.0](https://docs.oasis-open.org/csaf/csaf/v2.0/os/csaf-v2.0-os.html)
|
([specification v2.0](https://docs.oasis-open.org/csaf/csaf/v2.0/os/csaf-v2.0-os.html)
|
||||||
and its [errata](https://docs.oasis-open.org/csaf/csaf/v2.0/csaf-v2.0.html))
|
and its [errata](https://docs.oasis-open.org/csaf/csaf/v2.0/csaf-v2.0.html))
|
||||||
trusted provider, checker, aggregator and downloader.
|
trusted provider, checker, aggregator and downloader.
|
||||||
|
|
@ -79,7 +79,7 @@ Download the binaries from the most recent release assets on Github.
|
||||||
|
|
||||||
### Build from sources
|
### Build from sources
|
||||||
|
|
||||||
- A recent version of **Go** (1.22+) should be installed. [Go installation](https://go.dev/doc/install)
|
- A recent version of **Go** (1.23+) should be installed. [Go installation](https://go.dev/doc/install)
|
||||||
|
|
||||||
- Clone the repository `git clone https://github.com/gocsaf/csaf.git `
|
- Clone the repository `git clone https://github.com/gocsaf/csaf.git `
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -284,6 +284,7 @@ func (c *config) httpClient(p *provider) util.Client {
|
||||||
|
|
||||||
hClient.Transport = &http.Transport{
|
hClient.Transport = &http.Transport{
|
||||||
TLSClientConfig: &tlsConfig,
|
TLSClientConfig: &tlsConfig,
|
||||||
|
Proxy: http.ProxyFromEnvironment,
|
||||||
}
|
}
|
||||||
|
|
||||||
client := util.Client(&hClient)
|
client := util.Client(&hClient)
|
||||||
|
|
|
||||||
|
|
@ -423,6 +423,7 @@ func (p *processor) fullClient() util.Client {
|
||||||
|
|
||||||
hClient.Transport = &http.Transport{
|
hClient.Transport = &http.Transport{
|
||||||
TLSClientConfig: &tlsConfig,
|
TLSClientConfig: &tlsConfig,
|
||||||
|
Proxy: http.ProxyFromEnvironment,
|
||||||
}
|
}
|
||||||
|
|
||||||
client := util.Client(&hClient)
|
client := util.Client(&hClient)
|
||||||
|
|
@ -453,6 +454,7 @@ func (p *processor) basicClient() *http.Client {
|
||||||
if p.cfg.Insecure {
|
if p.cfg.Insecure {
|
||||||
tr := &http.Transport{
|
tr := &http.Transport{
|
||||||
TLSClientConfig: &tls.Config{InsecureSkipVerify: true},
|
TLSClientConfig: &tls.Config{InsecureSkipVerify: true},
|
||||||
|
Proxy: http.ProxyFromEnvironment,
|
||||||
}
|
}
|
||||||
return &http.Client{Transport: tr}
|
return &http.Client{Transport: tr}
|
||||||
}
|
}
|
||||||
|
|
@ -1352,47 +1354,52 @@ func (p *processor) checkSecurityFolder(folder string) string {
|
||||||
|
|
||||||
// checkDNS checks if the "csaf.data.security.domain.tld" DNS record is available
|
// checkDNS checks if the "csaf.data.security.domain.tld" DNS record is available
|
||||||
// and serves the "provider-metadata.json".
|
// and serves the "provider-metadata.json".
|
||||||
// It returns an empty string if all checks are passed, otherwise the errormessage.
|
func (p *processor) checkDNS(domain string) {
|
||||||
func (p *processor) checkDNS(domain string) string {
|
p.badDNSPath.use()
|
||||||
client := p.httpClient()
|
client := p.httpClient()
|
||||||
path := "https://csaf.data.security." + domain
|
path := "https://csaf.data.security." + domain
|
||||||
res, err := client.Get(path)
|
res, err := client.Get(path)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Sprintf("Fetching %s failed: %v", path, err)
|
p.badDNSPath.add(ErrorType,
|
||||||
|
fmt.Sprintf("Fetching %s failed: %v", path, err))
|
||||||
|
return
|
||||||
}
|
}
|
||||||
if res.StatusCode != http.StatusOK {
|
if res.StatusCode != http.StatusOK {
|
||||||
return fmt.Sprintf("Fetching %s failed. Status code %d (%s)",
|
p.badDNSPath.add(ErrorType, fmt.Sprintf("Fetching %s failed. Status code %d (%s)",
|
||||||
path, res.StatusCode, res.Status)
|
path, res.StatusCode, res.Status))
|
||||||
}
|
}
|
||||||
hash := sha256.New()
|
hash := sha256.New()
|
||||||
defer res.Body.Close()
|
defer res.Body.Close()
|
||||||
content, err := io.ReadAll(res.Body)
|
content, err := io.ReadAll(res.Body)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Sprintf("Error while reading the response from %s", path)
|
p.badDNSPath.add(ErrorType,
|
||||||
|
fmt.Sprintf("Error while reading the response from %s", path))
|
||||||
}
|
}
|
||||||
hash.Write(content)
|
hash.Write(content)
|
||||||
if !bytes.Equal(hash.Sum(nil), p.pmd256) {
|
if !bytes.Equal(hash.Sum(nil), p.pmd256) {
|
||||||
return fmt.Sprintf("%s does not serve the same provider-metadata.json as previously found", path)
|
p.badDNSPath.add(ErrorType,
|
||||||
|
fmt.Sprintf("%s does not serve the same provider-metadata.json as previously found",
|
||||||
|
path))
|
||||||
}
|
}
|
||||||
return ""
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// checkWellknownMetadataReporter checks if the provider-metadata.json file is
|
// checkWellknown checks if the provider-metadata.json file is
|
||||||
// available under the /.well-known/csaf/ directory. Returns the errormessage if
|
// available under the /.well-known/csaf/ directory.
|
||||||
// an error was encountered, or an empty string otherwise
|
func (p *processor) checkWellknown(domain string) {
|
||||||
func (p *processor) checkWellknown(domain string) string {
|
|
||||||
|
p.badWellknownMetadata.use()
|
||||||
client := p.httpClient()
|
client := p.httpClient()
|
||||||
path := "https://" + domain + "/.well-known/csaf/provider-metadata.json"
|
path := "https://" + domain + "/.well-known/csaf/provider-metadata.json"
|
||||||
|
|
||||||
res, err := client.Get(path)
|
res, err := client.Get(path)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Sprintf("Fetching %s failed: %v", path, err)
|
p.badWellknownMetadata.add(ErrorType,
|
||||||
|
fmt.Sprintf("Fetching %s failed: %v", path, err))
|
||||||
}
|
}
|
||||||
if res.StatusCode != http.StatusOK {
|
if res.StatusCode != http.StatusOK {
|
||||||
return fmt.Sprintf("Fetching %s failed. Status code %d (%s)",
|
p.badWellknownMetadata.add(ErrorType, fmt.Sprintf("Fetching %s failed. Status code %d (%s)",
|
||||||
path, res.StatusCode, res.Status)
|
path, res.StatusCode, res.Status))
|
||||||
}
|
}
|
||||||
return ""
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// checkWellknownSecurityDNS
|
// checkWellknownSecurityDNS
|
||||||
|
|
@ -1404,56 +1411,41 @@ func (p *processor) checkWellknown(domain string) string {
|
||||||
// 4. Finally it checks if the "csaf.data.security.domain.tld" DNS record
|
// 4. Finally it checks if the "csaf.data.security.domain.tld" DNS record
|
||||||
// is available and serves the "provider-metadata.json".
|
// is available and serves the "provider-metadata.json".
|
||||||
//
|
//
|
||||||
// /
|
// For the security.txt checks, it first checks the default location.
|
||||||
// If all three checks fail, errors are given,
|
// Should this lookup fail, a warning is will be given and a lookup
|
||||||
// otherwise warnings for all failed checks.
|
// for the legacy location will be made. If this fails as well, then an
|
||||||
// The function returns nil, unless errors outside the checks were found.
|
// error is given.
|
||||||
// In that case, errors are returned.
|
|
||||||
func (p *processor) checkWellknownSecurityDNS(domain string) error {
|
func (p *processor) checkWellknownSecurityDNS(domain string) error {
|
||||||
warningsW := p.checkWellknown(domain)
|
p.checkWellknown(domain)
|
||||||
// Security check for well known (default) and legacy location
|
// Security check for well known (default) and legacy location
|
||||||
warningsS, sDMessage := p.checkSecurity(domain, false)
|
warnings, sDMessage := p.checkSecurity(domain, false)
|
||||||
// if the security.txt under .well-known was not okay
|
// if the security.txt under .well-known was not okay
|
||||||
// check for a security.txt within its legacy location
|
// check for a security.txt within its legacy location
|
||||||
sLMessage := ""
|
sLMessage := ""
|
||||||
if warningsS == 1 {
|
if warnings == 1 {
|
||||||
warningsS, sLMessage = p.checkSecurity(domain, true)
|
warnings, sLMessage = p.checkSecurity(domain, true)
|
||||||
}
|
}
|
||||||
warningsD := p.checkDNS(domain)
|
|
||||||
|
|
||||||
p.badWellknownMetadata.use()
|
|
||||||
p.badSecurity.use()
|
p.badSecurity.use()
|
||||||
p.badDNSPath.use()
|
|
||||||
|
|
||||||
var kind MessageType
|
// Report about Securitytxt:
|
||||||
if warningsS != 1 || warningsD == "" || warningsW == "" {
|
// Only report about default location if it was succesful (0).
|
||||||
kind = WarnType
|
// Report default and legacy as errors if neither was succesful (1).
|
||||||
} else {
|
// Warn about missing security in the default position if not found
|
||||||
kind = ErrorType
|
// but found in the legacy location, and inform about finding it there (2).
|
||||||
|
switch warnings {
|
||||||
|
case 0:
|
||||||
|
p.badSecurity.add(InfoType, sDMessage)
|
||||||
|
case 1:
|
||||||
|
p.badSecurity.add(ErrorType, sDMessage)
|
||||||
|
p.badSecurity.add(ErrorType, sLMessage)
|
||||||
|
case 2:
|
||||||
|
p.badSecurity.add(WarnType, sDMessage)
|
||||||
|
p.badSecurity.add(InfoType, sLMessage)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Info, Warning or Error depending on kind and warningS
|
p.checkDNS(domain)
|
||||||
kindSD := kind
|
|
||||||
if warningsS == 0 {
|
|
||||||
kindSD = InfoType
|
|
||||||
}
|
|
||||||
kindSL := kind
|
|
||||||
if warningsS == 2 {
|
|
||||||
kindSL = InfoType
|
|
||||||
}
|
|
||||||
|
|
||||||
if warningsW != "" {
|
|
||||||
p.badWellknownMetadata.add(kind, warningsW)
|
|
||||||
}
|
|
||||||
p.badSecurity.add(kindSD, sDMessage)
|
|
||||||
// only if the well-known security.txt was not successful:
|
|
||||||
// report about the legacy location
|
|
||||||
if warningsS != 0 {
|
|
||||||
p.badSecurity.add(kindSL, sLMessage)
|
|
||||||
}
|
|
||||||
if warningsD != "" {
|
|
||||||
p.badDNSPath.add(kind, warningsD)
|
|
||||||
}
|
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -178,7 +178,7 @@ func (r *tlpAmberRedReporter) report(p *processor, domain *Domain) {
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
if len(p.badAmberRedPermissions) == 0 {
|
if len(p.badAmberRedPermissions) == 0 {
|
||||||
req.message(InfoType, "All tested advisories labeled TLP:WHITE or TLP:RED were access-protected.")
|
req.message(InfoType, "All tested advisories labeled TLP:AMBER or TLP:RED were access-protected.")
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
req.Messages = p.badAmberRedPermissions
|
req.Messages = p.badAmberRedPermissions
|
||||||
|
|
|
||||||
|
|
@ -128,6 +128,7 @@ func (d *downloader) httpClient() util.Client {
|
||||||
|
|
||||||
hClient.Transport = &http.Transport{
|
hClient.Transport = &http.Transport{
|
||||||
TLSClientConfig: &tlsConfig,
|
TLSClientConfig: &tlsConfig,
|
||||||
|
Proxy: http.ProxyFromEnvironment,
|
||||||
}
|
}
|
||||||
|
|
||||||
client := util.Client(&hClient)
|
client := util.Client(&hClient)
|
||||||
|
|
|
||||||
|
|
@ -106,6 +106,7 @@ func (f *forwarder) httpClient() util.Client {
|
||||||
|
|
||||||
hClient.Transport = &http.Transport{
|
hClient.Transport = &http.Transport{
|
||||||
TLSClientConfig: &tlsConfig,
|
TLSClientConfig: &tlsConfig,
|
||||||
|
Proxy: http.ProxyFromEnvironment,
|
||||||
}
|
}
|
||||||
|
|
||||||
client := util.Client(&hClient)
|
client := util.Client(&hClient)
|
||||||
|
|
|
||||||
|
|
@ -174,7 +174,7 @@ func (c *controller) web(
|
||||||
// writeJSON sets the header for the response and writes the JSON encoding of the given "content".
|
// writeJSON sets the header for the response and writes the JSON encoding of the given "content".
|
||||||
// It logs out an error message in case of an error.
|
// It logs out an error message in case of an error.
|
||||||
func writeJSON(rw http.ResponseWriter, content any, code int) {
|
func writeJSON(rw http.ResponseWriter, content any, code int) {
|
||||||
rw.Header().Set("Content-type", "application/json; charset=utf-8")
|
rw.Header().Set("Content-type", "application/json")
|
||||||
rw.Header().Set("X-Content-Type-Options", "nosniff")
|
rw.Header().Set("X-Content-Type-Options", "nosniff")
|
||||||
rw.WriteHeader(code)
|
rw.WriteHeader(code)
|
||||||
if err := json.NewEncoder(rw).Encode(content); err != nil {
|
if err := json.NewEncoder(rw).Encode(content); err != nil {
|
||||||
|
|
|
||||||
|
|
@ -51,6 +51,7 @@ func (p *processor) httpClient() *http.Client {
|
||||||
|
|
||||||
client.Transport = &http.Transport{
|
client.Transport = &http.Transport{
|
||||||
TLSClientConfig: &tlsConfig,
|
TLSClientConfig: &tlsConfig,
|
||||||
|
Proxy: http.ProxyFromEnvironment,
|
||||||
}
|
}
|
||||||
|
|
||||||
return &client
|
return &client
|
||||||
|
|
|
||||||
|
|
@ -22,6 +22,13 @@ import (
|
||||||
"github.com/gocsaf/csaf/v3/util"
|
"github.com/gocsaf/csaf/v3/util"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
const (
|
||||||
|
exitCodeSchemaInvalid = 2 << iota
|
||||||
|
exitCodeNoRemoteValidator
|
||||||
|
exitCodeFailedRemoteValidation
|
||||||
|
exitCodeAllValid = 0
|
||||||
|
)
|
||||||
|
|
||||||
type options struct {
|
type options struct {
|
||||||
Version bool `long:"version" description:"Display version of the binary"`
|
Version bool `long:"version" description:"Display version of the binary"`
|
||||||
RemoteValidator string `long:"validator" description:"URL to validate documents remotely" value-name:"URL"`
|
RemoteValidator string `long:"validator" description:"URL to validate documents remotely" value-name:"URL"`
|
||||||
|
|
@ -53,6 +60,7 @@ func main() {
|
||||||
|
|
||||||
// run validates the given files.
|
// run validates the given files.
|
||||||
func run(opts *options, files []string) error {
|
func run(opts *options, files []string) error {
|
||||||
|
exitCode := exitCodeAllValid
|
||||||
|
|
||||||
var validator csaf.RemoteValidator
|
var validator csaf.RemoteValidator
|
||||||
eval := util.NewPathEval()
|
eval := util.NewPathEval()
|
||||||
|
|
@ -69,6 +77,9 @@ func run(opts *options, files []string) error {
|
||||||
"preparing remote validator failed: %w", err)
|
"preparing remote validator failed: %w", err)
|
||||||
}
|
}
|
||||||
defer validator.Close()
|
defer validator.Close()
|
||||||
|
} else {
|
||||||
|
exitCode |= exitCodeNoRemoteValidator
|
||||||
|
log.Printf("warn: no remote validator specified")
|
||||||
}
|
}
|
||||||
|
|
||||||
// Select amount level of output for remote validation.
|
// Select amount level of output for remote validation.
|
||||||
|
|
@ -96,7 +107,7 @@ func run(opts *options, files []string) error {
|
||||||
log.Printf("error: loading %q as JSON failed: %v\n", file, err)
|
log.Printf("error: loading %q as JSON failed: %v\n", file, err)
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
// Validate agsinst Schema.
|
// Validate against Schema.
|
||||||
validationErrs, err := csaf.ValidateCSAF(doc)
|
validationErrs, err := csaf.ValidateCSAF(doc)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
log.Printf("error: validating %q against schema failed: %v\n",
|
log.Printf("error: validating %q against schema failed: %v\n",
|
||||||
|
|
@ -104,6 +115,7 @@ func run(opts *options, files []string) error {
|
||||||
|
|
||||||
}
|
}
|
||||||
if len(validationErrs) > 0 {
|
if len(validationErrs) > 0 {
|
||||||
|
exitCode |= exitCodeSchemaInvalid
|
||||||
fmt.Printf("schema validation errors of %q\n", file)
|
fmt.Printf("schema validation errors of %q\n", file)
|
||||||
for _, vErr := range validationErrs {
|
for _, vErr := range validationErrs {
|
||||||
fmt.Printf(" * %s\n", vErr)
|
fmt.Printf(" * %s\n", vErr)
|
||||||
|
|
@ -112,10 +124,9 @@ func run(opts *options, files []string) error {
|
||||||
fmt.Printf("%q passes the schema validation.\n", file)
|
fmt.Printf("%q passes the schema validation.\n", file)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Check filename agains ID
|
// Check filename against ID
|
||||||
if err := util.IDMatchesFilename(eval, doc, filepath.Base(file)); err != nil {
|
if err := util.IDMatchesFilename(eval, doc, filepath.Base(file)); err != nil {
|
||||||
log.Printf("%s: %s.\n", file, err)
|
log.Printf("%s: %s.\n", file, err)
|
||||||
continue
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// Validate against remote validator.
|
// Validate against remote validator.
|
||||||
|
|
@ -130,12 +141,15 @@ func run(opts *options, files []string) error {
|
||||||
if rvr.Valid {
|
if rvr.Valid {
|
||||||
passes = "passes"
|
passes = "passes"
|
||||||
} else {
|
} else {
|
||||||
|
exitCode |= exitCodeFailedRemoteValidation
|
||||||
passes = "does not pass"
|
passes = "does not pass"
|
||||||
}
|
}
|
||||||
fmt.Printf("%q %s remote validation.\n", file, passes)
|
fmt.Printf("%q %s remote validation.\n", file, passes)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Exit code is based on validation results
|
||||||
|
os.Exit(exitCode)
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -3,7 +3,7 @@
|
||||||
## Supported Go versions
|
## Supported Go versions
|
||||||
|
|
||||||
We support the latest version and the one before
|
We support the latest version and the one before
|
||||||
the latest version of Go (currently 1.22 and 1.23).
|
the latest version of Go (currently 1.23 and 1.24).
|
||||||
|
|
||||||
## Generated files
|
## Generated files
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,6 +2,16 @@
|
||||||
|
|
||||||
is a tool to validate local advisories files against the JSON Schema and an optional remote validator.
|
is a tool to validate local advisories files against the JSON Schema and an optional remote validator.
|
||||||
|
|
||||||
|
### Exit codes
|
||||||
|
|
||||||
|
If no fatal error occurs the program will exit with an exit code `n` with the following conditions:
|
||||||
|
|
||||||
|
- `n == 0`: all valid
|
||||||
|
- `(n & 1) > 0`: a general error occurred, all other flags are unset (see logs for more information)
|
||||||
|
- `(n & 2) > 0`: schema validation failed
|
||||||
|
- `(n & 4) > 0`: no remote validator configured
|
||||||
|
- `(n & 8) > 0`: failure in remote validation
|
||||||
|
|
||||||
### Usage
|
### Usage
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
|
||||||
|
|
@ -5,7 +5,9 @@ calls it a *CSAF publisher*.
|
||||||
|
|
||||||
After manually downloading the advisories from such a publisher,
|
After manually downloading the advisories from such a publisher,
|
||||||
the tools here can be used to offer the CSAF files for automated downloading
|
the tools here can be used to offer the CSAF files for automated downloading
|
||||||
as *CSAF aggregator*. (The construct is called *CSAF proxy provider*. See [Section 7.2.5](https://docs.oasis-open.org/csaf/csaf/v2.0/csaf-v2.0.html#725-role-csaf-aggregator) for more details.)
|
as *CSAF aggregator*. (The construct is called *CSAF proxy provider*.
|
||||||
|
See [Section 7.2.5](https://docs.oasis-open.org/csaf/csaf/v2.0/os/csaf-v2.0-os.html#725-role-csaf-aggregator)
|
||||||
|
for more details.)
|
||||||
|
|
||||||
There are three necessary steps, easiest is to use
|
There are three necessary steps, easiest is to use
|
||||||
one single virtual maschine (or container) per internal provider.
|
one single virtual maschine (or container) per internal provider.
|
||||||
|
|
|
||||||
141
examples/product_lister/main.go
Normal file
141
examples/product_lister/main.go
Normal file
|
|
@ -0,0 +1,141 @@
|
||||||
|
// Package main implements a simple demo program to
|
||||||
|
// work with the csaf library.
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"flag"
|
||||||
|
"fmt"
|
||||||
|
"log"
|
||||||
|
"os"
|
||||||
|
|
||||||
|
"github.com/gocsaf/csaf/v3/csaf"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
flag.Usage = func() {
|
||||||
|
if _, err := fmt.Fprintf(flag.CommandLine.Output(),
|
||||||
|
"Usage:\n %s [OPTIONS] files...\n\nOptions:\n", os.Args[0]); err != nil {
|
||||||
|
log.Fatalf("error: %v\n", err)
|
||||||
|
}
|
||||||
|
flag.PrintDefaults()
|
||||||
|
}
|
||||||
|
printProductIdentHelper := flag.Bool("print_ident_helper", false, "print product helper mapping")
|
||||||
|
flag.Parse()
|
||||||
|
|
||||||
|
files := flag.Args()
|
||||||
|
if len(files) == 0 {
|
||||||
|
log.Println("No files given.")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
var printer func(*csaf.Advisory) error
|
||||||
|
if *printProductIdentHelper {
|
||||||
|
printer = printProductIdentHelperMapping
|
||||||
|
} else {
|
||||||
|
printer = printProductIDMapping
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := run(files, printer); err != nil {
|
||||||
|
log.Fatalf("error: %v\n", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// visitFullProductNames iterates all full product names in the advisory.
|
||||||
|
func visitFullProductNames(
|
||||||
|
adv *csaf.Advisory,
|
||||||
|
visit func(*csaf.FullProductName),
|
||||||
|
) {
|
||||||
|
// Iterate over all full product names
|
||||||
|
if fpns := adv.ProductTree.FullProductNames; fpns != nil {
|
||||||
|
for _, fpn := range *fpns {
|
||||||
|
if fpn != nil && fpn.ProductID != nil {
|
||||||
|
visit(fpn)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Iterate over branches recursively
|
||||||
|
var recBranch func(b *csaf.Branch)
|
||||||
|
recBranch = func(b *csaf.Branch) {
|
||||||
|
if b == nil {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if fpn := b.Product; fpn != nil && fpn.ProductID != nil {
|
||||||
|
visit(fpn)
|
||||||
|
|
||||||
|
}
|
||||||
|
for _, c := range b.Branches {
|
||||||
|
recBranch(c)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for _, b := range adv.ProductTree.Branches {
|
||||||
|
recBranch(b)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Iterate over relationships
|
||||||
|
if rels := adv.ProductTree.RelationShips; rels != nil {
|
||||||
|
for _, rel := range *rels {
|
||||||
|
if rel != nil {
|
||||||
|
if fpn := rel.FullProductName; fpn != nil && fpn.ProductID != nil {
|
||||||
|
visit(fpn)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// run applies fn to all loaded advisories.
|
||||||
|
func run(files []string, fn func(*csaf.Advisory) error) error {
|
||||||
|
for _, file := range files {
|
||||||
|
adv, err := csaf.LoadAdvisory(file)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("loading %q failed: %w", file, err)
|
||||||
|
}
|
||||||
|
if err := fn(adv); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// printJSON serializes v as indented JSON to stdout.
|
||||||
|
func printJSON(v any) error {
|
||||||
|
enc := json.NewEncoder(os.Stdout)
|
||||||
|
enc.SetIndent("", " ")
|
||||||
|
return enc.Encode(v)
|
||||||
|
}
|
||||||
|
|
||||||
|
// printProductIDMapping prints all product ids with their name and identification helper.
|
||||||
|
func printProductIDMapping(adv *csaf.Advisory) error {
|
||||||
|
type productNameHelperMapping struct {
|
||||||
|
FullProductName *csaf.FullProductName `json:"product"`
|
||||||
|
ProductIdentificationHelper *csaf.ProductIdentificationHelper `json:"product_identification_helper"`
|
||||||
|
}
|
||||||
|
|
||||||
|
productIDMap := map[csaf.ProductID][]productNameHelperMapping{}
|
||||||
|
visitFullProductNames(adv, func(fpn *csaf.FullProductName) {
|
||||||
|
productIDMap[*fpn.ProductID] = append(productIDMap[*fpn.ProductID], productNameHelperMapping{
|
||||||
|
FullProductName: fpn,
|
||||||
|
ProductIdentificationHelper: fpn.ProductIdentificationHelper,
|
||||||
|
})
|
||||||
|
})
|
||||||
|
return printJSON(productIDMap)
|
||||||
|
}
|
||||||
|
|
||||||
|
// printProductIdentHelperMapping prints all product identifier helper with their product id.
|
||||||
|
func printProductIdentHelperMapping(adv *csaf.Advisory) error {
|
||||||
|
type productIdentIDMapping struct {
|
||||||
|
ProductNameHelperMapping csaf.ProductIdentificationHelper `json:"product_identification_helper"`
|
||||||
|
ProductID *csaf.ProductID `json:"product_id"`
|
||||||
|
}
|
||||||
|
|
||||||
|
productIdentMap := []productIdentIDMapping{}
|
||||||
|
visitFullProductNames(adv, func(fpn *csaf.FullProductName) {
|
||||||
|
productIdentMap = append(productIdentMap, productIdentIDMapping{
|
||||||
|
ProductNameHelperMapping: *fpn.ProductIdentificationHelper,
|
||||||
|
ProductID: fpn.ProductID,
|
||||||
|
})
|
||||||
|
})
|
||||||
|
return printJSON(productIdentMap)
|
||||||
|
}
|
||||||
Loading…
Add table
Add a link
Reference in a new issue