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