diff --git a/Makefile b/Makefile
index 1fc418d9..21187949 100644
--- a/Makefile
+++ b/Makefile
@@ -6,6 +6,7 @@ TESTENV_CMD ?= /bin/bash -c " \
(socat PTY,link=$(TESTENV_HID) PTY,link=/dev/ttyS11 &) \
&& cp -r /usr/share/kvmd/configs.default/nginx/* /etc/nginx \
&& cp /usr/share/kvmd/configs.default/kvmd/*.yaml /etc/kvmd \
+ && cp /usr/share/kvmd/configs.default/kvmd/htpasswd /etc/kvmd \
&& cp /testenv/kvmd.yaml /etc/kvmd \
&& nginx -c /etc/nginx/nginx.conf \
&& ln -s $(TESTENV_VIDEO) /dev/kvmd-video \
diff --git a/PKGBUILD b/PKGBUILD
index 3e66c52c..dd7de7ef 100644
--- a/PKGBUILD
+++ b/PKGBUILD
@@ -14,6 +14,7 @@ depends=(
python-yaml
python-aiohttp
python-aiofiles
+ python-passlib
python-pyudev
python-raspberry-gpio
python-pyserial
diff --git a/configs/kvmd/htpasswd b/configs/kvmd/htpasswd
new file mode 100644
index 00000000..e62e44d0
--- /dev/null
+++ b/configs/kvmd/htpasswd
@@ -0,0 +1 @@
+admin:$apr1$INC0KeyU$YdLQ9qosXzNVlhxQPUf7A/
diff --git a/configs/kvmd/platforms/kvmd.v1-hdmi.yaml b/configs/kvmd/platforms/kvmd.v1-hdmi.yaml
index 8a1f9c8b..1991e4c5 100644
--- a/configs/kvmd/platforms/kvmd.v1-hdmi.yaml
+++ b/configs/kvmd/platforms/kvmd.v1-hdmi.yaml
@@ -7,6 +7,9 @@ kvmd:
port: 8081
heartbeat: 3.0
+ auth:
+ htpasswd: /etc/kvmd/htpasswd
+
info:
meta: /etc/kvmd/meta.yaml
extras: /usr/share/kvmd/extras
diff --git a/configs/kvmd/platforms/kvmd.v1-vga.yaml b/configs/kvmd/platforms/kvmd.v1-vga.yaml
index 05c1234d..5688f306 100644
--- a/configs/kvmd/platforms/kvmd.v1-vga.yaml
+++ b/configs/kvmd/platforms/kvmd.v1-vga.yaml
@@ -1,5 +1,5 @@
# Don't touch this file otherwise your device may stop working.
-# You can find a workable configuration in /usr/share/kvmd/configs.default/kvmd.
+# You can find a working configuration in /usr/share/kvmd/configs.default/kvmd.
kvmd:
server:
@@ -7,6 +7,9 @@ kvmd:
port: 8081
heartbeat: 3.0
+ auth:
+ htpasswd: /etc/kvmd/htpasswd
+
info:
meta: /etc/kvmd/meta.yaml
extras: /usr/share/kvmd/extras
diff --git a/configs/nginx/nginx.conf b/configs/nginx/nginx.conf
index 5a368833..49776d9d 100644
--- a/configs/nginx/nginx.conf
+++ b/configs/nginx/nginx.conf
@@ -1,5 +1,3 @@
-load_module /usr/lib/nginx/modules/ngx_http_lua_module.so;
-
user http;
worker_processes 4;
@@ -28,6 +26,7 @@ http {
tcp_nodelay on;
tcp_nopush on;
keepalive_timeout 10;
+ client_max_body_size 4k;
client_body_temp_path /tmp/nginx.client_body_temp;
fastcgi_temp_path /tmp/nginx.fastcgi_temp;
@@ -45,11 +44,6 @@ http {
include /usr/share/kvmd/extras/*/nginx.http-ctx.conf;
-#PROD lua_shared_dict WS_TOKENS 10m;
-#PROD init_by_lua_block {
-#PROD WS_TOKEN_EXPIRES = 10;
-#PROD }
-
#PROD server {
#PROD listen 80;
#PROD server_name localhost;
@@ -67,34 +61,47 @@ http {
#PROD add_header Strict-Transport-Security "max-age=31536000; includeSubDomains" always;
-#PROD auth_basic "Restricted Area";
-#PROD auth_basic_user_file /etc/nginx/htpasswd;
+ auth_request /auth;
+
+ location = /auth {
+ internal;
+ proxy_pass http://kvmd/auth/check;
+ proxy_pass_request_body off;
+ proxy_set_header Content-Length "";
+ auth_request off;
+ }
location / {
root /usr/share/kvmd/web;
+ error_page 401 = @login;
+ error_page 403 = @login;
}
- location /ws_auth {
- # Workaround for Safari: https://bugs.webkit.org/show_bug.cgi?id=80362
-#PROD access_by_lua_block {
-#PROD local token = ngx.encode_base64(ngx.sha1_bin(ngx.var.http_Authorization));
-#PROD ngx.shared.WS_TOKENS:set(token, token, WS_TOKEN_EXPIRES);
-#PROD ngx.header["Set-Cookie"] = "WS_ACCESS_TOKEN=" .. token .. "; Path=/; Expires=" .. ngx.cookie_time(ngx.time() + WS_TOKEN_EXPIRES);
-#PROD }
- content_by_lua_block {
- ngx.say("ok");
- }
+ location @login {
+ return 302 /login;
+ }
+
+ location /login {
+ root /usr/share/kvmd/web;
+ auth_request off;
+ }
+
+ location /share {
+ root /usr/share/kvmd/web;
+ auth_request off;
+ }
+
+ location = /favicon.ico {
+ alias /usr/share/kvmd/web/favicon.ico;
+ auth_request off;
+ }
+
+ location = /robots.txt {
+ alias /usr/share/kvmd/web/robots.txt;
+ auth_request off;
}
location /kvmd/ws {
-#PROD auth_basic off;
-#PROD access_by_lua_block {
-#PROD local token = ngx.var.cookie_WS_ACCESS_TOKEN;
-#PROD local value, _ = ngx.shared.WS_TOKENS:get(token);
-#PROD if value == nil then
-#PROD ngx.exec("/ws_auth");
-#PROD end
-#PROD }
rewrite ^/kvmd/ws$ /ws break;
rewrite ^/kvmd/ws\?(.*)$ /ws?$1 break;
proxy_pass http://kvmd;
@@ -104,6 +111,7 @@ http {
proxy_connect_timeout 7d;
proxy_send_timeout 7d;
proxy_read_timeout 7d;
+ auth_request off;
}
location /kvmd/msd/write {
@@ -115,6 +123,7 @@ http {
limit_rate_after 50k;
client_max_body_size 0;
proxy_request_buffering off;
+ auth_request off;
}
location /kvmd/log {
@@ -126,6 +135,7 @@ http {
postpone_output 0;
proxy_buffering off;
proxy_ignore_headers X-Accel-Buffering;
+ auth_request off;
}
location /kvmd {
@@ -133,6 +143,7 @@ http {
rewrite ^/kvmd/(.*)$ /$1 break;
proxy_pass http://kvmd;
include /etc/nginx/proxy-params.conf;
+ auth_request off;
}
location /streamer {
diff --git a/extras/kvm/manifest.yaml b/extras/kvm/manifest.yaml
index d99cd7bf..609cb495 100644
--- a/extras/kvm/manifest.yaml
+++ b/extras/kvm/manifest.yaml
@@ -1,6 +1,6 @@
name: KVM
description: Open KVM session in a web browser
-icon: svg/kvm.svg
+icon: share/svg/kvm.svg
path: kvm
keyboard_cap: true
daemon: kvmd
diff --git a/kvmd/apps/kvmd/__init__.py b/kvmd/apps/kvmd/__init__.py
index 7662fae0..480a1017 100644
--- a/kvmd/apps/kvmd/__init__.py
+++ b/kvmd/apps/kvmd/__init__.py
@@ -5,8 +5,9 @@ from ...logging import get_logger
from ... import gpio
-from .logreader import LogReader
+from .auth import AuthManager
from .info import InfoManager
+from .logreader import LogReader
from .hid import Hid
from .atx import Atx
from .msd import MassStorageDevice
@@ -20,6 +21,10 @@ def main() -> None:
with gpio.bcm():
loop = asyncio.get_event_loop()
+ auth_manager = AuthManager(
+ htpasswd_path=str(config["auth"]["htpasswd"]),
+ )
+
info_manager = InfoManager(
meta_path=str(config["info"]["meta"]),
extras_path=str(config["info"]["extras"]),
@@ -80,6 +85,7 @@ def main() -> None:
)
Server(
+ auth_manager=auth_manager,
info_manager=info_manager,
log_reader=log_reader,
diff --git a/kvmd/apps/kvmd/auth.py b/kvmd/apps/kvmd/auth.py
new file mode 100644
index 00000000..f319b5cc
--- /dev/null
+++ b/kvmd/apps/kvmd/auth.py
@@ -0,0 +1,37 @@
+import secrets
+
+from typing import Dict
+from typing import Optional
+
+import passlib.apache
+
+from ...logging import get_logger
+
+
+# =====
+class AuthManager:
+ def __init__(self, htpasswd_path: str) -> None:
+ self.__htpasswd_path = htpasswd_path
+ self.__tokens: Dict[str, str] = {} # {token: user}
+
+ def login(self, user: str, passwd: str) -> Optional[str]:
+ htpasswd = passlib.apache.HtpasswdFile(self.__htpasswd_path)
+ if htpasswd.check_password(user, passwd):
+ for (token, token_user) in self.__tokens.items():
+ if user == token_user:
+ return token
+ token = secrets.token_hex(32)
+ self.__tokens[token] = user
+ get_logger().info("Logged in user %r", user)
+ return token
+ else:
+ get_logger().error("Access denied for user %r", user)
+ return None
+
+ def logout(self, token: str) -> None:
+ user = self.__tokens.pop(token, "")
+ if user:
+ get_logger().info("Logged out user %r", user)
+
+ def check(self, token: str) -> bool:
+ return (token in self.__tokens)
diff --git a/kvmd/apps/kvmd/server.py b/kvmd/apps/kvmd/server.py
index 2fae9994..3981f59b 100644
--- a/kvmd/apps/kvmd/server.py
+++ b/kvmd/apps/kvmd/server.py
@@ -1,4 +1,5 @@
import os
+import re
import signal
import socket
import asyncio
@@ -23,6 +24,7 @@ from ...aioregion import RegionIsBusyError
from ... import __version__
+from .auth import AuthManager
from .info import InfoManager
from .logreader import LogReader
from .hid import Hid
@@ -33,8 +35,29 @@ from .streamer import Streamer
# =====
-def _json(result: Optional[Dict]=None, status: int=200) -> aiohttp.web.Response:
- return aiohttp.web.Response(
+class HttpError(Exception):
+ pass
+
+
+class BadRequestError(HttpError):
+ pass
+
+
+class UnauthorizedError(HttpError):
+ pass
+
+
+class ForbiddenError(HttpError):
+ pass
+
+
+def _json(
+ result: Optional[Dict]=None,
+ status: int=200,
+ set_cookies: Optional[Dict[str, str]]=None,
+) -> aiohttp.web.Response:
+
+ response = aiohttp.web.Response(
text=json.dumps({
"ok": (status == 200),
"result": (result or {}),
@@ -42,37 +65,53 @@ def _json(result: Optional[Dict]=None, status: int=200) -> aiohttp.web.Response:
status=status,
content_type="application/json",
)
+ if set_cookies:
+ for (key, value) in set_cookies.items():
+ response.set_cookie(key, value)
+ return response
def _json_exception(err: Exception, status: int) -> aiohttp.web.Response:
name = type(err).__name__
msg = str(err)
- get_logger().error("API error: %s: %s", name, msg)
+ if not isinstance(err, (UnauthorizedError, ForbiddenError)):
+ get_logger().error("API error: %s: %s", name, msg)
return _json({
"error": name,
"error_msg": msg,
}, status=status)
-class BadRequestError(Exception):
- pass
-
-
_ATTR_EXPOSED = "exposed"
_ATTR_EXPOSED_METHOD = "exposed_method"
_ATTR_EXPOSED_PATH = "exposed_path"
_ATTR_SYSTEM_TASK = "system_task"
+_COOKIE_AUTH_TOKEN = "auth_token"
-def _exposed(http_method: str, path: str) -> Callable:
+
+def _exposed(http_method: str, path: str, auth_required: bool=True) -> Callable:
def make_wrapper(method: Callable) -> Callable:
async def wrap(self: "Server", request: aiohttp.web.Request) -> aiohttp.web.Response:
try:
+ if auth_required:
+ token = request.cookies.get(_COOKIE_AUTH_TOKEN, "")
+ if token:
+ if not self._auth_manager.check(_valid_token(token)):
+ raise ForbiddenError("Forbidden")
+ else:
+ raise UnauthorizedError("Unauthorized")
+
return (await method(self, request))
+
except RegionIsBusyError as err:
return _json_exception(err, 409)
except (BadRequestError, MsdOperationError) as err:
return _json_exception(err, 400)
+ except UnauthorizedError as err:
+ return _json_exception(err, 401)
+ except ForbiddenError as err:
+ return _json_exception(err, 403)
setattr(wrap, _ATTR_EXPOSED, True)
setattr(wrap, _ATTR_EXPOSED_METHOD, http_method)
@@ -95,6 +134,29 @@ def _system_task(method: Callable) -> Callable:
return wrap
+def _valid_user(user: Optional[str]) -> str:
+ if isinstance(user, str):
+ stripped = user.strip()
+ if re.match(r"^[a-z_][a-z0-9_-]*$", stripped):
+ return stripped
+ raise BadRequestError("Invalid user characters %r" % (user))
+
+
+def _valid_passwd(passwd: Optional[str]) -> str:
+ if isinstance(passwd, str):
+ if re.match(r"[\x20-\x7e]*$", passwd):
+ return passwd
+ raise BadRequestError("Invalid password characters")
+
+
+def _valid_token(token: Optional[str]) -> str:
+ if isinstance(token, str):
+ token = token.strip().lower()
+ if re.match(r"^[0-9a-f]{64}$", token):
+ return token
+ raise BadRequestError("Invalid auth token characters")
+
+
def _valid_bool(name: str, flag: Optional[str]) -> bool:
flag = str(flag).strip().lower()
if flag in ["1", "true", "yes"]:
@@ -127,6 +189,7 @@ class _Events(Enum):
class Server: # pylint: disable=too-many-instance-attributes
def __init__( # pylint: disable=too-many-arguments
self,
+ auth_manager: AuthManager,
info_manager: InfoManager,
log_reader: LogReader,
@@ -142,6 +205,7 @@ class Server: # pylint: disable=too-many-instance-attributes
loop: asyncio.AbstractEventLoop,
) -> None:
+ self._auth_manager = auth_manager
self.__info_manager = info_manager
self.__log_reader = log_reader
@@ -210,6 +274,29 @@ class Server: # pylint: disable=too-many-instance-attributes
"extras": await self.__info_manager.get_extras(),
}
+ # ===== AUTH
+
+ @_exposed("POST", "/auth/login", auth_required=False)
+ async def __auth_login_handler(self, request: aiohttp.web.Request) -> aiohttp.web.Response:
+ credentials = await request.post()
+ token = self._auth_manager.login(
+ user=_valid_user(credentials.get("user", "")),
+ passwd=_valid_passwd(credentials.get("passwd", "")),
+ )
+ if token:
+ return _json({}, set_cookies={_COOKIE_AUTH_TOKEN: token})
+ raise ForbiddenError("Forbidden")
+
+ @_exposed("POST", "/auth/logout")
+ async def __auth_logout_handler(self, request: aiohttp.web.Request) -> aiohttp.web.Response:
+ token = _valid_token(request.cookies.get(_COOKIE_AUTH_TOKEN, ""))
+ self._auth_manager.logout(token)
+ return _json({})
+
+ @_exposed("GET", "/auth/check")
+ async def __auth_check_handler(self, _: aiohttp.web.Request) -> aiohttp.web.Response:
+ return _json({})
+
# ===== SYSTEM
@_exposed("GET", "/info")
diff --git a/testenv/Dockerfile b/testenv/Dockerfile
index 78226b17..4fe453e8 100644
--- a/testenv/Dockerfile
+++ b/testenv/Dockerfile
@@ -31,12 +31,7 @@ RUN useradd -r -d / packer \
&& cd - \
&& rm -rf /tmp/packer-color
-COPY testenv/customizepkg.nginx /etc/customizepkg.d/nginx-mainline-mod-ndk
-COPY testenv/customizepkg.nginx /etc/customizepkg.d/nginx-mainline-mod-lua
-
RUN pacman -Syy \
- && user-packer -S --noconfirm \
- customizepkg \
&& mkdir /.npm \
&& chmod 777 /.npm \
&& user-packer -S --noconfirm \
@@ -50,7 +45,6 @@ RUN pacman -Syy \
htmlhint \
eslint \
&& rm -rf /.npm \
- && env MAKEPKGOPTS="--skipchecksums --skippgpcheck" user-packer -S --noconfirm nginx-mainline-mod-lua \
&& pacman -Sc --noconfirm
COPY testenv/requirements.txt requirements.txt
diff --git a/testenv/customizepkg.nginx b/testenv/customizepkg.nginx
deleted file mode 100644
index 5e7db5a4..00000000
--- a/testenv/customizepkg.nginx
+++ /dev/null
@@ -1 +0,0 @@
-replace#global#_nginxver=.*#_nginxver=`pacman -Q nginx-mainline | grep -Po "\\d+\\.\\d+\\.\\d+"`
diff --git a/testenv/kvmd.yaml b/testenv/kvmd.yaml
index 8233cd58..da37e9d8 100644
--- a/testenv/kvmd.yaml
+++ b/testenv/kvmd.yaml
@@ -4,6 +4,9 @@ kvmd:
port: 8081
heartbeat: 3.0
+ auth:
+ htpasswd: /etc/kvmd/htpasswd
+
info:
meta: /etc/kvmd/meta.yaml
extras: /usr/share/kvmd/extras
diff --git a/testenv/requirements.txt b/testenv/requirements.txt
index 4f95d90a..a968fcb1 100644
--- a/testenv/requirements.txt
+++ b/testenv/requirements.txt
@@ -1,6 +1,7 @@
git+git://github.com/willbuckner/rpi-gpio-development-mock@master#egg=rpi
aiohttp
aiofiles
+passlib
pyudev
pyyaml
pyserial
diff --git a/testenv/tox.ini b/testenv/tox.ini
index 47ce1636..b10700a2 100644
--- a/testenv/tox.ini
+++ b/testenv/tox.ini
@@ -33,7 +33,7 @@ deps =
[testenv:eslint]
whitelist_externals = eslint
-commands = eslint --config=testenv/eslintrc.yaml --color --ext .js web/js
+commands = eslint --config=testenv/eslintrc.yaml --color --ext .js web/share/js
[testenv:htmlhint]
whitelist_externals = htmlhint
diff --git a/web/browserconfig.xml b/web/browserconfig.xml
deleted file mode 100644
index fcb73892..00000000
--- a/web/browserconfig.xml
+++ /dev/null
@@ -1,9 +0,0 @@
-
-
|
- |
|