1
2
3
4
5
6
7
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
66
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
132
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
|
# frozen_string_literal: true
module Vulnerabilities
# The class is mimicking Vulnerabilites::Remediation
class Remediation < ApplicationRecord
include FileStoreMounter
include ShaAttribute
self.table_name = 'vulnerability_remediations'
sha_attribute :checksum
mount_file_store_uploader AttachmentUploader
def retrieve_upload(_identifier, paths)
Upload.find_by(model: self, path: paths)
end
end
end
module Gitlab
module BackgroundMigration
# The class to migrate the remediation data into their own records from the json attribute
class MigrateRemediationsForVulnerabilityFindings < BatchedMigrationJob
feature_category :vulnerability_management
operation_name :migrate_remediations_for_vulnerability_findings
# The class to encapsulate checksum and file for uploading
class DiffFile < StringIO
# This method is used by the `carrierwave` gem
def original_filename
@original_filename ||= self.class.original_filename(checksum)
end
def checksum
@checksum ||= self.class.checksum(string)
end
def self.checksum(value)
Digest::SHA256.hexdigest(value)
end
def self.original_filename(checksum)
"#{checksum}.diff"
end
end
# The class is mimicking Vulnerabilites::Finding
class Finding < ApplicationRecord
self.table_name = 'vulnerability_occurrences'
validates :details, json_schema: { filename: 'vulnerability_finding_details', draft: 7 }, if: false
end
# The class is mimicking Vulnerabilites::FindingRemediation
class FindingRemediation < ApplicationRecord
self.table_name = 'vulnerability_findings_remediations'
end
def perform
each_sub_batch do |sub_batch|
migrate_remediations(sub_batch)
end
end
private
def migrate_remediations(sub_batch)
sub_batch.each do |finding|
FindingRemediation.transaction do
remediations = append_remediations_diff_checksum(finding.raw_metadata)
result_ids = create_remediations(finding, remediations)
create_finding_remediations(finding.id, result_ids)
end
rescue StandardError => e
logger.error(
message: e.message,
class: self.class.name,
model_id: finding.id
)
end
end
def create_finding_remediations(finding_id, result_ids)
attrs = result_ids.map do |result_id|
build_finding_remediation_attrs(finding_id, result_id)
end
return unless attrs.present?
FindingRemediation.upsert_all(
attrs,
returning: false,
unique_by: [:vulnerability_occurrence_id, :vulnerability_remediation_id]
)
end
def create_remediations(finding, remediations)
attrs = remediations.map do |remediation|
build_remediation_attrs(finding, remediation)
end
return [] unless attrs.present?
ids_checksums = ::Vulnerabilities::Remediation.upsert_all(
attrs,
returning: %w[id checksum],
unique_by: [:project_id, :checksum]
)
ids_checksums.each do |id_checksum|
upload_file(id_checksum['id'], id_checksum['checksum'], remediations)
end
ids_checksums.pluck('id')
end
def upload_file(id, checksum, remediations)
deserialized_checksum = Gitlab::Database::ShaAttribute.new.deserialize(checksum)
diff = remediations.find { |rem| rem['checksum'] == deserialized_checksum }["diff"]
file = DiffFile.new(diff)
::Vulnerabilities::Remediation.find_by(id: id).update!(file: file)
end
def build_remediation_attrs(finding, remediation)
{
project_id: finding.project_id,
summary: remediation['summary'],
file: DiffFile.original_filename(remediation['checksum']),
checksum: remediation['checksum'],
created_at: Time.current,
updated_at: Time.current
}
end
def build_finding_remediation_attrs(finding_id, remediation_id)
{
vulnerability_occurrence_id: finding_id,
vulnerability_remediation_id: remediation_id,
created_at: Time.current,
updated_at: Time.current
}
end
def append_remediations_diff_checksum(metadata)
parsed_metadata = Gitlab::Json.parse(metadata)
return [] unless parsed_metadata['remediations']
parsed_metadata['remediations'].filter_map do |remediation|
next unless remediation && remediation['diff'].present?
remediation.merge('checksum' => DiffFile.checksum(remediation['diff']))
end.compact.uniq
end
def logger
@logger ||= ::Gitlab::AppLogger
end
end
end
end
|
