Skip to content

fix(api-gateway): route regression for non-word and unsafe URI chars #556

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jul 23, 2021
Merged

fix(api-gateway): route regression for non-word and unsafe URI chars #556

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
625fc51
fix(apigw): route regression for non-word chars 1st take
heitorlessa Jul 23, 2021
9e58198
fix(apigw): add all safe URI chars RFC3986
heitorlessa Jul 23, 2021
db20c9b
fix(apigw): add all safe URI chars RFC3986 pt2
heitorlessa Jul 23, 2021
4dd0149
fix(apigw): add unsafe URI chars as APIGW ALB decode them
heitorlessa Jul 23, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion aws_lambda_powertools/event_handler/api_gateway.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,11 @@
logger = logging.getLogger(__name__)

_DYNAMIC_ROUTE_PATTERN = r"(<\w+>)"
_NAMED_GROUP_BOUNDARY_PATTERN = r"(?P\1\\w+\\b)"
_SAFE_URI = "-._~()'!*:@,;" # https://www.ietf.org/rfc/rfc3986.txt
# API GW/ALB decode non-safe URI chars; we must support them too
_UNSAFE_URI = "%<>\[\]{}|^" # noqa: W605

_NAMED_GROUP_BOUNDARY_PATTERN = fr"(?P\1[{_SAFE_URI}{_UNSAFE_URI}\\w]+)"


class ProxyEventType(Enum):
Expand Down
27 changes: 27 additions & 0 deletions tests/functional/event_handler/test_api_gateway.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -701,3 +701,30 @@ def get_network_account(account_id: str, network_id: str):
event["resource"] = "/accounts/{account_id}/source_networks/{network_id}"
event["path"] = "/accounts/nested_account/source_networks/network"
app.resolve(event, {})


@pytest.mark.parametrize(
"req",
[
pytest.param(123456789, id="num"),
pytest.param("user@example.com", id="email"),
pytest.param("-._~'!*:@,;()", id="safe-rfc3986"),
pytest.param("%<>[]{}|^", id="unsafe-rfc3986"),
],
)
def test_non_word_chars_route(req):
# GIVEN
app = ApiGatewayResolver()
event = deepcopy(LOAD_GW_EVENT)

# WHEN
@app.get("/accounts/<account_id>")
def get_account(account_id: str):
assert account_id == f"{req}"

# THEN
event["resource"] = "/accounts/{account_id}"
event["path"] = f"/accounts/{req}"

ret = app.resolve(event, None)
assert ret["statusCode"] == 200