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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
|
"""Handle sshuttle sessions."""
from getpass import getuser
import os
from pathlib import Path
from signal import (
SIGKILL,
SIGTERM,
)
from subprocess import (
PIPE,
Popen,
)
from tempfile import gettempdir
import time
from typing import (
Any,
cast,
Dict,
IO,
List,
Optional,
)
from xdg.BaseDirectory import xdg_config_home
from .config import Config
from .i18n import _
from .profile import (
Profile,
ProfileError,
)
DEFAULT_CONFIG_PATH = Path(xdg_config_home) / "sshoot"
class ManagerProfileError(Exception):
"""Profile operation failed."""
class Manager:
"""Profile manager."""
def __init__(
self, config_path: Optional[str] = None, rundir: Optional[str] = None
):
self.config_path = (
Path(config_path) if config_path else DEFAULT_CONFIG_PATH
)
self.rundir = Path(rundir) if rundir else get_rundir("sshoot")
self.sessions_path = self.rundir / "sessions"
self._config = Config(self.config_path)
def load_config(self):
"""Load configuration from file."""
self.config_path.mkdir(parents=True, exist_ok=True)
self.sessions_path.mkdir(parents=True, exist_ok=True)
self._config.load()
def create_profile(self, name: str, details: Dict[str, Any]):
"""Create a profile with provided details."""
try:
self._config.add_profile(name, Profile.from_config(details))
except KeyError:
raise ManagerProfileError(
_("Profile name already in use: {name}").format(name=name)
)
except ProfileError as error:
raise ManagerProfileError(str(error))
self._config.save()
def remove_profile(self, name: str):
"""Remove profile with given name."""
try:
self._config.remove_profile(name)
except KeyError:
raise ManagerProfileError(
_("Unknown profile: {name}").format(name=name)
)
self._config.save()
def get_profiles(self) -> Dict[str, Profile]:
"""Return profiles defined in config."""
return self._config.profiles
def get_profile(self, name: str) -> Profile:
"""Return profile with given name."""
try:
return self._config.profiles[name]
except KeyError:
raise ManagerProfileError(
_("Unknown profile: {name}").format(name=name)
)
def start_profile(
self,
name: str,
extra_args: Optional[List[str]] = None,
disable_global_extra_options: bool = False,
):
"""Start profile with given name."""
if self.is_running(name):
raise ManagerProfileError(_("Profile is already running"))
cmdline = self.get_cmdline(
name,
extra_args=extra_args,
disable_global_extra_options=disable_global_extra_options,
)
message = _("Profile failed to start: {error}")
try:
process = Popen(cmdline, stderr=PIPE)
# Wait until process is started (it daemonizes)
process.wait()
except OSError as err:
# To catch file not found errors
raise ManagerProfileError(message.format(error=str(err)))
stderr = cast(IO[bytes], process.stderr)
if process.returncode != 0:
error = stderr.read().decode()
stderr.close()
if not error:
error = "Please see the log for more details: 'grep sshuttle /var/log/syslog'"
raise ManagerProfileError(message.format(error=error))
stderr.close()
def stop_profile(self, name: str):
"""Stop profile with given name."""
self.get_profile(name)
if not self.is_running(name):
raise ManagerProfileError(_("Profile is not running"))
try:
pid = int(self._get_pidfile(name).read_text())
kill_and_wait(pid)
except (OSError, PermissionError) as error:
raise ManagerProfileError(
_("Failed to stop profile: {error}").format(error=error)
)
def restart_profile(
self,
name: str,
extra_args: Optional[List[str]] = None,
disable_global_extra_options: bool = False,
):
"""Restart profile with given name."""
if self.is_running(name):
self.stop_profile(name)
self.start_profile(
name,
extra_args=extra_args,
disable_global_extra_options=disable_global_extra_options,
)
def is_running(self, name: str) -> bool:
"""Return whether the specified profile is running."""
pidfile = self._get_pidfile(name)
try:
pid = int(pidfile.read_text())
except Exception:
# If anything fails, a valid PID can't be found, so the profile is
# not running
return False
try:
os.kill(pid, 0)
except ProcessLookupError:
# Delete stale pidfile
pidfile.unlink()
return False
return True
def get_cmdline(
self,
name: str,
extra_args: Optional[List[str]] = None,
disable_global_extra_options: bool = False,
) -> List[str]:
"""Return the command line for the specified profile."""
profile = self.get_profile(name)
executable = self._get_executable()
extra_opts = ["--daemon", "--pidfile", str(self._get_pidfile(name))]
global_extra_options = (
self._config.config.get("extra-options", [])
if not disable_global_extra_options
else []
)
if extra_args:
extra_opts.extend(extra_args)
return profile.cmdline(
executable=executable,
extra_opts=extra_opts,
global_extra_options=global_extra_options,
)
def _get_pidfile(self, name: str) -> Path:
"""Return the path of the pidfile for the specified profile."""
return self.sessions_path / f"{name}.pid"
def _get_executable(self) -> str:
"""Return the shuttle executable from the config."""
return self._config.config.get("executable", "sshuttle")
class ProcessKillFail(Exception):
"""Failed to kill a process."""
def __init__(self, pid: int):
self.pid = pid
super().__init__(_("Failed to kill process {pid}").format(pid=pid))
def kill_and_wait(pid: int):
"""Kill a process and wait for it to terminate."""
for wait, signal in ((2.0, SIGTERM), (1.0, SIGKILL)):
while wait > 0:
try:
os.kill(pid, signal)
except ProcessLookupError:
return
wait -= 0.2
time.sleep(0.2)
raise ProcessKillFail(pid)
def get_rundir(prefix: str) -> Path:
"""Return the directory holding runtime data."""
return Path(gettempdir()) / f"{prefix}-{getuser()}"
|
