github.com/google/osv-scalibr@v0.4.1/extractor/filesystem/os/nix/metadata/metadata.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 metadata defines a metadata struct for nix packages.
    16  package metadata
    17  
    18  import (
    19  	"github.com/google/osv-scalibr/log"
    20  
    21  	pb "github.com/google/osv-scalibr/binary/proto/scan_result_go_proto"
    22  )
    23  
    24  // Metadata holds parsing information for a nix package.
    25  type Metadata struct {
    26  	PackageName       string
    27  	PackageVersion    string
    28  	PackageHash       string
    29  	PackageOutput     string
    30  	OSID              string
    31  	OSVersionCodename string
    32  	OSVersionID       string
    33  }
    34  
    35  // ToDistro extracts the OS distro from the metadata.
    36  func (m *Metadata) ToDistro() string {
    37  	if m.OSVersionCodename != "" {
    38  		return m.OSVersionCodename
    39  	}
    40  
    41  	if m.OSVersionID != "" {
    42  		return m.OSVersionID
    43  	}
    44  
    45  	log.Errorf("VERSION_CODENAME and VERSION_ID not set in os-release")
    46  
    47  	return ""
    48  }
    49  
    50  // SetProto sets the NixPackageMetadata field in the Package proto.
    51  func (m *Metadata) SetProto(p *pb.Package) {
    52  	if m == nil {
    53  		return
    54  	}
    55  	if p == nil {
    56  		return
    57  	}
    58  
    59  	p.Metadata = &pb.Package_NixMetadata{
    60  		NixMetadata: &pb.NixPackageMetadata{
    61  			PackageName:       m.PackageName,
    62  			PackageVersion:    m.PackageVersion,
    63  			PackageHash:       m.PackageHash,
    64  			PackageOutput:     m.PackageOutput,
    65  			OsId:              m.OSID,
    66  			OsVersionCodename: m.OSVersionCodename,
    67  			OsVersionId:       m.OSVersionID,
    68  		},
    69  	}
    70  }
    71  
    72  // ToStruct converts the NixPackageMetadata proto to a Metadata struct.
    73  func ToStruct(m *pb.NixPackageMetadata) *Metadata {
    74  	if m == nil {
    75  		return nil
    76  	}
    77  
    78  	return &Metadata{
    79  		PackageName:       m.GetPackageName(),
    80  		PackageVersion:    m.GetPackageVersion(),
    81  		PackageHash:       m.GetPackageHash(),
    82  		PackageOutput:     m.GetPackageOutput(),
    83  		OSID:              m.GetOsId(),
    84  		OSVersionCodename: m.GetOsVersionCodename(),
    85  		OSVersionID:       m.GetOsVersionId(),
    86  	}
    87  }