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