[DMAAP-DR] Another fix for sql injection 04/127604/1
authorefiacor <fiachra.corcoran@est.tech>
Wed, 9 Mar 2022 16:23:37 +0000 (16:23 +0000)
committerefiacor <fiachra.corcoran@est.tech>
Wed, 9 Mar 2022 16:24:00 +0000 (16:24 +0000)
Signed-off-by: efiacor <fiachra.corcoran@est.tech>
Change-Id: Id7f05dc3ba3dca0a7da3f94cd072ecb9204a728a
Issue-ID: DMAAP-1623

csit/scripts/dmaap-datarouter/docker-compose/docker-compose.yml
csit/scripts/dmaap-datarouter/docker-compose/logback.xml [new file with mode: 0644]
datarouter-prov/src/main/java/org/onap/dmaap/datarouter/provisioning/StatisticsServlet.java

index 9140d0f..d2902ff 100644 (file)
@@ -30,6 +30,7 @@ services:
     - "8080:8080"
     volumes:
     - ./provserver.properties:/opt/app/datartr/etc/provserver.properties
+    - ./logback.xml:/opt/app/datartr/etc/logback.xml
     - ../dr_certs/dr_prov/truststore.jks:/opt/app/osaaf/local/truststore.jks
     - ../dr_certs/dr_prov/org.onap.dmaap-dr-prov.p12:/opt/app/osaaf/local/org.onap.dmaap-dr-prov.p12
     - ../dr_certs/dr_prov/org.onap.dmaap-dr.cred.props:/opt/app/osaaf/local/org.onap.dmaap-dr.cred.props
