Class: Bundler::Sbom::SPDX

Inherits:
Object
  • Object
show all
Defined in:
lib/bundler/sbom/spdx.rb

Class Method Summary collapse

Class Method Details

.add_element(parent, name, value) ⇒ Object 



210
211
212
213
214
 
# File 'lib/bundler/sbom/spdx.rb', line 210

def self.add_element(parent, name, value)
  element = REXML::Element.new(name)
  element.text = value
  parent.add_element(element)
end

.generate(lockfile, document_name) ⇒ Object 



8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/bundler/sbom/spdx.rb', line 8

def self.generate(lockfile, document_name)
  spdx_id = generate_spdx_id
  sbom = {
    "SPDXID" => "SPDXRef-DOCUMENT",
    "spdxVersion" => "SPDX-2.3",
    "creationInfo" => {
      "created" => Time.now.utc.strftime("%Y-%m-%dT%H:%M:%SZ"),
      "creators" => ["Tool: bundle-sbom"],
      "licenseListVersion" => "3.20"
    },
    "name" => document_name,
    "dataLicense" => "CC0-1.0",
    "documentNamespace" => "https://spdx.org/spdxdocs/#{document_name}-#{spdx_id}",
    "packages" => []
  }

  lockfile.specs.each do |spec|
    begin
      gemspec = Gem::Specification.find_by_name(spec.name, spec.version)
      licenses = []
      if gemspec
        if gemspec.license && !gemspec.license.empty?
          licenses << gemspec.license
        end
        if gemspec.licenses && !gemspec.licenses.empty?
          licenses.concat(gemspec.licenses)
        end
        licenses.uniq!
      end
      license_string = licenses.empty? ? "NOASSERTION" : licenses.join(", ")
    rescue Gem::LoadError
      license_string = "NOASSERTION"
    end

    package = {
      "SPDXID" => "SPDXRef-Package-#{spec.name}",
      "name" => spec.name,
      "versionInfo" => spec.version.to_s,
      "downloadLocation" => "NOASSERTION",
      "filesAnalyzed" => false,
      "licenseConcluded" => license_string,
      "licenseDeclared" => license_string,
      "copyrightText" => "NOASSERTION",
      "supplier" => "NOASSERTION",
      "externalRefs" => [
        {
          "referenceCategory" => "PACKAGE_MANAGER",
          "referenceType" => "purl",
          "referenceLocator" => "pkg:gem/#{spec.name}@#{spec.version}"
        }
      ]
    }
    sbom["packages"] << package
  end

  sbom["documentDescribes"] = sbom["packages"].map { |p| p["SPDXID"] }
  sbom
end

.generate_spdx_id ⇒ Object 



206
207
208
 
# File 'lib/bundler/sbom/spdx.rb', line 206

def self.generate_spdx_id
  SecureRandom.uuid
end

.get_element_text(element, xpath) ⇒ Object 



216
217
218
219
 
# File 'lib/bundler/sbom/spdx.rb', line 216

def self.get_element_text(element, xpath)
  result = REXML::XPath.first(element, xpath)
  result ? result.text : nil
end

.parse_xml(doc) ⇒ Object 



133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/bundler/sbom/spdx.rb', line 133

def self.parse_xml(doc)
  root = doc.root

  sbom = {
    "SPDXID" => get_element_text(root, "SPDXID"),
    "spdxVersion" => get_element_text(root, "spdxVersion"),
    "name" => get_element_text(root, "name"),
    "dataLicense" => get_element_text(root, "dataLicense"),
    "documentNamespace" => get_element_text(root, "documentNamespace"),
    "creationInfo" => {
      "created" => get_element_text(root, "creationInfo/created"),
      "licenseListVersion" => get_element_text(root, "creationInfo/licenseListVersion"),
      "creators" => []
    },
    "packages" => [],
    "documentDescribes" => []
  }

  # Collect creators
  REXML::XPath.each(root, "creationInfo/creator") do |creator|
    sbom["creationInfo"]["creators"] << creator.text
  end

  # Collect documentDescribes
  REXML::XPath.each(root, "documentDescribes") do |describes|
    sbom["documentDescribes"] << describes.text
  end

  # Collect packages
  REXML::XPath.each(root, "package") do |pkg_element|
    package = {
      "SPDXID" => get_element_text(pkg_element, "SPDXID"),
      "name" => get_element_text(pkg_element, "name"),
      "versionInfo" => get_element_text(pkg_element, "versionInfo"),
      "downloadLocation" => get_element_text(pkg_element, "downloadLocation"),
      "filesAnalyzed" => get_element_text(pkg_element, "filesAnalyzed") == "true",
      "licenseConcluded" => get_element_text(pkg_element, "licenseConcluded"),
      "licenseDeclared" => get_element_text(pkg_element, "licenseDeclared"),
      "copyrightText" => get_element_text(pkg_element, "copyrightText"),
      "supplier" => get_element_text(pkg_element, "supplier"),
      "externalRefs" => []
    }

    # Collect external references
    REXML::XPath.each(pkg_element, "externalRef") do |ref_element|
      ref = {
        "referenceCategory" => get_element_text(ref_element, "referenceCategory"),
        "referenceType" => get_element_text(ref_element, "referenceType"),
        "referenceLocator" => get_element_text(ref_element, "referenceLocator")
      }
      package["externalRefs"] << ref
    end

    sbom["packages"] << package
  end

  sbom
