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