To get this branch, use:
bzr branch
http://bzr.recompile.se/loggerhead/mandos/trunk
« back to all changes in this revision
Viewing changes to mandos
- browse files at revision 869
- compare with another revision
- download diff
- download tarball
- view history from revision 869
- Committer: Teddy Hogeborn
- Date: 2016-07-10 03:43:48 UTC
- Revision ID: teddy@recompile.se-20160710034348-5qc50yeyyn7peirm
Update RFC references to their modern equivalents.
* plugins.d/mandos-client.xml (SEE ALSO): Replace RFC 4346 (TLS 1.1)
with RFC 5246 (TLS 1.2), and replace RFC 5081 (TLS OpenPGP) with its
replacement RFC 6091.
* plugins.d/mandos-client.xml (SEE ALSO): Replace RFC 4346 (TLS 1.1)
with RFC 5246 (TLS 1.2), and replace RFC 5081 (TLS OpenPGP) with its
replacement RFC 6091.
- files added:
- bugs.xml
- debian/upstream
- network-hooks.d
- plugin-helpers
- files modified:
- .bzrignore
added
removed
mandos
11
11
# "AvahiService" class, and some lines in "main".
12
12
#
13
13
# Everything else is
14
# Copyright © 2008-2011 Teddy Hogeborn
15
# Copyright © 2008-2011 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
import SocketServer as socketserver
37
try:
38
from future_builtins import *
39
except ImportError:
40
pass
41
42
try:
43
import SocketServer as socketserver
44
except ImportError:
45
import socketserver
38
46
import socket
39
47
import argparse
40
48
import datetime
41
49
import errno
42
import gnutls.crypto
43
import gnutls.connection
44
import gnutls.errors
45
import gnutls.library.functions
46
import gnutls.library.constants
47
import gnutls.library.types
48
import ConfigParser as configparser
50
try:
51
import ConfigParser as configparser
52
except ImportError:
53
import configparser
49
54
import sys
50
55
import re
51
56
import os
60
65
import struct
61
66
import fcntl
62
67
import functools
63
import cPickle as pickle
68
try:
69
import cPickle as pickle
70
except ImportError:
71
import pickle
64
72
import multiprocessing
65
73
import types
74
import binascii
75
import tempfile
76
import itertools
77
import collections
78
import codecs
66
79
67
80
import dbus
68
81
import dbus.service
69
import gobject
70
import avahi
82
from gi.repository import GLib
71
83
from dbus.mainloop.glib import DBusGMainLoop
72
84
import ctypes
73
85
import ctypes.util
74
86
import xml.dom.minidom
75
87
import inspect
76
88
89
# Try to find the value of SO_BINDTODEVICE:
77
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:
78
93
SO_BINDTODEVICE = socket.SO_BINDTODEVICE
79
94
except AttributeError:
80
95
try:
96
# This is where SO_BINDTODEVICE was up to and including Python
97
# 2.6, and also 3.2:
81
98
from IN import SO_BINDTODEVICE
82
99
except ImportError:
83
SO_BINDTODEVICE = None
84
85
86
version = "1.3.1"
87
88
#logger = logging.getLogger('mandos')
89
logger = logging.Logger('mandos')
90
syslogger = (logging.handlers.SysLogHandler
91
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
92
address = str("/dev/log")))
93
syslogger.setFormatter(logging.Formatter
94
('Mandos [%(process)d]: %(levelname)s:'
95
' %(message)s'))
96
logger.addHandler(syslogger)
97
98
console = logging.StreamHandler()
99
console.setFormatter(logging.Formatter('%(name)s [%(process)d]:'
100
' %(levelname)s:'
101
' %(message)s'))
102
logger.addHandler(console)
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
113
114
if sys.version_info.major == 2:
115
str = unicode
116
117
version = "1.7.10"
118
stored_state_file = "clients.pickle"
119
120
logger = logging.getLogger()
121
syslogger = None
122
123
try:
124
if_nametoindex = ctypes.cdll.LoadLibrary(
125
ctypes.util.find_library("c")).if_nametoindex
126
except (OSError, AttributeError):
127
128
def if_nametoindex(interface):
129
"Get an interface index the hard way, i.e. using fcntl()"
130
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
131
with contextlib.closing(socket.socket()) as s:
132
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
133
struct.pack(b"16s16x", interface))
134
interface_index = struct.unpack("I", ifreq[16:20])[0]
135
return interface_index
136
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
154
def initlogger(debug, level=logging.WARNING):
155
"""init logger and add loglevel"""
156
157
global syslogger
158
syslogger = (logging.handlers.SysLogHandler(
159
facility = logging.handlers.SysLogHandler.LOG_DAEMON,
160
address = "/dev/log"))
161
syslogger.setFormatter(logging.Formatter
162
('Mandos [%(process)d]: %(levelname)s:'
163
' %(message)s'))
164
logger.addHandler(syslogger)
165
166
if debug:
167
console = logging.StreamHandler()
168
console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
169
' [%(process)d]:'
170
' %(levelname)s:'
171
' %(message)s'))
172
logger.addHandler(console)
173
logger.setLevel(level)
174
175
176
class PGPError(Exception):
177
"""Exception if encryption/decryption fails"""
178
pass
179
180
181
class PGPEngine(object):
182
"""A simple class for OpenPGP symmetric encryption & decryption"""
183
184
def __init__(self):
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
197
self.gnupgargs = ['--batch',
198
'--homedir', self.tempdir,
199
'--force-mdc',
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")
204
205
def __enter__(self):
206
return self
207
208
def __exit__(self, exc_type, exc_value, traceback):
209
self._cleanup()
210
return False
211
212
def __del__(self):
213
self._cleanup()
214
215
def _cleanup(self):
216
if self.tempdir is not None:
217
# Delete contents of tempdir
218
for root, dirs, files in os.walk(self.tempdir,
219
topdown = False):
220
for filename in files:
221
os.remove(os.path.join(root, filename))
222
for dirname in dirs:
223
os.rmdir(os.path.join(root, dirname))
224
# Remove tempdir
225
os.rmdir(self.tempdir)
226
self.tempdir = None
227
228
def password_encode(self, password):
229
# Passphrase can not be empty and can not contain newlines or
230
# NUL bytes. So we prefix it and hex encode it.
231
encoded = b"mandos" + binascii.hexlify(password)
232
if len(encoded) > 2048:
233
# GnuPG can't handle long passwords, so encode differently
234
encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
235
.replace(b"\n", b"\\n")
236
.replace(b"\0", b"\\x00"))
237
return encoded
238
239
def encrypt(self, data, password):
240
passphrase = self.password_encode(password)
241
with tempfile.NamedTemporaryFile(
242
dir=self.tempdir) as passfile:
243
passfile.write(passphrase)
244
passfile.flush()
245
proc = subprocess.Popen([self.gpg, '--symmetric',
246
'--passphrase-file',
247
passfile.name]
248
+ self.gnupgargs,
249
stdin = subprocess.PIPE,
250
stdout = subprocess.PIPE,
251
stderr = subprocess.PIPE)
252
ciphertext, err = proc.communicate(input = data)
253
if proc.returncode != 0:
254
raise PGPError(err)
255
return ciphertext
256
257
def decrypt(self, data, password):
258
passphrase = self.password_encode(password)
259
with tempfile.NamedTemporaryFile(
260
dir = self.tempdir) as passfile:
261
passfile.write(passphrase)
262
passfile.flush()
263
proc = subprocess.Popen([self.gpg, '--decrypt',
264
'--passphrase-file',
265
passfile.name]
266
+ self.gnupgargs,
267
stdin = subprocess.PIPE,
268
stdout = subprocess.PIPE,
269
stderr = subprocess.PIPE)
270
decrypted_plaintext, err = proc.communicate(input = data)
271
if proc.returncode != 0:
272
raise PGPError(err)
273
return decrypted_plaintext
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()
103
299
104
300
class AvahiError(Exception):
105
301
def __init__(self, value, *args, **kwargs):
106
302
self.value = value
107
super(AvahiError, self).__init__(value, *args, **kwargs)
108
def __unicode__(self):
109
return unicode(repr(self.value))
303
return super(AvahiError, self).__init__(value, *args,
304
**kwargs)
305
110
306
111
307
class AvahiServiceError(AvahiError):
112
308
pass
113
309
310
114
311
class AvahiGroupError(AvahiError):
115
312
pass
116
313
123
320
Used to optionally bind to the specified interface.
124
321
name: string; Example: 'Mandos'
125
322
type: string; Example: '_mandos._tcp'.
126
See <http://www.dns-sd.org/ServiceTypes.html>
323
See <https://www.iana.org/assignments/service-names-port-numbers>
127
324
port: integer; what port to announce
128
325
TXT: list of strings; TXT record for the service
129
326
domain: string; Domain to publish on, default to .local if empty.
135
332
server: D-Bus Server
136
333
bus: dbus.SystemBus()
137
334
"""
138
def __init__(self, interface = avahi.IF_UNSPEC, name = None,
139
servicetype = None, port = None, TXT = None,
140
domain = "", host = "", max_renames = 32768,
141
protocol = avahi.PROTO_UNSPEC, bus = None):
335
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):
142
347
self.interface = interface
143
348
self.name = name
144
349
self.type = servicetype
153
358
self.server = None
154
359
self.bus = bus
155
360
self.entry_group_state_changed_match = None
156
def rename(self):
361
362
def rename(self, remove=True):
157
363
"""Derived from the Avahi example code"""
158
364
if self.rename_count >= self.max_renames:
159
365
logger.critical("No suitable Zeroconf service name found"
160
366
" after %i retries, exiting.",
161
367
self.rename_count)
162
368
raise AvahiServiceError("Too many renames")
163
self.name = unicode(self.server
164
.GetAlternativeServiceName(self.name))
369
self.name = str(
370
self.server.GetAlternativeServiceName(self.name))
371
self.rename_count += 1
165
372
logger.info("Changing Zeroconf service name to %r ...",
166
373
self.name)
167
syslogger.setFormatter(logging.Formatter
168
('Mandos (%s) [%%(process)d]:'
169
' %%(levelname)s: %%(message)s'
170
% self.name))
171
self.remove()
374
if remove:
375
self.remove()
172
376
try:
173
377
self.add()
174
378
except dbus.exceptions.DBusException as error:
175
logger.critical("DBusException: %s", error)
176
self.cleanup()
177
os._exit(1)
178
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)
387
179
388
def remove(self):
180
389
"""Derived from the Avahi example code"""
181
390
if self.entry_group_state_changed_match is not None:
183
392
self.entry_group_state_changed_match = None
184
393
if self.group is not None:
185
394
self.group.Reset()
395
186
396
def add(self):
187
397
"""Derived from the Avahi example code"""
188
398
self.remove()
193
403
avahi.DBUS_INTERFACE_ENTRY_GROUP)
194
404
self.entry_group_state_changed_match = (
195
405
self.group.connect_to_signal(
196
'StateChanged', self .entry_group_state_changed))
406
'StateChanged', self.entry_group_state_changed))
197
407
logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
198
408
self.name, self.type)
199
409
self.group.AddService(
205
415
dbus.UInt16(self.port),
206
416
avahi.string_array_to_txt_array(self.TXT))
207
417
self.group.Commit()
418
208
419
def entry_group_state_changed(self, state, error):
209
420
"""Derived from the Avahi example code"""
210
421
logger.debug("Avahi entry group state change: %i", state)
216
427
self.rename()
217
428
elif state == avahi.ENTRY_GROUP_FAILURE:
218
429
logger.critical("Avahi: Error in group state changed %s",
219
unicode(error))
220
raise AvahiGroupError("State changed: %s"
221
% unicode(error))
430
str(error))
431
raise AvahiGroupError("State changed: {!s}".format(error))
432
222
433
def cleanup(self):
223
434
"""Derived from the Avahi example code"""
224
435
if self.group is not None:
225
436
try:
226
437
self.group.Free()
227
438
except (dbus.exceptions.UnknownMethodException,
228
dbus.exceptions.DBusException) as e:
439
dbus.exceptions.DBusException):
229
440
pass
230
441
self.group = None
231
442
self.remove()
443
232
444
def server_state_changed(self, state, error=None):
233
445
"""Derived from the Avahi example code"""
234
446
logger.debug("Avahi server state change: %i", state)
235
bad_states = { avahi.SERVER_INVALID:
236
"Zeroconf server invalid",
237
avahi.SERVER_REGISTERING: None,
238
avahi.SERVER_COLLISION:
239
"Zeroconf server name collision",
240
avahi.SERVER_FAILURE:
241
"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
}
242
453
if state in bad_states:
243
454
if bad_states[state] is not None:
244
455
if error is None:
247
458
logger.error(bad_states[state] + ": %r", error)
248
459
self.cleanup()
249
460
elif state == avahi.SERVER_RUNNING:
250
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)
251
473
else:
252
474
if error is None:
253
475
logger.debug("Unknown state: %r", state)
254
476
else:
255
477
logger.debug("Unknown state: %r: %r", state, error)
478
256
479
def activate(self):
257
480
"""Derived from the Avahi example code"""
258
481
if self.server is None:
262
485
follow_name_owner_changes=True),
263
486
avahi.DBUS_INTERFACE_SERVER)
264
487
self.server.connect_to_signal("StateChanged",
265
self.server_state_changed)
488
self.server_state_changed)
266
489
self.server_state_changed(self.server.GetState())
267
490
268
491
269
def _timedelta_to_milliseconds(td):
270
"Convert a datetime.timedelta() to milliseconds"
271
return ((td.days * 24 * 60 * 60 * 1000)
272
+ (td.seconds * 1000)
273
+ (td.microseconds // 1000))
274
492
class AvahiServiceToSyslog(AvahiService):
493
def rename(self, *args, **kwargs):
494
"""Add the new name to the syslog messages"""
495
ret = AvahiService.rename(self, *args, **kwargs)
496
syslogger.setFormatter(logging.Formatter(
497
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
498
.format(self.name)))
499
return ret
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()
765
275
766
class Client(object):
276
767
"""A representation of a client host served by this server.
277
768
278
769
Attributes:
279
_approved: bool(); 'None' if not yet approved/disapproved
770
approved: bool(); 'None' if not yet approved/disapproved
280
771
approval_delay: datetime.timedelta(); Time to wait for approval
281
772
approval_duration: datetime.timedelta(); Duration of one approval
282
773
checker: subprocess.Popen(); a running checker process used
283
774
to see if the client lives.
284
775
'None' if no process is running.
285
checker_callback_tag: a gobject event source tag, or None
776
checker_callback_tag: a GLib event source tag, or None
286
777
checker_command: string; External command which is run to check
287
778
if client lives. %() expansions are done at
288
779
runtime with vars(self) as dict, so that for
289
780
instance %(name)s can be used in the command.
290
checker_initiator_tag: a gobject event source tag, or None
781
checker_initiator_tag: a GLib event source tag, or None
291
782
created: datetime.datetime(); (UTC) object creation
783
client_structure: Object describing what attributes a client has
784
and is used for storing the client at exit
292
785
current_checker_command: string; current running checker_command
293
disable_hook: If set, called by disable() as disable_hook(self)
294
disable_initiator_tag: a gobject event source tag, or None
786
disable_initiator_tag: a GLib event source tag, or None
295
787
enabled: bool()
296
788
fingerprint: string (40 or 32 hexadecimal digits); used to
297
789
uniquely identify the client
299
791
interval: datetime.timedelta(); How often to start a new checker
300
792
last_approval_request: datetime.datetime(); (UTC) or None
301
793
last_checked_ok: datetime.datetime(); (UTC) or None
302
last_enabled: datetime.datetime(); (UTC)
794
last_checker_status: integer between 0 and 255 reflecting exit
795
status of last checker. -1 reflects crashed
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
799
last_enabled: datetime.datetime(); (UTC) or None
303
800
name: string; from the config file, used in log messages and
304
801
D-Bus identifiers
305
802
secret: bytestring; sent verbatim (over TLS) to client
306
803
timeout: datetime.timedelta(); How long from last_checked_ok
307
804
until this client is disabled
308
extended_timeout: extra long timeout when password has been sent
805
extended_timeout: extra long timeout when secret has been sent
309
806
runtime_expansions: Allowed attributes for runtime expansion.
310
807
expires: datetime.datetime(); time (UTC) when a client will be
311
808
disabled, or None
809
server_settings: The server_settings dict from main()
312
810
"""
313
811
314
812
runtime_expansions = ("approval_delay", "approval_duration",
315
"created", "enabled", "fingerprint",
316
"host", "interval", "last_checked_ok",
813
"created", "enabled", "expires",
814
"fingerprint", "host", "interval",
815
"last_approval_request", "last_checked_ok",
317
816
"last_enabled", "name", "timeout")
318
319
def timeout_milliseconds(self):
320
"Return the 'timeout' attribute in milliseconds"
321
return _timedelta_to_milliseconds(self.timeout)
322
323
def extended_timeout_milliseconds(self):
324
"Return the 'extended_timeout' attribute in milliseconds"
325
return _timedelta_to_milliseconds(self.extended_timeout)
326
327
def interval_milliseconds(self):
328
"Return the 'interval' attribute in milliseconds"
329
return _timedelta_to_milliseconds(self.interval)
330
331
def approval_delay_milliseconds(self):
332
return _timedelta_to_milliseconds(self.approval_delay)
333
334
def __init__(self, name = None, disable_hook=None, config=None):
335
"""Note: the 'checker' key in 'config' sets the
336
'checker_command' attribute and *not* the 'checker'
337
attribute."""
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
}
828
829
@staticmethod
830
def config_parser(config):
831
"""Construct a new dict of client settings of this form:
832
{ client_name: {setting_name: value, ...}, ...}
833
with exceptions for any special settings as defined above.
834
NOTE: Must be a pure function. Must return the same result
835
value given the same arguments.
836
"""
837
settings = {}
838
for client_name in config.sections():
839
section = dict(config.items(client_name))
840
client = settings[client_name] = {}
841
842
client["host"] = section["host"]
843
# Reformat values from string types to Python types
844
client["approved_by_default"] = config.getboolean(
845
client_name, "approved_by_default")
846
client["enabled"] = config.getboolean(client_name,
847
"enabled")
848
849
# Uppercase and remove spaces from fingerprint for later
850
# comparison purposes with return value from the
851
# fingerprint() function
852
client["fingerprint"] = (section["fingerprint"].upper()
853
.replace(" ", ""))
854
if "secret" in section:
855
client["secret"] = codecs.decode(section["secret"]
856
.encode("utf-8"),
857
"base64")
858
elif "secfile" in section:
859
with open(os.path.expanduser(os.path.expandvars
860
(section["secfile"])),
861
"rb") as secfile:
862
client["secret"] = secfile.read()
863
else:
864
raise TypeError("No secret or secfile for section {}"
865
.format(section))
866
client["timeout"] = string_to_delta(section["timeout"])
867
client["extended_timeout"] = string_to_delta(
868
section["extended_timeout"])
869
client["interval"] = string_to_delta(section["interval"])
870
client["approval_delay"] = string_to_delta(
871
section["approval_delay"])
872
client["approval_duration"] = string_to_delta(
873
section["approval_duration"])
874
client["checker_command"] = section["checker"]
875
client["last_approval_request"] = None
876
client["last_checked_ok"] = None
877
client["last_checker_status"] = -2
878
879
return settings
880
881
def __init__(self, settings, name = None, server_settings=None):
338
882
self.name = name
339
if config is None:
340
config = {}
883
if server_settings is None:
884
server_settings = {}
885
self.server_settings = server_settings
886
# adding all client settings
887
for setting, value in settings.items():
888
setattr(self, setting, value)
889
890
if self.enabled:
891
if not hasattr(self, "last_enabled"):
892
self.last_enabled = datetime.datetime.utcnow()
893
if not hasattr(self, "expires"):
894
self.expires = (datetime.datetime.utcnow()
895
+ self.timeout)
896
else:
897
self.last_enabled = None
898
self.expires = None
899
341
900
logger.debug("Creating client %r", self.name)
342
# Uppercase and remove spaces from fingerprint for later
343
# comparison purposes with return value from the fingerprint()
344
# function
345
self.fingerprint = (config["fingerprint"].upper()
346
.replace(" ", ""))
347
901
logger.debug(" Fingerprint: %s", self.fingerprint)
348
if "secret" in config:
349
self.secret = config["secret"].decode("base64")
350
elif "secfile" in config:
351
with open(os.path.expanduser(os.path.expandvars
352
(config["secfile"])),
353
"rb") as secfile:
354
self.secret = secfile.read()
355
else:
356
raise TypeError("No secret or secfile for client %s"
357
% self.name)
358
self.host = config.get("host", "")
359
self.created = datetime.datetime.utcnow()
360
self.enabled = False
361
self.last_approval_request = None
362
self.last_enabled = None
363
self.last_checked_ok = None
364
self.timeout = string_to_delta(config["timeout"])
365
self.extended_timeout = string_to_delta(config
366
["extended_timeout"])
367
self.interval = string_to_delta(config["interval"])
368
self.disable_hook = disable_hook
902
self.created = settings.get("created",
903
datetime.datetime.utcnow())
904
905
# attributes specific for this server instance
369
906
self.checker = None
370
907
self.checker_initiator_tag = None
371
908
self.disable_initiator_tag = None
372
self.expires = None
373
909
self.checker_callback_tag = None
374
self.checker_command = config["checker"]
375
910
self.current_checker_command = None
376
self.last_connect = None
377
self._approved = None
378
self.approved_by_default = config.get("approved_by_default",
379
True)
911
self.approved = None
380
912
self.approvals_pending = 0
381
self.approval_delay = string_to_delta(
382
config["approval_delay"])
383
self.approval_duration = string_to_delta(
384
config["approval_duration"])
385
self.changedstate = (multiprocessing_manager
386
.Condition(multiprocessing_manager
387
.Lock()))
913
self.changedstate = multiprocessing_manager.Condition(
914
multiprocessing_manager.Lock())
915
self.client_structure = [attr
916
for attr in self.__dict__.keys()
917
if not attr.startswith("_")]
918
self.client_structure.append("client_structure")
919
920
for name, t in inspect.getmembers(
921
type(self), lambda obj: isinstance(obj, property)):
922
if not name.startswith("_"):
923
self.client_structure.append(name)
388
924
925
# Send notice to process children that client state has changed
389
926
def send_changedstate(self):
390
self.changedstate.acquire()
391
self.changedstate.notify_all()
392
self.changedstate.release()
927
with self.changedstate:
928
self.changedstate.notify_all()
393
929
394
930
def enable(self):
395
931
"""Start this client's checker and timeout hooks"""
396
932
if getattr(self, "enabled", False):
397
933
# Already enabled
398
934
return
399
self.send_changedstate()
400
# Schedule a new checker to be started an 'interval' from now,
401
# and every interval from then on.
402
self.checker_initiator_tag = (gobject.timeout_add
403
(self.interval_milliseconds(),
404
self.start_checker))
405
# Schedule a disable() when 'timeout' has passed
406
935
self.expires = datetime.datetime.utcnow() + self.timeout
407
self.disable_initiator_tag = (gobject.timeout_add
408
(self.timeout_milliseconds(),
409
self.disable))
410
936
self.enabled = True
411
937
self.last_enabled = datetime.datetime.utcnow()
412
# Also start a new checker *right now*.
413
self.start_checker()
938
self.init_checker()
939
self.send_changedstate()
414
940
415
941
def disable(self, quiet=True):
416
942
"""Disable this client."""
417
943
if not getattr(self, "enabled", False):
418
944
return False
419
945
if not quiet:
420
self.send_changedstate()
421
if not quiet:
422
946
logger.info("Disabling client %s", self.name)
423
if getattr(self, "disable_initiator_tag", False):
424
gobject.source_remove(self.disable_initiator_tag)
947
if getattr(self, "disable_initiator_tag", None) is not None:
948
GLib.source_remove(self.disable_initiator_tag)
425
949
self.disable_initiator_tag = None
426
950
self.expires = None
427
if getattr(self, "checker_initiator_tag", False):
428
gobject.source_remove(self.checker_initiator_tag)
951
if getattr(self, "checker_initiator_tag", None) is not None:
952
GLib.source_remove(self.checker_initiator_tag)
429
953
self.checker_initiator_tag = None
430
954
self.stop_checker()
431
if self.disable_hook:
432
self.disable_hook(self)
433
955
self.enabled = False
434
# Do not run this again if called by a gobject.timeout_add
956
if not quiet:
957
self.send_changedstate()
958
# Do not run this again if called by a GLib.timeout_add
435
959
return False
436
960
437
961
def __del__(self):
438
self.disable_hook = None
439
962
self.disable()
440
963
441
def checker_callback(self, pid, condition, command):
964
def init_checker(self):
965
# Schedule a new checker to be started an 'interval' from now,
966
# and every interval from then on.
967
if self.checker_initiator_tag is not None:
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)
972
# Schedule a disable() when 'timeout' has passed
973
if self.disable_initiator_tag is not None:
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)
977
# Also start a new checker *right now*.
978
self.start_checker()
979
980
def checker_callback(self, source, condition, connection,
981
command):
442
982
"""The checker has completed, so take appropriate actions."""
443
983
self.checker_callback_tag = None
444
984
self.checker = None
445
if os.WIFEXITED(condition):
446
exitstatus = os.WEXITSTATUS(condition)
447
if exitstatus == 0:
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
992
if self.last_checker_status == 0:
448
993
logger.info("Checker for %(name)s succeeded",
449
994
vars(self))
450
995
self.checked_ok()
451
996
else:
452
logger.info("Checker for %(name)s failed",
453
vars(self))
997
logger.info("Checker for %(name)s failed", vars(self))
454
998
else:
999
self.last_checker_status = -1
1000
self.last_checker_signal = -returncode
455
1001
logger.warning("Checker for %(name)s crashed?",
456
1002
vars(self))
457
458
def checked_ok(self, timeout=None):
459
"""Bump up the timeout for this client.
460
461
This should only be called when the client has been seen,
462
alive and well.
463
"""
1003
return False
1004
1005
def checked_ok(self):
1006
"""Assert that the client has been seen, alive and well."""
1007
self.last_checked_ok = datetime.datetime.utcnow()
1008
self.last_checker_status = 0
1009
self.last_checker_signal = None
1010
self.bump_timeout()
1011
1012
def bump_timeout(self, timeout=None):
1013
"""Bump up the timeout for this client."""
464
1014
if timeout is None:
465
1015
timeout = self.timeout
466
self.last_checked_ok = datetime.datetime.utcnow()
467
gobject.source_remove(self.disable_initiator_tag)
468
self.expires = datetime.datetime.utcnow() + timeout
469
self.disable_initiator_tag = (gobject.timeout_add
470
(_timedelta_to_milliseconds
471
(timeout), self.disable))
1016
if self.disable_initiator_tag is not None:
1017
GLib.source_remove(self.disable_initiator_tag)
1018
self.disable_initiator_tag = None
1019
if getattr(self, "enabled", False):
1020
self.disable_initiator_tag = GLib.timeout_add(
1021
int(timeout.total_seconds() * 1000), self.disable)
1022
self.expires = datetime.datetime.utcnow() + timeout
472
1023
473
1024
def need_approval(self):
474
1025
self.last_approval_request = datetime.datetime.utcnow()
479
1030
If a checker already exists, leave it running and do
480
1031
nothing."""
481
1032
# The reason for not killing a running checker is that if we
482
# did that, then if a checker (for some reason) started
483
# running slowly and taking more than 'interval' time, the
484
# client would inevitably timeout, since no checker would get
485
# a chance to run to completion. If we instead leave running
1033
# did that, and if a checker (for some reason) started running
1034
# slowly and taking more than 'interval' time, then the client
1035
# would inevitably timeout, since no checker would get a
1036
# chance to run to completion. If we instead leave running
486
1037
# checkers alone, the checker would have to take more time
487
1038
# than 'timeout' for the client to be disabled, which is as it
488
1039
# should be.
489
1040
490
# If a checker exists, make sure it is not a zombie
491
try:
492
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
493
except (AttributeError, OSError) as error:
494
if (isinstance(error, OSError)
495
and error.errno != errno.ECHILD):
496
raise error
497
else:
498
if pid:
499
logger.warning("Checker was a zombie")
500
gobject.source_remove(self.checker_callback_tag)
501
self.checker_callback(pid, status,
502
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
503
1045
# Start a new checker if needed
504
1046
if self.checker is None:
1047
# Escape attributes for the shell
1048
escaped_attrs = {
1049
attr: re.escape(str(getattr(self, attr)))
1050
for attr in self.runtime_expansions }
505
1051
try:
506
# In case checker_command has exactly one % operator
507
command = self.checker_command % self.host
508
except TypeError:
509
# Escape attributes for the shell
510
escaped_attrs = dict(
511
(attr,
512
re.escape(unicode(str(getattr(self, attr, "")),
513
errors=
514
'replace')))
515
for attr in
516
self.runtime_expansions)
517
518
try:
519
command = self.checker_command % escaped_attrs
520
except TypeError as error:
521
logger.error('Could not format string "%s":'
522
' %s', self.checker_command, error)
523
return True # Try again later
1052
command = self.checker_command % escaped_attrs
1053
except TypeError as error:
1054
logger.error('Could not format string "%s"',
1055
self.checker_command,
1056
exc_info=error)
1057
return True # Try again later
524
1058
self.current_checker_command = command
525
try:
526
logger.info("Starting checker %r for %s",
527
command, self.name)
528
# We don't need to redirect stdout and stderr, since
529
# in normal mode, that is already done by daemon(),
530
# and in debug mode we don't want to. (Stdin is
531
# always replaced by /dev/null.)
532
self.checker = subprocess.Popen(command,
533
close_fds=True,
534
shell=True, cwd="/")
535
self.checker_callback_tag = (gobject.child_watch_add
536
(self.checker.pid,
537
self.checker_callback,
538
data=command))
539
# The checker may have completed before the gobject
540
# watch was added. Check for this.
541
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
542
if pid:
543
gobject.source_remove(self.checker_callback_tag)
544
self.checker_callback(pid, status, command)
545
except OSError as error:
546
logger.error("Failed to start subprocess: %s",
547
error)
548
# 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
549
1085
return True
550
1086
551
1087
def stop_checker(self):
552
1088
"""Force the checker process, if any, to stop."""
553
1089
if self.checker_callback_tag:
554
gobject.source_remove(self.checker_callback_tag)
1090
GLib.source_remove(self.checker_callback_tag)
555
1091
self.checker_callback_tag = None
556
1092
if getattr(self, "checker", None) is None:
557
1093
return
558
1094
logger.debug("Stopping checker for %(name)s", vars(self))
559
try:
560
os.kill(self.checker.pid, signal.SIGTERM)
561
#time.sleep(0.5)
562
#if self.checker.poll() is None:
563
# os.kill(self.checker.pid, signal.SIGKILL)
564
except OSError as error:
565
if error.errno != errno.ESRCH: # No such process
566
raise
1095
self.checker.terminate()
567
1096
self.checker = None
568
1097
569
1098
570
def dbus_service_property(dbus_interface, signature="v",
571
access="readwrite", byte_arrays=False):
1099
def dbus_service_property(dbus_interface,
1100
signature="v",
1101
access="readwrite",
1102
byte_arrays=False):
572
1103
"""Decorators for marking methods of a DBusObjectWithProperties to
573
1104
become properties on the D-Bus.
574
1105
583
1114
# "Set" method, so we fail early here:
584
1115
if byte_arrays and signature != "ay":
585
1116
raise ValueError("Byte arrays not supported for non-'ay'"
586
" signature %r" % signature)
1117
" signature {!r}".format(signature))
1118
587
1119
def decorator(func):
588
1120
func._dbus_is_property = True
589
1121
func._dbus_interface = dbus_interface
594
1126
func._dbus_name = func._dbus_name[:-14]
595
1127
func._dbus_get_args_options = {'byte_arrays': byte_arrays }
596
1128
return func
1129
1130
return decorator
1131
1132
1133
def dbus_interface_annotations(dbus_interface):
1134
"""Decorator for marking functions returning interface annotations
1135
1136
Usage:
1137
1138
@dbus_interface_annotations("org.example.Interface")
1139
def _foo(self): # Function name does not matter
1140
return {"org.freedesktop.DBus.Deprecated": "true",
1141
"org.freedesktop.DBus.Property.EmitsChangedSignal":
1142
"false"}
1143
"""
1144
1145
def decorator(func):
1146
func._dbus_is_interface = True
1147
func._dbus_interface = dbus_interface
1148
func._dbus_name = dbus_interface
1149
return func
1150
1151
return decorator
1152
1153
1154
def dbus_annotations(annotations):
1155
"""Decorator to annotate D-Bus methods, signals or properties
1156
Usage:
1157
1158
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
1159
"org.freedesktop.DBus.Property."
1160
"EmitsChangedSignal": "false"})
1161
@dbus_service_property("org.example.Interface", signature="b",
1162
access="r")
1163
def Property_dbus_property(self):
1164
return dbus.Boolean(False)
1165
1166
See also the DBusObjectWithAnnotations class.
1167
"""
1168
1169
def decorator(func):
1170
func._dbus_annotations = annotations
1171
return func
1172
597
1173
return decorator
598
1174
599
1175
600
1176
class DBusPropertyException(dbus.exceptions.DBusException):
601
1177
"""A base class for D-Bus property-related exceptions
602
1178
"""
603
def __unicode__(self):
604
return unicode(str(self))
1179
pass
605
1180
606
1181
607
1182
class DBusPropertyAccessException(DBusPropertyException):
616
1191
pass
617
1192
618
1193
619
class DBusObjectWithProperties(dbus.service.Object):
1194
class DBusObjectWithAnnotations(dbus.service.Object):
1195
"""A D-Bus object with annotations.
1196
1197
Classes inheriting from this can use the dbus_annotations
1198
decorator to add annotations to methods or signals.
1199
"""
1200
1201
@staticmethod
1202
def _is_dbus_thing(thing):
1203
"""Returns a function testing if an attribute is a D-Bus thing
1204
1205
If called like _is_dbus_thing("method") it returns a function
1206
suitable for use as predicate to inspect.getmembers().
1207
"""
1208
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
1209
False)
1210
1211
def _get_all_dbus_things(self, thing):
1212
"""Returns a generator of (name, attribute) pairs
1213
"""
1214
return ((getattr(athing.__get__(self), "_dbus_name", name),
1215
athing.__get__(self))
1216
for cls in self.__class__.__mro__
1217
for name, athing in
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):
620
1284
"""A D-Bus object with properties.
621
1285
622
1286
Classes inheriting from this can use the dbus_service_property
624
1288
standard Get(), Set(), and GetAll() methods on the D-Bus.
625
1289
"""
626
1290
627
@staticmethod
628
def _is_dbus_property(obj):
629
return getattr(obj, "_dbus_is_property", False)
630
631
def _get_all_dbus_properties(self):
632
"""Returns a generator of (name, attribute) pairs
633
"""
634
return ((prop.__get__(self)._dbus_name, prop.__get__(self))
635
for cls in self.__class__.__mro__
636
for name, prop in
637
inspect.getmembers(cls, self._is_dbus_property))
638
639
1291
def _get_dbus_property(self, interface_name, property_name):
640
1292
"""Returns a bound method if one exists which is a D-Bus
641
1293
property with the specified name and interface.
642
1294
"""
643
for cls in self.__class__.__mro__:
644
for name, value in (inspect.getmembers
645
(cls, self._is_dbus_property)):
1295
for cls in self.__class__.__mro__:
1296
for name, value in inspect.getmembers(
1297
cls, self._is_dbus_thing("property")):
646
1298
if (value._dbus_name == property_name
647
1299
and value._dbus_interface == interface_name):
648
1300
return value.__get__(self)
649
1301
650
1302
# No such property
651
raise DBusPropertyNotFound(self.dbus_object_path + ":"
652
+ interface_name + "."
653
+ property_name)
654
655
@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",
656
1317
out_signature="v")
657
1318
def Get(self, interface_name, property_name):
658
1319
"""Standard D-Bus property Get() method, see D-Bus standard.
676
1337
# The byte_arrays option is not supported yet on
677
1338
# signatures other than "ay".
678
1339
if prop._dbus_signature != "ay":
679
raise ValueError
680
value = dbus.ByteArray(''.join(unichr(byte)
681
for byte in value))
1340
raise ValueError("Byte arrays not supported for non-"
1341
"'ay' signature {!r}"
1342
.format(prop._dbus_signature))
1343
value = dbus.ByteArray(b''.join(chr(byte)
1344
for byte in value))
682
1345
prop(value)
683
1346
684
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
1347
@dbus.service.method(dbus.PROPERTIES_IFACE,
1348
in_signature="s",
685
1349
out_signature="a{sv}")
686
1350
def GetAll(self, interface_name):
687
1351
"""Standard D-Bus property GetAll() method, see D-Bus
689
1353
690
1354
Note: Will not include properties with access="write".
691
1355
"""
692
all = {}
693
for name, prop in self._get_all_dbus_properties():
1356
properties = {}
1357
for name, prop in self._get_all_dbus_things("property"):
694
1358
if (interface_name
695
1359
and interface_name != prop._dbus_interface):
696
1360
# Interface non-empty but did not match
700
1364
continue
701
1365
value = prop()
702
1366
if not hasattr(value, "variant_level"):
703
all[name] = value
1367
properties[name] = value
704
1368
continue
705
all[name] = type(value)(value, variant_level=
706
value.variant_level+1)
707
return dbus.Dictionary(all, signature="sv")
1369
properties[name] = type(value)(
1370
value, variant_level = value.variant_level + 1)
1371
return dbus.Dictionary(properties, signature="sv")
1372
1373
@dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
1374
def PropertiesChanged(self, interface_name, changed_properties,
1375
invalidated_properties):
1376
"""Standard D-Bus PropertiesChanged() signal, see D-Bus
1377
standard.
1378
"""
1379
pass
708
1380
709
1381
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
710
1382
out_signature="s",
711
1383
path_keyword='object_path',
712
1384
connection_keyword='connection')
713
1385
def Introspect(self, object_path, connection):
714
"""Standard D-Bus method, overloaded to insert property tags.
1386
"""Overloading of standard D-Bus method.
1387
1388
Inserts property tags and interface annotation tags.
715
1389
"""
716
xmlstring = dbus.service.Object.Introspect(self, object_path,
717
connection)
1390
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1391
object_path,
1392
connection)
718
1393
try:
719
1394
document = xml.dom.minidom.parseString(xmlstring)
1395
720
1396
def make_tag(document, name, prop):
721
1397
e = document.createElement("property")
722
1398
e.setAttribute("name", name)
723
1399
e.setAttribute("type", prop._dbus_signature)
724
1400
e.setAttribute("access", prop._dbus_access)
725
1401
return e
1402
726
1403
for if_tag in document.getElementsByTagName("interface"):
1404
# Add property tags
727
1405
for tag in (make_tag(document, name, prop)
728
1406
for name, prop
729
in self._get_all_dbus_properties()
1407
in self._get_all_dbus_things("property")
730
1408
if prop._dbus_interface
731
1409
== if_tag.getAttribute("name")):
732
1410
if_tag.appendChild(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)
733
1427
# Add the names to the return values for the
734
1428
# "org.freedesktop.DBus.Properties" methods
735
1429
if (if_tag.getAttribute("name")
750
1444
except (AttributeError, xml.dom.DOMException,
751
1445
xml.parsers.expat.ExpatError) as error:
752
1446
logger.error("Failed to override Introspection method",
753
error)
754
return xmlstring
755
756
757
def datetime_to_dbus (dt, variant_level=0):
1447
exc_info=error)
1448
return xmlstring
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
1518
1519
def datetime_to_dbus(dt, variant_level=0):
758
1520
"""Convert a UTC datetime.datetime() to a D-Bus type."""
759
1521
if dt is None:
760
1522
return dbus.String("", variant_level = variant_level)
761
return dbus.String(dt.isoformat(),
762
variant_level=variant_level)
763
764
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
765
.__metaclass__):
766
"""Applied to an empty subclass of a D-Bus object, this metaclass
767
will add additional D-Bus attributes matching a certain pattern.
1523
return dbus.String(dt.isoformat(), variant_level=variant_level)
1524
1525
1526
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1527
"""A class decorator; applied to a subclass of
1528
dbus.service.Object, it will add alternate D-Bus attributes with
1529
interface names according to the "alt_interface_names" mapping.
1530
Usage:
1531
1532
@alternate_dbus_interfaces({"org.example.Interface":
1533
"net.example.AlternateInterface"})
1534
class SampleDBusObject(dbus.service.Object):
1535
@dbus.service.method("org.example.Interface")
1536
def SampleDBusMethod():
1537
pass
1538
1539
The above "SampleDBusMethod" on "SampleDBusObject" will be
1540
reachable via two interfaces: "org.example.Interface" and
1541
"net.example.AlternateInterface", the latter of which will have
1542
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1543
"true", unless "deprecate" is passed with a False value.
1544
1545
This works for methods and signals, and also for D-Bus properties
1546
(from DBusObjectWithProperties) and interfaces (from the
1547
dbus_interface_annotations decorator).
768
1548
"""
769
def __new__(mcs, name, bases, attr):
770
# Go through all the base classes which could have D-Bus
771
# methods, signals, or properties in them
772
for base in (b for b in bases
773
if issubclass(b, dbus.service.Object)):
774
# Go though all attributes of the base class
775
for attrname, attribute in inspect.getmembers(base):
1549
1550
def wrapper(cls):
1551
for orig_interface_name, alt_interface_name in (
1552
alt_interface_names.items()):
1553
attr = {}
1554
interface_names = set()
1555
# Go though all attributes of the class
1556
for attrname, attribute in inspect.getmembers(cls):
776
1557
# Ignore non-D-Bus attributes, and D-Bus attributes
777
1558
# with the wrong interface name
778
1559
if (not hasattr(attribute, "_dbus_interface")
779
or not attribute._dbus_interface
780
.startswith("se.recompile.Mandos")):
1560
or not attribute._dbus_interface.startswith(
1561
orig_interface_name)):
781
1562
continue
782
1563
# Create an alternate D-Bus interface name based on
783
1564
# the current name
784
alt_interface = (attribute._dbus_interface
785
.replace("se.recompile.Mandos",
786
"se.bsnet.fukt.Mandos"))
1565
alt_interface = attribute._dbus_interface.replace(
1566
orig_interface_name, alt_interface_name)
1567
interface_names.add(alt_interface)
787
1568
# Is this a D-Bus signal?
788
1569
if getattr(attribute, "_dbus_is_signal", False):
789
# Extract the original non-method function by
790
# black magic
791
nonmethod_func = (dict(
1570
# Extract the original non-method undecorated
1571
# function by black magic
1572
if sys.version_info.major == 2:
1573
nonmethod_func = (dict(
792
1574
zip(attribute.func_code.co_freevars,
793
attribute.__closure__))["func"]
794
.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)
795
1582
# Create a new, but exactly alike, function
796
1583
# object, and decorate it to be a new D-Bus signal
797
1584
# with the alternate D-Bus interface name
798
new_function = (dbus.service.signal
799
(alt_interface,
800
attribute._dbus_signature)
801
(types.FunctionType(
802
nonmethod_func.func_code,
803
nonmethod_func.func_globals,
804
nonmethod_func.func_name,
805
nonmethod_func.func_defaults,
806
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))
1589
# Copy annotations, if any
1590
try:
1591
new_function._dbus_annotations = dict(
1592
attribute._dbus_annotations)
1593
except AttributeError:
1594
pass
807
1595
# Define a creator of a function to call both the
808
# old and new functions, so both the old and new
809
# signals gets sent when the function is called
1596
# original and alternate functions, so both the
1597
# original and alternate signals gets sent when
1598
# the function is called
810
1599
def fixscope(func1, func2):
811
1600
"""This function is a scope container to pass
812
1601
func1 and func2 to the "call_both" function
813
1602
outside of its arguments"""
1603
1604
@functools.wraps(func2)
814
1605
def call_both(*args, **kwargs):
815
1606
"""This function will emit two D-Bus
816
1607
signals by calling func1 and func2"""
817
1608
func1(*args, **kwargs)
818
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
819
1615
return call_both
820
1616
# Create the "call_both" function and add it to
821
1617
# the class
822
attr[attrname] = fixscope(attribute,
823
new_function)
1618
attr[attrname] = fixscope(attribute, new_function)
824
1619
# Is this a D-Bus method?
825
1620
elif getattr(attribute, "_dbus_is_method", False):
826
1621
# Create a new, but exactly alike, function
827
1622
# object. Decorate it to be a new D-Bus method
828
1623
# with the alternate D-Bus interface name. Add it
829
1624
# to the class.
830
attr[attrname] = (dbus.service.method
831
(alt_interface,
832
attribute._dbus_in_signature,
833
attribute._dbus_out_signature)
834
(types.FunctionType
835
(attribute.func_code,
836
attribute.func_globals,
837
attribute.func_name,
838
attribute.func_defaults,
839
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)))
1631
# Copy annotations, if any
1632
try:
1633
attr[attrname]._dbus_annotations = dict(
1634
attribute._dbus_annotations)
1635
except AttributeError:
1636
pass
840
1637
# Is this a D-Bus property?
841
1638
elif getattr(attribute, "_dbus_is_property", False):
842
1639
# Create a new, but exactly alike, function
843
1640
# object, and decorate it to be a new D-Bus
844
1641
# property with the alternate D-Bus interface
845
1642
# name. Add it to the class.
846
attr[attrname] = (dbus_service_property
847
(alt_interface,
848
attribute._dbus_signature,
849
attribute._dbus_access,
850
attribute
851
._dbus_get_args_options
852
["byte_arrays"])
853
(types.FunctionType
854
(attribute.func_code,
855
attribute.func_globals,
856
attribute.func_name,
857
attribute.func_defaults,
858
attribute.func_closure)))
859
return type.__new__(mcs, name, bases, attr)
860
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)))
1649
# Copy annotations, if any
1650
try:
1651
attr[attrname]._dbus_annotations = dict(
1652
attribute._dbus_annotations)
1653
except AttributeError:
1654
pass
1655
# Is this a D-Bus interface?
1656
elif getattr(attribute, "_dbus_is_interface", False):
1657
# Create a new, but exactly alike, function
1658
# object. Decorate it to be a new D-Bus interface
1659
# with the alternate D-Bus interface name. Add it
1660
# to the class.
1661
attr[attrname] = (
1662
dbus_interface_annotations(alt_interface)
1663
(copy_function(attribute)))
1664
if deprecate:
1665
# Deprecate all alternate interfaces
1666
iname="_AlternateDBusNames_interface_annotation{}"
1667
for interface_name in interface_names:
1668
1669
@dbus_interface_annotations(interface_name)
1670
def func(self):
1671
return { "org.freedesktop.DBus.Deprecated":
1672
"true" }
1673
# Find an unused name
1674
for aname in (iname.format(i)
1675
for i in itertools.count()):
1676
if aname not in attr:
1677
attr[aname] = func
1678
break
1679
if interface_names:
1680
# Replace the class with a new subclass of it with
1681
# methods, signals, etc. as created above.
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)
1688
return cls
1689
1690
return wrapper
1691
1692
1693
@alternate_dbus_interfaces({"se.recompile.Mandos":
1694
"se.bsnet.fukt.Mandos"})
861
1695
class ClientDBus(Client, DBusObjectWithProperties):
862
1696
"""A Client class using D-Bus
863
1697
867
1701
"""
868
1702
869
1703
runtime_expansions = (Client.runtime_expansions
870
+ ("dbus_object_path",))
1704
+ ("dbus_object_path", ))
1705
1706
_interface = "se.recompile.Mandos.Client"
871
1707
872
1708
# dbus.service.Object doesn't use super(), so we can't either.
873
1709
874
1710
def __init__(self, bus = None, *args, **kwargs):
875
self._approvals_pending = 0
876
1711
self.bus = bus
877
1712
Client.__init__(self, *args, **kwargs)
878
1713
# Only now, when this client is initialized, can it show up on
879
1714
# the D-Bus
880
client_object_name = unicode(self.name).translate(
1715
client_object_name = str(self.name).translate(
881
1716
{ord("."): ord("_"),
882
1717
ord("-"): ord("_")})
883
self.dbus_object_path = (dbus.ObjectPath
884
("/clients/" + client_object_name))
1718
self.dbus_object_path = dbus.ObjectPath(
1719
"/clients/" + client_object_name)
885
1720
DBusObjectWithProperties.__init__(self, self.bus,
886
1721
self.dbus_object_path)
887
888
def notifychangeproperty(transform_func,
889
dbus_name, type_func=lambda x: x,
890
variant_level=1):
1722
1723
def notifychangeproperty(transform_func, dbus_name,
1724
type_func=lambda x: x,
1725
variant_level=1,
1726
invalidate_only=False,
1727
_interface=_interface):
891
1728
""" Modify a variable so that it's a property which announces
892
1729
its changes to DBus.
893
894
transform_fun: Function that takes a value and transforms it
895
to a D-Bus type.
1730
1731
transform_fun: Function that takes a value and a variant_level
1732
and transforms it to a D-Bus type.
896
1733
dbus_name: D-Bus name of the variable
897
1734
type_func: Function that transform the value before sending it
898
1735
to the D-Bus. Default: no transform
899
1736
variant_level: D-Bus variant level. Default: 1
900
1737
"""
901
attrname = "_{0}".format(dbus_name)
1738
attrname = "_{}".format(dbus_name)
1739
902
1740
def setter(self, value):
903
1741
if hasattr(self, "dbus_object_path"):
904
1742
if (not hasattr(self, attrname) or
905
1743
type_func(getattr(self, attrname, None))
906
1744
!= type_func(value)):
907
dbus_value = transform_func(type_func(value),
908
variant_level)
909
self.PropertyChanged(dbus.String(dbus_name),
910
dbus_value)
1745
if invalidate_only:
1746
self.PropertiesChanged(
1747
_interface, dbus.Dictionary(),
1748
dbus.Array((dbus_name, )))
1749
else:
1750
dbus_value = transform_func(
1751
type_func(value),
1752
variant_level = variant_level)
1753
self.PropertyChanged(dbus.String(dbus_name),
1754
dbus_value)
1755
self.PropertiesChanged(
1756
_interface,
1757
dbus.Dictionary({ dbus.String(dbus_name):
1758
dbus_value }),
1759
dbus.Array())
911
1760
setattr(self, attrname, value)
912
1761
913
1762
return property(lambda self: getattr(self, attrname), setter)
914
1763
915
916
1764
expires = notifychangeproperty(datetime_to_dbus, "Expires")
917
1765
approvals_pending = notifychangeproperty(dbus.Boolean,
918
1766
"ApprovalPending",
920
1768
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
921
1769
last_enabled = notifychangeproperty(datetime_to_dbus,
922
1770
"LastEnabled")
923
checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
924
type_func = lambda checker:
925
checker is not None)
1771
checker = notifychangeproperty(
1772
dbus.Boolean, "CheckerRunning",
1773
type_func = lambda checker: checker is not None)
926
1774
last_checked_ok = notifychangeproperty(datetime_to_dbus,
927
1775
"LastCheckedOK")
1776
last_checker_status = notifychangeproperty(dbus.Int16,
1777
"LastCheckerStatus")
928
1778
last_approval_request = notifychangeproperty(
929
1779
datetime_to_dbus, "LastApprovalRequest")
930
1780
approved_by_default = notifychangeproperty(dbus.Boolean,
931
1781
"ApprovedByDefault")
932
approval_delay = notifychangeproperty(dbus.UInt16,
933
"ApprovalDelay",
934
type_func =
935
_timedelta_to_milliseconds)
1782
approval_delay = notifychangeproperty(
1783
dbus.UInt64, "ApprovalDelay",
1784
type_func = lambda td: td.total_seconds() * 1000)
936
1785
approval_duration = notifychangeproperty(
937
dbus.UInt16, "ApprovalDuration",
938
type_func = _timedelta_to_milliseconds)
1786
dbus.UInt64, "ApprovalDuration",
1787
type_func = lambda td: td.total_seconds() * 1000)
939
1788
host = notifychangeproperty(dbus.String, "Host")
940
timeout = notifychangeproperty(dbus.UInt16, "Timeout",
941
type_func =
942
_timedelta_to_milliseconds)
1789
timeout = notifychangeproperty(
1790
dbus.UInt64, "Timeout",
1791
type_func = lambda td: td.total_seconds() * 1000)
943
1792
extended_timeout = notifychangeproperty(
944
dbus.UInt16, "ExtendedTimeout",
945
type_func = _timedelta_to_milliseconds)
946
interval = notifychangeproperty(dbus.UInt16,
947
"Interval",
948
type_func =
949
_timedelta_to_milliseconds)
1793
dbus.UInt64, "ExtendedTimeout",
1794
type_func = lambda td: td.total_seconds() * 1000)
1795
interval = notifychangeproperty(
1796
dbus.UInt64, "Interval",
1797
type_func = lambda td: td.total_seconds() * 1000)
950
1798
checker_command = notifychangeproperty(dbus.String, "Checker")
1799
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1800
invalidate_only=True)
951
1801
952
1802
del notifychangeproperty
953
1803
960
1810
DBusObjectWithProperties.__del__(self, *args, **kwargs)
961
1811
Client.__del__(self, *args, **kwargs)
962
1812
963
def checker_callback(self, pid, condition, command,
964
*args, **kwargs):
965
self.checker_callback_tag = None
966
self.checker = None
967
if os.WIFEXITED(condition):
968
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:
969
1820
# Emit D-Bus signal
970
1821
self.CheckerCompleted(dbus.Int16(exitstatus),
971
dbus.Int64(condition),
1822
# This is specific to GNU libC
1823
dbus.Int64(exitstatus << 8),
972
1824
dbus.String(command))
973
1825
else:
974
1826
# Emit D-Bus signal
975
1827
self.CheckerCompleted(dbus.Int16(-1),
976
dbus.Int64(condition),
1828
dbus.Int64(
1829
# This is specific to GNU libC
1830
(exitstatus << 8)
1831
| self.last_checker_signal),
977
1832
dbus.String(command))
978
979
return Client.checker_callback(self, pid, condition, command,
980
*args, **kwargs)
1833
return ret
981
1834
982
1835
def start_checker(self, *args, **kwargs):
983
old_checker = self.checker
984
if self.checker is not None:
985
old_checker_pid = self.checker.pid
986
else:
987
old_checker_pid = None
1836
old_checker_pid = getattr(self.checker, "pid", None)
988
1837
r = Client.start_checker(self, *args, **kwargs)
989
1838
# Only if new checker process was started
990
1839
if (self.checker is not None
994
1843
return r
995
1844
996
1845
def _reset_approved(self):
997
self._approved = None
1846
self.approved = None
998
1847
return False
999
1848
1000
1849
def approve(self, value=True):
1850
self.approved = value
1851
GLib.timeout_add(int(self.approval_duration.total_seconds()
1852
* 1000), self._reset_approved)
1001
1853
self.send_changedstate()
1002
self._approved = value
1003
gobject.timeout_add(_timedelta_to_milliseconds
1004
(self.approval_duration),
1005
self._reset_approved)
1006
1007
1854
1008
1855
## D-Bus methods, signals & properties
1009
_interface = "se.recompile.Mandos.Client"
1856
1857
## Interfaces
1010
1858
1011
1859
## Signals
1012
1860
1023
1871
pass
1024
1872
1025
1873
# PropertyChanged - signal
1874
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1026
1875
@dbus.service.signal(_interface, signature="sv")
1027
1876
def PropertyChanged(self, property, value):
1028
1877
"D-Bus signal"
1062
1911
self.checked_ok()
1063
1912
1064
1913
# Enable - method
1914
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1065
1915
@dbus.service.method(_interface)
1066
1916
def Enable(self):
1067
1917
"D-Bus method"
1068
1918
self.enable()
1069
1919
1070
1920
# StartChecker - method
1921
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1071
1922
@dbus.service.method(_interface)
1072
1923
def StartChecker(self):
1073
1924
"D-Bus method"
1074
1925
self.start_checker()
1075
1926
1076
1927
# Disable - method
1928
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1077
1929
@dbus.service.method(_interface)
1078
1930
def Disable(self):
1079
1931
"D-Bus method"
1080
1932
self.disable()
1081
1933
1082
1934
# StopChecker - method
1935
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1083
1936
@dbus.service.method(_interface)
1084
1937
def StopChecker(self):
1085
1938
self.stop_checker()
1092
1945
return dbus.Boolean(bool(self.approvals_pending))
1093
1946
1094
1947
# ApprovedByDefault - property
1095
@dbus_service_property(_interface, signature="b",
1948
@dbus_service_property(_interface,
1949
signature="b",
1096
1950
access="readwrite")
1097
1951
def ApprovedByDefault_dbus_property(self, value=None):
1098
1952
if value is None: # get
1100
1954
self.approved_by_default = bool(value)
1101
1955
1102
1956
# ApprovalDelay - property
1103
@dbus_service_property(_interface, signature="t",
1957
@dbus_service_property(_interface,
1958
signature="t",
1104
1959
access="readwrite")
1105
1960
def ApprovalDelay_dbus_property(self, value=None):
1106
1961
if value is None: # get
1107
return dbus.UInt64(self.approval_delay_milliseconds())
1962
return dbus.UInt64(self.approval_delay.total_seconds()
1963
* 1000)
1108
1964
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1109
1965
1110
1966
# ApprovalDuration - property
1111
@dbus_service_property(_interface, signature="t",
1967
@dbus_service_property(_interface,
1968
signature="t",
1112
1969
access="readwrite")
1113
1970
def ApprovalDuration_dbus_property(self, value=None):
1114
1971
if value is None: # get
1115
return dbus.UInt64(_timedelta_to_milliseconds(
1116
self.approval_duration))
1972
return dbus.UInt64(self.approval_duration.total_seconds()
1973
* 1000)
1117
1974
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1118
1975
1119
1976
# Name - property
1977
@dbus_annotations(
1978
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1120
1979
@dbus_service_property(_interface, signature="s", access="read")
1121
1980
def Name_dbus_property(self):
1122
1981
return dbus.String(self.name)
1123
1982
1124
1983
# Fingerprint - property
1984
@dbus_annotations(
1985
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1125
1986
@dbus_service_property(_interface, signature="s", access="read")
1126
1987
def Fingerprint_dbus_property(self):
1127
1988
return dbus.String(self.fingerprint)
1128
1989
1129
1990
# Host - property
1130
@dbus_service_property(_interface, signature="s",
1991
@dbus_service_property(_interface,
1992
signature="s",
1131
1993
access="readwrite")
1132
1994
def Host_dbus_property(self, value=None):
1133
1995
if value is None: # get
1134
1996
return dbus.String(self.host)
1135
self.host = value
1997
self.host = str(value)
1136
1998
1137
1999
# Created - property
2000
@dbus_annotations(
2001
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1138
2002
@dbus_service_property(_interface, signature="s", access="read")
1139
2003
def Created_dbus_property(self):
1140
return dbus.String(datetime_to_dbus(self.created))
2004
return datetime_to_dbus(self.created)
1141
2005
1142
2006
# LastEnabled - property
1143
2007
@dbus_service_property(_interface, signature="s", access="read")
1145
2009
return datetime_to_dbus(self.last_enabled)
1146
2010
1147
2011
# Enabled - property
1148
@dbus_service_property(_interface, signature="b",
2012
@dbus_service_property(_interface,
2013
signature="b",
1149
2014
access="readwrite")
1150
2015
def Enabled_dbus_property(self, value=None):
1151
2016
if value is None: # get
1156
2021
self.disable()
1157
2022
1158
2023
# LastCheckedOK - property
1159
@dbus_service_property(_interface, signature="s",
2024
@dbus_service_property(_interface,
2025
signature="s",
1160
2026
access="readwrite")
1161
2027
def LastCheckedOK_dbus_property(self, value=None):
1162
2028
if value is not None:
1164
2030
return
1165
2031
return datetime_to_dbus(self.last_checked_ok)
1166
2032
2033
# LastCheckerStatus - property
2034
@dbus_service_property(_interface, signature="n", access="read")
2035
def LastCheckerStatus_dbus_property(self):
2036
return dbus.Int16(self.last_checker_status)
2037
1167
2038
# Expires - property
1168
2039
@dbus_service_property(_interface, signature="s", access="read")
1169
2040
def Expires_dbus_property(self):
1175
2046
return datetime_to_dbus(self.last_approval_request)
1176
2047
1177
2048
# Timeout - property
1178
@dbus_service_property(_interface, signature="t",
2049
@dbus_service_property(_interface,
2050
signature="t",
1179
2051
access="readwrite")
1180
2052
def Timeout_dbus_property(self, value=None):
1181
2053
if value is None: # get
1182
return dbus.UInt64(self.timeout_milliseconds())
2054
return dbus.UInt64(self.timeout.total_seconds() * 1000)
2055
old_timeout = self.timeout
1183
2056
self.timeout = datetime.timedelta(0, 0, 0, value)
1184
if getattr(self, "disable_initiator_tag", None) is None:
1185
return
1186
# Reschedule timeout
1187
gobject.source_remove(self.disable_initiator_tag)
1188
self.disable_initiator_tag = None
1189
self.expires = None
1190
time_to_die = (self.
1191
_timedelta_to_milliseconds((self
1192
.last_checked_ok
1193
+ self.timeout)
1194
- datetime.datetime
1195
.utcnow()))
1196
if time_to_die <= 0:
1197
# The timeout has passed
1198
self.disable()
1199
else:
1200
self.expires = (datetime.datetime.utcnow()
1201
+ datetime.timedelta(milliseconds =
1202
time_to_die))
1203
self.disable_initiator_tag = (gobject.timeout_add
1204
(time_to_die, self.disable))
2057
# Reschedule disabling
2058
if self.enabled:
2059
now = datetime.datetime.utcnow()
2060
self.expires += self.timeout - old_timeout
2061
if self.expires <= now:
2062
# The timeout has passed
2063
self.disable()
2064
else:
2065
if (getattr(self, "disable_initiator_tag", None)
2066
is None):
2067
return
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)
1205
2072
1206
2073
# ExtendedTimeout - property
1207
@dbus_service_property(_interface, signature="t",
2074
@dbus_service_property(_interface,
2075
signature="t",
1208
2076
access="readwrite")
1209
2077
def ExtendedTimeout_dbus_property(self, value=None):
1210
2078
if value is None: # get
1211
return dbus.UInt64(self.extended_timeout_milliseconds())
2079
return dbus.UInt64(self.extended_timeout.total_seconds()
2080
* 1000)
1212
2081
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1213
2082
1214
2083
# Interval - property
1215
@dbus_service_property(_interface, signature="t",
2084
@dbus_service_property(_interface,
2085
signature="t",
1216
2086
access="readwrite")
1217
2087
def Interval_dbus_property(self, value=None):
1218
2088
if value is None: # get
1219
return dbus.UInt64(self.interval_milliseconds())
2089
return dbus.UInt64(self.interval.total_seconds() * 1000)
1220
2090
self.interval = datetime.timedelta(0, 0, 0, value)
1221
2091
if getattr(self, "checker_initiator_tag", None) is None:
1222
2092
return
1223
# Reschedule checker run
1224
gobject.source_remove(self.checker_initiator_tag)
1225
self.checker_initiator_tag = (gobject.timeout_add
1226
(value, self.start_checker))
1227
self.start_checker() # Start one now, too
2093
if self.enabled:
2094
# Reschedule checker run
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
1228
2099
1229
2100
# Checker - property
1230
@dbus_service_property(_interface, signature="s",
2101
@dbus_service_property(_interface,
2102
signature="s",
1231
2103
access="readwrite")
1232
2104
def Checker_dbus_property(self, value=None):
1233
2105
if value is None: # get
1234
2106
return dbus.String(self.checker_command)
1235
self.checker_command = value
2107
self.checker_command = str(value)
1236
2108
1237
2109
# CheckerRunning - property
1238
@dbus_service_property(_interface, signature="b",
2110
@dbus_service_property(_interface,
2111
signature="b",
1239
2112
access="readwrite")
1240
2113
def CheckerRunning_dbus_property(self, value=None):
1241
2114
if value is None: # get
1246
2119
self.stop_checker()
1247
2120
1248
2121
# ObjectPath - property
2122
@dbus_annotations(
2123
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
2124
"org.freedesktop.DBus.Deprecated": "true"})
1249
2125
@dbus_service_property(_interface, signature="o", access="read")
1250
2126
def ObjectPath_dbus_property(self):
1251
2127
return self.dbus_object_path # is already a dbus.ObjectPath
1252
2128
1253
2129
# Secret = property
1254
@dbus_service_property(_interface, signature="ay",
1255
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)
1256
2137
def Secret_dbus_property(self, value):
1257
self.secret = str(value)
2138
self.secret = bytes(value)
1258
2139
1259
2140
del _interface
1260
2141
1264
2145
self._pipe = child_pipe
1265
2146
self._pipe.send(('init', fpr, address))
1266
2147
if not self._pipe.recv():
1267
raise KeyError()
2148
raise KeyError(fpr)
1268
2149
1269
2150
def __getattribute__(self, name):
1270
if(name == '_pipe'):
2151
if name == '_pipe':
1271
2152
return super(ProxyClient, self).__getattribute__(name)
1272
2153
self._pipe.send(('getattr', name))
1273
2154
data = self._pipe.recv()
1274
2155
if data[0] == 'data':
1275
2156
return data[1]
1276
2157
if data[0] == 'function':
2158
1277
2159
def func(*args, **kwargs):
1278
2160
self._pipe.send(('funcall', name, args, kwargs))
1279
2161
return self._pipe.recv()[1]
2162
1280
2163
return func
1281
2164
1282
2165
def __setattr__(self, name, value):
1283
if(name == '_pipe'):
2166
if name == '_pipe':
1284
2167
return super(ProxyClient, self).__setattr__(name, value)
1285
2168
self._pipe.send(('setattr', name, value))
1286
2169
1287
class ClientDBusTransitional(ClientDBus):
1288
__metaclass__ = AlternateDBusNamesMetaclass
1289
2170
1290
2171
class ClientHandler(socketserver.BaseRequestHandler, object):
1291
2172
"""A class to handle client connections.
1296
2177
def handle(self):
1297
2178
with contextlib.closing(self.server.child_pipe) as child_pipe:
1298
2179
logger.info("TCP connection from: %s",
1299
unicode(self.client_address))
2180
str(self.client_address))
1300
2181
logger.debug("Pipe FD: %d",
1301
2182
self.server.child_pipe.fileno())
1302
2183
1303
session = (gnutls.connection
1304
.ClientSession(self.request,
1305
gnutls.connection
1306
.X509Credentials()))
1307
1308
# Note: gnutls.connection.X509Credentials is really a
1309
# generic GnuTLS certificate credentials object so long as
1310
# no X.509 keys are added to it. Therefore, we can use it
1311
# here despite using OpenPGP certificates.
2184
session = gnutls.ClientSession(self.request)
1312
2185
1313
2186
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1314
2187
# "+AES-256-CBC", "+SHA1",
1318
2191
priority = self.server.gnutls_priority
1319
2192
if priority is None:
1320
2193
priority = "NORMAL"
1321
(gnutls.library.functions
1322
.gnutls_priority_set_direct(session._c_object,
1323
priority, None))
2194
gnutls.priority_set_direct(session._c_object,
2195
priority.encode("utf-8"),
2196
None)
1324
2197
1325
2198
# Start communication using the Mandos protocol
1326
2199
# Get protocol number
1328
2201
logger.debug("Protocol version: %r", line)
1329
2202
try:
1330
2203
if int(line.strip().split()[0]) > 1:
1331
raise RuntimeError
2204
raise RuntimeError(line)
1332
2205
except (ValueError, IndexError, RuntimeError) as error:
1333
2206
logger.error("Unknown protocol version: %s", error)
1334
2207
return
1336
2209
# Start GnuTLS connection
1337
2210
try:
1338
2211
session.handshake()
1339
except gnutls.errors.GNUTLSError as error:
2212
except gnutls.Error as error:
1340
2213
logger.warning("Handshake failed: %s", error)
1341
2214
# Do not run session.bye() here: the session is not
1342
2215
# established. Just abandon the request.
1346
2219
approval_required = False
1347
2220
try:
1348
2221
try:
1349
fpr = self.fingerprint(self.peer_certificate
1350
(session))
1351
except (TypeError,
1352
gnutls.errors.GNUTLSError) as error:
2222
fpr = self.fingerprint(
2223
self.peer_certificate(session))
2224
except (TypeError, gnutls.Error) as error:
1353
2225
logger.warning("Bad certificate: %s", error)
1354
2226
return
1355
2227
logger.debug("Fingerprint: %s", fpr)
1368
2240
while True:
1369
2241
if not client.enabled:
1370
2242
logger.info("Client %s is disabled",
1371
client.name)
2243
client.name)
1372
2244
if self.server.use_dbus:
1373
2245
# Emit D-Bus signal
1374
2246
client.Rejected("Disabled")
1375
2247
return
1376
2248
1377
if client._approved or not client.approval_delay:
2249
if client.approved or not client.approval_delay:
1378
2250
#We are approved or approval is disabled
1379
2251
break
1380
elif client._approved is None:
2252
elif client.approved is None:
1381
2253
logger.info("Client %s needs approval",
1382
2254
client.name)
1383
2255
if self.server.use_dbus:
1384
2256
# Emit D-Bus signal
1385
2257
client.NeedApproval(
1386
client.approval_delay_milliseconds(),
1387
client.approved_by_default)
2258
client.approval_delay.total_seconds()
2259
* 1000, client.approved_by_default)
1388
2260
else:
1389
2261
logger.warning("Client %s was not approved",
1390
2262
client.name)
1394
2266
return
1395
2267
1396
2268
#wait until timeout or approved
1397
#x = float(client
1398
# ._timedelta_to_milliseconds(delay))
1399
2269
time = datetime.datetime.now()
1400
2270
client.changedstate.acquire()
1401
(client.changedstate.wait
1402
(float(client._timedelta_to_milliseconds(delay)
1403
/ 1000)))
2271
client.changedstate.wait(delay.total_seconds())
1404
2272
client.changedstate.release()
1405
2273
time2 = datetime.datetime.now()
1406
2274
if (time2 - time) >= delay:
1417
2285
else:
1418
2286
delay -= time2 - time
1419
2287
1420
sent_size = 0
1421
while sent_size < len(client.secret):
1422
try:
1423
sent = session.send(client.secret[sent_size:])
1424
except gnutls.errors.GNUTLSError as error:
1425
logger.warning("gnutls send failed")
1426
return
1427
logger.debug("Sent: %d, remaining: %d",
1428
sent, len(client.secret)
1429
- (sent_size + sent))
1430
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
1431
2294
1432
2295
logger.info("Sending secret to %s", client.name)
1433
# bump the timeout as if seen
1434
client.checked_ok(client.extended_timeout)
2296
# bump the timeout using extended_timeout
2297
client.bump_timeout(client.extended_timeout)
1435
2298
if self.server.use_dbus:
1436
2299
# Emit D-Bus signal
1437
2300
client.GotSecret()
1441
2304
client.approvals_pending -= 1
1442
2305
try:
1443
2306
session.bye()
1444
except gnutls.errors.GNUTLSError as error:
1445
logger.warning("GnuTLS bye failed")
2307
except gnutls.Error as error:
2308
logger.warning("GnuTLS bye failed",
2309
exc_info=error)
1446
2310
1447
2311
@staticmethod
1448
2312
def peer_certificate(session):
1449
2313
"Return the peer's OpenPGP certificate as a bytestring"
1450
2314
# If not an OpenPGP certificate...
1451
if (gnutls.library.functions
1452
.gnutls_certificate_type_get(session._c_object)
1453
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1454
# ...do the normal thing
1455
return session.peer_certificate
2315
if (gnutls.certificate_type_get(session._c_object)
2316
!= gnutls.CRT_OPENPGP):
2317
# ...return invalid data
2318
return b""
1456
2319
list_size = ctypes.c_uint(1)
1457
cert_list = (gnutls.library.functions
1458
.gnutls_certificate_get_peers
2320
cert_list = (gnutls.certificate_get_peers
1459
2321
(session._c_object, ctypes.byref(list_size)))
1460
2322
if not bool(cert_list) and list_size.value != 0:
1461
raise gnutls.errors.GNUTLSError("error getting peer"
1462
" certificate")
2323
raise gnutls.Error("error getting peer certificate")
1463
2324
if list_size.value == 0:
1464
2325
return None
1465
2326
cert = cert_list[0]
1469
2330
def fingerprint(openpgp):
1470
2331
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
1471
2332
# New GnuTLS "datum" with the OpenPGP public key
1472
datum = (gnutls.library.types
1473
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1474
ctypes.POINTER
1475
(ctypes.c_ubyte)),
1476
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)))
1477
2337
# New empty GnuTLS certificate
1478
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1479
(gnutls.library.functions
1480
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2338
crt = gnutls.openpgp_crt_t()
2339
gnutls.openpgp_crt_init(ctypes.byref(crt))
1481
2340
# Import the OpenPGP public key into the certificate
1482
(gnutls.library.functions
1483
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1484
gnutls.library.constants
1485
.GNUTLS_OPENPGP_FMT_RAW))
2341
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2342
gnutls.OPENPGP_FMT_RAW)
1486
2343
# Verify the self signature in the key
1487
2344
crtverify = ctypes.c_uint()
1488
(gnutls.library.functions
1489
.gnutls_openpgp_crt_verify_self(crt, 0,
1490
ctypes.byref(crtverify)))
2345
gnutls.openpgp_crt_verify_self(crt, 0,
2346
ctypes.byref(crtverify))
1491
2347
if crtverify.value != 0:
1492
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1493
raise (gnutls.errors.CertificateSecurityError
1494
("Verify failed"))
2348
gnutls.openpgp_crt_deinit(crt)
2349
raise gnutls.CertificateSecurityError("Verify failed")
1495
2350
# New buffer for the fingerprint
1496
2351
buf = ctypes.create_string_buffer(20)
1497
2352
buf_len = ctypes.c_size_t()
1498
2353
# Get the fingerprint from the certificate into the buffer
1499
(gnutls.library.functions
1500
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1501
ctypes.byref(buf_len)))
2354
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2355
ctypes.byref(buf_len))
1502
2356
# Deinit the certificate
1503
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2357
gnutls.openpgp_crt_deinit(crt)
1504
2358
# Convert the buffer to a Python bytestring
1505
2359
fpr = ctypes.string_at(buf, buf_len.value)
1506
2360
# Convert the bytestring to hexadecimal notation
1507
hex_fpr = ''.join("%02X" % ord(char) for char in fpr)
2361
hex_fpr = binascii.hexlify(fpr).upper()
1508
2362
return hex_fpr
1509
2363
1510
2364
1511
2365
class MultiprocessingMixIn(object):
1512
2366
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2367
1513
2368
def sub_process_main(self, request, address):
1514
2369
try:
1515
2370
self.finish_request(request, address)
1516
except:
2371
except Exception:
1517
2372
self.handle_error(request, address)
1518
2373
self.close_request(request)
1519
2374
1520
2375
def process_request(self, request, address):
1521
2376
"""Start a new process to process the request."""
1522
multiprocessing.Process(target = self.sub_process_main,
1523
args = (request, address)).start()
2377
proc = multiprocessing.Process(target = self.sub_process_main,
2378
args = (request, address))
2379
proc.start()
2380
return proc
1524
2381
1525
2382
1526
2383
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1527
2384
""" adds a pipe to the MixIn """
2385
1528
2386
def process_request(self, request, client_address):
1529
2387
"""Overrides and wraps the original process_request().
1530
2388
1532
2390
"""
1533
2391
parent_pipe, self.child_pipe = multiprocessing.Pipe()
1534
2392
1535
super(MultiprocessingMixInWithPipe,
1536
self).process_request(request, client_address)
2393
proc = MultiprocessingMixIn.process_request(self, request,
2394
client_address)
1537
2395
self.child_pipe.close()
1538
self.add_pipe(parent_pipe)
2396
self.add_pipe(parent_pipe, proc)
1539
2397
1540
def add_pipe(self, parent_pipe):
2398
def add_pipe(self, parent_pipe, proc):
1541
2399
"""Dummy function; override as necessary"""
1542
raise NotImplementedError
2400
raise NotImplementedError()
1543
2401
1544
2402
1545
2403
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1551
2409
interface: None or a network interface name (string)
1552
2410
use_ipv6: Boolean; to use IPv6 or not
1553
2411
"""
2412
1554
2413
def __init__(self, server_address, RequestHandlerClass,
1555
interface=None, use_ipv6=True):
2414
interface=None,
2415
use_ipv6=True,
2416
socketfd=None):
2417
"""If socketfd is set, use that file descriptor instead of
2418
creating a new one with socket.socket().
2419
"""
1556
2420
self.interface = interface
1557
2421
if use_ipv6:
1558
2422
self.address_family = socket.AF_INET6
2423
if socketfd is not None:
2424
# Save the file descriptor
2425
self.socketfd = socketfd
2426
# Save the original socket.socket() function
2427
self.socket_socket = socket.socket
2428
# To implement --socket, we monkey patch socket.socket.
2429
#
2430
# (When socketserver.TCPServer is a new-style class, we
2431
# could make self.socket into a property instead of monkey
2432
# patching socket.socket.)
2433
#
2434
# Create a one-time-only replacement for socket.socket()
2435
@functools.wraps(socket.socket)
2436
def socket_wrapper(*args, **kwargs):
2437
# Restore original function so subsequent calls are
2438
# not affected.
2439
socket.socket = self.socket_socket
2440
del self.socket_socket
2441
# This time only, return a new socket object from the
2442
# saved file descriptor.
2443
return socket.fromfd(self.socketfd, *args, **kwargs)
2444
# Replace socket.socket() function with wrapper
2445
socket.socket = socket_wrapper
2446
# The socketserver.TCPServer.__init__ will call
2447
# socket.socket(), which might be our replacement,
2448
# socket_wrapper(), if socketfd was set.
1559
2449
socketserver.TCPServer.__init__(self, server_address,
1560
2450
RequestHandlerClass)
2451
1561
2452
def server_bind(self):
1562
2453
"""This overrides the normal server_bind() function
1563
2454
to bind to an interface if one was specified, and also NOT to
1564
2455
bind to an address or port if they were not specified."""
2456
global SO_BINDTODEVICE
1565
2457
if self.interface is not None:
1566
2458
if SO_BINDTODEVICE is None:
1567
logger.error("SO_BINDTODEVICE does not exist;"
1568
" cannot bind to interface %s",
1569
self.interface)
1570
else:
1571
try:
1572
self.socket.setsockopt(socket.SOL_SOCKET,
1573
SO_BINDTODEVICE,
1574
str(self.interface
1575
+ '\0'))
1576
except socket.error as error:
1577
if error[0] == errno.EPERM:
1578
logger.error("No permission to"
1579
" bind to interface %s",
1580
self.interface)
1581
elif error[0] == errno.ENOPROTOOPT:
1582
logger.error("SO_BINDTODEVICE not available;"
1583
" cannot bind to interface %s",
1584
self.interface)
1585
else:
1586
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
1587
2480
# Only bind(2) the socket if we really need to.
1588
2481
if self.server_address[0] or self.server_address[1]:
1589
2482
if not self.server_address[0]:
1590
2483
if self.address_family == socket.AF_INET6:
1591
2484
any_address = "::" # in6addr_any
1592
2485
else:
1593
any_address = socket.INADDR_ANY
2486
any_address = "0.0.0.0" # INADDR_ANY
1594
2487
self.server_address = (any_address,
1595
2488
self.server_address[1])
1596
2489
elif not self.server_address[1]:
1597
self.server_address = (self.server_address[0],
1598
0)
2490
self.server_address = (self.server_address[0], 0)
1599
2491
# if self.interface:
1600
2492
# self.server_address = (self.server_address[0],
1601
2493
# 0, # port
1613
2505
gnutls_priority GnuTLS priority string
1614
2506
use_dbus: Boolean; to emit D-Bus signals or not
1615
2507
1616
Assumes a gobject.MainLoop event loop.
2508
Assumes a GLib.MainLoop event loop.
1617
2509
"""
2510
1618
2511
def __init__(self, server_address, RequestHandlerClass,
1619
interface=None, use_ipv6=True, clients=None,
1620
gnutls_priority=None, use_dbus=True):
2512
interface=None,
2513
use_ipv6=True,
2514
clients=None,
2515
gnutls_priority=None,
2516
use_dbus=True,
2517
socketfd=None):
1621
2518
self.enabled = False
1622
2519
self.clients = clients
1623
2520
if self.clients is None:
1624
self.clients = set()
2521
self.clients = {}
1625
2522
self.use_dbus = use_dbus
1626
2523
self.gnutls_priority = gnutls_priority
1627
2524
IPv6_TCPServer.__init__(self, server_address,
1628
2525
RequestHandlerClass,
1629
2526
interface = interface,
1630
use_ipv6 = use_ipv6)
2527
use_ipv6 = use_ipv6,
2528
socketfd = socketfd)
2529
1631
2530
def server_activate(self):
1632
2531
if self.enabled:
1633
2532
return socketserver.TCPServer.server_activate(self)
2533
1634
2534
def enable(self):
1635
2535
self.enabled = True
1636
def add_pipe(self, parent_pipe):
2536
2537
def add_pipe(self, parent_pipe, proc):
1637
2538
# Call "handle_ipc" for both data and EOF events
1638
gobject.io_add_watch(parent_pipe.fileno(),
1639
gobject.IO_IN | gobject.IO_HUP,
1640
functools.partial(self.handle_ipc,
1641
parent_pipe =
1642
parent_pipe))
1643
1644
def handle_ipc(self, source, condition, parent_pipe=None,
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))
2545
2546
def handle_ipc(self, source, condition,
2547
parent_pipe=None,
2548
proc = None,
1645
2549
client_object=None):
1646
condition_names = {
1647
gobject.IO_IN: "IN", # There is data to read.
1648
gobject.IO_OUT: "OUT", # Data can be written (without
1649
# blocking).
1650
gobject.IO_PRI: "PRI", # There is urgent data to read.
1651
gobject.IO_ERR: "ERR", # Error condition.
1652
gobject.IO_HUP: "HUP" # Hung up (the connection has been
1653
# broken, usually for pipes and
1654
# sockets).
1655
}
1656
conditions_string = ' | '.join(name
1657
for cond, name in
1658
condition_names.iteritems()
1659
if cond & condition)
1660
# error or the other end of multiprocessing.Pipe has closed
1661
if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
2550
# error, or the other end of multiprocessing.Pipe has closed
2551
if condition & (GLib.IO_ERR | GLib.IO_HUP):
2552
# Wait for other process to exit
2553
proc.join()
1662
2554
return False
1663
2555
1664
2556
# Read a request from the child
1669
2561
fpr = request[1]
1670
2562
address = request[2]
1671
2563
1672
for c in self.clients:
2564
for c in self.clients.values():
1673
2565
if c.fingerprint == fpr:
1674
2566
client = c
1675
2567
break
1683
2575
parent_pipe.send(False)
1684
2576
return False
1685
2577
1686
gobject.io_add_watch(parent_pipe.fileno(),
1687
gobject.IO_IN | gobject.IO_HUP,
1688
functools.partial(self.handle_ipc,
1689
parent_pipe =
1690
parent_pipe,
1691
client_object =
1692
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))
1693
2585
parent_pipe.send(True)
1694
2586
# remove the old hook in favor of the new above hook on
1695
2587
# same fileno
1701
2593
1702
2594
parent_pipe.send(('data', getattr(client_object,
1703
2595
funcname)(*args,
1704
**kwargs)))
2596
**kwargs)))
1705
2597
1706
2598
if command == 'getattr':
1707
2599
attrname = request[1]
1708
if callable(client_object.__getattribute__(attrname)):
1709
parent_pipe.send(('function',))
2600
if isinstance(client_object.__getattribute__(attrname),
2601
collections.Callable):
2602
parent_pipe.send(('function', ))
1710
2603
else:
1711
parent_pipe.send(('data', client_object
1712
.__getattribute__(attrname)))
2604
parent_pipe.send((
2605
'data', client_object.__getattribute__(attrname)))
1713
2606
1714
2607
if command == 'setattr':
1715
2608
attrname = request[1]
1719
2612
return True
1720
2613
1721
2614
2615
def rfc3339_duration_to_delta(duration):
2616
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2617
2618
>>> rfc3339_duration_to_delta("P7D")
2619
datetime.timedelta(7)
2620
>>> rfc3339_duration_to_delta("PT60S")
2621
datetime.timedelta(0, 60)
2622
>>> rfc3339_duration_to_delta("PT60M")
2623
datetime.timedelta(0, 3600)
2624
>>> rfc3339_duration_to_delta("PT24H")
2625
datetime.timedelta(1)
2626
>>> rfc3339_duration_to_delta("P1W")
2627
datetime.timedelta(7)
2628
>>> rfc3339_duration_to_delta("PT5M30S")
2629
datetime.timedelta(0, 330)
2630
>>> rfc3339_duration_to_delta("P1DT3M20S")
2631
datetime.timedelta(1, 200)
2632
"""
2633
2634
# Parsing an RFC 3339 duration with regular expressions is not
2635
# possible - there would have to be multiple places for the same
2636
# values, like seconds. The current code, while more esoteric, is
2637
# cleaner without depending on a parsing library. If Python had a
2638
# built-in library for parsing we would use it, but we'd like to
2639
# avoid excessive use of external libraries.
2640
2641
# New type for defining tokens, syntax, and semantics all-in-one
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
2647
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2648
# the "duration" ABNF definition in RFC 3339, Appendix A.
2649
token_end = Token(re.compile(r"$"), None, frozenset())
2650
token_second = Token(re.compile(r"(\d+)S"),
2651
datetime.timedelta(seconds=1),
2652
frozenset((token_end, )))
2653
token_minute = Token(re.compile(r"(\d+)M"),
2654
datetime.timedelta(minutes=1),
2655
frozenset((token_second, token_end)))
2656
token_hour = Token(re.compile(r"(\d+)H"),
2657
datetime.timedelta(hours=1),
2658
frozenset((token_minute, token_end)))
2659
token_time = Token(re.compile(r"T"),
2660
None,
2661
frozenset((token_hour, token_minute,
2662
token_second)))
2663
token_day = Token(re.compile(r"(\d+)D"),
2664
datetime.timedelta(days=1),
2665
frozenset((token_time, token_end)))
2666
token_month = Token(re.compile(r"(\d+)M"),
2667
datetime.timedelta(weeks=4),
2668
frozenset((token_day, token_end)))
2669
token_year = Token(re.compile(r"(\d+)Y"),
2670
datetime.timedelta(weeks=52),
2671
frozenset((token_month, token_end)))
2672
token_week = Token(re.compile(r"(\d+)W"),
2673
datetime.timedelta(weeks=1),
2674
frozenset((token_end, )))
2675
token_duration = Token(re.compile(r"P"), None,
2676
frozenset((token_year, token_month,
2677
token_day, token_time,
2678
token_week)))
2679
# Define starting values
2680
value = datetime.timedelta() # Value so far
2681
found_token = None
2682
followers = frozenset((token_duration, )) # Following valid tokens
2683
s = duration # String left to parse
2684
# Loop until end token is found
2685
while found_token is not token_end:
2686
# Search for any currently valid tokens
2687
for token in followers:
2688
match = token.regexp.match(s)
2689
if match is not None:
2690
# Token found
2691
if token.value is not None:
2692
# Value found, parse digits
2693
factor = int(match.group(1), 10)
2694
# Add to value so far
2695
value += factor * token.value
2696
# Strip token from string
2697
s = token.regexp.sub("", s, 1)
2698
# Go to found token
2699
found_token = token
2700
# Set valid next tokens
2701
followers = found_token.followers
2702
break
2703
else:
2704
# No currently valid tokens were found
2705
raise ValueError("Invalid RFC 3339 duration: {!r}"
2706
.format(duration))
2707
# End token found
2708
return value
2709
2710
1722
2711
def string_to_delta(interval):
1723
2712
"""Parse a string and return a datetime.timedelta
1724
2713
1735
2724
>>> string_to_delta('5m 30s')
1736
2725
datetime.timedelta(0, 330)
1737
2726
"""
2727
2728
try:
2729
return rfc3339_duration_to_delta(interval)
2730
except ValueError:
2731
pass
2732
1738
2733
timevalue = datetime.timedelta(0)
1739
2734
for s in interval.split():
1740
2735
try:
1741
suffix = unicode(s[-1])
2736
suffix = s[-1]
1742
2737
value = int(s[:-1])
1743
2738
if suffix == "d":
1744
2739
delta = datetime.timedelta(value)
1751
2746
elif suffix == "w":
1752
2747
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
1753
2748
else:
1754
raise ValueError("Unknown suffix %r" % suffix)
1755
except (ValueError, IndexError) as e:
2749
raise ValueError("Unknown suffix {!r}".format(suffix))
2750
except IndexError as e:
1756
2751
raise ValueError(*(e.args))
1757
2752
timevalue += delta
1758
2753
return timevalue
1759
2754
1760
2755
1761
def if_nametoindex(interface):
1762
"""Call the C function if_nametoindex(), or equivalent
1763
1764
Note: This function cannot accept a unicode string."""
1765
global if_nametoindex
1766
try:
1767
if_nametoindex = (ctypes.cdll.LoadLibrary
1768
(ctypes.util.find_library("c"))
1769
.if_nametoindex)
1770
except (OSError, AttributeError):
1771
logger.warning("Doing if_nametoindex the hard way")
1772
def if_nametoindex(interface):
1773
"Get an interface index the hard way, i.e. using fcntl()"
1774
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
1775
with contextlib.closing(socket.socket()) as s:
1776
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1777
struct.pack(str("16s16x"),
1778
interface))
1779
interface_index = struct.unpack(str("I"),
1780
ifreq[16:20])[0]
1781
return interface_index
1782
return if_nametoindex(interface)
1783
1784
1785
2756
def daemon(nochdir = False, noclose = False):
1786
2757
"""See daemon(3). Standard BSD Unix function.
1787
2758
1795
2766
sys.exit()
1796
2767
if not noclose:
1797
2768
# Close all standard open file descriptors
1798
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2769
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1799
2770
if not stat.S_ISCHR(os.fstat(null).st_mode):
1800
2771
raise OSError(errno.ENODEV,
1801
"%s not a character device"
1802
% os.path.devnull)
2772
"{} not a character device"
2773
.format(os.devnull))
1803
2774
os.dup2(null, sys.stdin.fileno())
1804
2775
os.dup2(null, sys.stdout.fileno())
1805
2776
os.dup2(null, sys.stderr.fileno())
1814
2785
1815
2786
parser = argparse.ArgumentParser()
1816
2787
parser.add_argument("-v", "--version", action="version",
1817
version = "%%(prog)s %s" % version,
2788
version = "%(prog)s {}".format(version),
1818
2789
help="show version number and exit")
1819
2790
parser.add_argument("-i", "--interface", metavar="IF",
1820
2791
help="Bind to interface IF")
1826
2797
help="Run self-test")
1827
2798
parser.add_argument("--debug", action="store_true",
1828
2799
help="Debug mode; run in foreground and log"
1829
" to terminal")
2800
" to terminal", default=None)
1830
2801
parser.add_argument("--debuglevel", metavar="LEVEL",
1831
2802
help="Debug level for stdout output")
1832
2803
parser.add_argument("--priority", help="GnuTLS"
1839
2810
" files")
1840
2811
parser.add_argument("--no-dbus", action="store_false",
1841
2812
dest="use_dbus", help="Do not provide D-Bus"
1842
" system bus interface")
2813
" system bus interface", default=None)
1843
2814
parser.add_argument("--no-ipv6", action="store_false",
1844
dest="use_ipv6", help="Do not use IPv6")
2815
dest="use_ipv6", help="Do not use IPv6",
2816
default=None)
2817
parser.add_argument("--no-restore", action="store_false",
2818
dest="restore", help="Do not restore stored"
2819
" state", default=None)
2820
parser.add_argument("--socket", type=int,
2821
help="Specify a file descriptor to a network"
2822
" socket to use instead of creating one")
2823
parser.add_argument("--statedir", metavar="DIR",
2824
help="Directory to save/restore state in")
2825
parser.add_argument("--foreground", action="store_true",
2826
help="Run in foreground", default=None)
2827
parser.add_argument("--no-zeroconf", action="store_false",
2828
dest="zeroconf", help="Do not use Zeroconf",
2829
default=None)
2830
1845
2831
options = parser.parse_args()
1846
2832
1847
2833
if options.check:
1848
2834
import doctest
1849
doctest.testmod()
1850
sys.exit()
2835
fail_count, test_count = doctest.testmod()
2836
sys.exit(os.EX_OK if fail_count == 0 else 1)
1851
2837
1852
2838
# Default values for config file for server-global settings
1853
2839
server_defaults = { "interface": "",
1855
2841
"port": "",
1856
2842
"debug": "False",
1857
2843
"priority":
1858
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
2844
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2845
":+SIGN-DSA-SHA256",
1859
2846
"servicename": "Mandos",
1860
2847
"use_dbus": "True",
1861
2848
"use_ipv6": "True",
1862
2849
"debuglevel": "",
1863
}
2850
"restore": "True",
2851
"socket": "",
2852
"statedir": "/var/lib/mandos",
2853
"foreground": "False",
2854
"zeroconf": "True",
2855
}
1864
2856
1865
2857
# Parse config file for server-global settings
1866
2858
server_config = configparser.SafeConfigParser(server_defaults)
1867
2859
del server_defaults
1868
server_config.read(os.path.join(options.configdir,
1869
"mandos.conf"))
2860
server_config.read(os.path.join(options.configdir, "mandos.conf"))
1870
2861
# Convert the SafeConfigParser object to a dict
1871
2862
server_settings = server_config.defaults()
1872
2863
# Use the appropriate methods on the non-string config options
1873
for option in ("debug", "use_dbus", "use_ipv6"):
2864
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
1874
2865
server_settings[option] = server_config.getboolean("DEFAULT",
1875
2866
option)
1876
2867
if server_settings["port"]:
1877
2868
server_settings["port"] = server_config.getint("DEFAULT",
1878
2869
"port")
2870
if server_settings["socket"]:
2871
server_settings["socket"] = server_config.getint("DEFAULT",
2872
"socket")
2873
# Later, stdin will, and stdout and stderr might, be dup'ed
2874
# over with an opened os.devnull. But we don't want this to
2875
# happen with a supplied network socket.
2876
if 0 <= server_settings["socket"] <= 2:
2877
server_settings["socket"] = os.dup(server_settings
2878
["socket"])
1879
2879
del server_config
1880
2880
1881
2881
# Override the settings from the config file with command line
1882
2882
# options, if set.
1883
2883
for option in ("interface", "address", "port", "debug",
1884
"priority", "servicename", "configdir",
1885
"use_dbus", "use_ipv6", "debuglevel"):
2884
"priority", "servicename", "configdir", "use_dbus",
2885
"use_ipv6", "debuglevel", "restore", "statedir",
2886
"socket", "foreground", "zeroconf"):
1886
2887
value = getattr(options, option)
1887
2888
if value is not None:
1888
2889
server_settings[option] = value
1889
2890
del options
1890
2891
# Force all strings to be unicode
1891
2892
for option in server_settings.keys():
1892
if type(server_settings[option]) is str:
1893
server_settings[option] = unicode(server_settings[option])
2893
if isinstance(server_settings[option], bytes):
2894
server_settings[option] = (server_settings[option]
2895
.decode("utf-8"))
2896
# Force all boolean options to be boolean
2897
for option in ("debug", "use_dbus", "use_ipv6", "restore",
2898
"foreground", "zeroconf"):
2899
server_settings[option] = bool(server_settings[option])
2900
# Debug implies foreground
2901
if server_settings["debug"]:
2902
server_settings["foreground"] = True
1894
2903
# Now we have our good server settings in "server_settings"
1895
2904
1896
2905
##################################################################
1897
2906
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")
2911
1898
2912
# For convenience
1899
2913
debug = server_settings["debug"]
1900
2914
debuglevel = server_settings["debuglevel"]
1901
2915
use_dbus = server_settings["use_dbus"]
1902
2916
use_ipv6 = server_settings["use_ipv6"]
2917
stored_state_path = os.path.join(server_settings["statedir"],
2918
stored_state_file)
2919
foreground = server_settings["foreground"]
2920
zeroconf = server_settings["zeroconf"]
2921
2922
if debug:
2923
initlogger(debug, logging.DEBUG)
2924
else:
2925
if not debuglevel:
2926
initlogger(debug)
2927
else:
2928
level = getattr(logging, debuglevel.upper())
2929
initlogger(debug, level)
1903
2930
1904
2931
if server_settings["servicename"] != "Mandos":
1905
syslogger.setFormatter(logging.Formatter
1906
('Mandos (%s) [%%(process)d]:'
1907
' %%(levelname)s: %%(message)s'
1908
% server_settings["servicename"]))
2932
syslogger.setFormatter(
2933
logging.Formatter('Mandos ({}) [%(process)d]:'
2934
' %(levelname)s: %(message)s'.format(
2935
server_settings["servicename"])))
1909
2936
1910
2937
# Parse config file with clients
1911
client_defaults = { "timeout": "5m",
1912
"extended_timeout": "15m",
1913
"interval": "2m",
1914
"checker": "fping -q -- %%(host)s",
1915
"host": "",
1916
"approval_delay": "0s",
1917
"approval_duration": "1s",
1918
}
1919
client_config = configparser.SafeConfigParser(client_defaults)
2938
client_config = configparser.SafeConfigParser(Client
2939
.client_defaults)
1920
2940
client_config.read(os.path.join(server_settings["configdir"],
1921
2941
"clients.conf"))
1922
2942
1923
2943
global mandos_dbus_service
1924
2944
mandos_dbus_service = None
1925
2945
1926
tcp_server = MandosServer((server_settings["address"],
1927
server_settings["port"]),
1928
ClientHandler,
1929
interface=(server_settings["interface"]
1930
or None),
1931
use_ipv6=use_ipv6,
1932
gnutls_priority=
1933
server_settings["priority"],
1934
use_dbus=use_dbus)
1935
if not debug:
1936
pidfilename = "/var/run/mandos.pid"
2946
socketfd = None
2947
if server_settings["socket"] != "":
2948
socketfd = server_settings["socket"]
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)
2957
if not foreground:
2958
pidfilename = "/run/mandos.pid"
2959
if not os.path.isdir("/run/."):
2960
pidfilename = "/var/run/mandos.pid"
2961
pidfile = None
1937
2962
try:
1938
pidfile = open(pidfilename, "w")
1939
except IOError:
1940
logger.error("Could not open file %r", pidfilename)
2963
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
2964
except IOError as e:
2965
logger.error("Could not open file %r", pidfilename,
2966
exc_info=e)
1941
2967
1942
try:
1943
uid = pwd.getpwnam("_mandos").pw_uid
1944
gid = pwd.getpwnam("_mandos").pw_gid
1945
except KeyError:
2968
for name, group in (("_mandos", "_mandos"),
2969
("mandos", "mandos"),
2970
("nobody", "nogroup")):
1946
2971
try:
1947
uid = pwd.getpwnam("mandos").pw_uid
1948
gid = pwd.getpwnam("mandos").pw_gid
2972
uid = pwd.getpwnam(name).pw_uid
2973
gid = pwd.getpwnam(group).pw_gid
2974
break
1949
2975
except KeyError:
1950
try:
1951
uid = pwd.getpwnam("nobody").pw_uid
1952
gid = pwd.getpwnam("nobody").pw_gid
1953
except KeyError:
1954
uid = 65534
1955
gid = 65534
2976
continue
2977
else:
2978
uid = 65534
2979
gid = 65534
1956
2980
try:
1957
2981
os.setgid(gid)
1958
2982
os.setuid(uid)
2983
if debug:
2984
logger.debug("Did setuid/setgid to {}:{}".format(uid,
2985
gid))
1959
2986
except OSError as error:
1960
if error[0] != errno.EPERM:
1961
raise error
1962
1963
if not debug and not debuglevel:
1964
syslogger.setLevel(logging.WARNING)
1965
console.setLevel(logging.WARNING)
1966
if debuglevel:
1967
level = getattr(logging, debuglevel.upper())
1968
syslogger.setLevel(level)
1969
console.setLevel(level)
2987
logger.warning("Failed to setuid/setgid to {}:{}: {}"
2988
.format(uid, gid, os.strerror(error.errno)))
2989
if error.errno != errno.EPERM:
2990
raise
1970
2991
1971
2992
if debug:
1972
2993
# Enable all possible GnuTLS debugging
1973
2994
1974
2995
# "Use a log level over 10 to enable all debugging options."
1975
2996
# - GnuTLS manual
1976
gnutls.library.functions.gnutls_global_set_log_level(11)
2997
gnutls.global_set_log_level(11)
1977
2998
1978
@gnutls.library.types.gnutls_log_func
2999
@gnutls.log_func
1979
3000
def debug_gnutls(level, string):
1980
3001
logger.debug("GnuTLS: %s", string[:-1])
1981
3002
1982
(gnutls.library.functions
1983
.gnutls_global_set_log_function(debug_gnutls))
3003
gnutls.global_set_log_function(debug_gnutls)
1984
3004
1985
3005
# Redirect stdin so all checkers get /dev/null
1986
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
3006
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1987
3007
os.dup2(null, sys.stdin.fileno())
1988
3008
if null > 2:
1989
3009
os.close(null)
1990
else:
1991
# No console logging
1992
logger.removeHandler(console)
1993
3010
1994
3011
# Need to fork before connecting to D-Bus
1995
if not debug:
3012
if not foreground:
1996
3013
# Close all input and output, do double fork, etc.
1997
3014
daemon()
1998
3015
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()
3019
1999
3020
global main_loop
2000
3021
# From the Avahi example code
2001
DBusGMainLoop(set_as_default=True )
2002
main_loop = gobject.MainLoop()
3022
DBusGMainLoop(set_as_default=True)
3023
main_loop = GLib.MainLoop()
2003
3024
bus = dbus.SystemBus()
2004
3025
# End of Avahi example code
2005
3026
if use_dbus:
2006
3027
try:
2007
3028
bus_name = dbus.service.BusName("se.recompile.Mandos",
2008
bus, do_not_queue=True)
2009
old_bus_name = (dbus.service.BusName
2010
("se.bsnet.fukt.Mandos", bus,
2011
do_not_queue=True))
2012
except dbus.exceptions.NameExistsException as e:
2013
logger.error(unicode(e) + ", disabling D-Bus")
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:
3035
logger.error("Disabling D-Bus:", exc_info=e)
2014
3036
use_dbus = False
2015
3037
server_settings["use_dbus"] = False
2016
3038
tcp_server.use_dbus = False
2017
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2018
service = AvahiService(name = server_settings["servicename"],
2019
servicetype = "_mandos._tcp",
2020
protocol = protocol, bus = bus)
2021
if server_settings["interface"]:
2022
service.interface = (if_nametoindex
2023
(str(server_settings["interface"])))
3039
if zeroconf:
3040
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3041
service = AvahiServiceToSyslog(
3042
name = server_settings["servicename"],
3043
servicetype = "_mandos._tcp",
3044
protocol = protocol,
3045
bus = bus)
3046
if server_settings["interface"]:
3047
service.interface = if_nametoindex(
3048
server_settings["interface"].encode("utf-8"))
2024
3049
2025
3050
global multiprocessing_manager
2026
3051
multiprocessing_manager = multiprocessing.Manager()
2027
3052
2028
3053
client_class = Client
2029
3054
if use_dbus:
2030
client_class = functools.partial(ClientDBusTransitional,
2031
bus = bus)
2032
def client_config_items(config, section):
2033
special_settings = {
2034
"approved_by_default":
2035
lambda: config.getboolean(section,
2036
"approved_by_default"),
2037
}
2038
for name, value in config.items(section):
3055
client_class = functools.partial(ClientDBus, bus = bus)
3056
3057
client_settings = Client.config_parser(client_config)
3058
old_client_settings = {}
3059
clients_data = {}
3060
3061
# This is used to redirect stdout and stderr for checker processes
3062
global wnull
3063
wnull = open(os.devnull, "w") # A writable /dev/null
3064
# Only used if server is running in foreground but not in debug
3065
# mode
3066
if debug or not foreground:
3067
wnull.close()
3068
3069
# Get client data and settings from last running state.
3070
if server_settings["restore"]:
3071
try:
3072
with open(stored_state_path, "rb") as 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"))
3118
os.remove(stored_state_path)
3119
except IOError as e:
3120
if e.errno == errno.ENOENT:
3121
logger.warning("Could not load persistent state:"
3122
" {}".format(os.strerror(e.errno)))
3123
else:
3124
logger.critical("Could not load persistent state:",
3125
exc_info=e)
3126
raise
3127
except EOFError as e:
3128
logger.warning("Could not load persistent state: "
3129
"EOFError:",
3130
exc_info=e)
3131
3132
with PGPEngine() as pgp:
3133
for client_name, client in clients_data.items():
3134
# Skip removed clients
3135
if client_name not in client_settings:
3136
continue
3137
3138
# Decide which value to use after restoring saved state.
3139
# We have three different values: Old config file,
3140
# new config file, and saved state.
3141
# New config value takes precedence if it differs from old
3142
# config value, otherwise use saved state.
3143
for name, value in client_settings[client_name].items():
3144
try:
3145
# For each value in new config, check if it
3146
# differs from the old config value (Except for
3147
# the "secret" attribute)
3148
if (name != "secret"
3149
and (value !=
3150
old_client_settings[client_name][name])):
3151
client[name] = value
3152
except KeyError:
3153
pass
3154
3155
# Clients who has passed its expire date can still be
3156
# enabled if its last checker was successful. A Client
3157
# whose checker succeeded before we stored its state is
3158
# assumed to have successfully run all checkers during
3159
# downtime.
3160
if client["enabled"]:
3161
if datetime.datetime.utcnow() >= client["expires"]:
3162
if not client["last_checked_ok"]:
3163
logger.warning(
3164
"disabling client {} - Client never "
3165
"performed a successful checker".format(
3166
client_name))
3167
client["enabled"] = False
3168
elif client["last_checker_status"] != 0:
3169
logger.warning(
3170
"disabling client {} - Client last"
3171
" checker failed with error code"
3172
" {}".format(
3173
client_name,
3174
client["last_checker_status"]))
3175
client["enabled"] = False
3176
else:
3177
client["expires"] = (
3178
datetime.datetime.utcnow()
3179
+ client["timeout"])
3180
logger.debug("Last checker succeeded,"
3181
" keeping {} enabled".format(
3182
client_name))
2039
3183
try:
2040
yield (name, special_settings[name]())
2041
except KeyError:
2042
yield (name, value)
2043
2044
tcp_server.clients.update(set(
2045
client_class(name = section,
2046
config= dict(client_config_items(
2047
client_config, section)))
2048
for section in client_config.sections()))
3184
client["secret"] = pgp.decrypt(
3185
client["encrypted_secret"],
3186
client_settings[client_name]["secret"])
3187
except PGPError:
3188
# If decryption fails, we use secret from new settings
3189
logger.debug("Failed to decrypt {} old secret".format(
3190
client_name))
3191
client["secret"] = (client_settings[client_name]
3192
["secret"])
3193
3194
# Add/remove clients based on new changes made to config
3195
for client_name in (set(old_client_settings)
3196
- set(client_settings)):
3197
del clients_data[client_name]
3198
for client_name in (set(client_settings)
3199
- set(old_client_settings)):
3200
clients_data[client_name] = client_settings[client_name]
3201
3202
# Create all client objects
3203
for client_name, client in clients_data.items():
3204
tcp_server.clients[client_name] = client_class(
3205
name = client_name,
3206
settings = client,
3207
server_settings = server_settings)
3208
2049
3209
if not tcp_server.clients:
2050
3210
logger.warning("No clients defined")
2051
2052
if not debug:
2053
try:
2054
with pidfile:
2055
pid = os.getpid()
2056
pidfile.write(str(pid) + "\n".encode("utf-8"))
2057
del pidfile
2058
except IOError:
2059
logger.error("Could not write to file %r with PID %d",
2060
pidfilename, pid)
2061
except NameError:
2062
# "pidfile" was never created
2063
pass
3211
3212
if not foreground:
3213
if pidfile is not None:
3214
pid = os.getpid()
3215
try:
3216
with pidfile:
3217
print(pid, file=pidfile)
3218
except IOError:
3219
logger.error("Could not write to file %r with PID %d",
3220
pidfilename, pid)
3221
del pidfile
2064
3222
del pidfilename
3223
3224
for termsig in (signal.SIGHUP, signal.SIGTERM):
3225
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3226
lambda: main_loop.quit() and False)
3227
3228
if use_dbus:
2065
3229
2066
signal.signal(signal.SIGINT, signal.SIG_IGN)
2067
2068
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2069
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2070
2071
if use_dbus:
2072
class MandosDBusService(dbus.service.Object):
3230
@alternate_dbus_interfaces(
3231
{ "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
3232
class MandosDBusService(DBusObjectWithObjectManager):
2073
3233
"""A D-Bus proxy object"""
3234
2074
3235
def __init__(self):
2075
3236
dbus.service.Object.__init__(self, bus, "/")
3237
2076
3238
_interface = "se.recompile.Mandos"
2077
3239
2078
3240
@dbus.service.signal(_interface, signature="o")
2085
3247
"D-Bus signal"
2086
3248
pass
2087
3249
3250
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3251
"true"})
2088
3252
@dbus.service.signal(_interface, signature="os")
2089
3253
def ClientRemoved(self, objpath, name):
2090
3254
"D-Bus signal"
2091
3255
pass
2092
3256
3257
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3258
"true"})
2093
3259
@dbus.service.method(_interface, out_signature="ao")
2094
3260
def GetAllClients(self):
2095
3261
"D-Bus method"
2096
return dbus.Array(c.dbus_object_path
2097
for c in tcp_server.clients)
3262
return dbus.Array(c.dbus_object_path for c in
3263
tcp_server.clients.values())
2098
3264
3265
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3266
"true"})
2099
3267
@dbus.service.method(_interface,
2100
3268
out_signature="a{oa{sv}}")
2101
3269
def GetAllClientsWithProperties(self):
2102
3270
"D-Bus method"
2103
3271
return dbus.Dictionary(
2104
((c.dbus_object_path, c.GetAll(""))
2105
for c in tcp_server.clients),
3272
{ c.dbus_object_path: c.GetAll(
3273
"se.recompile.Mandos.Client")
3274
for c in tcp_server.clients.values() },
2106
3275
signature="oa{sv}")
2107
3276
2108
3277
@dbus.service.method(_interface, in_signature="o")
2109
3278
def RemoveClient(self, object_path):
2110
3279
"D-Bus method"
2111
for c in tcp_server.clients:
3280
for c in tcp_server.clients.values():
2112
3281
if c.dbus_object_path == object_path:
2113
tcp_server.clients.remove(c)
3282
del tcp_server.clients[c.name]
2114
3283
c.remove_from_connection()
2115
# Don't signal anything except ClientRemoved
3284
# Don't signal the disabling
2116
3285
c.disable(quiet=True)
2117
# Emit D-Bus signal
2118
self.ClientRemoved(object_path, c.name)
3286
# Emit D-Bus signal for removal
3287
self.client_removed_signal(c)
2119
3288
return
2120
3289
raise KeyError(object_path)
2121
3290
2122
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)
2123
3328
2124
class MandosDBusServiceTransitional(MandosDBusService):
2125
__metaclass__ = AlternateDBusNamesMetaclass
2126
mandos_dbus_service = MandosDBusServiceTransitional()
3329
mandos_dbus_service = MandosDBusService()
2127
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
2128
3335
def cleanup():
2129
3336
"Cleanup function; run on exit"
2130
service.cleanup()
2131
3337
if zeroconf:
3338
service.cleanup()
3339
3340
mp.active_children()
3341
wn.close()
3342
if not (tcp_server.clients or client_settings):
3343
return
3344
3345
# Store client before exiting. Secrets are encrypted with key
3346
# based on what config file has. If config file is
3347
# removed/edited, old secret will thus be unrecovable.
3348
clients = {}
3349
with PGPEngine() as pgp:
3350
for client in tcp_server.clients.values():
3351
key = client_settings[client.name]["secret"]
3352
client.encrypted_secret = pgp.encrypt(client.secret,
3353
key)
3354
client_dict = {}
3355
3356
# A list of attributes that can not be pickled
3357
# + secret.
3358
exclude = { "bus", "changedstate", "secret",
3359
"checker", "server_settings" }
3360
for name, typ in inspect.getmembers(dbus.service
3361
.Object):
3362
exclude.add(name)
3363
3364
client_dict["encrypted_secret"] = (client
3365
.encrypted_secret)
3366
for attr in client.client_structure:
3367
if attr not in exclude:
3368
client_dict[attr] = getattr(client, attr)
3369
3370
clients[client.name] = client_dict
3371
del client_settings[client.name]["secret"]
3372
3373
try:
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
3383
os.rename(tempname, stored_state_path)
3384
except (IOError, OSError) as e:
3385
if not debug:
3386
try:
3387
os.remove(tempname)
3388
except NameError:
3389
pass
3390
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3391
logger.warning("Could not save persistent state: {}"
3392
.format(os.strerror(e.errno)))
3393
else:
3394
logger.warning("Could not save persistent state:",
3395
exc_info=e)
3396
raise
3397
3398
# Delete all clients, and settings from config
2132
3399
while tcp_server.clients:
2133
client = tcp_server.clients.pop()
3400
name, client = tcp_server.clients.popitem()
2134
3401
if use_dbus:
2135
3402
client.remove_from_connection()
2136
client.disable_hook = None
2137
# Don't signal anything except ClientRemoved
3403
# Don't signal the disabling
2138
3404
client.disable(quiet=True)
3405
# Emit D-Bus signal for removal
2139
3406
if use_dbus:
2140
# Emit D-Bus signal
2141
mandos_dbus_service.ClientRemoved(client
2142
.dbus_object_path,
2143
client.name)
3407
mandos_dbus_service.client_removed_signal(client)
3408
client_settings.clear()
2144
3409
2145
3410
atexit.register(cleanup)
2146
3411
2147
for client in tcp_server.clients:
3412
for client in tcp_server.clients.values():
2148
3413
if use_dbus:
2149
# Emit D-Bus signal
2150
mandos_dbus_service.ClientAdded(client.dbus_object_path)
2151
client.enable()
3414
# Emit D-Bus signal for adding
3415
mandos_dbus_service.client_added_signal(client)
3416
# Need to initiate checking of clients
3417
if client.enabled:
3418
client.init_checker()
2152
3419
2153
3420
tcp_server.enable()
2154
3421
tcp_server.server_activate()
2155
3422
2156
3423
# Find out what port we got
2157
service.port = tcp_server.socket.getsockname()[1]
3424
if zeroconf:
3425
service.port = tcp_server.socket.getsockname()[1]
2158
3426
if use_ipv6:
2159
3427
logger.info("Now listening on address %r, port %d,"
2160
" flowinfo %d, scope_id %d"
2161
% tcp_server.socket.getsockname())
3428
" flowinfo %d, scope_id %d",
3429
*tcp_server.socket.getsockname())
2162
3430
else: # IPv4
2163
logger.info("Now listening on address %r, port %d"
2164
% tcp_server.socket.getsockname())
3431
logger.info("Now listening on address %r, port %d",
3432
*tcp_server.socket.getsockname())
2165
3433
2166
3434
#service.interface = tcp_server.socket.getsockname()[3]
2167
3435
2168
3436
try:
2169
# From the Avahi example code
2170
try:
2171
service.activate()
2172
except dbus.exceptions.DBusException as error:
2173
logger.critical("DBusException: %s", error)
2174
cleanup()
2175
sys.exit(1)
2176
# End of Avahi example code
3437
if zeroconf:
3438
# From the Avahi example code
3439
try:
3440
service.activate()
3441
except dbus.exceptions.DBusException as error:
3442
logger.critical("D-Bus Exception", exc_info=error)
3443
cleanup()
3444
sys.exit(1)
3445
# End of Avahi example code
2177
3446
2178
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2179
lambda *args, **kwargs:
2180
(tcp_server.handle_request
2181
(*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))
2182
3451
2183
3452
logger.debug("Starting main loop")
2184
3453
main_loop.run()
2185
3454
except AvahiError as error:
2186
logger.critical("AvahiError: %s", error)
3455
logger.critical("Avahi Error", exc_info=error)
2187
3456
cleanup()
2188
3457
sys.exit(1)
2189
3458
except KeyboardInterrupt:
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0