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