サーブレットフィルターを使用して要求パラメーターを変更する


114

既存のWebアプリケーションがTomcat 4.1で実行されています。ページにXSSの問題がありますが、ソースを変更できません。ページに表示される前にパラメーターをサニタイズするサーブレットフィルターを作成することにしました。

次のようなFilterクラスを記述したいと思います。

import java.io.*;
import javax.servlet.*;

public final class XssFilter implements Filter {

  public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
      throws IOException, ServletException
  {
    String badValue = request.getParameter("dangerousParamName");
    String goodValue = sanitize(badValue);
    request.setParameter("dangerousParamName", goodValue);
    chain.doFilter(request, response);
  }

  public void destroy() {
  }

  public void init(FilterConfig filterConfig) {
  }
}

しかしServletRequest.setParameter、存在しません。

リクエストをチェーンに渡す前に、リクエストパラメータの値を変更するにはどうすればよいですか?


HttpServletRequestWrapperには多くのAPIが定義されています。すべてのAPIを有意義に理解しようとしています。Javadocは 'userinRole'、 'getPrincipal'etxなどのAPIを理解するのに役立ちません。
sskumar86 2016年

回答:


132

あなたが述べてきたようにHttpServletRequestsetParameterを使用する方法はありません。これは意図的なものです。クラスはクライアントからの要求を表し、パラメーターを変更してもそれは表されないためです。

1つの解決策は、HttpServletRequestWrapperクラスを使用することです。これにより、1つの要求を別の要求でラップできます。それをサブクラス化し、getParameterメソッドをオーバーライドして、サニタイズされた値を返すことができます。その後chain.doFilter、元のリクエストの代わりにラップされたリクエストを渡すことができます。

少し見づらいですが、サーブレットAPIはそうすべきだと言っています。他に何かをに渡そうとするとdoFilter、一部のサーブレットコンテナは、仕様に違反したことを報告し、その処理を拒否します。

より洗練された解決策はより多くの作業です-パラメータではなくリクエスト属性を期待するように、パラメータを処理する元のサーブレット/ JSPを変更します。フィルターはパラメーターを調べ、それをrequest.setAttributeサニタイズし、サニタイズされた値で(を使用して)属性を設定します。サブクラス化やスプーフィングはありませんが、アプリケーションの他の部分を変更する必要があります。


6
HttpServletRequestWrapperは素晴らしいです。それが存在することを知りませんでした。ありがとう!
ジェレミースタイン

3
属性設定の代替案をありがとう!Head FirstサーブレットとJSPのリクエストラッパーとレスポンスラッパーを使用してサンプルコードを確認しましたが、仕様が人々をそうした方法で進めるように仕向けているとは信じられませんでした。
ケビン

私はコントローラーの値を<property name="username" value="somemail@gmail.com" /> //Change email on logging in <property name="password" value="*********" />//Change Password on logging in
使って連絡を取り

73

参考までに、私が書いたクラスは次のとおりです。

import java.io.IOException;

import javax.servlet.Filter;
import javax.servlet.FilterChain;
import javax.servlet.FilterConfig;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletRequestWrapper;

public final class XssFilter implements Filter {

    static class FilteredRequest extends HttpServletRequestWrapper {

        /* These are the characters allowed by the Javascript validation */
        static String allowedChars = "+-0123456789#*";

        public FilteredRequest(ServletRequest request) {
            super((HttpServletRequest)request);
        }

        public String sanitize(String input) {
            String result = "";
            for (int i = 0; i < input.length(); i++) {
                if (allowedChars.indexOf(input.charAt(i)) >= 0) {
                    result += input.charAt(i);
                }
            }
            return result;
        }

        public String getParameter(String paramName) {
            String value = super.getParameter(paramName);
            if ("dangerousParamName".equals(paramName)) {
                value = sanitize(value);
            }
            return value;
        }

        public String[] getParameterValues(String paramName) {
            String values[] = super.getParameterValues(paramName);
            if ("dangerousParamName".equals(paramName)) {
                for (int index = 0; index < values.length; index++) {
                    values[index] = sanitize(values[index]);
                }
            }
            return values;
        }
    }

    public void doFilter(ServletRequest request, ServletResponse response,
            FilterChain chain) throws IOException, ServletException {
        chain.doFilter(new FilteredRequest(request), response);
    }

    public void destroy() {
    }

    public void init(FilterConfig filterConfig) {
    }
}

5
getParameterMapメソッドも考慮する必要がある場合があります。コンポーネントがメソッドを使用せず、サニタイズロジックをスキップするように、サポートされていない例外をスローする可能性があります。
Tom