end

.to_report_format(sbom) ⇒ Object 



192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/bundler/sbom/spdx.rb', line 192

def self.to_report_format(sbom)
  # SPDXフォーマットは既にレポート形式と互換性があるため、
  # packagesセクションだけを抽出して返す
  {
    "packages" => sbom["packages"].map do |pkg|
      {
        "name" => pkg["name"],
        "versionInfo" => pkg["versionInfo"],
        "licenseDeclared" => pkg["licenseDeclared"]
      }
    end
  }
end

.to_xml(sbom) ⇒ Object 



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/bundler/sbom/spdx.rb', line 67

def self.to_xml(sbom)
  doc = REXML::Document.new
  doc << REXML::XMLDecl.new("1.0", "UTF-8")

  # Root element
  root = REXML::Element.new("SpdxDocument")
  root.add_namespace("https://spdx.org/spdxdocs/")
  doc.add_element(root)

  # Document info
  add_element(root, "SPDXID", sbom["SPDXID"])
  add_element(root, "spdxVersion", sbom["spdxVersion"])
  add_element(root, "name", sbom["name"])
  add_element(root, "dataLicense", sbom["dataLicense"])
  add_element(root, "documentNamespace", sbom["documentNamespace"])

  # Creation info
  creation_info = REXML::Element.new("creationInfo")
  root.add_element(creation_info)
  add_element(creation_info, "created", sbom["creationInfo"]["created"])
  add_element(creation_info, "licenseListVersion", sbom["creationInfo"]["licenseListVersion"])

  sbom["creationInfo"]["creators"].each do |creator|
    add_element(creation_info, "creator", creator)
  end

  # Describes
  sbom["documentDescribes"].each do |describes|
    add_element(root, "documentDescribes", describes)
  end

  # Packages
  sbom["packages"].each do |pkg|
    package = REXML::Element.new("package")
    root.add_element(package)

    add_element(package, "SPDXID", pkg["SPDXID"])
    add_element(package, "name", pkg["name"])
    add_element(package, "versionInfo", pkg["versionInfo"])
    add_element(package, "downloadLocation", pkg["downloadLocation"])
    add_element(package, "filesAnalyzed", pkg["filesAnalyzed"].to_s)
    add_element(package, "licenseConcluded", pkg["licenseConcluded"])
    add_element(package, "licenseDeclared", pkg["licenseDeclared"])
    add_element(package, "copyrightText", pkg["copyrightText"])
    add_element(package, "supplier", pkg["supplier"])

    # External references
    if pkg["externalRefs"]
      pkg["externalRefs"].each do |ref|
        ext_ref = REXML::Element.new("externalRef")
        package.add_element(ext_ref)

        add_element(ext_ref, "referenceCategory", ref["referenceCategory"])
        add_element(ext_ref, "referenceType", ref["referenceType"])
        add_element(ext_ref, "referenceLocator", ref["referenceLocator"])
      end
    end
  end

  formatter = REXML::Formatters::Pretty.new(2)
  formatter.compact = true
  output = ""
  formatter.write(doc, output)
  output.sub(%r{<\?xml version='1\.0' encoding='UTF-8'\?>}, '<?xml version="1.0" encoding="UTF-8"?>')
end