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