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 585
- compare with another revision
- download diff
- download tarball
- view history from revision 585
- Committer: Teddy Hogeborn
- Date: 2012-05-17 01:55:58 UTC
- Revision ID: teddy@recompile.se-20120517015558-5703p8nkquc2rhgd
* .bzrignore (statedir): Added.
- files removed:
- debian/mandos-client.examples
- debian/upstream
- plugin-helpers
- files modified:
- DBUS-API
added
removed
mandos
11
11
# "AvahiService" class, and some lines in "main".
12
12
#
13
13
# Everything else is
14
# Copyright © 2008-2016 Teddy Hogeborn
15
# Copyright © 2008-2016 Björn Påhlsson
14
# Copyright © 2008-2012 Teddy Hogeborn
15
# Copyright © 2008-2012 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
try:
40
import SocketServer as socketserver
41
except ImportError:
42
import socketserver
39
import SocketServer as socketserver
43
40
import socket
44
41
import argparse
45
42
import datetime
46
43
import errno
47
try:
48
import ConfigParser as configparser
49
except ImportError:
50
import configparser
44
import gnutls.crypto
45
import gnutls.connection
46
import gnutls.errors
47
import gnutls.library.functions
48
import gnutls.library.constants
49
import gnutls.library.types
50
import ConfigParser as configparser
51
51
import sys
52
52
import re
53
53
import os
62
62
import struct
63
63
import fcntl
64
64
import functools
65
try:
66
import cPickle as pickle
67
except ImportError:
68
import pickle
65
import cPickle as pickle
69
66
import multiprocessing
70
67
import types
71
68
import binascii
72
69
import tempfile
73
70
import itertools
74
import collections
75
import codecs
76
71
77
72
import dbus
78
73
import dbus.service
79
try:
80
import gobject
81
except ImportError:
82
from gi.repository import GObject as gobject
74
import gobject
83
75
import avahi
84
76
from dbus.mainloop.glib import DBusGMainLoop
85
77
import ctypes
86
78
import ctypes.util
87
79
import xml.dom.minidom
88
80
import inspect
81
import GnuPGInterface
89
82
90
83
try:
91
84
SO_BINDTODEVICE = socket.SO_BINDTODEVICE
95
88
except ImportError:
96
89
SO_BINDTODEVICE = None
97
90
98
if sys.version_info.major == 2:
99
str = unicode
100
101
version = "1.7.1"
91
version = "1.5.3"
102
92
stored_state_file = "clients.pickle"
103
93
104
94
logger = logging.getLogger()
105
syslogger = None
95
syslogger = (logging.handlers.SysLogHandler
96
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
97
address = str("/dev/log")))
106
98
107
99
try:
108
if_nametoindex = ctypes.cdll.LoadLibrary(
109
ctypes.util.find_library("c")).if_nametoindex
100
if_nametoindex = (ctypes.cdll.LoadLibrary
101
(ctypes.util.find_library("c"))
102
.if_nametoindex)
110
103
except (OSError, AttributeError):
111
112
104
def if_nametoindex(interface):
113
105
"Get an interface index the hard way, i.e. using fcntl()"
114
106
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
115
107
with contextlib.closing(socket.socket()) as s:
116
108
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
117
struct.pack(b"16s16x", interface))
118
interface_index = struct.unpack("I", ifreq[16:20])[0]
109
struct.pack(str("16s16x"),
110
interface))
111
interface_index = struct.unpack(str("I"),
112
ifreq[16:20])[0]
119
113
return interface_index
120
114
121
115
122
116
def initlogger(debug, level=logging.WARNING):
123
117
"""init logger and add loglevel"""
124
118
125
global syslogger
126
syslogger = (logging.handlers.SysLogHandler(
127
facility = logging.handlers.SysLogHandler.LOG_DAEMON,
128
address = "/dev/log"))
129
119
syslogger.setFormatter(logging.Formatter
130
120
('Mandos [%(process)d]: %(levelname)s:'
131
121
' %(message)s'))
148
138
149
139
class PGPEngine(object):
150
140
"""A simple class for OpenPGP symmetric encryption & decryption"""
151
152
141
def __init__(self):
142
self.gnupg = GnuPGInterface.GnuPG()
153
143
self.tempdir = tempfile.mkdtemp(prefix="mandos-")
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']
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'])
170
150
171
151
def __enter__(self):
172
152
return self
173
153
174
def __exit__(self, exc_type, exc_value, traceback):
154
def __exit__ (self, exc_type, exc_value, traceback):
175
155
self._cleanup()
176
156
return False
177
157
194
174
def password_encode(self, password):
195
175
# Passphrase can not be empty and can not contain newlines or
196
176
# NUL bytes. So we prefix it and hex encode it.
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
177
return b"mandos" + binascii.hexlify(password)
204
178
205
179
def encrypt(self, data, password):
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)
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
221
194
return ciphertext
222
195
223
196
def decrypt(self, data, password):
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)
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
239
211
return decrypted_plaintext
240
212
241
213
242
214
class AvahiError(Exception):
243
215
def __init__(self, value, *args, **kwargs):
244
216
self.value = value
245
return super(AvahiError, self).__init__(value, *args,
246
**kwargs)
247
217
super(AvahiError, self).__init__(value, *args, **kwargs)
218
def __unicode__(self):
219
return unicode(repr(self.value))
248
220
249
221
class AvahiServiceError(AvahiError):
250
222
pass
251
223
252
253
224
class AvahiGroupError(AvahiError):
254
225
pass
255
226
262
233
Used to optionally bind to the specified interface.
263
234
name: string; Example: 'Mandos'
264
235
type: string; Example: '_mandos._tcp'.
265
See <https://www.iana.org/assignments/service-names-port-numbers>
236
See <http://www.dns-sd.org/ServiceTypes.html>
266
237
port: integer; what port to announce
267
238
TXT: list of strings; TXT record for the service
268
239
domain: string; Domain to publish on, default to .local if empty.
275
246
bus: dbus.SystemBus()
276
247
"""
277
248
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):
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):
289
253
self.interface = interface
290
254
self.name = name
291
255
self.type = servicetype
301
265
self.bus = bus
302
266
self.entry_group_state_changed_match = None
303
267
304
def rename(self, remove=True):
268
def rename(self):
305
269
"""Derived from the Avahi example code"""
306
270
if self.rename_count >= self.max_renames:
307
271
logger.critical("No suitable Zeroconf service name found"
308
272
" after %i retries, exiting.",
309
273
self.rename_count)
310
274
raise AvahiServiceError("Too many renames")
311
self.name = str(
312
self.server.GetAlternativeServiceName(self.name))
313
self.rename_count += 1
275
self.name = unicode(self.server
276
.GetAlternativeServiceName(self.name))
314
277
logger.info("Changing Zeroconf service name to %r ...",
315
278
self.name)
316
if remove:
317
self.remove()
279
self.remove()
318
280
try:
319
281
self.add()
320
282
except dbus.exceptions.DBusException as error:
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)
283
logger.critical("D-Bus Exception", exc_info=error)
284
self.cleanup()
285
os._exit(1)
286
self.rename_count += 1
329
287
330
288
def remove(self):
331
289
"""Derived from the Avahi example code"""
369
327
self.rename()
370
328
elif state == avahi.ENTRY_GROUP_FAILURE:
371
329
logger.critical("Avahi: Error in group state changed %s",
372
str(error))
373
raise AvahiGroupError("State changed: {!s}".format(error))
330
unicode(error))
331
raise AvahiGroupError("State changed: {0!s}"
332
.format(error))
374
333
375
334
def cleanup(self):
376
335
"""Derived from the Avahi example code"""
386
345
def server_state_changed(self, state, error=None):
387
346
"""Derived from the Avahi example code"""
388
347
logger.debug("Avahi server state change: %i", state)
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
}
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" }
395
355
if state in bad_states:
396
356
if bad_states[state] is not None:
397
357
if error is None:
400
360
logger.error(bad_states[state] + ": %r", error)
401
361
self.cleanup()
402
362
elif state == avahi.SERVER_RUNNING:
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)
363
self.add()
415
364
else:
416
365
if error is None:
417
366
logger.debug("Unknown state: %r", state)
427
376
follow_name_owner_changes=True),
428
377
avahi.DBUS_INTERFACE_SERVER)
429
378
self.server.connect_to_signal("StateChanged",
430
self.server_state_changed)
379
self.server_state_changed)
431
380
self.server_state_changed(self.server.GetState())
432
381
433
382
434
383
class AvahiServiceToSyslog(AvahiService):
435
def rename(self, *args, **kwargs):
384
def rename(self):
436
385
"""Add the new name to the syslog messages"""
437
ret = AvahiService.rename(self, *args, **kwargs)
438
syslogger.setFormatter(logging.Formatter(
439
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
440
.format(self.name)))
386
ret = AvahiService.rename(self)
387
syslogger.setFormatter(logging.Formatter
388
('Mandos ({0}) [%(process)d]:'
389
' %(levelname)s: %(message)s'
390
.format(self.name)))
441
391
return ret
442
392
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()
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
707
400
708
401
class Client(object):
709
402
"""A representation of a client host served by this server.
736
429
last_checker_status: integer between 0 and 255 reflecting exit
737
430
status of last checker. -1 reflects crashed
738
431
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
741
432
last_enabled: datetime.datetime(); (UTC) or None
742
433
name: string; from the config file, used in log messages and
743
434
D-Bus identifiers
748
439
runtime_expansions: Allowed attributes for runtime expansion.
749
440
expires: datetime.datetime(); time (UTC) when a client will be
750
441
disabled, or None
751
server_settings: The server_settings dict from main()
752
442
"""
753
443
754
444
runtime_expansions = ("approval_delay", "approval_duration",
756
446
"fingerprint", "host", "interval",
757
447
"last_approval_request", "last_checked_ok",
758
448
"last_enabled", "name", "timeout")
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
}
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)
770
474
771
475
@staticmethod
772
476
def config_parser(config):
788
492
client["enabled"] = config.getboolean(client_name,
789
493
"enabled")
790
494
791
# Uppercase and remove spaces from fingerprint for later
792
# comparison purposes with return value from the
793
# fingerprint() function
794
495
client["fingerprint"] = (section["fingerprint"].upper()
795
496
.replace(" ", ""))
796
497
if "secret" in section:
801
502
"rb") as secfile:
802
503
client["secret"] = secfile.read()
803
504
else:
804
raise TypeError("No secret or secfile for section {}"
505
raise TypeError("No secret or secfile for section {0}"
805
506
.format(section))
806
507
client["timeout"] = string_to_delta(section["timeout"])
807
508
client["extended_timeout"] = string_to_delta(
818
519
819
520
return settings
820
521
821
def __init__(self, settings, name = None, server_settings=None):
522
def __init__(self, settings, name = None):
822
523
self.name = name
823
if server_settings is None:
824
server_settings = {}
825
self.server_settings = server_settings
826
524
# adding all client settings
827
for setting, value in settings.items():
525
for setting, value in settings.iteritems():
828
526
setattr(self, setting, value)
829
527
830
528
if self.enabled:
838
536
self.expires = None
839
537
840
538
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
841
542
logger.debug(" Fingerprint: %s", self.fingerprint)
842
543
self.created = settings.get("created",
843
544
datetime.datetime.utcnow())
850
551
self.current_checker_command = None
851
552
self.approved = None
852
553
self.approvals_pending = 0
853
self.changedstate = multiprocessing_manager.Condition(
854
multiprocessing_manager.Lock())
855
self.client_structure = [attr
856
for attr in self.__dict__.iterkeys()
554
self.changedstate = (multiprocessing_manager
555
.Condition(multiprocessing_manager
556
.Lock()))
557
self.client_structure = [attr for attr in
558
self.__dict__.iterkeys()
857
559
if not attr.startswith("_")]
858
560
self.client_structure.append("client_structure")
859
561
860
for name, t in inspect.getmembers(
861
type(self), lambda obj: isinstance(obj, property)):
562
for name, t in inspect.getmembers(type(self),
563
lambda obj:
564
isinstance(obj,
565
property)):
862
566
if not name.startswith("_"):
863
567
self.client_structure.append(name)
864
568
906
610
# and every interval from then on.
907
611
if self.checker_initiator_tag is not None:
908
612
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)
613
self.checker_initiator_tag = (gobject.timeout_add
614
(self.interval_milliseconds(),
615
self.start_checker))
912
616
# Schedule a disable() when 'timeout' has passed
913
617
if self.disable_initiator_tag is not None:
914
618
gobject.source_remove(self.disable_initiator_tag)
915
self.disable_initiator_tag = gobject.timeout_add(
916
int(self.timeout.total_seconds() * 1000), self.disable)
619
self.disable_initiator_tag = (gobject.timeout_add
620
(self.timeout_milliseconds(),
621
self.disable))
917
622
# Also start a new checker *right now*.
918
623
self.start_checker()
919
624
920
def checker_callback(self, source, condition, connection,
921
command):
625
def checker_callback(self, pid, condition, command):
922
626
"""The checker has completed, so take appropriate actions."""
923
627
self.checker_callback_tag = None
924
628
self.checker = None
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
629
if os.WIFEXITED(condition):
630
self.last_checker_status = os.WEXITSTATUS(condition)
932
631
if self.last_checker_status == 0:
933
632
logger.info("Checker for %(name)s succeeded",
934
633
vars(self))
935
634
self.checked_ok()
936
635
else:
937
logger.info("Checker for %(name)s failed", vars(self))
636
logger.info("Checker for %(name)s failed",
637
vars(self))
938
638
else:
939
639
self.last_checker_status = -1
940
self.last_checker_signal = -returncode
941
640
logger.warning("Checker for %(name)s crashed?",
942
641
vars(self))
943
return False
944
642
945
643
def checked_ok(self):
946
644
"""Assert that the client has been seen, alive and well."""
947
645
self.last_checked_ok = datetime.datetime.utcnow()
948
646
self.last_checker_status = 0
949
self.last_checker_signal = None
950
647
self.bump_timeout()
951
648
952
649
def bump_timeout(self, timeout=None):
957
654
gobject.source_remove(self.disable_initiator_tag)
958
655
self.disable_initiator_tag = None
959
656
if getattr(self, "enabled", False):
960
self.disable_initiator_tag = gobject.timeout_add(
961
int(timeout.total_seconds() * 1000), self.disable)
657
self.disable_initiator_tag = (gobject.timeout_add
658
(timedelta_to_milliseconds
659
(timeout), self.disable))
962
660
self.expires = datetime.datetime.utcnow() + timeout
963
661
964
662
def need_approval(self):
978
676
# than 'timeout' for the client to be disabled, which is as it
979
677
# should be.
980
678
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
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)
985
692
# Start a new checker if needed
986
693
if self.checker is None:
987
694
# Escape attributes for the shell
988
escaped_attrs = {
989
attr: re.escape(str(getattr(self, attr)))
990
for attr in self.runtime_expansions }
695
escaped_attrs = dict(
696
(attr, re.escape(unicode(getattr(self, attr))))
697
for attr in
698
self.runtime_expansions)
991
699
try:
992
700
command = self.checker_command % escaped_attrs
993
701
except TypeError as error:
994
702
logger.error('Could not format string "%s"',
995
self.checker_command,
703
self.checker_command, exc_info=error)
704
return True # Try again later
705
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",
996
718
exc_info=error)
997
return True # Try again later
998
self.current_checker_command = command
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)
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)
1024
729
# Re-run this periodically if run by gobject.timeout_add
1025
730
return True
1026
731
1032
737
if getattr(self, "checker", None) is None:
1033
738
return
1034
739
logger.debug("Stopping checker for %(name)s", vars(self))
1035
self.checker.terminate()
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
1036
748
self.checker = None
1037
749
1038
750
1039
def dbus_service_property(dbus_interface,
1040
signature="v",
1041
access="readwrite",
1042
byte_arrays=False):
751
def dbus_service_property(dbus_interface, signature="v",
752
access="readwrite", byte_arrays=False):
1043
753
"""Decorators for marking methods of a DBusObjectWithProperties to
1044
754
become properties on the D-Bus.
1045
755
1054
764
# "Set" method, so we fail early here:
1055
765
if byte_arrays and signature != "ay":
1056
766
raise ValueError("Byte arrays not supported for non-'ay'"
1057
" signature {!r}".format(signature))
1058
767
" signature {0!r}".format(signature))
1059
768
def decorator(func):
1060
769
func._dbus_is_property = True
1061
770
func._dbus_interface = dbus_interface
1066
775
func._dbus_name = func._dbus_name[:-14]
1067
776
func._dbus_get_args_options = {'byte_arrays': byte_arrays }
1068
777
return func
1069
1070
778
return decorator
1071
779
1072
780
1081
789
"org.freedesktop.DBus.Property.EmitsChangedSignal":
1082
790
"false"}
1083
791
"""
1084
1085
792
def decorator(func):
1086
793
func._dbus_is_interface = True
1087
794
func._dbus_interface = dbus_interface
1088
795
func._dbus_name = dbus_interface
1089
796
return func
1090
1091
797
return decorator
1092
798
1093
799
1095
801
"""Decorator to annotate D-Bus methods, signals or properties
1096
802
Usage:
1097
803
1098
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
1099
"org.freedesktop.DBus.Property."
1100
"EmitsChangedSignal": "false"})
1101
804
@dbus_service_property("org.example.Interface", signature="b",
1102
805
access="r")
806
@dbus_annotations({{"org.freedesktop.DBus.Deprecated": "true",
807
"org.freedesktop.DBus.Property."
808
"EmitsChangedSignal": "false"})
1103
809
def Property_dbus_property(self):
1104
810
return dbus.Boolean(False)
1105
1106
See also the DBusObjectWithAnnotations class.
1107
811
"""
1108
1109
812
def decorator(func):
1110
813
func._dbus_annotations = annotations
1111
814
return func
1112
1113
815
return decorator
1114
816
1115
817
1116
818
class DBusPropertyException(dbus.exceptions.DBusException):
1117
819
"""A base class for D-Bus property-related exceptions
1118
820
"""
1119
pass
821
def __unicode__(self):
822
return unicode(str(self))
1120
823
1121
824
1122
825
class DBusPropertyAccessException(DBusPropertyException):
1131
834
pass
1132
835
1133
836
1134
class DBusObjectWithAnnotations(dbus.service.Object):
1135
"""A D-Bus object with annotations.
837
class DBusObjectWithProperties(dbus.service.Object):
838
"""A D-Bus object with properties.
1136
839
1137
Classes inheriting from this can use the dbus_annotations
1138
decorator to add annotations to methods or signals.
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.
1139
843
"""
1140
844
1141
845
@staticmethod
1145
849
If called like _is_dbus_thing("method") it returns a function
1146
850
suitable for use as predicate to inspect.getmembers().
1147
851
"""
1148
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
852
return lambda obj: getattr(obj, "_dbus_is_{0}".format(thing),
1149
853
False)
1150
854
1151
855
def _get_all_dbus_things(self, thing):
1152
856
"""Returns a generator of (name, attribute) pairs
1153
857
"""
1154
return ((getattr(athing.__get__(self), "_dbus_name", name),
858
return ((getattr(athing.__get__(self), "_dbus_name",
859
name),
1155
860
athing.__get__(self))
1156
861
for cls in self.__class__.__mro__
1157
862
for name, athing in
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
"""
863
inspect.getmembers(cls,
864
self._is_dbus_thing(thing)))
1230
865
1231
866
def _get_dbus_property(self, interface_name, property_name):
1232
867
"""Returns a bound method if one exists which is a D-Bus
1233
868
property with the specified name and interface.
1234
869
"""
1235
for cls in self.__class__.__mro__:
1236
for name, value in inspect.getmembers(
1237
cls, self._is_dbus_thing("property")):
870
for cls in self.__class__.__mro__:
871
for name, value in (inspect.getmembers
872
(cls,
873
self._is_dbus_thing("property"))):
1238
874
if (value._dbus_name == property_name
1239
875
and value._dbus_interface == interface_name):
1240
876
return value.__get__(self)
1241
877
1242
878
# No such property
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",
879
raise DBusPropertyNotFound(self.dbus_object_path + ":"
880
+ interface_name + "."
881
+ property_name)
882
883
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
1257
884
out_signature="v")
1258
885
def Get(self, interface_name, property_name):
1259
886
"""Standard D-Bus property Get() method, see D-Bus standard.
1277
904
# The byte_arrays option is not supported yet on
1278
905
# signatures other than "ay".
1279
906
if prop._dbus_signature != "ay":
1280
raise ValueError("Byte arrays not supported for non-"
1281
"'ay' signature {!r}"
1282
.format(prop._dbus_signature))
907
raise ValueError
1283
908
value = dbus.ByteArray(b''.join(chr(byte)
1284
909
for byte in value))
1285
910
prop(value)
1286
911
1287
@dbus.service.method(dbus.PROPERTIES_IFACE,
1288
in_signature="s",
912
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
1289
913
out_signature="a{sv}")
1290
914
def GetAll(self, interface_name):
1291
915
"""Standard D-Bus property GetAll() method, see D-Bus
1306
930
if not hasattr(value, "variant_level"):
1307
931
properties[name] = value
1308
932
continue
1309
properties[name] = type(value)(
1310
value, variant_level = value.variant_level + 1)
933
properties[name] = type(value)(value, variant_level=
934
value.variant_level+1)
1311
935
return dbus.Dictionary(properties, signature="sv")
1312
936
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
1321
937
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1322
938
out_signature="s",
1323
939
path_keyword='object_path',
1327
943
1328
944
Inserts property tags and interface annotation tags.
1329
945
"""
1330
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1331
object_path,
1332
connection)
946
xmlstring = dbus.service.Object.Introspect(self, object_path,
947
connection)
1333
948
try:
1334
949
document = xml.dom.minidom.parseString(xmlstring)
1335
1336
950
def make_tag(document, name, prop):
1337
951
e = document.createElement("property")
1338
952
e.setAttribute("name", name)
1339
953
e.setAttribute("type", prop._dbus_signature)
1340
954
e.setAttribute("access", prop._dbus_access)
1341
955
return e
1342
1343
956
for if_tag in document.getElementsByTagName("interface"):
1344
957
# Add property tags
1345
958
for tag in (make_tag(document, name, prop)
1348
961
if prop._dbus_interface
1349
962
== if_tag.getAttribute("name")):
1350
963
if_tag.appendChild(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)
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)
1367
995
# Add the names to the return values for the
1368
996
# "org.freedesktop.DBus.Properties" methods
1369
997
if (if_tag.getAttribute("name")
1387
1015
exc_info=error)
1388
1016
return xmlstring
1389
1017
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):
1018
1019
def datetime_to_dbus (dt, variant_level=0):
1460
1020
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1461
1021
if dt is None:
1462
1022
return dbus.String("", variant_level = variant_level)
1463
return dbus.String(dt.isoformat(), variant_level=variant_level)
1023
return dbus.String(dt.isoformat(),
1024
variant_level=variant_level)
1464
1025
1465
1026
1466
1027
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1469
1030
interface names according to the "alt_interface_names" mapping.
1470
1031
Usage:
1471
1032
1472
@alternate_dbus_interfaces({"org.example.Interface":
1473
"net.example.AlternateInterface"})
1033
@alternate_dbus_names({"org.example.Interface":
1034
"net.example.AlternateInterface"})
1474
1035
class SampleDBusObject(dbus.service.Object):
1475
1036
@dbus.service.method("org.example.Interface")
1476
1037
def SampleDBusMethod():
1486
1047
(from DBusObjectWithProperties) and interfaces (from the
1487
1048
dbus_interface_annotations decorator).
1488
1049
"""
1489
1490
1050
def wrapper(cls):
1491
1051
for orig_interface_name, alt_interface_name in (
1492
alt_interface_names.items()):
1052
alt_interface_names.iteritems()):
1493
1053
attr = {}
1494
1054
interface_names = set()
1495
1055
# Go though all attributes of the class
1497
1057
# Ignore non-D-Bus attributes, and D-Bus attributes
1498
1058
# with the wrong interface name
1499
1059
if (not hasattr(attribute, "_dbus_interface")
1500
or not attribute._dbus_interface.startswith(
1501
orig_interface_name)):
1060
or not attribute._dbus_interface
1061
.startswith(orig_interface_name)):
1502
1062
continue
1503
1063
# Create an alternate D-Bus interface name based on
1504
1064
# the current name
1505
alt_interface = attribute._dbus_interface.replace(
1506
orig_interface_name, alt_interface_name)
1065
alt_interface = (attribute._dbus_interface
1066
.replace(orig_interface_name,
1067
alt_interface_name))
1507
1068
interface_names.add(alt_interface)
1508
1069
# Is this a D-Bus signal?
1509
1070
if getattr(attribute, "_dbus_is_signal", False):
1510
if sys.version_info.major == 2:
1511
# Extract the original non-method undecorated
1512
# function by black magic
1513
nonmethod_func = (dict(
1071
# Extract the original non-method function by
1072
# black magic
1073
nonmethod_func = (dict(
1514
1074
zip(attribute.func_code.co_freevars,
1515
attribute.__closure__))
1516
["func"].cell_contents)
1517
else:
1518
nonmethod_func = attribute
1075
attribute.__closure__))["func"]
1076
.cell_contents)
1519
1077
# Create a new, but exactly alike, function
1520
1078
# object, and decorate it to be a new D-Bus signal
1521
1079
# with the alternate D-Bus interface name
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))
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)))
1539
1089
# Copy annotations, if any
1540
1090
try:
1541
new_function._dbus_annotations = dict(
1542
attribute._dbus_annotations)
1091
new_function._dbus_annotations = (
1092
dict(attribute._dbus_annotations))
1543
1093
except AttributeError:
1544
1094
pass
1545
1095
# Define a creator of a function to call both the
1550
1100
"""This function is a scope container to pass
1551
1101
func1 and func2 to the "call_both" function
1552
1102
outside of its arguments"""
1553
1554
@functools.wraps(func2)
1555
1103
def call_both(*args, **kwargs):
1556
1104
"""This function will emit two D-Bus
1557
1105
signals by calling func1 and func2"""
1558
1106
func1(*args, **kwargs)
1559
1107
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
1565
1108
return call_both
1566
1109
# Create the "call_both" function and add it to
1567
1110
# the class
1572
1115
# object. Decorate it to be a new D-Bus method
1573
1116
# with the alternate D-Bus interface name. Add it
1574
1117
# to the class.
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)))
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)))
1585
1128
# Copy annotations, if any
1586
1129
try:
1587
attr[attrname]._dbus_annotations = dict(
1588
attribute._dbus_annotations)
1130
attr[attrname]._dbus_annotations = (
1131
dict(attribute._dbus_annotations))
1589
1132
except AttributeError:
1590
1133
pass
1591
1134
# Is this a D-Bus property?
1594
1137
# object, and decorate it to be a new D-Bus
1595
1138
# property with the alternate D-Bus interface
1596
1139
# name. Add it to the class.
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)))
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)))
1608
1153
# Copy annotations, if any
1609
1154
try:
1610
attr[attrname]._dbus_annotations = dict(
1611
attribute._dbus_annotations)
1155
attr[attrname]._dbus_annotations = (
1156
dict(attribute._dbus_annotations))
1612
1157
except AttributeError:
1613
1158
pass
1614
1159
# Is this a D-Bus interface?
1617
1162
# object. Decorate it to be a new D-Bus interface
1618
1163
# with the alternate D-Bus interface name. Add it
1619
1164
# to the class.
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)))
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)))
1627
1173
if deprecate:
1628
1174
# Deprecate all alternate interfaces
1629
iname="_AlternateDBusNames_interface_annotation{}"
1175
iname="_AlternateDBusNames_interface_annotation{0}"
1630
1176
for interface_name in interface_names:
1631
1632
1177
@dbus_interface_annotations(interface_name)
1633
1178
def func(self):
1634
1179
return { "org.freedesktop.DBus.Deprecated":
1635
"true" }
1180
"true" }
1636
1181
# Find an unused name
1637
1182
for aname in (iname.format(i)
1638
1183
for i in itertools.count()):
1642
1187
if interface_names:
1643
1188
# Replace the class with a new subclass of it with
1644
1189
# methods, signals, etc. as created above.
1645
cls = type(b"{}Alternate".format(cls.__name__),
1646
(cls, ), attr)
1190
cls = type(b"{0}Alternate".format(cls.__name__),
1191
(cls,), attr)
1647
1192
return cls
1648
1649
1193
return wrapper
1650
1194
1651
1195
1652
1196
@alternate_dbus_interfaces({"se.recompile.Mandos":
1653
"se.bsnet.fukt.Mandos"})
1197
"se.bsnet.fukt.Mandos"})
1654
1198
class ClientDBus(Client, DBusObjectWithProperties):
1655
1199
"""A Client class using D-Bus
1656
1200
1660
1204
"""
1661
1205
1662
1206
runtime_expansions = (Client.runtime_expansions
1663
+ ("dbus_object_path", ))
1664
1665
_interface = "se.recompile.Mandos.Client"
1207
+ ("dbus_object_path",))
1666
1208
1667
1209
# dbus.service.Object doesn't use super(), so we can't either.
1668
1210
1671
1213
Client.__init__(self, *args, **kwargs)
1672
1214
# Only now, when this client is initialized, can it show up on
1673
1215
# the D-Bus
1674
client_object_name = str(self.name).translate(
1216
client_object_name = unicode(self.name).translate(
1675
1217
{ord("."): ord("_"),
1676
1218
ord("-"): ord("_")})
1677
self.dbus_object_path = dbus.ObjectPath(
1678
"/clients/" + client_object_name)
1219
self.dbus_object_path = (dbus.ObjectPath
1220
("/clients/" + client_object_name))
1679
1221
DBusObjectWithProperties.__init__(self, self.bus,
1680
1222
self.dbus_object_path)
1681
1223
1682
def notifychangeproperty(transform_func, dbus_name,
1683
type_func=lambda x: x,
1684
variant_level=1,
1685
invalidate_only=False,
1686
_interface=_interface):
1224
def notifychangeproperty(transform_func,
1225
dbus_name, type_func=lambda x: x,
1226
variant_level=1):
1687
1227
""" Modify a variable so that it's a property which announces
1688
1228
its changes to DBus.
1689
1229
1694
1234
to the D-Bus. Default: no transform
1695
1235
variant_level: D-Bus variant level. Default: 1
1696
1236
"""
1697
attrname = "_{}".format(dbus_name)
1698
1237
attrname = "_{0}".format(dbus_name)
1699
1238
def setter(self, value):
1700
1239
if hasattr(self, "dbus_object_path"):
1701
1240
if (not hasattr(self, attrname) or
1702
1241
type_func(getattr(self, attrname, None))
1703
1242
!= type_func(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())
1243
dbus_value = transform_func(type_func(value),
1244
variant_level
1245
=variant_level)
1246
self.PropertyChanged(dbus.String(dbus_name),
1247
dbus_value)
1719
1248
setattr(self, attrname, value)
1720
1249
1721
1250
return property(lambda self: getattr(self, attrname), setter)
1727
1256
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1728
1257
last_enabled = notifychangeproperty(datetime_to_dbus,
1729
1258
"LastEnabled")
1730
checker = notifychangeproperty(
1731
dbus.Boolean, "CheckerRunning",
1732
type_func = lambda checker: checker is not None)
1259
checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1260
type_func = lambda checker:
1261
checker is not None)
1733
1262
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1734
1263
"LastCheckedOK")
1735
1264
last_checker_status = notifychangeproperty(dbus.Int16,
1738
1267
datetime_to_dbus, "LastApprovalRequest")
1739
1268
approved_by_default = notifychangeproperty(dbus.Boolean,
1740
1269
"ApprovedByDefault")
1741
approval_delay = notifychangeproperty(
1742
dbus.UInt64, "ApprovalDelay",
1743
type_func = lambda td: td.total_seconds() * 1000)
1270
approval_delay = notifychangeproperty(dbus.UInt64,
1271
"ApprovalDelay",
1272
type_func =
1273
timedelta_to_milliseconds)
1744
1274
approval_duration = notifychangeproperty(
1745
1275
dbus.UInt64, "ApprovalDuration",
1746
type_func = lambda td: td.total_seconds() * 1000)
1276
type_func = timedelta_to_milliseconds)
1747
1277
host = notifychangeproperty(dbus.String, "Host")
1748
timeout = notifychangeproperty(
1749
dbus.UInt64, "Timeout",
1750
type_func = lambda td: td.total_seconds() * 1000)
1278
timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1279
type_func =
1280
timedelta_to_milliseconds)
1751
1281
extended_timeout = notifychangeproperty(
1752
1282
dbus.UInt64, "ExtendedTimeout",
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)
1283
type_func = timedelta_to_milliseconds)
1284
interval = notifychangeproperty(dbus.UInt64,
1285
"Interval",
1286
type_func =
1287
timedelta_to_milliseconds)
1757
1288
checker_command = notifychangeproperty(dbus.String, "Checker")
1758
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1759
invalidate_only=True)
1760
1289
1761
1290
del notifychangeproperty
1762
1291
1769
1298
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1770
1299
Client.__del__(self, *args, **kwargs)
1771
1300
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:
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)
1779
1307
# Emit D-Bus signal
1780
1308
self.CheckerCompleted(dbus.Int16(exitstatus),
1781
# This is specific to GNU libC
1782
dbus.Int64(exitstatus << 8),
1309
dbus.Int64(condition),
1783
1310
dbus.String(command))
1784
1311
else:
1785
1312
# Emit D-Bus signal
1786
1313
self.CheckerCompleted(dbus.Int16(-1),
1787
dbus.Int64(
1788
# This is specific to GNU libC
1789
(exitstatus << 8)
1790
| self.last_checker_signal),
1314
dbus.Int64(condition),
1791
1315
dbus.String(command))
1792
return ret
1316
1317
return Client.checker_callback(self, pid, condition, command,
1318
*args, **kwargs)
1793
1319
1794
1320
def start_checker(self, *args, **kwargs):
1795
old_checker_pid = getattr(self.checker, "pid", None)
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
1796
1326
r = Client.start_checker(self, *args, **kwargs)
1797
1327
# Only if new checker process was started
1798
1328
if (self.checker is not None
1807
1337
1808
1338
def approve(self, value=True):
1809
1339
self.approved = value
1810
gobject.timeout_add(int(self.approval_duration.total_seconds()
1811
* 1000), self._reset_approved)
1340
gobject.timeout_add(timedelta_to_milliseconds
1341
(self.approval_duration),
1342
self._reset_approved)
1812
1343
self.send_changedstate()
1813
1344
1814
1345
## D-Bus methods, signals & properties
1346
_interface = "se.recompile.Mandos.Client"
1815
1347
1816
1348
## Interfaces
1817
1349
1350
@dbus_interface_annotations(_interface)
1351
def _foo(self):
1352
return { "org.freedesktop.DBus.Property.EmitsChangedSignal":
1353
"false"}
1354
1818
1355
## Signals
1819
1356
1820
1357
# CheckerCompleted - signal
1830
1367
pass
1831
1368
1832
1369
# PropertyChanged - signal
1833
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1834
1370
@dbus.service.signal(_interface, signature="sv")
1835
1371
def PropertyChanged(self, property, value):
1836
1372
"D-Bus signal"
1870
1406
self.checked_ok()
1871
1407
1872
1408
# Enable - method
1873
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1874
1409
@dbus.service.method(_interface)
1875
1410
def Enable(self):
1876
1411
"D-Bus method"
1877
1412
self.enable()
1878
1413
1879
1414
# StartChecker - method
1880
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1881
1415
@dbus.service.method(_interface)
1882
1416
def StartChecker(self):
1883
1417
"D-Bus method"
1884
1418
self.start_checker()
1885
1419
1886
1420
# Disable - method
1887
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1888
1421
@dbus.service.method(_interface)
1889
1422
def Disable(self):
1890
1423
"D-Bus method"
1891
1424
self.disable()
1892
1425
1893
1426
# StopChecker - method
1894
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1895
1427
@dbus.service.method(_interface)
1896
1428
def StopChecker(self):
1897
1429
self.stop_checker()
1904
1436
return dbus.Boolean(bool(self.approvals_pending))
1905
1437
1906
1438
# ApprovedByDefault - property
1907
@dbus_service_property(_interface,
1908
signature="b",
1439
@dbus_service_property(_interface, signature="b",
1909
1440
access="readwrite")
1910
1441
def ApprovedByDefault_dbus_property(self, value=None):
1911
1442
if value is None: # get
1913
1444
self.approved_by_default = bool(value)
1914
1445
1915
1446
# ApprovalDelay - property
1916
@dbus_service_property(_interface,
1917
signature="t",
1447
@dbus_service_property(_interface, signature="t",
1918
1448
access="readwrite")
1919
1449
def ApprovalDelay_dbus_property(self, value=None):
1920
1450
if value is None: # get
1921
return dbus.UInt64(self.approval_delay.total_seconds()
1922
* 1000)
1451
return dbus.UInt64(self.approval_delay_milliseconds())
1923
1452
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1924
1453
1925
1454
# ApprovalDuration - property
1926
@dbus_service_property(_interface,
1927
signature="t",
1455
@dbus_service_property(_interface, signature="t",
1928
1456
access="readwrite")
1929
1457
def ApprovalDuration_dbus_property(self, value=None):
1930
1458
if value is None: # get
1931
return dbus.UInt64(self.approval_duration.total_seconds()
1932
* 1000)
1459
return dbus.UInt64(timedelta_to_milliseconds(
1460
self.approval_duration))
1933
1461
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1934
1462
1935
1463
# Name - property
1936
@dbus_annotations(
1937
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1938
1464
@dbus_service_property(_interface, signature="s", access="read")
1939
1465
def Name_dbus_property(self):
1940
1466
return dbus.String(self.name)
1941
1467
1942
1468
# Fingerprint - property
1943
@dbus_annotations(
1944
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1945
1469
@dbus_service_property(_interface, signature="s", access="read")
1946
1470
def Fingerprint_dbus_property(self):
1947
1471
return dbus.String(self.fingerprint)
1948
1472
1949
1473
# Host - property
1950
@dbus_service_property(_interface,
1951
signature="s",
1474
@dbus_service_property(_interface, signature="s",
1952
1475
access="readwrite")
1953
1476
def Host_dbus_property(self, value=None):
1954
1477
if value is None: # get
1955
1478
return dbus.String(self.host)
1956
self.host = str(value)
1479
self.host = unicode(value)
1957
1480
1958
1481
# Created - property
1959
@dbus_annotations(
1960
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1961
1482
@dbus_service_property(_interface, signature="s", access="read")
1962
1483
def Created_dbus_property(self):
1963
1484
return datetime_to_dbus(self.created)
1968
1489
return datetime_to_dbus(self.last_enabled)
1969
1490
1970
1491
# Enabled - property
1971
@dbus_service_property(_interface,
1972
signature="b",
1492
@dbus_service_property(_interface, signature="b",
1973
1493
access="readwrite")
1974
1494
def Enabled_dbus_property(self, value=None):
1975
1495
if value is None: # get
1980
1500
self.disable()
1981
1501
1982
1502
# LastCheckedOK - property
1983
@dbus_service_property(_interface,
1984
signature="s",
1503
@dbus_service_property(_interface, signature="s",
1985
1504
access="readwrite")
1986
1505
def LastCheckedOK_dbus_property(self, value=None):
1987
1506
if value is not None:
1990
1509
return datetime_to_dbus(self.last_checked_ok)
1991
1510
1992
1511
# LastCheckerStatus - property
1993
@dbus_service_property(_interface, signature="n", access="read")
1512
@dbus_service_property(_interface, signature="n",
1513
access="read")
1994
1514
def LastCheckerStatus_dbus_property(self):
1995
1515
return dbus.Int16(self.last_checker_status)
1996
1516
2005
1525
return datetime_to_dbus(self.last_approval_request)
2006
1526
2007
1527
# Timeout - property
2008
@dbus_service_property(_interface,
2009
signature="t",
1528
@dbus_service_property(_interface, signature="t",
2010
1529
access="readwrite")
2011
1530
def Timeout_dbus_property(self, value=None):
2012
1531
if value is None: # get
2013
return dbus.UInt64(self.timeout.total_seconds() * 1000)
1532
return dbus.UInt64(self.timeout_milliseconds())
2014
1533
old_timeout = self.timeout
2015
1534
self.timeout = datetime.timedelta(0, 0, 0, value)
2016
1535
# Reschedule disabling
2025
1544
is None):
2026
1545
return
2027
1546
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)
1547
self.disable_initiator_tag = (
1548
gobject.timeout_add(
1549
timedelta_to_milliseconds(self.expires - now),
1550
self.disable))
2031
1551
2032
1552
# ExtendedTimeout - property
2033
@dbus_service_property(_interface,
2034
signature="t",
1553
@dbus_service_property(_interface, signature="t",
2035
1554
access="readwrite")
2036
1555
def ExtendedTimeout_dbus_property(self, value=None):
2037
1556
if value is None: # get
2038
return dbus.UInt64(self.extended_timeout.total_seconds()
2039
* 1000)
1557
return dbus.UInt64(self.extended_timeout_milliseconds())
2040
1558
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
2041
1559
2042
1560
# Interval - property
2043
@dbus_service_property(_interface,
2044
signature="t",
1561
@dbus_service_property(_interface, signature="t",
2045
1562
access="readwrite")
2046
1563
def Interval_dbus_property(self, value=None):
2047
1564
if value is None: # get
2048
return dbus.UInt64(self.interval.total_seconds() * 1000)
1565
return dbus.UInt64(self.interval_milliseconds())
2049
1566
self.interval = datetime.timedelta(0, 0, 0, value)
2050
1567
if getattr(self, "checker_initiator_tag", None) is None:
2051
1568
return
2052
1569
if self.enabled:
2053
1570
# Reschedule checker run
2054
1571
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
1572
self.checker_initiator_tag = (gobject.timeout_add
1573
(value, self.start_checker))
1574
self.start_checker() # Start one now, too
2058
1575
2059
1576
# Checker - property
2060
@dbus_service_property(_interface,
2061
signature="s",
1577
@dbus_service_property(_interface, signature="s",
2062
1578
access="readwrite")
2063
1579
def Checker_dbus_property(self, value=None):
2064
1580
if value is None: # get
2065
1581
return dbus.String(self.checker_command)
2066
self.checker_command = str(value)
1582
self.checker_command = unicode(value)
2067
1583
2068
1584
# CheckerRunning - property
2069
@dbus_service_property(_interface,
2070
signature="b",
1585
@dbus_service_property(_interface, signature="b",
2071
1586
access="readwrite")
2072
1587
def CheckerRunning_dbus_property(self, value=None):
2073
1588
if value is None: # get
2078
1593
self.stop_checker()
2079
1594
2080
1595
# ObjectPath - property
2081
@dbus_annotations(
2082
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
2083
"org.freedesktop.DBus.Deprecated": "true"})
2084
1596
@dbus_service_property(_interface, signature="o", access="read")
2085
1597
def ObjectPath_dbus_property(self):
2086
1598
return self.dbus_object_path # is already a dbus.ObjectPath
2087
1599
2088
1600
# Secret = property
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)
1601
@dbus_service_property(_interface, signature="ay",
1602
access="write", byte_arrays=True)
2096
1603
def Secret_dbus_property(self, value):
2097
self.secret = bytes(value)
1604
self.secret = str(value)
2098
1605
2099
1606
del _interface
2100
1607
2104
1611
self._pipe = child_pipe
2105
1612
self._pipe.send(('init', fpr, address))
2106
1613
if not self._pipe.recv():
2107
raise KeyError(fpr)
1614
raise KeyError()
2108
1615
2109
1616
def __getattribute__(self, name):
2110
1617
if name == '_pipe':
2114
1621
if data[0] == 'data':
2115
1622
return data[1]
2116
1623
if data[0] == 'function':
2117
2118
1624
def func(*args, **kwargs):
2119
1625
self._pipe.send(('funcall', name, args, kwargs))
2120
1626
return self._pipe.recv()[1]
2121
2122
1627
return func
2123
1628
2124
1629
def __setattr__(self, name, value):
2136
1641
def handle(self):
2137
1642
with contextlib.closing(self.server.child_pipe) as child_pipe:
2138
1643
logger.info("TCP connection from: %s",
2139
str(self.client_address))
1644
unicode(self.client_address))
2140
1645
logger.debug("Pipe FD: %d",
2141
1646
self.server.child_pipe.fileno())
2142
1647
2143
session = gnutls.ClientSession(self.request)
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.
2144
1657
2145
1658
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
2146
1659
# "+AES-256-CBC", "+SHA1",
2150
1663
priority = self.server.gnutls_priority
2151
1664
if priority is None:
2152
1665
priority = "NORMAL"
2153
gnutls.priority_set_direct(session._c_object, priority,
2154
None)
1666
(gnutls.library.functions
1667
.gnutls_priority_set_direct(session._c_object,
1668
priority, None))
2155
1669
2156
1670
# Start communication using the Mandos protocol
2157
1671
# Get protocol number
2159
1673
logger.debug("Protocol version: %r", line)
2160
1674
try:
2161
1675
if int(line.strip().split()[0]) > 1:
2162
raise RuntimeError(line)
1676
raise RuntimeError
2163
1677
except (ValueError, IndexError, RuntimeError) as error:
2164
1678
logger.error("Unknown protocol version: %s", error)
2165
1679
return
2167
1681
# Start GnuTLS connection
2168
1682
try:
2169
1683
session.handshake()
2170
except gnutls.Error as error:
1684
except gnutls.errors.GNUTLSError as error:
2171
1685
logger.warning("Handshake failed: %s", error)
2172
1686
# Do not run session.bye() here: the session is not
2173
1687
# established. Just abandon the request.
2177
1691
approval_required = False
2178
1692
try:
2179
1693
try:
2180
fpr = self.fingerprint(
2181
self.peer_certificate(session))
2182
except (TypeError, gnutls.Error) as error:
1694
fpr = self.fingerprint(self.peer_certificate
1695
(session))
1696
except (TypeError,
1697
gnutls.errors.GNUTLSError) as error:
2183
1698
logger.warning("Bad certificate: %s", error)
2184
1699
return
2185
1700
logger.debug("Fingerprint: %s", fpr)
2198
1713
while True:
2199
1714
if not client.enabled:
2200
1715
logger.info("Client %s is disabled",
2201
client.name)
1716
client.name)
2202
1717
if self.server.use_dbus:
2203
1718
# Emit D-Bus signal
2204
1719
client.Rejected("Disabled")
2213
1728
if self.server.use_dbus:
2214
1729
# Emit D-Bus signal
2215
1730
client.NeedApproval(
2216
client.approval_delay.total_seconds()
2217
* 1000, client.approved_by_default)
1731
client.approval_delay_milliseconds(),
1732
client.approved_by_default)
2218
1733
else:
2219
1734
logger.warning("Client %s was not approved",
2220
1735
client.name)
2226
1741
#wait until timeout or approved
2227
1742
time = datetime.datetime.now()
2228
1743
client.changedstate.acquire()
2229
client.changedstate.wait(delay.total_seconds())
1744
client.changedstate.wait(
1745
float(timedelta_to_milliseconds(delay)
1746
/ 1000))
2230
1747
client.changedstate.release()
2231
1748
time2 = datetime.datetime.now()
2232
1749
if (time2 - time) >= delay:
2243
1760
else:
2244
1761
delay -= time2 - time
2245
1762
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
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
2252
1775
2253
1776
logger.info("Sending secret to %s", client.name)
2254
1777
# bump the timeout using extended_timeout
2262
1785
client.approvals_pending -= 1
2263
1786
try:
2264
1787
session.bye()
2265
except gnutls.Error as error:
1788
except gnutls.errors.GNUTLSError as error:
2266
1789
logger.warning("GnuTLS bye failed",
2267
1790
exc_info=error)
2268
1791
2270
1793
def peer_certificate(session):
2271
1794
"Return the peer's OpenPGP certificate as a bytestring"
2272
1795
# If not an OpenPGP certificate...
2273
if (gnutls.certificate_type_get(session._c_object)
2274
!= gnutls.CRT_OPENPGP):
2275
# ...return invalid data
2276
return b""
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
2277
1801
list_size = ctypes.c_uint(1)
2278
cert_list = (gnutls.certificate_get_peers
1802
cert_list = (gnutls.library.functions
1803
.gnutls_certificate_get_peers
2279
1804
(session._c_object, ctypes.byref(list_size)))
2280
1805
if not bool(cert_list) and list_size.value != 0:
2281
raise gnutls.Error("error getting peer certificate")
1806
raise gnutls.errors.GNUTLSError("error getting peer"
1807
" certificate")
2282
1808
if list_size.value == 0:
2283
1809
return None
2284
1810
cert = cert_list[0]
2288
1814
def fingerprint(openpgp):
2289
1815
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
2290
1816
# New GnuTLS "datum" with the OpenPGP public key
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)))
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))))
2295
1822
# New empty GnuTLS certificate
2296
crt = gnutls.openpgp_crt_t()
2297
gnutls.openpgp_crt_init(ctypes.byref(crt))
1823
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1824
(gnutls.library.functions
1825
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2298
1826
# Import the OpenPGP public key into the certificate
2299
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2300
gnutls.OPENPGP_FMT_RAW)
1827
(gnutls.library.functions
1828
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1829
gnutls.library.constants
1830
.GNUTLS_OPENPGP_FMT_RAW))
2301
1831
# Verify the self signature in the key
2302
1832
crtverify = ctypes.c_uint()
2303
gnutls.openpgp_crt_verify_self(crt, 0,
2304
ctypes.byref(crtverify))
1833
(gnutls.library.functions
1834
.gnutls_openpgp_crt_verify_self(crt, 0,
1835
ctypes.byref(crtverify)))
2305
1836
if crtverify.value != 0:
2306
gnutls.openpgp_crt_deinit(crt)
2307
raise gnutls.CertificateSecurityError("Verify failed")
1837
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1838
raise (gnutls.errors.CertificateSecurityError
1839
("Verify failed"))
2308
1840
# New buffer for the fingerprint
2309
1841
buf = ctypes.create_string_buffer(20)
2310
1842
buf_len = ctypes.c_size_t()
2311
1843
# Get the fingerprint from the certificate into the buffer
2312
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2313
ctypes.byref(buf_len))
1844
(gnutls.library.functions
1845
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1846
ctypes.byref(buf_len)))
2314
1847
# Deinit the certificate
2315
gnutls.openpgp_crt_deinit(crt)
1848
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2316
1849
# Convert the buffer to a Python bytestring
2317
1850
fpr = ctypes.string_at(buf, buf_len.value)
2318
1851
# Convert the bytestring to hexadecimal notation
2322
1855
2323
1856
class MultiprocessingMixIn(object):
2324
1857
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2325
2326
1858
def sub_process_main(self, request, address):
2327
1859
try:
2328
1860
self.finish_request(request, address)
2340
1872
2341
1873
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2342
1874
""" adds a pipe to the MixIn """
2343
2344
1875
def process_request(self, request, client_address):
2345
1876
"""Overrides and wraps the original process_request().
2346
1877
2355
1886
2356
1887
def add_pipe(self, parent_pipe, proc):
2357
1888
"""Dummy function; override as necessary"""
2358
raise NotImplementedError()
1889
raise NotImplementedError
2359
1890
2360
1891
2361
1892
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2367
1898
interface: None or a network interface name (string)
2368
1899
use_ipv6: Boolean; to use IPv6 or not
2369
1900
"""
2370
2371
1901
def __init__(self, server_address, RequestHandlerClass,
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
"""
1902
interface=None, use_ipv6=True):
2378
1903
self.interface = interface
2379
1904
if use_ipv6:
2380
1905
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.
2407
1906
socketserver.TCPServer.__init__(self, server_address,
2408
1907
RequestHandlerClass)
2409
2410
1908
def server_bind(self):
2411
1909
"""This overrides the normal server_bind() function
2412
1910
to bind to an interface if one was specified, and also NOT to
2418
1916
self.interface)
2419
1917
else:
2420
1918
try:
2421
self.socket.setsockopt(
2422
socket.SOL_SOCKET, SO_BINDTODEVICE,
2423
(self.interface + "\0").encode("utf-8"))
1919
self.socket.setsockopt(socket.SOL_SOCKET,
1920
SO_BINDTODEVICE,
1921
str(self.interface
1922
+ '\0'))
2424
1923
except socket.error as error:
2425
1924
if error.errno == errno.EPERM:
2426
logger.error("No permission to bind to"
2427
" interface %s", self.interface)
1925
logger.error("No permission to"
1926
" bind to interface %s",
1927
self.interface)
2428
1928
elif error.errno == errno.ENOPROTOOPT:
2429
1929
logger.error("SO_BINDTODEVICE not available;"
2430
1930
" cannot bind to interface %s",
2431
1931
self.interface)
2432
1932
elif error.errno == errno.ENODEV:
2433
logger.error("Interface %s does not exist,"
2434
" cannot bind", self.interface)
1933
logger.error("Interface %s does not"
1934
" exist, cannot bind",
1935
self.interface)
2435
1936
else:
2436
1937
raise
2437
1938
# Only bind(2) the socket if we really need to.
2440
1941
if self.address_family == socket.AF_INET6:
2441
1942
any_address = "::" # in6addr_any
2442
1943
else:
2443
any_address = "0.0.0.0" # INADDR_ANY
1944
any_address = socket.INADDR_ANY
2444
1945
self.server_address = (any_address,
2445
1946
self.server_address[1])
2446
1947
elif not self.server_address[1]:
2447
self.server_address = (self.server_address[0], 0)
1948
self.server_address = (self.server_address[0],
1949
0)
2448
1950
# if self.interface:
2449
1951
# self.server_address = (self.server_address[0],
2450
1952
# 0, # port
2464
1966
2465
1967
Assumes a gobject.MainLoop event loop.
2466
1968
"""
2467
2468
1969
def __init__(self, server_address, RequestHandlerClass,
2469
interface=None,
2470
use_ipv6=True,
2471
clients=None,
2472
gnutls_priority=None,
2473
use_dbus=True,
2474
socketfd=None):
1970
interface=None, use_ipv6=True, clients=None,
1971
gnutls_priority=None, use_dbus=True):
2475
1972
self.enabled = False
2476
1973
self.clients = clients
2477
1974
if self.clients is None:
2481
1978
IPv6_TCPServer.__init__(self, server_address,
2482
1979
RequestHandlerClass,
2483
1980
interface = interface,
2484
use_ipv6 = use_ipv6,
2485
socketfd = socketfd)
2486
1981
use_ipv6 = use_ipv6)
2487
1982
def server_activate(self):
2488
1983
if self.enabled:
2489
1984
return socketserver.TCPServer.server_activate(self)
2493
1988
2494
1989
def add_pipe(self, parent_pipe, proc):
2495
1990
# Call "handle_ipc" for both data and EOF events
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))
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))
2502
1997
2503
def handle_ipc(self, source, condition,
2504
parent_pipe=None,
2505
proc = None,
2506
client_object=None):
1998
def handle_ipc(self, source, condition, parent_pipe=None,
1999
proc = None, client_object=None):
2507
2000
# error, or the other end of multiprocessing.Pipe has closed
2508
2001
if condition & (gobject.IO_ERR | gobject.IO_HUP):
2509
2002
# Wait for other process to exit
2532
2025
parent_pipe.send(False)
2533
2026
return False
2534
2027
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))
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))
2542
2036
parent_pipe.send(True)
2543
2037
# remove the old hook in favor of the new above hook on
2544
2038
# same fileno
2550
2044
2551
2045
parent_pipe.send(('data', getattr(client_object,
2552
2046
funcname)(*args,
2553
**kwargs)))
2047
**kwargs)))
2554
2048
2555
2049
if command == 'getattr':
2556
2050
attrname = request[1]
2557
if isinstance(client_object.__getattribute__(attrname),
2558
collections.Callable):
2559
parent_pipe.send(('function', ))
2051
if callable(client_object.__getattribute__(attrname)):
2052
parent_pipe.send(('function',))
2560
2053
else:
2561
parent_pipe.send((
2562
'data', client_object.__getattribute__(attrname)))
2054
parent_pipe.send(('data', client_object
2055
.__getattribute__(attrname)))
2563
2056
2564
2057
if command == 'setattr':
2565
2058
attrname = request[1]
2569
2062
return True
2570
2063
2571
2064
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
2668
2065
def string_to_delta(interval):
2669
2066
"""Parse a string and return a datetime.timedelta
2670
2067
2681
2078
>>> string_to_delta('5m 30s')
2682
2079
datetime.timedelta(0, 330)
2683
2080
"""
2684
2685
try:
2686
return rfc3339_duration_to_delta(interval)
2687
except ValueError:
2688
pass
2689
2690
2081
timevalue = datetime.timedelta(0)
2691
2082
for s in interval.split():
2692
2083
try:
2693
suffix = s[-1]
2084
suffix = unicode(s[-1])
2694
2085
value = int(s[:-1])
2695
2086
if suffix == "d":
2696
2087
delta = datetime.timedelta(value)
2703
2094
elif suffix == "w":
2704
2095
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2705
2096
else:
2706
raise ValueError("Unknown suffix {!r}".format(suffix))
2707
except IndexError as e:
2097
raise ValueError("Unknown suffix {0!r}"
2098
.format(suffix))
2099
except (ValueError, IndexError) as e:
2708
2100
raise ValueError(*(e.args))
2709
2101
timevalue += delta
2710
2102
return timevalue
2726
2118
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2727
2119
if not stat.S_ISCHR(os.fstat(null).st_mode):
2728
2120
raise OSError(errno.ENODEV,
2729
"{} not a character device"
2121
"{0} not a character device"
2730
2122
.format(os.devnull))
2731
2123
os.dup2(null, sys.stdin.fileno())
2732
2124
os.dup2(null, sys.stdout.fileno())
2742
2134
2743
2135
parser = argparse.ArgumentParser()
2744
2136
parser.add_argument("-v", "--version", action="version",
2745
version = "%(prog)s {}".format(version),
2137
version = "%(prog)s {0}".format(version),
2746
2138
help="show version number and exit")
2747
2139
parser.add_argument("-i", "--interface", metavar="IF",
2748
2140
help="Bind to interface IF")
2754
2146
help="Run self-test")
2755
2147
parser.add_argument("--debug", action="store_true",
2756
2148
help="Debug mode; run in foreground and log"
2757
" to terminal", default=None)
2149
" to terminal")
2758
2150
parser.add_argument("--debuglevel", metavar="LEVEL",
2759
2151
help="Debug level for stdout output")
2760
2152
parser.add_argument("--priority", help="GnuTLS"
2767
2159
" files")
2768
2160
parser.add_argument("--no-dbus", action="store_false",
2769
2161
dest="use_dbus", help="Do not provide D-Bus"
2770
" system bus interface", default=None)
2162
" system bus interface")
2771
2163
parser.add_argument("--no-ipv6", action="store_false",
2772
dest="use_ipv6", help="Do not use IPv6",
2773
default=None)
2164
dest="use_ipv6", help="Do not use IPv6")
2774
2165
parser.add_argument("--no-restore", action="store_false",
2775
2166
dest="restore", help="Do not restore stored"
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")
2167
" state")
2780
2168
parser.add_argument("--statedir", metavar="DIR",
2781
2169
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)
2787
2170
2788
2171
options = parser.parse_args()
2789
2172
2790
2173
if options.check:
2791
2174
import doctest
2792
fail_count, test_count = doctest.testmod()
2793
sys.exit(os.EX_OK if fail_count == 0 else 1)
2175
doctest.testmod()
2176
sys.exit()
2794
2177
2795
2178
# Default values for config file for server-global settings
2796
2179
server_defaults = { "interface": "",
2798
2181
"port": "",
2799
2182
"debug": "False",
2800
2183
"priority":
2801
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2802
":+SIGN-DSA-SHA256",
2184
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
2803
2185
"servicename": "Mandos",
2804
2186
"use_dbus": "True",
2805
2187
"use_ipv6": "True",
2806
2188
"debuglevel": "",
2807
2189
"restore": "True",
2808
"socket": "",
2809
"statedir": "/var/lib/mandos",
2810
"foreground": "False",
2811
"zeroconf": "True",
2812
}
2190
"statedir": "/var/lib/mandos"
2191
}
2813
2192
2814
2193
# Parse config file for server-global settings
2815
2194
server_config = configparser.SafeConfigParser(server_defaults)
2816
2195
del server_defaults
2817
server_config.read(os.path.join(options.configdir, "mandos.conf"))
2196
server_config.read(os.path.join(options.configdir,
2197
"mandos.conf"))
2818
2198
# Convert the SafeConfigParser object to a dict
2819
2199
server_settings = server_config.defaults()
2820
2200
# Use the appropriate methods on the non-string config options
2821
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2201
for option in ("debug", "use_dbus", "use_ipv6"):
2822
2202
server_settings[option] = server_config.getboolean("DEFAULT",
2823
2203
option)
2824
2204
if server_settings["port"]:
2825
2205
server_settings["port"] = server_config.getint("DEFAULT",
2826
2206
"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"])
2836
2207
del server_config
2837
2208
2838
2209
# Override the settings from the config file with command line
2839
2210
# options, if set.
2840
2211
for option in ("interface", "address", "port", "debug",
2841
"priority", "servicename", "configdir", "use_dbus",
2842
"use_ipv6", "debuglevel", "restore", "statedir",
2843
"socket", "foreground", "zeroconf"):
2212
"priority", "servicename", "configdir",
2213
"use_dbus", "use_ipv6", "debuglevel", "restore",
2214
"statedir"):
2844
2215
value = getattr(options, option)
2845
2216
if value is not None:
2846
2217
server_settings[option] = value
2847
2218
del options
2848
2219
# Force all strings to be unicode
2849
2220
for option in server_settings.keys():
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
2221
if type(server_settings[option]) is str:
2222
server_settings[option] = unicode(server_settings[option])
2860
2223
# Now we have our good server settings in "server_settings"
2861
2224
2862
2225
##################################################################
2863
2226
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
2869
2227
# For convenience
2870
2228
debug = server_settings["debug"]
2871
2229
debuglevel = server_settings["debuglevel"]
2873
2231
use_ipv6 = server_settings["use_ipv6"]
2874
2232
stored_state_path = os.path.join(server_settings["statedir"],
2875
2233
stored_state_file)
2876
foreground = server_settings["foreground"]
2877
zeroconf = server_settings["zeroconf"]
2878
2234
2879
2235
if debug:
2880
2236
initlogger(debug, logging.DEBUG)
2886
2242
initlogger(debug, level)
2887
2243
2888
2244
if server_settings["servicename"] != "Mandos":
2889
syslogger.setFormatter(
2890
logging.Formatter('Mandos ({}) [%(process)d]:'
2891
' %(levelname)s: %(message)s'.format(
2892
server_settings["servicename"])))
2245
syslogger.setFormatter(logging.Formatter
2246
('Mandos ({0}) [%(process)d]:'
2247
' %(levelname)s: %(message)s'
2248
.format(server_settings
2249
["servicename"])))
2893
2250
2894
2251
# Parse config file with clients
2895
2252
client_config = configparser.SafeConfigParser(Client
2900
2257
global mandos_dbus_service
2901
2258
mandos_dbus_service = None
2902
2259
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
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"
2919
2271
try:
2920
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
2272
pidfile = open(pidfilename, "w")
2921
2273
except IOError as e:
2922
2274
logger.error("Could not open file %r", pidfilename,
2923
2275
exc_info=e)
2937
2289
os.setuid(uid)
2938
2290
except OSError as error:
2939
2291
if error.errno != errno.EPERM:
2940
raise
2292
raise error
2941
2293
2942
2294
if debug:
2943
2295
# Enable all possible GnuTLS debugging
2944
2296
2945
2297
# "Use a log level over 10 to enable all debugging options."
2946
2298
# - GnuTLS manual
2947
gnutls.global_set_log_level(11)
2299
gnutls.library.functions.gnutls_global_set_log_level(11)
2948
2300
2949
@gnutls.log_func
2301
@gnutls.library.types.gnutls_log_func
2950
2302
def debug_gnutls(level, string):
2951
2303
logger.debug("GnuTLS: %s", string[:-1])
2952
2304
2953
gnutls.global_set_log_function(debug_gnutls)
2305
(gnutls.library.functions
2306
.gnutls_global_set_log_function(debug_gnutls))
2954
2307
2955
2308
# Redirect stdin so all checkers get /dev/null
2956
2309
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2959
2312
os.close(null)
2960
2313
2961
2314
# Need to fork before connecting to D-Bus
2962
if not foreground:
2315
if not debug:
2963
2316
# Close all input and output, do double fork, etc.
2964
2317
daemon()
2965
2318
2966
# multiprocessing will use threads, so before we use gobject we
2967
# need to inform gobject that threads will be used.
2968
2319
gobject.threads_init()
2969
2320
2970
2321
global main_loop
2976
2327
if use_dbus:
2977
2328
try:
2978
2329
bus_name = dbus.service.BusName("se.recompile.Mandos",
2979
bus,
2980
do_not_queue=True)
2981
old_bus_name = dbus.service.BusName(
2982
"se.bsnet.fukt.Mandos", bus,
2983
do_not_queue=True)
2984
except dbus.exceptions.DBusException as e:
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:
2985
2335
logger.error("Disabling D-Bus:", exc_info=e)
2986
2336
use_dbus = False
2987
2337
server_settings["use_dbus"] = False
2988
2338
tcp_server.use_dbus = False
2989
if zeroconf:
2990
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2991
service = AvahiServiceToSyslog(
2992
name = server_settings["servicename"],
2993
servicetype = "_mandos._tcp",
2994
protocol = protocol,
2995
bus = bus)
2996
if server_settings["interface"]:
2997
service.interface = if_nametoindex(
2998
server_settings["interface"].encode("utf-8"))
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"])))
2999
2347
3000
2348
global multiprocessing_manager
3001
2349
multiprocessing_manager = multiprocessing.Manager()
3008
2356
old_client_settings = {}
3009
2357
clients_data = {}
3010
2358
3011
# This is used to redirect stdout and stderr for checker processes
3012
global wnull
3013
wnull = open(os.devnull, "w") # A writable /dev/null
3014
# Only used if server is running in foreground but not in debug
3015
# mode
3016
if debug or not foreground:
3017
wnull.close()
3018
3019
2359
# Get client data and settings from last running state.
3020
2360
if server_settings["restore"]:
3021
2361
try:
3022
2362
with open(stored_state_path, "rb") as stored_state:
3023
clients_data, old_client_settings = pickle.load(
3024
stored_state)
2363
clients_data, old_client_settings = (pickle.load
2364
(stored_state))
3025
2365
os.remove(stored_state_path)
3026
2366
except IOError as e:
3027
2367
if e.errno == errno.ENOENT:
3028
logger.warning("Could not load persistent state:"
3029
" {}".format(os.strerror(e.errno)))
2368
logger.warning("Could not load persistent state: {0}"
2369
.format(os.strerror(e.errno)))
3030
2370
else:
3031
2371
logger.critical("Could not load persistent state:",
3032
2372
exc_info=e)
3033
2373
raise
3034
2374
except EOFError as e:
3035
2375
logger.warning("Could not load persistent state: "
3036
"EOFError:",
3037
exc_info=e)
2376
"EOFError:", exc_info=e)
3038
2377
3039
2378
with PGPEngine() as pgp:
3040
for client_name, client in clients_data.items():
3041
# Skip removed clients
3042
if client_name not in client_settings:
3043
continue
3044
2379
for client_name, client in clients_data.iteritems():
3045
2380
# Decide which value to use after restoring saved state.
3046
2381
# We have three different values: Old config file,
3047
2382
# new config file, and saved state.
3052
2387
# For each value in new config, check if it
3053
2388
# differs from the old config value (Except for
3054
2389
# the "secret" attribute)
3055
if (name != "secret"
3056
and (value !=
3057
old_client_settings[client_name][name])):
2390
if (name != "secret" and
2391
value != old_client_settings[client_name]
2392
[name]):
3058
2393
client[name] = value
3059
2394
except KeyError:
3060
2395
pass
3061
2396
3062
2397
# Clients who has passed its expire date can still be
3063
# enabled if its last checker was successful. A Client
2398
# enabled if its last checker was successful. Clients
3064
2399
# whose checker succeeded before we stored its state is
3065
2400
# assumed to have successfully run all checkers during
3066
2401
# downtime.
3068
2403
if datetime.datetime.utcnow() >= client["expires"]:
3069
2404
if not client["last_checked_ok"]:
3070
2405
logger.warning(
3071
"disabling client {} - Client never "
3072
"performed a successful checker".format(
3073
client_name))
2406
"disabling client {0} - Client never "
2407
"performed a successful checker"
2408
.format(client_name))
3074
2409
client["enabled"] = False
3075
2410
elif client["last_checker_status"] != 0:
3076
2411
logger.warning(
3077
"disabling client {} - Client last"
3078
" checker failed with error code"
3079
" {}".format(
3080
client_name,
3081
client["last_checker_status"]))
2412
"disabling client {0} - Client "
2413
"last checker failed with error code {1}"
2414
.format(client_name,
2415
client["last_checker_status"]))
3082
2416
client["enabled"] = False
3083
2417
else:
3084
client["expires"] = (
3085
datetime.datetime.utcnow()
3086
+ client["timeout"])
2418
client["expires"] = (datetime.datetime
2419
.utcnow()
2420
+ client["timeout"])
3087
2421
logger.debug("Last checker succeeded,"
3088
" keeping {} enabled".format(
3089
client_name))
2422
" keeping {0} enabled"
2423
.format(client_name))
3090
2424
try:
3091
client["secret"] = pgp.decrypt(
3092
client["encrypted_secret"],
3093
client_settings[client_name]["secret"])
2425
client["secret"] = (
2426
pgp.decrypt(client["encrypted_secret"],
2427
client_settings[client_name]
2428
["secret"]))
3094
2429
except PGPError:
3095
2430
# If decryption fails, we use secret from new settings
3096
logger.debug("Failed to decrypt {} old secret".format(
3097
client_name))
3098
client["secret"] = (client_settings[client_name]
3099
["secret"])
2431
logger.debug("Failed to decrypt {0} old secret"
2432
.format(client_name))
2433
client["secret"] = (
2434
client_settings[client_name]["secret"])
3100
2435
3101
2436
# Add/remove clients based on new changes made to config
3102
2437
for client_name in (set(old_client_settings)
3107
2442
clients_data[client_name] = client_settings[client_name]
3108
2443
3109
2444
# Create all client objects
3110
for client_name, client in clients_data.items():
2445
for client_name, client in clients_data.iteritems():
3111
2446
tcp_server.clients[client_name] = client_class(
3112
name = client_name,
3113
settings = client,
3114
server_settings = server_settings)
2447
name = client_name, settings = client)
3115
2448
3116
2449
if not tcp_server.clients:
3117
2450
logger.warning("No clients defined")
3118
2451
3119
if not foreground:
3120
if pidfile is not None:
3121
pid = os.getpid()
3122
try:
3123
with pidfile:
3124
print(pid, file=pidfile)
3125
except IOError:
3126
logger.error("Could not write to file %r with PID %d",
3127
pidfilename, pid)
3128
del pidfile
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
3129
2464
del pidfilename
3130
2465
3131
2466
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
3132
2467
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
3133
2468
3134
2469
if use_dbus:
3135
3136
@alternate_dbus_interfaces(
3137
{ "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
3138
class MandosDBusService(DBusObjectWithObjectManager):
2470
@alternate_dbus_interfaces({"se.recompile.Mandos":
2471
"se.bsnet.fukt.Mandos"})
2472
class MandosDBusService(DBusObjectWithProperties):
3139
2473
"""A D-Bus proxy object"""
3140
3141
2474
def __init__(self):
3142
2475
dbus.service.Object.__init__(self, bus, "/")
3143
3144
2476
_interface = "se.recompile.Mandos"
3145
2477
2478
@dbus_interface_annotations(_interface)
2479
def _foo(self):
2480
return { "org.freedesktop.DBus.Property"
2481
".EmitsChangedSignal":
2482
"false"}
2483
3146
2484
@dbus.service.signal(_interface, signature="o")
3147
2485
def ClientAdded(self, objpath):
3148
2486
"D-Bus signal"
3153
2491
"D-Bus signal"
3154
2492
pass
3155
2493
3156
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3157
"true"})
3158
2494
@dbus.service.signal(_interface, signature="os")
3159
2495
def ClientRemoved(self, objpath, name):
3160
2496
"D-Bus signal"
3161
2497
pass
3162
2498
3163
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3164
"true"})
3165
2499
@dbus.service.method(_interface, out_signature="ao")
3166
2500
def GetAllClients(self):
3167
2501
"D-Bus method"
3168
return dbus.Array(c.dbus_object_path for c in
2502
return dbus.Array(c.dbus_object_path
2503
for c in
3169
2504
tcp_server.clients.itervalues())
3170
2505
3171
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3172
"true"})
3173
2506
@dbus.service.method(_interface,
3174
2507
out_signature="a{oa{sv}}")
3175
2508
def GetAllClientsWithProperties(self):
3176
2509
"D-Bus method"
3177
2510
return dbus.Dictionary(
3178
{ c.dbus_object_path: c.GetAll(
3179
"se.recompile.Mandos.Client")
3180
for c in tcp_server.clients.itervalues() },
2511
((c.dbus_object_path, c.GetAll(""))
2512
for c in tcp_server.clients.itervalues()),
3181
2513
signature="oa{sv}")
3182
2514
3183
2515
@dbus.service.method(_interface, in_signature="o")
3187
2519
if c.dbus_object_path == object_path:
3188
2520
del tcp_server.clients[c.name]
3189
2521
c.remove_from_connection()
3190
# Don't signal the disabling
2522
# Don't signal anything except ClientRemoved
3191
2523
c.disable(quiet=True)
3192
# Emit D-Bus signal for removal
3193
self.client_removed_signal(c)
2524
# Emit D-Bus signal
2525
self.ClientRemoved(object_path, c.name)
3194
2526
return
3195
2527
raise KeyError(object_path)
3196
2528
3197
2529
del _interface
3198
3199
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3200
out_signature = "a{oa{sa{sv}}}")
3201
def GetManagedObjects(self):
3202
"""D-Bus method"""
3203
return dbus.Dictionary(
3204
{ client.dbus_object_path:
3205
dbus.Dictionary(
3206
{ interface: client.GetAll(interface)
3207
for interface in
3208
client._get_all_interface_names()})
3209
for client in tcp_server.clients.values()})
3210
3211
def client_added_signal(self, client):
3212
"""Send the new standard signal and the old signal"""
3213
if use_dbus:
3214
# New standard signal
3215
self.InterfacesAdded(
3216
client.dbus_object_path,
3217
dbus.Dictionary(
3218
{ interface: client.GetAll(interface)
3219
for interface in
3220
client._get_all_interface_names()}))
3221
# Old signal
3222
self.ClientAdded(client.dbus_object_path)
3223
3224
def client_removed_signal(self, client):
3225
"""Send the new standard signal and the old signal"""
3226
if use_dbus:
3227
# New standard signal
3228
self.InterfacesRemoved(
3229
client.dbus_object_path,
3230
client._get_all_interface_names())
3231
# Old signal
3232
self.ClientRemoved(client.dbus_object_path,
3233
client.name)
3234
2530
3235
2531
mandos_dbus_service = MandosDBusService()
3236
2532
3237
2533
def cleanup():
3238
2534
"Cleanup function; run on exit"
3239
if zeroconf:
3240
service.cleanup()
2535
service.cleanup()
3241
2536
3242
2537
multiprocessing.active_children()
3243
wnull.close()
3244
2538
if not (tcp_server.clients or client_settings):
3245
2539
return
3246
2540
3257
2551
3258
2552
# A list of attributes that can not be pickled
3259
2553
# + secret.
3260
exclude = { "bus", "changedstate", "secret",
3261
"checker", "server_settings" }
3262
for name, typ in inspect.getmembers(dbus.service
3263
.Object):
2554
exclude = set(("bus", "changedstate", "secret",
2555
"checker"))
2556
for name, typ in (inspect.getmembers
2557
(dbus.service.Object)):
3264
2558
exclude.add(name)
3265
2559
3266
2560
client_dict["encrypted_secret"] = (client
3273
2567
del client_settings[client.name]["secret"]
3274
2568
3275
2569
try:
3276
with tempfile.NamedTemporaryFile(
3277
mode='wb',
3278
suffix=".pickle",
3279
prefix='clients-',
3280
dir=os.path.dirname(stored_state_path),
3281
delete=False) as stored_state:
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:
3282
2574
pickle.dump((clients, client_settings), stored_state)
3283
tempname = stored_state.name
2575
tempname=stored_state.name
3284
2576
os.rename(tempname, stored_state_path)
3285
2577
except (IOError, OSError) as e:
3286
2578
if not debug:
3289
2581
except NameError:
3290
2582
pass
3291
2583
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3292
logger.warning("Could not save persistent state: {}"
2584
logger.warning("Could not save persistent state: {0}"
3293
2585
.format(os.strerror(e.errno)))
3294
2586
else:
3295
2587
logger.warning("Could not save persistent state:",
3296
2588
exc_info=e)
3297
raise
2589
raise e
3298
2590
3299
2591
# Delete all clients, and settings from config
3300
2592
while tcp_server.clients:
3301
2593
name, client = tcp_server.clients.popitem()
3302
2594
if use_dbus:
3303
2595
client.remove_from_connection()
3304
# Don't signal the disabling
2596
# Don't signal anything except ClientRemoved
3305
2597
client.disable(quiet=True)
3306
# Emit D-Bus signal for removal
3307
2598
if use_dbus:
3308
mandos_dbus_service.client_removed_signal(client)
2599
# Emit D-Bus signal
2600
mandos_dbus_service.ClientRemoved(client
2601
.dbus_object_path,
2602
client.name)
3309
2603
client_settings.clear()
3310
2604
3311
2605
atexit.register(cleanup)
3312
2606
3313
2607
for client in tcp_server.clients.itervalues():
3314
2608
if use_dbus:
3315
# Emit D-Bus signal for adding
3316
mandos_dbus_service.client_added_signal(client)
2609
# Emit D-Bus signal
2610
mandos_dbus_service.ClientAdded(client.dbus_object_path)
3317
2611
# Need to initiate checking of clients
3318
2612
if client.enabled:
3319
2613
client.init_checker()
3322
2616
tcp_server.server_activate()
3323
2617
3324
2618
# Find out what port we got
3325
if zeroconf:
3326
service.port = tcp_server.socket.getsockname()[1]
2619
service.port = tcp_server.socket.getsockname()[1]
3327
2620
if use_ipv6:
3328
2621
logger.info("Now listening on address %r, port %d,"
3329
2622
" flowinfo %d, scope_id %d",
3335
2628
#service.interface = tcp_server.socket.getsockname()[3]
3336
2629
3337
2630
try:
3338
if zeroconf:
3339
# From the Avahi example code
3340
try:
3341
service.activate()
3342
except dbus.exceptions.DBusException as error:
3343
logger.critical("D-Bus Exception", exc_info=error)
3344
cleanup()
3345
sys.exit(1)
3346
# End of Avahi example code
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
3347
2639
3348
2640
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
3349
2641
lambda *args, **kwargs:
3364
2656
# Must run before the D-Bus bus name gets deregistered
3365
2657
cleanup()
3366
2658
3367
3368
2659
if __name__ == '__main__':
3369
2660
main()
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0