To get this branch, use:
bzr branch
http://bzr.recompile.se/loggerhead/mandos/trunk
« back to all changes in this revision
Viewing changes to mandos
- browse files at revision 1318
- compare with another revision
- download diff
- download tarball
- view history from revision 1318
- Committer: Teddy Hogeborn
- Date: 2025-06-14 15:37:45 UTC
- Revision ID: teddy@recompile.se-20250614153745-1labvcqq11fuijy4
debian/control: Require cryptsetup support in systemd
* debian/control (Package: mandos-client/Depends): Add dependency on
"systemd-cryptsetup" (for newer systemd), or "systemd (<< 256-2)"
for when cryptsetup support was included in the systemd package
itself, or "sysvinit-core" for installations without systemd.
* debian/control (Package: mandos-client/Depends): Add dependency on
"systemd-cryptsetup" (for newer systemd), or "systemd (<< 256-2)"
for when cryptsetup support was included in the systemd package
itself, or "sysvinit-core" for installations without systemd.
- files added:
- bugs.xml
- debian/tests
- dracut-module
- plugin-helpers
- files removed:
- initramfs-tools-hook-conf
- files modified:
- .bzrignore
added
removed
mandos
1
#!/usr/bin/python
2
# -*- mode: python; coding: utf-8 -*-
3
#
1
#!/usr/bin/python3 -bI
2
# -*- coding: utf-8; lexical-binding: t -*-
3
#
4
4
# Mandos server - give out binary blobs to connecting clients.
5
#
5
#
6
6
# This program is partly derived from an example program for an Avahi
7
7
# service publisher, downloaded from
8
8
# <http://avahi.org/wiki/PythonPublishExample>. This includes the
9
9
# methods "add", "remove", "server_state_changed",
10
10
# "entry_group_state_changed", "cleanup", and "activate" in the
11
11
# "AvahiService" class, and some lines in "main".
12
#
12
#
13
13
# Everything else is
14
# Copyright © 2008-2014 Teddy Hogeborn
15
# Copyright © 2008-2014 Björn Påhlsson
16
#
17
# This program is free software: you can redistribute it and/or modify
18
# it under the terms of the GNU General Public License as published by
14
# Copyright © 2008-2022 Teddy Hogeborn
15
# Copyright © 2008-2022 Björn Påhlsson
16
#
17
# This file is part of Mandos.
18
#
19
# Mandos is free software: you can redistribute it and/or modify it
20
# under the terms of the GNU General Public License as published by
19
21
# the Free Software Foundation, either version 3 of the License, or
20
22
# (at your option) any later version.
21
23
#
22
# This program is distributed in the hope that it will be useful,
23
# but WITHOUT ANY WARRANTY; without even the implied warranty of
24
# Mandos is distributed in the hope that it will be useful, but
25
# WITHOUT ANY WARRANTY; without even the implied warranty of
24
26
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25
27
# GNU General Public License for more details.
26
#
28
#
27
29
# You should have received a copy of the GNU General Public License
28
# along with this program. If not, see
29
# <http://www.gnu.org/licenses/>.
30
#
30
# along with Mandos. If not, see <http://www.gnu.org/licenses/>.
31
#
31
32
# Contact the authors at <mandos@recompile.se>.
32
#
33
33
#
34
34
from __future__ import (division, absolute_import, print_function,
35
35
unicode_literals)
36
36
37
from future_builtins import *
37
try:
38
from future_builtins import *
39
except ImportError:
40
pass
38
41
39
import SocketServer as socketserver
42
import sys
43
import unittest
44
import argparse
45
import logging
46
import os
47
try:
48
import SocketServer as socketserver
49
except ImportError:
50
import socketserver
40
51
import socket
41
import argparse
42
52
import datetime
43
53
import errno
44
import gnutls.crypto
45
import gnutls.connection
46
import gnutls.errors
47
import gnutls.library.functions
48
import gnutls.library.constants
49
import gnutls.library.types
50
import ConfigParser as configparser
51
import sys
54
try:
55
import ConfigParser as configparser
56
except ImportError:
57
import configparser
52
58
import re
53
import os
54
59
import signal
55
60
import subprocess
56
61
import atexit
57
62
import stat
58
import logging
59
63
import logging.handlers
60
64
import pwd
61
65
import contextlib
62
66
import struct
63
67
import fcntl
64
68
import functools
65
import cPickle as pickle
69
try:
70
import cPickle as pickle
71
except ImportError:
72
import pickle
66
73
import multiprocessing
67
74
import types
68
75
import binascii
69
76
import tempfile
70
77
import itertools
71
78
import collections
79
import codecs
80
import random
81
import shlex
72
82
73
83
import dbus
74
84
import dbus.service
75
import gobject
76
import avahi
85
import gi
86
from gi.repository import GLib
77
87
from dbus.mainloop.glib import DBusGMainLoop
78
88
import ctypes
79
89
import ctypes.util
80
90
import xml.dom.minidom
81
91
import inspect
82
92
83
try:
93
if sys.version_info.major == 2:
94
__metaclass__ = type
95
str = unicode
96
input = raw_input
97
98
# Add collections.abc.Callable if it does not exist
99
try:
100
collections.abc.Callable
101
except AttributeError:
102
class abc:
103
Callable = collections.Callable
104
collections.abc = abc
105
del abc
106
107
# Add shlex.quote if it does not exist
108
try:
109
shlex.quote
110
except AttributeError:
111
shlex.quote = re.escape
112
113
# Add os.set_inheritable if it does not exist
114
try:
115
os.set_inheritable
116
except AttributeError:
117
def set_inheritable(fd, inheritable):
118
flags = fcntl.fcntl(fd, fcntl.F_GETFD)
119
if inheritable and ((flags & fcntl.FD_CLOEXEC) != 0):
120
fcntl.fcntl(fd, fcntl.F_SETFL, flags & ~fcntl.FD_CLOEXEC)
121
elif (not inheritable) and ((flags & fcntl.FD_CLOEXEC) == 0):
122
fcntl.fcntl(fd, fcntl.F_SETFL, flags | fcntl.FD_CLOEXEC)
123
os.set_inheritable = set_inheritable
124
del set_inheritable
125
126
# Show warnings by default
127
if not sys.warnoptions:
128
import warnings
129
warnings.simplefilter("default")
130
131
# Try to find the value of SO_BINDTODEVICE:
132
try:
133
# This is where SO_BINDTODEVICE is in Python 3.3 (or 3.4?) and
134
# newer, and it is also the most natural place for it:
84
135
SO_BINDTODEVICE = socket.SO_BINDTODEVICE
85
136
except AttributeError:
86
137
try:
138
# This is where SO_BINDTODEVICE was up to and including Python
139
# 2.6, and also 3.2:
87
140
from IN import SO_BINDTODEVICE
88
141
except ImportError:
89
SO_BINDTODEVICE = None
90
91
version = "1.6.5"
142
# In Python 2.7 it seems to have been removed entirely.
143
# Try running the C preprocessor:
144
try:
145
cc = subprocess.Popen(["cc", "--language=c", "-E",
146
"/dev/stdin"],
147
stdin=subprocess.PIPE,
148
stdout=subprocess.PIPE)
149
stdout = cc.communicate(
150
"#include <sys/socket.h>\nSO_BINDTODEVICE\n")[0]
151
SO_BINDTODEVICE = int(stdout.splitlines()[-1])
152
except (OSError, ValueError, IndexError):
153
# No value found
154
SO_BINDTODEVICE = None
155
156
if sys.version_info < (3, 2):
157
configparser.Configparser = configparser.SafeConfigParser
158
159
version = "1.8.18"
92
160
stored_state_file = "clients.pickle"
93
161
94
logger = logging.getLogger()
162
log = logging.getLogger(os.path.basename(sys.argv[0]))
163
logging.captureWarnings(True) # Show warnings via the logging system
95
164
syslogger = None
96
165
97
166
try:
98
if_nametoindex = (ctypes.cdll.LoadLibrary
99
(ctypes.util.find_library("c"))
100
.if_nametoindex)
167
if_nametoindex = ctypes.cdll.LoadLibrary(
168
ctypes.util.find_library("c")).if_nametoindex
101
169
except (OSError, AttributeError):
170
102
171
def if_nametoindex(interface):
103
172
"Get an interface index the hard way, i.e. using fcntl()"
104
173
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
105
174
with contextlib.closing(socket.socket()) as s:
106
175
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
107
struct.pack(str("16s16x"),
108
interface))
109
interface_index = struct.unpack(str("I"),
110
ifreq[16:20])[0]
176
struct.pack(b"16s16x", interface))
177
interface_index = struct.unpack("I", ifreq[16:20])[0]
111
178
return interface_index
112
179
113
180
181
def copy_function(func):
182
"""Make a copy of a function"""
183
if sys.version_info.major == 2:
184
return types.FunctionType(func.func_code,
185
func.func_globals,
186
func.func_name,
187
func.func_defaults,
188
func.func_closure)
189
else:
190
return types.FunctionType(func.__code__,
191
func.__globals__,
192
func.__name__,
193
func.__defaults__,
194
func.__closure__)
195
196
114
197
def initlogger(debug, level=logging.WARNING):
115
198
"""init logger and add loglevel"""
116
117
syslogger = (logging.handlers.SysLogHandler
118
(facility =
119
logging.handlers.SysLogHandler.LOG_DAEMON,
120
address = str("/dev/log")))
199
200
global syslogger
201
syslogger = (logging.handlers.SysLogHandler(
202
facility=logging.handlers.SysLogHandler.LOG_DAEMON,
203
address="/dev/log"))
121
204
syslogger.setFormatter(logging.Formatter
122
('Mandos [%(process)d]: %(levelname)s:'
123
' %(message)s'))
124
logger.addHandler(syslogger)
125
205
("Mandos [%(process)d]: %(levelname)s:"
206
" %(message)s"))
207
log.addHandler(syslogger)
208
126
209
if debug:
127
210
console = logging.StreamHandler()
128
console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
129
' [%(process)d]:'
130
' %(levelname)s:'
131
' %(message)s'))
132
logger.addHandler(console)
133
logger.setLevel(level)
211
console.setFormatter(logging.Formatter("%(asctime)s %(name)s"
212
" [%(process)d]:"
213
" %(levelname)s:"
214
" %(message)s"))
215
log.addHandler(console)
216
log.setLevel(level)
134
217
135
218
136
219
class PGPError(Exception):
138
221
pass
139
222
140
223
141
class PGPEngine(object):
224
class PGPEngine:
142
225
"""A simple class for OpenPGP symmetric encryption & decryption"""
226
143
227
def __init__(self):
144
228
self.tempdir = tempfile.mkdtemp(prefix="mandos-")
145
self.gnupgargs = ['--batch',
146
'--home', self.tempdir,
147
'--force-mdc',
148
'--quiet',
149
'--no-use-agent']
150
229
self.gpg = "gpg"
230
try:
231
output = subprocess.check_output(["gpgconf"])
232
for line in output.splitlines():
233
name, text, path = line.split(b":")
234
if name == b"gpg":
235
self.gpg = path
236
break
237
except OSError as e:
238
if e.errno != errno.ENOENT:
239
raise
240
self.gnupgargs = ["--batch",
241
"--homedir", self.tempdir,
242
"--force-mdc",
243
"--quiet"]
244
# Only GPG version 1 has the --no-use-agent option.
245
if self.gpg == b"gpg" or self.gpg.endswith(b"/gpg"):
246
self.gnupgargs.append("--no-use-agent")
247
151
248
def __enter__(self):
152
249
return self
153
250
154
251
def __exit__(self, exc_type, exc_value, traceback):
155
252
self._cleanup()
156
253
return False
157
254
158
255
def __del__(self):
159
256
self._cleanup()
160
257
161
258
def _cleanup(self):
162
259
if self.tempdir is not None:
163
260
# Delete contents of tempdir
164
261
for root, dirs, files in os.walk(self.tempdir,
165
topdown = False):
262
topdown=False):
166
263
for filename in files:
167
264
os.remove(os.path.join(root, filename))
168
265
for dirname in dirs:
170
267
# Remove tempdir
171
268
os.rmdir(self.tempdir)
172
269
self.tempdir = None
173
270
174
271
def password_encode(self, password):
175
272
# Passphrase can not be empty and can not contain newlines or
176
273
# NUL bytes. So we prefix it and hex encode it.
181
278
.replace(b"\n", b"\\n")
182
279
.replace(b"\0", b"\\x00"))
183
280
return encoded
184
281
185
282
def encrypt(self, data, password):
186
283
passphrase = self.password_encode(password)
187
with tempfile.NamedTemporaryFile(dir=self.tempdir
188
) as passfile:
284
with tempfile.NamedTemporaryFile(
285
dir=self.tempdir) as passfile:
189
286
passfile.write(passphrase)
190
287
passfile.flush()
191
proc = subprocess.Popen(['gpg', '--symmetric',
192
'--passphrase-file',
288
proc = subprocess.Popen([self.gpg, "--symmetric",
289
"--passphrase-file",
193
290
passfile.name]
194
291
+ self.gnupgargs,
195
stdin = subprocess.PIPE,
196
stdout = subprocess.PIPE,
197
stderr = subprocess.PIPE)
198
ciphertext, err = proc.communicate(input = data)
292
stdin=subprocess.PIPE,
293
stdout=subprocess.PIPE,
294
stderr=subprocess.PIPE)
295
ciphertext, err = proc.communicate(input=data)
199
296
if proc.returncode != 0:
200
297
raise PGPError(err)
201
298
return ciphertext
202
299
203
300
def decrypt(self, data, password):
204
301
passphrase = self.password_encode(password)
205
with tempfile.NamedTemporaryFile(dir = self.tempdir
206
) as passfile:
302
with tempfile.NamedTemporaryFile(
303
dir=self.tempdir) as passfile:
207
304
passfile.write(passphrase)
208
305
passfile.flush()
209
proc = subprocess.Popen(['gpg', '--decrypt',
210
'--passphrase-file',
306
proc = subprocess.Popen([self.gpg, "--decrypt",
307
"--passphrase-file",
211
308
passfile.name]
212
309
+ self.gnupgargs,
213
stdin = subprocess.PIPE,
214
stdout = subprocess.PIPE,
215
stderr = subprocess.PIPE)
216
decrypted_plaintext, err = proc.communicate(input
217
= data)
310
stdin=subprocess.PIPE,
311
stdout=subprocess.PIPE,
312
stderr=subprocess.PIPE)
313
decrypted_plaintext, err = proc.communicate(input=data)
218
314
if proc.returncode != 0:
219
315
raise PGPError(err)
220
316
return decrypted_plaintext
221
317
222
318
319
# Pretend that we have an Avahi module
320
class avahi:
321
"""This isn't so much a class as it is a module-like namespace."""
322
IF_UNSPEC = -1 # avahi-common/address.h
323
PROTO_UNSPEC = -1 # avahi-common/address.h
324
PROTO_INET = 0 # avahi-common/address.h
325
PROTO_INET6 = 1 # avahi-common/address.h
326
DBUS_NAME = "org.freedesktop.Avahi"
327
DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"
328
DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"
329
DBUS_PATH_SERVER = "/"
330
331
@staticmethod
332
def string_array_to_txt_array(t):
333
return dbus.Array((dbus.ByteArray(s.encode("utf-8"))
334
for s in t), signature="ay")
335
ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h
336
ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h
337
ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h
338
SERVER_INVALID = 0 # avahi-common/defs.h
339
SERVER_REGISTERING = 1 # avahi-common/defs.h
340
SERVER_RUNNING = 2 # avahi-common/defs.h
341
SERVER_COLLISION = 3 # avahi-common/defs.h
342
SERVER_FAILURE = 4 # avahi-common/defs.h
343
344
223
345
class AvahiError(Exception):
224
346
def __init__(self, value, *args, **kwargs):
225
347
self.value = value
226
super(AvahiError, self).__init__(value, *args, **kwargs)
227
def __unicode__(self):
228
return unicode(repr(self.value))
348
return super(AvahiError, self).__init__(value, *args,
349
**kwargs)
350
229
351
230
352
class AvahiServiceError(AvahiError):
231
353
pass
232
354
355
233
356
class AvahiGroupError(AvahiError):
234
357
pass
235
358
236
359
237
class AvahiService(object):
360
class AvahiService:
238
361
"""An Avahi (Zeroconf) service.
239
362
240
363
Attributes:
241
364
interface: integer; avahi.IF_UNSPEC or an interface index.
242
365
Used to optionally bind to the specified interface.
243
name: string; Example: 'Mandos'
244
type: string; Example: '_mandos._tcp'.
366
name: string; Example: "Mandos"
367
type: string; Example: "_mandos._tcp".
245
368
See <https://www.iana.org/assignments/service-names-port-numbers>
246
369
port: integer; what port to announce
247
370
TXT: list of strings; TXT record for the service
254
377
server: D-Bus Server
255
378
bus: dbus.SystemBus()
256
379
"""
257
258
def __init__(self, interface = avahi.IF_UNSPEC, name = None,
259
servicetype = None, port = None, TXT = None,
260
domain = "", host = "", max_renames = 32768,
261
protocol = avahi.PROTO_UNSPEC, bus = None):
380
381
def __init__(self,
382
interface=avahi.IF_UNSPEC,
383
name=None,
384
servicetype=None,
385
port=None,
386
TXT=None,
387
domain="",
388
host="",
389
max_renames=32768,
390
protocol=avahi.PROTO_UNSPEC,
391
bus=None):
262
392
self.interface = interface
263
393
self.name = name
264
394
self.type = servicetype
273
403
self.server = None
274
404
self.bus = bus
275
405
self.entry_group_state_changed_match = None
276
277
def rename(self):
406
407
def rename(self, remove=True):
278
408
"""Derived from the Avahi example code"""
279
409
if self.rename_count >= self.max_renames:
280
logger.critical("No suitable Zeroconf service name found"
281
" after %i retries, exiting.",
282
self.rename_count)
410
log.critical("No suitable Zeroconf service name found"
411
" after %i retries, exiting.",
412
self.rename_count)
283
413
raise AvahiServiceError("Too many renames")
284
self.name = unicode(self.server
285
.GetAlternativeServiceName(self.name))
286
logger.info("Changing Zeroconf service name to %r ...",
287
self.name)
288
self.remove()
289
try:
290
self.add()
291
except dbus.exceptions.DBusException as error:
292
logger.critical("D-Bus Exception", exc_info=error)
293
self.cleanup()
294
os._exit(1)
414
self.name = str(
415
self.server.GetAlternativeServiceName(self.name))
295
416
self.rename_count += 1
296
417
log.info("Changing Zeroconf service name to %r ...",
418
self.name)
419
if remove:
420
self.remove()
421
try:
422
self.add()
423
except dbus.exceptions.DBusException as error:
424
if (error.get_dbus_name()
425
== "org.freedesktop.Avahi.CollisionError"):
426
log.info("Local Zeroconf service name collision.")
427
return self.rename(remove=False)
428
else:
429
log.critical("D-Bus Exception", exc_info=error)
430
self.cleanup()
431
os._exit(1)
432
297
433
def remove(self):
298
434
"""Derived from the Avahi example code"""
299
435
if self.entry_group_state_changed_match is not None:
301
437
self.entry_group_state_changed_match = None
302
438
if self.group is not None:
303
439
self.group.Reset()
304
440
305
441
def add(self):
306
442
"""Derived from the Avahi example code"""
307
443
self.remove()
312
448
avahi.DBUS_INTERFACE_ENTRY_GROUP)
313
449
self.entry_group_state_changed_match = (
314
450
self.group.connect_to_signal(
315
'StateChanged', self.entry_group_state_changed))
316
logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
317
self.name, self.type)
451
"StateChanged", self.entry_group_state_changed))
452
log.debug("Adding Zeroconf service '%s' of type '%s' ...",
453
self.name, self.type)
318
454
self.group.AddService(
319
455
self.interface,
320
456
self.protocol,
324
460
dbus.UInt16(self.port),
325
461
avahi.string_array_to_txt_array(self.TXT))
326
462
self.group.Commit()
327
463
328
464
def entry_group_state_changed(self, state, error):
329
465
"""Derived from the Avahi example code"""
330
logger.debug("Avahi entry group state change: %i", state)
331
466
log.debug("Avahi entry group state change: %i", state)
467
332
468
if state == avahi.ENTRY_GROUP_ESTABLISHED:
333
logger.debug("Zeroconf service established.")
469
log.debug("Zeroconf service established.")
334
470
elif state == avahi.ENTRY_GROUP_COLLISION:
335
logger.info("Zeroconf service name collision.")
471
log.info("Zeroconf service name collision.")
336
472
self.rename()
337
473
elif state == avahi.ENTRY_GROUP_FAILURE:
338
logger.critical("Avahi: Error in group state changed %s",
339
unicode(error))
340
raise AvahiGroupError("State changed: {0!s}"
341
.format(error))
342
474
log.critical("Avahi: Error in group state changed %s",
475
str(error))
476
raise AvahiGroupError("State changed: {!s}".format(error))
477
343
478
def cleanup(self):
344
479
"""Derived from the Avahi example code"""
345
480
if self.group is not None:
350
485
pass
351
486
self.group = None
352
487
self.remove()
353
488
354
489
def server_state_changed(self, state, error=None):
355
490
"""Derived from the Avahi example code"""
356
logger.debug("Avahi server state change: %i", state)
357
bad_states = { avahi.SERVER_INVALID:
358
"Zeroconf server invalid",
359
avahi.SERVER_REGISTERING: None,
360
avahi.SERVER_COLLISION:
361
"Zeroconf server name collision",
362
avahi.SERVER_FAILURE:
363
"Zeroconf server failure" }
491
log.debug("Avahi server state change: %i", state)
492
bad_states = {
493
avahi.SERVER_INVALID: "Zeroconf server invalid",
494
avahi.SERVER_REGISTERING: None,
495
avahi.SERVER_COLLISION: "Zeroconf server name collision",
496
avahi.SERVER_FAILURE: "Zeroconf server failure",
497
}
364
498
if state in bad_states:
365
499
if bad_states[state] is not None:
366
500
if error is None:
367
logger.error(bad_states[state])
501
log.error(bad_states[state])
368
502
else:
369
logger.error(bad_states[state] + ": %r", error)
503
log.error(bad_states[state] + ": %r", error)
370
504
self.cleanup()
371
505
elif state == avahi.SERVER_RUNNING:
372
self.add()
506
try:
507
self.add()
508
except dbus.exceptions.DBusException as error:
509
if (error.get_dbus_name()
510
== "org.freedesktop.Avahi.CollisionError"):
511
log.info("Local Zeroconf service name collision.")
512
return self.rename(remove=False)
513
else:
514
log.critical("D-Bus Exception", exc_info=error)
515
self.cleanup()
516
os._exit(1)
373
517
else:
374
518
if error is None:
375
logger.debug("Unknown state: %r", state)
519
log.debug("Unknown state: %r", state)
376
520
else:
377
logger.debug("Unknown state: %r: %r", state, error)
378
521
log.debug("Unknown state: %r: %r", state, error)
522
379
523
def activate(self):
380
524
"""Derived from the Avahi example code"""
381
525
if self.server is None:
385
529
follow_name_owner_changes=True),
386
530
avahi.DBUS_INTERFACE_SERVER)
387
531
self.server.connect_to_signal("StateChanged",
388
self.server_state_changed)
532
self.server_state_changed)
389
533
self.server_state_changed(self.server.GetState())
390
534
391
535
392
536
class AvahiServiceToSyslog(AvahiService):
393
def rename(self):
537
def rename(self, *args, **kwargs):
394
538
"""Add the new name to the syslog messages"""
395
ret = AvahiService.rename(self)
396
syslogger.setFormatter(logging.Formatter
397
('Mandos ({0}) [%(process)d]:'
398
' %(levelname)s: %(message)s'
399
.format(self.name)))
539
ret = super(AvahiServiceToSyslog, self).rename(*args,
540
**kwargs)
541
syslogger.setFormatter(logging.Formatter(
542
"Mandos ({}) [%(process)d]: %(levelname)s: %(message)s"
543
.format(self.name)))
400
544
return ret
401
545
402
546
403
def timedelta_to_milliseconds(td):
404
"Convert a datetime.timedelta() to milliseconds"
405
return ((td.days * 24 * 60 * 60 * 1000)
406
+ (td.seconds * 1000)
407
+ (td.microseconds // 1000))
408
409
410
class Client(object):
547
# Pretend that we have a GnuTLS module
548
class gnutls:
549
"""This isn't so much a class as it is a module-like namespace."""
550
551
library = ctypes.util.find_library("gnutls")
552
if library is None:
553
library = ctypes.util.find_library("gnutls-deb0")
554
_library = ctypes.cdll.LoadLibrary(library)
555
del library
556
557
# Unless otherwise indicated, the constants and types below are
558
# all from the gnutls/gnutls.h C header file.
559
560
# Constants
561
E_SUCCESS = 0
562
E_INTERRUPTED = -52
563
E_AGAIN = -28
564
CRT_OPENPGP = 2
565
CRT_RAWPK = 3
566
CLIENT = 2
567
SHUT_RDWR = 0
568
CRD_CERTIFICATE = 1
569
E_NO_CERTIFICATE_FOUND = -49
570
X509_FMT_DER = 0
571
NO_TICKETS = 1<<10
572
ENABLE_RAWPK = 1<<18
573
CTYPE_PEERS = 3
574
KEYID_USE_SHA256 = 1 # gnutls/x509.h
575
OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h
576
577
# Types
578
class _session_int(ctypes.Structure):
579
_fields_ = []
580
session_t = ctypes.POINTER(_session_int)
581
582
class certificate_credentials_st(ctypes.Structure):
583
_fields_ = []
584
certificate_credentials_t = ctypes.POINTER(
585
certificate_credentials_st)
586
certificate_type_t = ctypes.c_int
587
588
class datum_t(ctypes.Structure):
589
_fields_ = [("data", ctypes.POINTER(ctypes.c_ubyte)),
590
("size", ctypes.c_uint)]
591
592
class _openpgp_crt_int(ctypes.Structure):
593
_fields_ = []
594
openpgp_crt_t = ctypes.POINTER(_openpgp_crt_int)
595
openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
596
log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
597
credentials_type_t = ctypes.c_int
598
transport_ptr_t = ctypes.c_void_p
599
close_request_t = ctypes.c_int
600
601
# Exceptions
602
class Error(Exception):
603
def __init__(self, message=None, code=None, args=()):
604
# Default usage is by a message string, but if a return
605
# code is passed, convert it to a string with
606
# gnutls.strerror()
607
self.code = code
608
if message is None and code is not None:
609
message = gnutls.strerror(code).decode(
610
"utf-8", errors="replace")
611
return super(gnutls.Error, self).__init__(
612
message, *args)
613
614
class CertificateSecurityError(Error):
615
pass
616
617
class PointerTo:
618
def __init__(self, cls):
619
self.cls = cls
620
621
def from_param(self, obj):
622
if not isinstance(obj, self.cls):
623
raise TypeError("Not of type {}: {!r}"
624
.format(self.cls.__name__, obj))
625
return ctypes.byref(obj.from_param(obj))
626
627
class CastToVoidPointer:
628
def __init__(self, cls):
629
self.cls = cls
630
631
def from_param(self, obj):
632
if not isinstance(obj, self.cls):
633
raise TypeError("Not of type {}: {!r}"
634
.format(self.cls.__name__, obj))
635
return ctypes.cast(obj.from_param(obj), ctypes.c_void_p)
636
637
class With_from_param:
638
@classmethod
639
def from_param(cls, obj):
640
return obj._as_parameter_
641
642
# Classes
643
class Credentials(With_from_param):
644
def __init__(self):
645
self._as_parameter_ = gnutls.certificate_credentials_t()
646
gnutls.certificate_allocate_credentials(self)
647
self.type = gnutls.CRD_CERTIFICATE
648
649
def __del__(self):
650
gnutls.certificate_free_credentials(self)
651
652
class ClientSession(With_from_param):
653
def __init__(self, socket, credentials=None):
654
self._as_parameter_ = gnutls.session_t()
655
gnutls_flags = gnutls.CLIENT
656
if gnutls.check_version(b"3.5.6"):
657
gnutls_flags |= gnutls.NO_TICKETS
658
if gnutls.has_rawpk:
659
gnutls_flags |= gnutls.ENABLE_RAWPK
660
gnutls.init(self, gnutls_flags)
661
del gnutls_flags
662
gnutls.set_default_priority(self)
663
gnutls.transport_set_ptr(self, socket.fileno())
664
gnutls.handshake_set_private_extensions(self, True)
665
self.socket = socket
666
if credentials is None:
667
credentials = gnutls.Credentials()
668
gnutls.credentials_set(self, credentials.type,
669
credentials)
670
self.credentials = credentials
671
672
def __del__(self):
673
gnutls.deinit(self)
674
675
def handshake(self):
676
return gnutls.handshake(self)
677
678
def send(self, data):
679
data = bytes(data)
680
data_len = len(data)
681
while data_len > 0:
682
data_len -= gnutls.record_send(self, data[-data_len:],
683
data_len)
684
685
def bye(self):
686
return gnutls.bye(self, gnutls.SHUT_RDWR)
687
688
# Error handling functions
689
def _error_code(result):
690
"""A function to raise exceptions on errors, suitable
691
for the "restype" attribute on ctypes functions"""
692
if result >= gnutls.E_SUCCESS:
693
return result
694
if result == gnutls.E_NO_CERTIFICATE_FOUND:
695
raise gnutls.CertificateSecurityError(code=result)
696
raise gnutls.Error(code=result)
697
698
def _retry_on_error(result, func, arguments,
699
_error_code=_error_code):
700
"""A function to retry on some errors, suitable
701
for the "errcheck" attribute on ctypes functions"""
702
while result < gnutls.E_SUCCESS:
703
if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
704
return _error_code(result)
705
result = func(*arguments)
706
return result
707
708
# Unless otherwise indicated, the function declarations below are
709
# all from the gnutls/gnutls.h C header file.
710
711
# Functions
712
priority_set_direct = _library.gnutls_priority_set_direct
713
priority_set_direct.argtypes = [ClientSession, ctypes.c_char_p,
714
ctypes.POINTER(ctypes.c_char_p)]
715
priority_set_direct.restype = _error_code
716
717
init = _library.gnutls_init
718
init.argtypes = [PointerTo(ClientSession), ctypes.c_int]
719
init.restype = _error_code
720
721
set_default_priority = _library.gnutls_set_default_priority
722
set_default_priority.argtypes = [ClientSession]
723
set_default_priority.restype = _error_code
724
725
record_send = _library.gnutls_record_send
726
record_send.argtypes = [ClientSession, ctypes.c_void_p,
727
ctypes.c_size_t]
728
record_send.restype = ctypes.c_ssize_t
729
record_send.errcheck = _retry_on_error
730
731
certificate_allocate_credentials = (
732
_library.gnutls_certificate_allocate_credentials)
733
certificate_allocate_credentials.argtypes = [
734
PointerTo(Credentials)]
735
certificate_allocate_credentials.restype = _error_code
736
737
certificate_free_credentials = (
738
_library.gnutls_certificate_free_credentials)
739
certificate_free_credentials.argtypes = [Credentials]
740
certificate_free_credentials.restype = None
741
742
handshake_set_private_extensions = (
743
_library.gnutls_handshake_set_private_extensions)
744
handshake_set_private_extensions.argtypes = [ClientSession,
745
ctypes.c_int]
746
handshake_set_private_extensions.restype = None
747
748
credentials_set = _library.gnutls_credentials_set
749
credentials_set.argtypes = [ClientSession, credentials_type_t,
750
CastToVoidPointer(Credentials)]
751
credentials_set.restype = _error_code
752
753
strerror = _library.gnutls_strerror
754
strerror.argtypes = [ctypes.c_int]
755
strerror.restype = ctypes.c_char_p
756
757
certificate_type_get = _library.gnutls_certificate_type_get
758
certificate_type_get.argtypes = [ClientSession]
759
certificate_type_get.restype = _error_code
760
761
certificate_get_peers = _library.gnutls_certificate_get_peers
762
certificate_get_peers.argtypes = [ClientSession,
763
ctypes.POINTER(ctypes.c_uint)]
764
certificate_get_peers.restype = ctypes.POINTER(datum_t)
765
766
global_set_log_level = _library.gnutls_global_set_log_level
767
global_set_log_level.argtypes = [ctypes.c_int]
768
global_set_log_level.restype = None
769
770
global_set_log_function = _library.gnutls_global_set_log_function
771
global_set_log_function.argtypes = [log_func]
772
global_set_log_function.restype = None
773
774
deinit = _library.gnutls_deinit
775
deinit.argtypes = [ClientSession]
776
deinit.restype = None
777
778
handshake = _library.gnutls_handshake
779
handshake.argtypes = [ClientSession]
780
handshake.restype = ctypes.c_int
781
handshake.errcheck = _retry_on_error
782
783
transport_set_ptr = _library.gnutls_transport_set_ptr
784
transport_set_ptr.argtypes = [ClientSession, transport_ptr_t]
785
transport_set_ptr.restype = None
786
787
bye = _library.gnutls_bye
788
bye.argtypes = [ClientSession, close_request_t]
789
bye.restype = ctypes.c_int
790
bye.errcheck = _retry_on_error
791
792
check_version = _library.gnutls_check_version
793
check_version.argtypes = [ctypes.c_char_p]
794
check_version.restype = ctypes.c_char_p
795
796
_need_version = b"3.3.0"
797
if check_version(_need_version) is None:
798
raise self.Error("Needs GnuTLS {} or later"
799
.format(_need_version))
800
801
_tls_rawpk_version = b"3.6.6"
802
has_rawpk = bool(check_version(_tls_rawpk_version))
803
804
if has_rawpk:
805
# Types
806
class pubkey_st(ctypes.Structure):
807
_fields = []
808
pubkey_t = ctypes.POINTER(pubkey_st)
809
810
x509_crt_fmt_t = ctypes.c_int
811
812
# All the function declarations below are from
813
# gnutls/abstract.h
814
pubkey_init = _library.gnutls_pubkey_init
815
pubkey_init.argtypes = [ctypes.POINTER(pubkey_t)]
816
pubkey_init.restype = _error_code
817
818
pubkey_import = _library.gnutls_pubkey_import
819
pubkey_import.argtypes = [pubkey_t, ctypes.POINTER(datum_t),
820
x509_crt_fmt_t]
821
pubkey_import.restype = _error_code
822
823
pubkey_get_key_id = _library.gnutls_pubkey_get_key_id
824
pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,
825
ctypes.POINTER(ctypes.c_ubyte),
826
ctypes.POINTER(ctypes.c_size_t)]
827
pubkey_get_key_id.restype = _error_code
828
829
pubkey_deinit = _library.gnutls_pubkey_deinit
830
pubkey_deinit.argtypes = [pubkey_t]
831
pubkey_deinit.restype = None
832
else:
833
# All the function declarations below are from
834
# gnutls/openpgp.h
835
836
openpgp_crt_init = _library.gnutls_openpgp_crt_init
837
openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
838
openpgp_crt_init.restype = _error_code
839
840
openpgp_crt_import = _library.gnutls_openpgp_crt_import
841
openpgp_crt_import.argtypes = [openpgp_crt_t,
842
ctypes.POINTER(datum_t),
843
openpgp_crt_fmt_t]
844
openpgp_crt_import.restype = _error_code
845
846
openpgp_crt_verify_self = \
847
_library.gnutls_openpgp_crt_verify_self
848
openpgp_crt_verify_self.argtypes = [
849
openpgp_crt_t,
850
ctypes.c_uint,
851
ctypes.POINTER(ctypes.c_uint),
852
]
853
openpgp_crt_verify_self.restype = _error_code
854
855
openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
856
openpgp_crt_deinit.argtypes = [openpgp_crt_t]
857
openpgp_crt_deinit.restype = None
858
859
openpgp_crt_get_fingerprint = (
860
_library.gnutls_openpgp_crt_get_fingerprint)
861
openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
862
ctypes.c_void_p,
863
ctypes.POINTER(
864
ctypes.c_size_t)]
865
openpgp_crt_get_fingerprint.restype = _error_code
866
867
if check_version(b"3.6.4"):
868
certificate_type_get2 = _library.gnutls_certificate_type_get2
869
certificate_type_get2.argtypes = [ClientSession, ctypes.c_int]
870
certificate_type_get2.restype = _error_code
871
872
# Remove non-public functions
873
del _error_code, _retry_on_error
874
875
876
def call_pipe(connection, # : multiprocessing.Connection
877
func, *args, **kwargs):
878
"""This function is meant to be called by multiprocessing.Process
879
880
This function runs func(*args, **kwargs), and writes the resulting
881
return value on the provided multiprocessing.Connection.
882
"""
883
connection.send(func(*args, **kwargs))
884
connection.close()
885
886
887
class Client:
411
888
"""A representation of a client host served by this server.
412
889
413
890
Attributes:
414
approved: bool(); 'None' if not yet approved/disapproved
891
approved: bool(); None if not yet approved/disapproved
415
892
approval_delay: datetime.timedelta(); Time to wait for approval
416
893
approval_duration: datetime.timedelta(); Duration of one approval
417
checker: subprocess.Popen(); a running checker process used
418
to see if the client lives.
419
'None' if no process is running.
420
checker_callback_tag: a gobject event source tag, or None
894
checker: multiprocessing.Process(); a running checker process used
895
to see if the client lives. None if no process is
896
running.
897
checker_callback_tag: a GLib event source tag, or None
421
898
checker_command: string; External command which is run to check
422
899
if client lives. %() expansions are done at
423
900
runtime with vars(self) as dict, so that for
424
901
instance %(name)s can be used in the command.
425
checker_initiator_tag: a gobject event source tag, or None
902
checker_initiator_tag: a GLib event source tag, or None
426
903
created: datetime.datetime(); (UTC) object creation
427
904
client_structure: Object describing what attributes a client has
428
905
and is used for storing the client at exit
429
906
current_checker_command: string; current running checker_command
430
disable_initiator_tag: a gobject event source tag, or None
907
disable_initiator_tag: a GLib event source tag, or None
431
908
enabled: bool()
432
909
fingerprint: string (40 or 32 hexadecimal digits); used to
433
uniquely identify the client
910
uniquely identify an OpenPGP client
911
key_id: string (64 hexadecimal digits); used to uniquely identify
912
a client using raw public keys
434
913
host: string; available for use by the checker command
435
914
interval: datetime.timedelta(); How often to start a new checker
436
915
last_approval_request: datetime.datetime(); (UTC) or None
438
917
last_checker_status: integer between 0 and 255 reflecting exit
439
918
status of last checker. -1 reflects crashed
440
919
checker, -2 means no checker completed yet.
920
last_checker_signal: The signal which killed the last checker, if
921
last_checker_status is -1
441
922
last_enabled: datetime.datetime(); (UTC) or None
442
923
name: string; from the config file, used in log messages and
443
924
D-Bus identifiers
450
931
disabled, or None
451
932
server_settings: The server_settings dict from main()
452
933
"""
453
934
454
935
runtime_expansions = ("approval_delay", "approval_duration",
455
"created", "enabled", "expires",
936
"created", "enabled", "expires", "key_id",
456
937
"fingerprint", "host", "interval",
457
938
"last_approval_request", "last_checked_ok",
458
939
"last_enabled", "name", "timeout")
459
client_defaults = { "timeout": "PT5M",
460
"extended_timeout": "PT15M",
461
"interval": "PT2M",
462
"checker": "fping -q -- %%(host)s",
463
"host": "",
464
"approval_delay": "PT0S",
465
"approval_duration": "PT1S",
466
"approved_by_default": "True",
467
"enabled": "True",
468
}
469
470
def timeout_milliseconds(self):
471
"Return the 'timeout' attribute in milliseconds"
472
return timedelta_to_milliseconds(self.timeout)
473
474
def extended_timeout_milliseconds(self):
475
"Return the 'extended_timeout' attribute in milliseconds"
476
return timedelta_to_milliseconds(self.extended_timeout)
477
478
def interval_milliseconds(self):
479
"Return the 'interval' attribute in milliseconds"
480
return timedelta_to_milliseconds(self.interval)
481
482
def approval_delay_milliseconds(self):
483
return timedelta_to_milliseconds(self.approval_delay)
484
940
client_defaults = {
941
"timeout": "PT5M",
942
"extended_timeout": "PT15M",
943
"interval": "PT2M",
944
"checker": "fping -q -- %%(host)s",
945
"host": "",
946
"approval_delay": "PT0S",
947
"approval_duration": "PT1S",
948
"approved_by_default": "True",
949
"enabled": "True",
950
}
951
485
952
@staticmethod
486
953
def config_parser(config):
487
954
"""Construct a new dict of client settings of this form:
494
961
for client_name in config.sections():
495
962
section = dict(config.items(client_name))
496
963
client = settings[client_name] = {}
497
964
498
965
client["host"] = section["host"]
499
966
# Reformat values from string types to Python types
500
967
client["approved_by_default"] = config.getboolean(
501
968
client_name, "approved_by_default")
502
969
client["enabled"] = config.getboolean(client_name,
503
970
"enabled")
504
505
client["fingerprint"] = (section["fingerprint"].upper()
971
972
# Uppercase and remove spaces from key_id and fingerprint
973
# for later comparison purposes with return value from the
974
# key_id() and fingerprint() functions
975
client["key_id"] = (section.get("key_id", "").upper()
976
.replace(" ", ""))
977
client["fingerprint"] = (section.get("fingerprint",
978
"").upper()
506
979
.replace(" ", ""))
980
if not (client["key_id"] or client["fingerprint"]):
981
log.error("Skipping client %s without key_id or"
982
" fingerprint", client_name)
983
del settings[client_name]
984
continue
507
985
if "secret" in section:
508
client["secret"] = section["secret"].decode("base64")
986
client["secret"] = codecs.decode(section["secret"]
987
.encode("utf-8"),
988
"base64")
509
989
elif "secfile" in section:
510
990
with open(os.path.expanduser(os.path.expandvars
511
991
(section["secfile"])),
512
992
"rb") as secfile:
513
993
client["secret"] = secfile.read()
514
994
else:
515
raise TypeError("No secret or secfile for section {0}"
995
raise TypeError("No secret or secfile for section {}"
516
996
.format(section))
517
997
client["timeout"] = string_to_delta(section["timeout"])
518
998
client["extended_timeout"] = string_to_delta(
526
1006
client["last_approval_request"] = None
527
1007
client["last_checked_ok"] = None
528
1008
client["last_checker_status"] = -2
529
1009
530
1010
return settings
531
532
def __init__(self, settings, name = None, server_settings=None):
1011
1012
def __init__(self, settings, name=None, server_settings=None):
533
1013
self.name = name
534
1014
if server_settings is None:
535
1015
server_settings = {}
536
1016
self.server_settings = server_settings
537
1017
# adding all client settings
538
for setting, value in settings.iteritems():
1018
for setting, value in settings.items():
539
1019
setattr(self, setting, value)
540
1020
541
1021
if self.enabled:
542
1022
if not hasattr(self, "last_enabled"):
543
1023
self.last_enabled = datetime.datetime.utcnow()
547
1027
else:
548
1028
self.last_enabled = None
549
1029
self.expires = None
550
551
logger.debug("Creating client %r", self.name)
552
# Uppercase and remove spaces from fingerprint for later
553
# comparison purposes with return value from the fingerprint()
554
# function
555
logger.debug(" Fingerprint: %s", self.fingerprint)
1030
1031
log.debug("Creating client %r", self.name)
1032
log.debug(" Key ID: %s", self.key_id)
1033
log.debug(" Fingerprint: %s", self.fingerprint)
556
1034
self.created = settings.get("created",
557
1035
datetime.datetime.utcnow())
558
1036
559
1037
# attributes specific for this server instance
560
1038
self.checker = None
561
1039
self.checker_initiator_tag = None
564
1042
self.current_checker_command = None
565
1043
self.approved = None
566
1044
self.approvals_pending = 0
567
self.changedstate = (multiprocessing_manager
568
.Condition(multiprocessing_manager
569
.Lock()))
570
self.client_structure = [attr for attr in
571
self.__dict__.iterkeys()
1045
self.changedstate = multiprocessing_manager.Condition(
1046
multiprocessing_manager.Lock())
1047
self.client_structure = [attr
1048
for attr in self.__dict__.keys()
572
1049
if not attr.startswith("_")]
573
1050
self.client_structure.append("client_structure")
574
575
for name, t in inspect.getmembers(type(self),
576
lambda obj:
577
isinstance(obj,
578
property)):
1051
1052
for name, t in inspect.getmembers(
1053
type(self), lambda obj: isinstance(obj, property)):
579
1054
if not name.startswith("_"):
580
1055
self.client_structure.append(name)
581
1056
582
1057
# Send notice to process children that client state has changed
583
1058
def send_changedstate(self):
584
1059
with self.changedstate:
585
1060
self.changedstate.notify_all()
586
1061
587
1062
def enable(self):
588
1063
"""Start this client's checker and timeout hooks"""
589
1064
if getattr(self, "enabled", False):
590
1065
# Already enabled
591
1066
return
592
self.expires = datetime.datetime.utcnow() + self.timeout
593
1067
self.enabled = True
594
1068
self.last_enabled = datetime.datetime.utcnow()
595
1069
self.init_checker()
596
1070
self.send_changedstate()
597
1071
598
1072
def disable(self, quiet=True):
599
1073
"""Disable this client."""
600
1074
if not getattr(self, "enabled", False):
601
1075
return False
602
1076
if not quiet:
603
logger.info("Disabling client %s", self.name)
1077
log.info("Disabling client %s", self.name)
604
1078
if getattr(self, "disable_initiator_tag", None) is not None:
605
gobject.source_remove(self.disable_initiator_tag)
1079
GLib.source_remove(self.disable_initiator_tag)
606
1080
self.disable_initiator_tag = None
607
1081
self.expires = None
608
1082
if getattr(self, "checker_initiator_tag", None) is not None:
609
gobject.source_remove(self.checker_initiator_tag)
1083
GLib.source_remove(self.checker_initiator_tag)
610
1084
self.checker_initiator_tag = None
611
1085
self.stop_checker()
612
1086
self.enabled = False
613
1087
if not quiet:
614
1088
self.send_changedstate()
615
# Do not run this again if called by a gobject.timeout_add
1089
# Do not run this again if called by a GLib.timeout_add
616
1090
return False
617
1091
618
1092
def __del__(self):
619
1093
self.disable()
620
621
def init_checker(self):
622
# Schedule a new checker to be started an 'interval' from now,
623
# and every interval from then on.
1094
1095
def init_checker(self, randomize_start=False):
1096
# Schedule a new checker to be started a randomly selected
1097
# time (a fraction of 'interval') from now. This spreads out
1098
# the startup of checkers over time when the server is
1099
# started.
624
1100
if self.checker_initiator_tag is not None:
625
gobject.source_remove(self.checker_initiator_tag)
626
self.checker_initiator_tag = (gobject.timeout_add
627
(self.interval_milliseconds(),
628
self.start_checker))
629
# Schedule a disable() when 'timeout' has passed
1101
GLib.source_remove(self.checker_initiator_tag)
1102
interval_milliseconds = int(self.interval.total_seconds()
1103
* 1000)
1104
if randomize_start:
1105
delay_milliseconds = random.randrange(
1106
interval_milliseconds + 1)
1107
else:
1108
delay_milliseconds = interval_milliseconds
1109
self.checker_initiator_tag = GLib.timeout_add(
1110
delay_milliseconds, self.start_checker, randomize_start)
1111
delay = datetime.timedelta(0, 0, 0, delay_milliseconds)
1112
# A checker might take up to an 'interval' of time, so we can
1113
# expire at the soonest one interval after a checker was
1114
# started. Since the initial checker is delayed, the expire
1115
# time might have to be extended.
1116
now = datetime.datetime.utcnow()
1117
self.expires = now + delay + self.interval
1118
# Schedule a disable() at expire time
630
1119
if self.disable_initiator_tag is not None:
631
gobject.source_remove(self.disable_initiator_tag)
632
self.disable_initiator_tag = (gobject.timeout_add
633
(self.timeout_milliseconds(),
634
self.disable))
635
# Also start a new checker *right now*.
636
self.start_checker()
637
638
def checker_callback(self, pid, condition, command):
1120
GLib.source_remove(self.disable_initiator_tag)
1121
self.disable_initiator_tag = GLib.timeout_add(
1122
int((self.expires - now).total_seconds() * 1000),
1123
self.disable)
1124
1125
def checker_callback(self, source, condition, connection,
1126
command):
639
1127
"""The checker has completed, so take appropriate actions."""
1128
# Read return code from connection (see call_pipe)
1129
returncode = connection.recv()
1130
connection.close()
1131
if self.checker is not None:
1132
self.checker.join()
640
1133
self.checker_callback_tag = None
641
1134
self.checker = None
642
if os.WIFEXITED(condition):
643
self.last_checker_status = os.WEXITSTATUS(condition)
1135
1136
if returncode >= 0:
1137
self.last_checker_status = returncode
1138
self.last_checker_signal = None
644
1139
if self.last_checker_status == 0:
645
logger.info("Checker for %(name)s succeeded",
646
vars(self))
1140
log.info("Checker for %(name)s succeeded", vars(self))
647
1141
self.checked_ok()
648
1142
else:
649
logger.info("Checker for %(name)s failed",
650
vars(self))
1143
log.info("Checker for %(name)s failed", vars(self))
651
1144
else:
652
1145
self.last_checker_status = -1
653
logger.warning("Checker for %(name)s crashed?",
654
vars(self))
655
1146
self.last_checker_signal = -returncode
1147
log.warning("Checker for %(name)s crashed?", vars(self))
1148
return False
1149
656
1150
def checked_ok(self):
657
1151
"""Assert that the client has been seen, alive and well."""
658
1152
self.last_checked_ok = datetime.datetime.utcnow()
659
1153
self.last_checker_status = 0
1154
self.last_checker_signal = None
660
1155
self.bump_timeout()
661
1156
662
1157
def bump_timeout(self, timeout=None):
663
1158
"""Bump up the timeout for this client."""
664
1159
if timeout is None:
665
1160
timeout = self.timeout
666
1161
if self.disable_initiator_tag is not None:
667
gobject.source_remove(self.disable_initiator_tag)
1162
GLib.source_remove(self.disable_initiator_tag)
668
1163
self.disable_initiator_tag = None
669
1164
if getattr(self, "enabled", False):
670
self.disable_initiator_tag = (gobject.timeout_add
671
(timedelta_to_milliseconds
672
(timeout), self.disable))
1165
self.disable_initiator_tag = GLib.timeout_add(
1166
int(timeout.total_seconds() * 1000), self.disable)
673
1167
self.expires = datetime.datetime.utcnow() + timeout
674
1168
675
1169
def need_approval(self):
676
1170
self.last_approval_request = datetime.datetime.utcnow()
677
678
def start_checker(self):
1171
1172
def start_checker(self, start_was_randomized=False):
679
1173
"""Start a new checker subprocess if one is not running.
680
1174
681
1175
If a checker already exists, leave it running and do
682
1176
nothing."""
683
1177
# The reason for not killing a running checker is that if we
688
1182
# checkers alone, the checker would have to take more time
689
1183
# than 'timeout' for the client to be disabled, which is as it
690
1184
# should be.
691
692
# If a checker exists, make sure it is not a zombie
693
try:
694
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
695
except AttributeError:
696
pass
697
except OSError as error:
698
if error.errno != errno.ECHILD:
699
raise
700
else:
701
if pid:
702
logger.warning("Checker was a zombie")
703
gobject.source_remove(self.checker_callback_tag)
704
self.checker_callback(pid, status,
705
self.current_checker_command)
1185
1186
if self.checker is not None and not self.checker.is_alive():
1187
log.warning("Checker was not alive; joining")
1188
self.checker.join()
1189
self.checker = None
706
1190
# Start a new checker if needed
707
1191
if self.checker is None:
708
1192
# Escape attributes for the shell
709
escaped_attrs = dict(
710
(attr, re.escape(unicode(getattr(self, attr))))
711
for attr in
712
self.runtime_expansions)
1193
escaped_attrs = {
1194
attr: shlex.quote(str(getattr(self, attr)))
1195
for attr in self.runtime_expansions}
713
1196
try:
714
1197
command = self.checker_command % escaped_attrs
715
1198
except TypeError as error:
716
logger.error('Could not format string "%s"',
717
self.checker_command, exc_info=error)
718
return True # Try again later
1199
log.error('Could not format string "%s"',
1200
self.checker_command, exc_info=error)
1201
return True # Try again later
719
1202
self.current_checker_command = command
720
try:
721
logger.info("Starting checker %r for %s",
722
command, self.name)
723
# We don't need to redirect stdout and stderr, since
724
# in normal mode, that is already done by daemon(),
725
# and in debug mode we don't want to. (Stdin is
726
# always replaced by /dev/null.)
727
# The exception is when not debugging but nevertheless
728
# running in the foreground; use the previously
729
# created wnull.
730
popen_args = {}
731
if (not self.server_settings["debug"]
732
and self.server_settings["foreground"]):
733
popen_args.update({"stdout": wnull,
734
"stderr": wnull })
735
self.checker = subprocess.Popen(command,
736
close_fds=True,
737
shell=True, cwd="/",
738
**popen_args)
739
except OSError as error:
740
logger.error("Failed to start subprocess",
741
exc_info=error)
742
return True
743
self.checker_callback_tag = (gobject.child_watch_add
744
(self.checker.pid,
745
self.checker_callback,
746
data=command))
747
# The checker may have completed before the gobject
748
# watch was added. Check for this.
749
try:
750
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
751
except OSError as error:
752
if error.errno == errno.ECHILD:
753
# This should never happen
754
logger.error("Child process vanished",
755
exc_info=error)
756
return True
757
raise
758
if pid:
759
gobject.source_remove(self.checker_callback_tag)
760
self.checker_callback(pid, status, command)
761
# Re-run this periodically if run by gobject.timeout_add
1203
log.info("Starting checker %r for %s", command, self.name)
1204
# We don't need to redirect stdout and stderr, since
1205
# in normal mode, that is already done by daemon(),
1206
# and in debug mode we don't want to. (Stdin is
1207
# always replaced by /dev/null.)
1208
# The exception is when not debugging but nevertheless
1209
# running in the foreground; use the previously
1210
# created wnull.
1211
popen_args = {"close_fds": True,
1212
"shell": True,
1213
"cwd": "/"}
1214
if (not self.server_settings["debug"]
1215
and self.server_settings["foreground"]):
1216
popen_args.update({"stdout": wnull,
1217
"stderr": wnull})
1218
pipe = multiprocessing.Pipe(duplex=False)
1219
self.checker = multiprocessing.Process(
1220
target=call_pipe,
1221
args=(pipe[1], subprocess.call, command),
1222
kwargs=popen_args)
1223
self.checker.start()
1224
self.checker_callback_tag = GLib.io_add_watch(
1225
GLib.IOChannel.unix_new(pipe[0].fileno()),
1226
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
1227
self.checker_callback, pipe[0], command)
1228
if start_was_randomized:
1229
# We were started after a random delay; Schedule a new
1230
# checker to be started an 'interval' from now, and every
1231
# interval from then on.
1232
now = datetime.datetime.utcnow()
1233
self.checker_initiator_tag = GLib.timeout_add(
1234
int(self.interval.total_seconds() * 1000),
1235
self.start_checker)
1236
self.expires = max(self.expires, now + self.interval)
1237
# Don't start a new checker again after same random delay
1238
return False
1239
# Re-run this periodically if run by GLib.timeout_add
762
1240
return True
763
1241
764
1242
def stop_checker(self):
765
1243
"""Force the checker process, if any, to stop."""
766
1244
if self.checker_callback_tag:
767
gobject.source_remove(self.checker_callback_tag)
1245
GLib.source_remove(self.checker_callback_tag)
768
1246
self.checker_callback_tag = None
769
1247
if getattr(self, "checker", None) is None:
770
1248
return
771
logger.debug("Stopping checker for %(name)s", vars(self))
772
try:
773
self.checker.terminate()
774
#time.sleep(0.5)
775
#if self.checker.poll() is None:
776
# self.checker.kill()
777
except OSError as error:
778
if error.errno != errno.ESRCH: # No such process
779
raise
1249
log.debug("Stopping checker for %(name)s", vars(self))
1250
self.checker.terminate()
780
1251
self.checker = None
781
1252
782
1253
783
def dbus_service_property(dbus_interface, signature="v",
784
access="readwrite", byte_arrays=False):
1254
def dbus_service_property(dbus_interface,
1255
signature="v",
1256
access="readwrite",
1257
byte_arrays=False):
785
1258
"""Decorators for marking methods of a DBusObjectWithProperties to
786
1259
become properties on the D-Bus.
787
1260
788
1261
The decorated method will be called with no arguments by "Get"
789
1262
and with one argument by "Set".
790
1263
791
1264
The parameters, where they are supported, are the same as
792
1265
dbus.service.method, except there is only "signature", since the
793
1266
type from Get() and the type sent to Set() is the same.
796
1269
# "Set" method, so we fail early here:
797
1270
if byte_arrays and signature != "ay":
798
1271
raise ValueError("Byte arrays not supported for non-'ay'"
799
" signature {0!r}".format(signature))
1272
" signature {!r}".format(signature))
1273
800
1274
def decorator(func):
801
1275
func._dbus_is_property = True
802
1276
func._dbus_interface = dbus_interface
805
1279
func._dbus_name = func.__name__
806
1280
if func._dbus_name.endswith("_dbus_property"):
807
1281
func._dbus_name = func._dbus_name[:-14]
808
func._dbus_get_args_options = {'byte_arrays': byte_arrays }
1282
func._dbus_get_args_options = {"byte_arrays": byte_arrays}
809
1283
return func
1284
810
1285
return decorator
811
1286
812
1287
813
1288
def dbus_interface_annotations(dbus_interface):
814
1289
"""Decorator for marking functions returning interface annotations
815
1290
816
1291
Usage:
817
1292
818
1293
@dbus_interface_annotations("org.example.Interface")
819
1294
def _foo(self): # Function name does not matter
820
1295
return {"org.freedesktop.DBus.Deprecated": "true",
821
1296
"org.freedesktop.DBus.Property.EmitsChangedSignal":
822
1297
"false"}
823
1298
"""
1299
824
1300
def decorator(func):
825
1301
func._dbus_is_interface = True
826
1302
func._dbus_interface = dbus_interface
827
1303
func._dbus_name = dbus_interface
828
1304
return func
1305
829
1306
return decorator
830
1307
831
1308
832
1309
def dbus_annotations(annotations):
833
1310
"""Decorator to annotate D-Bus methods, signals or properties
834
1311
Usage:
835
1312
1313
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
1314
"org.freedesktop.DBus.Property."
1315
"EmitsChangedSignal": "false"})
836
1316
@dbus_service_property("org.example.Interface", signature="b",
837
1317
access="r")
838
@dbus_annotations({{"org.freedesktop.DBus.Deprecated": "true",
839
"org.freedesktop.DBus.Property."
840
"EmitsChangedSignal": "false"})
841
1318
def Property_dbus_property(self):
842
1319
return dbus.Boolean(False)
1320
1321
See also the DBusObjectWithAnnotations class.
843
1322
"""
1323
844
1324
def decorator(func):
845
1325
func._dbus_annotations = annotations
846
1326
return func
1327
847
1328
return decorator
848
1329
849
1330
850
1331
class DBusPropertyException(dbus.exceptions.DBusException):
851
1332
"""A base class for D-Bus property-related exceptions
852
1333
"""
853
def __unicode__(self):
854
return unicode(str(self))
1334
pass
855
1335
856
1336
857
1337
class DBusPropertyAccessException(DBusPropertyException):
866
1346
pass
867
1347
868
1348
869
class DBusObjectWithProperties(dbus.service.Object):
870
"""A D-Bus object with properties.
871
872
Classes inheriting from this can use the dbus_service_property
873
decorator to expose methods as D-Bus properties. It exposes the
874
standard Get(), Set(), and GetAll() methods on the D-Bus.
1349
class DBusObjectWithAnnotations(dbus.service.Object):
1350
"""A D-Bus object with annotations.
1351
1352
Classes inheriting from this can use the dbus_annotations
1353
decorator to add annotations to methods or signals.
875
1354
"""
876
1355
877
1356
@staticmethod
878
1357
def _is_dbus_thing(thing):
879
1358
"""Returns a function testing if an attribute is a D-Bus thing
880
1359
881
1360
If called like _is_dbus_thing("method") it returns a function
882
1361
suitable for use as predicate to inspect.getmembers().
883
1362
"""
884
return lambda obj: getattr(obj, "_dbus_is_{0}".format(thing),
1363
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
885
1364
False)
886
1365
887
1366
def _get_all_dbus_things(self, thing):
888
1367
"""Returns a generator of (name, attribute) pairs
889
1368
"""
890
return ((getattr(athing.__get__(self), "_dbus_name",
891
name),
1369
return ((getattr(athing.__get__(self), "_dbus_name", name),
892
1370
athing.__get__(self))
893
1371
for cls in self.__class__.__mro__
894
1372
for name, athing in
895
inspect.getmembers(cls,
896
self._is_dbus_thing(thing)))
897
1373
inspect.getmembers(cls, self._is_dbus_thing(thing)))
1374
1375
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1376
out_signature="s",
1377
path_keyword="object_path",
1378
connection_keyword="connection")
1379
def Introspect(self, object_path, connection):
1380
"""Overloading of standard D-Bus method.
1381
1382
Inserts annotation tags on methods and signals.
1383
"""
1384
xmlstring = dbus.service.Object.Introspect(self, object_path,
1385
connection)
1386
try:
1387
document = xml.dom.minidom.parseString(xmlstring)
1388
1389
for if_tag in document.getElementsByTagName("interface"):
1390
# Add annotation tags
1391
for typ in ("method", "signal"):
1392
for tag in if_tag.getElementsByTagName(typ):
1393
annots = dict()
1394
for name, prop in (self.
1395
_get_all_dbus_things(typ)):
1396
if (name == tag.getAttribute("name")
1397
and prop._dbus_interface
1398
== if_tag.getAttribute("name")):
1399
annots.update(getattr(
1400
prop, "_dbus_annotations", {}))
1401
for name, value in annots.items():
1402
ann_tag = document.createElement(
1403
"annotation")
1404
ann_tag.setAttribute("name", name)
1405
ann_tag.setAttribute("value", value)
1406
tag.appendChild(ann_tag)
1407
# Add interface annotation tags
1408
for annotation, value in dict(
1409
itertools.chain.from_iterable(
1410
annotations().items()
1411
for name, annotations
1412
in self._get_all_dbus_things("interface")
1413
if name == if_tag.getAttribute("name")
1414
)).items():
1415
ann_tag = document.createElement("annotation")
1416
ann_tag.setAttribute("name", annotation)
1417
ann_tag.setAttribute("value", value)
1418
if_tag.appendChild(ann_tag)
1419
# Fix argument name for the Introspect method itself
1420
if (if_tag.getAttribute("name")
1421
== dbus.INTROSPECTABLE_IFACE):
1422
for cn in if_tag.getElementsByTagName("method"):
1423
if cn.getAttribute("name") == "Introspect":
1424
for arg in cn.getElementsByTagName("arg"):
1425
if (arg.getAttribute("direction")
1426
== "out"):
1427
arg.setAttribute("name",
1428
"xml_data")
1429
xmlstring = document.toxml("utf-8")
1430
document.unlink()
1431
except (AttributeError, xml.dom.DOMException,
1432
xml.parsers.expat.ExpatError) as error:
1433
log.error("Failed to override Introspection method",
1434
exc_info=error)
1435
return xmlstring
1436
1437
1438
class DBusObjectWithProperties(DBusObjectWithAnnotations):
1439
"""A D-Bus object with properties.
1440
1441
Classes inheriting from this can use the dbus_service_property
1442
decorator to expose methods as D-Bus properties. It exposes the
1443
standard Get(), Set(), and GetAll() methods on the D-Bus.
1444
"""
1445
898
1446
def _get_dbus_property(self, interface_name, property_name):
899
1447
"""Returns a bound method if one exists which is a D-Bus
900
1448
property with the specified name and interface.
901
1449
"""
902
for cls in self.__class__.__mro__:
903
for name, value in (inspect.getmembers
904
(cls,
905
self._is_dbus_thing("property"))):
1450
for cls in self.__class__.__mro__:
1451
for name, value in inspect.getmembers(
1452
cls, self._is_dbus_thing("property")):
906
1453
if (value._dbus_name == property_name
907
1454
and value._dbus_interface == interface_name):
908
1455
return value.__get__(self)
909
1456
910
1457
# No such property
911
raise DBusPropertyNotFound(self.dbus_object_path + ":"
912
+ interface_name + "."
913
+ property_name)
914
915
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
1458
raise DBusPropertyNotFound("{}:{}.{}".format(
1459
self.dbus_object_path, interface_name, property_name))
1460
1461
@classmethod
1462
def _get_all_interface_names(cls):
1463
"""Get a sequence of all interfaces supported by an object"""
1464
return (name for name in set(getattr(getattr(x, attr),
1465
"_dbus_interface", None)
1466
for x in (inspect.getmro(cls))
1467
for attr in dir(x))
1468
if name is not None)
1469
1470
@dbus.service.method(dbus.PROPERTIES_IFACE,
1471
in_signature="ss",
916
1472
out_signature="v")
917
1473
def Get(self, interface_name, property_name):
918
1474
"""Standard D-Bus property Get() method, see D-Bus standard.
924
1480
if not hasattr(value, "variant_level"):
925
1481
return value
926
1482
return type(value)(value, variant_level=value.variant_level+1)
927
1483
928
1484
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
929
1485
def Set(self, interface_name, property_name, value):
930
1486
"""Standard D-Bus property Set() method, see D-Bus standard.
937
1493
# signatures other than "ay".
938
1494
if prop._dbus_signature != "ay":
939
1495
raise ValueError("Byte arrays not supported for non-"
940
"'ay' signature {0!r}"
1496
"'ay' signature {!r}"
941
1497
.format(prop._dbus_signature))
942
value = dbus.ByteArray(b''.join(chr(byte)
943
for byte in value))
1498
value = dbus.ByteArray(bytes(value))
944
1499
prop(value)
945
946
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
1500
1501
@dbus.service.method(dbus.PROPERTIES_IFACE,
1502
in_signature="s",
947
1503
out_signature="a{sv}")
948
1504
def GetAll(self, interface_name):
949
1505
"""Standard D-Bus property GetAll() method, see D-Bus
950
1506
standard.
951
1507
952
1508
Note: Will not include properties with access="write".
953
1509
"""
954
1510
properties = {}
964
1520
if not hasattr(value, "variant_level"):
965
1521
properties[name] = value
966
1522
continue
967
properties[name] = type(value)(value, variant_level=
968
value.variant_level+1)
1523
properties[name] = type(value)(
1524
value, variant_level=value.variant_level + 1)
969
1525
return dbus.Dictionary(properties, signature="sv")
970
1526
1527
@dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
1528
def PropertiesChanged(self, interface_name, changed_properties,
1529
invalidated_properties):
1530
"""Standard D-Bus PropertiesChanged() signal, see D-Bus
1531
standard.
1532
"""
1533
pass
1534
971
1535
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
972
1536
out_signature="s",
973
path_keyword='object_path',
974
connection_keyword='connection')
1537
path_keyword="object_path",
1538
connection_keyword="connection")
975
1539
def Introspect(self, object_path, connection):
976
1540
"""Overloading of standard D-Bus method.
977
1541
978
1542
Inserts property tags and interface annotation tags.
979
1543
"""
980
xmlstring = dbus.service.Object.Introspect(self, object_path,
981
connection)
1544
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1545
object_path,
1546
connection)
982
1547
try:
983
1548
document = xml.dom.minidom.parseString(xmlstring)
1549
984
1550
def make_tag(document, name, prop):
985
1551
e = document.createElement("property")
986
1552
e.setAttribute("name", name)
987
1553
e.setAttribute("type", prop._dbus_signature)
988
1554
e.setAttribute("access", prop._dbus_access)
989
1555
return e
1556
990
1557
for if_tag in document.getElementsByTagName("interface"):
991
1558
# Add property tags
992
1559
for tag in (make_tag(document, name, prop)
995
1562
if prop._dbus_interface
996
1563
== if_tag.getAttribute("name")):
997
1564
if_tag.appendChild(tag)
998
# Add annotation tags
999
for typ in ("method", "signal", "property"):
1000
for tag in if_tag.getElementsByTagName(typ):
1001
annots = dict()
1002
for name, prop in (self.
1003
_get_all_dbus_things(typ)):
1004
if (name == tag.getAttribute("name")
1005
and prop._dbus_interface
1006
== if_tag.getAttribute("name")):
1007
annots.update(getattr
1008
(prop,
1009
"_dbus_annotations",
1010
{}))
1011
for name, value in annots.iteritems():
1012
ann_tag = document.createElement(
1013
"annotation")
1014
ann_tag.setAttribute("name", name)
1015
ann_tag.setAttribute("value", value)
1016
tag.appendChild(ann_tag)
1017
# Add interface annotation tags
1018
for annotation, value in dict(
1019
itertools.chain.from_iterable(
1020
annotations().iteritems()
1021
for name, annotations in
1022
self._get_all_dbus_things("interface")
1023
if name == if_tag.getAttribute("name")
1024
)).iteritems():
1025
ann_tag = document.createElement("annotation")
1026
ann_tag.setAttribute("name", annotation)
1027
ann_tag.setAttribute("value", value)
1028
if_tag.appendChild(ann_tag)
1565
# Add annotation tags for properties
1566
for tag in if_tag.getElementsByTagName("property"):
1567
annots = dict()
1568
for name, prop in self._get_all_dbus_things(
1569
"property"):
1570
if (name == tag.getAttribute("name")
1571
and prop._dbus_interface
1572
== if_tag.getAttribute("name")):
1573
annots.update(getattr(
1574
prop, "_dbus_annotations", {}))
1575
for name, value in annots.items():
1576
ann_tag = document.createElement(
1577
"annotation")
1578
ann_tag.setAttribute("name", name)
1579
ann_tag.setAttribute("value", value)
1580
tag.appendChild(ann_tag)
1029
1581
# Add the names to the return values for the
1030
1582
# "org.freedesktop.DBus.Properties" methods
1031
1583
if (if_tag.getAttribute("name")
1045
1597
document.unlink()
1046
1598
except (AttributeError, xml.dom.DOMException,
1047
1599
xml.parsers.expat.ExpatError) as error:
1048
logger.error("Failed to override Introspection method",
1049
exc_info=error)
1600
log.error("Failed to override Introspection method",
1601
exc_info=error)
1602
return xmlstring
1603
1604
1605
try:
1606
dbus.OBJECT_MANAGER_IFACE
1607
except AttributeError:
1608
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1609
1610
1611
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1612
"""A D-Bus object with an ObjectManager.
1613
1614
Classes inheriting from this exposes the standard
1615
GetManagedObjects call and the InterfacesAdded and
1616
InterfacesRemoved signals on the standard
1617
"org.freedesktop.DBus.ObjectManager" interface.
1618
1619
Note: No signals are sent automatically; they must be sent
1620
manually.
1621
"""
1622
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1623
out_signature="a{oa{sa{sv}}}")
1624
def GetManagedObjects(self):
1625
"""This function must be overridden"""
1626
raise NotImplementedError()
1627
1628
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1629
signature="oa{sa{sv}}")
1630
def InterfacesAdded(self, object_path, interfaces_and_properties):
1631
pass
1632
1633
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature="oas")
1634
def InterfacesRemoved(self, object_path, interfaces):
1635
pass
1636
1637
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1638
out_signature="s",
1639
path_keyword="object_path",
1640
connection_keyword="connection")
1641
def Introspect(self, object_path, connection):
1642
"""Overloading of standard D-Bus method.
1643
1644
Override return argument name of GetManagedObjects to be
1645
"objpath_interfaces_and_properties"
1646
"""
1647
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1648
object_path,
1649
connection)
1650
try:
1651
document = xml.dom.minidom.parseString(xmlstring)
1652
1653
for if_tag in document.getElementsByTagName("interface"):
1654
# Fix argument name for the GetManagedObjects method
1655
if (if_tag.getAttribute("name")
1656
== dbus.OBJECT_MANAGER_IFACE):
1657
for cn in if_tag.getElementsByTagName("method"):
1658
if (cn.getAttribute("name")
1659
== "GetManagedObjects"):
1660
for arg in cn.getElementsByTagName("arg"):
1661
if (arg.getAttribute("direction")
1662
== "out"):
1663
arg.setAttribute(
1664
"name",
1665
"objpath_interfaces"
1666
"_and_properties")
1667
xmlstring = document.toxml("utf-8")
1668
document.unlink()
1669
except (AttributeError, xml.dom.DOMException,
1670
xml.parsers.expat.ExpatError) as error:
1671
log.error("Failed to override Introspection method",
1672
exc_info=error)
1050
1673
return xmlstring
1051
1674
1052
1675
1053
1676
def datetime_to_dbus(dt, variant_level=0):
1054
1677
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1055
1678
if dt is None:
1056
return dbus.String("", variant_level = variant_level)
1057
return dbus.String(dt.isoformat(),
1058
variant_level=variant_level)
1679
return dbus.String("", variant_level=variant_level)
1680
return dbus.String(dt.isoformat(), variant_level=variant_level)
1059
1681
1060
1682
1061
1683
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1063
1685
dbus.service.Object, it will add alternate D-Bus attributes with
1064
1686
interface names according to the "alt_interface_names" mapping.
1065
1687
Usage:
1066
1688
1067
1689
@alternate_dbus_interfaces({"org.example.Interface":
1068
1690
"net.example.AlternateInterface"})
1069
1691
class SampleDBusObject(dbus.service.Object):
1070
1692
@dbus.service.method("org.example.Interface")
1071
1693
def SampleDBusMethod():
1072
1694
pass
1073
1695
1074
1696
The above "SampleDBusMethod" on "SampleDBusObject" will be
1075
1697
reachable via two interfaces: "org.example.Interface" and
1076
1698
"net.example.AlternateInterface", the latter of which will have
1077
1699
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1078
1700
"true", unless "deprecate" is passed with a False value.
1079
1701
1080
1702
This works for methods and signals, and also for D-Bus properties
1081
1703
(from DBusObjectWithProperties) and interfaces (from the
1082
1704
dbus_interface_annotations decorator).
1083
1705
"""
1706
1084
1707
def wrapper(cls):
1085
1708
for orig_interface_name, alt_interface_name in (
1086
alt_interface_names.iteritems()):
1709
alt_interface_names.items()):
1087
1710
attr = {}
1088
1711
interface_names = set()
1089
1712
# Go though all attributes of the class
1091
1714
# Ignore non-D-Bus attributes, and D-Bus attributes
1092
1715
# with the wrong interface name
1093
1716
if (not hasattr(attribute, "_dbus_interface")
1094
or not attribute._dbus_interface
1095
.startswith(orig_interface_name)):
1717
or not attribute._dbus_interface.startswith(
1718
orig_interface_name)):
1096
1719
continue
1097
1720
# Create an alternate D-Bus interface name based on
1098
1721
# the current name
1099
alt_interface = (attribute._dbus_interface
1100
.replace(orig_interface_name,
1101
alt_interface_name))
1722
alt_interface = attribute._dbus_interface.replace(
1723
orig_interface_name, alt_interface_name)
1102
1724
interface_names.add(alt_interface)
1103
1725
# Is this a D-Bus signal?
1104
1726
if getattr(attribute, "_dbus_is_signal", False):
1105
1727
# Extract the original non-method undecorated
1106
1728
# function by black magic
1107
nonmethod_func = (dict(
1729
if sys.version_info.major == 2:
1730
nonmethod_func = (dict(
1108
1731
zip(attribute.func_code.co_freevars,
1109
attribute.__closure__))["func"]
1110
.cell_contents)
1732
attribute.__closure__))
1733
["func"].cell_contents)
1734
else:
1735
nonmethod_func = (dict(
1736
zip(attribute.__code__.co_freevars,
1737
attribute.__closure__))
1738
["func"].cell_contents)
1111
1739
# Create a new, but exactly alike, function
1112
1740
# object, and decorate it to be a new D-Bus signal
1113
1741
# with the alternate D-Bus interface name
1114
new_function = (dbus.service.signal
1115
(alt_interface,
1116
attribute._dbus_signature)
1117
(types.FunctionType(
1118
nonmethod_func.func_code,
1119
nonmethod_func.func_globals,
1120
nonmethod_func.func_name,
1121
nonmethod_func.func_defaults,
1122
nonmethod_func.func_closure)))
1742
new_function = copy_function(nonmethod_func)
1743
new_function = (dbus.service.signal(
1744
alt_interface,
1745
attribute._dbus_signature)(new_function))
1123
1746
# Copy annotations, if any
1124
1747
try:
1125
new_function._dbus_annotations = (
1126
dict(attribute._dbus_annotations))
1748
new_function._dbus_annotations = dict(
1749
attribute._dbus_annotations)
1127
1750
except AttributeError:
1128
1751
pass
1752
1129
1753
# Define a creator of a function to call both the
1130
1754
# original and alternate functions, so both the
1131
1755
# original and alternate signals gets sent when
1134
1758
"""This function is a scope container to pass
1135
1759
func1 and func2 to the "call_both" function
1136
1760
outside of its arguments"""
1761
1762
@functools.wraps(func2)
1137
1763
def call_both(*args, **kwargs):
1138
1764
"""This function will emit two D-Bus
1139
1765
signals by calling func1 and func2"""
1140
1766
func1(*args, **kwargs)
1141
1767
func2(*args, **kwargs)
1768
# Make wrapper function look like a D-Bus
1769
# signal
1770
for name, attr in inspect.getmembers(func2):
1771
if name.startswith("_dbus_"):
1772
setattr(call_both, name, attr)
1773
1142
1774
return call_both
1143
1775
# Create the "call_both" function and add it to
1144
1776
# the class
1149
1781
# object. Decorate it to be a new D-Bus method
1150
1782
# with the alternate D-Bus interface name. Add it
1151
1783
# to the class.
1152
attr[attrname] = (dbus.service.method
1153
(alt_interface,
1154
attribute._dbus_in_signature,
1155
attribute._dbus_out_signature)
1156
(types.FunctionType
1157
(attribute.func_code,
1158
attribute.func_globals,
1159
attribute.func_name,
1160
attribute.func_defaults,
1161
attribute.func_closure)))
1784
attr[attrname] = (
1785
dbus.service.method(
1786
alt_interface,
1787
attribute._dbus_in_signature,
1788
attribute._dbus_out_signature)
1789
(copy_function(attribute)))
1162
1790
# Copy annotations, if any
1163
1791
try:
1164
attr[attrname]._dbus_annotations = (
1165
dict(attribute._dbus_annotations))
1792
attr[attrname]._dbus_annotations = dict(
1793
attribute._dbus_annotations)
1166
1794
except AttributeError:
1167
1795
pass
1168
1796
# Is this a D-Bus property?
1171
1799
# object, and decorate it to be a new D-Bus
1172
1800
# property with the alternate D-Bus interface
1173
1801
# name. Add it to the class.
1174
attr[attrname] = (dbus_service_property
1175
(alt_interface,
1176
attribute._dbus_signature,
1177
attribute._dbus_access,
1178
attribute
1179
._dbus_get_args_options
1180
["byte_arrays"])
1181
(types.FunctionType
1182
(attribute.func_code,
1183
attribute.func_globals,
1184
attribute.func_name,
1185
attribute.func_defaults,
1186
attribute.func_closure)))
1802
attr[attrname] = (dbus_service_property(
1803
alt_interface, attribute._dbus_signature,
1804
attribute._dbus_access,
1805
attribute._dbus_get_args_options
1806
["byte_arrays"])
1807
(copy_function(attribute)))
1187
1808
# Copy annotations, if any
1188
1809
try:
1189
attr[attrname]._dbus_annotations = (
1190
dict(attribute._dbus_annotations))
1810
attr[attrname]._dbus_annotations = dict(
1811
attribute._dbus_annotations)
1191
1812
except AttributeError:
1192
1813
pass
1193
1814
# Is this a D-Bus interface?
1196
1817
# object. Decorate it to be a new D-Bus interface
1197
1818
# with the alternate D-Bus interface name. Add it
1198
1819
# to the class.
1199
attr[attrname] = (dbus_interface_annotations
1200
(alt_interface)
1201
(types.FunctionType
1202
(attribute.func_code,
1203
attribute.func_globals,
1204
attribute.func_name,
1205
attribute.func_defaults,
1206
attribute.func_closure)))
1820
attr[attrname] = (
1821
dbus_interface_annotations(alt_interface)
1822
(copy_function(attribute)))
1207
1823
if deprecate:
1208
1824
# Deprecate all alternate interfaces
1209
iname="_AlternateDBusNames_interface_annotation{0}"
1825
iname = "_AlternateDBusNames_interface_annotation{}"
1210
1826
for interface_name in interface_names:
1827
1211
1828
@dbus_interface_annotations(interface_name)
1212
1829
def func(self):
1213
return { "org.freedesktop.DBus.Deprecated":
1214
"true" }
1830
return {"org.freedesktop.DBus.Deprecated":
1831
"true"}
1215
1832
# Find an unused name
1216
1833
for aname in (iname.format(i)
1217
1834
for i in itertools.count()):
1221
1838
if interface_names:
1222
1839
# Replace the class with a new subclass of it with
1223
1840
# methods, signals, etc. as created above.
1224
cls = type(b"{0}Alternate".format(cls.__name__),
1225
(cls,), attr)
1841
if sys.version_info.major == 2:
1842
cls = type(b"{}Alternate".format(cls.__name__),
1843
(cls, ), attr)
1844
else:
1845
cls = type("{}Alternate".format(cls.__name__),
1846
(cls, ), attr)
1226
1847
return cls
1848
1227
1849
return wrapper
1228
1850
1229
1851
1230
1852
@alternate_dbus_interfaces({"se.recompile.Mandos":
1231
"se.bsnet.fukt.Mandos"})
1853
"se.bsnet.fukt.Mandos"})
1232
1854
class ClientDBus(Client, DBusObjectWithProperties):
1233
1855
"""A Client class using D-Bus
1234
1856
1235
1857
Attributes:
1236
1858
dbus_object_path: dbus.ObjectPath
1237
1859
bus: dbus.SystemBus()
1238
1860
"""
1239
1861
1240
1862
runtime_expansions = (Client.runtime_expansions
1241
+ ("dbus_object_path",))
1242
1863
+ ("dbus_object_path", ))
1864
1865
_interface = "se.recompile.Mandos.Client"
1866
1243
1867
# dbus.service.Object doesn't use super(), so we can't either.
1244
1245
def __init__(self, bus = None, *args, **kwargs):
1868
1869
def __init__(self, bus=None, *args, **kwargs):
1246
1870
self.bus = bus
1247
1871
Client.__init__(self, *args, **kwargs)
1248
1872
# Only now, when this client is initialized, can it show up on
1249
1873
# the D-Bus
1250
client_object_name = unicode(self.name).translate(
1874
client_object_name = str(self.name).translate(
1251
1875
{ord("."): ord("_"),
1252
1876
ord("-"): ord("_")})
1253
self.dbus_object_path = (dbus.ObjectPath
1254
("/clients/" + client_object_name))
1877
self.dbus_object_path = dbus.ObjectPath(
1878
"/clients/" + client_object_name)
1255
1879
DBusObjectWithProperties.__init__(self, self.bus,
1256
1880
self.dbus_object_path)
1257
1258
def notifychangeproperty(transform_func,
1259
dbus_name, type_func=lambda x: x,
1260
variant_level=1):
1881
1882
def notifychangeproperty(transform_func, dbus_name,
1883
type_func=lambda x: x,
1884
variant_level=1,
1885
invalidate_only=False,
1886
_interface=_interface):
1261
1887
""" Modify a variable so that it's a property which announces
1262
1888
its changes to DBus.
1263
1889
1264
1890
transform_fun: Function that takes a value and a variant_level
1265
1891
and transforms it to a D-Bus type.
1266
1892
dbus_name: D-Bus name of the variable
1268
1894
to the D-Bus. Default: no transform
1269
1895
variant_level: D-Bus variant level. Default: 1
1270
1896
"""
1271
attrname = "_{0}".format(dbus_name)
1897
attrname = "_{}".format(dbus_name)
1898
1272
1899
def setter(self, value):
1273
1900
if hasattr(self, "dbus_object_path"):
1274
1901
if (not hasattr(self, attrname) or
1275
1902
type_func(getattr(self, attrname, None))
1276
1903
!= type_func(value)):
1277
dbus_value = transform_func(type_func(value),
1278
variant_level
1279
=variant_level)
1280
self.PropertyChanged(dbus.String(dbus_name),
1281
dbus_value)
1904
if invalidate_only:
1905
self.PropertiesChanged(
1906
_interface, dbus.Dictionary(),
1907
dbus.Array((dbus_name, )))
1908
else:
1909
dbus_value = transform_func(
1910
type_func(value),
1911
variant_level=variant_level)
1912
self.PropertyChanged(dbus.String(dbus_name),
1913
dbus_value)
1914
self.PropertiesChanged(
1915
_interface,
1916
dbus.Dictionary({dbus.String(dbus_name):
1917
dbus_value}),
1918
dbus.Array())
1282
1919
setattr(self, attrname, value)
1283
1920
1284
1921
return property(lambda self: getattr(self, attrname), setter)
1285
1922
1286
1923
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1287
1924
approvals_pending = notifychangeproperty(dbus.Boolean,
1288
1925
"ApprovalPending",
1289
type_func = bool)
1926
type_func=bool)
1290
1927
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1291
1928
last_enabled = notifychangeproperty(datetime_to_dbus,
1292
1929
"LastEnabled")
1293
checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1294
type_func = lambda checker:
1295
checker is not None)
1930
checker = notifychangeproperty(
1931
dbus.Boolean, "CheckerRunning",
1932
type_func=lambda checker: checker is not None)
1296
1933
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1297
1934
"LastCheckedOK")
1298
1935
last_checker_status = notifychangeproperty(dbus.Int16,
1301
1938
datetime_to_dbus, "LastApprovalRequest")
1302
1939
approved_by_default = notifychangeproperty(dbus.Boolean,
1303
1940
"ApprovedByDefault")
1304
approval_delay = notifychangeproperty(dbus.UInt64,
1305
"ApprovalDelay",
1306
type_func =
1307
timedelta_to_milliseconds)
1941
approval_delay = notifychangeproperty(
1942
dbus.UInt64, "ApprovalDelay",
1943
type_func=lambda td: td.total_seconds() * 1000)
1308
1944
approval_duration = notifychangeproperty(
1309
1945
dbus.UInt64, "ApprovalDuration",
1310
type_func = timedelta_to_milliseconds)
1946
type_func=lambda td: td.total_seconds() * 1000)
1311
1947
host = notifychangeproperty(dbus.String, "Host")
1312
timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1313
type_func =
1314
timedelta_to_milliseconds)
1948
timeout = notifychangeproperty(
1949
dbus.UInt64, "Timeout",
1950
type_func=lambda td: td.total_seconds() * 1000)
1315
1951
extended_timeout = notifychangeproperty(
1316
1952
dbus.UInt64, "ExtendedTimeout",
1317
type_func = timedelta_to_milliseconds)
1318
interval = notifychangeproperty(dbus.UInt64,
1319
"Interval",
1320
type_func =
1321
timedelta_to_milliseconds)
1953
type_func=lambda td: td.total_seconds() * 1000)
1954
interval = notifychangeproperty(
1955
dbus.UInt64, "Interval",
1956
type_func=lambda td: td.total_seconds() * 1000)
1322
1957
checker_command = notifychangeproperty(dbus.String, "Checker")
1323
1958
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1959
invalidate_only=True)
1960
1324
1961
del notifychangeproperty
1325
1962
1326
1963
def __del__(self, *args, **kwargs):
1327
1964
try:
1328
1965
self.remove_from_connection()
1331
1968
if hasattr(DBusObjectWithProperties, "__del__"):
1332
1969
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1333
1970
Client.__del__(self, *args, **kwargs)
1334
1335
def checker_callback(self, pid, condition, command,
1336
*args, **kwargs):
1337
self.checker_callback_tag = None
1338
self.checker = None
1339
if os.WIFEXITED(condition):
1340
exitstatus = os.WEXITSTATUS(condition)
1971
1972
def checker_callback(self, source, condition,
1973
connection, command, *args, **kwargs):
1974
ret = Client.checker_callback(self, source, condition,
1975
connection, command, *args,
1976
**kwargs)
1977
exitstatus = self.last_checker_status
1978
if exitstatus >= 0:
1341
1979
# Emit D-Bus signal
1342
1980
self.CheckerCompleted(dbus.Int16(exitstatus),
1343
dbus.Int64(condition),
1981
# This is specific to GNU libC
1982
dbus.Int64(exitstatus << 8),
1344
1983
dbus.String(command))
1345
1984
else:
1346
1985
# Emit D-Bus signal
1347
1986
self.CheckerCompleted(dbus.Int16(-1),
1348
dbus.Int64(condition),
1987
dbus.Int64(
1988
# This is specific to GNU libC
1989
(exitstatus << 8)
1990
| self.last_checker_signal),
1349
1991
dbus.String(command))
1350
1351
return Client.checker_callback(self, pid, condition, command,
1352
*args, **kwargs)
1353
1992
return ret
1993
1354
1994
def start_checker(self, *args, **kwargs):
1355
1995
old_checker_pid = getattr(self.checker, "pid", None)
1356
1996
r = Client.start_checker(self, *args, **kwargs)
1360
2000
# Emit D-Bus signal
1361
2001
self.CheckerStarted(self.current_checker_command)
1362
2002
return r
1363
2003
1364
2004
def _reset_approved(self):
1365
2005
self.approved = None
1366
2006
return False
1367
2007
1368
2008
def approve(self, value=True):
1369
2009
self.approved = value
1370
gobject.timeout_add(timedelta_to_milliseconds
1371
(self.approval_duration),
1372
self._reset_approved)
2010
GLib.timeout_add(int(self.approval_duration.total_seconds()
2011
* 1000), self._reset_approved)
1373
2012
self.send_changedstate()
1374
1375
## D-Bus methods, signals & properties
1376
_interface = "se.recompile.Mandos.Client"
1377
1378
## Interfaces
1379
1380
@dbus_interface_annotations(_interface)
1381
def _foo(self):
1382
return { "org.freedesktop.DBus.Property.EmitsChangedSignal":
1383
"false"}
1384
1385
## Signals
1386
2013
2014
# D-Bus methods, signals & properties
2015
2016
# Interfaces
2017
2018
# Signals
2019
1387
2020
# CheckerCompleted - signal
1388
2021
@dbus.service.signal(_interface, signature="nxs")
1389
2022
def CheckerCompleted(self, exitcode, waitstatus, command):
1390
2023
"D-Bus signal"
1391
2024
pass
1392
2025
1393
2026
# CheckerStarted - signal
1394
2027
@dbus.service.signal(_interface, signature="s")
1395
2028
def CheckerStarted(self, command):
1396
2029
"D-Bus signal"
1397
2030
pass
1398
2031
1399
2032
# PropertyChanged - signal
2033
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1400
2034
@dbus.service.signal(_interface, signature="sv")
1401
2035
def PropertyChanged(self, property, value):
1402
2036
"D-Bus signal"
1403
2037
pass
1404
2038
1405
2039
# GotSecret - signal
1406
2040
@dbus.service.signal(_interface)
1407
2041
def GotSecret(self):
1410
2044
server to mandos-client
1411
2045
"""
1412
2046
pass
1413
2047
1414
2048
# Rejected - signal
1415
2049
@dbus.service.signal(_interface, signature="s")
1416
2050
def Rejected(self, reason):
1417
2051
"D-Bus signal"
1418
2052
pass
1419
2053
1420
2054
# NeedApproval - signal
1421
2055
@dbus.service.signal(_interface, signature="tb")
1422
2056
def NeedApproval(self, timeout, default):
1423
2057
"D-Bus signal"
1424
2058
return self.need_approval()
1425
1426
## Methods
1427
2059
2060
# Methods
2061
1428
2062
# Approve - method
1429
2063
@dbus.service.method(_interface, in_signature="b")
1430
2064
def Approve(self, value):
1431
2065
self.approve(value)
1432
2066
1433
2067
# CheckedOK - method
1434
2068
@dbus.service.method(_interface)
1435
2069
def CheckedOK(self):
1436
2070
self.checked_ok()
1437
2071
1438
2072
# Enable - method
2073
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1439
2074
@dbus.service.method(_interface)
1440
2075
def Enable(self):
1441
2076
"D-Bus method"
1442
2077
self.enable()
1443
2078
1444
2079
# StartChecker - method
2080
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1445
2081
@dbus.service.method(_interface)
1446
2082
def StartChecker(self):
1447
2083
"D-Bus method"
1448
2084
self.start_checker()
1449
2085
1450
2086
# Disable - method
2087
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1451
2088
@dbus.service.method(_interface)
1452
2089
def Disable(self):
1453
2090
"D-Bus method"
1454
2091
self.disable()
1455
2092
1456
2093
# StopChecker - method
2094
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1457
2095
@dbus.service.method(_interface)
1458
2096
def StopChecker(self):
1459
2097
self.stop_checker()
1460
1461
## Properties
1462
2098
2099
# Properties
2100
1463
2101
# ApprovalPending - property
1464
2102
@dbus_service_property(_interface, signature="b", access="read")
1465
2103
def ApprovalPending_dbus_property(self):
1466
2104
return dbus.Boolean(bool(self.approvals_pending))
1467
2105
1468
2106
# ApprovedByDefault - property
1469
@dbus_service_property(_interface, signature="b",
2107
@dbus_service_property(_interface,
2108
signature="b",
1470
2109
access="readwrite")
1471
2110
def ApprovedByDefault_dbus_property(self, value=None):
1472
2111
if value is None: # get
1473
2112
return dbus.Boolean(self.approved_by_default)
1474
2113
self.approved_by_default = bool(value)
1475
2114
1476
2115
# ApprovalDelay - property
1477
@dbus_service_property(_interface, signature="t",
2116
@dbus_service_property(_interface,
2117
signature="t",
1478
2118
access="readwrite")
1479
2119
def ApprovalDelay_dbus_property(self, value=None):
1480
2120
if value is None: # get
1481
return dbus.UInt64(self.approval_delay_milliseconds())
2121
return dbus.UInt64(self.approval_delay.total_seconds()
2122
* 1000)
1482
2123
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1483
2124
1484
2125
# ApprovalDuration - property
1485
@dbus_service_property(_interface, signature="t",
2126
@dbus_service_property(_interface,
2127
signature="t",
1486
2128
access="readwrite")
1487
2129
def ApprovalDuration_dbus_property(self, value=None):
1488
2130
if value is None: # get
1489
return dbus.UInt64(timedelta_to_milliseconds(
1490
self.approval_duration))
2131
return dbus.UInt64(self.approval_duration.total_seconds()
2132
* 1000)
1491
2133
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1492
2134
1493
2135
# Name - property
2136
@dbus_annotations(
2137
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1494
2138
@dbus_service_property(_interface, signature="s", access="read")
1495
2139
def Name_dbus_property(self):
1496
2140
return dbus.String(self.name)
1497
2141
2142
# KeyID - property
2143
@dbus_annotations(
2144
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2145
@dbus_service_property(_interface, signature="s", access="read")
2146
def KeyID_dbus_property(self):
2147
return dbus.String(self.key_id)
2148
1498
2149
# Fingerprint - property
2150
@dbus_annotations(
2151
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1499
2152
@dbus_service_property(_interface, signature="s", access="read")
1500
2153
def Fingerprint_dbus_property(self):
1501
2154
return dbus.String(self.fingerprint)
1502
2155
1503
2156
# Host - property
1504
@dbus_service_property(_interface, signature="s",
2157
@dbus_service_property(_interface,
2158
signature="s",
1505
2159
access="readwrite")
1506
2160
def Host_dbus_property(self, value=None):
1507
2161
if value is None: # get
1508
2162
return dbus.String(self.host)
1509
self.host = unicode(value)
1510
2163
self.host = str(value)
2164
1511
2165
# Created - property
2166
@dbus_annotations(
2167
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1512
2168
@dbus_service_property(_interface, signature="s", access="read")
1513
2169
def Created_dbus_property(self):
1514
2170
return datetime_to_dbus(self.created)
1515
2171
1516
2172
# LastEnabled - property
1517
2173
@dbus_service_property(_interface, signature="s", access="read")
1518
2174
def LastEnabled_dbus_property(self):
1519
2175
return datetime_to_dbus(self.last_enabled)
1520
2176
1521
2177
# Enabled - property
1522
@dbus_service_property(_interface, signature="b",
2178
@dbus_service_property(_interface,
2179
signature="b",
1523
2180
access="readwrite")
1524
2181
def Enabled_dbus_property(self, value=None):
1525
2182
if value is None: # get
1528
2185
self.enable()
1529
2186
else:
1530
2187
self.disable()
1531
2188
1532
2189
# LastCheckedOK - property
1533
@dbus_service_property(_interface, signature="s",
2190
@dbus_service_property(_interface,
2191
signature="s",
1534
2192
access="readwrite")
1535
2193
def LastCheckedOK_dbus_property(self, value=None):
1536
2194
if value is not None:
1537
2195
self.checked_ok()
1538
2196
return
1539
2197
return datetime_to_dbus(self.last_checked_ok)
1540
2198
1541
2199
# LastCheckerStatus - property
1542
@dbus_service_property(_interface, signature="n",
1543
access="read")
2200
@dbus_service_property(_interface, signature="n", access="read")
1544
2201
def LastCheckerStatus_dbus_property(self):
1545
2202
return dbus.Int16(self.last_checker_status)
1546
2203
1547
2204
# Expires - property
1548
2205
@dbus_service_property(_interface, signature="s", access="read")
1549
2206
def Expires_dbus_property(self):
1550
2207
return datetime_to_dbus(self.expires)
1551
2208
1552
2209
# LastApprovalRequest - property
1553
2210
@dbus_service_property(_interface, signature="s", access="read")
1554
2211
def LastApprovalRequest_dbus_property(self):
1555
2212
return datetime_to_dbus(self.last_approval_request)
1556
2213
1557
2214
# Timeout - property
1558
@dbus_service_property(_interface, signature="t",
2215
@dbus_service_property(_interface,
2216
signature="t",
1559
2217
access="readwrite")
1560
2218
def Timeout_dbus_property(self, value=None):
1561
2219
if value is None: # get
1562
return dbus.UInt64(self.timeout_milliseconds())
2220
return dbus.UInt64(self.timeout.total_seconds() * 1000)
1563
2221
old_timeout = self.timeout
1564
2222
self.timeout = datetime.timedelta(0, 0, 0, value)
1565
2223
# Reschedule disabling
1573
2231
if (getattr(self, "disable_initiator_tag", None)
1574
2232
is None):
1575
2233
return
1576
gobject.source_remove(self.disable_initiator_tag)
1577
self.disable_initiator_tag = (
1578
gobject.timeout_add(
1579
timedelta_to_milliseconds(self.expires - now),
1580
self.disable))
1581
2234
GLib.source_remove(self.disable_initiator_tag)
2235
self.disable_initiator_tag = GLib.timeout_add(
2236
int((self.expires - now).total_seconds() * 1000),
2237
self.disable)
2238
1582
2239
# ExtendedTimeout - property
1583
@dbus_service_property(_interface, signature="t",
2240
@dbus_service_property(_interface,
2241
signature="t",
1584
2242
access="readwrite")
1585
2243
def ExtendedTimeout_dbus_property(self, value=None):
1586
2244
if value is None: # get
1587
return dbus.UInt64(self.extended_timeout_milliseconds())
2245
return dbus.UInt64(self.extended_timeout.total_seconds()
2246
* 1000)
1588
2247
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1589
2248
1590
2249
# Interval - property
1591
@dbus_service_property(_interface, signature="t",
2250
@dbus_service_property(_interface,
2251
signature="t",
1592
2252
access="readwrite")
1593
2253
def Interval_dbus_property(self, value=None):
1594
2254
if value is None: # get
1595
return dbus.UInt64(self.interval_milliseconds())
2255
return dbus.UInt64(self.interval.total_seconds() * 1000)
1596
2256
self.interval = datetime.timedelta(0, 0, 0, value)
1597
2257
if getattr(self, "checker_initiator_tag", None) is None:
1598
2258
return
1599
2259
if self.enabled:
1600
2260
# Reschedule checker run
1601
gobject.source_remove(self.checker_initiator_tag)
1602
self.checker_initiator_tag = (gobject.timeout_add
1603
(value, self.start_checker))
1604
self.start_checker() # Start one now, too
1605
2261
GLib.source_remove(self.checker_initiator_tag)
2262
self.checker_initiator_tag = GLib.timeout_add(
2263
value, self.start_checker)
2264
self.start_checker() # Start one now, too
2265
1606
2266
# Checker - property
1607
@dbus_service_property(_interface, signature="s",
2267
@dbus_service_property(_interface,
2268
signature="s",
1608
2269
access="readwrite")
1609
2270
def Checker_dbus_property(self, value=None):
1610
2271
if value is None: # get
1611
2272
return dbus.String(self.checker_command)
1612
self.checker_command = unicode(value)
1613
2273
self.checker_command = str(value)
2274
1614
2275
# CheckerRunning - property
1615
@dbus_service_property(_interface, signature="b",
2276
@dbus_service_property(_interface,
2277
signature="b",
1616
2278
access="readwrite")
1617
2279
def CheckerRunning_dbus_property(self, value=None):
1618
2280
if value is None: # get
1621
2283
self.start_checker()
1622
2284
else:
1623
2285
self.stop_checker()
1624
2286
1625
2287
# ObjectPath - property
2288
@dbus_annotations(
2289
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
2290
"org.freedesktop.DBus.Deprecated": "true"})
1626
2291
@dbus_service_property(_interface, signature="o", access="read")
1627
2292
def ObjectPath_dbus_property(self):
1628
return self.dbus_object_path # is already a dbus.ObjectPath
1629
2293
return self.dbus_object_path # is already a dbus.ObjectPath
2294
1630
2295
# Secret = property
1631
@dbus_service_property(_interface, signature="ay",
1632
access="write", byte_arrays=True)
2296
@dbus_annotations(
2297
{"org.freedesktop.DBus.Property.EmitsChangedSignal":
2298
"invalidates"})
2299
@dbus_service_property(_interface,
2300
signature="ay",
2301
access="write",
2302
byte_arrays=True)
1633
2303
def Secret_dbus_property(self, value):
1634
self.secret = str(value)
1635
2304
self.secret = bytes(value)
2305
1636
2306
del _interface
1637
2307
1638
2308
1639
class ProxyClient(object):
1640
def __init__(self, child_pipe, fpr, address):
2309
class ProxyClient:
2310
def __init__(self, child_pipe, key_id, fpr, address):
1641
2311
self._pipe = child_pipe
1642
self._pipe.send(('init', fpr, address))
2312
self._pipe.send(("init", key_id, fpr, address))
1643
2313
if not self._pipe.recv():
1644
raise KeyError()
1645
2314
raise KeyError(key_id or fpr)
2315
1646
2316
def __getattribute__(self, name):
1647
if name == '_pipe':
2317
if name == "_pipe":
1648
2318
return super(ProxyClient, self).__getattribute__(name)
1649
self._pipe.send(('getattr', name))
2319
self._pipe.send(("getattr", name))
1650
2320
data = self._pipe.recv()
1651
if data[0] == 'data':
2321
if data[0] == "data":
1652
2322
return data[1]
1653
if data[0] == 'function':
2323
if data[0] == "function":
2324
1654
2325
def func(*args, **kwargs):
1655
self._pipe.send(('funcall', name, args, kwargs))
2326
self._pipe.send(("funcall", name, args, kwargs))
1656
2327
return self._pipe.recv()[1]
2328
1657
2329
return func
1658
2330
1659
2331
def __setattr__(self, name, value):
1660
if name == '_pipe':
2332
if name == "_pipe":
1661
2333
return super(ProxyClient, self).__setattr__(name, value)
1662
self._pipe.send(('setattr', name, value))
2334
self._pipe.send(("setattr", name, value))
1663
2335
1664
2336
1665
2337
class ClientHandler(socketserver.BaseRequestHandler, object):
1666
2338
"""A class to handle client connections.
1667
2339
1668
2340
Instantiated once for each connection to handle it.
1669
2341
Note: This will run in its own forked process."""
1670
2342
1671
2343
def handle(self):
1672
2344
with contextlib.closing(self.server.child_pipe) as child_pipe:
1673
logger.info("TCP connection from: %s",
1674
unicode(self.client_address))
1675
logger.debug("Pipe FD: %d",
1676
self.server.child_pipe.fileno())
1677
1678
session = (gnutls.connection
1679
.ClientSession(self.request,
1680
gnutls.connection
1681
.X509Credentials()))
1682
1683
# Note: gnutls.connection.X509Credentials is really a
1684
# generic GnuTLS certificate credentials object so long as
1685
# no X.509 keys are added to it. Therefore, we can use it
1686
# here despite using OpenPGP certificates.
1687
1688
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1689
# "+AES-256-CBC", "+SHA1",
1690
# "+COMP-NULL", "+CTYPE-OPENPGP",
1691
# "+DHE-DSS"))
2345
log.info("TCP connection from: %s",
2346
str(self.client_address))
2347
log.debug("Pipe FD: %d", self.server.child_pipe.fileno())
2348
2349
session = gnutls.ClientSession(self.request)
2350
2351
# priority = ":".join(("NONE", "+VERS-TLS1.1",
2352
# "+AES-256-CBC", "+SHA1",
2353
# "+COMP-NULL", "+CTYPE-OPENPGP",
2354
# "+DHE-DSS"))
1692
2355
# Use a fallback default, since this MUST be set.
1693
2356
priority = self.server.gnutls_priority
1694
2357
if priority is None:
1695
2358
priority = "NORMAL"
1696
(gnutls.library.functions
1697
.gnutls_priority_set_direct(session._c_object,
1698
priority, None))
1699
2359
gnutls.priority_set_direct(session,
2360
priority.encode("utf-8"), None)
2361
1700
2362
# Start communication using the Mandos protocol
1701
2363
# Get protocol number
1702
2364
line = self.request.makefile().readline()
1703
logger.debug("Protocol version: %r", line)
2365
log.debug("Protocol version: %r", line)
1704
2366
try:
1705
2367
if int(line.strip().split()[0]) > 1:
1706
2368
raise RuntimeError(line)
1707
2369
except (ValueError, IndexError, RuntimeError) as error:
1708
logger.error("Unknown protocol version: %s", error)
2370
log.error("Unknown protocol version: %s", error)
1709
2371
return
1710
2372
1711
2373
# Start GnuTLS connection
1712
2374
try:
1713
2375
session.handshake()
1714
except gnutls.errors.GNUTLSError as error:
1715
logger.warning("Handshake failed: %s", error)
2376
except gnutls.Error as error:
2377
log.warning("Handshake failed: %s", error)
1716
2378
# Do not run session.bye() here: the session is not
1717
2379
# established. Just abandon the request.
1718
2380
return
1719
logger.debug("Handshake succeeded")
1720
2381
log.debug("Handshake succeeded")
2382
1721
2383
approval_required = False
1722
2384
try:
1723
try:
1724
fpr = self.fingerprint(self.peer_certificate
1725
(session))
1726
except (TypeError,
1727
gnutls.errors.GNUTLSError) as error:
1728
logger.warning("Bad certificate: %s", error)
1729
return
1730
logger.debug("Fingerprint: %s", fpr)
1731
1732
try:
1733
client = ProxyClient(child_pipe, fpr,
2385
if gnutls.has_rawpk:
2386
fpr = b""
2387
try:
2388
key_id = self.key_id(
2389
self.peer_certificate(session))
2390
except (TypeError, gnutls.Error) as error:
2391
log.warning("Bad certificate: %s", error)
2392
return
2393
log.debug("Key ID: %s",
2394
key_id.decode("utf-8",
2395
errors="replace"))
2396
2397
else:
2398
key_id = b""
2399
try:
2400
fpr = self.fingerprint(
2401
self.peer_certificate(session))
2402
except (TypeError, gnutls.Error) as error:
2403
log.warning("Bad certificate: %s", error)
2404
return
2405
log.debug("Fingerprint: %s", fpr)
2406
2407
try:
2408
client = ProxyClient(child_pipe, key_id, fpr,
1734
2409
self.client_address)
1735
2410
except KeyError:
1736
2411
return
1737
2412
1738
2413
if client.approval_delay:
1739
2414
delay = client.approval_delay
1740
2415
client.approvals_pending += 1
1741
2416
approval_required = True
1742
2417
1743
2418
while True:
1744
2419
if not client.enabled:
1745
logger.info("Client %s is disabled",
1746
client.name)
2420
log.info("Client %s is disabled", client.name)
1747
2421
if self.server.use_dbus:
1748
2422
# Emit D-Bus signal
1749
2423
client.Rejected("Disabled")
1750
2424
return
1751
2425
1752
2426
if client.approved or not client.approval_delay:
1753
#We are approved or approval is disabled
2427
# We are approved or approval is disabled
1754
2428
break
1755
2429
elif client.approved is None:
1756
logger.info("Client %s needs approval",
2430
log.info("Client %s needs approval",
2431
client.name)
2432
if self.server.use_dbus:
2433
# Emit D-Bus signal
2434
client.NeedApproval(
2435
client.approval_delay.total_seconds()
2436
* 1000, client.approved_by_default)
2437
else:
2438
log.warning("Client %s was not approved",
1757
2439
client.name)
1758
2440
if self.server.use_dbus:
1759
2441
# Emit D-Bus signal
1760
client.NeedApproval(
1761
client.approval_delay_milliseconds(),
1762
client.approved_by_default)
1763
else:
1764
logger.warning("Client %s was not approved",
1765
client.name)
1766
if self.server.use_dbus:
1767
# Emit D-Bus signal
1768
2442
client.Rejected("Denied")
1769
2443
return
1770
1771
#wait until timeout or approved
2444
2445
# wait until timeout or approved
1772
2446
time = datetime.datetime.now()
1773
2447
client.changedstate.acquire()
1774
client.changedstate.wait(
1775
float(timedelta_to_milliseconds(delay)
1776
/ 1000))
2448
client.changedstate.wait(delay.total_seconds())
1777
2449
client.changedstate.release()
1778
2450
time2 = datetime.datetime.now()
1779
2451
if (time2 - time) >= delay:
1780
2452
if not client.approved_by_default:
1781
logger.warning("Client %s timed out while"
1782
" waiting for approval",
1783
client.name)
2453
log.warning("Client %s timed out while"
2454
" waiting for approval",
2455
client.name)
1784
2456
if self.server.use_dbus:
1785
2457
# Emit D-Bus signal
1786
2458
client.Rejected("Approval timed out")
1789
2461
break
1790
2462
else:
1791
2463
delay -= time2 - time
1792
1793
sent_size = 0
1794
while sent_size < len(client.secret):
1795
try:
1796
sent = session.send(client.secret[sent_size:])
1797
except gnutls.errors.GNUTLSError as error:
1798
logger.warning("gnutls send failed",
1799
exc_info=error)
1800
return
1801
logger.debug("Sent: %d, remaining: %d",
1802
sent, len(client.secret)
1803
- (sent_size + sent))
1804
sent_size += sent
1805
1806
logger.info("Sending secret to %s", client.name)
2464
2465
try:
2466
session.send(client.secret)
2467
except gnutls.Error as error:
2468
log.warning("gnutls send failed", exc_info=error)
2469
return
2470
2471
log.info("Sending secret to %s", client.name)
1807
2472
# bump the timeout using extended_timeout
1808
2473
client.bump_timeout(client.extended_timeout)
1809
2474
if self.server.use_dbus:
1810
2475
# Emit D-Bus signal
1811
2476
client.GotSecret()
1812
2477
1813
2478
finally:
1814
2479
if approval_required:
1815
2480
client.approvals_pending -= 1
1816
2481
try:
1817
2482
session.bye()
1818
except gnutls.errors.GNUTLSError as error:
1819
logger.warning("GnuTLS bye failed",
1820
exc_info=error)
1821
2483
except gnutls.Error as error:
2484
log.warning("GnuTLS bye failed", exc_info=error)
2485
1822
2486
@staticmethod
1823
2487
def peer_certificate(session):
1824
"Return the peer's OpenPGP certificate as a bytestring"
1825
# If not an OpenPGP certificate...
1826
if (gnutls.library.functions
1827
.gnutls_certificate_type_get(session._c_object)
1828
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1829
# ...do the normal thing
1830
return session.peer_certificate
2488
"Return the peer's certificate as a bytestring"
2489
try:
2490
cert_type = gnutls.certificate_type_get2(
2491
session, gnutls.CTYPE_PEERS)
2492
except AttributeError:
2493
cert_type = gnutls.certificate_type_get(session)
2494
if gnutls.has_rawpk:
2495
valid_cert_types = frozenset((gnutls.CRT_RAWPK,))
2496
else:
2497
valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))
2498
# If not a valid certificate type...
2499
if cert_type not in valid_cert_types:
2500
log.info("Cert type %r not in %r", cert_type,
2501
valid_cert_types)
2502
# ...return invalid data
2503
return b""
1831
2504
list_size = ctypes.c_uint(1)
1832
cert_list = (gnutls.library.functions
1833
.gnutls_certificate_get_peers
1834
(session._c_object, ctypes.byref(list_size)))
2505
cert_list = (gnutls.certificate_get_peers
2506
(session, ctypes.byref(list_size)))
1835
2507
if not bool(cert_list) and list_size.value != 0:
1836
raise gnutls.errors.GNUTLSError("error getting peer"
1837
" certificate")
2508
raise gnutls.Error("error getting peer certificate")
1838
2509
if list_size.value == 0:
1839
2510
return None
1840
2511
cert = cert_list[0]
1841
2512
return ctypes.string_at(cert.data, cert.size)
1842
2513
2514
@staticmethod
2515
def key_id(certificate):
2516
"Convert a certificate bytestring to a hexdigit key ID"
2517
# New GnuTLS "datum" with the public key
2518
datum = gnutls.datum_t(
2519
ctypes.cast(ctypes.c_char_p(certificate),
2520
ctypes.POINTER(ctypes.c_ubyte)),
2521
ctypes.c_uint(len(certificate)))
2522
# XXX all these need to be created in the gnutls "module"
2523
# New empty GnuTLS certificate
2524
pubkey = gnutls.pubkey_t()
2525
gnutls.pubkey_init(ctypes.byref(pubkey))
2526
# Import the raw public key into the certificate
2527
gnutls.pubkey_import(pubkey,
2528
ctypes.byref(datum),
2529
gnutls.X509_FMT_DER)
2530
# New buffer for the key ID
2531
buf = ctypes.create_string_buffer(32)
2532
buf_len = ctypes.c_size_t(len(buf))
2533
# Get the key ID from the raw public key into the buffer
2534
gnutls.pubkey_get_key_id(
2535
pubkey,
2536
gnutls.KEYID_USE_SHA256,
2537
ctypes.cast(ctypes.byref(buf),
2538
ctypes.POINTER(ctypes.c_ubyte)),
2539
ctypes.byref(buf_len))
2540
# Deinit the certificate
2541
gnutls.pubkey_deinit(pubkey)
2542
2543
# Convert the buffer to a Python bytestring
2544
key_id = ctypes.string_at(buf, buf_len.value)
2545
# Convert the bytestring to hexadecimal notation
2546
hex_key_id = binascii.hexlify(key_id).upper()
2547
return hex_key_id
2548
1843
2549
@staticmethod
1844
2550
def fingerprint(openpgp):
1845
2551
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
1846
2552
# New GnuTLS "datum" with the OpenPGP public key
1847
datum = (gnutls.library.types
1848
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1849
ctypes.POINTER
1850
(ctypes.c_ubyte)),
1851
ctypes.c_uint(len(openpgp))))
2553
datum = gnutls.datum_t(
2554
ctypes.cast(ctypes.c_char_p(openpgp),
2555
ctypes.POINTER(ctypes.c_ubyte)),
2556
ctypes.c_uint(len(openpgp)))
1852
2557
# New empty GnuTLS certificate
1853
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1854
(gnutls.library.functions
1855
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2558
crt = gnutls.openpgp_crt_t()
2559
gnutls.openpgp_crt_init(ctypes.byref(crt))
1856
2560
# Import the OpenPGP public key into the certificate
1857
(gnutls.library.functions
1858
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1859
gnutls.library.constants
1860
.GNUTLS_OPENPGP_FMT_RAW))
2561
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2562
gnutls.OPENPGP_FMT_RAW)
1861
2563
# Verify the self signature in the key
1862
2564
crtverify = ctypes.c_uint()
1863
(gnutls.library.functions
1864
.gnutls_openpgp_crt_verify_self(crt, 0,
1865
ctypes.byref(crtverify)))
2565
gnutls.openpgp_crt_verify_self(crt, 0,
2566
ctypes.byref(crtverify))
1866
2567
if crtverify.value != 0:
1867
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1868
raise (gnutls.errors.CertificateSecurityError
1869
("Verify failed"))
2568
gnutls.openpgp_crt_deinit(crt)
2569
raise gnutls.CertificateSecurityError(code
2570
=crtverify.value)
1870
2571
# New buffer for the fingerprint
1871
2572
buf = ctypes.create_string_buffer(20)
1872
2573
buf_len = ctypes.c_size_t()
1873
2574
# Get the fingerprint from the certificate into the buffer
1874
(gnutls.library.functions
1875
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1876
ctypes.byref(buf_len)))
2575
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2576
ctypes.byref(buf_len))
1877
2577
# Deinit the certificate
1878
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2578
gnutls.openpgp_crt_deinit(crt)
1879
2579
# Convert the buffer to a Python bytestring
1880
2580
fpr = ctypes.string_at(buf, buf_len.value)
1881
2581
# Convert the bytestring to hexadecimal notation
1883
2583
return hex_fpr
1884
2584
1885
2585
1886
class MultiprocessingMixIn(object):
2586
class MultiprocessingMixIn:
1887
2587
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2588
1888
2589
def sub_process_main(self, request, address):
1889
2590
try:
1890
2591
self.finish_request(request, address)
1891
2592
except Exception:
1892
2593
self.handle_error(request, address)
1893
2594
self.close_request(request)
1894
2595
1895
2596
def process_request(self, request, address):
1896
2597
"""Start a new process to process the request."""
1897
proc = multiprocessing.Process(target = self.sub_process_main,
1898
args = (request, address))
2598
proc = multiprocessing.Process(target=self.sub_process_main,
2599
args=(request, address))
1899
2600
proc.start()
1900
2601
return proc
1901
2602
1902
2603
1903
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2604
class MultiprocessingMixInWithPipe(MultiprocessingMixIn):
1904
2605
""" adds a pipe to the MixIn """
2606
1905
2607
def process_request(self, request, client_address):
1906
2608
"""Overrides and wraps the original process_request().
1907
2609
1908
2610
This function creates a new pipe in self.pipe
1909
2611
"""
1910
2612
parent_pipe, self.child_pipe = multiprocessing.Pipe()
1911
2613
1912
2614
proc = MultiprocessingMixIn.process_request(self, request,
1913
2615
client_address)
1914
2616
self.child_pipe.close()
1915
2617
self.add_pipe(parent_pipe, proc)
1916
2618
1917
2619
def add_pipe(self, parent_pipe, proc):
1918
2620
"""Dummy function; override as necessary"""
1919
2621
raise NotImplementedError()
1920
2622
1921
2623
1922
2624
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1923
socketserver.TCPServer, object):
1924
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
1925
2625
socketserver.TCPServer):
2626
"""IPv6-capable TCP server. Accepts None as address and/or port
2627
1926
2628
Attributes:
1927
2629
enabled: Boolean; whether this server is activated yet
1928
2630
interface: None or a network interface name (string)
1929
2631
use_ipv6: Boolean; to use IPv6 or not
1930
2632
"""
2633
1931
2634
def __init__(self, server_address, RequestHandlerClass,
1932
interface=None, use_ipv6=True, socketfd=None):
2635
interface=None,
2636
use_ipv6=True,
2637
socketfd=None):
1933
2638
"""If socketfd is set, use that file descriptor instead of
1934
2639
creating a new one with socket.socket().
1935
2640
"""
1941
2646
self.socketfd = socketfd
1942
2647
# Save the original socket.socket() function
1943
2648
self.socket_socket = socket.socket
2649
1944
2650
# To implement --socket, we monkey patch socket.socket.
1945
#
2651
#
1946
2652
# (When socketserver.TCPServer is a new-style class, we
1947
2653
# could make self.socket into a property instead of monkey
1948
2654
# patching socket.socket.)
1949
#
2655
#
1950
2656
# Create a one-time-only replacement for socket.socket()
1951
2657
@functools.wraps(socket.socket)
1952
2658
def socket_wrapper(*args, **kwargs):
1964
2670
# socket_wrapper(), if socketfd was set.
1965
2671
socketserver.TCPServer.__init__(self, server_address,
1966
2672
RequestHandlerClass)
1967
2673
1968
2674
def server_bind(self):
1969
2675
"""This overrides the normal server_bind() function
1970
2676
to bind to an interface if one was specified, and also NOT to
1971
2677
bind to an address or port if they were not specified."""
2678
global SO_BINDTODEVICE
1972
2679
if self.interface is not None:
1973
2680
if SO_BINDTODEVICE is None:
1974
logger.error("SO_BINDTODEVICE does not exist;"
1975
" cannot bind to interface %s",
1976
self.interface)
1977
else:
1978
try:
1979
self.socket.setsockopt(socket.SOL_SOCKET,
1980
SO_BINDTODEVICE,
1981
str(self.interface + '\0'))
1982
except socket.error as error:
1983
if error.errno == errno.EPERM:
1984
logger.error("No permission to bind to"
1985
" interface %s", self.interface)
1986
elif error.errno == errno.ENOPROTOOPT:
1987
logger.error("SO_BINDTODEVICE not available;"
1988
" cannot bind to interface %s",
1989
self.interface)
1990
elif error.errno == errno.ENODEV:
1991
logger.error("Interface %s does not exist,"
1992
" cannot bind", self.interface)
1993
else:
1994
raise
2681
# Fall back to a hard-coded value which seems to be
2682
# common enough.
2683
log.warning("SO_BINDTODEVICE not found, trying 25")
2684
SO_BINDTODEVICE = 25
2685
try:
2686
self.socket.setsockopt(
2687
socket.SOL_SOCKET, SO_BINDTODEVICE,
2688
(self.interface + "\0").encode("utf-8"))
2689
except socket.error as error:
2690
if error.errno == errno.EPERM:
2691
log.error("No permission to bind to interface %s",
2692
self.interface)
2693
elif error.errno == errno.ENOPROTOOPT:
2694
log.error("SO_BINDTODEVICE not available; cannot"
2695
" bind to interface %s", self.interface)
2696
elif error.errno == errno.ENODEV:
2697
log.error("Interface %s does not exist, cannot"
2698
" bind", self.interface)
2699
else:
2700
raise
1995
2701
# Only bind(2) the socket if we really need to.
1996
2702
if self.server_address[0] or self.server_address[1]:
2703
if self.server_address[1]:
2704
self.allow_reuse_address = True
1997
2705
if not self.server_address[0]:
1998
2706
if self.address_family == socket.AF_INET6:
1999
any_address = "::" # in6addr_any
2707
any_address = "::" # in6addr_any
2000
2708
else:
2001
any_address = "0.0.0.0" # INADDR_ANY
2709
any_address = "0.0.0.0" # INADDR_ANY
2002
2710
self.server_address = (any_address,
2003
2711
self.server_address[1])
2004
2712
elif not self.server_address[1]:
2005
self.server_address = (self.server_address[0],
2006
0)
2713
self.server_address = (self.server_address[0], 0)
2007
2714
# if self.interface:
2008
2715
# self.server_address = (self.server_address[0],
2009
2716
# 0, # port
2015
2722
2016
2723
class MandosServer(IPv6_TCPServer):
2017
2724
"""Mandos server.
2018
2725
2019
2726
Attributes:
2020
2727
clients: set of Client objects
2021
2728
gnutls_priority GnuTLS priority string
2022
2729
use_dbus: Boolean; to emit D-Bus signals or not
2023
2024
Assumes a gobject.MainLoop event loop.
2730
2731
Assumes a GLib.MainLoop event loop.
2025
2732
"""
2733
2026
2734
def __init__(self, server_address, RequestHandlerClass,
2027
interface=None, use_ipv6=True, clients=None,
2028
gnutls_priority=None, use_dbus=True, socketfd=None):
2735
interface=None,
2736
use_ipv6=True,
2737
clients=None,
2738
gnutls_priority=None,
2739
use_dbus=True,
2740
socketfd=None):
2029
2741
self.enabled = False
2030
2742
self.clients = clients
2031
2743
if self.clients is None:
2034
2746
self.gnutls_priority = gnutls_priority
2035
2747
IPv6_TCPServer.__init__(self, server_address,
2036
2748
RequestHandlerClass,
2037
interface = interface,
2038
use_ipv6 = use_ipv6,
2039
socketfd = socketfd)
2749
interface=interface,
2750
use_ipv6=use_ipv6,
2751
socketfd=socketfd)
2752
2040
2753
def server_activate(self):
2041
2754
if self.enabled:
2042
2755
return socketserver.TCPServer.server_activate(self)
2043
2756
2044
2757
def enable(self):
2045
2758
self.enabled = True
2046
2759
2047
2760
def add_pipe(self, parent_pipe, proc):
2048
2761
# Call "handle_ipc" for both data and EOF events
2049
gobject.io_add_watch(parent_pipe.fileno(),
2050
gobject.IO_IN | gobject.IO_HUP,
2051
functools.partial(self.handle_ipc,
2052
parent_pipe =
2053
parent_pipe,
2054
proc = proc))
2055
2056
def handle_ipc(self, source, condition, parent_pipe=None,
2057
proc = None, client_object=None):
2762
GLib.io_add_watch(
2763
GLib.IOChannel.unix_new(parent_pipe.fileno()),
2764
GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
2765
functools.partial(self.handle_ipc,
2766
parent_pipe=parent_pipe,
2767
proc=proc))
2768
2769
def handle_ipc(self, source, condition,
2770
parent_pipe=None,
2771
proc=None,
2772
client_object=None):
2058
2773
# error, or the other end of multiprocessing.Pipe has closed
2059
if condition & (gobject.IO_ERR | gobject.IO_HUP):
2774
if condition & (GLib.IO_ERR | GLib.IO_HUP):
2060
2775
# Wait for other process to exit
2061
2776
proc.join()
2062
2777
return False
2063
2778
2064
2779
# Read a request from the child
2065
2780
request = parent_pipe.recv()
2066
2781
command = request[0]
2067
2068
if command == 'init':
2069
fpr = request[1]
2070
address = request[2]
2071
2072
for c in self.clients.itervalues():
2073
if c.fingerprint == fpr:
2782
2783
if command == "init":
2784
key_id = request[1].decode("ascii")
2785
fpr = request[2].decode("ascii")
2786
address = request[3]
2787
2788
for c in self.clients.values():
2789
if key_id == ("E3B0C44298FC1C149AFBF4C8996FB924"
2790
"27AE41E4649B934CA495991B7852B855"):
2791
continue
2792
if key_id and c.key_id == key_id:
2793
client = c
2794
break
2795
if fpr and c.fingerprint == fpr:
2074
2796
client = c
2075
2797
break
2076
2798
else:
2077
logger.info("Client not found for fingerprint: %s, ad"
2078
"dress: %s", fpr, address)
2799
log.info("Client not found for key ID: %s, address:"
2800
" %s", key_id or fpr, address)
2079
2801
if self.use_dbus:
2080
2802
# Emit D-Bus signal
2081
mandos_dbus_service.ClientNotFound(fpr,
2803
mandos_dbus_service.ClientNotFound(key_id or fpr,
2082
2804
address[0])
2083
2805
parent_pipe.send(False)
2084
2806
return False
2085
2086
gobject.io_add_watch(parent_pipe.fileno(),
2087
gobject.IO_IN | gobject.IO_HUP,
2088
functools.partial(self.handle_ipc,
2089
parent_pipe =
2090
parent_pipe,
2091
proc = proc,
2092
client_object =
2093
client))
2807
2808
GLib.io_add_watch(
2809
GLib.IOChannel.unix_new(parent_pipe.fileno()),
2810
GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
2811
functools.partial(self.handle_ipc,
2812
parent_pipe=parent_pipe,
2813
proc=proc,
2814
client_object=client))
2094
2815
parent_pipe.send(True)
2095
2816
# remove the old hook in favor of the new above hook on
2096
2817
# same fileno
2097
2818
return False
2098
if command == 'funcall':
2819
if command == "funcall":
2099
2820
funcname = request[1]
2100
2821
args = request[2]
2101
2822
kwargs = request[3]
2102
2103
parent_pipe.send(('data', getattr(client_object,
2823
2824
parent_pipe.send(("data", getattr(client_object,
2104
2825
funcname)(*args,
2105
**kwargs)))
2106
2107
if command == 'getattr':
2826
**kwargs)))
2827
2828
if command == "getattr":
2108
2829
attrname = request[1]
2109
if callable(client_object.__getattribute__(attrname)):
2110
parent_pipe.send(('function',))
2830
if isinstance(client_object.__getattribute__(attrname),
2831
collections.abc.Callable):
2832
parent_pipe.send(("function", ))
2111
2833
else:
2112
parent_pipe.send(('data', client_object
2113
.__getattribute__(attrname)))
2114
2115
if command == 'setattr':
2834
parent_pipe.send((
2835
"data", client_object.__getattribute__(attrname)))
2836
2837
if command == "setattr":
2116
2838
attrname = request[1]
2117
2839
value = request[2]
2118
2840
setattr(client_object, attrname, value)
2119
2841
2120
2842
return True
2121
2843
2122
2844
2123
2845
def rfc3339_duration_to_delta(duration):
2124
2846
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2125
2126
>>> rfc3339_duration_to_delta("P7D")
2127
datetime.timedelta(7)
2128
>>> rfc3339_duration_to_delta("PT60S")
2129
datetime.timedelta(0, 60)
2130
>>> rfc3339_duration_to_delta("PT60M")
2131
datetime.timedelta(0, 3600)
2132
>>> rfc3339_duration_to_delta("PT24H")
2133
datetime.timedelta(1)
2134
>>> rfc3339_duration_to_delta("P1W")
2135
datetime.timedelta(7)
2136
>>> rfc3339_duration_to_delta("PT5M30S")
2137
datetime.timedelta(0, 330)
2138
>>> rfc3339_duration_to_delta("P1DT3M20S")
2139
datetime.timedelta(1, 200)
2847
2848
>>> timedelta = datetime.timedelta
2849
>>> rfc3339_duration_to_delta("P7D") == timedelta(7)
2850
True
2851
>>> rfc3339_duration_to_delta("PT60S") == timedelta(0, 60)
2852
True
2853
>>> rfc3339_duration_to_delta("PT60M") == timedelta(0, 3600)
2854
True
2855
>>> rfc3339_duration_to_delta("PT24H") == timedelta(1)
2856
True
2857
>>> rfc3339_duration_to_delta("P1W") == timedelta(7)
2858
True
2859
>>> rfc3339_duration_to_delta("PT5M30S") == timedelta(0, 330)
2860
True
2861
>>> rfc3339_duration_to_delta("P1DT3M20S") == timedelta(1, 200)
2862
True
2863
>>> del timedelta
2140
2864
"""
2141
2865
2142
2866
# Parsing an RFC 3339 duration with regular expressions is not
2143
2867
# possible - there would have to be multiple places for the same
2144
2868
# values, like seconds. The current code, while more esoteric, is
2145
2869
# cleaner without depending on a parsing library. If Python had a
2146
2870
# built-in library for parsing we would use it, but we'd like to
2147
2871
# avoid excessive use of external libraries.
2148
2872
2149
2873
# New type for defining tokens, syntax, and semantics all-in-one
2150
Token = collections.namedtuple("Token",
2151
("regexp", # To match token; if
2152
# "value" is not None,
2153
# must have a "group"
2154
# containing digits
2155
"value", # datetime.timedelta or
2156
# None
2157
"followers")) # Tokens valid after
2158
# this token
2874
Token = collections.namedtuple("Token", (
2875
"regexp", # To match token; if "value" is not None, must have
2876
# a "group" containing digits
2877
"value", # datetime.timedelta or None
2878
"followers")) # Tokens valid after this token
2159
2879
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2160
2880
# the "duration" ABNF definition in RFC 3339, Appendix A.
2161
2881
token_end = Token(re.compile(r"$"), None, frozenset())
2162
2882
token_second = Token(re.compile(r"(\d+)S"),
2163
2883
datetime.timedelta(seconds=1),
2164
frozenset((token_end,)))
2884
frozenset((token_end, )))
2165
2885
token_minute = Token(re.compile(r"(\d+)M"),
2166
2886
datetime.timedelta(minutes=1),
2167
2887
frozenset((token_second, token_end)))
2183
2903
frozenset((token_month, token_end)))
2184
2904
token_week = Token(re.compile(r"(\d+)W"),
2185
2905
datetime.timedelta(weeks=1),
2186
frozenset((token_end,)))
2906
frozenset((token_end, )))
2187
2907
token_duration = Token(re.compile(r"P"), None,
2188
2908
frozenset((token_year, token_month,
2189
2909
token_day, token_time,
2190
token_week))),
2191
# Define starting values
2192
value = datetime.timedelta() # Value so far
2910
token_week)))
2911
# Define starting values:
2912
# Value so far
2913
value = datetime.timedelta()
2193
2914
found_token = None
2194
followers = frozenset(token_duration,) # Following valid tokens
2195
s = duration # String left to parse
2915
# Following valid tokens
2916
followers = frozenset((token_duration, ))
2917
# String left to parse
2918
s = duration
2196
2919
# Loop until end token is found
2197
2920
while found_token is not token_end:
2198
2921
# Search for any currently valid tokens
2214
2937
break
2215
2938
else:
2216
2939
# No currently valid tokens were found
2217
raise ValueError("Invalid RFC 3339 duration")
2940
raise ValueError("Invalid RFC 3339 duration: {!r}"
2941
.format(duration))
2218
2942
# End token found
2219
2943
return value
2220
2944
2221
2945
2222
2946
def string_to_delta(interval):
2223
2947
"""Parse a string and return a datetime.timedelta
2224
2225
>>> string_to_delta('7d')
2226
datetime.timedelta(7)
2227
>>> string_to_delta('60s')
2228
datetime.timedelta(0, 60)
2229
>>> string_to_delta('60m')
2230
datetime.timedelta(0, 3600)
2231
>>> string_to_delta('24h')
2232
datetime.timedelta(1)
2233
>>> string_to_delta('1w')
2234
datetime.timedelta(7)
2235
>>> string_to_delta('5m 30s')
2236
datetime.timedelta(0, 330)
2948
2949
>>> string_to_delta("7d") == datetime.timedelta(7)
2950
True
2951
>>> string_to_delta("60s") == datetime.timedelta(0, 60)
2952
True
2953
>>> string_to_delta("60m") == datetime.timedelta(0, 3600)
2954
True
2955
>>> string_to_delta("24h") == datetime.timedelta(1)
2956
True
2957
>>> string_to_delta("1w") == datetime.timedelta(7)
2958
True
2959
>>> string_to_delta("5m 30s") == datetime.timedelta(0, 330)
2960
True
2237
2961
"""
2238
2962
2239
2963
try:
2240
2964
return rfc3339_duration_to_delta(interval)
2241
2965
except ValueError:
2242
2966
pass
2243
2967
2244
2968
timevalue = datetime.timedelta(0)
2245
2969
for s in interval.split():
2246
2970
try:
2247
suffix = unicode(s[-1])
2971
suffix = s[-1]
2248
2972
value = int(s[:-1])
2249
2973
if suffix == "d":
2250
2974
delta = datetime.timedelta(value)
2257
2981
elif suffix == "w":
2258
2982
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2259
2983
else:
2260
raise ValueError("Unknown suffix {0!r}"
2261
.format(suffix))
2984
raise ValueError("Unknown suffix {!r}".format(suffix))
2262
2985
except IndexError as e:
2263
2986
raise ValueError(*(e.args))
2264
2987
timevalue += delta
2265
2988
return timevalue
2266
2989
2267
2990
2268
def daemon(nochdir = False, noclose = False):
2991
def daemon(nochdir=False, noclose=False):
2269
2992
"""See daemon(3). Standard BSD Unix function.
2270
2993
2271
2994
This should really exist as os.daemon, but it doesn't (yet)."""
2272
2995
if os.fork():
2273
2996
sys.exit()
2281
3004
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2282
3005
if not stat.S_ISCHR(os.fstat(null).st_mode):
2283
3006
raise OSError(errno.ENODEV,
2284
"{0} not a character device"
3007
"{} not a character device"
2285
3008
.format(os.devnull))
2286
3009
os.dup2(null, sys.stdin.fileno())
2287
3010
os.dup2(null, sys.stdout.fileno())
2291
3014
2292
3015
2293
3016
def main():
2294
3017
2295
3018
##################################################################
2296
3019
# Parsing of options, both command line and config file
2297
3020
2298
3021
parser = argparse.ArgumentParser()
2299
3022
parser.add_argument("-v", "--version", action="version",
2300
version = "%(prog)s {0}".format(version),
3023
version="%(prog)s {}".format(version),
2301
3024
help="show version number and exit")
2302
3025
parser.add_argument("-i", "--interface", metavar="IF",
2303
3026
help="Bind to interface IF")
2336
3059
help="Directory to save/restore state in")
2337
3060
parser.add_argument("--foreground", action="store_true",
2338
3061
help="Run in foreground", default=None)
2339
3062
parser.add_argument("--no-zeroconf", action="store_false",
3063
dest="zeroconf", help="Do not use Zeroconf",
3064
default=None)
3065
2340
3066
options = parser.parse_args()
2341
2342
if options.check:
2343
import doctest
2344
fail_count, test_count = doctest.testmod()
2345
sys.exit(os.EX_OK if fail_count == 0 else 1)
2346
3067
2347
3068
# Default values for config file for server-global settings
2348
server_defaults = { "interface": "",
2349
"address": "",
2350
"port": "",
2351
"debug": "False",
2352
"priority":
2353
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",
2354
"servicename": "Mandos",
2355
"use_dbus": "True",
2356
"use_ipv6": "True",
2357
"debuglevel": "",
2358
"restore": "True",
2359
"socket": "",
2360
"statedir": "/var/lib/mandos",
2361
"foreground": "False",
2362
}
2363
3069
if gnutls.has_rawpk:
3070
priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"
3071
":!VERS-ALL:+VERS-TLS1.3:%PROFILE_ULTRA")
3072
else:
3073
priority = ("SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
3074
":+SIGN-DSA-SHA256")
3075
server_defaults = {"interface": "",
3076
"address": "",
3077
"port": "",
3078
"debug": "False",
3079
"priority": priority,
3080
"servicename": "Mandos",
3081
"use_dbus": "True",
3082
"use_ipv6": "True",
3083
"debuglevel": "",
3084
"restore": "True",
3085
"socket": "",
3086
"statedir": "/var/lib/mandos",
3087
"foreground": "False",
3088
"zeroconf": "True",
3089
}
3090
del priority
3091
2364
3092
# Parse config file for server-global settings
2365
server_config = configparser.SafeConfigParser(server_defaults)
3093
server_config = configparser.ConfigParser(server_defaults)
2366
3094
del server_defaults
2367
server_config.read(os.path.join(options.configdir,
2368
"mandos.conf"))
2369
# Convert the SafeConfigParser object to a dict
3095
server_config.read(os.path.join(options.configdir, "mandos.conf"))
3096
# Convert the ConfigParser object to a dict
2370
3097
server_settings = server_config.defaults()
2371
3098
# Use the appropriate methods on the non-string config options
2372
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
3099
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3100
"foreground", "zeroconf"):
2373
3101
server_settings[option] = server_config.getboolean("DEFAULT",
2374
3102
option)
2375
3103
if server_settings["port"]:
2381
3109
# Later, stdin will, and stdout and stderr might, be dup'ed
2382
3110
# over with an opened os.devnull. But we don't want this to
2383
3111
# happen with a supplied network socket.
2384
if 0 <= server_settings["socket"] <= 2:
3112
while 0 <= server_settings["socket"] <= 2:
2385
3113
server_settings["socket"] = os.dup(server_settings
2386
3114
["socket"])
3115
os.set_inheritable(server_settings["socket"], False)
2387
3116
del server_config
2388
3117
2389
3118
# Override the settings from the config file with command line
2390
3119
# options, if set.
2391
3120
for option in ("interface", "address", "port", "debug",
2392
"priority", "servicename", "configdir",
2393
"use_dbus", "use_ipv6", "debuglevel", "restore",
2394
"statedir", "socket", "foreground"):
3121
"priority", "servicename", "configdir", "use_dbus",
3122
"use_ipv6", "debuglevel", "restore", "statedir",
3123
"socket", "foreground", "zeroconf"):
2395
3124
value = getattr(options, option)
2396
3125
if value is not None:
2397
3126
server_settings[option] = value
2398
3127
del options
2399
3128
# Force all strings to be unicode
2400
3129
for option in server_settings.keys():
2401
if type(server_settings[option]) is str:
2402
server_settings[option] = unicode(server_settings[option])
3130
if isinstance(server_settings[option], bytes):
3131
server_settings[option] = (server_settings[option]
3132
.decode("utf-8"))
2403
3133
# Force all boolean options to be boolean
2404
3134
for option in ("debug", "use_dbus", "use_ipv6", "restore",
2405
"foreground"):
3135
"foreground", "zeroconf"):
2406
3136
server_settings[option] = bool(server_settings[option])
2407
3137
# Debug implies foreground
2408
3138
if server_settings["debug"]:
2409
3139
server_settings["foreground"] = True
2410
3140
# Now we have our good server settings in "server_settings"
2411
3141
2412
3142
##################################################################
2413
3143
3144
if (not server_settings["zeroconf"]
3145
and not (server_settings["port"]
3146
or server_settings["socket"] != "")):
3147
parser.error("Needs port or socket to work without Zeroconf")
3148
2414
3149
# For convenience
2415
3150
debug = server_settings["debug"]
2416
3151
debuglevel = server_settings["debuglevel"]
2419
3154
stored_state_path = os.path.join(server_settings["statedir"],
2420
3155
stored_state_file)
2421
3156
foreground = server_settings["foreground"]
2422
3157
zeroconf = server_settings["zeroconf"]
3158
2423
3159
if debug:
2424
3160
initlogger(debug, logging.DEBUG)
2425
3161
else:
2428
3164
else:
2429
3165
level = getattr(logging, debuglevel.upper())
2430
3166
initlogger(debug, level)
2431
3167
2432
3168
if server_settings["servicename"] != "Mandos":
2433
syslogger.setFormatter(logging.Formatter
2434
('Mandos ({0}) [%(process)d]:'
2435
' %(levelname)s: %(message)s'
2436
.format(server_settings
2437
["servicename"])))
2438
3169
syslogger.setFormatter(
3170
logging.Formatter("Mandos ({}) [%(process)d]:"
3171
" %(levelname)s: %(message)s".format(
3172
server_settings["servicename"])))
3173
2439
3174
# Parse config file with clients
2440
client_config = configparser.SafeConfigParser(Client
2441
.client_defaults)
3175
client_config = configparser.ConfigParser(Client.client_defaults)
2442
3176
client_config.read(os.path.join(server_settings["configdir"],
2443
3177
"clients.conf"))
2444
3178
2445
3179
global mandos_dbus_service
2446
3180
mandos_dbus_service = None
2447
2448
tcp_server = MandosServer((server_settings["address"],
2449
server_settings["port"]),
2450
ClientHandler,
2451
interface=(server_settings["interface"]
2452
or None),
2453
use_ipv6=use_ipv6,
2454
gnutls_priority=
2455
server_settings["priority"],
2456
use_dbus=use_dbus,
2457
socketfd=(server_settings["socket"]
2458
or None))
3181
3182
socketfd = None
3183
if server_settings["socket"] != "":
3184
socketfd = server_settings["socket"]
3185
tcp_server = MandosServer(
3186
(server_settings["address"], server_settings["port"]),
3187
ClientHandler,
3188
interface=(server_settings["interface"] or None),
3189
use_ipv6=use_ipv6,
3190
gnutls_priority=server_settings["priority"],
3191
use_dbus=use_dbus,
3192
socketfd=socketfd)
2459
3193
if not foreground:
2460
3194
pidfilename = "/run/mandos.pid"
2461
3195
if not os.path.isdir("/run/."):
2462
3196
pidfilename = "/var/run/mandos.pid"
2463
3197
pidfile = None
2464
3198
try:
2465
pidfile = open(pidfilename, "w")
3199
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
2466
3200
except IOError as e:
2467
logger.error("Could not open file %r", pidfilename,
2468
exc_info=e)
2469
2470
for name in ("_mandos", "mandos", "nobody"):
3201
log.error("Could not open file %r", pidfilename,
3202
exc_info=e)
3203
3204
for name, group in (("_mandos", "_mandos"),
3205
("mandos", "mandos"),
3206
("nobody", "nogroup")):
2471
3207
try:
2472
3208
uid = pwd.getpwnam(name).pw_uid
2473
gid = pwd.getpwnam(name).pw_gid
3209
gid = pwd.getpwnam(group).pw_gid
2474
3210
break
2475
3211
except KeyError:
2476
3212
continue
2480
3216
try:
2481
3217
os.setgid(gid)
2482
3218
os.setuid(uid)
3219
log.debug("Did setuid/setgid to %s:%s", uid, gid)
2483
3220
except OSError as error:
3221
log.warning("Failed to setuid/setgid to %s:%s: %s", uid, gid,
3222
os.strerror(error.errno))
2484
3223
if error.errno != errno.EPERM:
2485
3224
raise
2486
3225
2487
3226
if debug:
2488
3227
# Enable all possible GnuTLS debugging
2489
3228
2490
3229
# "Use a log level over 10 to enable all debugging options."
2491
3230
# - GnuTLS manual
2492
gnutls.library.functions.gnutls_global_set_log_level(11)
2493
2494
@gnutls.library.types.gnutls_log_func
3231
gnutls.global_set_log_level(11)
3232
3233
@gnutls.log_func
2495
3234
def debug_gnutls(level, string):
2496
logger.debug("GnuTLS: %s", string[:-1])
2497
2498
(gnutls.library.functions
2499
.gnutls_global_set_log_function(debug_gnutls))
2500
3235
log.debug("GnuTLS: %s",
3236
string[:-1].decode("utf-8", errors="replace"))
3237
3238
gnutls.global_set_log_function(debug_gnutls)
3239
2501
3240
# Redirect stdin so all checkers get /dev/null
2502
3241
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2503
3242
os.dup2(null, sys.stdin.fileno())
2504
3243
if null > 2:
2505
3244
os.close(null)
2506
3245
2507
3246
# Need to fork before connecting to D-Bus
2508
3247
if not foreground:
2509
3248
# Close all input and output, do double fork, etc.
2510
3249
daemon()
2511
2512
# multiprocessing will use threads, so before we use gobject we
2513
# need to inform gobject that threads will be used.
2514
gobject.threads_init()
2515
3250
3251
if gi.version_info < (3, 10, 2):
3252
# multiprocessing will use threads, so before we use GLib we
3253
# need to inform GLib that threads will be used.
3254
GLib.threads_init()
3255
2516
3256
global main_loop
2517
3257
# From the Avahi example code
2518
3258
DBusGMainLoop(set_as_default=True)
2519
main_loop = gobject.MainLoop()
2520
bus = dbus.SystemBus()
3259
main_loop = GLib.MainLoop()
3260
if use_dbus or zeroconf:
3261
bus = dbus.SystemBus()
2521
3262
# End of Avahi example code
2522
3263
if use_dbus:
2523
3264
try:
2524
3265
bus_name = dbus.service.BusName("se.recompile.Mandos",
2525
bus, do_not_queue=True)
2526
old_bus_name = (dbus.service.BusName
2527
("se.bsnet.fukt.Mandos", bus,
2528
do_not_queue=True))
2529
except dbus.exceptions.NameExistsException as e:
2530
logger.error("Disabling D-Bus:", exc_info=e)
3266
bus,
3267
do_not_queue=True)
3268
old_bus_name = dbus.service.BusName(
3269
"se.bsnet.fukt.Mandos", bus,
3270
do_not_queue=True)
3271
except dbus.exceptions.DBusException as e:
3272
log.error("Disabling D-Bus:", exc_info=e)
2531
3273
use_dbus = False
2532
3274
server_settings["use_dbus"] = False
2533
3275
tcp_server.use_dbus = False
2534
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2535
service = AvahiServiceToSyslog(name =
2536
server_settings["servicename"],
2537
servicetype = "_mandos._tcp",
2538
protocol = protocol, bus = bus)
2539
if server_settings["interface"]:
2540
service.interface = (if_nametoindex
2541
(str(server_settings["interface"])))
2542
3276
if zeroconf:
3277
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3278
service = AvahiServiceToSyslog(
3279
name=server_settings["servicename"],
3280
servicetype="_mandos._tcp",
3281
protocol=protocol,
3282
bus=bus)
3283
if server_settings["interface"]:
3284
service.interface = if_nametoindex(
3285
server_settings["interface"].encode("utf-8"))
3286
2543
3287
global multiprocessing_manager
2544
3288
multiprocessing_manager = multiprocessing.Manager()
2545
3289
2546
3290
client_class = Client
2547
3291
if use_dbus:
2548
client_class = functools.partial(ClientDBus, bus = bus)
2549
3292
client_class = functools.partial(ClientDBus, bus=bus)
3293
2550
3294
client_settings = Client.config_parser(client_config)
2551
3295
old_client_settings = {}
2552
3296
clients_data = {}
2553
3297
2554
3298
# This is used to redirect stdout and stderr for checker processes
2555
3299
global wnull
2556
wnull = open(os.devnull, "w") # A writable /dev/null
3300
wnull = open(os.devnull, "w") # A writable /dev/null
2557
3301
# Only used if server is running in foreground but not in debug
2558
3302
# mode
2559
3303
if debug or not foreground:
2560
3304
wnull.close()
2561
3305
2562
3306
# Get client data and settings from last running state.
2563
3307
if server_settings["restore"]:
2564
3308
try:
2565
3309
with open(stored_state_path, "rb") as stored_state:
2566
clients_data, old_client_settings = (pickle.load
2567
(stored_state))
3310
if sys.version_info.major == 2:
3311
clients_data, old_client_settings = pickle.load(
3312
stored_state)
3313
else:
3314
bytes_clients_data, bytes_old_client_settings = (
3315
pickle.load(stored_state, encoding="bytes"))
3316
# Fix bytes to strings
3317
# clients_data
3318
# .keys()
3319
clients_data = {(key.decode("utf-8")
3320
if isinstance(key, bytes)
3321
else key): value
3322
for key, value in
3323
bytes_clients_data.items()}
3324
del bytes_clients_data
3325
for key in clients_data:
3326
value = {(k.decode("utf-8")
3327
if isinstance(k, bytes) else k): v
3328
for k, v in
3329
clients_data[key].items()}
3330
clients_data[key] = value
3331
# .client_structure
3332
value["client_structure"] = [
3333
(s.decode("utf-8")
3334
if isinstance(s, bytes)
3335
else s) for s in
3336
value["client_structure"]]
3337
# .name, .host, and .checker_command
3338
for k in ("name", "host", "checker_command"):
3339
if isinstance(value[k], bytes):
3340
value[k] = value[k].decode("utf-8")
3341
if "key_id" not in value:
3342
value["key_id"] = ""
3343
elif "fingerprint" not in value:
3344
value["fingerprint"] = ""
3345
# old_client_settings
3346
# .keys()
3347
old_client_settings = {
3348
(key.decode("utf-8")
3349
if isinstance(key, bytes)
3350
else key): value
3351
for key, value in
3352
bytes_old_client_settings.items()}
3353
del bytes_old_client_settings
3354
# .host and .checker_command
3355
for value in old_client_settings.values():
3356
for attribute in ("host", "checker_command"):
3357
if isinstance(value[attribute], bytes):
3358
value[attribute] = (value[attribute]
3359
.decode("utf-8"))
2568
3360
os.remove(stored_state_path)
2569
3361
except IOError as e:
2570
3362
if e.errno == errno.ENOENT:
2571
logger.warning("Could not load persistent state: {0}"
2572
.format(os.strerror(e.errno)))
3363
log.warning("Could not load persistent state:"
3364
" %s", os.strerror(e.errno))
2573
3365
else:
2574
logger.critical("Could not load persistent state:",
2575
exc_info=e)
3366
log.critical("Could not load persistent state:",
3367
exc_info=e)
2576
3368
raise
2577
3369
except EOFError as e:
2578
logger.warning("Could not load persistent state: "
2579
"EOFError:", exc_info=e)
2580
3370
log.warning("Could not load persistent state: EOFError:",
3371
exc_info=e)
3372
2581
3373
with PGPEngine() as pgp:
2582
for client_name, client in clients_data.iteritems():
3374
for client_name, client in clients_data.items():
2583
3375
# Skip removed clients
2584
3376
if client_name not in client_settings:
2585
3377
continue
2586
3378
2587
3379
# Decide which value to use after restoring saved state.
2588
3380
# We have three different values: Old config file,
2589
3381
# new config file, and saved state.
2594
3386
# For each value in new config, check if it
2595
3387
# differs from the old config value (Except for
2596
3388
# the "secret" attribute)
2597
if (name != "secret" and
2598
value != old_client_settings[client_name]
2599
[name]):
3389
if (name != "secret"
3390
and (value !=
3391
old_client_settings[client_name][name])):
2600
3392
client[name] = value
2601
3393
except KeyError:
2602
3394
pass
2603
3395
2604
3396
# Clients who has passed its expire date can still be
2605
# enabled if its last checker was successful. Clients
3397
# enabled if its last checker was successful. A Client
2606
3398
# whose checker succeeded before we stored its state is
2607
3399
# assumed to have successfully run all checkers during
2608
3400
# downtime.
2609
3401
if client["enabled"]:
2610
3402
if datetime.datetime.utcnow() >= client["expires"]:
2611
3403
if not client["last_checked_ok"]:
2612
logger.warning(
2613
"disabling client {0} - Client never "
2614
"performed a successful checker"
2615
.format(client_name))
3404
log.warning("disabling client %s - Client"
3405
" never performed a successful"
3406
" checker", client_name)
2616
3407
client["enabled"] = False
2617
3408
elif client["last_checker_status"] != 0:
2618
logger.warning(
2619
"disabling client {0} - Client "
2620
"last checker failed with error code {1}"
2621
.format(client_name,
2622
client["last_checker_status"]))
3409
log.warning("disabling client %s - Client"
3410
" last checker failed with error"
3411
" code %s", client_name,
3412
client["last_checker_status"])
2623
3413
client["enabled"] = False
2624
3414
else:
2625
client["expires"] = (datetime.datetime
2626
.utcnow()
2627
+ client["timeout"])
2628
logger.debug("Last checker succeeded,"
2629
" keeping {0} enabled"
2630
.format(client_name))
3415
client["expires"] = (
3416
datetime.datetime.utcnow()
3417
+ client["timeout"])
3418
log.debug("Last checker succeeded, keeping %s"
3419
" enabled", client_name)
2631
3420
try:
2632
client["secret"] = (
2633
pgp.decrypt(client["encrypted_secret"],
2634
client_settings[client_name]
2635
["secret"]))
3421
client["secret"] = pgp.decrypt(
3422
client["encrypted_secret"],
3423
client_settings[client_name]["secret"])
2636
3424
except PGPError:
2637
3425
# If decryption fails, we use secret from new settings
2638
logger.debug("Failed to decrypt {0} old secret"
2639
.format(client_name))
2640
client["secret"] = (
2641
client_settings[client_name]["secret"])
2642
3426
log.debug("Failed to decrypt %s old secret",
3427
client_name)
3428
client["secret"] = (client_settings[client_name]
3429
["secret"])
3430
2643
3431
# Add/remove clients based on new changes made to config
2644
3432
for client_name in (set(old_client_settings)
2645
3433
- set(client_settings)):
2647
3435
for client_name in (set(client_settings)
2648
3436
- set(old_client_settings)):
2649
3437
clients_data[client_name] = client_settings[client_name]
2650
3438
2651
3439
# Create all client objects
2652
for client_name, client in clients_data.iteritems():
3440
for client_name, client in clients_data.items():
2653
3441
tcp_server.clients[client_name] = client_class(
2654
name = client_name, settings = client,
2655
server_settings = server_settings)
2656
3442
name=client_name,
3443
settings=client,
3444
server_settings=server_settings)
3445
2657
3446
if not tcp_server.clients:
2658
logger.warning("No clients defined")
2659
3447
log.warning("No clients defined")
3448
2660
3449
if not foreground:
2661
3450
if pidfile is not None:
3451
pid = os.getpid()
2662
3452
try:
2663
3453
with pidfile:
2664
pid = os.getpid()
2665
pidfile.write(str(pid) + "\n".encode("utf-8"))
3454
print(pid, file=pidfile)
2666
3455
except IOError:
2667
logger.error("Could not write to file %r with PID %d",
2668
pidfilename, pid)
3456
log.error("Could not write to file %r with PID %d",
3457
pidfilename, pid)
2669
3458
del pidfile
2670
3459
del pidfilename
2671
2672
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2673
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2674
3460
3461
for termsig in (signal.SIGHUP, signal.SIGTERM):
3462
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3463
lambda: main_loop.quit() and False)
3464
2675
3465
if use_dbus:
2676
@alternate_dbus_interfaces({"se.recompile.Mandos":
2677
"se.bsnet.fukt.Mandos"})
2678
class MandosDBusService(DBusObjectWithProperties):
3466
3467
@alternate_dbus_interfaces(
3468
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3469
class MandosDBusService(DBusObjectWithObjectManager):
2679
3470
"""A D-Bus proxy object"""
3471
2680
3472
def __init__(self):
2681
3473
dbus.service.Object.__init__(self, bus, "/")
3474
2682
3475
_interface = "se.recompile.Mandos"
2683
2684
@dbus_interface_annotations(_interface)
2685
def _foo(self):
2686
return { "org.freedesktop.DBus.Property"
2687
".EmitsChangedSignal":
2688
"false"}
2689
3476
2690
3477
@dbus.service.signal(_interface, signature="o")
2691
3478
def ClientAdded(self, objpath):
2692
3479
"D-Bus signal"
2693
3480
pass
2694
3481
2695
3482
@dbus.service.signal(_interface, signature="ss")
2696
def ClientNotFound(self, fingerprint, address):
3483
def ClientNotFound(self, key_id, address):
2697
3484
"D-Bus signal"
2698
3485
pass
2699
3486
3487
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3488
"true"})
2700
3489
@dbus.service.signal(_interface, signature="os")
2701
3490
def ClientRemoved(self, objpath, name):
2702
3491
"D-Bus signal"
2703
3492
pass
2704
3493
3494
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3495
"true"})
2705
3496
@dbus.service.method(_interface, out_signature="ao")
2706
3497
def GetAllClients(self):
2707
3498
"D-Bus method"
2708
return dbus.Array(c.dbus_object_path
2709
for c in
2710
tcp_server.clients.itervalues())
2711
3499
return dbus.Array(c.dbus_object_path for c in
3500
tcp_server.clients.values())
3501
3502
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3503
"true"})
2712
3504
@dbus.service.method(_interface,
2713
3505
out_signature="a{oa{sv}}")
2714
3506
def GetAllClientsWithProperties(self):
2715
3507
"D-Bus method"
2716
3508
return dbus.Dictionary(
2717
((c.dbus_object_path, c.GetAll(""))
2718
for c in tcp_server.clients.itervalues()),
3509
{c.dbus_object_path: c.GetAll(
3510
"se.recompile.Mandos.Client")
3511
for c in tcp_server.clients.values()},
2719
3512
signature="oa{sv}")
2720
3513
2721
3514
@dbus.service.method(_interface, in_signature="o")
2722
3515
def RemoveClient(self, object_path):
2723
3516
"D-Bus method"
2724
for c in tcp_server.clients.itervalues():
3517
for c in tcp_server.clients.values():
2725
3518
if c.dbus_object_path == object_path:
2726
3519
del tcp_server.clients[c.name]
2727
3520
c.remove_from_connection()
2728
# Don't signal anything except ClientRemoved
3521
# Don't signal the disabling
2729
3522
c.disable(quiet=True)
2730
# Emit D-Bus signal
2731
self.ClientRemoved(object_path, c.name)
3523
# Emit D-Bus signal for removal
3524
self.client_removed_signal(c)
2732
3525
return
2733
3526
raise KeyError(object_path)
2734
3527
2735
3528
del _interface
2736
3529
3530
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3531
out_signature="a{oa{sa{sv}}}")
3532
def GetManagedObjects(self):
3533
"""D-Bus method"""
3534
return dbus.Dictionary(
3535
{client.dbus_object_path:
3536
dbus.Dictionary(
3537
{interface: client.GetAll(interface)
3538
for interface in
3539
client._get_all_interface_names()})
3540
for client in tcp_server.clients.values()})
3541
3542
def client_added_signal(self, client):
3543
"""Send the new standard signal and the old signal"""
3544
if use_dbus:
3545
# New standard signal
3546
self.InterfacesAdded(
3547
client.dbus_object_path,
3548
dbus.Dictionary(
3549
{interface: client.GetAll(interface)
3550
for interface in
3551
client._get_all_interface_names()}))
3552
# Old signal
3553
self.ClientAdded(client.dbus_object_path)
3554
3555
def client_removed_signal(self, client):
3556
"""Send the new standard signal and the old signal"""
3557
if use_dbus:
3558
# New standard signal
3559
self.InterfacesRemoved(
3560
client.dbus_object_path,
3561
client._get_all_interface_names())
3562
# Old signal
3563
self.ClientRemoved(client.dbus_object_path,
3564
client.name)
3565
2737
3566
mandos_dbus_service = MandosDBusService()
2738
3567
3568
# Save modules to variables to exempt the modules from being
3569
# unloaded before the function registered with atexit() is run.
3570
mp = multiprocessing
3571
wn = wnull
3572
2739
3573
def cleanup():
2740
3574
"Cleanup function; run on exit"
2741
service.cleanup()
2742
2743
multiprocessing.active_children()
2744
wnull.close()
3575
if zeroconf:
3576
service.cleanup()
3577
3578
mp.active_children()
3579
wn.close()
2745
3580
if not (tcp_server.clients or client_settings):
2746
3581
return
2747
3582
2748
3583
# Store client before exiting. Secrets are encrypted with key
2749
3584
# based on what config file has. If config file is
2750
3585
# removed/edited, old secret will thus be unrecovable.
2751
3586
clients = {}
2752
3587
with PGPEngine() as pgp:
2753
for client in tcp_server.clients.itervalues():
3588
for client in tcp_server.clients.values():
2754
3589
key = client_settings[client.name]["secret"]
2755
3590
client.encrypted_secret = pgp.encrypt(client.secret,
2756
3591
key)
2757
3592
client_dict = {}
2758
3593
2759
3594
# A list of attributes that can not be pickled
2760
3595
# + secret.
2761
exclude = set(("bus", "changedstate", "secret",
2762
"checker", "server_settings"))
2763
for name, typ in (inspect.getmembers
2764
(dbus.service.Object)):
3596
exclude = {"bus", "changedstate", "secret",
3597
"checker", "server_settings"}
3598
for name, typ in inspect.getmembers(dbus.service
3599
.Object):
2765
3600
exclude.add(name)
2766
3601
2767
3602
client_dict["encrypted_secret"] = (client
2768
3603
.encrypted_secret)
2769
3604
for attr in client.client_structure:
2770
3605
if attr not in exclude:
2771
3606
client_dict[attr] = getattr(client, attr)
2772
3607
2773
3608
clients[client.name] = client_dict
2774
3609
del client_settings[client.name]["secret"]
2775
3610
2776
3611
try:
2777
with (tempfile.NamedTemporaryFile
2778
(mode='wb', suffix=".pickle", prefix='clients-',
2779
dir=os.path.dirname(stored_state_path),
2780
delete=False)) as stored_state:
2781
pickle.dump((clients, client_settings), stored_state)
2782
tempname=stored_state.name
3612
with tempfile.NamedTemporaryFile(
3613
mode="wb",
3614
suffix=".pickle",
3615
prefix="clients-",
3616
dir=os.path.dirname(stored_state_path),
3617
delete=False) as stored_state:
3618
pickle.dump((clients, client_settings), stored_state,
3619
protocol=2)
3620
tempname = stored_state.name
2783
3621
os.rename(tempname, stored_state_path)
2784
3622
except (IOError, OSError) as e:
2785
3623
if not debug:
2788
3626
except NameError:
2789
3627
pass
2790
3628
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
2791
logger.warning("Could not save persistent state: {0}"
2792
.format(os.strerror(e.errno)))
3629
log.warning("Could not save persistent state: %s",
3630
os.strerror(e.errno))
2793
3631
else:
2794
logger.warning("Could not save persistent state:",
2795
exc_info=e)
3632
log.warning("Could not save persistent state:",
3633
exc_info=e)
2796
3634
raise
2797
3635
2798
3636
# Delete all clients, and settings from config
2799
3637
while tcp_server.clients:
2800
3638
name, client = tcp_server.clients.popitem()
2801
3639
if use_dbus:
2802
3640
client.remove_from_connection()
2803
# Don't signal anything except ClientRemoved
3641
# Don't signal the disabling
2804
3642
client.disable(quiet=True)
3643
# Emit D-Bus signal for removal
2805
3644
if use_dbus:
2806
# Emit D-Bus signal
2807
mandos_dbus_service.ClientRemoved(client
2808
.dbus_object_path,
2809
client.name)
3645
mandos_dbus_service.client_removed_signal(client)
2810
3646
client_settings.clear()
2811
3647
2812
3648
atexit.register(cleanup)
2813
2814
for client in tcp_server.clients.itervalues():
3649
3650
for client in tcp_server.clients.values():
2815
3651
if use_dbus:
2816
# Emit D-Bus signal
2817
mandos_dbus_service.ClientAdded(client.dbus_object_path)
3652
# Emit D-Bus signal for adding
3653
mandos_dbus_service.client_added_signal(client)
2818
3654
# Need to initiate checking of clients
2819
3655
if client.enabled:
2820
client.init_checker()
2821
3656
client.init_checker(randomize_start=True)
3657
2822
3658
tcp_server.enable()
2823
3659
tcp_server.server_activate()
2824
3660
2825
3661
# Find out what port we got
2826
service.port = tcp_server.socket.getsockname()[1]
3662
if zeroconf:
3663
service.port = tcp_server.socket.getsockname()[1]
2827
3664
if use_ipv6:
2828
logger.info("Now listening on address %r, port %d,"
2829
" flowinfo %d, scope_id %d",
2830
*tcp_server.socket.getsockname())
3665
log.info("Now listening on address %r, port %d, flowinfo %d,"
3666
" scope_id %d", *tcp_server.socket.getsockname())
2831
3667
else: # IPv4
2832
logger.info("Now listening on address %r, port %d",
2833
*tcp_server.socket.getsockname())
2834
2835
#service.interface = tcp_server.socket.getsockname()[3]
2836
3668
log.info("Now listening on address %r, port %d",
3669
*tcp_server.socket.getsockname())
3670
3671
# service.interface = tcp_server.socket.getsockname()[3]
3672
2837
3673
try:
2838
# From the Avahi example code
2839
try:
2840
service.activate()
2841
except dbus.exceptions.DBusException as error:
2842
logger.critical("D-Bus Exception", exc_info=error)
2843
cleanup()
2844
sys.exit(1)
2845
# End of Avahi example code
2846
2847
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2848
lambda *args, **kwargs:
2849
(tcp_server.handle_request
2850
(*args[2:], **kwargs) or True))
2851
2852
logger.debug("Starting main loop")
3674
if zeroconf:
3675
# From the Avahi example code
3676
try:
3677
service.activate()
3678
except dbus.exceptions.DBusException as error:
3679
log.critical("D-Bus Exception", exc_info=error)
3680
cleanup()
3681
sys.exit(1)
3682
# End of Avahi example code
3683
3684
GLib.io_add_watch(
3685
GLib.IOChannel.unix_new(tcp_server.fileno()),
3686
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
3687
lambda *args, **kwargs: (tcp_server.handle_request
3688
(*args[2:], **kwargs) or True))
3689
3690
log.debug("Starting main loop")
2853
3691
main_loop.run()
2854
3692
except AvahiError as error:
2855
logger.critical("Avahi Error", exc_info=error)
3693
log.critical("Avahi Error", exc_info=error)
2856
3694
cleanup()
2857
3695
sys.exit(1)
2858
3696
except KeyboardInterrupt:
2859
3697
if debug:
2860
3698
print("", file=sys.stderr)
2861
logger.debug("Server received KeyboardInterrupt")
2862
logger.debug("Server exiting")
3699
log.debug("Server received KeyboardInterrupt")
3700
log.debug("Server exiting")
2863
3701
# Must run before the D-Bus bus name gets deregistered
2864
3702
cleanup()
2865
3703
2866
if __name__ == '__main__':
2867
main()
3704
3705
def parse_test_args():
3706
# type: () -> argparse.Namespace
3707
parser = argparse.ArgumentParser(add_help=False)
3708
parser.add_argument("--check", action="store_true")
3709
parser.add_argument("--prefix", )
3710
args, unknown_args = parser.parse_known_args()
3711
if args.check:
3712
# Remove test options from sys.argv
3713
sys.argv[1:] = unknown_args
3714
return args
3715
3716
# Add all tests from doctest strings
3717
def load_tests(loader, tests, none):
3718
import doctest
3719
tests.addTests(doctest.DocTestSuite())
3720
return tests
3721
3722
if __name__ == "__main__":
3723
options = parse_test_args()
3724
try:
3725
if options.check:
3726
extra_test_prefix = options.prefix
3727
if extra_test_prefix is not None:
3728
if not (unittest.main(argv=[""], exit=False)
3729
.result.wasSuccessful()):
3730
sys.exit(1)
3731
class ExtraTestLoader(unittest.TestLoader):
3732
testMethodPrefix = extra_test_prefix
3733
# Call using ./scriptname --test [--verbose]
3734
unittest.main(argv=[""], testLoader=ExtraTestLoader())
3735
else:
3736
unittest.main(argv=[""])
3737
else:
3738
main()
3739
finally:
3740
logging.shutdown()
3741
3742
# Local Variables:
3743
# run-tests:
3744
# (lambda (&optional extra)
3745
# (if (not (funcall run-tests-in-test-buffer default-directory
3746
# extra))
3747
# (funcall show-test-buffer-in-test-window)
3748
# (funcall remove-test-window)
3749
# (if extra (message "Extra tests run successfully!"))))
3750
# run-tests-in-test-buffer:
3751
# (lambda (dir &optional extra)
3752
# (with-current-buffer (get-buffer-create "*Test*")
3753
# (setq buffer-read-only nil
3754
# default-directory dir)
3755
# (erase-buffer)
3756
# (compilation-mode))
3757
# (let ((process-result
3758
# (let ((inhibit-read-only t))
3759
# (process-file-shell-command
3760
# (funcall get-command-line extra) nil "*Test*"))))
3761
# (and (numberp process-result)
3762
# (= process-result 0))))
3763
# get-command-line:
3764
# (lambda (&optional extra)
3765
# (let ((quoted-script
3766
# (shell-quote-argument (funcall get-script-name))))
3767
# (format
3768
# (concat "%s --check" (if extra " --prefix=atest" ""))
3769
# quoted-script)))
3770
# get-script-name:
3771
# (lambda ()
3772
# (if (fboundp 'file-local-name)
3773
# (file-local-name (buffer-file-name))
3774
# (or (file-remote-p (buffer-file-name) 'localname)
3775
# (buffer-file-name))))
3776
# remove-test-window:
3777
# (lambda ()
3778
# (let ((test-window (get-buffer-window "*Test*")))
3779
# (if test-window (delete-window test-window))))
3780
# show-test-buffer-in-test-window:
3781
# (lambda ()
3782
# (when (not (get-buffer-window-list "*Test*"))
3783
# (setq next-error-last-buffer (get-buffer "*Test*"))
3784
# (let* ((side (if (>= (window-width) 146) 'right 'bottom))
3785
# (display-buffer-overriding-action
3786
# `((display-buffer-in-side-window) (side . ,side)
3787
# (window-height . fit-window-to-buffer)
3788
# (window-width . fit-window-to-buffer))))
3789
# (display-buffer "*Test*"))))
3790
# eval:
3791
# (progn
3792
# (let* ((run-extra-tests (lambda () (interactive)
3793
# (funcall run-tests t)))
3794
# (inner-keymap `(keymap (116 . ,run-extra-tests))) ; t
3795
# (outer-keymap `(keymap (3 . ,inner-keymap)))) ; C-c
3796
# (setq minor-mode-overriding-map-alist
3797
# (cons `(run-tests . ,outer-keymap)
3798
# minor-mode-overriding-map-alist)))
3799
# (add-hook 'after-save-hook run-tests 90 t))
3800
# End:
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0