-
-
Notifications
You must be signed in to change notification settings - Fork 29.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
114 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
"""Middleware to add some basic security filtering to requests.""" | ||
import logging | ||
import re | ||
|
||
from aiohttp.web import HTTPBadRequest, middleware | ||
|
||
from homeassistant.core import callback | ||
|
||
_LOGGER = logging.getLogger(__name__) | ||
|
||
# mypy: allow-untyped-defs | ||
|
||
# fmt: off | ||
FILTERS = re.compile( | ||
r"(?:" | ||
|
||
# Common exploits | ||
r"proc/self/environ" | ||
r"|(<|%3C).*script.*(>|%3E)" | ||
|
||
# File Injections | ||
r"|(\.\.//?)+" # ../../anywhere | ||
r"|[a-zA-Z0-9_]=/([a-z0-9_.]//?)+" # .html?v=/.//test | ||
|
||
# SQL Injections | ||
r"|union.*select.*\(" | ||
r"|union.*all.*select.*" | ||
r"|concat.*\(" | ||
|
||
r")", | ||
flags=re.IGNORECASE, | ||
) | ||
# fmt: on | ||
|
||
|
||
@callback | ||
def setup_security_filter(app): | ||
"""Create security filter middleware for the app.""" | ||
|
||
@middleware | ||
async def security_filter_middleware(request, handler): | ||
"""Process request and block commonly known exploit attempts.""" | ||
if FILTERS.search(request.raw_path): | ||
_LOGGER.warning( | ||
"Filtered a potential harmful request to: %s", request.raw_path | ||
) | ||
raise HTTPBadRequest | ||
|
||
return await handler(request) | ||
|
||
app.middlewares.append(security_filter_middleware) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,58 @@ | ||
"""Test security filter middleware.""" | ||
from aiohttp import web | ||
import pytest | ||
|
||
from homeassistant.components.http.security_filter import setup_security_filter | ||
|
||
|
||
async def mock_handler(request): | ||
"""Return OK.""" | ||
return web.Response(text="OK") | ||
|
||
|
||
@pytest.mark.parametrize( | ||
"request_path,request_params", | ||
[ | ||
("/", {}), | ||
("/lovelace/dashboard", {}), | ||
("/frontend_latest/chunk.4c9e2d8dc10f77b885b0.js", {}), | ||
("/static/translations/en-f96a262a5a6eede29234dc45dc63abf2.json", {}), | ||
("/", {"test": "123"}), | ||
], | ||
) | ||
async def test_ok_requests(request_path, request_params, aiohttp_client): | ||
"""Test request paths that should not be filtered.""" | ||
app = web.Application() | ||
app.router.add_get("/{all:.*}", mock_handler) | ||
|
||
setup_security_filter(app) | ||
|
||
mock_api_client = await aiohttp_client(app) | ||
resp = await mock_api_client.get(request_path, params=request_params) | ||
|
||
assert resp.status == 200 | ||
assert await resp.text() == "OK" | ||
|
||
|
||
@pytest.mark.parametrize( | ||
"request_path,request_params", | ||
[ | ||
("/proc/self/environ", {}), | ||
("/", {"test": "/test/../../api"}), | ||
("/", {"test": "test/../../api"}), | ||
("/", {"sql": ";UNION SELECT (a, b"}), | ||
("/", {"sql": "concat(..."}), | ||
("/", {"xss": "<script >"}), | ||
], | ||
) | ||
async def test_bad_requests(request_path, request_params, aiohttp_client): | ||
"""Test request paths that should be filtered.""" | ||
app = web.Application() | ||
app.router.add_get("/{all:.*}", mock_handler) | ||
|
||
setup_security_filter(app) | ||
|
||
mock_api_client = await aiohttp_client(app) | ||
resp = await mock_api_client.get(request_path, params=request_params) | ||
|
||
assert resp.status == 400 |