-
-
Notifications
You must be signed in to change notification settings - Fork 63
/
Copy pathCsvSerializer.cs
272 lines (262 loc) · 13.2 KB
/
CsvSerializer.cs
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
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
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
// This file is part of CycloneDX CLI Tool
//
// 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.
//
// SPDX-License-Identifier: Apache-2.0
// Copyright (c) OWASP Foundation. All Rights Reserved.
using System;
using System.Collections.Generic;
using System.Diagnostics.Contracts;
using System.Globalization;
using System.IO;
using System.Linq;
using System.Text;
using CsvHelper;
using CsvHelper.Configuration;
using CycloneDX.Models;
namespace CycloneDX.Cli.Serialization
{
public static class CsvSerializer
{
public static string Serialize(Bom bom)
{
Contract.Requires(bom != null);
using (var stream = new MemoryStream())
{
using (var writer = new StreamWriter(stream))
using (var csv = new CsvWriter(writer, CultureInfo.InvariantCulture))
{
csv.WriteField("Type");
csv.WriteField("MimeType");
csv.WriteField("Supplier");
csv.WriteField("Author");
csv.WriteField("Publisher");
csv.WriteField("Group");
csv.WriteField("Name");
csv.WriteField("Version");
csv.WriteField("Scope");
csv.WriteField("LicenseExpressions");
csv.WriteField("LicenseNames");
csv.WriteField("Copyright");
csv.WriteField("Cpe");
csv.WriteField("Purl");
csv.WriteField("Modified");
csv.WriteField("SwidTagId");
csv.WriteField("SwidName");
csv.WriteField("SwidVersion");
csv.WriteField("SwidTagVersion");
csv.WriteField("SwidPatch");
csv.WriteField("SwidTextContentType");
csv.WriteField("SwidTextEncoding");
csv.WriteField("SwidTextContent");
csv.WriteField("SwidUrl");
var hashAlgorithms = Enum.GetValues(typeof(Hash.HashAlgorithm)).Cast<Hash.HashAlgorithm>();
foreach (var hashAlgorithm in hashAlgorithms)
{
if (hashAlgorithm != Hash.HashAlgorithm.Null)
csv.WriteField(hashAlgorithm.ToString().Replace('_', '-'));
}
csv.WriteField("Description");
csv.NextRecord();
foreach (var c in bom.Components)
{
csv.WriteField(c.Type);
csv.WriteField(c.MimeType);
csv.WriteField(c.Supplier?.Name);
#pragma warning disable CS0618 // Type or member is obsolete
csv.WriteField(c.Author);
#pragma warning restore CS0618 // Type or member is obsolete
csv.WriteField(c.Publisher);
csv.WriteField(c.Group);
csv.WriteField(c.Name);
csv.WriteField(c.Version);
csv.WriteField(c.Scope.ToString().ToLowerInvariant());
var licenseExpressions = new List<string>();
var LicenseNames = new List<string>();
if (c.Licenses != null)
foreach (var license in c.Licenses)
{
if (!string.IsNullOrEmpty(license.Expression))
{
licenseExpressions.Add(license.Expression);
}
else
{
if (!string.IsNullOrEmpty(license.License?.Id))
{
licenseExpressions.Add(license.License?.Id);
}
else if (!string.IsNullOrEmpty(license.License?.Name))
{
LicenseNames.Add(license.License?.Name.Replace(',', '_'));
}
}
}
csv.WriteField(string.Join(',', licenseExpressions));
csv.WriteField(string.Join(',', LicenseNames));
csv.WriteField(c.Copyright);
csv.WriteField(c.Cpe);
csv.WriteField(c.Purl);
csv.WriteField(c.Modified);
csv.WriteField(c.Swid?.TagId);
csv.WriteField(c.Swid?.Name);
csv.WriteField(c.Swid?.Version);
csv.WriteField(c.Swid?.TagVersion);
csv.WriteField(c.Swid?.Patch);
csv.WriteField(c.Swid?.Text?.ContentType);
csv.WriteField(c.Swid?.Text?.Encoding);
csv.WriteField(c.Swid?.Text?.Content);
csv.WriteField(c.Swid?.Url);
foreach (var hashAlgorithm in hashAlgorithms)
{
if (hashAlgorithm != Hash.HashAlgorithm.Null)
csv.WriteField(c.Hashes?.Where(h => h.Alg == hashAlgorithm).FirstOrDefault<Hash>()?.Content);
}
csv.WriteField(c.Description?.Replace("\r", "", StringComparison.InvariantCulture).Replace("\n", "", StringComparison.InvariantCulture));
csv.NextRecord();
}
}
return Encoding.UTF8.GetString(stream.ToArray());
}
}
public static Bom Deserialize(string csv)
{
var csvConfig = new CsvConfiguration(CultureInfo.InvariantCulture)
{
MissingFieldFound = null,
PrepareHeaderForMatch = args => args.Header.ToLower(CultureInfo.InvariantCulture)
};
using (var stream = new MemoryStream(System.Text.Encoding.UTF8.GetBytes(csv)))
using (var reader = new StreamReader(stream))
using (var csvReader = new CsvReader(reader, csvConfig))
{
var bom = new Bom();
bom.Version = 1;
bom.Components = new List<Component>();
csvReader.Read();
csvReader.ReadHeader();
while (csvReader.Read())
{
#pragma warning disable CS0618 // Type or member is obsolete
var component = new Component
{
Type = csvReader.GetField<Component.Classification?>("Type") ?? Component.Classification.Library,
MimeType = csvReader.GetField("MimeType").NullIfWhiteSpace(),
// BomRef not supported
Supplier = new OrganizationalEntity
{
// additional supplier information not supported
Name = csvReader.GetField("Supplier").NullIfWhiteSpace()
},
Author = csvReader.GetField("Author").NullIfWhiteSpace(),
Publisher = csvReader.GetField("Publisher").NullIfWhiteSpace(),
Group = csvReader.GetField("Group").NullIfWhiteSpace(),
Name = csvReader.GetField("Name").NullIfWhiteSpace(),
Version = csvReader.GetField("Version").NullIfWhiteSpace(),
Description = csvReader.GetField("Description").NullIfWhiteSpace(),
Copyright = csvReader.GetField("Copyright").NullIfWhiteSpace(),
Cpe = csvReader.GetField("Cpe").NullIfWhiteSpace(),
Purl = csvReader.GetField("Purl").NullIfWhiteSpace(),
Swid = new Swid
{
TagId = csvReader.GetField("SwidTagId").NullIfWhiteSpace(),
Name = csvReader.GetField("SwidName").NullIfWhiteSpace(),
Version = csvReader.GetField("SwidVersion").NullIfWhiteSpace(),
TagVersion = csvReader.GetField<int?>("SwidTagVersion").GetValueOrDefault(),
Patch = csvReader.GetField<bool?>("SwidPatch").GetValueOrDefault(),
Text = new AttachedText
{
ContentType = csvReader.GetField("SwidTextContentType").NullIfWhiteSpace(),
Encoding = csvReader.GetField("SwidTextEncoding").NullIfWhiteSpace(),
Content = csvReader.GetField("SwidTextContent".NullIfWhiteSpace())
},
Url = csvReader.GetField("SwidUrl").NullIfWhiteSpace()
},
Modified= csvReader.GetField<bool?>("Modified"),
// pedigree not supported
// external references not supported
// sub-components not supported
};
#pragma warning restore CS0618 // Type or member is obsolete
if (component.Supplier.Name == null) component.Supplier = null;
if (component.Swid.Text.Content == null) component.Swid.Text = null;
if (component.Swid.TagId == null) component.Swid = null;
var scopeString = csvReader.GetField("Scope").NullIfWhiteSpace();
if (scopeString != null)
{
Component.ComponentScope scope;
var success = Enum.TryParse<Component.ComponentScope>(scopeString, ignoreCase: true, out scope);
if (success)
{
component.Scope = scope;
}
}
var hashAlgorithms = Enum.GetValues(typeof(Hash.HashAlgorithm)).Cast<Hash.HashAlgorithm>();
var hashes = new List<Hash>();
foreach (var hashAlgorithm in hashAlgorithms)
{
if (hashAlgorithm != Hash.HashAlgorithm.Null)
{
var hash = new Hash();
hash.Alg = hashAlgorithm;
hash.Content = csvReader.GetField(hashAlgorithm.ToString().Replace('_', '-'));
if (!string.IsNullOrEmpty(hash.Content)) hashes.Add(hash);
}
}
if (hashes.Any()) component.Hashes = hashes;
var componentLicenses = new List<LicenseChoice>();
var licenseExpressions = csvReader.GetField("LicenseExpressions")?.Split(',');
if (licenseExpressions != null)
foreach (var licenseExpressionString in licenseExpressions)
{
if (licenseExpressionString.Contains(' ', StringComparison.InvariantCulture)) // license expression
{
var componentLicense = new LicenseChoice
{
Expression = licenseExpressionString
};
componentLicenses.Add(componentLicense);
}
else if (!string.IsNullOrEmpty(licenseExpressionString)) // license ID
{
var componentLicense = new LicenseChoice
{
License = new License
{
Id = licenseExpressionString
}
};
componentLicenses.Add(componentLicense);
}
}
var licenseNames = csvReader.GetField("LicenseNames")?.Split(',');
if (licenseNames != null)
foreach (var licenseName in licenseNames)
{
if (!string.IsNullOrEmpty(licenseName))
componentLicenses.Add(new LicenseChoice
{
License = new License
{
Name = licenseName
}
});
}
if (componentLicenses.Any()) component.Licenses = componentLicenses;
bom.Components.Add(component);
}
return bom;
}
}
}
}