gerrit.onap Code Review - policy/distribution.git/blob

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2018 Ericsson. All rights reserved.
   4  *  Copyright (C) 2019 Nordix Foundation.
   5  *  Modifications Copyright (C) 2020-2021 AT&T Intellectual Property. All rights reserved.
   6  *  Modifications Copyright (C) 2021 Bell Canada. All rights reserved.
   7  * ================================================================================
   8  * Licensed under the Apache License, Version 2.0 (the "License");
   9  * you may not use this file except in compliance with the License.
  10  * You may obtain a copy of the License at
  11  *
  12  *      http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing, software
  15  * distributed under the License is distributed on an "AS IS" BASIS,
  16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17  * See the License for the specific language governing permissions and
  18  * limitations under the License.
  19  *
  20  * SPDX-License-Identifier: Apache-2.0
  21  * ============LICENSE_END=========================================================
  22  */
  23
  24 package org.onap.policy.distribution.reception.decoding.policy.file;
  25
  26 import java.io.IOException;
  27 import java.nio.file.Path;
  28 import java.util.ArrayList;
  29 import java.util.Collection;
  30 import java.util.Enumeration;
  31 import java.util.zip.ZipEntry;
  32 import java.util.zip.ZipFile;
  33 import org.onap.policy.common.parameters.ParameterService;
  34 import org.onap.policy.common.utils.coder.CoderException;
  35 import org.onap.policy.common.utils.coder.StandardCoder;
  36 import org.onap.policy.distribution.model.Csar;
  37 import org.onap.policy.distribution.model.PolicyInput;
  38 import org.onap.policy.distribution.reception.decoding.PolicyDecoder;
  39 import org.onap.policy.distribution.reception.decoding.PolicyDecodingException;
  40 import org.onap.policy.models.tosca.authorative.concepts.ToscaEntity;
  41 import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate;
  42
  43 /**
  44  * This class extracts policy files from a CSAR file.
  45  *
  46  * @author Ram Krishna Verma (ram.krishna.verma@ericsson.com)
  47  */
  48 public class PolicyDecoderFileInCsarToPolicy implements PolicyDecoder<Csar, ToscaEntity> {
  49
  50     private PolicyDecoderFileInCsarToPolicyParameterGroup decoderParameters;
  51     private StandardCoder coder;
  52     private static final long MAX_FILE_SIZE = 512L * 1024;
  53
  54     /**
  55      * {@inheritDoc}.
  56      */
  57     @Override
  58     public void configure(final String parameterGroupName) {
  59         decoderParameters = ParameterService.get(parameterGroupName);
  60         coder = new StandardCoder();
  61     }
  62
  63     /**
  64      * {@inheritDoc}.
  65      */
  66     @Override
  67     public boolean canHandle(final PolicyInput policyInput) {
  68         return policyInput.getClass().isAssignableFrom(Csar.class);
  69     }
  70
  71     /**
  72      * {@inheritDoc}.
  73      */
  74     @Override
  75     public Collection<ToscaEntity> decode(final Csar csar) throws PolicyDecodingException {
  76         final Collection<ToscaEntity> policyList = new ArrayList<>();
  77
  78         try (var zipFile = new ZipFile(csar.getCsarFilePath())) {
  79             final Enumeration<? extends ZipEntry> entries = zipFile.entries();
  80             while (entries.hasMoreElements()) {
  81                 //
  82                 // Sonar will flag this as a Security Hotspot
  83                 // "Expanding archive files is security-sensitive"
  84                 // isZipEntryValid ensures the file being read exists in the archive
  85                 //
  86                 final ZipEntry entry = entries.nextElement(); // NOSONAR
  87                 if (isZipEntryValid(entry.getName(), csar.getCsarFilePath(), entry.getSize())) {
  88                     final ToscaServiceTemplate policy =
  89                             coder.decode(zipFile.getInputStream(entry), ToscaServiceTemplate.class);
  90                     policyList.add(policy);
  91                 }
  92             }
  93         } catch (final IOException | CoderException exp) {
  94             throw new PolicyDecodingException("Failed decoding the policy", exp);
  95         }
  96
  97         return policyList;
  98     }
  99
 100     /**
 101      * Method to filter out Policy type and Policy files. In addition,
 102      * ensures validation of entries in the Zipfile. Attempts to solve path
 103      * injection java security issues.
 104      *
 105      * @param entryName name of the ZipEntry to check
 106      * @param csarPath Absolute path to the csar the ZipEntry is in
 107      * @param entrySize size of the ZipEntry
 108      * @return true if no injection detected, and it is a policy type  or policy file.
 109      * @throws PolicyDecodingException if the file size is too large
 110      */
 111     private boolean isZipEntryValid(String entryName, String csarPath, long entrySize) throws PolicyDecodingException {
 112         //
 113         // We only care about policy types and policies
 114         //
 115         if (entryName.contains(decoderParameters.getPolicyTypeFileName())
 116                 || entryName.contains(decoderParameters.getPolicyFileName())) {
 117             //
 118             // Check file size
 119             //
 120             if (entrySize > MAX_FILE_SIZE) {
 121                 throw new PolicyDecodingException("Zip entry for " + entryName + " is too large " + entrySize);
 122             }
 123             //
 124             // Now ensure that there is no path injection
 125             //
 126             var path = Path.of(csarPath, entryName).normalize();
 127             //
 128             // Throw an exception if path is outside the csar
 129             //
 130             if (! path.startsWith(csarPath)) {
 131                 throw new PolicyDecodingException("Potential path injection for zip entry " + entryName);
 132             }
 133             return true;
 134         }
 135
 136         return false;
 137     }
 138 }