org.eclipse.jetty.server.SizeLimitHandler Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jetty-server Show documentation
The core jetty server artifact.
There is a newer version: 12.1.0.alpha0
//
// ========================================================================
// Copyright (c) 1995 Mort Bay Consulting Pty Ltd and others.
//
// This program and the accompanying materials are made available under the
// terms of the Eclipse Public License v. 2.0 which is available at
// https://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0
// which is available at https://www.apache.org/licenses/LICENSE-2.0.
//
// SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
// ========================================================================
//

package org.eclipse.jetty.server;

import java.nio.ByteBuffer;

import org.eclipse.jetty.http.BadMessageException;
import org.eclipse.jetty.http.HttpException;
import org.eclipse.jetty.http.HttpField;
import org.eclipse.jetty.http.HttpFields;
import org.eclipse.jetty.http.HttpHeader;
import org.eclipse.jetty.http.HttpStatus;
import org.eclipse.jetty.io.Content;
import org.eclipse.jetty.server.handler.gzip.GzipHandler;
import org.eclipse.jetty.util.Callback;

/**
 * A {@link Handler} that can limit the size of message bodies in requests and responses.
 * The optional request and response limits are imposed by checking the {@code Content-Length}
 * header or observing the actual bytes seen by this Handler.
 * Handler order is important; for example, if this handler is before the {@link GzipHandler},
 * then it will limit compressed sizes, if it as after the {@link GzipHandler} then it will limit
 * uncompressed sizes.
 * If a size limit is exceeded then {@link BadMessageException} is thrown with a
 * {@link HttpStatus#PAYLOAD_TOO_LARGE_413} status.
 */
public class SizeLimitHandler extends Handler.Wrapper
{
    private final long _requestLimit;
    private final long _responseLimit;

    /**
     * @param requestLimit The request body size limit in bytes or -1 for no limit
     * @param responseLimit The response body size limit in bytes or -1 for no limit
     */
    public SizeLimitHandler(long requestLimit, long responseLimit)
    {
        _requestLimit = requestLimit;
        _responseLimit = responseLimit;
    }

    @Override
    public boolean handle(Request request, Response response, Callback callback) throws Exception
    {
        HttpField contentLengthField = request.getHeaders().getField(HttpHeader.CONTENT_LENGTH);
        if (contentLengthField != null)
        {
            long contentLength = contentLengthField.getLongValue();
            if (_requestLimit >= 0 && contentLength > _requestLimit)
            {
                String s = "Request body is too large: " + contentLength + ">" + _requestLimit;
                Response.writeError(request, response, callback, HttpStatus.PAYLOAD_TOO_LARGE_413, s);
                return true;
            }
        }

        SizeLimitRequestWrapper wrappedRequest = new SizeLimitRequestWrapper(request);
        SizeLimitResponseWrapper wrappedResponse = new SizeLimitResponseWrapper(wrappedRequest, response);
        return super.handle(wrappedRequest, wrappedResponse, callback);
    }

    private class SizeLimitRequestWrapper extends Request.Wrapper
    {
        private long _read = 0;

        public SizeLimitRequestWrapper(Request wrapped)
        {
            super(wrapped);
        }

        @Override
        public Content.Chunk read()
        {
            Content.Chunk chunk = super.read();
            if (chunk == null)
                return null;
            if (chunk.getFailure() != null)
                return chunk;

            // Check request content limit.
            ByteBuffer content = chunk.getByteBuffer();
            if (content != null && content.remaining() > 0)
            {
                _read += content.remaining();
                if (_requestLimit >= 0 && _read > _requestLimit)
                {
                    BadMessageException e = new BadMessageException(HttpStatus.PAYLOAD_TOO_LARGE_413, "Request body is too large: " + _read + ">" + _requestLimit);
                    getWrapped().fail(e);
                    return null;
                }
            }

            return chunk;
        }
    }

    private class SizeLimitResponseWrapper extends Response.Wrapper
    {
        private final HttpFields.Mutable _httpFields;
        private long _written = 0;
        private HttpException.RuntimeException _failure;

        public SizeLimitResponseWrapper(Request request, Response wrapped)
        {
            super(request, wrapped);

            _httpFields = new HttpFields.Mutable.Wrapper(wrapped.getHeaders())
            {
                @Override
                public HttpField onAddField(HttpField field)
                {
                    if (field.getHeader() == HttpHeader.CONTENT_LENGTH)
                    {
                        long contentLength = field.getLongValue();
                        if (_responseLimit >= 0 && contentLength > _responseLimit)
                            throw new HttpException.RuntimeException(HttpStatus.INTERNAL_SERVER_ERROR_500, "Response body is too large: " + contentLength + ">" + _responseLimit);
                    }
                    return super.onAddField(field);
                }
            };
        }

        @Override
        public HttpFields.Mutable getHeaders()
        {
            return _httpFields;
        }

        @Override
        public void write(boolean last, ByteBuffer content, Callback callback)
        {
            if (_failure != null)
            {
                callback.failed(_failure);
                return;
            }

            if (content != null && content.remaining() > 0)
            {
                if (_responseLimit >= 0 && (_written + content.remaining())  > _responseLimit)
                {
                    _failure = new HttpException.RuntimeException(HttpStatus.INTERNAL_SERVER_ERROR_500,
                        "Response body is too large: %d>%d".formatted(_written + content.remaining(), _responseLimit));
                    callback.failed(_failure);
                    return;
                }
                _written += content.remaining();
            }

            super.write(last, content, callback);
        }
    }
}