3 * ============LICENSE_START==========================================
5 * ===================================================================
6 * Copyright © 2017 AT&T Intellectual Property. All rights reserved.
7 * ===================================================================
9 * Unless otherwise specified, all software contained herein is licensed
10 * under the Apache License, Version 2.0 (the "License");
11 * you may not use this software except in compliance with the License.
12 * You may obtain a copy of the License at
14 * http://www.apache.org/licenses/LICENSE-2.0
16 * Unless required by applicable law or agreed to in writing, software
17 * distributed under the License is distributed on an "AS IS" BASIS,
18 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19 * See the License for the specific language governing permissions and
20 * limitations under the License.
22 * Unless otherwise specified, all documentation contained herein is licensed
23 * under the Creative Commons License, Attribution 4.0 Intl. (the "License");
24 * you may not use this documentation except in compliance with the License.
25 * You may obtain a copy of the License at
27 * https://creativecommons.org/licenses/by/4.0/
29 * Unless required by applicable law or agreed to in writing, documentation
30 * distributed under the License is distributed on an "AS IS" BASIS,
31 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
32 * See the License for the specific language governing permissions and
33 * limitations under the License.
35 * ============LICENSE_END============================================
39 package org.onap.portalapp.filter;
41 import java.io.BufferedReader;
42 import java.io.ByteArrayInputStream;
43 import java.io.ByteArrayOutputStream;
44 import java.io.IOException;
45 import java.io.InputStreamReader;
46 import java.nio.charset.StandardCharsets;
48 import javax.servlet.FilterChain;
49 import javax.servlet.ReadListener;
50 import javax.servlet.ServletException;
51 import javax.servlet.ServletInputStream;
52 import javax.servlet.http.HttpServletRequest;
53 import javax.servlet.http.HttpServletRequestWrapper;
54 import javax.servlet.http.HttpServletResponse;
56 import org.apache.commons.io.IOUtils;
57 import org.apache.commons.lang.StringUtils;
58 import org.apache.http.HttpStatus;
59 import org.onap.portalsdk.core.logging.logic.EELFLoggerDelegate;
60 import org.springframework.web.filter.OncePerRequestFilter;
62 public class SecurityXssFilter extends OncePerRequestFilter {
64 private EELFLoggerDelegate logger = EELFLoggerDelegate.getLogger(SecurityXssFilter.class);
66 private static final String APPLICATION_JSON = "application/json";
68 private static final String ERROR_BAD_REQUEST = "{\"error\":\"BAD_REQUEST\"}";
70 private SecurityXssValidator validator = SecurityXssValidator.getInstance();
72 public class RequestWrapper extends HttpServletRequestWrapper {
74 private ByteArrayOutputStream cachedBytes;
76 public RequestWrapper(HttpServletRequest request) {
81 public ServletInputStream getInputStream() throws IOException {
82 if (cachedBytes == null)
85 return new CachedServletInputStream();
89 public BufferedReader getReader() throws IOException {
90 return new BufferedReader(new InputStreamReader(getInputStream()));
93 private void cacheInputStream() throws IOException {
94 cachedBytes = new ByteArrayOutputStream();
95 IOUtils.copy(super.getInputStream(), cachedBytes);
98 public class CachedServletInputStream extends ServletInputStream {
99 private ByteArrayInputStream input;
101 public CachedServletInputStream() {
102 input = new ByteArrayInputStream(cachedBytes.toByteArray());
106 public int read() throws IOException {
111 public boolean isFinished() {
116 public boolean isReady() {
121 public void setReadListener(ReadListener readListener) {
129 protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain)
130 throws ServletException, IOException {
131 if (validateRequestType(request)) {
132 request = new RequestWrapper(request);
133 String requestData = IOUtils.toString(request.getInputStream(), StandardCharsets.UTF_8.toString());
135 if (StringUtils.isNotBlank(requestData) && validator.denyXSS(requestData)) {
136 response.setContentType(APPLICATION_JSON);
137 response.setStatus(HttpStatus.SC_BAD_REQUEST);
138 response.getWriter().write(ERROR_BAD_REQUEST);
139 throw new SecurityException(ERROR_BAD_REQUEST);
141 } catch (Exception e) {
142 logger.error(EELFLoggerDelegate.errorLogger, "doFilterInternal() failed due to BAD_REQUEST", e);
143 response.getWriter().close();
146 filterChain.doFilter(request, response);
149 filterChain.doFilter(request, response);
154 private boolean validateRequestType(HttpServletRequest request) {
155 return (request.getMethod().equalsIgnoreCase("POST") || request.getMethod().equalsIgnoreCase("PUT")
156 || request.getMethod().equalsIgnoreCase("DELETE"));