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
|
// SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
package parser2v2
import (
"fmt"
"strings"
"github.com/spdx/tools-golang/spdx"
)
func (parser *tvParser2_2) parsePairFromCreationInfo2_2(tag string, value string) error {
// fail if not in Creation Info parser state
if parser.st != psCreationInfo2_2 {
return fmt.Errorf("got invalid state %v in parsePairFromCreationInfo2_2", parser.st)
}
// create an SPDX Creation Info data struct if we don't have one already
if parser.doc.CreationInfo == nil {
parser.doc.CreationInfo = &spdx.CreationInfo2_2{
ExternalDocumentReferences: map[string]spdx.ExternalDocumentRef2_2{},
}
}
ci := parser.doc.CreationInfo
switch tag {
case "SPDXVersion":
ci.SPDXVersion = value
case "DataLicense":
ci.DataLicense = value
case "SPDXID":
eID, err := extractElementID(value)
if err != nil {
return err
}
ci.SPDXIdentifier = eID
case "DocumentName":
ci.DocumentName = value
case "DocumentNamespace":
ci.DocumentNamespace = value
case "ExternalDocumentRef":
documentRefID, uri, alg, checksum, err := extractExternalDocumentReference(value)
if err != nil {
return err
}
edr := spdx.ExternalDocumentRef2_2{
DocumentRefID: documentRefID,
URI: uri,
Alg: alg,
Checksum: checksum,
}
ci.ExternalDocumentReferences[documentRefID] = edr
case "LicenseListVersion":
ci.LicenseListVersion = value
case "Creator":
subkey, subvalue, err := extractSubs(value)
if err != nil {
return err
}
switch subkey {
case "Person":
ci.CreatorPersons = append(ci.CreatorPersons, subvalue)
case "Organization":
ci.CreatorOrganizations = append(ci.CreatorOrganizations, subvalue)
case "Tool":
ci.CreatorTools = append(ci.CreatorTools, subvalue)
default:
return fmt.Errorf("unrecognized Creator type %v", subkey)
}
case "Created":
ci.Created = value
case "CreatorComment":
ci.CreatorComment = value
case "DocumentComment":
ci.DocumentComment = value
// tag for going on to package section
case "PackageName":
// error if last file does not have an identifier
// this may be a null case: can we ever have a "last file" in
// the "creation info" state? should go on to "file" state
// even when parsing unpackaged files.
if parser.file != nil && parser.file.FileSPDXIdentifier == nullSpdxElementId2_2 {
return fmt.Errorf("file with FileName %s does not have SPDX identifier", parser.file.FileName)
}
parser.st = psPackage2_2
parser.pkg = &spdx.Package2_2{
FilesAnalyzed: true,
IsFilesAnalyzedTagPresent: false,
}
return parser.parsePairFromPackage2_2(tag, value)
// tag for going on to _unpackaged_ file section
case "FileName":
// leave pkg as nil, so that packages will be placed in UnpackagedFiles
parser.st = psFile2_2
parser.pkg = nil
return parser.parsePairFromFile2_2(tag, value)
// tag for going on to other license section
case "LicenseID":
parser.st = psOtherLicense2_2
return parser.parsePairFromOtherLicense2_2(tag, value)
// tag for going on to review section (DEPRECATED)
case "Reviewer":
parser.st = psReview2_2
return parser.parsePairFromReview2_2(tag, value)
// for relationship tags, pass along but don't change state
case "Relationship":
parser.rln = &spdx.Relationship2_2{}
parser.doc.Relationships = append(parser.doc.Relationships, parser.rln)
return parser.parsePairForRelationship2_2(tag, value)
case "RelationshipComment":
return parser.parsePairForRelationship2_2(tag, value)
// for annotation tags, pass along but don't change state
case "Annotator":
parser.ann = &spdx.Annotation2_2{}
parser.doc.Annotations = append(parser.doc.Annotations, parser.ann)
return parser.parsePairForAnnotation2_2(tag, value)
case "AnnotationDate":
return parser.parsePairForAnnotation2_2(tag, value)
case "AnnotationType":
return parser.parsePairForAnnotation2_2(tag, value)
case "SPDXREF":
return parser.parsePairForAnnotation2_2(tag, value)
case "AnnotationComment":
return parser.parsePairForAnnotation2_2(tag, value)
default:
return fmt.Errorf("received unknown tag %v in CreationInfo section", tag)
}
return nil
}
// ===== Helper functions =====
func extractExternalDocumentReference(value string) (string, string, string, string, error) {
sp := strings.Split(value, " ")
// remove any that are just whitespace
keepSp := []string{}
for _, s := range sp {
ss := strings.TrimSpace(s)
if ss != "" {
keepSp = append(keepSp, ss)
}
}
var documentRefID, uri, alg, checksum string
// now, should have 4 items (or 3, if Alg and Checksum were joined)
// and should be able to map them
if len(keepSp) == 4 {
documentRefID = keepSp[0]
uri = keepSp[1]
alg = keepSp[2]
// check that colon is present for alg, and remove it
if !strings.HasSuffix(alg, ":") {
return "", "", "", "", fmt.Errorf("algorithm does not end with colon")
}
alg = strings.TrimSuffix(alg, ":")
checksum = keepSp[3]
} else if len(keepSp) == 3 {
documentRefID = keepSp[0]
uri = keepSp[1]
// split on colon into alg and checksum
parts := strings.SplitN(keepSp[2], ":", 2)
if len(parts) != 2 {
return "", "", "", "", fmt.Errorf("missing colon separator between algorithm and checksum")
}
alg = parts[0]
checksum = parts[1]
} else {
return "", "", "", "", fmt.Errorf("expected 4 elements, got %d", len(keepSp))
}
// additionally, we should be able to parse the first element as a
// DocumentRef- ID string, and we should remove that prefix
if !strings.HasPrefix(documentRefID, "DocumentRef-") {
return "", "", "", "", fmt.Errorf("expected first element to have DocumentRef- prefix")
}
documentRefID = strings.TrimPrefix(documentRefID, "DocumentRef-")
if documentRefID == "" {
return "", "", "", "", fmt.Errorf("document identifier has nothing after prefix")
}
return documentRefID, uri, alg, checksum, nil
}
|