diff --git a/csit/scripts/dmaap-datarouter/docker-compose/logback.xml b/csit/scripts/dmaap-datarouter/docker-compose/logback.xml
new file mode 100644 (file)
index 0000000..8e3183a
--- /dev/null
@@ -0,0 +1,189 @@
+<!--
+  ============LICENSE_START=======================================================
+   Copyright (C) 2019 Nordix Foundation.
+  ================================================================================
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+
+  SPDX-License-Identifier: Apache-2.0
+  ============LICENSE_END=========================================================
+-->
+<configuration scan="true" scanPeriod="3 seconds" debug="true">
+  <property name="logDir" value="/opt/app/datartr/logs" />
+  <!--  log file names -->
+  <property name="generalLogName" value="apicalls" />
+  <property name="errorLogName" value="errors" />
+  <property name="debugLogName" value="debug"/>
+  <property name="jettyLogName" value="jetty"/>
+  <property name="defaultPattern"     value="%d{MM/dd-HH:mm:ss.SSS}|%logger|%X{RequestId}|%X{InvocationId}|%X{ServiceInstanceId}|%thread|%X{ServiceName}|%X{InstanceUUID}|%.-5level|%X{AlertSeverity}|%X{ServerIPAddress}|%X{ServerFQDN}|%X{RemoteHost}|%X{Timer}|%msg%n" />
+  <property name="jettyLoggerPattern" value="%d{MM/dd-HH:mm:ss.SSS}|%logger|%thread|%.-5level|%msg%n" />
+
+  <property name="debugLoggerPattern" value="%d{MM/dd-HH:mm:ss.SSS}|%logger|%X{RequestId}|%X{InvocationId}|%X{ServiceInstanceId}|%thread|%X{ServiceName}|%X{InstanceUUID}|%.-5level|%X{AlertSeverity}|%X{ServerIPAddress}|%X{ServerFQDN}|%X{RemoteHost}|%X{Timer}|[%caller{3}]|%msg%n" />
+  <property name="logDirectory" value="${logDir}" />
+
+  <!-- Example evaluator filter applied against console appender -->
+  <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
+    <encoder>
+      <pattern>${defaultPattern}</pattern>
+    </encoder>
+  </appender>
+
+  <!-- ============================================================================ -->
+  <!-- EELF Appenders -->
+  <!-- ============================================================================ -->
+
+  <!-- The EELFAppender is used to record events to the general application
+    log -->
+
+  <appender name="EELF"
+    class="ch.qos.logback.core.rolling.RollingFileAppender">
+    <file>${logDirectory}/${generalLogName}.log</file>
+    <filter class="ch.qos.logback.classic.filter.LevelFilter">
+      <level>INFO</level>
+      <onMatch>ACCEPT</onMatch>
+      <onMismatch>DENY</onMismatch>
+    </filter>
+    <rollingPolicy
+      class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
+      <fileNamePattern>${logDirectory}/${generalLogName}.%i.log.zip
+      </fileNamePattern>
+      <minIndex>1</minIndex>
+      <maxIndex>9</maxIndex>
+    </rollingPolicy>
+    <triggeringPolicy
+      class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
+      <maxFileSize>50MB</maxFileSize>
+    </triggeringPolicy>
+    <encoder>
+      <pattern>${defaultPattern}</pattern>
+    </encoder>
+  </appender>
+
+  <appender name="asyncEELF" class="ch.qos.logback.classic.AsyncAppender">
+    <queueSize>256</queueSize>
+    <appender-ref ref="EELF" />
+  </appender>
+
+  <appender name="EELFError"
+    class="ch.qos.logback.core.rolling.RollingFileAppender">
+    <file>${logDirectory}/${errorLogName}.log</file>
+    <filter class="ch.qos.logback.classic.filter.LevelFilter">
+      <level>ERROR</level>
+      <onMatch>ACCEPT</onMatch>
+      <onMismatch>DENY</onMismatch>
+    </filter>
+    <rollingPolicy
+      class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
+      <fileNamePattern>${logDirectory}/${errorLogName}.%i.log.zip
+      </fileNamePattern>
+      <minIndex>1</minIndex>
+      <maxIndex>9</maxIndex>
+    </rollingPolicy>
+    <triggeringPolicy
+      class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
+      <maxFileSize>50MB</maxFileSize>
+    </triggeringPolicy>
+    <encoder>
+      <pattern>${defaultPattern}</pattern>
+    </encoder>
+  </appender>
+
+  <appender name="asyncEELFError" class="ch.qos.logback.classic.AsyncAppender">
+    <queueSize>256</queueSize>
+    <appender-ref ref="EELFError"/>
+  </appender>
+
+  <!-- ============================================================================ -->
+  <appender name="jettylog"
+    class="ch.qos.logback.core.rolling.RollingFileAppender">
+    <file>${logDirectory}/${jettyLogName}.log</file>
+    <filter class="org.onap.dmaap.datarouter.provisioning.eelf.JettyFilter" />
+    <rollingPolicy
+      class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
+      <fileNamePattern>${logDirectory}/${jettyLogName}.%i.log.zip
+      </fileNamePattern>
+      <minIndex>1</minIndex>
+      <maxIndex>9</maxIndex>
+    </rollingPolicy>
+    <triggeringPolicy
+      class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
+      <maxFileSize>50MB</maxFileSize>
+    </triggeringPolicy>
+    <encoder>
+      <pattern>${jettyLoggerPattern}</pattern>
+    </encoder>
+  </appender>
+
+  <appender name="asyncEELFjettylog" class="ch.qos.logback.classic.AsyncAppender">
+    <queueSize>256</queueSize>
+    <appender-ref ref="jettylog" />
+    <includeCallerData>true</includeCallerData>
+  </appender>
+
+  <!-- ============================================================================ -->
+
+
+  <appender name="EELFDebug"
+    class="ch.qos.logback.core.rolling.RollingFileAppender">
+    <file>${logDirectory}/${debugLogName}.log</file>
+    <filter class="org.onap.dmaap.datarouter.provisioning.eelf.DebugTraceFilter" />
+    <rollingPolicy
+      class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
+      <fileNamePattern>${logDirectory}/${debugLogName}.%i.log.zip
+      </fileNamePattern>
+      <minIndex>1</minIndex>
+      <maxIndex>9</maxIndex>
+    </rollingPolicy>
+    <triggeringPolicy
+      class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
+      <maxFileSize>50MB</maxFileSize>
+    </triggeringPolicy>
+    <encoder>
+      <pattern>${defaultPattern}</pattern>
+    </encoder>
+  </appender>
+
+  <appender name="asyncEELFDebug" class="ch.qos.logback.classic.AsyncAppender">
+    <queueSize>256</queueSize>
+    <appender-ref ref="EELFDebug" />
+    <includeCallerData>true</includeCallerData>
+  </appender>
+
+
+  <!-- ============================================================================ -->
+  <!--  EELF loggers -->
+  <!-- ============================================================================ -->
+  <logger name="com.att.eelf" level="info" additivity="false">
+    <appender-ref ref="asyncEELF" />
+  </logger>
+
+  <logger name="com.att.eelf.error" level="error" additivity="false">
+    <appender-ref ref="asyncEELFError" />
+  </logger>
+
+  <logger name="log4j.logger.org.eclipse.jetty" additivity="false" level="info">
+    <appender-ref ref="asyncEELFjettylog"/>
+  </logger>
+
+  <logger name="com.att.eelf.debug" level="debug" additivity="false">
+    <appender-ref ref="asyncEELFDebug" />
+  </logger>
+
+  <root level="DEBUG">
+    <appender-ref ref="asyncEELF" />
+    <appender-ref ref="asyncEELFError" />
+    <appender-ref ref="asyncEELFjettylog" />
+    <appender-ref ref="asyncEELFDebug" />
+    <appender-ref ref="STDOUT" />
+  </root>
+
+</configuration>
\ No newline at end of file
index 964ef03..6049eea 100755 (executable)
@@ -64,6 +64,7 @@ public class StatisticsServlet extends BaseServlet {
     private static final String FMT1 = "yyyy-MM-dd'T'HH:mm:ss'Z'";\r
     private static final String FMT2 = "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'";\r
     public static final String FEEDID = "FEEDID";\r
+    public static final String START = "start";\r
 \r
     //sql Strings\r
     private static final String SQL_SELECT_NAME = "SELECT (SELECT NAME FROM FEEDS AS f WHERE f.FEEDID in(";\r
@@ -301,11 +302,12 @@ public class StatisticsServlet extends BaseServlet {
 \r
 \r
     /**\r
-     * queryGeneretor - Generating sql query.\r
+     * getResultSet - Set the result from the query.\r
      *\r
      * @param map as key value pare of all user input fields\r
      */\r
-    private PreparedStatement queryGeneretor(Map<String, String> map) throws ParseException, SQLException {\r
+    private void getResultSet(Map<String, String> map, String outputType, ServletOutputStream out,\r
+        HttpServletResponse resp) throws ParseException, SQLException, IOException {\r
 \r
         String sql;\r
         String feedids = null;\r
@@ -315,8 +317,8 @@ public class StatisticsServlet extends BaseServlet {
         long startInMillis = 0;\r
         long endInMillis = 0;\r
         String subid = " ";\r
-        String compareType = null;\r
-        PreparedStatement ps = null;\r
+        String compareType;\r
+        ResultSet rs;\r
 \r
         if (map.get(FEEDIDS) != null) {\r
             feedids = map.get(FEEDIDS);\r
@@ -334,8 +336,7 @@ public class StatisticsServlet extends BaseServlet {
         if (endTime == null && startTime == null) {\r
             sql =  SQL_SELECT_NAME + "?" + SQL_FEED_ID + SQL_SELECT_COUNT + "?" + SQL_TYPE_PUB + SQL_SELECT_SUM\r
                 + "?" + SQL_PUBLISH_LENGTH + SQL_SUBSCRIBER_URL + SQL_SUB_ID + SQL_DELIVERY_TIME + SQL_AVERAGE_DELAY\r
-                + SQL_JOIN_RECORDS + "?" + ") " + "?" + SQL_STATUS_204\r
-                + SQL_GROUP_SUB_ID;\r
+                + SQL_JOIN_RECORDS + "?" + ") " + SQL_STATUS_204 + SQL_GROUP_SUB_ID;\r
             compareType = "default";\r
         } else if (startTime != null && endTime == null) {\r
             long inputTimeInMilli = 60000 * Long.parseLong(startTime);\r
@@ -344,9 +345,9 @@ public class StatisticsServlet extends BaseServlet {
             compareTime = currentTimeInMilli - inputTimeInMilli;\r
             sql = SQL_SELECT_NAME + "?" + SQL_FEED_ID + SQL_SELECT_COUNT + "?" + SQL_TYPE_PUB + SQL_SELECT_SUM\r
                 + "?" + SQL_PUBLISH_LENGTH + SQL_SUBSCRIBER_URL + SQL_SUB_ID + SQL_DELIVERY_TIME + SQL_AVERAGE_DELAY\r
-                + SQL_JOIN_RECORDS + "?" + ") " + "?" + SQL_STATUS_204\r
+                + SQL_JOIN_RECORDS + "?" + ") " + SQL_STATUS_204\r
                 + " and e.event_time>=" + "?" + SQL_GROUP_SUB_ID;\r
-            compareType = "start";\r
+            compareType = START;\r
         } else {\r
             SimpleDateFormat inFormat = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss");\r
             Date startDate = inFormat.parse(startTime);\r
@@ -355,32 +356,28 @@ public class StatisticsServlet extends BaseServlet {
             endInMillis = endDate.getTime();\r
             sql = SQL_SELECT_NAME + "?" + SQL_FEED_ID + SQL_SELECT_COUNT + "?" + SQL_TYPE_PUB + SQL_SELECT_SUM\r
                 + "?" + SQL_PUBLISH_LENGTH + SQL_SUBSCRIBER_URL + SQL_SUB_ID + SQL_DELIVERY_TIME + SQL_AVERAGE_DELAY\r
-                + SQL_JOIN_RECORDS + "?" + ") " + "?" + SQL_STATUS_204\r
+                + SQL_JOIN_RECORDS + "?" + ") " +  SQL_STATUS_204\r
                 + " and e.event_time between " + "?" + " and " + "?" + SQL_GROUP_SUB_ID;\r
             compareType = "startAndEnd";\r
         }\r
-        try (Connection conn = ProvDbUtils.getInstance().getConnection()) {\r
+        try (Connection conn = ProvDbUtils.getInstance().getConnection();\r
+            PreparedStatement ps = conn.prepareStatement(sql)) {\r
             eventlogger.debug("SQL Query for Statistics resultset. " + sql);\r
             intlogger.debug(sql);\r
-            ps = conn.prepareStatement(sql);\r
             ps.setString(1, feedids);\r
             ps.setString(2, feedids);\r
             ps.setString(3, feedids);\r
             ps.setString(4, feedids);\r
-            ps.setString(5, subid);\r
-            if (compareType.equals("start")) {\r
-                ps.setLong(6, compareTime);\r
+            if (compareType.equals(START)) {\r
+                ps.setLong(5, compareTime);\r
             }\r
             if (compareType.equals("startAndEnd")) {\r
-                ps.setLong(6, startInMillis);\r
-                ps.setLong(7, endInMillis);\r
-            }\r
-        } finally {\r
-            if (ps != null) {\r
-                ps.close();\r
+                ps.setLong(5, startInMillis);\r
+                ps.setLong(6, endInMillis);\r
             }\r
+            rs = ps.executeQuery();\r
+            parseResult(outputType, out, resp, rs);\r
         }\r
-        return ps;\r
     }\r
 \r
 \r
@@ -491,7 +488,7 @@ public class StatisticsServlet extends BaseServlet {
             }\r
         }\r
 \r
-        long stime = getTimeFromParam(req.getParameter("start"));\r
+        long stime = getTimeFromParam(req.getParameter(START));\r
         if (stime < 0) {\r
             map.put("err", "bad start");\r
             return map;\r
@@ -540,12 +537,12 @@ public class StatisticsServlet extends BaseServlet {
         HttpServletResponse resp) {\r
         eventlogger.info("Generating sql query to get Statistics resultset. ");\r
         try {\r
-            PreparedStatement ps = this.queryGeneretor(map);\r
             long start = System.currentTimeMillis();\r
-            executeQuery(outputType, out, resp, ps);\r
+            this.getResultSet(map, outputType, out, resp);\r
             intlogger.debug("Time: " + (System.currentTimeMillis() - start) + " ms");\r
         } catch (SQLException e) {\r
-            eventlogger.error("SQLException:" + e);\r
+            eventlogger.error("SQLException:" + e.getMessage());\r
+            e.printStackTrace();\r
         } catch (IOException e) {\r
             eventlogger.error("IOException - Generating JSON/CSV:" + e);\r
         } catch (JSONException e) {\r
@@ -555,22 +552,18 @@ public class StatisticsServlet extends BaseServlet {
         }\r
     }\r
 \r
-    private void executeQuery(String outputType, ServletOutputStream out, HttpServletResponse resp,\r
-        PreparedStatement ps) throws IOException {\r
-        try (ResultSet rs = ps.executeQuery()) {\r
-            if (CSV_OUTPUT_TYPE.equals(outputType)) {\r
-                resp.setContentType("application/octet-stream");\r
-                DateTimeFormatter formatter = DateTimeFormatter.ofPattern("dd-MM-yyyy HH:mm:ss");\r
-                resp.setHeader("Content-Disposition",\r
-                    "attachment; filename=\"result:" + LocalDateTime.now().format(formatter) + ".csv\"");\r
-                eventlogger.info("Generating CSV file from Statistics resultset");\r
-                rsToCSV(rs, out);\r
-            } else {\r
-                eventlogger.info("Generating JSON for Statistics resultset");\r
-                this.rsToJson(rs, out);\r
-            }\r
-        } catch (SQLException e) {\r
-            eventlogger.error("SQLException:" + e);\r
+    private void parseResult(String outputType, ServletOutputStream out, HttpServletResponse resp,\r
+        ResultSet rs) throws IOException, SQLException {\r
+        if (CSV_OUTPUT_TYPE.equals(outputType)) {\r
+            resp.setContentType("application/octet-stream");\r
+            DateTimeFormatter formatter = DateTimeFormatter.ofPattern("dd-MM-yyyy HH:mm:ss");\r
+            resp.setHeader("Content-Disposition",\r
+                "attachment; filename=\"result:" + LocalDateTime.now().format(formatter) + ".csv\"");\r
+            eventlogger.info("Generating CSV file from Statistics resultset");\r
+            rsToCSV(rs, out);\r
+        } else {\r
+            eventlogger.info("Generating JSON for Statistics resultset");\r
+            this.rsToJson(rs, out);\r
         }\r
     }\r
 }\r