1
良い点、トム。この特定のケースでは、チェックしたところ、呼び出されていないことがわかりましたが、完全性と次の人のために追加する必要がありました。ありがとう!
ジェレミースタイン

13
私はその次の人、ジェレミーのようです。外部のアプリケーションからサードパーティのサーブレットに渡されるデータを変更するオプションを探しているときに、この投稿を見つけました。私の場合、サーブレットはHTTPServletRequest.getParameter()、getParameterMap()、またはgetAttribute()を呼び出して要求データを取得していなかったため、試行錯誤の結果、サーブレットがHTTPServletRequest.getInputStream()を呼び出していると判断しました。およびgetQueryString()。閉じたサーブレットに対してこのタスクを試みる人への私のアドバイスは、実際に何が起こっているのかを理解するために、すべてのアクセサーをHTTPServletRequestにラップすることです
Fred Sobotka '24

3
SrpingMVCの場合、getParameterValues()をオーバーライドしてSpringをだます必要があります。RequestParamMethodArgumentResolver.resovleName()はそのメソッドを使用するため、オーバーライドせずにMissingServletRequestParameterExceptionを取得します。Spring Boot 1.2.6とspring-web 4.1.7でテスト済み。
barryku

10

入力のサニタイズさHttpServletRequestWrapperれたバージョンを返すgetParameter()メソッドでサブクラス化する単純なクラスを記述します。次に、あなたのインスタンスを渡すHttpServletRequestWrapperFilter.doChain()直接代わりにリクエストオブジェクトの。


1

同じ問題がありました(フィルターのHTTPリクエストからパラメーターを変更)。を使用して終了しましたThreadLocal<String>。でFilter私が持っています:

class MyFilter extends Filter {
    public static final ThreadLocal<String> THREAD_VARIABLE = new ThreadLocal<>();
    public void doFilter(HttpServletRequest request, HttpServletResponse response, FilterChain chain) {
        THREAD_VARIABLE.set("myVariableValue");
        chain.doFilter(request, response);
    }
}

私の要求プロセッサー(HttpServlet、JSFコントローラー、またはその他のHTTP要求プロセッサー)で、現在のスレッド値を取得します。

...
String myVariable = MyFilter.THREAD_VARIABLE.get();
...

利点:

  • HTTPパラメータを渡すよりも用途が広い(POJOオブジェクトを渡すことができます)
  • やや高速(変数値を抽出するためにURLを解析する必要はありません)
  • よりエレガントな HttpServletRequestWrapperボイラープレート
  • 変数のスコープは単なるHTTPリクエストよりも広いです(実行するときに持っているスコープ) request.setAttribute(String,Object)、つまり、他のフィルターで変数にアクセスできます)。

