2 * ============LICENSE_START=======================================================
3 * Copyright (C) 2020 Nordix Foundation.
4 * ================================================================================
5 * Modification copyright 2021 Nokia
6 * ================================================================================
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
19 * SPDX-License-Identifier: Apache-2.0
20 * ============LICENSE_END=========================================================
23 package org.onap.oom.certservice.cmpv2client.validation;
25 import static org.onap.oom.certservice.cmpv2client.impl.CmpResponseValidationHelper.checkImplicitConfirm;
26 import static org.onap.oom.certservice.cmpv2client.impl.CmpResponseValidationHelper.verifyPasswordBasedProtection;
27 import static org.onap.oom.certservice.cmpv2client.impl.CmpResponseValidationHelper.verifySignature;
29 import java.security.PublicKey;
30 import java.util.Date;
31 import java.util.Objects;
32 import java.util.Optional;
33 import org.apache.http.impl.client.CloseableHttpClient;
34 import org.bouncycastle.asn1.ASN1ObjectIdentifier;
35 import org.bouncycastle.asn1.cmp.CertResponse;
36 import org.bouncycastle.asn1.cmp.PKIHeader;
37 import org.bouncycastle.asn1.cmp.PKIMessage;
38 import org.bouncycastle.asn1.x509.AlgorithmIdentifier;
39 import org.onap.oom.certservice.certification.configuration.model.Cmpv2Server;
40 import org.onap.oom.certservice.certification.model.CsrModel;
41 import org.onap.oom.certservice.cmpv2client.exceptions.CmpClientException;
42 import org.onap.oom.certservice.cmpv2client.exceptions.CmpServerException;
43 import org.onap.oom.certservice.cmpv2client.impl.CmpUtil;
44 import org.onap.oom.certservice.cmpv2client.impl.PkiStatus;
45 import org.slf4j.Logger;
46 import org.slf4j.LoggerFactory;
48 public class CmpCertificationValidator {
49 private static final String DEFAULT_CA_NAME = "Certification Authority";
50 private static final ASN1ObjectIdentifier PASSWORD_BASED_MAC = new ASN1ObjectIdentifier("1.2.840.113533.7.66.13");
51 private static final Logger LOG = LoggerFactory.getLogger(CmpCertificationValidator.class);
53 public static void validate(
54 final CsrModel csrModel,
55 final Cmpv2Server server,
56 final CloseableHttpClient httpClient,
58 final Date notAfter) {
60 String caName = CmpUtil.isNullOrEmpty(server.getCaName()) ? server.getCaName() : DEFAULT_CA_NAME;
62 "Validate before creating Certificate Request for CA: {}", caName);
64 CmpUtil.notNull(csrModel, "CsrModel Instance");
65 CmpUtil.notNull(csrModel.getSubjectData(), "Subject DN");
66 CmpUtil.notNull(csrModel.getPrivateKey(), "Subject private key");
67 CmpUtil.notNull(csrModel.getPublicKey(), "Subject public key");
68 CmpUtil.notNull(server.getIssuerDN(), "Issuer DN");
69 CmpUtil.notNull(server.getUrl(), "External CA URL");
70 CmpUtil.notNull(server.getAuthentication().getIak(), "IAK/RV Password");
71 CmpUtil.notNull(httpClient, "Closeable Http Client");
73 if (notBefore != null && notAfter != null && notBefore.compareTo(notAfter) > 0) {
74 throw new IllegalArgumentException("Before Date is set after the After Date");
78 public void checkCmpResponse(final PKIMessage respPkiMessage, final PublicKey publicKey, final String initAuthPassword)
79 throws CmpClientException {
80 final PKIHeader header = respPkiMessage.getHeader();
81 final AlgorithmIdentifier protectionAlgo = header.getProtectionAlg();
82 verifySignatureWithPublicKey(respPkiMessage, publicKey);
83 if (isPasswordBasedMacAlgorithm(protectionAlgo)) {
84 LOG.info("CMP response is protected by Password Base Mac Algorithm. Attempt to verify protection");
85 verifyPasswordBasedMacProtection(respPkiMessage, initAuthPassword, header, protectionAlgo);
89 public void checkServerResponse(CertResponse certResponse) {
90 if (certResponse.getStatus() != null && certResponse.getStatus().getStatus() != null) {
91 logServerResponse(certResponse);
92 if (certResponse.getStatus().getStatus().intValue() == PkiStatus.REJECTED.getCode()) {
93 String serverMessage = certResponse.getStatus().getStatusString().getStringAt(0).getString();
94 throw new CmpServerException(Optional.ofNullable(serverMessage).orElse("N/A"));
99 private boolean isPasswordBasedMacAlgorithm(AlgorithmIdentifier protectionAlgo) throws CmpClientException {
100 if (Objects.isNull(protectionAlgo)) {
101 LOG.error("CMP response does not contain Protection Algorithm field");
102 throw new CmpClientException("CMP response does not contain Protection Algorithm field");
104 return PASSWORD_BASED_MAC.equals(protectionAlgo.getAlgorithm());
107 private void verifySignatureWithPublicKey(PKIMessage respPkiMessage, PublicKey publicKey)
108 throws CmpClientException {
109 if (Objects.nonNull(publicKey)) {
110 LOG.debug("Verifying signature of the response.");
111 verifySignature(respPkiMessage, publicKey);
113 LOG.error("Public Key is not available, therefore cannot verify signature");
114 throw new CmpClientException(
115 "Public Key is not available, therefore cannot verify signature");
119 private void verifyPasswordBasedMacProtection(PKIMessage respPkiMessage, String initAuthPassword,
120 PKIHeader header, AlgorithmIdentifier protectionAlgo)
121 throws CmpClientException {
122 LOG.debug("Verifying PasswordBased Protection of the Response.");
123 verifyPasswordBasedProtection(respPkiMessage, initAuthPassword, protectionAlgo);
124 checkImplicitConfirm(header);
127 private void logServerResponse(CertResponse certResponse) {
128 if (LOG.isInfoEnabled()) {
129 LOG.info("Response status code: {}", certResponse.getStatus().getStatus());
131 if (certResponse.getStatus().getStatusString() != null) {
132 String serverMessage = certResponse.getStatus().getStatusString().getStringAt(0).getString();
133 LOG.warn("Response status text: {}", serverMessage);
135 if (LOG.isWarnEnabled() && certResponse.getStatus().getFailInfo() != null) {
136 LOG.warn("Response fail info: {}", certResponse.getStatus().getFailInfo());