Files
oslo.middleware/oslo_middleware/sizelimit.py
Mehdi Abaakouk e744501c47 Remove usage of oslo.config global
Currently application that doesn't use the global configuration object
have to rely on hack to setup the global oslo config object for each middleware
it want to use.

For example, gnocchi have its own middleware loader and add crap to load
keystonemiddleware:

  https://github.com/openstack/gnocchi/blob/master/gnocchi/rest/app.py#L140

And it can't use oslo.middleware that relies on the global conf object.

Also aodh (use 'paste' for middleware) have to hack the global
configuration object for each middlewares it want to use by code...

  https://review.openstack.org/#/c/208632/1/aodh/service.py

But middleware are optional deployer stuffs, we should not write any
code for them...

This change allows application to use paste-deploy (or any middleware
loader) without enforcing the application to use the global oslo.config object.

If the middleware want to use oslo.config it should load the
configuration file himself (and fallback to the global one if any)

The proposed paste configuration to allow this is:

  [filter:cors]
  paste.filter_factory = oslo.middleware:cors
  oslo_config_project = aodh

So the cors middleware can find and load the aodh config and
what is it interested in.

Also, some of them use oslo.config local, some other the global object.
Some can be loaded by an middleware loader like paste, some other not.

This change make consistent the way we bootstrap all middlewares.

Closes-bug: #1482086

Change-Id: Iad197d1f3a386683d818b59718df34e14e15ca5c
2015-08-07 08:22:42 +02:00

96 lines
3.2 KiB
Python

# Copyright (c) 2012 Red Hat, Inc.
#
# 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.
"""
Request Body limiting middleware.
"""
from oslo_config import cfg
import webob.dec
import webob.exc
from oslo_middleware._i18n import _
from oslo_middleware import base
_oldopts = [cfg.DeprecatedOpt('osapi_max_request_body_size',
group='DEFAULT'),
cfg.DeprecatedOpt('max_request_body_size',
group='DEFAULT')]
_opts = [
# default request size is 112k
cfg.IntOpt('max_request_body_size',
default=114688,
help='The maximum body size for each '
' request, in bytes.',
deprecated_opts=_oldopts)
]
class LimitingReader(object):
"""Reader to limit the size of an incoming request."""
def __init__(self, data, limit):
"""Initiates LimitingReader object.
:param data: Underlying data object
:param limit: maximum number of bytes the reader should allow
"""
self.data = data
self.limit = limit
self.bytes_read = 0
def __iter__(self):
for chunk in self.data:
self.bytes_read += len(chunk)
if self.bytes_read > self.limit:
msg = _("Request is too large.")
raise webob.exc.HTTPRequestEntityTooLarge(explanation=msg)
else:
yield chunk
def read(self, i=None):
# NOTE(jamielennox): We can't simply provide the default to the read()
# call as the expected default differs between mod_wsgi and eventlet
if i is None:
result = self.data.read()
else:
result = self.data.read(i)
self.bytes_read += len(result)
if self.bytes_read > self.limit:
msg = _("Request is too large.")
raise webob.exc.HTTPRequestEntityTooLarge(explanation=msg)
return result
class RequestBodySizeLimiter(base.Middleware):
"""Limit the size of incoming requests."""
def __init__(self, application, conf=None):
super(RequestBodySizeLimiter, self).__init__(application, conf)
self.oslo_conf.register_opts(_opts, group='oslo_middleware')
@webob.dec.wsgify
def __call__(self, req):
max_size = self.oslo_conf.oslo_middleware.max_request_body_size
if (req.content_length is not None and
req.content_length > max_size):
msg = _("Request is too large.")
raise webob.exc.HTTPRequestEntityTooLarge(explanation=msg)
if req.content_length is None and req.is_body_readable:
limiter = LimitingReader(req.body_file, max_size)
req.body_file = limiter
return self.application