1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
|
# ========================================================================== #
# #
# KVMD - The main PiKVM daemon. #
# #
# Copyright (C) 2018-2024 Maxim Devaev <[email protected]> #
# #
# 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 sys
import os
import signal
import asyncio
import asyncio.subprocess
import argparse
import aiohttp
from ...logging import get_logger
from ... import tools
from ... import aiotools
from ... import aioproc
from ... import htclient
from ... import htserver
from .. import init
# =====
def _preexec() -> None:
os.setpgrp()
if os.isatty(0):
try:
os.tcsetpgrp(0, os.getpgid(0))
except Exception as ex:
get_logger(0).info("Can't perform tcsetpgrp(0): %s", tools.efmt(ex))
async def _run_process(cmd: list[str], data_path: str) -> asyncio.subprocess.Process: # pylint: disable=no-member
# https://stackoverflow.com/questions/58918188/why-is-stdin-not-propagated-to-child-process-of-different-process-group
if os.isatty(0):
signal.signal(signal.SIGTTOU, signal.SIG_IGN)
return (await asyncio.create_subprocess_exec(
*cmd,
preexec_fn=_preexec,
env={
**os.environ,
"KVMD_PST_DATA": data_path,
},
))
async def _run_cmd_ws(cmd: list[str], ws: aiohttp.ClientWebSocketResponse) -> int: # pylint: disable=too-many-branches
logger = get_logger(0)
receive_task: (asyncio.Task | None) = None
proc_task: (asyncio.Task | None) = None
proc: (asyncio.subprocess.Process | None) = None # pylint: disable=no-member
try: # pylint: disable=too-many-nested-blocks
while True:
if receive_task is None:
receive_task = asyncio.create_task(ws.receive())
if proc_task is None and proc is not None:
proc_task = asyncio.create_task(proc.wait())
tasks = list(filter(None, [receive_task, proc_task]))
done = (await aiotools.wait_first(*tasks))[0]
if receive_task in done:
msg = receive_task.result()
if msg.type == aiohttp.WSMsgType.TEXT:
(event_type, event) = htserver.parse_ws_event(msg.data)
if event_type == "storage":
if event["data"]["write_allowed"] and proc is None:
logger.info("PST write is allowed: %s", event["data"]["path"])
logger.info("Running the process ...")
proc = await _run_process(cmd, event["data"]["path"])
elif not event["data"]["write_allowed"]:
logger.error("PST write is not allowed")
break
elif msg.type == aiohttp.WSMsgType.CLOSED:
logger.error("PST connection closed")
break
else:
logger.error("Unknown PST message type: %r", msg)
break
receive_task = None
if proc_task in done:
break
except Exception:
logger.exception("Unhandled exception")
if receive_task is not None:
receive_task.cancel()
if proc_task is not None:
proc_task.cancel()
if proc is not None:
await aioproc.kill_process(proc, 1, logger)
assert proc.returncode is not None
logger.info("Process finished: returncode=%d", proc.returncode)
return proc.returncode
return 1
async def _run_cmd(cmd: list[str], unix_path: str) -> None:
get_logger(0).info("Opening PST session ...")
async with aiohttp.ClientSession(
headers={"User-Agent": htclient.make_user_agent("KVMD-PSTRun")},
connector=aiohttp.UnixConnector(path=unix_path),
timeout=aiohttp.ClientTimeout(total=5),
) as session:
async with session.ws_connect("http://localhost:0/ws") as ws:
sys.exit(await _run_cmd_ws(cmd, ws))
# =====
def main(argv: (list[str] | None)=None) -> None:
(parent_parser, argv, config) = init(
add_help=False,
cli_logging=True,
argv=argv,
)
parser = argparse.ArgumentParser(
prog="kvmd-pstrun",
description="Request the access to KVMD persistent storage and run the script",
parents=[parent_parser],
)
parser.add_argument("cmd", nargs="+", help="Script with arguments to run")
options = parser.parse_args(argv[1:])
aiotools.run(_run_cmd(options.cmd, config.pst.server.unix))
|
