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
|
/*
Copyright 2020 Nokia
<p>
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
<p>
http://www.apache.org/licenses/LICENSE-2.0
<p>
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.
*/
package org.onap.cvc.csar.cc.sol004.r130206;
import org.onap.cvc.csar.CSARArchive;
import org.onap.cvc.csar.parser.SourcesParser;
import org.onap.cvc.csar.security.CertificateLoadingException;
import org.onap.cvc.csar.security.CmsSignatureData;
import org.onap.cvc.csar.security.CmsSignatureLoadingException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.io.File;
import java.io.IOException;
import java.nio.file.Path;
import java.security.NoSuchAlgorithmException;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import static org.onap.validation.csar.FileUtil.getFileNameWithoutExtension;
public class CsarSecurityValidator {
private static final Logger LOG = LoggerFactory.getLogger(CsarSecurityValidator.class);
private static final String EMPTY_STRING = "";
public static final String CERTIFICATE_EXTENSION = ".cert";
private final FileSignatureValidator fileSignatureValidator = new FileSignatureValidator();
private final List<CSARArchive.CSARError> errors = new ArrayList<>();
private final CSARArchive csar;
private final Path csarRootDirectory;
public CsarSecurityValidator(CSARArchive csar, Path csarRootDirectory) {
this.csar = csar;
this.csarRootDirectory = csarRootDirectory;
}
public List<CSARArchive.CSARError> validate() throws IOException, NoSuchAlgorithmException {
this.errors.clear();
if (containsCms()) {
validateCsarSecurity();
} else if (containAnySecurityElements()) {
this.errors.add(new Error.CSARErrorUnableToFindCms());
} else {
this.errors.add(new Error.CSARWarningNoSecurity());
}
return errors;
}
private boolean containAnySecurityElements() {
return (containsToscaMeta() && containsCertificateInTosca()) ||
containsCertificateInRootCatalog() ||
containsPerArtifactSecurity();
}
private void validateCsarSecurity() throws NoSuchAlgorithmException, IOException {
try {
CmsSignatureData signatureData = this.fileSignatureValidator.createSignatureDataForManifestFile(csar.getManifestMfFile());
if (signatureData.getCertificate().isPresent()) {
validateCertificationUsingCmsCertificate(signatureData);
} else if (containsToscaMeta()) {
validateCertificationUsingTosca(signatureData);
} else if (containsCertificateInRootCatalog()) {
validateCertificationUsingCertificateFromRootDirectory(signatureData);
} else {
this.errors.add(new Error.CSARErrorUnableToFindCertificate());
}
} catch (CmsSignatureLoadingException e) {
LOG.error("Unable to load CMS!", e);
this.errors.add(new Error.CSARErrorUnableToLoadCms());
}
}
private boolean containsCms() {
String cms = csar.getManifest().getCms();
return cms != null && !cms.equals(EMPTY_STRING);
}
private boolean containsToscaMeta() {
return csar.getToscaMetaFile() != null;
}
private boolean containsCertificateInTosca() {
String certificate = csar.getToscaMeta().getEntryCertificate();
return certificate != null && !certificate.equals(EMPTY_STRING);
}
private boolean containsCertificateInRootCatalog() {
File potentialCertificateFileInRootDirectory = getCertificateFromRootDirectory();
return potentialCertificateFileInRootDirectory.exists();
}
private boolean containsPerArtifactSecurity() {
return csar.getManifest().getSources().stream().anyMatch(
source ->
!source.getAlgorithm().equals(EMPTY_STRING) ||
!source.getHash().equals(EMPTY_STRING) ||
!source.getCertificate().equals(EMPTY_STRING) ||
!source.getSignature().equals(EMPTY_STRING)
);
}
private void validateCertificationUsingCmsCertificate(CmsSignatureData signatureData)
throws NoSuchAlgorithmException, IOException {
validateAllSources();
validateFileSignature(signatureData);
if (containsCertificateInTosca()) {
this.errors.add(new Error.CSARErrorEntryCertificateIsDefinedDespiteTheCms());
if (csar.getFileFromCsar(csar.getToscaMeta().getEntryCertificate()).exists()) {
this.errors.add(new Error.CSARErrorEntryCertificateIsPresentDespiteTheCms());
}
}
if (containsCertificateInRootCatalog()) {
this.errors.add(new Error.CSARErrorRootCertificateIsPresentDespiteTheCms());
}
}
private void validateCertificationUsingTosca(CmsSignatureData signatureData)
throws NoSuchAlgorithmException, IOException {
Optional<Path> pathToCert = loadCertificateFromTosca();
if (pathToCert.isPresent()) {
validateAllSources(pathToCert.get());
signatureData.loadCertificate(pathToCert.get());
validateFileSignature(signatureData);
}
if (containsCertificateInRootCatalog() && rootCertificateIsNotReferredAsToscaEtsiEntryCertificate()) {
this.errors.add(new Error.CSARErrorRootCertificateIsPresentDespiteTheEtsiEntryCertificate());
}
}
private Optional<Path> loadCertificateFromTosca() {
if (csar.getToscaMeta().getEntryCertificate() != null) {
final Path absolutePathToEntryCertificate = csar.getFileFromCsar(csar.getToscaMeta().getEntryCertificate()).toPath();
if (absolutePathToEntryCertificate.toFile().exists()) {
return Optional.of(absolutePathToEntryCertificate);
} else {
this.errors.add(new Error.CSARErrorUnableToFindEntryCertificate());
return Optional.empty();
}
} else {
this.errors.add(new Error.CSARErrorUnableToFindCertificateEntryInTosca());
return Optional.empty();
}
}
private boolean rootCertificateIsNotReferredAsToscaEtsiEntryCertificate() {
String pathToRootCertificate = getCertificateFromRootDirectory().getPath();
String pathToEntryEtsiCertificate = csar.getFileFromCsar(csar.getToscaMeta().getEntryCertificate()).getPath();
return !pathToRootCertificate.equals(pathToEntryEtsiCertificate);
}
private void validateCertificationUsingCertificateFromRootDirectory(CmsSignatureData signatureData)
throws NoSuchAlgorithmException, IOException {
Optional<Path> pathToCert = loadCertificateFromRootDirectory();
if (pathToCert.isPresent()) {
validateAllSources(pathToCert.get());
signatureData.loadCertificate(pathToCert.get());
validateFileSignature(signatureData);
}
}
private void validateFileSignature(CmsSignatureData signatureData) {
final boolean isValid = this.fileSignatureValidator.isValid(signatureData);
if (!isValid) {
this.errors.add(new Error.CSARErrorInvalidSignature());
}
}
private Optional<Path> loadCertificateFromRootDirectory() {
try {
Path pathToCertificateInRootDirectory = getCertificateFromRootDirectory().toPath();
return Optional.of(pathToCertificateInRootDirectory);
} catch (CertificateLoadingException e) {
LOG.error("Unable to read ETSI entry certificate file!", e);
return Optional.empty();
}
}
private File getCertificateFromRootDirectory() {
String nameOfCertificate =
getFileNameWithoutExtension(csar.getManifestMfFile().getName()) + CERTIFICATE_EXTENSION;
return csar.getFileFromCsar(nameOfCertificate);
}
private void validateAllSources()
throws NoSuchAlgorithmException, IOException {
this.errors.addAll(createCsarSourcesValidator().validate());
}
private void validateAllSources(Path commonCertificate)
throws NoSuchAlgorithmException, IOException {
this.errors.addAll(createCsarSourcesValidator().validate(commonCertificate));
}
private CsarSourcesSecurityValidator createCsarSourcesValidator() {
final CSARArchive.Manifest manifest = csar.getManifest();
final Map<String, Map<String, List<String>>> nonMano = manifest.getNonMano();
final List<SourcesParser.Source> sources = manifest.getSources();
return new CsarSourcesSecurityValidator(nonMano, sources, csarRootDirectory);
}
}
|
