def extract_cors_http(
self,
cors_prop: Union[bool, Dict],
) -> Optional[Cors]:
"""
Extract Cors property from AWS::Serverless::HttpApi resource by reading and parsing Swagger documents.
The result is added to the HttpApi.
Parameters
----------
cors_prop : dict
Resource properties for CorsConfiguration
"""
cors = None
if cors_prop and isinstance(cors_prop, dict):
allow_methods = self._get_cors_prop_http(cors_prop, "AllowMethods",
list)
if isinstance(allow_methods, list):
allow_methods = CfnBaseApiProvider.normalize_cors_allow_methods(
allow_methods)
else:
allow_methods = ",".join(sorted(Route.ANY_HTTP_METHODS))
allow_origins = self._get_cors_prop_http(cors_prop, "AllowOrigins",
list)
if isinstance(allow_origins, list):
allow_origins = ",".join(allow_origins)
allow_headers = self._get_cors_prop_http(cors_prop, "AllowHeaders",
list)
if isinstance(allow_headers, list):
allow_headers = ",".join(allow_headers)
# Read AllowCredentials but only output the header with the case-sensitive value of true
# (see https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Credentials)
allow_credentials = "true" if self._get_cors_prop_http(
cors_prop, "AllowCredentials", bool) else None
max_age = self._get_cors_prop_http(cors_prop, "MaxAge", int)
cors = Cors(
allow_origin=allow_origins,
allow_methods=allow_methods,
allow_headers=allow_headers,
allow_credentials=allow_credentials,
max_age=max_age,
)
elif cors_prop and isinstance(cors_prop, bool) and cors_prop:
cors = Cors(
allow_origin="*",
allow_methods=",".join(sorted(Route.ANY_HTTP_METHODS)),
allow_headers=None,
allow_credentials=None,
max_age=None,
)
return cors
def extract_cors(self, cors_prop: Union[Dict, str]) -> Optional[Cors]:
"""
Extract Cors property from AWS::Serverless::Api resource by reading and parsing Swagger documents. The result
is added to the Api.
Parameters
----------
cors_prop : dict
Resource properties for Cors
"""
cors = None
if cors_prop and isinstance(cors_prop, dict):
allow_methods = self._get_cors_prop(cors_prop, "AllowMethods")
if allow_methods:
allow_methods = CfnBaseApiProvider.normalize_cors_allow_methods(
allow_methods)
else:
allow_methods = ",".join(sorted(Route.ANY_HTTP_METHODS))
allow_origin = self._get_cors_prop(cors_prop, "AllowOrigin")
allow_headers = self._get_cors_prop(cors_prop, "AllowHeaders")
allow_credentials = self._get_cors_prop(cors_prop,
"AllowCredentials", True)
max_age = self._get_cors_prop(cors_prop, "MaxAge")
cors = Cors(
allow_origin=allow_origin,
allow_methods=allow_methods,
allow_headers=allow_headers,
allow_credentials=allow_credentials,
max_age=max_age,
)
elif cors_prop and isinstance(cors_prop, str):
allow_origin = cors_prop
if not (allow_origin.startswith("'")
and allow_origin.endswith("'")):
raise InvalidSamDocumentException(
"Cors Properties must be a quoted string "
'(i.e. "\'*\'" is correct, but "*" is not).')
allow_origin = allow_origin.strip("'")
cors = Cors(
allow_origin=allow_origin,
allow_methods=",".join(sorted(Route.ANY_HTTP_METHODS)),
allow_headers=None,
allow_credentials=None,
max_age=None,
)
return cors
def test_empty_elements(self):
cors = Cors(allow_origin="www.domain.com", allow_methods=",".join(["GET", "POST", "OPTIONS"]))
headers = Cors.cors_to_headers(cors)
self.assertEqual(
headers,
{"Access-Control-Allow-Origin": "www.domain.com", "Access-Control-Allow-Methods": "GET,POST,OPTIONS"},
)
def extract_cors_http(self, cors_prop):
"""
Extract Cors property from AWS::Serverless::HttpApi resource by reading and parsing Swagger documents. The result
is added to the HttpApi.
Parameters
----------
cors_prop : dict
Resource properties for CorsConfiguration
"""
cors = None
if cors_prop and isinstance(cors_prop, dict):
allow_methods = self._get_cors_prop_http(cors_prop, "AllowMethods",
list)
if isinstance(allow_methods, list):
allow_methods = self.normalize_cors_allow_methods(
allow_methods)
else:
allow_methods = ",".join(sorted(Route.ANY_HTTP_METHODS))
allow_origins = self._get_cors_prop_http(cors_prop, "AllowOrigins",
list)
if isinstance(allow_origins, list):
allow_origins = ",".join(allow_origins)
allow_headers = self._get_cors_prop_http(cors_prop, "AllowHeaders",
list)
if isinstance(allow_headers, list):
allow_headers = ",".join(allow_headers)
max_age = self._get_cors_prop_http(cors_prop, "MaxAge", int)
cors = Cors(allow_origin=allow_origins,
allow_methods=allow_methods,
allow_headers=allow_headers,
max_age=max_age)
elif cors_prop and isinstance(cors_prop, bool) and cors_prop:
cors = Cors(
allow_origin="*",
allow_methods=",".join(sorted(Route.ANY_HTTP_METHODS)),
allow_headers=None,
max_age=None,
)
return cors
def test_basic_conversion(self):
cors = Cors(
allow_origin="*", allow_methods=",".join(["POST", "OPTIONS"]), allow_headers="UPGRADE-HEADER", max_age=6
)
headers = Cors.cors_to_headers(cors)
self.assertEqual(
headers,
{
"Access-Control-Allow-Origin": "*",
"Access-Control-Allow-Methods": "POST,OPTIONS",
"Access-Control-Allow-Headers": "UPGRADE-HEADER",
"Access-Control-Max-Age": 6,
},
)