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