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