gerrit.onap Code Review - sdc.git/blob

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * SDC
   4  * ================================================================================
   5  * Copyright (C) 2019, Nordix Foundation. All rights reserved.
   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
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  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.
  18  * ============LICENSE_END=========================================================
  19  */
  20 package org.openecomp.sdc.vendorsoftwareproduct.security;
  21
  22 import com.google.common.collect.ImmutableSet;
  23 import java.io.ByteArrayInputStream;
  24 import java.io.File;
  25 import java.io.FileInputStream;
  26 import java.io.IOException;
  27 import java.io.InputStream;
  28 import java.io.InputStreamReader;
  29 import java.security.GeneralSecurityException;
  30 import java.security.InvalidAlgorithmParameterException;
  31 import java.security.InvalidKeyException;
  32 import java.security.NoSuchAlgorithmException;
  33 import java.security.NoSuchProviderException;
  34 import java.security.PublicKey;
  35 import java.security.Security;
  36 import java.security.SignatureException;
  37 import java.security.cert.CertPathBuilder;
  38 import java.security.cert.CertStore;
  39 import java.security.cert.Certificate;
  40 import java.security.cert.CertificateException;
  41 import java.security.cert.CertificateExpiredException;
  42 import java.security.cert.CertificateFactory;
  43 import java.security.cert.CertificateNotYetValidException;
  44 import java.security.cert.CollectionCertStoreParameters;
  45 import java.security.cert.PKIXBuilderParameters;
  46 import java.security.cert.PKIXCertPathBuilderResult;
  47 import java.security.cert.TrustAnchor;
  48 import java.security.cert.X509CertSelector;
  49 import java.security.cert.X509Certificate;
  50 import java.util.Collection;
  51 import java.util.HashSet;
  52 import java.util.Set;
  53 import org.bouncycastle.asn1.cms.ContentInfo;
  54 import org.bouncycastle.cert.X509CertificateHolder;
  55 import org.bouncycastle.cms.CMSException;
  56 import org.bouncycastle.cms.CMSProcessableByteArray;
  57 import org.bouncycastle.cms.CMSSignedData;
  58 import org.bouncycastle.cms.CMSTypedData;
  59 import org.bouncycastle.cms.SignerInformation;
  60 import org.bouncycastle.cms.jcajce.JcaSimpleSignerInfoVerifierBuilder;
  61 import org.bouncycastle.jce.provider.BouncyCastleProvider;
  62 import org.bouncycastle.openssl.PEMParser;
  63 import org.bouncycastle.operator.OperatorCreationException;
  64 import org.openecomp.sdc.logging.api.Logger;
  65 import org.openecomp.sdc.logging.api.LoggerFactory;
  66
  67 /**
  68  * This is temporary solution. When AAF provides functionality for verifying trustedCertificates, this class should be
  69  * reviewed Class is responsible for providing root trustedCertificates from configured location in onboarding
  70  * container.
  71  */
  72 public class SecurityManager {
  73
  74     private static final String CERTIFICATE_DEFAULT_LOCATION = "cert";
  75
  76     private Logger logger = LoggerFactory.getLogger(SecurityManager.class);
  77     private Set<X509Certificate> trustedCertificates = new HashSet<>();
  78     private File certificateDirectory;
  79
  80     static {
  81         if (Security.getProvider(BouncyCastleProvider.PROVIDER_NAME) == null) {
  82             Security.addProvider(new BouncyCastleProvider());
  83         }
  84     }
  85
  86     private SecurityManager() {
  87         certificateDirectory = this.getcertDirectory();
  88     }
  89
  90     public static SecurityManager getInstance() {
  91         return SecurityManagerInstanceHolder.instance;
  92     }
  93
  94     /**
  95      * Initialization on demand class / synchronized singleton pattern.
  96      */
  97     private static class SecurityManagerInstanceHolder {
  98
  99         private static final SecurityManager instance = new SecurityManager();
 100     }
 101
 102     /**
 103      * Checks the configured location for available trustedCertificates
 104      *
 105      * @return set of trustedCertificates
 106      * @throws SecurityManagerException
 107      */
 108     public Set<X509Certificate> getTrustedCertificates() throws SecurityManagerException {
 109         //if file number in certificate directory changed reload certs
 110         String[] certFiles = certificateDirectory.list();
 111         if (certFiles == null) {
 112             logger.error("Certificate directory is empty!");
 113             return ImmutableSet.copyOf(new HashSet<>());
 114         }
 115         if (trustedCertificates.size() != certFiles.length) {
 116             trustedCertificates = new HashSet<>();
 117             processCertificateDir();
 118         }
 119         return ImmutableSet.copyOf(trustedCertificates);
 120     }
 121
 122     /**
 123      * Cleans certificate collection
 124      */
 125     public void cleanTrustedCertificates() {
 126         trustedCertificates.clear();
 127     }
 128
 129     /**
 130      * Verifies if packaged signed with trusted certificate
 131      *
 132      * @param messageSyntaxSignature - signature data in cms format
 133      * @param packageCert            - package certificate if not part of cms signature, can be null
 134      * @param innerPackageFile       data package signed with cms signature
 135      * @return true if signature verified
 136      * @throws SecurityManagerException
 137      */
 138     public boolean verifySignedData(final byte[] messageSyntaxSignature, final byte[] packageCert,
 139                                     final byte[] innerPackageFile) throws SecurityManagerException {
 140         try (ByteArrayInputStream signatureStream = new ByteArrayInputStream(messageSyntaxSignature);
 141             final PEMParser pemParser = new PEMParser(new InputStreamReader(signatureStream))) {
 142             final Object parsedObject = pemParser.readObject();
 143             if (!(parsedObject instanceof ContentInfo)) {
 144                 throw new SecurityManagerException("Signature is not recognized");
 145             }
 146             final ContentInfo signature = ContentInfo.getInstance(parsedObject);
 147             final CMSTypedData signedContent = new CMSProcessableByteArray(innerPackageFile);
 148             final CMSSignedData signedData = new CMSSignedData(signedContent, signature);
 149
 150             final Collection<SignerInformation> signers = signedData.getSignerInfos().getSigners();
 151             final SignerInformation firstSigner = signers.iterator().next();
 152             final X509Certificate cert;
 153             if (packageCert == null) {
 154                 final Collection<X509CertificateHolder> firstSignerCertificates = signedData.getCertificates()
 155                     .getMatches(firstSigner.getSID());
 156                 if (!firstSignerCertificates.iterator().hasNext()) {
 157                     throw new SecurityManagerException(
 158                         "No certificate found in cms signature that should contain one!");
 159                 }
 160                 cert = loadCertificate(firstSignerCertificates.iterator().next().getEncoded());
 161             } else {
 162                 cert = loadCertificate(packageCert);
 163             }
 164
 165             if (verifyCertificate(cert, getTrustedCertificates()) == null) {
 166                 return false;
 167             }
 168
 169             return firstSigner.verify(new JcaSimpleSignerInfoVerifierBuilder().build(cert));
 170         } catch (OperatorCreationException | IOException | CMSException e) {
 171             logger.error(e.getMessage(), e);
 172             throw new SecurityManagerException("Unexpected error occurred during signature validation!", e);
 173         } catch (GeneralSecurityException e) {
 174             throw new SecurityManagerException("Could not verify signature!", e);
 175         }
 176     }
 177
 178     private void processCertificateDir() throws SecurityManagerException {
 179         if (!certificateDirectory.exists() || !certificateDirectory.isDirectory()) {
 180             logger.error("Issue with certificate directory, check if exists!");
 181             return;
 182         }
 183
 184         File[] files = certificateDirectory.listFiles();
 185         if (files == null) {
 186             logger.error("Certificate directory is empty!");
 187             return;
 188         }
 189         for (File f : files) {
 190             trustedCertificates.add(loadCertificate(f));
 191         }
 192     }
 193
 194     private File getcertDirectory() {
 195         String certDirLocation = System.getenv("SDC_CERT_DIR");
 196         if (certDirLocation == null) {
 197             certDirLocation = CERTIFICATE_DEFAULT_LOCATION;
 198         }
 199         return new File(certDirLocation);
 200     }
 201
 202     private X509Certificate loadCertificate(File certFile) throws SecurityManagerException {
 203         try (InputStream fileInputStream = new FileInputStream(certFile)) {
 204             CertificateFactory factory = CertificateFactory.getInstance("X.509");
 205             return (X509Certificate) factory.generateCertificate(fileInputStream);
 206         } catch (CertificateException | IOException e) {
 207             throw new SecurityManagerException("Error during loading Certificate file!", e);
 208         }
 209     }
 210
 211     private X509Certificate loadCertificate(byte[] certFile) throws SecurityManagerException {
 212         try (InputStream in = new ByteArrayInputStream(certFile)) {
 213             CertificateFactory factory = CertificateFactory.getInstance("X.509");
 214             return (X509Certificate) factory.generateCertificate(in);
 215         } catch (CertificateException | IOException e) {
 216             throw new SecurityManagerException("Error during loading Certificate from bytes!", e);
 217         }
 218     }
 219
 220     private PKIXCertPathBuilderResult verifyCertificate(X509Certificate cert,
 221                                                         Set<X509Certificate> additionalCerts)
 222         throws GeneralSecurityException, SecurityManagerException {
 223         if (null == cert) {
 224             throw new SecurityManagerException("The certificate is empty!");
 225         }
 226
 227         if (isExpired(cert)) {
 228             throw new SecurityManagerException("The certificate expired on: " + cert.getNotAfter());
 229         }
 230
 231         if (isSelfSigned(cert)) {
 232             throw new SecurityManagerException("The certificate is self-signed.");
 233         }
 234
 235         Set<X509Certificate> trustedRootCerts = new HashSet<>();
 236         Set<X509Certificate> intermediateCerts = new HashSet<>();
 237         for (X509Certificate additionalCert : additionalCerts) {
 238             if (isSelfSigned(additionalCert)) {
 239                 trustedRootCerts.add(additionalCert);
 240             } else {
 241                 intermediateCerts.add(additionalCert);
 242             }
 243         }
 244
 245         return verifyCertificate(cert, trustedRootCerts, intermediateCerts);
 246     }
 247
 248     private PKIXCertPathBuilderResult verifyCertificate(X509Certificate cert,
 249                                                         Set<X509Certificate> allTrustedRootCerts,
 250                                                         Set<X509Certificate> allIntermediateCerts)
 251         throws GeneralSecurityException {
 252
 253         // Create the selector that specifies the starting certificate
 254         X509CertSelector selector = new X509CertSelector();
 255         selector.setCertificate(cert);
 256
 257         // Create the trust anchors (set of root CA certificates)
 258         Set<TrustAnchor> trustAnchors = new HashSet<>();
 259         for (X509Certificate trustedRootCert : allTrustedRootCerts) {
 260             trustAnchors.add(new TrustAnchor(trustedRootCert, null));
 261         }
 262
 263         // Configure the PKIX certificate builder algorithm parameters
 264         PKIXBuilderParameters pkixParams;
 265         try {
 266             pkixParams = new PKIXBuilderParameters(trustAnchors, selector);
 267         } catch (InvalidAlgorithmParameterException ex) {
 268             throw new InvalidAlgorithmParameterException("No root CA has been found for this certificate", ex);
 269         }
 270
 271         // Not supporting CRL checks for now
 272         pkixParams.setRevocationEnabled(false);
 273
 274         Set<X509Certificate> certSet = new HashSet<>();
 275         certSet.add(cert);
 276         pkixParams.addCertStore(createCertStore(certSet));
 277         pkixParams.addCertStore(createCertStore(allIntermediateCerts));
 278         pkixParams.addCertStore(createCertStore(allTrustedRootCerts));
 279
 280         CertPathBuilder builder = CertPathBuilder
 281             .getInstance(CertPathBuilder.getDefaultType(), BouncyCastleProvider.PROVIDER_NAME);
 282         return (PKIXCertPathBuilderResult) builder.build(pkixParams);
 283     }
 284
 285     private CertStore createCertStore(Set<X509Certificate> certificateSet) throws InvalidAlgorithmParameterException,
 286         NoSuchAlgorithmException, NoSuchProviderException {
 287         return CertStore.getInstance("Collection", new CollectionCertStoreParameters(certificateSet),
 288             BouncyCastleProvider.PROVIDER_NAME);
 289     }
 290
 291     private boolean isExpired(X509Certificate cert) {
 292         try {
 293             cert.checkValidity();
 294         } catch (CertificateExpiredException e) {
 295             logger.error(e.getMessage(), e);
 296             return true;
 297         } catch (CertificateNotYetValidException e) {
 298             logger.error(e.getMessage(), e);
 299             return false;
 300         }
 301         return false;
 302     }
 303
 304     private boolean isSelfSigned(Certificate cert)
 305         throws CertificateException, NoSuchAlgorithmException,
 306         NoSuchProviderException {
 307         try {
 308             // Try to verify certificate signature with its own public key
 309             PublicKey key = cert.getPublicKey();
 310             cert.verify(key);
 311             return true;
 312         } catch (SignatureException | InvalidKeyException e) {
 313             logger.error(e.getMessage(), e);
 314             //not self-signed
 315             return false;
 316         }
 317     }
 318 }