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 829
- compare with another revision
- download diff
- download tarball
- view history from revision 829
- Committer: Teddy Hogeborn
- Date: 2016-03-12 20:23:15 UTC
- Revision ID: teddy@recompile.se-20160312202315-hu7b87ivetlxqbw3
Server: Fix minor thing with Python 3 compatibility
Fix another small thing with unpickling string values.
* mandos (main): When restoring pickled client data, only decode byte
string for "host" key if it really is a byte string.
Fix another small thing with unpickling string values.
* mandos (main): When restoring pickled client data, only decode byte
string for "host" key if it really is a byte string.
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-2014 Teddy Hogeborn
15
# Copyright © 2008-2014 Björn Påhlsson
14
# Copyright © 2008-2016 Teddy Hogeborn
15
# Copyright © 2008-2016 Björn Påhlsson
16
16
#
17
17
# This program is free software: you can redistribute it and/or modify
18
18
# it under the terms of the GNU General Public License as published by
34
34
from __future__ import (division, absolute_import, print_function,
35
35
unicode_literals)
36
36
37
from future_builtins import *
37
try:
38
from future_builtins import *
39
except ImportError:
40
pass
38
41
39
import SocketServer as socketserver
42
try:
43
import SocketServer as socketserver
44
except ImportError:
45
import socketserver
40
46
import socket
41
47
import argparse
42
48
import datetime
43
49
import errno
44
import gnutls.crypto
45
import gnutls.connection
46
import gnutls.errors
47
import gnutls.library.functions
48
import gnutls.library.constants
49
import gnutls.library.types
50
import ConfigParser as configparser
50
try:
51
import ConfigParser as configparser
52
except ImportError:
53
import configparser
51
54
import sys
52
55
import re
53
56
import os
62
65
import struct
63
66
import fcntl
64
67
import functools
65
import cPickle as pickle
68
try:
69
import cPickle as pickle
70
except ImportError:
71
import pickle
66
72
import multiprocessing
67
73
import types
68
74
import binascii
69
75
import tempfile
70
76
import itertools
71
77
import collections
78
import codecs
72
79
73
80
import dbus
74
81
import dbus.service
75
import gobject
76
import avahi
82
try:
83
from gi.repository import GObject
84
except ImportError:
85
import gobject as GObject
77
86
from dbus.mainloop.glib import DBusGMainLoop
78
87
import ctypes
79
88
import ctypes.util
91
100
if sys.version_info.major == 2:
92
101
str = unicode
93
102
94
version = "1.6.8"
103
version = "1.7.5"
95
104
stored_state_file = "clients.pickle"
96
105
97
106
logger = logging.getLogger()
98
107
syslogger = None
99
108
100
109
try:
101
if_nametoindex = (ctypes.cdll.LoadLibrary
102
(ctypes.util.find_library("c"))
103
.if_nametoindex)
110
if_nametoindex = ctypes.cdll.LoadLibrary(
111
ctypes.util.find_library("c")).if_nametoindex
104
112
except (OSError, AttributeError):
113
105
114
def if_nametoindex(interface):
106
115
"Get an interface index the hard way, i.e. using fcntl()"
107
116
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
112
121
return interface_index
113
122
114
123
124
def copy_function(func):
125
"""Make a copy of a function"""
126
if sys.version_info.major == 2:
127
return types.FunctionType(func.func_code,
128
func.func_globals,
129
func.func_name,
130
func.func_defaults,
131
func.func_closure)
132
else:
133
return types.FunctionType(func.__code__,
134
func.__globals__,
135
func.__name__,
136
func.__defaults__,
137
func.__closure__)
138
139
115
140
def initlogger(debug, level=logging.WARNING):
116
141
"""init logger and add loglevel"""
117
142
118
143
global syslogger
119
syslogger = (logging.handlers.SysLogHandler
120
(facility =
121
logging.handlers.SysLogHandler.LOG_DAEMON,
122
address = "/dev/log"))
144
syslogger = (logging.handlers.SysLogHandler(
145
facility = logging.handlers.SysLogHandler.LOG_DAEMON,
146
address = "/dev/log"))
123
147
syslogger.setFormatter(logging.Formatter
124
148
('Mandos [%(process)d]: %(levelname)s:'
125
149
' %(message)s'))
142
166
143
167
class PGPEngine(object):
144
168
"""A simple class for OpenPGP symmetric encryption & decryption"""
169
145
170
def __init__(self):
146
171
self.tempdir = tempfile.mkdtemp(prefix="mandos-")
172
self.gpg = "gpg"
173
try:
174
output = subprocess.check_output(["gpgconf"])
175
for line in output.splitlines():
176
name, text, path = line.split(b":")
177
if name == "gpg":
178
self.gpg = path
179
break
180
except OSError as e:
181
if e.errno != errno.ENOENT:
182
raise
147
183
self.gnupgargs = ['--batch',
148
'--home', self.tempdir,
184
'--homedir', self.tempdir,
149
185
'--force-mdc',
150
186
'--quiet',
151
187
'--no-use-agent']
186
222
187
223
def encrypt(self, data, password):
188
224
passphrase = self.password_encode(password)
189
with tempfile.NamedTemporaryFile(dir=self.tempdir
190
) as passfile:
225
with tempfile.NamedTemporaryFile(
226
dir=self.tempdir) as passfile:
191
227
passfile.write(passphrase)
192
228
passfile.flush()
193
proc = subprocess.Popen(['gpg', '--symmetric',
229
proc = subprocess.Popen([self.gpg, '--symmetric',
194
230
'--passphrase-file',
195
231
passfile.name]
196
232
+ self.gnupgargs,
204
240
205
241
def decrypt(self, data, password):
206
242
passphrase = self.password_encode(password)
207
with tempfile.NamedTemporaryFile(dir = self.tempdir
208
) as passfile:
243
with tempfile.NamedTemporaryFile(
244
dir = self.tempdir) as passfile:
209
245
passfile.write(passphrase)
210
246
passfile.flush()
211
proc = subprocess.Popen(['gpg', '--decrypt',
247
proc = subprocess.Popen([self.gpg, '--decrypt',
212
248
'--passphrase-file',
213
249
passfile.name]
214
250
+ self.gnupgargs,
215
251
stdin = subprocess.PIPE,
216
252
stdout = subprocess.PIPE,
217
253
stderr = subprocess.PIPE)
218
decrypted_plaintext, err = proc.communicate(input
219
= data)
254
decrypted_plaintext, err = proc.communicate(input = data)
220
255
if proc.returncode != 0:
221
256
raise PGPError(err)
222
257
return decrypted_plaintext
223
258
259
# Pretend that we have an Avahi module
260
class Avahi(object):
261
"""This isn't so much a class as it is a module-like namespace.
262
It is instantiated once, and simulates having an Avahi module."""
263
IF_UNSPEC = -1 # avahi-common/address.h
264
PROTO_UNSPEC = -1 # avahi-common/address.h
265
PROTO_INET = 0 # avahi-common/address.h
266
PROTO_INET6 = 1 # avahi-common/address.h
267
DBUS_NAME = "org.freedesktop.Avahi"
268
DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"
269
DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"
270
DBUS_PATH_SERVER = "/"
271
def string_array_to_txt_array(self, t):
272
return dbus.Array((dbus.ByteArray(s.encode("utf-8"))
273
for s in t), signature="ay")
274
ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h
275
ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h
276
ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h
277
SERVER_INVALID = 0 # avahi-common/defs.h
278
SERVER_REGISTERING = 1 # avahi-common/defs.h
279
SERVER_RUNNING = 2 # avahi-common/defs.h
280
SERVER_COLLISION = 3 # avahi-common/defs.h
281
SERVER_FAILURE = 4 # avahi-common/defs.h
282
avahi = Avahi()
224
283
225
284
class AvahiError(Exception):
226
285
def __init__(self, value, *args, **kwargs):
228
287
return super(AvahiError, self).__init__(value, *args,
229
288
**kwargs)
230
289
290
231
291
class AvahiServiceError(AvahiError):
232
292
pass
233
293
294
234
295
class AvahiGroupError(AvahiError):
235
296
pass
236
297
256
317
bus: dbus.SystemBus()
257
318
"""
258
319
259
def __init__(self, interface = avahi.IF_UNSPEC, name = None,
260
servicetype = None, port = None, TXT = None,
261
domain = "", host = "", max_renames = 32768,
262
protocol = avahi.PROTO_UNSPEC, bus = None):
320
def __init__(self,
321
interface = avahi.IF_UNSPEC,
322
name = None,
323
servicetype = None,
324
port = None,
325
TXT = None,
326
domain = "",
327
host = "",
328
max_renames = 32768,
329
protocol = avahi.PROTO_UNSPEC,
330
bus = None):
263
331
self.interface = interface
264
332
self.name = name
265
333
self.type = servicetype
275
343
self.bus = bus
276
344
self.entry_group_state_changed_match = None
277
345
278
def rename(self):
346
def rename(self, remove=True):
279
347
"""Derived from the Avahi example code"""
280
348
if self.rename_count >= self.max_renames:
281
349
logger.critical("No suitable Zeroconf service name found"
282
350
" after %i retries, exiting.",
283
351
self.rename_count)
284
352
raise AvahiServiceError("Too many renames")
285
self.name = str(self.server
286
.GetAlternativeServiceName(self.name))
353
self.name = str(
354
self.server.GetAlternativeServiceName(self.name))
355
self.rename_count += 1
287
356
logger.info("Changing Zeroconf service name to %r ...",
288
357
self.name)
289
self.remove()
358
if remove:
359
self.remove()
290
360
try:
291
361
self.add()
292
362
except dbus.exceptions.DBusException as error:
293
logger.critical("D-Bus Exception", exc_info=error)
294
self.cleanup()
295
os._exit(1)
296
self.rename_count += 1
363
if (error.get_dbus_name()
364
== "org.freedesktop.Avahi.CollisionError"):
365
logger.info("Local Zeroconf service name collision.")
366
return self.rename(remove=False)
367
else:
368
logger.critical("D-Bus Exception", exc_info=error)
369
self.cleanup()
370
os._exit(1)
297
371
298
372
def remove(self):
299
373
"""Derived from the Avahi example code"""
338
412
elif state == avahi.ENTRY_GROUP_FAILURE:
339
413
logger.critical("Avahi: Error in group state changed %s",
340
414
str(error))
341
raise AvahiGroupError("State changed: {!s}"
342
.format(error))
415
raise AvahiGroupError("State changed: {!s}".format(error))
343
416
344
417
def cleanup(self):
345
418
"""Derived from the Avahi example code"""
355
428
def server_state_changed(self, state, error=None):
356
429
"""Derived from the Avahi example code"""
357
430
logger.debug("Avahi server state change: %i", state)
358
bad_states = { avahi.SERVER_INVALID:
359
"Zeroconf server invalid",
360
avahi.SERVER_REGISTERING: None,
361
avahi.SERVER_COLLISION:
362
"Zeroconf server name collision",
363
avahi.SERVER_FAILURE:
364
"Zeroconf server failure" }
431
bad_states = {
432
avahi.SERVER_INVALID: "Zeroconf server invalid",
433
avahi.SERVER_REGISTERING: None,
434
avahi.SERVER_COLLISION: "Zeroconf server name collision",
435
avahi.SERVER_FAILURE: "Zeroconf server failure",
436
}
365
437
if state in bad_states:
366
438
if bad_states[state] is not None:
367
439
if error is None:
370
442
logger.error(bad_states[state] + ": %r", error)
371
443
self.cleanup()
372
444
elif state == avahi.SERVER_RUNNING:
373
self.add()
445
try:
446
self.add()
447
except dbus.exceptions.DBusException as error:
448
if (error.get_dbus_name()
449
== "org.freedesktop.Avahi.CollisionError"):
450
logger.info("Local Zeroconf service name"
451
" collision.")
452
return self.rename(remove=False)
453
else:
454
logger.critical("D-Bus Exception", exc_info=error)
455
self.cleanup()
456
os._exit(1)
374
457
else:
375
458
if error is None:
376
459
logger.debug("Unknown state: %r", state)
386
469
follow_name_owner_changes=True),
387
470
avahi.DBUS_INTERFACE_SERVER)
388
471
self.server.connect_to_signal("StateChanged",
389
self.server_state_changed)
472
self.server_state_changed)
390
473
self.server_state_changed(self.server.GetState())
391
474
392
475
393
476
class AvahiServiceToSyslog(AvahiService):
394
def rename(self):
477
def rename(self, *args, **kwargs):
395
478
"""Add the new name to the syslog messages"""
396
ret = AvahiService.rename(self)
397
syslogger.setFormatter(logging.Formatter
398
('Mandos ({}) [%(process)d]:'
399
' %(levelname)s: %(message)s'
400
.format(self.name)))
479
ret = AvahiService.rename(self, *args, **kwargs)
480
syslogger.setFormatter(logging.Formatter(
481
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
482
.format(self.name)))
401
483
return ret
402
484
485
# Pretend that we have a GnuTLS module
486
class GnuTLS(object):
487
"""This isn't so much a class as it is a module-like namespace.
488
It is instantiated once, and simulates having a GnuTLS module."""
489
490
_library = ctypes.cdll.LoadLibrary(
491
ctypes.util.find_library("gnutls"))
492
_need_version = b"3.3.0"
493
def __init__(self):
494
# Need to use class name "GnuTLS" here, since this method is
495
# called before the assignment to the "gnutls" global variable
496
# happens.
497
if GnuTLS.check_version(self._need_version) is None:
498
raise GnuTLS.Error("Needs GnuTLS {} or later"
499
.format(self._need_version))
500
501
# Unless otherwise indicated, the constants and types below are
502
# all from the gnutls/gnutls.h C header file.
503
504
# Constants
505
E_SUCCESS = 0
506
E_INTERRUPTED = -52
507
E_AGAIN = -28
508
CRT_OPENPGP = 2
509
CLIENT = 2
510
SHUT_RDWR = 0
511
CRD_CERTIFICATE = 1
512
E_NO_CERTIFICATE_FOUND = -49
513
OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h
514
515
# Types
516
class session_int(ctypes.Structure):
517
_fields_ = []
518
session_t = ctypes.POINTER(session_int)
519
class certificate_credentials_st(ctypes.Structure):
520
_fields_ = []
521
certificate_credentials_t = ctypes.POINTER(
522
certificate_credentials_st)
523
certificate_type_t = ctypes.c_int
524
class datum_t(ctypes.Structure):
525
_fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
526
('size', ctypes.c_uint)]
527
class openpgp_crt_int(ctypes.Structure):
528
_fields_ = []
529
openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
530
openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
531
log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
532
credentials_type_t = ctypes.c_int
533
transport_ptr_t = ctypes.c_void_p
534
close_request_t = ctypes.c_int
535
536
# Exceptions
537
class Error(Exception):
538
# We need to use the class name "GnuTLS" here, since this
539
# exception might be raised from within GnuTLS.__init__,
540
# which is called before the assignment to the "gnutls"
541
# global variable has happened.
542
def __init__(self, message = None, code = None, args=()):
543
# Default usage is by a message string, but if a return
544
# code is passed, convert it to a string with
545
# gnutls.strerror()
546
self.code = code
547
if message is None and code is not None:
548
message = GnuTLS.strerror(code)
549
return super(GnuTLS.Error, self).__init__(
550
message, *args)
551
552
class CertificateSecurityError(Error):
553
pass
554
555
# Classes
556
class Credentials(object):
557
def __init__(self):
558
self._c_object = gnutls.certificate_credentials_t()
559
gnutls.certificate_allocate_credentials(
560
ctypes.byref(self._c_object))
561
self.type = gnutls.CRD_CERTIFICATE
562
563
def __del__(self):
564
gnutls.certificate_free_credentials(self._c_object)
565
566
class ClientSession(object):
567
def __init__(self, socket, credentials = None):
568
self._c_object = gnutls.session_t()
569
gnutls.init(ctypes.byref(self._c_object), gnutls.CLIENT)
570
gnutls.set_default_priority(self._c_object)
571
gnutls.transport_set_ptr(self._c_object, socket.fileno())
572
gnutls.handshake_set_private_extensions(self._c_object,
573
True)
574
self.socket = socket
575
if credentials is None:
576
credentials = gnutls.Credentials()
577
gnutls.credentials_set(self._c_object, credentials.type,
578
ctypes.cast(credentials._c_object,
579
ctypes.c_void_p))
580
self.credentials = credentials
581
582
def __del__(self):
583
gnutls.deinit(self._c_object)
584
585
def handshake(self):
586
return gnutls.handshake(self._c_object)
587
588
def send(self, data):
589
data = bytes(data)
590
data_len = len(data)
591
while data_len > 0:
592
data_len -= gnutls.record_send(self._c_object,
593
data[-data_len:],
594
data_len)
595
596
def bye(self):
597
return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
598
599
# Error handling functions
600
def _error_code(result):
601
"""A function to raise exceptions on errors, suitable
602
for the 'restype' attribute on ctypes functions"""
603
if result >= 0:
604
return result
605
if result == gnutls.E_NO_CERTIFICATE_FOUND:
606
raise gnutls.CertificateSecurityError(code = result)
607
raise gnutls.Error(code = result)
608
609
def _retry_on_error(result, func, arguments):
610
"""A function to retry on some errors, suitable
611
for the 'errcheck' attribute on ctypes functions"""
612
while result < 0:
613
if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
614
return _error_code(result)
615
result = func(*arguments)
616
return result
617
618
# Unless otherwise indicated, the function declarations below are
619
# all from the gnutls/gnutls.h C header file.
620
621
# Functions
622
priority_set_direct = _library.gnutls_priority_set_direct
623
priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
624
ctypes.POINTER(ctypes.c_char_p)]
625
priority_set_direct.restype = _error_code
626
627
init = _library.gnutls_init
628
init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
629
init.restype = _error_code
630
631
set_default_priority = _library.gnutls_set_default_priority
632
set_default_priority.argtypes = [session_t]
633
set_default_priority.restype = _error_code
634
635
record_send = _library.gnutls_record_send
636
record_send.argtypes = [session_t, ctypes.c_void_p,
637
ctypes.c_size_t]
638
record_send.restype = ctypes.c_ssize_t
639
record_send.errcheck = _retry_on_error
640
641
certificate_allocate_credentials = (
642
_library.gnutls_certificate_allocate_credentials)
643
certificate_allocate_credentials.argtypes = [
644
ctypes.POINTER(certificate_credentials_t)]
645
certificate_allocate_credentials.restype = _error_code
646
647
certificate_free_credentials = (
648
_library.gnutls_certificate_free_credentials)
649
certificate_free_credentials.argtypes = [certificate_credentials_t]
650
certificate_free_credentials.restype = None
651
652
handshake_set_private_extensions = (
653
_library.gnutls_handshake_set_private_extensions)
654
handshake_set_private_extensions.argtypes = [session_t,
655
ctypes.c_int]
656
handshake_set_private_extensions.restype = None
657
658
credentials_set = _library.gnutls_credentials_set
659
credentials_set.argtypes = [session_t, credentials_type_t,
660
ctypes.c_void_p]
661
credentials_set.restype = _error_code
662
663
strerror = _library.gnutls_strerror
664
strerror.argtypes = [ctypes.c_int]
665
strerror.restype = ctypes.c_char_p
666
667
certificate_type_get = _library.gnutls_certificate_type_get
668
certificate_type_get.argtypes = [session_t]
669
certificate_type_get.restype = _error_code
670
671
certificate_get_peers = _library.gnutls_certificate_get_peers
672
certificate_get_peers.argtypes = [session_t,
673
ctypes.POINTER(ctypes.c_uint)]
674
certificate_get_peers.restype = ctypes.POINTER(datum_t)
675
676
global_set_log_level = _library.gnutls_global_set_log_level
677
global_set_log_level.argtypes = [ctypes.c_int]
678
global_set_log_level.restype = None
679
680
global_set_log_function = _library.gnutls_global_set_log_function
681
global_set_log_function.argtypes = [log_func]
682
global_set_log_function.restype = None
683
684
deinit = _library.gnutls_deinit
685
deinit.argtypes = [session_t]
686
deinit.restype = None
687
688
handshake = _library.gnutls_handshake
689
handshake.argtypes = [session_t]
690
handshake.restype = _error_code
691
handshake.errcheck = _retry_on_error
692
693
transport_set_ptr = _library.gnutls_transport_set_ptr
694
transport_set_ptr.argtypes = [session_t, transport_ptr_t]
695
transport_set_ptr.restype = None
696
697
bye = _library.gnutls_bye
698
bye.argtypes = [session_t, close_request_t]
699
bye.restype = _error_code
700
bye.errcheck = _retry_on_error
701
702
check_version = _library.gnutls_check_version
703
check_version.argtypes = [ctypes.c_char_p]
704
check_version.restype = ctypes.c_char_p
705
706
# All the function declarations below are from gnutls/openpgp.h
707
708
openpgp_crt_init = _library.gnutls_openpgp_crt_init
709
openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
710
openpgp_crt_init.restype = _error_code
711
712
openpgp_crt_import = _library.gnutls_openpgp_crt_import
713
openpgp_crt_import.argtypes = [openpgp_crt_t,
714
ctypes.POINTER(datum_t),
715
openpgp_crt_fmt_t]
716
openpgp_crt_import.restype = _error_code
717
718
openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
719
openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
720
ctypes.POINTER(ctypes.c_uint)]
721
openpgp_crt_verify_self.restype = _error_code
722
723
openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
724
openpgp_crt_deinit.argtypes = [openpgp_crt_t]
725
openpgp_crt_deinit.restype = None
726
727
openpgp_crt_get_fingerprint = (
728
_library.gnutls_openpgp_crt_get_fingerprint)
729
openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
730
ctypes.c_void_p,
731
ctypes.POINTER(
732
ctypes.c_size_t)]
733
openpgp_crt_get_fingerprint.restype = _error_code
734
735
# Remove non-public functions
736
del _error_code, _retry_on_error
737
# Create the global "gnutls" object, simulating a module
738
gnutls = GnuTLS()
739
740
def call_pipe(connection, # : multiprocessing.Connection
741
func, *args, **kwargs):
742
"""This function is meant to be called by multiprocessing.Process
743
744
This function runs func(*args, **kwargs), and writes the resulting
745
return value on the provided multiprocessing.Connection.
746
"""
747
connection.send(func(*args, **kwargs))
748
connection.close()
403
749
404
750
class Client(object):
405
751
"""A representation of a client host served by this server.
411
757
checker: subprocess.Popen(); a running checker process used
412
758
to see if the client lives.
413
759
'None' if no process is running.
414
checker_callback_tag: a gobject event source tag, or None
760
checker_callback_tag: a GObject event source tag, or None
415
761
checker_command: string; External command which is run to check
416
762
if client lives. %() expansions are done at
417
763
runtime with vars(self) as dict, so that for
418
764
instance %(name)s can be used in the command.
419
checker_initiator_tag: a gobject event source tag, or None
765
checker_initiator_tag: a GObject event source tag, or None
420
766
created: datetime.datetime(); (UTC) object creation
421
767
client_structure: Object describing what attributes a client has
422
768
and is used for storing the client at exit
423
769
current_checker_command: string; current running checker_command
424
disable_initiator_tag: a gobject event source tag, or None
770
disable_initiator_tag: a GObject event source tag, or None
425
771
enabled: bool()
426
772
fingerprint: string (40 or 32 hexadecimal digits); used to
427
773
uniquely identify the client
432
778
last_checker_status: integer between 0 and 255 reflecting exit
433
779
status of last checker. -1 reflects crashed
434
780
checker, -2 means no checker completed yet.
781
last_checker_signal: The signal which killed the last checker, if
782
last_checker_status is -1
435
783
last_enabled: datetime.datetime(); (UTC) or None
436
784
name: string; from the config file, used in log messages and
437
785
D-Bus identifiers
450
798
"fingerprint", "host", "interval",
451
799
"last_approval_request", "last_checked_ok",
452
800
"last_enabled", "name", "timeout")
453
client_defaults = { "timeout": "PT5M",
454
"extended_timeout": "PT15M",
455
"interval": "PT2M",
456
"checker": "fping -q -- %%(host)s",
457
"host": "",
458
"approval_delay": "PT0S",
459
"approval_duration": "PT1S",
460
"approved_by_default": "True",
461
"enabled": "True",
462
}
801
client_defaults = {
802
"timeout": "PT5M",
803
"extended_timeout": "PT15M",
804
"interval": "PT2M",
805
"checker": "fping -q -- %%(host)s",
806
"host": "",
807
"approval_delay": "PT0S",
808
"approval_duration": "PT1S",
809
"approved_by_default": "True",
810
"enabled": "True",
811
}
463
812
464
813
@staticmethod
465
814
def config_parser(config):
481
830
client["enabled"] = config.getboolean(client_name,
482
831
"enabled")
483
832
833
# Uppercase and remove spaces from fingerprint for later
834
# comparison purposes with return value from the
835
# fingerprint() function
484
836
client["fingerprint"] = (section["fingerprint"].upper()
485
837
.replace(" ", ""))
486
838
if "secret" in section:
487
client["secret"] = section["secret"].decode("base64")
839
client["secret"] = codecs.decode(section["secret"]
840
.encode("utf-8"),
841
"base64")
488
842
elif "secfile" in section:
489
843
with open(os.path.expanduser(os.path.expandvars
490
844
(section["secfile"])),
528
882
self.expires = None
529
883
530
884
logger.debug("Creating client %r", self.name)
531
# Uppercase and remove spaces from fingerprint for later
532
# comparison purposes with return value from the fingerprint()
533
# function
534
885
logger.debug(" Fingerprint: %s", self.fingerprint)
535
886
self.created = settings.get("created",
536
887
datetime.datetime.utcnow())
543
894
self.current_checker_command = None
544
895
self.approved = None
545
896
self.approvals_pending = 0
546
self.changedstate = (multiprocessing_manager
547
.Condition(multiprocessing_manager
548
.Lock()))
549
self.client_structure = [attr for attr in
550
self.__dict__.iterkeys()
897
self.changedstate = multiprocessing_manager.Condition(
898
multiprocessing_manager.Lock())
899
self.client_structure = [attr
900
for attr in self.__dict__.keys()
551
901
if not attr.startswith("_")]
552
902
self.client_structure.append("client_structure")
553
903
554
for name, t in inspect.getmembers(type(self),
555
lambda obj:
556
isinstance(obj,
557
property)):
904
for name, t in inspect.getmembers(
905
type(self), lambda obj: isinstance(obj, property)):
558
906
if not name.startswith("_"):
559
907
self.client_structure.append(name)
560
908
581
929
if not quiet:
582
930
logger.info("Disabling client %s", self.name)
583
931
if getattr(self, "disable_initiator_tag", None) is not None:
584
gobject.source_remove(self.disable_initiator_tag)
932
GObject.source_remove(self.disable_initiator_tag)
585
933
self.disable_initiator_tag = None
586
934
self.expires = None
587
935
if getattr(self, "checker_initiator_tag", None) is not None:
588
gobject.source_remove(self.checker_initiator_tag)
936
GObject.source_remove(self.checker_initiator_tag)
589
937
self.checker_initiator_tag = None
590
938
self.stop_checker()
591
939
self.enabled = False
592
940
if not quiet:
593
941
self.send_changedstate()
594
# Do not run this again if called by a gobject.timeout_add
942
# Do not run this again if called by a GObject.timeout_add
595
943
return False
596
944
597
945
def __del__(self):
601
949
# Schedule a new checker to be started an 'interval' from now,
602
950
# and every interval from then on.
603
951
if self.checker_initiator_tag is not None:
604
gobject.source_remove(self.checker_initiator_tag)
605
self.checker_initiator_tag = (gobject.timeout_add
606
(int(self.interval
607
.total_seconds() * 1000),
608
self.start_checker))
952
GObject.source_remove(self.checker_initiator_tag)
953
self.checker_initiator_tag = GObject.timeout_add(
954
int(self.interval.total_seconds() * 1000),
955
self.start_checker)
609
956
# Schedule a disable() when 'timeout' has passed
610
957
if self.disable_initiator_tag is not None:
611
gobject.source_remove(self.disable_initiator_tag)
612
self.disable_initiator_tag = (gobject.timeout_add
613
(int(self.timeout
614
.total_seconds() * 1000),
615
self.disable))
958
GObject.source_remove(self.disable_initiator_tag)
959
self.disable_initiator_tag = GObject.timeout_add(
960
int(self.timeout.total_seconds() * 1000), self.disable)
616
961
# Also start a new checker *right now*.
617
962
self.start_checker()
618
963
619
def checker_callback(self, pid, condition, command):
964
def checker_callback(self, source, condition, connection,
965
command):
620
966
"""The checker has completed, so take appropriate actions."""
621
967
self.checker_callback_tag = None
622
968
self.checker = None
623
if os.WIFEXITED(condition):
624
self.last_checker_status = os.WEXITSTATUS(condition)
969
# Read return code from connection (see call_pipe)
970
returncode = connection.recv()
971
connection.close()
972
973
if returncode >= 0:
974
self.last_checker_status = returncode
975
self.last_checker_signal = None
625
976
if self.last_checker_status == 0:
626
977
logger.info("Checker for %(name)s succeeded",
627
978
vars(self))
628
979
self.checked_ok()
629
980
else:
630
logger.info("Checker for %(name)s failed",
631
vars(self))
981
logger.info("Checker for %(name)s failed", vars(self))
632
982
else:
633
983
self.last_checker_status = -1
984
self.last_checker_signal = -returncode
634
985
logger.warning("Checker for %(name)s crashed?",
635
986
vars(self))
987
return False
636
988
637
989
def checked_ok(self):
638
990
"""Assert that the client has been seen, alive and well."""
639
991
self.last_checked_ok = datetime.datetime.utcnow()
640
992
self.last_checker_status = 0
993
self.last_checker_signal = None
641
994
self.bump_timeout()
642
995
643
996
def bump_timeout(self, timeout=None):
645
998
if timeout is None:
646
999
timeout = self.timeout
647
1000
if self.disable_initiator_tag is not None:
648
gobject.source_remove(self.disable_initiator_tag)
1001
GObject.source_remove(self.disable_initiator_tag)
649
1002
self.disable_initiator_tag = None
650
1003
if getattr(self, "enabled", False):
651
self.disable_initiator_tag = (gobject.timeout_add
652
(int(timeout.total_seconds()
653
* 1000), self.disable))
1004
self.disable_initiator_tag = GObject.timeout_add(
1005
int(timeout.total_seconds() * 1000), self.disable)
654
1006
self.expires = datetime.datetime.utcnow() + timeout
655
1007
656
1008
def need_approval(self):
670
1022
# than 'timeout' for the client to be disabled, which is as it
671
1023
# should be.
672
1024
673
# If a checker exists, make sure it is not a zombie
674
try:
675
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
676
except AttributeError:
677
pass
678
except OSError as error:
679
if error.errno != errno.ECHILD:
680
raise
681
else:
682
if pid:
683
logger.warning("Checker was a zombie")
684
gobject.source_remove(self.checker_callback_tag)
685
self.checker_callback(pid, status,
686
self.current_checker_command)
1025
if self.checker is not None and not self.checker.is_alive():
1026
logger.warning("Checker was not alive; joining")
1027
self.checker.join()
1028
self.checker = None
687
1029
# Start a new checker if needed
688
1030
if self.checker is None:
689
1031
# Escape attributes for the shell
690
escaped_attrs = { attr:
691
re.escape(str(getattr(self, attr)))
692
for attr in self.runtime_expansions }
1032
escaped_attrs = {
1033
attr: re.escape(str(getattr(self, attr)))
1034
for attr in self.runtime_expansions }
693
1035
try:
694
1036
command = self.checker_command % escaped_attrs
695
1037
except TypeError as error:
696
1038
logger.error('Could not format string "%s"',
697
self.checker_command, exc_info=error)
698
return True # Try again later
1039
self.checker_command,
1040
exc_info=error)
1041
return True # Try again later
699
1042
self.current_checker_command = command
700
try:
701
logger.info("Starting checker %r for %s",
702
command, self.name)
703
# We don't need to redirect stdout and stderr, since
704
# in normal mode, that is already done by daemon(),
705
# and in debug mode we don't want to. (Stdin is
706
# always replaced by /dev/null.)
707
# The exception is when not debugging but nevertheless
708
# running in the foreground; use the previously
709
# created wnull.
710
popen_args = {}
711
if (not self.server_settings["debug"]
712
and self.server_settings["foreground"]):
713
popen_args.update({"stdout": wnull,
714
"stderr": wnull })
715
self.checker = subprocess.Popen(command,
716
close_fds=True,
717
shell=True, cwd="/",
718
**popen_args)
719
except OSError as error:
720
logger.error("Failed to start subprocess",
721
exc_info=error)
722
return True
723
self.checker_callback_tag = (gobject.child_watch_add
724
(self.checker.pid,
725
self.checker_callback,
726
data=command))
727
# The checker may have completed before the gobject
728
# watch was added. Check for this.
729
try:
730
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
731
except OSError as error:
732
if error.errno == errno.ECHILD:
733
# This should never happen
734
logger.error("Child process vanished",
735
exc_info=error)
736
return True
737
raise
738
if pid:
739
gobject.source_remove(self.checker_callback_tag)
740
self.checker_callback(pid, status, command)
741
# Re-run this periodically if run by gobject.timeout_add
1043
logger.info("Starting checker %r for %s", command,
1044
self.name)
1045
# We don't need to redirect stdout and stderr, since
1046
# in normal mode, that is already done by daemon(),
1047
# and in debug mode we don't want to. (Stdin is
1048
# always replaced by /dev/null.)
1049
# The exception is when not debugging but nevertheless
1050
# running in the foreground; use the previously
1051
# created wnull.
1052
popen_args = { "close_fds": True,
1053
"shell": True,
1054
"cwd": "/" }
1055
if (not self.server_settings["debug"]
1056
and self.server_settings["foreground"]):
1057
popen_args.update({"stdout": wnull,
1058
"stderr": wnull })
1059
pipe = multiprocessing.Pipe(duplex = False)
1060
self.checker = multiprocessing.Process(
1061
target = call_pipe,
1062
args = (pipe[1], subprocess.call, command),
1063
kwargs = popen_args)
1064
self.checker.start()
1065
self.checker_callback_tag = GObject.io_add_watch(
1066
pipe[0].fileno(), GObject.IO_IN,
1067
self.checker_callback, pipe[0], command)
1068
# Re-run this periodically if run by GObject.timeout_add
742
1069
return True
743
1070
744
1071
def stop_checker(self):
745
1072
"""Force the checker process, if any, to stop."""
746
1073
if self.checker_callback_tag:
747
gobject.source_remove(self.checker_callback_tag)
1074
GObject.source_remove(self.checker_callback_tag)
748
1075
self.checker_callback_tag = None
749
1076
if getattr(self, "checker", None) is None:
750
1077
return
751
1078
logger.debug("Stopping checker for %(name)s", vars(self))
752
try:
753
self.checker.terminate()
754
#time.sleep(0.5)
755
#if self.checker.poll() is None:
756
# self.checker.kill()
757
except OSError as error:
758
if error.errno != errno.ESRCH: # No such process
759
raise
1079
self.checker.terminate()
760
1080
self.checker = None
761
1081
762
1082
763
def dbus_service_property(dbus_interface, signature="v",
764
access="readwrite", byte_arrays=False):
1083
def dbus_service_property(dbus_interface,
1084
signature="v",
1085
access="readwrite",
1086
byte_arrays=False):
765
1087
"""Decorators for marking methods of a DBusObjectWithProperties to
766
1088
become properties on the D-Bus.
767
1089
777
1099
if byte_arrays and signature != "ay":
778
1100
raise ValueError("Byte arrays not supported for non-'ay'"
779
1101
" signature {!r}".format(signature))
1102
780
1103
def decorator(func):
781
1104
func._dbus_is_property = True
782
1105
func._dbus_interface = dbus_interface
787
1110
func._dbus_name = func._dbus_name[:-14]
788
1111
func._dbus_get_args_options = {'byte_arrays': byte_arrays }
789
1112
return func
1113
790
1114
return decorator
791
1115
792
1116
801
1125
"org.freedesktop.DBus.Property.EmitsChangedSignal":
802
1126
"false"}
803
1127
"""
1128
804
1129
def decorator(func):
805
1130
func._dbus_is_interface = True
806
1131
func._dbus_interface = dbus_interface
807
1132
func._dbus_name = dbus_interface
808
1133
return func
1134
809
1135
return decorator
810
1136
811
1137
820
1146
access="r")
821
1147
def Property_dbus_property(self):
822
1148
return dbus.Boolean(False)
1149
1150
See also the DBusObjectWithAnnotations class.
823
1151
"""
1152
824
1153
def decorator(func):
825
1154
func._dbus_annotations = annotations
826
1155
return func
1156
827
1157
return decorator
828
1158
829
1159
832
1162
"""
833
1163
pass
834
1164
1165
835
1166
class DBusPropertyAccessException(DBusPropertyException):
836
1167
"""A property's access permissions disallows an operation.
837
1168
"""
844
1175
pass
845
1176
846
1177
847
class DBusObjectWithProperties(dbus.service.Object):
848
"""A D-Bus object with properties.
1178
class DBusObjectWithAnnotations(dbus.service.Object):
1179
"""A D-Bus object with annotations.
849
1180
850
Classes inheriting from this can use the dbus_service_property
851
decorator to expose methods as D-Bus properties. It exposes the
852
standard Get(), Set(), and GetAll() methods on the D-Bus.
1181
Classes inheriting from this can use the dbus_annotations
1182
decorator to add annotations to methods or signals.
853
1183
"""
854
1184
855
1185
@staticmethod
865
1195
def _get_all_dbus_things(self, thing):
866
1196
"""Returns a generator of (name, attribute) pairs
867
1197
"""
868
return ((getattr(athing.__get__(self), "_dbus_name",
869
name),
1198
return ((getattr(athing.__get__(self), "_dbus_name", name),
870
1199
athing.__get__(self))
871
1200
for cls in self.__class__.__mro__
872
1201
for name, athing in
873
inspect.getmembers(cls,
874
self._is_dbus_thing(thing)))
1202
inspect.getmembers(cls, self._is_dbus_thing(thing)))
1203
1204
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1205
out_signature = "s",
1206
path_keyword = 'object_path',
1207
connection_keyword = 'connection')
1208
def Introspect(self, object_path, connection):
1209
"""Overloading of standard D-Bus method.
1210
1211
Inserts annotation tags on methods and signals.
1212
"""
1213
xmlstring = dbus.service.Object.Introspect(self, object_path,
1214
connection)
1215
try:
1216
document = xml.dom.minidom.parseString(xmlstring)
1217
1218
for if_tag in document.getElementsByTagName("interface"):
1219
# Add annotation tags
1220
for typ in ("method", "signal"):
1221
for tag in if_tag.getElementsByTagName(typ):
1222
annots = dict()
1223
for name, prop in (self.
1224
_get_all_dbus_things(typ)):
1225
if (name == tag.getAttribute("name")
1226
and prop._dbus_interface
1227
== if_tag.getAttribute("name")):
1228
annots.update(getattr(
1229
prop, "_dbus_annotations", {}))
1230
for name, value in annots.items():
1231
ann_tag = document.createElement(
1232
"annotation")
1233
ann_tag.setAttribute("name", name)
1234
ann_tag.setAttribute("value", value)
1235
tag.appendChild(ann_tag)
1236
# Add interface annotation tags
1237
for annotation, value in dict(
1238
itertools.chain.from_iterable(
1239
annotations().items()
1240
for name, annotations
1241
in self._get_all_dbus_things("interface")
1242
if name == if_tag.getAttribute("name")
1243
)).items():
1244
ann_tag = document.createElement("annotation")
1245
ann_tag.setAttribute("name", annotation)
1246
ann_tag.setAttribute("value", value)
1247
if_tag.appendChild(ann_tag)
1248
# Fix argument name for the Introspect method itself
1249
if (if_tag.getAttribute("name")
1250
== dbus.INTROSPECTABLE_IFACE):
1251
for cn in if_tag.getElementsByTagName("method"):
1252
if cn.getAttribute("name") == "Introspect":
1253
for arg in cn.getElementsByTagName("arg"):
1254
if (arg.getAttribute("direction")
1255
== "out"):
1256
arg.setAttribute("name",
1257
"xml_data")
1258
xmlstring = document.toxml("utf-8")
1259
document.unlink()
1260
except (AttributeError, xml.dom.DOMException,
1261
xml.parsers.expat.ExpatError) as error:
1262
logger.error("Failed to override Introspection method",
1263
exc_info=error)
1264
return xmlstring
1265
1266
1267
class DBusObjectWithProperties(DBusObjectWithAnnotations):
1268
"""A D-Bus object with properties.
1269
1270
Classes inheriting from this can use the dbus_service_property
1271
decorator to expose methods as D-Bus properties. It exposes the
1272
standard Get(), Set(), and GetAll() methods on the D-Bus.
1273
"""
875
1274
876
1275
def _get_dbus_property(self, interface_name, property_name):
877
1276
"""Returns a bound method if one exists which is a D-Bus
878
1277
property with the specified name and interface.
879
1278
"""
880
for cls in self.__class__.__mro__:
881
for name, value in (inspect.getmembers
882
(cls,
883
self._is_dbus_thing("property"))):
1279
for cls in self.__class__.__mro__:
1280
for name, value in inspect.getmembers(
1281
cls, self._is_dbus_thing("property")):
884
1282
if (value._dbus_name == property_name
885
1283
and value._dbus_interface == interface_name):
886
1284
return value.__get__(self)
887
1285
888
1286
# No such property
889
raise DBusPropertyNotFound(self.dbus_object_path + ":"
890
+ interface_name + "."
891
+ property_name)
892
893
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
1287
raise DBusPropertyNotFound("{}:{}.{}".format(
1288
self.dbus_object_path, interface_name, property_name))
1289
1290
@classmethod
1291
def _get_all_interface_names(cls):
1292
"""Get a sequence of all interfaces supported by an object"""
1293
return (name for name in set(getattr(getattr(x, attr),
1294
"_dbus_interface", None)
1295
for x in (inspect.getmro(cls))
1296
for attr in dir(x))
1297
if name is not None)
1298
1299
@dbus.service.method(dbus.PROPERTIES_IFACE,
1300
in_signature="ss",
894
1301
out_signature="v")
895
1302
def Get(self, interface_name, property_name):
896
1303
"""Standard D-Bus property Get() method, see D-Bus standard.
921
1328
for byte in value))
922
1329
prop(value)
923
1330
924
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
1331
@dbus.service.method(dbus.PROPERTIES_IFACE,
1332
in_signature="s",
925
1333
out_signature="a{sv}")
926
1334
def GetAll(self, interface_name):
927
1335
"""Standard D-Bus property GetAll() method, see D-Bus
942
1350
if not hasattr(value, "variant_level"):
943
1351
properties[name] = value
944
1352
continue
945
properties[name] = type(value)(value, variant_level=
946
value.variant_level+1)
1353
properties[name] = type(value)(
1354
value, variant_level = value.variant_level + 1)
947
1355
return dbus.Dictionary(properties, signature="sv")
948
1356
949
1357
@dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
963
1371
964
1372
Inserts property tags and interface annotation tags.
965
1373
"""
966
xmlstring = dbus.service.Object.Introspect(self, object_path,
967
connection)
1374
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1375
object_path,
1376
connection)
968
1377
try:
969
1378
document = xml.dom.minidom.parseString(xmlstring)
1379
970
1380
def make_tag(document, name, prop):
971
1381
e = document.createElement("property")
972
1382
e.setAttribute("name", name)
973
1383
e.setAttribute("type", prop._dbus_signature)
974
1384
e.setAttribute("access", prop._dbus_access)
975
1385
return e
1386
976
1387
for if_tag in document.getElementsByTagName("interface"):
977
1388
# Add property tags
978
1389
for tag in (make_tag(document, name, prop)
981
1392
if prop._dbus_interface
982
1393
== if_tag.getAttribute("name")):
983
1394
if_tag.appendChild(tag)
984
# Add annotation tags
985
for typ in ("method", "signal", "property"):
986
for tag in if_tag.getElementsByTagName(typ):
987
annots = dict()
988
for name, prop in (self.
989
_get_all_dbus_things(typ)):
990
if (name == tag.getAttribute("name")
991
and prop._dbus_interface
992
== if_tag.getAttribute("name")):
993
annots.update(getattr
994
(prop,
995
"_dbus_annotations",
996
{}))
997
for name, value in annots.items():
998
ann_tag = document.createElement(
999
"annotation")
1000
ann_tag.setAttribute("name", name)
1001
ann_tag.setAttribute("value", value)
1002
tag.appendChild(ann_tag)
1003
# Add interface annotation tags
1004
for annotation, value in dict(
1005
itertools.chain.from_iterable(
1006
annotations().items()
1007
for name, annotations in
1008
self._get_all_dbus_things("interface")
1009
if name == if_tag.getAttribute("name")
1010
)).items():
1011
ann_tag = document.createElement("annotation")
1012
ann_tag.setAttribute("name", annotation)
1013
ann_tag.setAttribute("value", value)
1014
if_tag.appendChild(ann_tag)
1395
# Add annotation tags for properties
1396
for tag in if_tag.getElementsByTagName("property"):
1397
annots = dict()
1398
for name, prop in self._get_all_dbus_things(
1399
"property"):
1400
if (name == tag.getAttribute("name")
1401
and prop._dbus_interface
1402
== if_tag.getAttribute("name")):
1403
annots.update(getattr(
1404
prop, "_dbus_annotations", {}))
1405
for name, value in annots.items():
1406
ann_tag = document.createElement(
1407
"annotation")
1408
ann_tag.setAttribute("name", name)
1409
ann_tag.setAttribute("value", value)
1410
tag.appendChild(ann_tag)
1015
1411
# Add the names to the return values for the
1016
1412
# "org.freedesktop.DBus.Properties" methods
1017
1413
if (if_tag.getAttribute("name")
1035
1431
exc_info=error)
1036
1432
return xmlstring
1037
1433
1434
try:
1435
dbus.OBJECT_MANAGER_IFACE
1436
except AttributeError:
1437
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1438
1439
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1440
"""A D-Bus object with an ObjectManager.
1441
1442
Classes inheriting from this exposes the standard
1443
GetManagedObjects call and the InterfacesAdded and
1444
InterfacesRemoved signals on the standard
1445
"org.freedesktop.DBus.ObjectManager" interface.
1446
1447
Note: No signals are sent automatically; they must be sent
1448
manually.
1449
"""
1450
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1451
out_signature = "a{oa{sa{sv}}}")
1452
def GetManagedObjects(self):
1453
"""This function must be overridden"""
1454
raise NotImplementedError()
1455
1456
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1457
signature = "oa{sa{sv}}")
1458
def InterfacesAdded(self, object_path, interfaces_and_properties):
1459
pass
1460
1461
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature = "oas")
1462
def InterfacesRemoved(self, object_path, interfaces):
1463
pass
1464
1465
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1466
out_signature = "s",
1467
path_keyword = 'object_path',
1468
connection_keyword = 'connection')
1469
def Introspect(self, object_path, connection):
1470
"""Overloading of standard D-Bus method.
1471
1472
Override return argument name of GetManagedObjects to be
1473
"objpath_interfaces_and_properties"
1474
"""
1475
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1476
object_path,
1477
connection)
1478
try:
1479
document = xml.dom.minidom.parseString(xmlstring)
1480
1481
for if_tag in document.getElementsByTagName("interface"):
1482
# Fix argument name for the GetManagedObjects method
1483
if (if_tag.getAttribute("name")
1484
== dbus.OBJECT_MANAGER_IFACE):
1485
for cn in if_tag.getElementsByTagName("method"):
1486
if (cn.getAttribute("name")
1487
== "GetManagedObjects"):
1488
for arg in cn.getElementsByTagName("arg"):
1489
if (arg.getAttribute("direction")
1490
== "out"):
1491
arg.setAttribute(
1492
"name",
1493
"objpath_interfaces"
1494
"_and_properties")
1495
xmlstring = document.toxml("utf-8")
1496
document.unlink()
1497
except (AttributeError, xml.dom.DOMException,
1498
xml.parsers.expat.ExpatError) as error:
1499
logger.error("Failed to override Introspection method",
1500
exc_info = error)
1501
return xmlstring
1038
1502
1039
1503
def datetime_to_dbus(dt, variant_level=0):
1040
1504
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1041
1505
if dt is None:
1042
1506
return dbus.String("", variant_level = variant_level)
1043
return dbus.String(dt.isoformat(),
1044
variant_level=variant_level)
1507
return dbus.String(dt.isoformat(), variant_level=variant_level)
1045
1508
1046
1509
1047
1510
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1067
1530
(from DBusObjectWithProperties) and interfaces (from the
1068
1531
dbus_interface_annotations decorator).
1069
1532
"""
1533
1070
1534
def wrapper(cls):
1071
1535
for orig_interface_name, alt_interface_name in (
1072
alt_interface_names.items()):
1536
alt_interface_names.items()):
1073
1537
attr = {}
1074
1538
interface_names = set()
1075
1539
# Go though all attributes of the class
1077
1541
# Ignore non-D-Bus attributes, and D-Bus attributes
1078
1542
# with the wrong interface name
1079
1543
if (not hasattr(attribute, "_dbus_interface")
1080
or not attribute._dbus_interface
1081
.startswith(orig_interface_name)):
1544
or not attribute._dbus_interface.startswith(
1545
orig_interface_name)):
1082
1546
continue
1083
1547
# Create an alternate D-Bus interface name based on
1084
1548
# the current name
1085
alt_interface = (attribute._dbus_interface
1086
.replace(orig_interface_name,
1087
alt_interface_name))
1549
alt_interface = attribute._dbus_interface.replace(
1550
orig_interface_name, alt_interface_name)
1088
1551
interface_names.add(alt_interface)
1089
1552
# Is this a D-Bus signal?
1090
1553
if getattr(attribute, "_dbus_is_signal", False):
1091
1554
# Extract the original non-method undecorated
1092
1555
# function by black magic
1093
nonmethod_func = (dict(
1556
if sys.version_info.major == 2:
1557
nonmethod_func = (dict(
1094
1558
zip(attribute.func_code.co_freevars,
1095
attribute.__closure__))["func"]
1096
.cell_contents)
1559
attribute.__closure__))
1560
["func"].cell_contents)
1561
else:
1562
nonmethod_func = (dict(
1563
zip(attribute.__code__.co_freevars,
1564
attribute.__closure__))
1565
["func"].cell_contents)
1097
1566
# Create a new, but exactly alike, function
1098
1567
# object, and decorate it to be a new D-Bus signal
1099
1568
# with the alternate D-Bus interface name
1100
new_function = (dbus.service.signal
1101
(alt_interface,
1102
attribute._dbus_signature)
1103
(types.FunctionType(
1104
nonmethod_func.func_code,
1105
nonmethod_func.func_globals,
1106
nonmethod_func.func_name,
1107
nonmethod_func.func_defaults,
1108
nonmethod_func.func_closure)))
1569
new_function = copy_function(nonmethod_func)
1570
new_function = (dbus.service.signal(
1571
alt_interface,
1572
attribute._dbus_signature)(new_function))
1109
1573
# Copy annotations, if any
1110
1574
try:
1111
new_function._dbus_annotations = (
1112
dict(attribute._dbus_annotations))
1575
new_function._dbus_annotations = dict(
1576
attribute._dbus_annotations)
1113
1577
except AttributeError:
1114
1578
pass
1115
1579
# Define a creator of a function to call both the
1120
1584
"""This function is a scope container to pass
1121
1585
func1 and func2 to the "call_both" function
1122
1586
outside of its arguments"""
1587
1588
@functools.wraps(func2)
1123
1589
def call_both(*args, **kwargs):
1124
1590
"""This function will emit two D-Bus
1125
1591
signals by calling func1 and func2"""
1126
1592
func1(*args, **kwargs)
1127
1593
func2(*args, **kwargs)
1594
# Make wrapper function look like a D-Bus signal
1595
for name, attr in inspect.getmembers(func2):
1596
if name.startswith("_dbus_"):
1597
setattr(call_both, name, attr)
1598
1128
1599
return call_both
1129
1600
# Create the "call_both" function and add it to
1130
1601
# the class
1135
1606
# object. Decorate it to be a new D-Bus method
1136
1607
# with the alternate D-Bus interface name. Add it
1137
1608
# to the class.
1138
attr[attrname] = (dbus.service.method
1139
(alt_interface,
1140
attribute._dbus_in_signature,
1141
attribute._dbus_out_signature)
1142
(types.FunctionType
1143
(attribute.func_code,
1144
attribute.func_globals,
1145
attribute.func_name,
1146
attribute.func_defaults,
1147
attribute.func_closure)))
1609
attr[attrname] = (
1610
dbus.service.method(
1611
alt_interface,
1612
attribute._dbus_in_signature,
1613
attribute._dbus_out_signature)
1614
(copy_function(attribute)))
1148
1615
# Copy annotations, if any
1149
1616
try:
1150
attr[attrname]._dbus_annotations = (
1151
dict(attribute._dbus_annotations))
1617
attr[attrname]._dbus_annotations = dict(
1618
attribute._dbus_annotations)
1152
1619
except AttributeError:
1153
1620
pass
1154
1621
# Is this a D-Bus property?
1157
1624
# object, and decorate it to be a new D-Bus
1158
1625
# property with the alternate D-Bus interface
1159
1626
# name. Add it to the class.
1160
attr[attrname] = (dbus_service_property
1161
(alt_interface,
1162
attribute._dbus_signature,
1163
attribute._dbus_access,
1164
attribute
1165
._dbus_get_args_options
1166
["byte_arrays"])
1167
(types.FunctionType
1168
(attribute.func_code,
1169
attribute.func_globals,
1170
attribute.func_name,
1171
attribute.func_defaults,
1172
attribute.func_closure)))
1627
attr[attrname] = (dbus_service_property(
1628
alt_interface, attribute._dbus_signature,
1629
attribute._dbus_access,
1630
attribute._dbus_get_args_options
1631
["byte_arrays"])
1632
(copy_function(attribute)))
1173
1633
# Copy annotations, if any
1174
1634
try:
1175
attr[attrname]._dbus_annotations = (
1176
dict(attribute._dbus_annotations))
1635
attr[attrname]._dbus_annotations = dict(
1636
attribute._dbus_annotations)
1177
1637
except AttributeError:
1178
1638
pass
1179
1639
# Is this a D-Bus interface?
1182
1642
# object. Decorate it to be a new D-Bus interface
1183
1643
# with the alternate D-Bus interface name. Add it
1184
1644
# to the class.
1185
attr[attrname] = (dbus_interface_annotations
1186
(alt_interface)
1187
(types.FunctionType
1188
(attribute.func_code,
1189
attribute.func_globals,
1190
attribute.func_name,
1191
attribute.func_defaults,
1192
attribute.func_closure)))
1645
attr[attrname] = (
1646
dbus_interface_annotations(alt_interface)
1647
(copy_function(attribute)))
1193
1648
if deprecate:
1194
1649
# Deprecate all alternate interfaces
1195
1650
iname="_AlternateDBusNames_interface_annotation{}"
1196
1651
for interface_name in interface_names:
1652
1197
1653
@dbus_interface_annotations(interface_name)
1198
1654
def func(self):
1199
1655
return { "org.freedesktop.DBus.Deprecated":
1200
"true" }
1656
"true" }
1201
1657
# Find an unused name
1202
1658
for aname in (iname.format(i)
1203
1659
for i in itertools.count()):
1207
1663
if interface_names:
1208
1664
# Replace the class with a new subclass of it with
1209
1665
# methods, signals, etc. as created above.
1210
cls = type(b"{}Alternate".format(cls.__name__),
1211
(cls,), attr)
1666
if sys.version_info.major == 2:
1667
cls = type(b"{}Alternate".format(cls.__name__),
1668
(cls, ), attr)
1669
else:
1670
cls = type("{}Alternate".format(cls.__name__),
1671
(cls, ), attr)
1212
1672
return cls
1673
1213
1674
return wrapper
1214
1675
1215
1676
1216
1677
@alternate_dbus_interfaces({"se.recompile.Mandos":
1217
"se.bsnet.fukt.Mandos"})
1678
"se.bsnet.fukt.Mandos"})
1218
1679
class ClientDBus(Client, DBusObjectWithProperties):
1219
1680
"""A Client class using D-Bus
1220
1681
1224
1685
"""
1225
1686
1226
1687
runtime_expansions = (Client.runtime_expansions
1227
+ ("dbus_object_path",))
1688
+ ("dbus_object_path", ))
1228
1689
1229
1690
_interface = "se.recompile.Mandos.Client"
1230
1691
1238
1699
client_object_name = str(self.name).translate(
1239
1700
{ord("."): ord("_"),
1240
1701
ord("-"): ord("_")})
1241
self.dbus_object_path = (dbus.ObjectPath
1242
("/clients/" + client_object_name))
1702
self.dbus_object_path = dbus.ObjectPath(
1703
"/clients/" + client_object_name)
1243
1704
DBusObjectWithProperties.__init__(self, self.bus,
1244
1705
self.dbus_object_path)
1245
1706
1246
def notifychangeproperty(transform_func,
1247
dbus_name, type_func=lambda x: x,
1248
variant_level=1, invalidate_only=False,
1707
def notifychangeproperty(transform_func, dbus_name,
1708
type_func=lambda x: x,
1709
variant_level=1,
1710
invalidate_only=False,
1249
1711
_interface=_interface):
1250
1712
""" Modify a variable so that it's a property which announces
1251
1713
its changes to DBus.
1258
1720
variant_level: D-Bus variant level. Default: 1
1259
1721
"""
1260
1722
attrname = "_{}".format(dbus_name)
1723
1261
1724
def setter(self, value):
1262
1725
if hasattr(self, "dbus_object_path"):
1263
1726
if (not hasattr(self, attrname) or
1264
1727
type_func(getattr(self, attrname, None))
1265
1728
!= type_func(value)):
1266
1729
if invalidate_only:
1267
self.PropertiesChanged(_interface,
1268
dbus.Dictionary(),
1269
dbus.Array
1270
((dbus_name,)))
1730
self.PropertiesChanged(
1731
_interface, dbus.Dictionary(),
1732
dbus.Array((dbus_name, )))
1271
1733
else:
1272
dbus_value = transform_func(type_func(value),
1273
variant_level
1274
=variant_level)
1734
dbus_value = transform_func(
1735
type_func(value),
1736
variant_level = variant_level)
1275
1737
self.PropertyChanged(dbus.String(dbus_name),
1276
1738
dbus_value)
1277
self.PropertiesChanged(_interface,
1278
dbus.Dictionary({
1279
dbus.String(dbus_name):
1280
dbus_value }), dbus.Array())
1739
self.PropertiesChanged(
1740
_interface,
1741
dbus.Dictionary({ dbus.String(dbus_name):
1742
dbus_value }),
1743
dbus.Array())
1281
1744
setattr(self, attrname, value)
1282
1745
1283
1746
return property(lambda self: getattr(self, attrname), setter)
1289
1752
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1290
1753
last_enabled = notifychangeproperty(datetime_to_dbus,
1291
1754
"LastEnabled")
1292
checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1293
type_func = lambda checker:
1294
checker is not None)
1755
checker = notifychangeproperty(
1756
dbus.Boolean, "CheckerRunning",
1757
type_func = lambda checker: checker is not None)
1295
1758
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1296
1759
"LastCheckedOK")
1297
1760
last_checker_status = notifychangeproperty(dbus.Int16,
1300
1763
datetime_to_dbus, "LastApprovalRequest")
1301
1764
approved_by_default = notifychangeproperty(dbus.Boolean,
1302
1765
"ApprovedByDefault")
1303
approval_delay = notifychangeproperty(dbus.UInt64,
1304
"ApprovalDelay",
1305
type_func =
1306
lambda td: td.total_seconds()
1307
* 1000)
1766
approval_delay = notifychangeproperty(
1767
dbus.UInt64, "ApprovalDelay",
1768
type_func = lambda td: td.total_seconds() * 1000)
1308
1769
approval_duration = notifychangeproperty(
1309
1770
dbus.UInt64, "ApprovalDuration",
1310
1771
type_func = lambda td: td.total_seconds() * 1000)
1311
1772
host = notifychangeproperty(dbus.String, "Host")
1312
timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1313
type_func = lambda td:
1314
td.total_seconds() * 1000)
1773
timeout = notifychangeproperty(
1774
dbus.UInt64, "Timeout",
1775
type_func = lambda td: td.total_seconds() * 1000)
1315
1776
extended_timeout = notifychangeproperty(
1316
1777
dbus.UInt64, "ExtendedTimeout",
1317
1778
type_func = lambda td: td.total_seconds() * 1000)
1318
interval = notifychangeproperty(dbus.UInt64,
1319
"Interval",
1320
type_func =
1321
lambda td: td.total_seconds()
1322
* 1000)
1779
interval = notifychangeproperty(
1780
dbus.UInt64, "Interval",
1781
type_func = lambda td: td.total_seconds() * 1000)
1323
1782
checker_command = notifychangeproperty(dbus.String, "Checker")
1324
1783
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1325
1784
invalidate_only=True)
1335
1794
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1336
1795
Client.__del__(self, *args, **kwargs)
1337
1796
1338
def checker_callback(self, pid, condition, command,
1339
*args, **kwargs):
1340
self.checker_callback_tag = None
1341
self.checker = None
1342
if os.WIFEXITED(condition):
1343
exitstatus = os.WEXITSTATUS(condition)
1797
def checker_callback(self, source, condition,
1798
connection, command, *args, **kwargs):
1799
ret = Client.checker_callback(self, source, condition,
1800
connection, command, *args,
1801
**kwargs)
1802
exitstatus = self.last_checker_status
1803
if exitstatus >= 0:
1344
1804
# Emit D-Bus signal
1345
1805
self.CheckerCompleted(dbus.Int16(exitstatus),
1346
dbus.Int64(condition),
1806
# This is specific to GNU libC
1807
dbus.Int64(exitstatus << 8),
1347
1808
dbus.String(command))
1348
1809
else:
1349
1810
# Emit D-Bus signal
1350
1811
self.CheckerCompleted(dbus.Int16(-1),
1351
dbus.Int64(condition),
1812
dbus.Int64(
1813
# This is specific to GNU libC
1814
(exitstatus << 8)
1815
| self.last_checker_signal),
1352
1816
dbus.String(command))
1353
1354
return Client.checker_callback(self, pid, condition, command,
1355
*args, **kwargs)
1817
return ret
1356
1818
1357
1819
def start_checker(self, *args, **kwargs):
1358
1820
old_checker_pid = getattr(self.checker, "pid", None)
1370
1832
1371
1833
def approve(self, value=True):
1372
1834
self.approved = value
1373
gobject.timeout_add(int(self.approval_duration.total_seconds()
1835
GObject.timeout_add(int(self.approval_duration.total_seconds()
1374
1836
* 1000), self._reset_approved)
1375
1837
self.send_changedstate()
1376
1838
1433
1895
self.checked_ok()
1434
1896
1435
1897
# Enable - method
1898
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1436
1899
@dbus.service.method(_interface)
1437
1900
def Enable(self):
1438
1901
"D-Bus method"
1439
1902
self.enable()
1440
1903
1441
1904
# StartChecker - method
1905
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1442
1906
@dbus.service.method(_interface)
1443
1907
def StartChecker(self):
1444
1908
"D-Bus method"
1445
1909
self.start_checker()
1446
1910
1447
1911
# Disable - method
1912
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1448
1913
@dbus.service.method(_interface)
1449
1914
def Disable(self):
1450
1915
"D-Bus method"
1451
1916
self.disable()
1452
1917
1453
1918
# StopChecker - method
1919
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1454
1920
@dbus.service.method(_interface)
1455
1921
def StopChecker(self):
1456
1922
self.stop_checker()
1463
1929
return dbus.Boolean(bool(self.approvals_pending))
1464
1930
1465
1931
# ApprovedByDefault - property
1466
@dbus_service_property(_interface, signature="b",
1932
@dbus_service_property(_interface,
1933
signature="b",
1467
1934
access="readwrite")
1468
1935
def ApprovedByDefault_dbus_property(self, value=None):
1469
1936
if value is None: # get
1471
1938
self.approved_by_default = bool(value)
1472
1939
1473
1940
# ApprovalDelay - property
1474
@dbus_service_property(_interface, signature="t",
1941
@dbus_service_property(_interface,
1942
signature="t",
1475
1943
access="readwrite")
1476
1944
def ApprovalDelay_dbus_property(self, value=None):
1477
1945
if value is None: # get
1480
1948
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1481
1949
1482
1950
# ApprovalDuration - property
1483
@dbus_service_property(_interface, signature="t",
1951
@dbus_service_property(_interface,
1952
signature="t",
1484
1953
access="readwrite")
1485
1954
def ApprovalDuration_dbus_property(self, value=None):
1486
1955
if value is None: # get
1489
1958
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1490
1959
1491
1960
# Name - property
1961
@dbus_annotations(
1962
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1492
1963
@dbus_service_property(_interface, signature="s", access="read")
1493
1964
def Name_dbus_property(self):
1494
1965
return dbus.String(self.name)
1495
1966
1496
1967
# Fingerprint - property
1968
@dbus_annotations(
1969
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1497
1970
@dbus_service_property(_interface, signature="s", access="read")
1498
1971
def Fingerprint_dbus_property(self):
1499
1972
return dbus.String(self.fingerprint)
1500
1973
1501
1974
# Host - property
1502
@dbus_service_property(_interface, signature="s",
1975
@dbus_service_property(_interface,
1976
signature="s",
1503
1977
access="readwrite")
1504
1978
def Host_dbus_property(self, value=None):
1505
1979
if value is None: # get
1507
1981
self.host = str(value)
1508
1982
1509
1983
# Created - property
1984
@dbus_annotations(
1985
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1510
1986
@dbus_service_property(_interface, signature="s", access="read")
1511
1987
def Created_dbus_property(self):
1512
1988
return datetime_to_dbus(self.created)
1517
1993
return datetime_to_dbus(self.last_enabled)
1518
1994
1519
1995
# Enabled - property
1520
@dbus_service_property(_interface, signature="b",
1996
@dbus_service_property(_interface,
1997
signature="b",
1521
1998
access="readwrite")
1522
1999
def Enabled_dbus_property(self, value=None):
1523
2000
if value is None: # get
1528
2005
self.disable()
1529
2006
1530
2007
# LastCheckedOK - property
1531
@dbus_service_property(_interface, signature="s",
2008
@dbus_service_property(_interface,
2009
signature="s",
1532
2010
access="readwrite")
1533
2011
def LastCheckedOK_dbus_property(self, value=None):
1534
2012
if value is not None:
1537
2015
return datetime_to_dbus(self.last_checked_ok)
1538
2016
1539
2017
# LastCheckerStatus - property
1540
@dbus_service_property(_interface, signature="n",
1541
access="read")
2018
@dbus_service_property(_interface, signature="n", access="read")
1542
2019
def LastCheckerStatus_dbus_property(self):
1543
2020
return dbus.Int16(self.last_checker_status)
1544
2021
1553
2030
return datetime_to_dbus(self.last_approval_request)
1554
2031
1555
2032
# Timeout - property
1556
@dbus_service_property(_interface, signature="t",
2033
@dbus_service_property(_interface,
2034
signature="t",
1557
2035
access="readwrite")
1558
2036
def Timeout_dbus_property(self, value=None):
1559
2037
if value is None: # get
1571
2049
if (getattr(self, "disable_initiator_tag", None)
1572
2050
is None):
1573
2051
return
1574
gobject.source_remove(self.disable_initiator_tag)
1575
self.disable_initiator_tag = (
1576
gobject.timeout_add(
1577
int((self.expires - now).total_seconds()
1578
* 1000), self.disable))
2052
GObject.source_remove(self.disable_initiator_tag)
2053
self.disable_initiator_tag = GObject.timeout_add(
2054
int((self.expires - now).total_seconds() * 1000),
2055
self.disable)
1579
2056
1580
2057
# ExtendedTimeout - property
1581
@dbus_service_property(_interface, signature="t",
2058
@dbus_service_property(_interface,
2059
signature="t",
1582
2060
access="readwrite")
1583
2061
def ExtendedTimeout_dbus_property(self, value=None):
1584
2062
if value is None: # get
1587
2065
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1588
2066
1589
2067
# Interval - property
1590
@dbus_service_property(_interface, signature="t",
2068
@dbus_service_property(_interface,
2069
signature="t",
1591
2070
access="readwrite")
1592
2071
def Interval_dbus_property(self, value=None):
1593
2072
if value is None: # get
1597
2076
return
1598
2077
if self.enabled:
1599
2078
# Reschedule checker run
1600
gobject.source_remove(self.checker_initiator_tag)
1601
self.checker_initiator_tag = (gobject.timeout_add
1602
(value, self.start_checker))
1603
self.start_checker() # Start one now, too
2079
GObject.source_remove(self.checker_initiator_tag)
2080
self.checker_initiator_tag = GObject.timeout_add(
2081
value, self.start_checker)
2082
self.start_checker() # Start one now, too
1604
2083
1605
2084
# Checker - property
1606
@dbus_service_property(_interface, signature="s",
2085
@dbus_service_property(_interface,
2086
signature="s",
1607
2087
access="readwrite")
1608
2088
def Checker_dbus_property(self, value=None):
1609
2089
if value is None: # get
1611
2091
self.checker_command = str(value)
1612
2092
1613
2093
# CheckerRunning - property
1614
@dbus_service_property(_interface, signature="b",
2094
@dbus_service_property(_interface,
2095
signature="b",
1615
2096
access="readwrite")
1616
2097
def CheckerRunning_dbus_property(self, value=None):
1617
2098
if value is None: # get
1622
2103
self.stop_checker()
1623
2104
1624
2105
# ObjectPath - property
2106
@dbus_annotations(
2107
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
2108
"org.freedesktop.DBus.Deprecated": "true"})
1625
2109
@dbus_service_property(_interface, signature="o", access="read")
1626
2110
def ObjectPath_dbus_property(self):
1627
2111
return self.dbus_object_path # is already a dbus.ObjectPath
1628
2112
1629
2113
# Secret = property
1630
@dbus_service_property(_interface, signature="ay",
1631
access="write", byte_arrays=True)
2114
@dbus_annotations(
2115
{"org.freedesktop.DBus.Property.EmitsChangedSignal":
2116
"invalidates"})
2117
@dbus_service_property(_interface,
2118
signature="ay",
2119
access="write",
2120
byte_arrays=True)
1632
2121
def Secret_dbus_property(self, value):
1633
2122
self.secret = bytes(value)
1634
2123
1640
2129
self._pipe = child_pipe
1641
2130
self._pipe.send(('init', fpr, address))
1642
2131
if not self._pipe.recv():
1643
raise KeyError()
2132
raise KeyError(fpr)
1644
2133
1645
2134
def __getattribute__(self, name):
1646
2135
if name == '_pipe':
1650
2139
if data[0] == 'data':
1651
2140
return data[1]
1652
2141
if data[0] == 'function':
2142
1653
2143
def func(*args, **kwargs):
1654
2144
self._pipe.send(('funcall', name, args, kwargs))
1655
2145
return self._pipe.recv()[1]
2146
1656
2147
return func
1657
2148
1658
2149
def __setattr__(self, name, value):
1674
2165
logger.debug("Pipe FD: %d",
1675
2166
self.server.child_pipe.fileno())
1676
2167
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.
2168
session = gnutls.ClientSession(self.request)
1686
2169
1687
2170
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1688
2171
# "+AES-256-CBC", "+SHA1",
1692
2175
priority = self.server.gnutls_priority
1693
2176
if priority is None:
1694
2177
priority = "NORMAL"
1695
(gnutls.library.functions
1696
.gnutls_priority_set_direct(session._c_object,
1697
priority, None))
2178
gnutls.priority_set_direct(session._c_object, priority,
2179
None)
1698
2180
1699
2181
# Start communication using the Mandos protocol
1700
2182
# Get protocol number
1710
2192
# Start GnuTLS connection
1711
2193
try:
1712
2194
session.handshake()
1713
except gnutls.errors.GNUTLSError as error:
2195
except gnutls.Error as error:
1714
2196
logger.warning("Handshake failed: %s", error)
1715
2197
# Do not run session.bye() here: the session is not
1716
2198
# established. Just abandon the request.
1720
2202
approval_required = False
1721
2203
try:
1722
2204
try:
1723
fpr = self.fingerprint(self.peer_certificate
1724
(session))
1725
except (TypeError,
1726
gnutls.errors.GNUTLSError) as error:
2205
fpr = self.fingerprint(
2206
self.peer_certificate(session))
2207
except (TypeError, gnutls.Error) as error:
1727
2208
logger.warning("Bad certificate: %s", error)
1728
2209
return
1729
2210
logger.debug("Fingerprint: %s", fpr)
1742
2223
while True:
1743
2224
if not client.enabled:
1744
2225
logger.info("Client %s is disabled",
1745
client.name)
2226
client.name)
1746
2227
if self.server.use_dbus:
1747
2228
# Emit D-Bus signal
1748
2229
client.Rejected("Disabled")
1787
2268
else:
1788
2269
delay -= time2 - time
1789
2270
1790
sent_size = 0
1791
while sent_size < len(client.secret):
1792
try:
1793
sent = session.send(client.secret[sent_size:])
1794
except gnutls.errors.GNUTLSError as error:
1795
logger.warning("gnutls send failed",
1796
exc_info=error)
1797
return
1798
logger.debug("Sent: %d, remaining: %d",
1799
sent, len(client.secret)
1800
- (sent_size + sent))
1801
sent_size += sent
2271
try:
2272
session.send(client.secret)
2273
except gnutls.Error as error:
2274
logger.warning("gnutls send failed",
2275
exc_info = error)
2276
return
1802
2277
1803
2278
logger.info("Sending secret to %s", client.name)
1804
2279
# bump the timeout using extended_timeout
1812
2287
client.approvals_pending -= 1
1813
2288
try:
1814
2289
session.bye()
1815
except gnutls.errors.GNUTLSError as error:
2290
except gnutls.Error as error:
1816
2291
logger.warning("GnuTLS bye failed",
1817
2292
exc_info=error)
1818
2293
1820
2295
def peer_certificate(session):
1821
2296
"Return the peer's OpenPGP certificate as a bytestring"
1822
2297
# If not an OpenPGP certificate...
1823
if (gnutls.library.functions
1824
.gnutls_certificate_type_get(session._c_object)
1825
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1826
# ...do the normal thing
1827
return session.peer_certificate
2298
if (gnutls.certificate_type_get(session._c_object)
2299
!= gnutls.CRT_OPENPGP):
2300
# ...return invalid data
2301
return b""
1828
2302
list_size = ctypes.c_uint(1)
1829
cert_list = (gnutls.library.functions
1830
.gnutls_certificate_get_peers
2303
cert_list = (gnutls.certificate_get_peers
1831
2304
(session._c_object, ctypes.byref(list_size)))
1832
2305
if not bool(cert_list) and list_size.value != 0:
1833
raise gnutls.errors.GNUTLSError("error getting peer"
1834
" certificate")
2306
raise gnutls.Error("error getting peer certificate")
1835
2307
if list_size.value == 0:
1836
2308
return None
1837
2309
cert = cert_list[0]
1841
2313
def fingerprint(openpgp):
1842
2314
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
1843
2315
# New GnuTLS "datum" with the OpenPGP public key
1844
datum = (gnutls.library.types
1845
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1846
ctypes.POINTER
1847
(ctypes.c_ubyte)),
1848
ctypes.c_uint(len(openpgp))))
2316
datum = gnutls.datum_t(
2317
ctypes.cast(ctypes.c_char_p(openpgp),
2318
ctypes.POINTER(ctypes.c_ubyte)),
2319
ctypes.c_uint(len(openpgp)))
1849
2320
# New empty GnuTLS certificate
1850
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1851
(gnutls.library.functions
1852
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2321
crt = gnutls.openpgp_crt_t()
2322
gnutls.openpgp_crt_init(ctypes.byref(crt))
1853
2323
# Import the OpenPGP public key into the certificate
1854
(gnutls.library.functions
1855
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1856
gnutls.library.constants
1857
.GNUTLS_OPENPGP_FMT_RAW))
2324
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2325
gnutls.OPENPGP_FMT_RAW)
1858
2326
# Verify the self signature in the key
1859
2327
crtverify = ctypes.c_uint()
1860
(gnutls.library.functions
1861
.gnutls_openpgp_crt_verify_self(crt, 0,
1862
ctypes.byref(crtverify)))
2328
gnutls.openpgp_crt_verify_self(crt, 0,
2329
ctypes.byref(crtverify))
1863
2330
if crtverify.value != 0:
1864
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1865
raise (gnutls.errors.CertificateSecurityError
1866
("Verify failed"))
2331
gnutls.openpgp_crt_deinit(crt)
2332
raise gnutls.CertificateSecurityError("Verify failed")
1867
2333
# New buffer for the fingerprint
1868
2334
buf = ctypes.create_string_buffer(20)
1869
2335
buf_len = ctypes.c_size_t()
1870
2336
# Get the fingerprint from the certificate into the buffer
1871
(gnutls.library.functions
1872
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1873
ctypes.byref(buf_len)))
2337
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2338
ctypes.byref(buf_len))
1874
2339
# Deinit the certificate
1875
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2340
gnutls.openpgp_crt_deinit(crt)
1876
2341
# Convert the buffer to a Python bytestring
1877
2342
fpr = ctypes.string_at(buf, buf_len.value)
1878
2343
# Convert the bytestring to hexadecimal notation
1882
2347
1883
2348
class MultiprocessingMixIn(object):
1884
2349
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2350
1885
2351
def sub_process_main(self, request, address):
1886
2352
try:
1887
2353
self.finish_request(request, address)
1899
2365
1900
2366
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1901
2367
""" adds a pipe to the MixIn """
2368
1902
2369
def process_request(self, request, client_address):
1903
2370
"""Overrides and wraps the original process_request().
1904
2371
1925
2392
interface: None or a network interface name (string)
1926
2393
use_ipv6: Boolean; to use IPv6 or not
1927
2394
"""
2395
1928
2396
def __init__(self, server_address, RequestHandlerClass,
1929
interface=None, use_ipv6=True, socketfd=None):
2397
interface=None,
2398
use_ipv6=True,
2399
socketfd=None):
1930
2400
"""If socketfd is set, use that file descriptor instead of
1931
2401
creating a new one with socket.socket().
1932
2402
"""
1973
2443
self.interface)
1974
2444
else:
1975
2445
try:
1976
self.socket.setsockopt(socket.SOL_SOCKET,
1977
SO_BINDTODEVICE,
1978
(self.interface + "\0")
1979
.encode("utf-8"))
2446
self.socket.setsockopt(
2447
socket.SOL_SOCKET, SO_BINDTODEVICE,
2448
(self.interface + "\0").encode("utf-8"))
1980
2449
except socket.error as error:
1981
2450
if error.errno == errno.EPERM:
1982
2451
logger.error("No permission to bind to"
2000
2469
self.server_address = (any_address,
2001
2470
self.server_address[1])
2002
2471
elif not self.server_address[1]:
2003
self.server_address = (self.server_address[0],
2004
0)
2472
self.server_address = (self.server_address[0], 0)
2005
2473
# if self.interface:
2006
2474
# self.server_address = (self.server_address[0],
2007
2475
# 0, # port
2019
2487
gnutls_priority GnuTLS priority string
2020
2488
use_dbus: Boolean; to emit D-Bus signals or not
2021
2489
2022
Assumes a gobject.MainLoop event loop.
2490
Assumes a GObject.MainLoop event loop.
2023
2491
"""
2492
2024
2493
def __init__(self, server_address, RequestHandlerClass,
2025
interface=None, use_ipv6=True, clients=None,
2026
gnutls_priority=None, use_dbus=True, socketfd=None):
2494
interface=None,
2495
use_ipv6=True,
2496
clients=None,
2497
gnutls_priority=None,
2498
use_dbus=True,
2499
socketfd=None):
2027
2500
self.enabled = False
2028
2501
self.clients = clients
2029
2502
if self.clients is None:
2035
2508
interface = interface,
2036
2509
use_ipv6 = use_ipv6,
2037
2510
socketfd = socketfd)
2511
2038
2512
def server_activate(self):
2039
2513
if self.enabled:
2040
2514
return socketserver.TCPServer.server_activate(self)
2044
2518
2045
2519
def add_pipe(self, parent_pipe, proc):
2046
2520
# Call "handle_ipc" for both data and EOF events
2047
gobject.io_add_watch(parent_pipe.fileno(),
2048
gobject.IO_IN | gobject.IO_HUP,
2049
functools.partial(self.handle_ipc,
2050
parent_pipe =
2051
parent_pipe,
2052
proc = proc))
2521
GObject.io_add_watch(
2522
parent_pipe.fileno(),
2523
GObject.IO_IN | GObject.IO_HUP,
2524
functools.partial(self.handle_ipc,
2525
parent_pipe = parent_pipe,
2526
proc = proc))
2053
2527
2054
def handle_ipc(self, source, condition, parent_pipe=None,
2055
proc = None, client_object=None):
2528
def handle_ipc(self, source, condition,
2529
parent_pipe=None,
2530
proc = None,
2531
client_object=None):
2056
2532
# error, or the other end of multiprocessing.Pipe has closed
2057
if condition & (gobject.IO_ERR | gobject.IO_HUP):
2533
if condition & (GObject.IO_ERR | GObject.IO_HUP):
2058
2534
# Wait for other process to exit
2059
2535
proc.join()
2060
2536
return False
2067
2543
fpr = request[1]
2068
2544
address = request[2]
2069
2545
2070
for c in self.clients.itervalues():
2546
for c in self.clients.values():
2071
2547
if c.fingerprint == fpr:
2072
2548
client = c
2073
2549
break
2081
2557
parent_pipe.send(False)
2082
2558
return False
2083
2559
2084
gobject.io_add_watch(parent_pipe.fileno(),
2085
gobject.IO_IN | gobject.IO_HUP,
2086
functools.partial(self.handle_ipc,
2087
parent_pipe =
2088
parent_pipe,
2089
proc = proc,
2090
client_object =
2091
client))
2560
GObject.io_add_watch(
2561
parent_pipe.fileno(),
2562
GObject.IO_IN | GObject.IO_HUP,
2563
functools.partial(self.handle_ipc,
2564
parent_pipe = parent_pipe,
2565
proc = proc,
2566
client_object = client))
2092
2567
parent_pipe.send(True)
2093
2568
# remove the old hook in favor of the new above hook on
2094
2569
# same fileno
2100
2575
2101
2576
parent_pipe.send(('data', getattr(client_object,
2102
2577
funcname)(*args,
2103
**kwargs)))
2578
**kwargs)))
2104
2579
2105
2580
if command == 'getattr':
2106
2581
attrname = request[1]
2107
if callable(client_object.__getattribute__(attrname)):
2108
parent_pipe.send(('function',))
2582
if isinstance(client_object.__getattribute__(attrname),
2583
collections.Callable):
2584
parent_pipe.send(('function', ))
2109
2585
else:
2110
parent_pipe.send(('data', client_object
2111
.__getattribute__(attrname)))
2586
parent_pipe.send((
2587
'data', client_object.__getattribute__(attrname)))
2112
2588
2113
2589
if command == 'setattr':
2114
2590
attrname = request[1]
2145
2621
# avoid excessive use of external libraries.
2146
2622
2147
2623
# New type for defining tokens, syntax, and semantics all-in-one
2148
Token = collections.namedtuple("Token",
2149
("regexp", # To match token; if
2150
# "value" is not None,
2151
# must have a "group"
2152
# containing digits
2153
"value", # datetime.timedelta or
2154
# None
2155
"followers")) # Tokens valid after
2156
# this token
2624
Token = collections.namedtuple("Token", (
2625
"regexp", # To match token; if "value" is not None, must have
2626
# a "group" containing digits
2627
"value", # datetime.timedelta or None
2628
"followers")) # Tokens valid after this token
2157
2629
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2158
2630
# the "duration" ABNF definition in RFC 3339, Appendix A.
2159
2631
token_end = Token(re.compile(r"$"), None, frozenset())
2160
2632
token_second = Token(re.compile(r"(\d+)S"),
2161
2633
datetime.timedelta(seconds=1),
2162
frozenset((token_end,)))
2634
frozenset((token_end, )))
2163
2635
token_minute = Token(re.compile(r"(\d+)M"),
2164
2636
datetime.timedelta(minutes=1),
2165
2637
frozenset((token_second, token_end)))
2181
2653
frozenset((token_month, token_end)))
2182
2654
token_week = Token(re.compile(r"(\d+)W"),
2183
2655
datetime.timedelta(weeks=1),
2184
frozenset((token_end,)))
2656
frozenset((token_end, )))
2185
2657
token_duration = Token(re.compile(r"P"), None,
2186
2658
frozenset((token_year, token_month,
2187
2659
token_day, token_time,
2189
2661
# Define starting values
2190
2662
value = datetime.timedelta() # Value so far
2191
2663
found_token = None
2192
followers = frozenset((token_duration,)) # Following valid tokens
2664
followers = frozenset((token_duration, )) # Following valid tokens
2193
2665
s = duration # String left to parse
2194
2666
# Loop until end token is found
2195
2667
while found_token is not token_end:
2212
2684
break
2213
2685
else:
2214
2686
# No currently valid tokens were found
2215
raise ValueError("Invalid RFC 3339 duration")
2687
raise ValueError("Invalid RFC 3339 duration: {!r}"
2688
.format(duration))
2216
2689
# End token found
2217
2690
return value
2218
2691
2255
2728
elif suffix == "w":
2256
2729
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2257
2730
else:
2258
raise ValueError("Unknown suffix {!r}"
2259
.format(suffix))
2731
raise ValueError("Unknown suffix {!r}".format(suffix))
2260
2732
except IndexError as e:
2261
2733
raise ValueError(*(e.args))
2262
2734
timevalue += delta
2278
2750
# Close all standard open file descriptors
2279
2751
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2280
2752
if not stat.S_ISCHR(os.fstat(null).st_mode):
2281
raise OSError(errno.ENODEV, "{} not a character device"
2753
raise OSError(errno.ENODEV,
2754
"{} not a character device"
2282
2755
.format(os.devnull))
2283
2756
os.dup2(null, sys.stdin.fileno())
2284
2757
os.dup2(null, sys.stdout.fileno())
2350
2823
"port": "",
2351
2824
"debug": "False",
2352
2825
"priority":
2353
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",
2826
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2827
":+SIGN-DSA-SHA256",
2354
2828
"servicename": "Mandos",
2355
2829
"use_dbus": "True",
2356
2830
"use_ipv6": "True",
2360
2834
"statedir": "/var/lib/mandos",
2361
2835
"foreground": "False",
2362
2836
"zeroconf": "True",
2363
}
2837
}
2364
2838
2365
2839
# Parse config file for server-global settings
2366
2840
server_config = configparser.SafeConfigParser(server_defaults)
2367
2841
del server_defaults
2368
server_config.read(os.path.join(options.configdir,
2369
"mandos.conf"))
2842
server_config.read(os.path.join(options.configdir, "mandos.conf"))
2370
2843
# Convert the SafeConfigParser object to a dict
2371
2844
server_settings = server_config.defaults()
2372
2845
# Use the appropriate methods on the non-string config options
2390
2863
# Override the settings from the config file with command line
2391
2864
# options, if set.
2392
2865
for option in ("interface", "address", "port", "debug",
2393
"priority", "servicename", "configdir",
2394
"use_dbus", "use_ipv6", "debuglevel", "restore",
2395
"statedir", "socket", "foreground", "zeroconf"):
2866
"priority", "servicename", "configdir", "use_dbus",
2867
"use_ipv6", "debuglevel", "restore", "statedir",
2868
"socket", "foreground", "zeroconf"):
2396
2869
value = getattr(options, option)
2397
2870
if value is not None:
2398
2871
server_settings[option] = value
2413
2886
2414
2887
##################################################################
2415
2888
2416
if (not server_settings["zeroconf"] and
2417
not (server_settings["port"]
2418
or server_settings["socket"] != "")):
2419
parser.error("Needs port or socket to work without"
2420
" Zeroconf")
2889
if (not server_settings["zeroconf"]
2890
and not (server_settings["port"]
2891
or server_settings["socket"] != "")):
2892
parser.error("Needs port or socket to work without Zeroconf")
2421
2893
2422
2894
# For convenience
2423
2895
debug = server_settings["debug"]
2439
2911
initlogger(debug, level)
2440
2912
2441
2913
if server_settings["servicename"] != "Mandos":
2442
syslogger.setFormatter(logging.Formatter
2443
('Mandos ({}) [%(process)d]:'
2444
' %(levelname)s: %(message)s'
2445
.format(server_settings
2446
["servicename"])))
2914
syslogger.setFormatter(
2915
logging.Formatter('Mandos ({}) [%(process)d]:'
2916
' %(levelname)s: %(message)s'.format(
2917
server_settings["servicename"])))
2447
2918
2448
2919
# Parse config file with clients
2449
2920
client_config = configparser.SafeConfigParser(Client
2457
2928
socketfd = None
2458
2929
if server_settings["socket"] != "":
2459
2930
socketfd = server_settings["socket"]
2460
tcp_server = MandosServer((server_settings["address"],
2461
server_settings["port"]),
2462
ClientHandler,
2463
interface=(server_settings["interface"]
2464
or None),
2465
use_ipv6=use_ipv6,
2466
gnutls_priority=
2467
server_settings["priority"],
2468
use_dbus=use_dbus,
2469
socketfd=socketfd)
2931
tcp_server = MandosServer(
2932
(server_settings["address"], server_settings["port"]),
2933
ClientHandler,
2934
interface=(server_settings["interface"] or None),
2935
use_ipv6=use_ipv6,
2936
gnutls_priority=server_settings["priority"],
2937
use_dbus=use_dbus,
2938
socketfd=socketfd)
2470
2939
if not foreground:
2471
2940
pidfilename = "/run/mandos.pid"
2472
2941
if not os.path.isdir("/run/."):
2473
2942
pidfilename = "/var/run/mandos.pid"
2474
2943
pidfile = None
2475
2944
try:
2476
pidfile = open(pidfilename, "w")
2945
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
2477
2946
except IOError as e:
2478
2947
logger.error("Could not open file %r", pidfilename,
2479
2948
exc_info=e)
2480
2949
2481
for name in ("_mandos", "mandos", "nobody"):
2950
for name, group in (("_mandos", "_mandos"),
2951
("mandos", "mandos"),
2952
("nobody", "nogroup")):
2482
2953
try:
2483
2954
uid = pwd.getpwnam(name).pw_uid
2484
gid = pwd.getpwnam(name).pw_gid
2955
gid = pwd.getpwnam(group).pw_gid
2485
2956
break
2486
2957
except KeyError:
2487
2958
continue
2491
2962
try:
2492
2963
os.setgid(gid)
2493
2964
os.setuid(uid)
2965
if debug:
2966
logger.debug("Did setuid/setgid to {}:{}".format(uid,
2967
gid))
2494
2968
except OSError as error:
2969
logger.warning("Failed to setuid/setgid to {}:{}: {}"
2970
.format(uid, gid, os.strerror(error.errno)))
2495
2971
if error.errno != errno.EPERM:
2496
2972
raise
2497
2973
2500
2976
2501
2977
# "Use a log level over 10 to enable all debugging options."
2502
2978
# - GnuTLS manual
2503
gnutls.library.functions.gnutls_global_set_log_level(11)
2979
gnutls.global_set_log_level(11)
2504
2980
2505
@gnutls.library.types.gnutls_log_func
2981
@gnutls.log_func
2506
2982
def debug_gnutls(level, string):
2507
2983
logger.debug("GnuTLS: %s", string[:-1])
2508
2984
2509
(gnutls.library.functions
2510
.gnutls_global_set_log_function(debug_gnutls))
2985
gnutls.global_set_log_function(debug_gnutls)
2511
2986
2512
2987
# Redirect stdin so all checkers get /dev/null
2513
2988
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2520
2995
# Close all input and output, do double fork, etc.
2521
2996
daemon()
2522
2997
2523
# multiprocessing will use threads, so before we use gobject we
2524
# need to inform gobject that threads will be used.
2525
gobject.threads_init()
2998
# multiprocessing will use threads, so before we use GObject we
2999
# need to inform GObject that threads will be used.
3000
GObject.threads_init()
2526
3001
2527
3002
global main_loop
2528
3003
# From the Avahi example code
2529
3004
DBusGMainLoop(set_as_default=True)
2530
main_loop = gobject.MainLoop()
3005
main_loop = GObject.MainLoop()
2531
3006
bus = dbus.SystemBus()
2532
3007
# End of Avahi example code
2533
3008
if use_dbus:
2534
3009
try:
2535
3010
bus_name = dbus.service.BusName("se.recompile.Mandos",
2536
bus, do_not_queue=True)
2537
old_bus_name = (dbus.service.BusName
2538
("se.bsnet.fukt.Mandos", bus,
2539
do_not_queue=True))
2540
except dbus.exceptions.NameExistsException as e:
3011
bus,
3012
do_not_queue=True)
3013
old_bus_name = dbus.service.BusName(
3014
"se.bsnet.fukt.Mandos", bus,
3015
do_not_queue=True)
3016
except dbus.exceptions.DBusException as e:
2541
3017
logger.error("Disabling D-Bus:", exc_info=e)
2542
3018
use_dbus = False
2543
3019
server_settings["use_dbus"] = False
2544
3020
tcp_server.use_dbus = False
2545
3021
if zeroconf:
2546
3022
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2547
service = AvahiServiceToSyslog(name =
2548
server_settings["servicename"],
2549
servicetype = "_mandos._tcp",
2550
protocol = protocol, bus = bus)
3023
service = AvahiServiceToSyslog(
3024
name = server_settings["servicename"],
3025
servicetype = "_mandos._tcp",
3026
protocol = protocol,
3027
bus = bus)
2551
3028
if server_settings["interface"]:
2552
service.interface = (if_nametoindex
2553
(server_settings["interface"]
2554
.encode("utf-8")))
3029
service.interface = if_nametoindex(
3030
server_settings["interface"].encode("utf-8"))
2555
3031
2556
3032
global multiprocessing_manager
2557
3033
multiprocessing_manager = multiprocessing.Manager()
2576
3052
if server_settings["restore"]:
2577
3053
try:
2578
3054
with open(stored_state_path, "rb") as stored_state:
2579
clients_data, old_client_settings = (pickle.load
2580
(stored_state))
3055
if sys.version_info.major == 2:
3056
clients_data, old_client_settings = pickle.load(
3057
stored_state)
3058
else:
3059
bytes_clients_data, bytes_old_client_settings = (
3060
pickle.load(stored_state, encoding = "bytes"))
3061
### Fix bytes to strings
3062
## clients_data
3063
# .keys()
3064
clients_data = { (key.decode("utf-8")
3065
if isinstance(key, bytes)
3066
else key): value
3067
for key, value in
3068
bytes_clients_data.items() }
3069
del bytes_clients_data
3070
for key in clients_data:
3071
value = { (k.decode("utf-8")
3072
if isinstance(k, bytes) else k): v
3073
for k, v in
3074
clients_data[key].items() }
3075
clients_data[key] = value
3076
# .client_structure
3077
value["client_structure"] = [
3078
(s.decode("utf-8")
3079
if isinstance(s, bytes)
3080
else s) for s in
3081
value["client_structure"] ]
3082
# .name & .host
3083
for k in ("name", "host"):
3084
if isinstance(value[k], bytes):
3085
value[k] = value[k].decode("utf-8")
3086
## old_client_settings
3087
# .keys()
3088
old_client_settings = {
3089
(key.decode("utf-8")
3090
if isinstance(key, bytes)
3091
else key): value
3092
for key, value in
3093
bytes_old_client_settings.items() }
3094
del bytes_old_client_settings
3095
# .host
3096
for value in old_client_settings.values():
3097
if isinstance(value["host"], bytes):
3098
value["host"] = (value["host"]
3099
.decode("utf-8"))
2581
3100
os.remove(stored_state_path)
2582
3101
except IOError as e:
2583
3102
if e.errno == errno.ENOENT:
2584
logger.warning("Could not load persistent state: {}"
2585
.format(os.strerror(e.errno)))
3103
logger.warning("Could not load persistent state:"
3104
" {}".format(os.strerror(e.errno)))
2586
3105
else:
2587
3106
logger.critical("Could not load persistent state:",
2588
3107
exc_info=e)
2589
3108
raise
2590
3109
except EOFError as e:
2591
3110
logger.warning("Could not load persistent state: "
2592
"EOFError:", exc_info=e)
3111
"EOFError:",
3112
exc_info=e)
2593
3113
2594
3114
with PGPEngine() as pgp:
2595
3115
for client_name, client in clients_data.items():
2607
3127
# For each value in new config, check if it
2608
3128
# differs from the old config value (Except for
2609
3129
# the "secret" attribute)
2610
if (name != "secret" and
2611
value != old_client_settings[client_name]
2612
[name]):
3130
if (name != "secret"
3131
and (value !=
3132
old_client_settings[client_name][name])):
2613
3133
client[name] = value
2614
3134
except KeyError:
2615
3135
pass
2616
3136
2617
3137
# Clients who has passed its expire date can still be
2618
# enabled if its last checker was successful. Clients
3138
# enabled if its last checker was successful. A Client
2619
3139
# whose checker succeeded before we stored its state is
2620
3140
# assumed to have successfully run all checkers during
2621
3141
# downtime.
2624
3144
if not client["last_checked_ok"]:
2625
3145
logger.warning(
2626
3146
"disabling client {} - Client never "
2627
"performed a successful checker"
2628
.format(client_name))
3147
"performed a successful checker".format(
3148
client_name))
2629
3149
client["enabled"] = False
2630
3150
elif client["last_checker_status"] != 0:
2631
3151
logger.warning(
2632
3152
"disabling client {} - Client last"
2633
" checker failed with error code {}"
2634
.format(client_name,
2635
client["last_checker_status"]))
3153
" checker failed with error code"
3154
" {}".format(
3155
client_name,
3156
client["last_checker_status"]))
2636
3157
client["enabled"] = False
2637
3158
else:
2638
client["expires"] = (datetime.datetime
2639
.utcnow()
2640
+ client["timeout"])
3159
client["expires"] = (
3160
datetime.datetime.utcnow()
3161
+ client["timeout"])
2641
3162
logger.debug("Last checker succeeded,"
2642
" keeping {} enabled"
2643
.format(client_name))
3163
" keeping {} enabled".format(
3164
client_name))
2644
3165
try:
2645
client["secret"] = (
2646
pgp.decrypt(client["encrypted_secret"],
2647
client_settings[client_name]
2648
["secret"]))
3166
client["secret"] = pgp.decrypt(
3167
client["encrypted_secret"],
3168
client_settings[client_name]["secret"])
2649
3169
except PGPError:
2650
3170
# If decryption fails, we use secret from new settings
2651
logger.debug("Failed to decrypt {} old secret"
2652
.format(client_name))
2653
client["secret"] = (
2654
client_settings[client_name]["secret"])
3171
logger.debug("Failed to decrypt {} old secret".format(
3172
client_name))
3173
client["secret"] = (client_settings[client_name]
3174
["secret"])
2655
3175
2656
3176
# Add/remove clients based on new changes made to config
2657
3177
for client_name in (set(old_client_settings)
2664
3184
# Create all client objects
2665
3185
for client_name, client in clients_data.items():
2666
3186
tcp_server.clients[client_name] = client_class(
2667
name = client_name, settings = client,
3187
name = client_name,
3188
settings = client,
2668
3189
server_settings = server_settings)
2669
3190
2670
3191
if not tcp_server.clients:
2672
3193
2673
3194
if not foreground:
2674
3195
if pidfile is not None:
3196
pid = os.getpid()
2675
3197
try:
2676
3198
with pidfile:
2677
pid = os.getpid()
2678
pidfile.write("{}\n".format(pid).encode("utf-8"))
3199
print(pid, file=pidfile)
2679
3200
except IOError:
2680
3201
logger.error("Could not write to file %r with PID %d",
2681
3202
pidfilename, pid)
2686
3207
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2687
3208
2688
3209
if use_dbus:
2689
@alternate_dbus_interfaces({"se.recompile.Mandos":
2690
"se.bsnet.fukt.Mandos"})
2691
class MandosDBusService(DBusObjectWithProperties):
3210
3211
@alternate_dbus_interfaces(
3212
{ "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
3213
class MandosDBusService(DBusObjectWithObjectManager):
2692
3214
"""A D-Bus proxy object"""
3215
2693
3216
def __init__(self):
2694
3217
dbus.service.Object.__init__(self, bus, "/")
3218
2695
3219
_interface = "se.recompile.Mandos"
2696
3220
2697
@dbus_interface_annotations(_interface)
2698
def _foo(self):
2699
return { "org.freedesktop.DBus.Property"
2700
".EmitsChangedSignal":
2701
"false"}
2702
2703
3221
@dbus.service.signal(_interface, signature="o")
2704
3222
def ClientAdded(self, objpath):
2705
3223
"D-Bus signal"
2710
3228
"D-Bus signal"
2711
3229
pass
2712
3230
3231
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3232
"true"})
2713
3233
@dbus.service.signal(_interface, signature="os")
2714
3234
def ClientRemoved(self, objpath, name):
2715
3235
"D-Bus signal"
2716
3236
pass
2717
3237
3238
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3239
"true"})
2718
3240
@dbus.service.method(_interface, out_signature="ao")
2719
3241
def GetAllClients(self):
2720
3242
"D-Bus method"
2721
return dbus.Array(c.dbus_object_path
2722
for c in
2723
tcp_server.clients.itervalues())
3243
return dbus.Array(c.dbus_object_path for c in
3244
tcp_server.clients.values())
2724
3245
3246
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3247
"true"})
2725
3248
@dbus.service.method(_interface,
2726
3249
out_signature="a{oa{sv}}")
2727
3250
def GetAllClientsWithProperties(self):
2728
3251
"D-Bus method"
2729
3252
return dbus.Dictionary(
2730
{ c.dbus_object_path: c.GetAll("")
2731
for c in tcp_server.clients.itervalues() },
3253
{ c.dbus_object_path: c.GetAll(
3254
"se.recompile.Mandos.Client")
3255
for c in tcp_server.clients.values() },
2732
3256
signature="oa{sv}")
2733
3257
2734
3258
@dbus.service.method(_interface, in_signature="o")
2735
3259
def RemoveClient(self, object_path):
2736
3260
"D-Bus method"
2737
for c in tcp_server.clients.itervalues():
3261
for c in tcp_server.clients.values():
2738
3262
if c.dbus_object_path == object_path:
2739
3263
del tcp_server.clients[c.name]
2740
3264
c.remove_from_connection()
2741
# Don't signal anything except ClientRemoved
3265
# Don't signal the disabling
2742
3266
c.disable(quiet=True)
2743
# Emit D-Bus signal
2744
self.ClientRemoved(object_path, c.name)
3267
# Emit D-Bus signal for removal
3268
self.client_removed_signal(c)
2745
3269
return
2746
3270
raise KeyError(object_path)
2747
3271
2748
3272
del _interface
3273
3274
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3275
out_signature = "a{oa{sa{sv}}}")
3276
def GetManagedObjects(self):
3277
"""D-Bus method"""
3278
return dbus.Dictionary(
3279
{ client.dbus_object_path:
3280
dbus.Dictionary(
3281
{ interface: client.GetAll(interface)
3282
for interface in
3283
client._get_all_interface_names()})
3284
for client in tcp_server.clients.values()})
3285
3286
def client_added_signal(self, client):
3287
"""Send the new standard signal and the old signal"""
3288
if use_dbus:
3289
# New standard signal
3290
self.InterfacesAdded(
3291
client.dbus_object_path,
3292
dbus.Dictionary(
3293
{ interface: client.GetAll(interface)
3294
for interface in
3295
client._get_all_interface_names()}))
3296
# Old signal
3297
self.ClientAdded(client.dbus_object_path)
3298
3299
def client_removed_signal(self, client):
3300
"""Send the new standard signal and the old signal"""
3301
if use_dbus:
3302
# New standard signal
3303
self.InterfacesRemoved(
3304
client.dbus_object_path,
3305
client._get_all_interface_names())
3306
# Old signal
3307
self.ClientRemoved(client.dbus_object_path,
3308
client.name)
2749
3309
2750
3310
mandos_dbus_service = MandosDBusService()
2751
3311
2764
3324
# removed/edited, old secret will thus be unrecovable.
2765
3325
clients = {}
2766
3326
with PGPEngine() as pgp:
2767
for client in tcp_server.clients.itervalues():
3327
for client in tcp_server.clients.values():
2768
3328
key = client_settings[client.name]["secret"]
2769
3329
client.encrypted_secret = pgp.encrypt(client.secret,
2770
3330
key)
2774
3334
# + secret.
2775
3335
exclude = { "bus", "changedstate", "secret",
2776
3336
"checker", "server_settings" }
2777
for name, typ in (inspect.getmembers
2778
(dbus.service.Object)):
3337
for name, typ in inspect.getmembers(dbus.service
3338
.Object):
2779
3339
exclude.add(name)
2780
3340
2781
3341
client_dict["encrypted_secret"] = (client
2788
3348
del client_settings[client.name]["secret"]
2789
3349
2790
3350
try:
2791
with (tempfile.NamedTemporaryFile
2792
(mode='wb', suffix=".pickle", prefix='clients-',
2793
dir=os.path.dirname(stored_state_path),
2794
delete=False)) as stored_state:
2795
pickle.dump((clients, client_settings), stored_state)
2796
tempname=stored_state.name
3351
with tempfile.NamedTemporaryFile(
3352
mode='wb',
3353
suffix=".pickle",
3354
prefix='clients-',
3355
dir=os.path.dirname(stored_state_path),
3356
delete=False) as stored_state:
3357
pickle.dump((clients, client_settings), stored_state,
3358
protocol = 2)
3359
tempname = stored_state.name
2797
3360
os.rename(tempname, stored_state_path)
2798
3361
except (IOError, OSError) as e:
2799
3362
if not debug:
2814
3377
name, client = tcp_server.clients.popitem()
2815
3378
if use_dbus:
2816
3379
client.remove_from_connection()
2817
# Don't signal anything except ClientRemoved
3380
# Don't signal the disabling
2818
3381
client.disable(quiet=True)
3382
# Emit D-Bus signal for removal
2819
3383
if use_dbus:
2820
# Emit D-Bus signal
2821
mandos_dbus_service.ClientRemoved(client
2822
.dbus_object_path,
2823
client.name)
3384
mandos_dbus_service.client_removed_signal(client)
2824
3385
client_settings.clear()
2825
3386
2826
3387
atexit.register(cleanup)
2827
3388
2828
for client in tcp_server.clients.itervalues():
3389
for client in tcp_server.clients.values():
2829
3390
if use_dbus:
2830
# Emit D-Bus signal
2831
mandos_dbus_service.ClientAdded(client.dbus_object_path)
3391
# Emit D-Bus signal for adding
3392
mandos_dbus_service.client_added_signal(client)
2832
3393
# Need to initiate checking of clients
2833
3394
if client.enabled:
2834
3395
client.init_checker()
2860
3421
sys.exit(1)
2861
3422
# End of Avahi example code
2862
3423
2863
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
3424
GObject.io_add_watch(tcp_server.fileno(), GObject.IO_IN,
2864
3425
lambda *args, **kwargs:
2865
3426
(tcp_server.handle_request
2866
3427
(*args[2:], **kwargs) or True))
2879
3440
# Must run before the D-Bus bus name gets deregistered
2880
3441
cleanup()
2881
3442
3443
2882
3444
if __name__ == '__main__':
2883
3445
main()
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0