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