短所:

  • このメソッドは、フィルターを処理するスレッドがHTTP要求を処理するスレッドと同じである場合にのみ使用できます(これは、私が知っているすべてのJavaベースのサーバーに当てはまります)。したがって、これはは機能しません
    • HTTPリダイレクトを行う(ブラウザーが新しいHTTPリクエストを実行し、同じスレッドによって処理されることを保証する方法がないため)
    • 別々のスレッドデータを処理する(例:、、を使用するjava.util.stream.Stream.parallel場合java.util.concurrent.Futurejava.lang.Thread
  • リクエストプロセッサ/アプリケーションを変更できる必要があります

いくつかの付記:

  • サーバーには、HTTP要求を処理するスレッドプールがあります。これはプールなので:

    1. このスレッドプールのスレッドは多くのHTTPリクエストを処理しますが、一度に1つだけです(したがって、使用後に変数をクリーンアップするか、HTTPリクエストごとに定義する必要があります= if (value!=null) { THREAD_VARIABLE.set(value);}値を再利用するためなどのコードに注意してくださいvalueがnullの場合、前のHTTPリクエストから:副作用が保証されます)。
    2. 2つの要求が同じスレッドで処理される保証はありません(その場合もありますが、保証はありません)。ユーザーデータをあるリクエストから別のリクエストに保持する必要がある場合は、HttpSession.setAttribute()
  • JEEは@RequestScoped内部でを使用しますがThreadLocal、を使用するThreadLocalとより用途が広がります。JEE/ CDI以外のコンテナ(マルチスレッドJREアプリケーションなど)で使用できます。

スレッドのスコープにパラメーターを設定することは本当に良い考えですか?複数のリクエストで同じスレッドが表示されることはありますか?(私はそうではないと思います)
ザカリークレイグ

それは良い考えですか=はい(ただし、JEE @RequestScopedは内部的に同じことをしているので、自分が何をしているかを知る必要があります)。複数のリクエストで同じスレッドが表示される=いいえ(または少なくとも保証はありません)。私はこれらの点を正確にするために答えを編集しました。
ジュリアンクロネッグ2018年

1

これは私がやったことです

//import ../../Constants;

public class RequestFilter implements Filter {

    private static final Logger logger = LoggerFactory.getLogger(RequestFilter.class);

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
    }

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain)
        throws IOException, ServletException {
        try {
            CustomHttpServletRequest customHttpServletRequest = new CustomHttpServletRequest((HttpServletRequest) servletRequest);
            filterChain.doFilter(customHttpServletRequest, servletResponse);
        } finally {
            //do something here
        }
    }



    @Override
    public void destroy() {

    }

     public static Map<String, String[]> ADMIN_QUERY_PARAMS = new HashMap<String, String[]>() {
        {
            put("diagnostics", new String[]{"false"});
            put("skipCache", new String[]{"false"});
        }
    };

    /*
        This is a custom wrapper over the `HttpServletRequestWrapper` which 
        overrides the various header getter methods and query param getter methods.
        Changes to the request pojo are
        => A custom header is added whose value is a unique id
        => Admin query params are set to default values in the url
    */
    private class CustomHttpServletRequest extends HttpServletRequestWrapper {
        public CustomHttpServletRequest(HttpServletRequest request) {
            super(request);
            //create custom id (to be returned) when the value for a
            //particular header is asked for
            internalRequestId = RandomStringUtils.random(10, true, true) + "-local";
        }

        public String getHeader(String name) {
            String value = super.getHeader(name);
            if(Strings.isNullOrEmpty(value) && isRequestIdHeaderName(name)) {
                value = internalRequestId;
            }
            return value;
        }

        private boolean isRequestIdHeaderName(String name) {
            return Constants.RID_HEADER.equalsIgnoreCase(name) || Constants.X_REQUEST_ID_HEADER.equalsIgnoreCase(name);
        }

        public Enumeration<String> getHeaders(String name) {
            List<String> values = Collections.list(super.getHeaders(name));
            if(values.size()==0 && isRequestIdHeaderName(name)) {
                values.add(internalRequestId);
            }
            return Collections.enumeration(values);
        }

        public Enumeration<String> getHeaderNames() {
            List<String> names = Collections.list(super.getHeaderNames());
            names.add(Constants.RID_HEADER);
            names.add(Constants.X_REQUEST_ID_HEADER);
            return Collections.enumeration(names);
        }

        public String getParameter(String name) {
            if (ADMIN_QUERY_PARAMS.get(name) != null) {
                return ADMIN_QUERY_PARAMS.get(name)[0];
            }
            return super.getParameter(name);
        }

        public Map<String, String[]> getParameterMap() {
            Map<String, String[]> paramsMap = new HashMap<>(super.getParameterMap());
            for (String paramName : ADMIN_QUERY_PARAMS.keySet()) {
                if (paramsMap.get(paramName) != null) {
                    paramsMap.put(paramName, ADMIN_QUERY_PARAMS.get(paramName));
                }
            }
            return paramsMap;
        }

        public String[] getParameterValues(String name) {
            if (ADMIN_QUERY_PARAMS.get(name) != null) {
                return ADMIN_QUERY_PARAMS.get(name);
            }
            return super.getParameterValues(name);
        }

        public String getQueryString() {
            Map<String, String[]> map = getParameterMap();
            StringBuilder builder = new StringBuilder();
            for (String param: map.keySet()) {
                for (String value: map.get(param)) {
                    builder.append(param).append("=").append(value).append("&");
                }
            }
            builder.deleteCharAt(builder.length() - 1);
            return builder.toString();
        }
    }
}

1

