23c772c78a
LOG.warn is deprecated. It is still used in few modules. Replaced with non-deprecated LOG.warning. Change-Id: I62b9878fb1cecd70ffaf614a642c68cb04e22130 Closes-Bug: #1508442
453 lines
18 KiB
Python
453 lines
18 KiB
Python
# Copyright (c) 2015 Hewlett-Packard Development Company, L.P.
|
|
#
|
|
# 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.
|
|
|
|
import copy
|
|
import logging
|
|
|
|
import debtcollector
|
|
from oslo_config import cfg
|
|
from oslo_middleware import base
|
|
import six
|
|
import webob.exc
|
|
|
|
|
|
LOG = logging.getLogger(__name__)
|
|
|
|
CORS_OPTS = [
|
|
cfg.ListOpt('allowed_origin',
|
|
default=None,
|
|
help='Indicate whether this resource may be shared with the '
|
|
'domain received in the requests "origin" header. '
|
|
'Format: "<protocol>://<host>[:<port>]", no trailing '
|
|
'slash. Example: https://horizon.example.com'),
|
|
cfg.BoolOpt('allow_credentials',
|
|
default=True,
|
|
help='Indicate that the actual request can include user '
|
|
'credentials'),
|
|
cfg.ListOpt('expose_headers',
|
|
default=[],
|
|
help='Indicate which headers are safe to expose to the API. '
|
|
'Defaults to HTTP Simple Headers.'),
|
|
cfg.IntOpt('max_age',
|
|
default=3600,
|
|
help='Maximum cache age of CORS preflight requests.'),
|
|
cfg.ListOpt('allow_methods',
|
|
default=['OPTIONS', 'GET', 'HEAD', 'POST', 'PUT', 'DELETE',
|
|
'TRACE', 'PATCH'], # RFC 2616, RFC 5789
|
|
help='Indicate which methods can be used during the actual '
|
|
'request.'),
|
|
cfg.ListOpt('allow_headers',
|
|
default=[],
|
|
help='Indicate which header field names may be used during '
|
|
'the actual request.')
|
|
]
|
|
|
|
|
|
def set_defaults(**kwargs):
|
|
"""Override the default values for configuration options.
|
|
|
|
This method permits a project to override the default CORS option values.
|
|
For example, it may wish to offer a set of sane default headers which
|
|
allow it to function with only minimal additional configuration.
|
|
|
|
:param allow_credentials: Whether to permit credentials.
|
|
:type allow_credentials: bool
|
|
:param expose_headers: A list of headers to expose.
|
|
:type expose_headers: List of Strings
|
|
:param max_age: Maximum cache duration in seconds.
|
|
:type max_age: Int
|
|
:param allow_methods: List of HTTP methods to permit.
|
|
:type allow_methods: List of Strings
|
|
:param allow_headers: List of HTTP headers to permit from the client.
|
|
:type allow_headers: List of Strings
|
|
"""
|
|
# Since 'None' is a valid config override, we have to use kwargs. Else
|
|
# there's no good way for a user to override only one option, because all
|
|
# the others would be overridden to 'None'.
|
|
|
|
valid_params = set(k.name for k in CORS_OPTS
|
|
if k.name != 'allowed_origin')
|
|
passed_params = set(k for k in kwargs)
|
|
|
|
wrong_params = passed_params - valid_params
|
|
if wrong_params:
|
|
raise AttributeError('Parameter(s) [%s] invalid, please only use [%s]'
|
|
% (wrong_params, valid_params))
|
|
|
|
# Set global defaults.
|
|
cfg.set_defaults(CORS_OPTS, **kwargs)
|
|
|
|
|
|
class InvalidOriginError(Exception):
|
|
"""Exception raised when Origin is invalid."""
|
|
|
|
def __init__(self, origin):
|
|
self.origin = origin
|
|
super(InvalidOriginError, self).__init__(
|
|
'CORS request from origin \'%s\' not permitted.' % origin)
|
|
|
|
|
|
class CORS(base.ConfigurableMiddleware):
|
|
"""CORS Middleware.
|
|
|
|
This middleware allows a WSGI app to serve CORS headers for multiple
|
|
configured domains.
|
|
|
|
For more information, see http://www.w3.org/TR/cors/
|
|
"""
|
|
|
|
simple_headers = [
|
|
'Accept',
|
|
'Accept-Language',
|
|
'Content-Type',
|
|
'Cache-Control',
|
|
'Content-Language',
|
|
'Expires',
|
|
'Last-Modified',
|
|
'Pragma'
|
|
]
|
|
|
|
def __init__(self, application, *args, **kwargs):
|
|
super(CORS, self).__init__(application, *args, **kwargs)
|
|
# Begin constructing our configuration hash.
|
|
self.allowed_origins = {}
|
|
self._init_conf()
|
|
|
|
def sanitize(csv_list):
|
|
try:
|
|
return [str.strip(x) for x in csv_list.split(',')]
|
|
except Exception:
|
|
return None
|
|
|
|
self.set_latent(
|
|
allow_headers=sanitize(self.conf.get('latent_allow_headers')),
|
|
expose_headers=sanitize(self.conf.get('latent_expose_headers')),
|
|
allow_methods=sanitize(self.conf.get('latent_allow_methods'))
|
|
)
|
|
|
|
@classmethod
|
|
def factory(cls, global_conf, **local_conf):
|
|
"""factory method for paste.deploy
|
|
|
|
allowed_origin: Protocol, host, and port for the allowed origin.
|
|
allow_credentials: Whether to permit credentials.
|
|
expose_headers: A list of headers to expose.
|
|
max_age: Maximum cache duration.
|
|
allow_methods: List of HTTP methods to permit.
|
|
allow_headers: List of HTTP headers to permit from the client.
|
|
"""
|
|
if ('allowed_origin' not in local_conf
|
|
and 'oslo_config_project' not in local_conf):
|
|
raise TypeError("allowed_origin or oslo_config_project "
|
|
"is required")
|
|
return super(CORS, cls).factory(global_conf, **local_conf)
|
|
|
|
def _init_conf(self):
|
|
'''Initialize this middleware from an oslo.config instance.'''
|
|
|
|
# Set up a location for our latent configuration options
|
|
self._latent_configuration = {
|
|
'allow_headers': [],
|
|
'expose_headers': [],
|
|
'methods': []
|
|
}
|
|
|
|
# First, check the configuration and register global options.
|
|
self.oslo_conf.register_opts(CORS_OPTS, 'cors')
|
|
|
|
allowed_origin = self._conf_get('allowed_origin', 'cors')
|
|
allow_credentials = self._conf_get('allow_credentials', 'cors')
|
|
expose_headers = self._conf_get('expose_headers', 'cors')
|
|
max_age = self._conf_get('max_age', 'cors')
|
|
allow_methods = self._conf_get('allow_methods', 'cors')
|
|
allow_headers = self._conf_get('allow_headers', 'cors')
|
|
|
|
# Clone our original CORS_OPTS, and set the defaults to whatever is
|
|
# set in the global conf instance. This is done explicitly (instead
|
|
# of **kwargs), since we don't accidentally want to catch
|
|
# allowed_origin.
|
|
subgroup_opts = copy.deepcopy(CORS_OPTS)
|
|
cfg.set_defaults(subgroup_opts,
|
|
allow_credentials=allow_credentials,
|
|
expose_headers=expose_headers,
|
|
max_age=max_age,
|
|
allow_methods=allow_methods,
|
|
allow_headers=allow_headers)
|
|
|
|
# If the default configuration contains an allowed_origin, don't
|
|
# forget to register that.
|
|
self.add_origin(allowed_origin=allowed_origin,
|
|
allow_credentials=allow_credentials,
|
|
expose_headers=expose_headers,
|
|
max_age=max_age,
|
|
allow_methods=allow_methods,
|
|
allow_headers=allow_headers)
|
|
|
|
# Iterate through all the loaded config sections, looking for ones
|
|
# prefixed with 'cors.'
|
|
for section in self.oslo_conf.list_all_sections():
|
|
if section.startswith('cors.'):
|
|
debtcollector.deprecate('Multiple configuration blocks are '
|
|
'deprecated and will be removed in '
|
|
'future versions. Please consolidate '
|
|
'your configuration in the [cors] '
|
|
'configuration block.')
|
|
# Register with the preconstructed defaults
|
|
self.oslo_conf.register_opts(subgroup_opts, section)
|
|
self.add_origin(**self.oslo_conf[section])
|
|
|
|
def add_origin(self, allowed_origin, allow_credentials=True,
|
|
expose_headers=None, max_age=None, allow_methods=None,
|
|
allow_headers=None):
|
|
'''Add another origin to this filter.
|
|
|
|
:param allowed_origin: Protocol, host, and port for the allowed origin.
|
|
:param allow_credentials: Whether to permit credentials.
|
|
:param expose_headers: A list of headers to expose.
|
|
:param max_age: Maximum cache duration.
|
|
:param allow_methods: List of HTTP methods to permit.
|
|
:param allow_headers: List of HTTP headers to permit from the client.
|
|
:return:
|
|
'''
|
|
|
|
# NOTE(dims): Support older code that still passes in
|
|
# a string for allowed_origin instead of a list
|
|
if isinstance(allowed_origin, six.string_types):
|
|
# TODO(krotscheck): https://review.openstack.org/#/c/312687/
|
|
LOG.warning('DEPRECATED: The `allowed_origin` keyword argument in '
|
|
'`add_origin()` should be a list, found String.')
|
|
allowed_origin = [allowed_origin]
|
|
|
|
if allowed_origin:
|
|
for origin in allowed_origin:
|
|
|
|
if origin in self.allowed_origins:
|
|
LOG.warning('Allowed origin [%s] already exists, skipping'
|
|
% (allowed_origin,))
|
|
continue
|
|
|
|
self.allowed_origins[origin] = {
|
|
'allow_credentials': allow_credentials,
|
|
'expose_headers': expose_headers,
|
|
'max_age': max_age,
|
|
'allow_methods': allow_methods,
|
|
'allow_headers': allow_headers
|
|
}
|
|
|
|
def set_latent(self, allow_headers=None, allow_methods=None,
|
|
expose_headers=None):
|
|
'''Add a new latent property for this middleware.
|
|
|
|
Latent properties are those values which a system requires for
|
|
operation. API-specific headers, for example, may be added by an
|
|
engineer so that they ship with the codebase, and thus do not require
|
|
extra documentation or passing of institutional knowledge.
|
|
|
|
:param allow_headers: HTTP headers permitted in client requests.
|
|
:param allow_methods: HTTP methods permitted in client requests.
|
|
:param expose_headers: HTTP Headers exposed to clients.
|
|
'''
|
|
|
|
if allow_headers:
|
|
if isinstance(allow_headers, list):
|
|
self._latent_configuration['allow_headers'] = allow_headers
|
|
else:
|
|
raise TypeError("allow_headers must be a list or None.")
|
|
|
|
if expose_headers:
|
|
if isinstance(expose_headers, list):
|
|
self._latent_configuration['expose_headers'] = expose_headers
|
|
else:
|
|
raise TypeError("expose_headers must be a list or None.")
|
|
|
|
if allow_methods:
|
|
if isinstance(allow_methods, list):
|
|
self._latent_configuration['methods'] = allow_methods
|
|
else:
|
|
raise TypeError("allow_methods parameter must be a list or"
|
|
" None.")
|
|
|
|
def process_response(self, response, request=None):
|
|
'''Check for CORS headers, and decorate if necessary.
|
|
|
|
Perform two checks. First, if an OPTIONS request was issued, let the
|
|
application handle it, and (if necessary) decorate the response with
|
|
preflight headers. In this case, if a 404 is thrown by the underlying
|
|
application (i.e. if the underlying application does not handle
|
|
OPTIONS requests, the response code is overridden.
|
|
|
|
In the case of all other requests, regular request headers are applied.
|
|
'''
|
|
|
|
# Sanity precheck: If we detect CORS headers provided by something in
|
|
# in the middleware chain, assume that it knows better.
|
|
if 'Access-Control-Allow-Origin' in response.headers:
|
|
return response
|
|
|
|
# Doublecheck for an OPTIONS request.
|
|
if request.method == 'OPTIONS':
|
|
return self._apply_cors_preflight_headers(request=request,
|
|
response=response)
|
|
|
|
# Apply regular CORS headers.
|
|
self._apply_cors_request_headers(request=request, response=response)
|
|
|
|
# Finally, return the response.
|
|
return response
|
|
|
|
@staticmethod
|
|
def _split_header_values(request, header_name):
|
|
"""Convert a comma-separated header value into a list of values."""
|
|
values = []
|
|
if header_name in request.headers:
|
|
for value in request.headers[header_name].rsplit(','):
|
|
value = value.strip()
|
|
if value:
|
|
values.append(value)
|
|
return values
|
|
|
|
def _apply_cors_preflight_headers(self, request, response):
|
|
"""Handle CORS Preflight (Section 6.2)
|
|
|
|
Given a request and a response, apply the CORS preflight headers
|
|
appropriate for the request.
|
|
"""
|
|
|
|
# If the response contains a 2XX code, we have to assume that the
|
|
# underlying middleware's response content needs to be persisted.
|
|
# Otherwise, create a new response.
|
|
if 200 > response.status_code or response.status_code >= 300:
|
|
response = base.NoContentTypeResponse(status=webob.exc.HTTPOk.code)
|
|
|
|
# Does the request have an origin header? (Section 6.2.1)
|
|
if 'Origin' not in request.headers:
|
|
return response
|
|
|
|
# Is this origin registered? (Section 6.2.2)
|
|
try:
|
|
origin, cors_config = self._get_cors_config_by_origin(
|
|
request.headers['Origin'])
|
|
except InvalidOriginError:
|
|
return response
|
|
|
|
# If there's no request method, exit. (Section 6.2.3)
|
|
if 'Access-Control-Request-Method' not in request.headers:
|
|
LOG.debug('CORS request does not contain '
|
|
'Access-Control-Request-Method header.')
|
|
return response
|
|
request_method = request.headers['Access-Control-Request-Method']
|
|
|
|
# Extract Request headers. If parsing fails, exit. (Section 6.2.4)
|
|
try:
|
|
request_headers = \
|
|
self._split_header_values(request,
|
|
'Access-Control-Request-Headers')
|
|
except Exception:
|
|
LOG.debug('Cannot parse request headers.')
|
|
return response
|
|
|
|
# Compare request method to permitted methods (Section 6.2.5)
|
|
permitted_methods = (
|
|
cors_config['allow_methods'] +
|
|
self._latent_configuration['methods']
|
|
)
|
|
if request_method not in permitted_methods:
|
|
LOG.debug('Request method \'%s\' not in permitted list: %s'
|
|
% (request_method, permitted_methods))
|
|
return response
|
|
|
|
# Compare request headers to permitted headers, case-insensitively.
|
|
# (Section 6.2.6)
|
|
permitted_headers = [header.upper() for header in
|
|
(cors_config['allow_headers'] +
|
|
self.simple_headers +
|
|
self._latent_configuration['allow_headers'])]
|
|
for requested_header in request_headers:
|
|
upper_header = requested_header.upper()
|
|
if upper_header not in permitted_headers:
|
|
LOG.debug('Request header \'%s\' not in permitted list: %s'
|
|
% (requested_header, permitted_headers))
|
|
return response
|
|
|
|
# Set the default origin permission headers. (Sections 6.2.7, 6.4)
|
|
response.headers['Vary'] = 'Origin'
|
|
response.headers['Access-Control-Allow-Origin'] = origin
|
|
|
|
# Does this CORS configuration permit credentials? (Section 6.2.7)
|
|
if cors_config['allow_credentials']:
|
|
response.headers['Access-Control-Allow-Credentials'] = 'true'
|
|
|
|
# Attach Access-Control-Max-Age if appropriate. (Section 6.2.8)
|
|
if 'max_age' in cors_config and cors_config['max_age']:
|
|
response.headers['Access-Control-Max-Age'] = \
|
|
str(cors_config['max_age'])
|
|
|
|
# Attach Access-Control-Allow-Methods. (Section 6.2.9)
|
|
response.headers['Access-Control-Allow-Methods'] = request_method
|
|
|
|
# Attach Access-Control-Allow-Headers. (Section 6.2.10)
|
|
if request_headers:
|
|
response.headers['Access-Control-Allow-Headers'] = \
|
|
','.join(request_headers)
|
|
|
|
return response
|
|
|
|
def _get_cors_config_by_origin(self, origin):
|
|
if origin not in self.allowed_origins:
|
|
if '*' in self.allowed_origins:
|
|
origin = '*'
|
|
else:
|
|
LOG.debug('CORS request from origin \'%s\' not permitted.'
|
|
% origin)
|
|
raise InvalidOriginError(origin)
|
|
return origin, self.allowed_origins[origin]
|
|
|
|
def _apply_cors_request_headers(self, request, response):
|
|
"""Handle Basic CORS Request (Section 6.1)
|
|
|
|
Given a request and a response, apply the CORS headers appropriate
|
|
for the request to the response.
|
|
"""
|
|
|
|
# Does the request have an origin header? (Section 6.1.1)
|
|
if 'Origin' not in request.headers:
|
|
return
|
|
|
|
# Is this origin registered? (Section 6.1.2)
|
|
try:
|
|
origin, cors_config = self._get_cors_config_by_origin(
|
|
request.headers['Origin'])
|
|
except InvalidOriginError:
|
|
return
|
|
|
|
# Set the default origin permission headers. (Sections 6.1.3 & 6.4)
|
|
if 'Vary' in response.headers:
|
|
response.headers['Vary'] += ',Origin'
|
|
else:
|
|
response.headers['Vary'] = 'Origin'
|
|
response.headers['Access-Control-Allow-Origin'] = origin
|
|
|
|
# Does this CORS configuration permit credentials? (Section 6.1.3)
|
|
if cors_config['allow_credentials']:
|
|
response.headers['Access-Control-Allow-Credentials'] = 'true'
|
|
|
|
# Attach the exposed headers and exit. (Section 6.1.4)
|
|
if cors_config['expose_headers']:
|
|
response.headers['Access-Control-Expose-Headers'] = \
|
|
','.join(cors_config['expose_headers'] +
|
|
self._latent_configuration['expose_headers'])
|
|
|
|
# NOTE(sileht): Shortcut for backwards compatibility
|
|
filter_factory = CORS.factory
|