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