ここでのすべての発言に基づいて、私のために働いた私の提案があります:

 private final class CustomHttpServletRequest extends HttpServletRequestWrapper {

    private final Map<String, String[]> queryParameterMap;
    private final Charset requestEncoding;

    public CustomHttpServletRequest(HttpServletRequest request) {
        super(request);
        queryParameterMap = getCommonQueryParamFromLegacy(request.getParameterMap());

        String encoding = request.getCharacterEncoding();
        requestEncoding = (encoding != null ? Charset.forName(encoding) : StandardCharsets.UTF_8);
    }

    private final Map<String, String[]> getCommonQueryParamFromLegacy(Map<String, String[]> paramMap) {
        Objects.requireNonNull(paramMap);

        Map<String, String[]> commonQueryParamMap = new LinkedHashMap<>(paramMap);

        commonQueryParamMap.put(CommonQueryParams.PATIENT_ID, new String[] { paramMap.get(LEGACY_PARAM_PATIENT_ID)[0] });
        commonQueryParamMap.put(CommonQueryParams.PATIENT_BIRTHDATE, new String[] { paramMap.get(LEGACY_PARAM_PATIENT_BIRTHDATE)[0] });
        commonQueryParamMap.put(CommonQueryParams.KEYWORDS, new String[] { paramMap.get(LEGACY_PARAM_STUDYTYPE)[0] });

        String lowerDateTime = null;
        String upperDateTime = null;

        try {
            String studyDateTime = new SimpleDateFormat("yyyy-MM-dd").format(new SimpleDateFormat("dd-MM-yyyy").parse(paramMap.get(LEGACY_PARAM_STUDY_DATE_TIME)[0]));

            lowerDateTime = studyDateTime + "T23:59:59";
            upperDateTime = studyDateTime + "T00:00:00";

        } catch (ParseException e) {
            LOGGER.error("Can't parse StudyDate from query parameters : {}", e.getLocalizedMessage());
        }

        commonQueryParamMap.put(CommonQueryParams.LOWER_DATETIME, new String[] { lowerDateTime });
        commonQueryParamMap.put(CommonQueryParams.UPPER_DATETIME, new String[] { upperDateTime });

        legacyQueryParams.forEach(commonQueryParamMap::remove);
        return Collections.unmodifiableMap(commonQueryParamMap);

    }

    @Override
    public String getParameter(String name) {
        String[] params = queryParameterMap.get(name);
        return params != null ? params[0] : null;
    }

    @Override
    public String[] getParameterValues(String name) {
        return queryParameterMap.get(name);
    }

    @Override
    public Map<String, String[]> getParameterMap() {
            return queryParameterMap; // unmodifiable to uphold the interface contract.
        }

        @Override
        public Enumeration<String> getParameterNames() {
            return Collections.enumeration(queryParameterMap.keySet());
        }

        @Override
        public String getQueryString() {
            // @see : https://stackoverflow.com/a/35831692/9869013
            // return queryParameterMap.entrySet().stream().flatMap(entry -> Stream.of(entry.getValue()).map(value -> entry.getKey() + "=" + value)).collect(Collectors.joining("&")); // without encoding !!
            return queryParameterMap.entrySet().stream().flatMap(entry -> encodeMultiParameter(entry.getKey(), entry.getValue(), requestEncoding)).collect(Collectors.joining("&"));
        }

        private Stream<String> encodeMultiParameter(String key, String[] values, Charset encoding) {
            return Stream.of(values).map(value -> encodeSingleParameter(key, value, encoding));
        }

        private String encodeSingleParameter(String key, String value, Charset encoding) {
            return urlEncode(key, encoding) + "=" + urlEncode(value, encoding);
        }

        private String urlEncode(String value, Charset encoding) {
            try {
                return URLEncoder.encode(value, encoding.name());
            } catch (UnsupportedEncodingException e) {
                throw new IllegalArgumentException("Cannot url encode " + value, e);
            }
        }

        @Override
        public ServletInputStream getInputStream() throws IOException {
            throw new UnsupportedOperationException("getInputStream() is not implemented in this " + CustomHttpServletRequest.class.getSimpleName() + " wrapper");
        }

    }

注:queryString()は各キーのすべての値を処理する必要があり、必要に応じて独自のparam値を追加するときにencodeUrl()を忘れないでください

制限として、request.getParameterMap()またはrequest.getReader()を呼び出す任意のメソッドを呼び出して読み取りを開始すると、request.setCharacterEncoding(...)がそれ以上呼び出されないようになります。


0

正規化を使用してサニタイズできます。chain.doFilter(request、response)メソッドを呼び出す前にフィルター内で、このコードを呼び出します。これがサンプルコードです:

for (Enumeration en = request.getParameterNames(); en.hasMoreElements(); ) {
String name = (String)en.nextElement();
String values[] = request.getParameterValues(name);
int n = values.length;
    for(int i=0; i < n; i++) {
     values[i] = values[i].replaceAll("[^\\dA-Za-z ]","").replaceAll("\\s+","+").trim();   
    }
}

1
この方法で元のリクエストパラメータを変更するのではなく、コピーで変更します。
Mehdi、

-1

お試しくださいrequest.setAttribute("param",value);。それは私にとってはうまくいきました。

このコードサンプルを見つけてください:

private void sanitizePrice(ServletRequest request){
        if(request.getParameterValues ("price") !=  null){
            String price[] = request.getParameterValues ("price");

            for(int i=0;i<price.length;i++){
                price[i] = price[i].replaceAll("[^\\dA-Za-z0-9- ]", "").trim();
                System.out.println(price[i]);
            }
            request.setAttribute("price", price);
            //request.getParameter("numOfBooks").re
        }
    }
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.