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