Mercurial > p > roundup > code
diff roundup/rest.py @ 6693:9a1f5e496e6c
issue2551203 - Add support for CORS preflight request
Add support for unauthenticated CORS preflight and fix headers for
CORS.
client.py:
pass through unauthenticated CORS preflight to rest backend. Normal
rest OPTION handlers (including tracker defined extensions) can
see and handle the request.
make some error cases return error json with crrect mime type rather
than plain text tracebacks.
create new functions to verify origin and referer that filter using
allowed origins setting.
remove tracker base url from error message is referer is not at an
allowed origin.
rest.py:
fix up OPTION methods handlers to include
Access-Control-Allow-Methods that are the same as the Allow
header.
set cache to one week for all Access-Control headers for CORS
preflight only.
remove self.client.setHeader("Access-Control-Allow-Origin", "*") and
set Access-Control-Allow-Origin to the client supplied origin if
it passes allowed origin checks. Required for CORS otherwise data
isn't available to caller. Set for all responses.
set Vary header now includes Origin as responses can differ based on
Origin for all responses.
set Access-Control-Allow-Credentials to true on all responses.
test_liveserver.py:
run server with setting to enforce origin csrf header check
run server with setting to enforce x-requested-with csrf header check
run server with setting for allowed_api_origins
requests now set required csrf headers
test preflight request on collections
check new headers and Origin is no longer '*'
rewrite all compression checks to use a single method with argument
to use different compression methods. Reduce a lot of code
duplication and makes updating for new headers easier.
test_cgi:
test new error messages in client.py
account for new headers
test preflight and new code paths
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Tue, 07 Jun 2022 09:39:35 -0400 |
| parents | 01a5dd90286e |
| children | 3f60a71b0812 |
line wrap: on
line diff
--- a/roundup/rest.py Mon Jun 06 15:15:31 2022 -0400 +++ b/roundup/rest.py Tue Jun 07 09:39:35 2022 -0400 @@ -1751,6 +1751,10 @@ "Allow", "OPTIONS, GET, PUT, DELETE, PATCH" ) + self.client.setHeader( + "Access-Control-Allow-Methods", + "OPTIONS, GET, PUT, DELETE, PATCH" + ) return 204, "" @Routing.route("/data/<:class_name>/<:item_id>/<:attr_name>", 'OPTIONS') @@ -1774,12 +1778,20 @@ "Allow", "OPTIONS, GET, PUT, DELETE, PATCH" ) + self.client.setHeader( + "Access-Control-Allow-Methods", + "OPTIONS, GET, PUT, DELETE, PATCH" + ) elif attr_name in class_obj.getprops(protected=True): # It must match a protected prop. These can't be written. self.client.setHeader( "Allow", "OPTIONS, GET" ) + self.client.setHeader( + "Access-Control-Allow-Methods", + "OPTIONS, GET" + ) else: raise NotFound('Attribute %s not valid for Class %s' % ( attr_name, class_name)) @@ -1910,6 +1922,10 @@ "Allow", "OPTIONS, GET" ) + self.client.setHeader( + "Access-Control-Allow-Methods", + "OPTIONS, GET" + ) return 204, "" @Routing.route("/data") @@ -1939,6 +1955,10 @@ "Allow", "OPTIONS, GET" ) + self.client.setHeader( + "Access-Control-Allow-Methods", + "OPTIONS, GET" + ) return 204, "" @Routing.route("/summary") @@ -2161,20 +2181,46 @@ # with invalid values. data_type = ext_type or accept_type or headers.get('Accept') or "invalid" - # add access-control-allow-* to support CORS - self.client.setHeader("Access-Control-Allow-Origin", "*") + if method.upper() == 'OPTIONS': + # add access-control-allow-* access-control-max-age to support + # CORS preflight + self.client.setHeader( + "Access-Control-Allow-Headers", + "Content-Type, Authorization, X-Requested-With, X-HTTP-Method-Override" + ) + # can be overridden by options handlers to provide supported + # methods for endpoint + self.client.setHeader( + "Access-Control-Allow-Methods", + "HEAD, OPTIONS, GET, POST, PUT, DELETE, PATCH" + ) + # cache the Access headings for a week. Allows one CORS pre-flight + # request to be reused again and again. + self.client.setHeader("Access-Control-Max-Age", "86400") + + # response may change based on Origin value. + self.client.setVary("Origin") + + # Allow-Origin must match origin supplied by client. '*' doesn't + # work for authenticated requests. self.client.setHeader( - "Access-Control-Allow-Headers", - "Content-Type, Authorization, X-Requested-With, X-HTTP-Method-Override" + "Access-Control-Allow-Origin", + self.client.request.headers.get("Origin") ) + + # allow credentials + self.client.setHeader( + "Access-Control-Allow-Credentials", + "true" + ) + # set allow header in case of error. 405 handlers below should + # replace it with a custom version as will OPTIONS handler + # doing CORS. self.client.setHeader( "Allow", "OPTIONS, GET, POST, PUT, DELETE, PATCH" ) - self.client.setHeader( - "Access-Control-Allow-Methods", - "HEAD, OPTIONS, GET, POST, PUT, DELETE, PATCH" - ) + # Is there an input.value with format json data? # If so turn it into an object that emulates enough # of the FieldStorge methods/props to allow a response.