github.com/google/osv-scalibr@v0.4.1/binary/cdx/cdx.go (about)

     1  // Copyright 2025 Google LLC
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //      http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  // Package cdx provides utilities for writing CycloneDX documents to the filesystem.
    16  package cdx
    17  
    18  import (
    19  	"fmt"
    20  	"os"
    21  
    22  	"github.com/CycloneDX/cyclonedx-go"
    23  )
    24  
    25  // Write writes an CDX document into a file in the chosen format.
    26  func Write(doc *cyclonedx.BOM, path string, format string) error {
    27  	var cdxFormat cyclonedx.BOMFileFormat
    28  	switch format {
    29  	case "cdx-json":
    30  		cdxFormat = cyclonedx.BOMFileFormatJSON
    31  	case "cdx-xml":
    32  		cdxFormat = cyclonedx.BOMFileFormatXML
    33  	default:
    34  		return fmt.Errorf("%s has an invalid CDX format or not supported by SCALIBR", path)
    35  	}
    36  	f, err := os.Create(path)
    37  	if err != nil {
    38  		return err
    39  	}
    40  	defer f.Close()
    41  	encoder := cyclonedx.NewBOMEncoder(f, cdxFormat).SetPretty(true)
    42  	return encoder.Encode(doc)
    43  }