mirror of
https://github.com/mofeng-git/One-KVM.git
synced 2025-12-12 01:00:29 +08:00
186 lines
6.9 KiB
Python
186 lines
6.9 KiB
Python
# ========================================================================== #
|
|
# #
|
|
# KVMD - The main PiKVM daemon. #
|
|
# #
|
|
# Copyright (C) 2018-2024 Maxim Devaev <mdevaev@gmail.com> #
|
|
# #
|
|
# This program is free software: you can redistribute it and/or modify #
|
|
# it under the terms of the GNU General Public License as published by #
|
|
# the Free Software Foundation, either version 3 of the License, or #
|
|
# (at your option) any later version. #
|
|
# #
|
|
# This program is distributed in the hope that it will be useful, #
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of #
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the #
|
|
# GNU General Public License for more details. #
|
|
# #
|
|
# You should have received a copy of the GNU General Public License #
|
|
# along with this program. If not, see <https://www.gnu.org/licenses/>. #
|
|
# #
|
|
# ========================================================================== #
|
|
|
|
|
|
import os
|
|
import hashlib
|
|
import tempfile
|
|
import builtins
|
|
import getpass
|
|
|
|
from typing import Generator
|
|
from typing import Any
|
|
|
|
import pytest
|
|
|
|
from kvmd.apps.htpasswd import main
|
|
|
|
from kvmd.crypto import KvmdHtpasswdFile
|
|
|
|
|
|
# =====
|
|
def _make_passwd(user: str) -> str:
|
|
return hashlib.md5(user.encode()).hexdigest()
|
|
|
|
|
|
@pytest.fixture(name="htpasswd", params=[[], ["admin"], ["admin", "user"]])
|
|
def _htpasswd_fixture(request) -> Generator[KvmdHtpasswdFile, None, None]: # type: ignore
|
|
(fd, path) = tempfile.mkstemp()
|
|
os.close(fd)
|
|
htpasswd = KvmdHtpasswdFile(path)
|
|
for user in request.param:
|
|
htpasswd.set_password(user, _make_passwd(user))
|
|
htpasswd.save()
|
|
try:
|
|
yield htpasswd
|
|
finally:
|
|
os.remove(path)
|
|
|
|
|
|
def _run_htpasswd(cmd: list[str], htpasswd_path: str, int_type: str="htpasswd") -> None:
|
|
cmd = ["kvmd-htpasswd", *cmd, "--set-options"]
|
|
if int_type != "htpasswd": # By default
|
|
cmd.append("kvmd/auth/internal/type=" + int_type)
|
|
if htpasswd_path:
|
|
cmd.append("kvmd/auth/internal/file=" + htpasswd_path)
|
|
main(cmd)
|
|
|
|
|
|
# =====
|
|
def test_ok__list(htpasswd: KvmdHtpasswdFile, capsys) -> None: # type: ignore
|
|
_run_htpasswd(["list"], htpasswd.path)
|
|
(out, err) = capsys.readouterr()
|
|
assert len(err) == 0
|
|
assert sorted(filter(None, out.split("\n"))) == sorted(htpasswd.users()) == sorted(set(htpasswd.users()))
|
|
|
|
|
|
# =====
|
|
def test_ok__set_stdin(htpasswd: KvmdHtpasswdFile, mocker) -> None: # type: ignore
|
|
old_users = set(htpasswd.users())
|
|
if old_users:
|
|
assert htpasswd.check_password("admin", _make_passwd("admin"))
|
|
|
|
mocker.patch.object(builtins, "input", (lambda: " test "))
|
|
|
|
_run_htpasswd(["set", "admin", "--read-stdin"], htpasswd.path)
|
|
|
|
with pytest.raises(SystemExit, match="The user 'new' is not exist"):
|
|
_run_htpasswd(["set", "new", "--read-stdin"], htpasswd.path)
|
|
|
|
htpasswd.load(force=True)
|
|
assert htpasswd.check_password("admin", " test ")
|
|
assert old_users == set(htpasswd.users())
|
|
|
|
|
|
def test_ok__add_stdin(htpasswd: KvmdHtpasswdFile, mocker) -> None: # type: ignore
|
|
old_users = set(htpasswd.users())
|
|
if old_users:
|
|
mocker.patch.object(builtins, "input", (lambda: " test "))
|
|
|
|
_run_htpasswd(["add", "new", "--read-stdin"], htpasswd.path)
|
|
|
|
with pytest.raises(SystemExit, match="The user 'new' is already exists"):
|
|
_run_htpasswd(["add", "new", "--read-stdin"], htpasswd.path)
|
|
|
|
htpasswd.load(force=True)
|
|
assert htpasswd.check_password("new", " test ")
|
|
assert old_users.union(["new"]) == set(htpasswd.users())
|
|
|
|
|
|
# =====
|
|
def test_ok__set_getpass(htpasswd: KvmdHtpasswdFile, mocker) -> None: # type: ignore
|
|
old_users = set(htpasswd.users())
|
|
if old_users:
|
|
assert htpasswd.check_password("admin", _make_passwd("admin"))
|
|
|
|
mocker.patch.object(getpass, "getpass", (lambda *_, **__: " test "))
|
|
|
|
_run_htpasswd(["set", "admin"], htpasswd.path)
|
|
|
|
with pytest.raises(SystemExit, match="The user 'new' is not exist"):
|
|
_run_htpasswd(["set", "new"], htpasswd.path)
|
|
|
|
htpasswd.load(force=True)
|
|
assert htpasswd.check_password("admin", " test ")
|
|
assert old_users == set(htpasswd.users())
|
|
|
|
|
|
def test_fail__set_getpass(htpasswd: KvmdHtpasswdFile, mocker) -> None: # type: ignore
|
|
old_users = set(htpasswd.users())
|
|
if old_users:
|
|
assert htpasswd.check_password("admin", _make_passwd("admin"))
|
|
|
|
count = 0
|
|
|
|
def fake_getpass(*_: Any, **__: Any) -> str:
|
|
nonlocal count
|
|
assert count <= 1
|
|
if count == 0:
|
|
passwd = " test "
|
|
else:
|
|
passwd = "test "
|
|
count += 1
|
|
return passwd
|
|
|
|
mocker.patch.object(getpass, "getpass", fake_getpass)
|
|
with pytest.raises(SystemExit, match="Sorry, passwords do not match"):
|
|
_run_htpasswd(["set", "admin"], htpasswd.path)
|
|
assert count == 2
|
|
|
|
htpasswd.load(force=True)
|
|
assert htpasswd.check_password("admin", _make_passwd("admin"))
|
|
assert old_users == set(htpasswd.users())
|
|
|
|
|
|
# =====
|
|
def test_ok__del(htpasswd: KvmdHtpasswdFile) -> None:
|
|
old_users = set(htpasswd.users())
|
|
|
|
if old_users:
|
|
assert htpasswd.check_password("admin", _make_passwd("admin"))
|
|
_run_htpasswd(["del", "admin"], htpasswd.path)
|
|
|
|
with pytest.raises(SystemExit, match="The user 'admin' is not exist"):
|
|
_run_htpasswd(["del", "admin"], htpasswd.path)
|
|
|
|
htpasswd.load(force=True)
|
|
assert not htpasswd.check_password("admin", _make_passwd("admin"))
|
|
assert old_users.difference(["admin"]) == set(htpasswd.users())
|
|
|
|
|
|
# =====
|
|
def test_fail__not_htpasswd() -> None:
|
|
with pytest.raises(SystemExit, match="Error: KVMD internal auth does not use 'htpasswd'"):
|
|
_run_htpasswd(["list"], "", int_type="http")
|
|
|
|
|
|
def test_fail__unknown_plugin() -> None:
|
|
with pytest.raises(SystemExit, match="ConfigError: Unknown plugin 'auth/foobar'"):
|
|
_run_htpasswd(["list"], "", int_type="foobar")
|
|
|
|
|
|
def test_fail__invalid_passwd(mocker, tmpdir) -> None: # type: ignore
|
|
path = os.path.abspath(str(tmpdir.join("htpasswd")))
|
|
open(path, "w").close() # pylint: disable=consider-using-with
|
|
mocker.patch.object(builtins, "input", (lambda: "\n"))
|
|
with pytest.raises(SystemExit, match="The argument is not a valid passwd characters"):
|
|
_run_htpasswd(["add", "admin", "--read-stdin"], path)
|