To get this branch, use:
bzr branch
http://bzr.recompile.se/loggerhead/mandos/trunk
« back to all changes in this revision
Viewing changes to mandos
- browse files at revision 24.1.157
- compare with another revision
- download diff
- download tarball
- view history from revision 24.1.157
- Committer: Björn Påhlsson
- Date: 2010-09-07 18:48:56 UTC
- mto: (237.4.3 mandos-release)
- mto: This revision was merged to the branch mainline in revision 421.
- Revision ID: belorn@fukt.bsnet.se-20100907184856-waz6cvxbm7ranha2
added the actually plugin file for plymouth
- files added:
- plugins.d/plymouth
- files removed:
- 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-2016 Teddy Hogeborn
15
# Copyright © 2008-2016 Björn Påhlsson
14
# Copyright © 2008,2009 Teddy Hogeborn
15
# Copyright © 2008,2009 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@recompile.se>.
31
# Contact the authors at <mandos@fukt.bsnet.se>.
32
32
#
33
33
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
34
from __future__ import division, with_statement, absolute_import
35
36
import SocketServer as socketserver
43
37
import socket
44
import argparse
38
import optparse
45
39
import datetime
46
40
import errno
47
try:
48
import ConfigParser as configparser
49
except ImportError:
50
import configparser
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
51
48
import sys
52
49
import re
53
50
import os
62
59
import struct
63
60
import fcntl
64
61
import functools
65
try:
66
import cPickle as pickle
67
except ImportError:
68
import pickle
62
import cPickle as pickle
69
63
import multiprocessing
70
import types
71
import binascii
72
import tempfile
73
import itertools
74
import collections
75
import codecs
76
64
77
65
import dbus
78
66
import dbus.service
79
try:
80
from gi.repository import GObject
81
except ImportError:
82
import gobject as GObject
67
import gobject
83
68
import avahi
84
69
from dbus.mainloop.glib import DBusGMainLoop
85
70
import ctypes
95
80
except ImportError:
96
81
SO_BINDTODEVICE = None
97
82
98
if sys.version_info.major == 2:
99
str = unicode
100
101
version = "1.7.4"
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
83
84
version = "1.0.14"
85
86
#logger = logging.getLogger(u'mandos')
87
logger = logging.Logger(u'mandos')
88
syslogger = (logging.handlers.SysLogHandler
89
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
90
address = "/dev/log"))
91
syslogger.setFormatter(logging.Formatter
92
(u'Mandos [%(process)d]: %(levelname)s:'
93
u' %(message)s'))
94
logger.addHandler(syslogger)
95
96
console = logging.StreamHandler()
97
console.setFormatter(logging.Formatter(u'%(name)s [%(process)d]:'
98
u' %(levelname)s:'
99
u' %(message)s'))
100
logger.addHandler(console)
241
101
242
102
class AvahiError(Exception):
243
103
def __init__(self, value, *args, **kwargs):
244
104
self.value = value
245
return super(AvahiError, self).__init__(value, *args,
246
**kwargs)
247
105
super(AvahiError, self).__init__(value, *args, **kwargs)
106
def __unicode__(self):
107
return unicode(repr(self.value))
248
108
249
109
class AvahiServiceError(AvahiError):
250
110
pass
251
111
252
253
112
class AvahiGroupError(AvahiError):
254
113
pass
255
114
260
119
Attributes:
261
120
interface: integer; avahi.IF_UNSPEC or an interface index.
262
121
Used to optionally bind to the specified interface.
263
name: string; Example: 'Mandos'
264
type: string; Example: '_mandos._tcp'.
265
See <https://www.iana.org/assignments/service-names-port-numbers>
122
name: string; Example: u'Mandos'
123
type: string; Example: u'_mandos._tcp'.
124
See <http://www.dns-sd.org/ServiceTypes.html>
266
125
port: integer; what port to announce
267
126
TXT: list of strings; TXT record for the service
268
127
domain: string; Domain to publish on, default to .local if empty.
274
133
server: D-Bus Server
275
134
bus: dbus.SystemBus()
276
135
"""
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):
136
def __init__(self, interface = avahi.IF_UNSPEC, name = None,
137
servicetype = None, port = None, TXT = None,
138
domain = u"", host = u"", max_renames = 32768,
139
protocol = avahi.PROTO_UNSPEC, bus = None):
289
140
self.interface = interface
290
141
self.name = name
291
142
self.type = servicetype
299
150
self.group = None # our entry group
300
151
self.server = None
301
152
self.bus = bus
302
self.entry_group_state_changed_match = None
303
304
def rename(self, remove=True):
153
def rename(self):
305
154
"""Derived from the Avahi example code"""
306
155
if self.rename_count >= self.max_renames:
307
logger.critical("No suitable Zeroconf service name found"
308
" after %i retries, exiting.",
156
logger.critical(u"No suitable Zeroconf service name found"
157
u" after %i retries, exiting.",
309
158
self.rename_count)
310
raise AvahiServiceError("Too many renames")
311
self.name = str(
312
self.server.GetAlternativeServiceName(self.name))
159
raise AvahiServiceError(u"Too many renames")
160
self.name = unicode(self.server.GetAlternativeServiceName(self.name))
161
logger.info(u"Changing Zeroconf service name to %r ...",
162
self.name)
163
syslogger.setFormatter(logging.Formatter
164
(u'Mandos (%s) [%%(process)d]:'
165
u' %%(levelname)s: %%(message)s'
166
% self.name))
167
self.remove()
168
self.add()
313
169
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
330
170
def remove(self):
331
171
"""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
335
172
if self.group is not None:
336
173
self.group.Reset()
337
338
174
def add(self):
339
175
"""Derived from the Avahi example code"""
340
self.remove()
341
176
if self.group is None:
342
177
self.group = dbus.Interface(
343
178
self.bus.get_object(avahi.DBUS_NAME,
344
179
self.server.EntryGroupNew()),
345
180
avahi.DBUS_INTERFACE_ENTRY_GROUP)
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' ...",
181
self.group.connect_to_signal('StateChanged',
182
self
183
.entry_group_state_changed)
184
logger.debug(u"Adding Zeroconf service '%s' of type '%s' ...",
350
185
self.name, self.type)
351
186
self.group.AddService(
352
187
self.interface,
357
192
dbus.UInt16(self.port),
358
193
avahi.string_array_to_txt_array(self.TXT))
359
194
self.group.Commit()
360
361
195
def entry_group_state_changed(self, state, error):
362
196
"""Derived from the Avahi example code"""
363
logger.debug("Avahi entry group state change: %i", state)
197
logger.debug(u"Avahi entry group state change: %i", state)
364
198
365
199
if state == avahi.ENTRY_GROUP_ESTABLISHED:
366
logger.debug("Zeroconf service established.")
200
logger.debug(u"Zeroconf service established.")
367
201
elif state == avahi.ENTRY_GROUP_COLLISION:
368
logger.info("Zeroconf service name collision.")
202
logger.warning(u"Zeroconf service name collision.")
369
203
self.rename()
370
204
elif state == avahi.ENTRY_GROUP_FAILURE:
371
logger.critical("Avahi: Error in group state changed %s",
372
str(error))
373
raise AvahiGroupError("State changed: {!s}".format(error))
374
205
logger.critical(u"Avahi: Error in group state changed %s",
206
unicode(error))
207
raise AvahiGroupError(u"State changed: %s"
208
% unicode(error))
375
209
def cleanup(self):
376
210
"""Derived from the Avahi example code"""
377
211
if self.group is not None:
378
try:
379
self.group.Free()
380
except (dbus.exceptions.UnknownMethodException,
381
dbus.exceptions.DBusException):
382
pass
212
self.group.Free()
383
213
self.group = None
384
self.remove()
385
386
def server_state_changed(self, state, error=None):
214
def server_state_changed(self, state):
387
215
"""Derived from the Avahi example code"""
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()
216
logger.debug(u"Avahi server state change: %i", state)
217
if state == avahi.SERVER_COLLISION:
218
logger.error(u"Zeroconf server name collision")
219
self.remove()
402
220
elif state == avahi.SERVER_RUNNING:
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
221
self.add()
421
222
def activate(self):
422
223
"""Derived from the Avahi example code"""
423
224
if self.server is None:
424
225
self.server = dbus.Interface(
425
226
self.bus.get_object(avahi.DBUS_NAME,
426
avahi.DBUS_PATH_SERVER,
427
follow_name_owner_changes=True),
227
avahi.DBUS_PATH_SERVER),
428
228
avahi.DBUS_INTERFACE_SERVER)
429
self.server.connect_to_signal("StateChanged",
430
self.server_state_changed)
229
self.server.connect_to_signal(u"StateChanged",
230
self.server_state_changed)
431
231
self.server_state_changed(self.server.GetState())
432
232
433
233
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
708
234
class Client(object):
709
235
"""A representation of a client host served by this server.
710
236
711
237
Attributes:
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
238
name: string; from the config file, used in log messages and
239
D-Bus identifiers
240
fingerprint: string (40 or 32 hexadecimal digits); used to
241
uniquely identify the client
242
secret: bytestring; sent verbatim (over TLS) to client
243
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()
247
last_checked_ok: datetime.datetime(); (UTC) or None
248
timeout: datetime.timedelta(); How long from last_checked_ok
249
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)
715
252
checker: subprocess.Popen(); a running checker process used
716
253
to see if the client lives.
717
254
'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
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
721
260
runtime with vars(self) as dict, so that for
722
261
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
262
current_checker_command: string; current running checker_command
728
disable_initiator_tag: a GObject event source tag, or None
729
enabled: bool()
730
fingerprint: string (40 or 32 hexadecimal digits); used to
731
uniquely identify the client
732
host: string; available for use by the checker command
733
interval: datetime.timedelta(); How often to start a new checker
734
last_approval_request: datetime.datetime(); (UTC) or None
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
745
timeout: datetime.timedelta(); How long from last_checked_ok
746
until this client is disabled
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()
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
752
266
"""
753
267
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
771
268
@staticmethod
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):
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."""
822
290
self.name = name
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)
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()
836
307
else:
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
308
raise TypeError(u"No secret or secfile for client %s"
309
% self.name)
310
self.host = config.get(u"host", u"")
311
self.created = datetime.datetime.utcnow()
312
self.enabled = False
313
self.last_enabled = None
314
self.last_checked_ok = None
315
self.timeout = string_to_delta(config[u"timeout"])
316
self.interval = string_to_delta(config[u"interval"])
317
self.disable_hook = disable_hook
846
318
self.checker = None
847
319
self.checker_initiator_tag = None
848
320
self.disable_initiator_tag = None
849
321
self.checker_callback_tag = None
322
self.checker_command = config[u"checker"]
850
323
self.current_checker_command = None
851
self.approved = None
324
self.last_connect = None
325
self._approved = None
326
self.approved_by_default = config.get(u"approved_by_default",
327
True)
852
328
self.approvals_pending = 0
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)
329
self.approved_delay = string_to_delta(
330
config[u"approved_delay"])
331
self.approved_duration = string_to_delta(
332
config[u"approved_duration"])
333
self.changedstate = multiprocessing_manager.Condition(multiprocessing_manager.Lock())
864
334
865
# Send notice to process children that client state has changed
866
335
def send_changedstate(self):
867
with self.changedstate:
868
self.changedstate.notify_all()
869
336
self.changedstate.acquire()
337
self.changedstate.notify_all()
338
self.changedstate.release()
339
870
340
def enable(self):
871
341
"""Start this client's checker and timeout hooks"""
872
if getattr(self, "enabled", False):
342
if getattr(self, u"enabled", False):
873
343
# Already enabled
874
344
return
875
self.expires = datetime.datetime.utcnow() + self.timeout
876
self.enabled = True
345
self.send_changedstate()
877
346
self.last_enabled = datetime.datetime.utcnow()
878
self.init_checker()
879
self.send_changedstate()
347
# Schedule a new checker to be started an 'interval' from now,
348
# and every interval from then on.
349
self.checker_initiator_tag = (gobject.timeout_add
350
(self.interval_milliseconds(),
351
self.start_checker))
352
# Schedule a disable() when 'timeout' has passed
353
self.disable_initiator_tag = (gobject.timeout_add
354
(self.timeout_milliseconds(),
355
self.disable))
356
self.enabled = True
357
# Also start a new checker *right now*.
358
self.start_checker()
880
359
881
360
def disable(self, quiet=True):
882
361
"""Disable this client."""
883
362
if not getattr(self, "enabled", False):
884
363
return False
885
364
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)
365
self.send_changedstate()
366
if not quiet:
367
logger.info(u"Disabling client %s", self.name)
368
if getattr(self, u"disable_initiator_tag", False):
369
gobject.source_remove(self.disable_initiator_tag)
889
370
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)
371
if getattr(self, u"checker_initiator_tag", False):
372
gobject.source_remove(self.checker_initiator_tag)
893
373
self.checker_initiator_tag = None
894
374
self.stop_checker()
375
if self.disable_hook:
376
self.disable_hook(self)
895
377
self.enabled = False
896
if not quiet:
897
self.send_changedstate()
898
# Do not run this again if called by a GObject.timeout_add
378
# Do not run this again if called by a gobject.timeout_add
899
379
return False
900
380
901
381
def __del__(self):
382
self.disable_hook = None
902
383
self.disable()
903
384
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):
385
def checker_callback(self, pid, condition, command):
922
386
"""The checker has completed, so take appropriate actions."""
923
387
self.checker_callback_tag = None
924
388
self.checker = None
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",
389
if os.WIFEXITED(condition):
390
exitstatus = os.WEXITSTATUS(condition)
391
if exitstatus == 0:
392
logger.info(u"Checker for %(name)s succeeded",
934
393
vars(self))
935
394
self.checked_ok()
936
395
else:
937
logger.info("Checker for %(name)s failed", vars(self))
396
logger.info(u"Checker for %(name)s failed",
397
vars(self))
938
398
else:
939
self.last_checker_status = -1
940
self.last_checker_signal = -returncode
941
logger.warning("Checker for %(name)s crashed?",
399
logger.warning(u"Checker for %(name)s crashed?",
942
400
vars(self))
943
return False
944
401
945
402
def checked_ok(self):
946
"""Assert that the client has been seen, alive and well."""
403
"""Bump up the timeout for this client.
404
405
This should only be called when the client has been seen,
406
alive and well.
407
"""
947
408
self.last_checked_ok = datetime.datetime.utcnow()
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()
409
gobject.source_remove(self.disable_initiator_tag)
410
self.disable_initiator_tag = (gobject.timeout_add
411
(self.timeout_milliseconds(),
412
self.disable))
966
413
967
414
def start_checker(self):
968
415
"""Start a new checker subprocess if one is not running.
970
417
If a checker already exists, leave it running and do
971
418
nothing."""
972
419
# The reason for not killing a running checker is that if we
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
420
# did that, then if a checker (for some reason) started
421
# running slowly and taking more than 'interval' time, the
422
# client would inevitably timeout, since no checker would get
423
# a chance to run to completion. If we instead leave running
977
424
# checkers alone, the checker would have to take more time
978
425
# than 'timeout' for the client to be disabled, which is as it
979
426
# should be.
980
427
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
428
# If a checker exists, make sure it is not a zombie
429
try:
430
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
431
except (AttributeError, OSError), error:
432
if (isinstance(error, OSError)
433
and error.errno != errno.ECHILD):
434
raise error
435
else:
436
if pid:
437
logger.warning(u"Checker was a zombie")
438
gobject.source_remove(self.checker_callback_tag)
439
self.checker_callback(pid, status,
440
self.current_checker_command)
985
441
# Start a new checker if needed
986
442
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 }
991
443
try:
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
444
# In case checker_command has exactly one % operator
445
command = self.checker_command % self.host
446
except TypeError:
447
# Escape attributes for the shell
448
escaped_attrs = dict((key,
449
re.escape(unicode(str(val),
450
errors=
451
u'replace')))
452
for key, val in
453
vars(self).iteritems())
454
try:
455
command = self.checker_command % escaped_attrs
456
except TypeError, error:
457
logger.error(u'Could not format string "%s":'
458
u' %s', self.checker_command, error)
459
return True # Try again later
998
460
self.current_checker_command = command
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)
1024
# Re-run this periodically if run by GObject.timeout_add
461
try:
462
logger.info(u"Starting checker %r for %s",
463
command, self.name)
464
# We don't need to redirect stdout and stderr, since
465
# in normal mode, that is already done by daemon(),
466
# and in debug mode we don't want to. (Stdin is
467
# always replaced by /dev/null.)
468
self.checker = subprocess.Popen(command,
469
close_fds=True,
470
shell=True, cwd=u"/")
471
self.checker_callback_tag = (gobject.child_watch_add
472
(self.checker.pid,
473
self.checker_callback,
474
data=command))
475
# The checker may have completed before the gobject
476
# watch was added. Check for this.
477
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
478
if pid:
479
gobject.source_remove(self.checker_callback_tag)
480
self.checker_callback(pid, status, command)
481
except OSError, error:
482
logger.error(u"Failed to start subprocess: %s",
483
error)
484
# Re-run this periodically if run by gobject.timeout_add
1025
485
return True
1026
486
1027
487
def stop_checker(self):
1028
488
"""Force the checker process, if any, to stop."""
1029
489
if self.checker_callback_tag:
1030
GObject.source_remove(self.checker_callback_tag)
490
gobject.source_remove(self.checker_callback_tag)
1031
491
self.checker_callback_tag = None
1032
if getattr(self, "checker", None) is None:
492
if getattr(self, u"checker", None) is None:
1033
493
return
1034
logger.debug("Stopping checker for %(name)s", vars(self))
1035
self.checker.terminate()
494
logger.debug(u"Stopping checker for %(name)s", vars(self))
495
try:
496
os.kill(self.checker.pid, signal.SIGTERM)
497
#time.sleep(0.5)
498
#if self.checker.poll() is None:
499
# os.kill(self.checker.pid, signal.SIGKILL)
500
except OSError, error:
501
if error.errno != errno.ESRCH: # No such process
502
raise
1036
503
self.checker = None
1037
504
1038
1039
def dbus_service_property(dbus_interface,
1040
signature="v",
1041
access="readwrite",
1042
byte_arrays=False):
505
def dbus_service_property(dbus_interface, signature=u"v",
506
access=u"readwrite", byte_arrays=False):
1043
507
"""Decorators for marking methods of a DBusObjectWithProperties to
1044
508
become properties on the D-Bus.
1045
509
1052
516
"""
1053
517
# Encoding deeply encoded byte arrays is not supported yet by the
1054
518
# "Set" method, so we fail early here:
1055
if byte_arrays and signature != "ay":
1056
raise ValueError("Byte arrays not supported for non-'ay'"
1057
" signature {!r}".format(signature))
1058
519
if byte_arrays and signature != u"ay":
520
raise ValueError(u"Byte arrays not supported for non-'ay'"
521
u" signature %r" % signature)
1059
522
def decorator(func):
1060
523
func._dbus_is_property = True
1061
524
func._dbus_interface = dbus_interface
1062
525
func._dbus_signature = signature
1063
526
func._dbus_access = access
1064
527
func._dbus_name = func.__name__
1065
if func._dbus_name.endswith("_dbus_property"):
528
if func._dbus_name.endswith(u"_dbus_property"):
1066
529
func._dbus_name = func._dbus_name[:-14]
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
530
func._dbus_get_args_options = {u'byte_arrays': byte_arrays }
531
return func
1113
532
return decorator
1114
533
1115
534
1116
535
class DBusPropertyException(dbus.exceptions.DBusException):
1117
536
"""A base class for D-Bus property-related exceptions
1118
537
"""
1119
pass
538
def __unicode__(self):
539
return unicode(str(self))
1120
540
1121
541
1122
542
class DBusPropertyAccessException(DBusPropertyException):
1131
551
pass
1132
552
1133
553
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):
554
class DBusObjectWithProperties(dbus.service.Object):
1224
555
"""A D-Bus object with properties.
1225
556
1226
557
Classes inheriting from this can use the dbus_service_property
1227
558
decorator to expose methods as D-Bus properties. It exposes the
1228
559
standard Get(), Set(), and GetAll() methods on the D-Bus.
1229
560
"""
1230
561
562
@staticmethod
563
def _is_dbus_property(obj):
564
return getattr(obj, u"_dbus_is_property", False)
565
566
def _get_all_dbus_properties(self):
567
"""Returns a generator of (name, attribute) pairs
568
"""
569
return ((prop._dbus_name, prop)
570
for name, prop in
571
inspect.getmembers(self, self._is_dbus_property))
572
1231
573
def _get_dbus_property(self, interface_name, property_name):
1232
574
"""Returns a bound method if one exists which is a D-Bus
1233
575
property with the specified name and interface.
1234
576
"""
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
577
for name in (property_name,
578
property_name + u"_dbus_property"):
579
prop = getattr(self, name, None)
580
if (prop is None
581
or not self._is_dbus_property(prop)
582
or prop._dbus_name != property_name
583
or (interface_name and prop._dbus_interface
584
and interface_name != prop._dbus_interface)):
585
continue
586
return prop
1242
587
# No such property
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")
588
raise DBusPropertyNotFound(self.dbus_object_path + u":"
589
+ interface_name + u"."
590
+ property_name)
591
592
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ss",
593
out_signature=u"v")
1258
594
def Get(self, interface_name, property_name):
1259
595
"""Standard D-Bus property Get() method, see D-Bus standard.
1260
596
"""
1261
597
prop = self._get_dbus_property(interface_name, property_name)
1262
if prop._dbus_access == "write":
598
if prop._dbus_access == u"write":
1263
599
raise DBusPropertyAccessException(property_name)
1264
600
value = prop()
1265
if not hasattr(value, "variant_level"):
601
if not hasattr(value, u"variant_level"):
1266
602
return value
1267
603
return type(value)(value, variant_level=value.variant_level+1)
1268
604
1269
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
605
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ssv")
1270
606
def Set(self, interface_name, property_name, value):
1271
607
"""Standard D-Bus property Set() method, see D-Bus standard.
1272
608
"""
1273
609
prop = self._get_dbus_property(interface_name, property_name)
1274
if prop._dbus_access == "read":
610
if prop._dbus_access == u"read":
1275
611
raise DBusPropertyAccessException(property_name)
1276
if prop._dbus_get_args_options["byte_arrays"]:
612
if prop._dbus_get_args_options[u"byte_arrays"]:
1277
613
# The byte_arrays option is not supported yet on
1278
614
# signatures other than "ay".
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))
615
if prop._dbus_signature != u"ay":
616
raise ValueError
617
value = dbus.ByteArray(''.join(unichr(byte)
618
for byte in value))
1285
619
prop(value)
1286
620
1287
@dbus.service.method(dbus.PROPERTIES_IFACE,
1288
in_signature="s",
1289
out_signature="a{sv}")
621
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"s",
622
out_signature=u"a{sv}")
1290
623
def GetAll(self, interface_name):
1291
624
"""Standard D-Bus property GetAll() method, see D-Bus
1292
625
standard.
1293
626
1294
627
Note: Will not include properties with access="write".
1295
628
"""
1296
properties = {}
1297
for name, prop in self._get_all_dbus_things("property"):
629
all = {}
630
for name, prop in self._get_all_dbus_properties():
1298
631
if (interface_name
1299
632
and interface_name != prop._dbus_interface):
1300
633
# Interface non-empty but did not match
1301
634
continue
1302
635
# Ignore write-only properties
1303
if prop._dbus_access == "write":
636
if prop._dbus_access == u"write":
1304
637
continue
1305
638
value = prop()
1306
if not hasattr(value, "variant_level"):
1307
properties[name] = value
639
if not hasattr(value, u"variant_level"):
640
all[name] = value
1308
641
continue
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
642
all[name] = type(value)(value, variant_level=
643
value.variant_level+1)
644
return dbus.Dictionary(all, signature=u"sv")
1320
645
1321
646
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1322
out_signature="s",
647
out_signature=u"s",
1323
648
path_keyword='object_path',
1324
649
connection_keyword='connection')
1325
650
def Introspect(self, object_path, connection):
1326
"""Overloading of standard D-Bus method.
1327
1328
Inserts property tags and interface annotation tags.
651
"""Standard D-Bus method, overloaded to insert property tags.
1329
652
"""
1330
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1331
object_path,
1332
connection)
653
xmlstring = dbus.service.Object.Introspect(self, object_path,
654
connection)
1333
655
try:
1334
656
document = xml.dom.minidom.parseString(xmlstring)
1335
1336
657
def make_tag(document, name, prop):
1337
e = document.createElement("property")
1338
e.setAttribute("name", name)
1339
e.setAttribute("type", prop._dbus_signature)
1340
e.setAttribute("access", prop._dbus_access)
658
e = document.createElement(u"property")
659
e.setAttribute(u"name", name)
660
e.setAttribute(u"type", prop._dbus_signature)
661
e.setAttribute(u"access", prop._dbus_access)
1341
662
return e
1342
1343
for if_tag in document.getElementsByTagName("interface"):
1344
# Add property tags
663
for if_tag in document.getElementsByTagName(u"interface"):
1345
664
for tag in (make_tag(document, name, prop)
1346
665
for name, prop
1347
in self._get_all_dbus_things("property")
666
in self._get_all_dbus_properties()
1348
667
if prop._dbus_interface
1349
== if_tag.getAttribute("name")):
668
== if_tag.getAttribute(u"name")):
1350
669
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)
1367
670
# Add the names to the return values for the
1368
671
# "org.freedesktop.DBus.Properties" methods
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"})
672
if (if_tag.getAttribute(u"name")
673
== u"org.freedesktop.DBus.Properties"):
674
for cn in if_tag.getElementsByTagName(u"method"):
675
if cn.getAttribute(u"name") == u"Get":
676
for arg in cn.getElementsByTagName(u"arg"):
677
if (arg.getAttribute(u"direction")
678
== u"out"):
679
arg.setAttribute(u"name", u"value")
680
elif cn.getAttribute(u"name") == u"GetAll":
681
for arg in cn.getElementsByTagName(u"arg"):
682
if (arg.getAttribute(u"direction")
683
== u"out"):
684
arg.setAttribute(u"name", u"props")
685
xmlstring = document.toxml(u"utf-8")
686
document.unlink()
687
except (AttributeError, xml.dom.DOMException,
688
xml.parsers.expat.ExpatError), error:
689
logger.error(u"Failed to override Introspection method",
690
error)
691
return xmlstring
692
693
1654
694
class ClientDBus(Client, DBusObjectWithProperties):
1655
695
"""A Client class using D-Bus
1656
696
1658
698
dbus_object_path: dbus.ObjectPath
1659
699
bus: dbus.SystemBus()
1660
700
"""
1661
1662
runtime_expansions = (Client.runtime_expansions
1663
+ ("dbus_object_path", ))
1664
1665
_interface = "se.recompile.Mandos.Client"
1666
1667
701
# dbus.service.Object doesn't use super(), so we can't either.
1668
702
1669
703
def __init__(self, bus = None, *args, **kwargs):
704
self._approvals_pending = 0
1670
705
self.bus = bus
1671
706
Client.__init__(self, *args, **kwargs)
1672
707
# Only now, when this client is initialized, can it show up on
1673
708
# the D-Bus
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)
709
self.dbus_object_path = (dbus.ObjectPath
710
(u"/clients/"
711
+ self.name.replace(u".", u"_")))
1679
712
DBusObjectWithProperties.__init__(self, self.bus,
1680
713
self.dbus_object_path)
1681
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
714
715
def _get_approvals_pending(self):
716
return self._approvals_pending
717
def _set_approvals_pending(self, value):
718
old_value = self._approvals_pending
719
self._approvals_pending = value
720
bval = bool(value)
721
if (hasattr(self, "dbus_object_path")
722
and bval is not bool(old_value)):
723
dbus_bool = dbus.Boolean(bval, variant_level=1)
724
self.PropertyChanged(dbus.String(u"approved_pending"),
725
dbus_bool)
726
727
approvals_pending = property(_get_approvals_pending,
728
_set_approvals_pending)
729
del _get_approvals_pending, _set_approvals_pending
730
731
@staticmethod
732
def _datetime_to_dbus(dt, variant_level=0):
733
"""Convert a UTC datetime.datetime() to a D-Bus type."""
734
return dbus.String(dt.isoformat(),
735
variant_level=variant_level)
736
737
def enable(self):
738
oldstate = getattr(self, u"enabled", False)
739
r = Client.enable(self)
740
if oldstate != self.enabled:
741
# Emit D-Bus signals
742
self.PropertyChanged(dbus.String(u"enabled"),
743
dbus.Boolean(True, variant_level=1))
744
self.PropertyChanged(
745
dbus.String(u"last_enabled"),
746
self._datetime_to_dbus(self.last_enabled,
747
variant_level=1))
748
return r
749
750
def disable(self, quiet = False):
751
oldstate = getattr(self, u"enabled", False)
752
r = Client.disable(self, quiet=quiet)
753
if not quiet and oldstate != self.enabled:
754
# Emit D-Bus signal
755
self.PropertyChanged(dbus.String(u"enabled"),
756
dbus.Boolean(False, variant_level=1))
757
return r
1762
758
1763
759
def __del__(self, *args, **kwargs):
1764
760
try:
1765
761
self.remove_from_connection()
1766
762
except LookupError:
1767
763
pass
1768
if hasattr(DBusObjectWithProperties, "__del__"):
764
if hasattr(DBusObjectWithProperties, u"__del__"):
1769
765
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1770
766
Client.__del__(self, *args, **kwargs)
1771
767
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:
768
def checker_callback(self, pid, condition, command,
769
*args, **kwargs):
770
self.checker_callback_tag = None
771
self.checker = None
772
# Emit D-Bus signal
773
self.PropertyChanged(dbus.String(u"checker_running"),
774
dbus.Boolean(False, variant_level=1))
775
if os.WIFEXITED(condition):
776
exitstatus = os.WEXITSTATUS(condition)
1779
777
# Emit D-Bus signal
1780
778
self.CheckerCompleted(dbus.Int16(exitstatus),
1781
# This is specific to GNU libC
1782
dbus.Int64(exitstatus << 8),
779
dbus.Int64(condition),
1783
780
dbus.String(command))
1784
781
else:
1785
782
# Emit D-Bus signal
1786
783
self.CheckerCompleted(dbus.Int16(-1),
1787
dbus.Int64(
1788
# This is specific to GNU libC
1789
(exitstatus << 8)
1790
| self.last_checker_signal),
784
dbus.Int64(condition),
1791
785
dbus.String(command))
1792
return ret
786
787
return Client.checker_callback(self, pid, condition, command,
788
*args, **kwargs)
789
790
def checked_ok(self, *args, **kwargs):
791
r = Client.checked_ok(self, *args, **kwargs)
792
# Emit D-Bus signal
793
self.PropertyChanged(
794
dbus.String(u"last_checked_ok"),
795
(self._datetime_to_dbus(self.last_checked_ok,
796
variant_level=1)))
797
return r
1793
798
1794
799
def start_checker(self, *args, **kwargs):
1795
old_checker_pid = getattr(self.checker, "pid", None)
800
old_checker = self.checker
801
if self.checker is not None:
802
old_checker_pid = self.checker.pid
803
else:
804
old_checker_pid = None
1796
805
r = Client.start_checker(self, *args, **kwargs)
1797
806
# Only if new checker process was started
1798
807
if (self.checker is not None
1799
808
and old_checker_pid != self.checker.pid):
1800
809
# Emit D-Bus signal
1801
810
self.CheckerStarted(self.current_checker_command)
811
self.PropertyChanged(
812
dbus.String(u"checker_running"),
813
dbus.Boolean(True, variant_level=1))
1802
814
return r
1803
815
816
def stop_checker(self, *args, **kwargs):
817
old_checker = getattr(self, u"checker", None)
818
r = Client.stop_checker(self, *args, **kwargs)
819
if (old_checker is not None
820
and getattr(self, u"checker", None) is None):
821
self.PropertyChanged(dbus.String(u"checker_running"),
822
dbus.Boolean(False, variant_level=1))
823
return r
824
1804
825
def _reset_approved(self):
1805
self.approved = None
826
self._approved = None
1806
827
return False
1807
828
1808
829
def approve(self, value=True):
1809
self.approved = value
1810
GObject.timeout_add(int(self.approval_duration.total_seconds()
1811
* 1000), self._reset_approved)
1812
830
self.send_changedstate()
831
self._approved = value
832
gobject.timeout_add(self._timedelta_to_milliseconds(self.approved_duration),
833
self._reset_approved)
834
1813
835
1814
836
## D-Bus methods, signals & properties
1815
1816
## Interfaces
837
_interface = u"se.bsnet.fukt.Mandos.Client"
1817
838
1818
839
## Signals
1819
840
1820
841
# CheckerCompleted - signal
1821
@dbus.service.signal(_interface, signature="nxs")
842
@dbus.service.signal(_interface, signature=u"nxs")
1822
843
def CheckerCompleted(self, exitcode, waitstatus, command):
1823
844
"D-Bus signal"
1824
845
pass
1825
846
1826
847
# CheckerStarted - signal
1827
@dbus.service.signal(_interface, signature="s")
848
@dbus.service.signal(_interface, signature=u"s")
1828
849
def CheckerStarted(self, command):
1829
850
"D-Bus signal"
1830
851
pass
1831
852
1832
853
# PropertyChanged - signal
1833
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1834
@dbus.service.signal(_interface, signature="sv")
854
@dbus.service.signal(_interface, signature=u"sv")
1835
855
def PropertyChanged(self, property, value):
1836
856
"D-Bus signal"
1837
857
pass
1846
866
pass
1847
867
1848
868
# Rejected - signal
1849
@dbus.service.signal(_interface, signature="s")
869
@dbus.service.signal(_interface, signature=u"s")
1850
870
def Rejected(self, reason):
1851
871
"D-Bus signal"
1852
872
pass
1853
873
1854
874
# NeedApproval - signal
1855
@dbus.service.signal(_interface, signature="tb")
875
@dbus.service.signal(_interface, signature=u"db")
1856
876
def NeedApproval(self, timeout, default):
1857
877
"D-Bus signal"
1858
return self.need_approval()
878
pass
1859
879
1860
880
## Methods
1861
881
1862
882
# Approve - method
1863
@dbus.service.method(_interface, in_signature="b")
883
@dbus.service.method(_interface, in_signature=u"b")
1864
884
def Approve(self, value):
1865
885
self.approve(value)
1866
886
1867
887
# CheckedOK - method
1868
888
@dbus.service.method(_interface)
1869
889
def CheckedOK(self):
1870
self.checked_ok()
890
return self.checked_ok()
1871
891
1872
892
# Enable - method
1873
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1874
893
@dbus.service.method(_interface)
1875
894
def Enable(self):
1876
895
"D-Bus method"
1877
896
self.enable()
1878
897
1879
898
# StartChecker - method
1880
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1881
899
@dbus.service.method(_interface)
1882
900
def StartChecker(self):
1883
901
"D-Bus method"
1884
902
self.start_checker()
1885
903
1886
904
# Disable - method
1887
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1888
905
@dbus.service.method(_interface)
1889
906
def Disable(self):
1890
907
"D-Bus method"
1891
908
self.disable()
1892
909
1893
910
# StopChecker - method
1894
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1895
911
@dbus.service.method(_interface)
1896
912
def StopChecker(self):
1897
913
self.stop_checker()
1898
914
1899
915
## Properties
1900
916
1901
# ApprovalPending - property
1902
@dbus_service_property(_interface, signature="b", access="read")
1903
def ApprovalPending_dbus_property(self):
917
# approved_pending - property
918
@dbus_service_property(_interface, signature=u"b", access=u"read")
919
def approved_pending_dbus_property(self):
1904
920
return dbus.Boolean(bool(self.approvals_pending))
1905
921
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):
922
# approved_by_default - property
923
@dbus_service_property(_interface, signature=u"b",
924
access=u"readwrite")
925
def approved_by_default_dbus_property(self):
926
return dbus.Boolean(self.approved_by_default)
927
928
# approved_delay - property
929
@dbus_service_property(_interface, signature=u"t",
930
access=u"readwrite")
931
def approved_delay_dbus_property(self):
932
return dbus.UInt64(self.approved_delay_milliseconds())
933
934
# approved_duration - property
935
@dbus_service_property(_interface, signature=u"t",
936
access=u"readwrite")
937
def approved_duration_dbus_property(self):
938
return dbus.UInt64(self._timedelta_to_milliseconds(
939
self.approved_duration))
940
941
# name - property
942
@dbus_service_property(_interface, signature=u"s", access=u"read")
943
def name_dbus_property(self):
1940
944
return dbus.String(self.name)
1941
945
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):
946
# fingerprint - property
947
@dbus_service_property(_interface, signature=u"s", access=u"read")
948
def fingerprint_dbus_property(self):
1947
949
return dbus.String(self.fingerprint)
1948
950
1949
# Host - property
1950
@dbus_service_property(_interface,
1951
signature="s",
1952
access="readwrite")
1953
def Host_dbus_property(self, value=None):
951
# host - property
952
@dbus_service_property(_interface, signature=u"s",
953
access=u"readwrite")
954
def host_dbus_property(self, value=None):
1954
955
if value is None: # get
1955
956
return dbus.String(self.host)
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):
957
self.host = value
958
# Emit D-Bus signal
959
self.PropertyChanged(dbus.String(u"host"),
960
dbus.String(value, variant_level=1))
961
962
# created - property
963
@dbus_service_property(_interface, signature=u"s", access=u"read")
964
def created_dbus_property(self):
965
return dbus.String(self._datetime_to_dbus(self.created))
966
967
# last_enabled - property
968
@dbus_service_property(_interface, signature=u"s", access=u"read")
969
def last_enabled_dbus_property(self):
970
if self.last_enabled is None:
971
return dbus.String(u"")
972
return dbus.String(self._datetime_to_dbus(self.last_enabled))
973
974
# enabled - property
975
@dbus_service_property(_interface, signature=u"b",
976
access=u"readwrite")
977
def enabled_dbus_property(self, value=None):
1975
978
if value is None: # get
1976
979
return dbus.Boolean(self.enabled)
1977
980
if value:
1979
982
else:
1980
983
self.disable()
1981
984
1982
# LastCheckedOK - property
1983
@dbus_service_property(_interface,
1984
signature="s",
1985
access="readwrite")
1986
def LastCheckedOK_dbus_property(self, value=None):
985
# last_checked_ok - property
986
@dbus_service_property(_interface, signature=u"s",
987
access=u"readwrite")
988
def last_checked_ok_dbus_property(self, value=None):
1987
989
if value is not None:
1988
990
self.checked_ok()
1989
991
return
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):
992
if self.last_checked_ok is None:
993
return dbus.String(u"")
994
return dbus.String(self._datetime_to_dbus(self
995
.last_checked_ok))
996
997
# timeout - property
998
@dbus_service_property(_interface, signature=u"t",
999
access=u"readwrite")
1000
def timeout_dbus_property(self, value=None):
2012
1001
if value is None: # get
2013
return dbus.UInt64(self.timeout.total_seconds() * 1000)
2014
old_timeout = self.timeout
1002
return dbus.UInt64(self.timeout_milliseconds())
2015
1003
self.timeout = datetime.timedelta(0, 0, 0, value)
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)
1004
# Emit D-Bus signal
1005
self.PropertyChanged(dbus.String(u"timeout"),
1006
dbus.UInt64(value, variant_level=1))
1007
if getattr(self, u"disable_initiator_tag", None) is None:
1008
return
1009
# Reschedule timeout
1010
gobject.source_remove(self.disable_initiator_tag)
1011
self.disable_initiator_tag = None
1012
time_to_die = (self.
1013
_timedelta_to_milliseconds((self
1014
.last_checked_ok
1015
+ self.timeout)
1016
- datetime.datetime
1017
.utcnow()))
1018
if time_to_die <= 0:
1019
# The timeout has passed
1020
self.disable()
1021
else:
1022
self.disable_initiator_tag = (gobject.timeout_add
1023
(time_to_die, self.disable))
1024
1025
# interval - property
1026
@dbus_service_property(_interface, signature=u"t",
1027
access=u"readwrite")
1028
def interval_dbus_property(self, value=None):
1029
if value is None: # get
1030
return dbus.UInt64(self.interval_milliseconds())
2049
1031
self.interval = datetime.timedelta(0, 0, 0, value)
2050
if getattr(self, "checker_initiator_tag", None) is None:
1032
# Emit D-Bus signal
1033
self.PropertyChanged(dbus.String(u"interval"),
1034
dbus.UInt64(value, variant_level=1))
1035
if getattr(self, u"checker_initiator_tag", None) is None:
2051
1036
return
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):
1037
# Reschedule checker run
1038
gobject.source_remove(self.checker_initiator_tag)
1039
self.checker_initiator_tag = (gobject.timeout_add
1040
(value, self.start_checker))
1041
self.start_checker() # Start one now, too
1042
1043
# checker - property
1044
@dbus_service_property(_interface, signature=u"s",
1045
access=u"readwrite")
1046
def checker_dbus_property(self, value=None):
2064
1047
if value is None: # get
2065
1048
return dbus.String(self.checker_command)
2066
self.checker_command = str(value)
1049
self.checker_command = value
1050
# Emit D-Bus signal
1051
self.PropertyChanged(dbus.String(u"checker"),
1052
dbus.String(self.checker_command,
1053
variant_level=1))
2067
1054
2068
# CheckerRunning - property
2069
@dbus_service_property(_interface,
2070
signature="b",
2071
access="readwrite")
2072
def CheckerRunning_dbus_property(self, value=None):
1055
# checker_running - property
1056
@dbus_service_property(_interface, signature=u"b",
1057
access=u"readwrite")
1058
def checker_running_dbus_property(self, value=None):
2073
1059
if value is None: # get
2074
1060
return dbus.Boolean(self.checker is not None)
2075
1061
if value:
2077
1063
else:
2078
1064
self.stop_checker()
2079
1065
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):
1066
# object_path - property
1067
@dbus_service_property(_interface, signature=u"o", access=u"read")
1068
def object_path_dbus_property(self):
2086
1069
return self.dbus_object_path # is already a dbus.ObjectPath
2087
1070
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)
1071
# secret = property
1072
@dbus_service_property(_interface, signature=u"ay",
1073
access=u"write", byte_arrays=True)
1074
def secret_dbus_property(self, value):
1075
self.secret = str(value)
2098
1076
2099
1077
del _interface
2100
1078
2104
1082
self._pipe = child_pipe
2105
1083
self._pipe.send(('init', fpr, address))
2106
1084
if not self._pipe.recv():
2107
raise KeyError(fpr)
2108
1085
raise KeyError()
1086
2109
1087
def __getattribute__(self, name):
2110
if name == '_pipe':
1088
if(name == '_pipe'):
2111
1089
return super(ProxyClient, self).__getattribute__(name)
2112
1090
self._pipe.send(('getattr', name))
2113
1091
data = self._pipe.recv()
2114
1092
if data[0] == 'data':
2115
1093
return data[1]
2116
1094
if data[0] == 'function':
2117
2118
1095
def func(*args, **kwargs):
2119
1096
self._pipe.send(('funcall', name, args, kwargs))
2120
1097
return self._pipe.recv()[1]
2121
2122
1098
return func
2123
1099
2124
1100
def __setattr__(self, name, value):
2125
if name == '_pipe':
1101
if(name == '_pipe'):
2126
1102
return super(ProxyClient, self).__setattr__(name, value)
2127
1103
self._pipe.send(('setattr', name, value))
2128
1104
2135
1111
2136
1112
def handle(self):
2137
1113
with contextlib.closing(self.server.child_pipe) as child_pipe:
2138
logger.info("TCP connection from: %s",
2139
str(self.client_address))
2140
logger.debug("Pipe FD: %d",
1114
logger.info(u"TCP connection from: %s",
1115
unicode(self.client_address))
1116
logger.debug(u"Pipe FD: %d",
2141
1117
self.server.child_pipe.fileno())
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"))
1118
1119
session = (gnutls.connection
1120
.ClientSession(self.request,
1121
gnutls.connection
1122
.X509Credentials()))
1123
1124
# Note: gnutls.connection.X509Credentials is really a
1125
# generic GnuTLS certificate credentials object so long as
1126
# no X.509 keys are added to it. Therefore, we can use it
1127
# here despite using OpenPGP certificates.
1128
1129
#priority = u':'.join((u"NONE", u"+VERS-TLS1.1",
1130
# u"+AES-256-CBC", u"+SHA1",
1131
# u"+COMP-NULL", u"+CTYPE-OPENPGP",
1132
# u"+DHE-DSS"))
2149
1133
# Use a fallback default, since this MUST be set.
2150
1134
priority = self.server.gnutls_priority
2151
1135
if priority is None:
2152
priority = "NORMAL"
2153
gnutls.priority_set_direct(session._c_object, priority,
2154
None)
2155
1136
priority = u"NORMAL"
1137
(gnutls.library.functions
1138
.gnutls_priority_set_direct(session._c_object,
1139
priority, None))
1140
2156
1141
# Start communication using the Mandos protocol
2157
1142
# Get protocol number
2158
1143
line = self.request.makefile().readline()
2159
logger.debug("Protocol version: %r", line)
1144
logger.debug(u"Protocol version: %r", line)
2160
1145
try:
2161
1146
if int(line.strip().split()[0]) > 1:
2162
raise RuntimeError(line)
2163
except (ValueError, IndexError, RuntimeError) as error:
2164
logger.error("Unknown protocol version: %s", error)
1147
raise RuntimeError
1148
except (ValueError, IndexError, RuntimeError), error:
1149
logger.error(u"Unknown protocol version: %s", error)
2165
1150
return
2166
1151
2167
1152
# Start GnuTLS connection
2168
1153
try:
2169
1154
session.handshake()
2170
except gnutls.Error as error:
2171
logger.warning("Handshake failed: %s", error)
1155
except gnutls.errors.GNUTLSError, error:
1156
logger.warning(u"Handshake failed: %s", error)
2172
1157
# Do not run session.bye() here: the session is not
2173
1158
# established. Just abandon the request.
2174
1159
return
2175
logger.debug("Handshake succeeded")
2176
1160
logger.debug(u"Handshake succeeded")
1161
2177
1162
approval_required = False
2178
1163
try:
2179
1164
try:
2180
fpr = self.fingerprint(
2181
self.peer_certificate(session))
2182
except (TypeError, gnutls.Error) as error:
2183
logger.warning("Bad certificate: %s", error)
1165
fpr = self.fingerprint(self.peer_certificate
1166
(session))
1167
except (TypeError, gnutls.errors.GNUTLSError), error:
1168
logger.warning(u"Bad certificate: %s", error)
2184
1169
return
2185
logger.debug("Fingerprint: %s", fpr)
2186
1170
logger.debug(u"Fingerprint: %s", fpr)
1171
2187
1172
try:
2188
1173
client = ProxyClient(child_pipe, fpr,
2189
1174
self.client_address)
2190
1175
except KeyError:
2191
1176
return
2192
1177
2193
if client.approval_delay:
2194
delay = client.approval_delay
1178
if client.approved_delay:
1179
delay = client.approved_delay
2195
1180
client.approvals_pending += 1
2196
1181
approval_required = True
2197
1182
2198
1183
while True:
2199
1184
if not client.enabled:
2200
logger.info("Client %s is disabled",
2201
client.name)
1185
logger.warning(u"Client %s is disabled",
1186
client.name)
2202
1187
if self.server.use_dbus:
2203
1188
# Emit D-Bus signal
2204
client.Rejected("Disabled")
1189
client.Rejected("Disabled")
2205
1190
return
2206
1191
2207
if client.approved or not client.approval_delay:
1192
if client._approved or not client.approved_delay:
2208
1193
#We are approved or approval is disabled
2209
1194
break
2210
elif client.approved is None:
2211
logger.info("Client %s needs approval",
1195
elif client._approved is None:
1196
logger.info(u"Client %s need approval",
2212
1197
client.name)
2213
1198
if self.server.use_dbus:
2214
1199
# Emit D-Bus signal
2215
1200
client.NeedApproval(
2216
client.approval_delay.total_seconds()
2217
* 1000, client.approved_by_default)
1201
client.approved_delay_milliseconds(),
1202
client.approved_by_default)
2218
1203
else:
2219
logger.warning("Client %s was not approved",
1204
logger.warning(u"Client %s was not approved",
2220
1205
client.name)
2221
1206
if self.server.use_dbus:
2222
1207
# Emit D-Bus signal
2223
client.Rejected("Denied")
1208
client.Rejected("Disapproved")
2224
1209
return
2225
1210
2226
1211
#wait until timeout or approved
1212
#x = float(client._timedelta_to_milliseconds(delay))
2227
1213
time = datetime.datetime.now()
2228
1214
client.changedstate.acquire()
2229
client.changedstate.wait(delay.total_seconds())
1215
client.changedstate.wait(float(client._timedelta_to_milliseconds(delay) / 1000))
2230
1216
client.changedstate.release()
2231
1217
time2 = datetime.datetime.now()
2232
1218
if (time2 - time) >= delay:
2236
1222
client.name)
2237
1223
if self.server.use_dbus:
2238
1224
# Emit D-Bus signal
2239
client.Rejected("Approval timed out")
1225
client.Rejected("Time out")
2240
1226
return
2241
1227
else:
2242
1228
break
2243
1229
else:
2244
1230
delay -= time2 - time
2245
1231
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)
1232
sent_size = 0
1233
while sent_size < len(client.secret):
1234
try:
1235
sent = session.send(client.secret[sent_size:])
1236
except (gnutls.errors.GNUTLSError), error:
1237
logger.warning("gnutls send failed")
1238
return
1239
logger.debug(u"Sent: %d, remaining: %d",
1240
sent, len(client.secret)
1241
- (sent_size + sent))
1242
sent_size += sent
1243
1244
logger.info(u"Sending secret to %s", client.name)
1245
# bump the timeout as if seen
1246
client.checked_ok()
2256
1247
if self.server.use_dbus:
2257
1248
# Emit D-Bus signal
2258
1249
client.GotSecret()
2262
1253
client.approvals_pending -= 1
2263
1254
try:
2264
1255
session.bye()
2265
except gnutls.Error as error:
2266
logger.warning("GnuTLS bye failed",
2267
exc_info=error)
1256
except (gnutls.errors.GNUTLSError), error:
1257
logger.warning("gnutls bye failed")
2268
1258
2269
1259
@staticmethod
2270
1260
def peer_certificate(session):
2271
1261
"Return the peer's OpenPGP certificate as a bytestring"
2272
1262
# If not an OpenPGP certificate...
2273
if (gnutls.certificate_type_get(session._c_object)
2274
!= gnutls.CRT_OPENPGP):
2275
# ...return invalid data
2276
return b""
1263
if (gnutls.library.functions
1264
.gnutls_certificate_type_get(session._c_object)
1265
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1266
# ...do the normal thing
1267
return session.peer_certificate
2277
1268
list_size = ctypes.c_uint(1)
2278
cert_list = (gnutls.certificate_get_peers
1269
cert_list = (gnutls.library.functions
1270
.gnutls_certificate_get_peers
2279
1271
(session._c_object, ctypes.byref(list_size)))
2280
1272
if not bool(cert_list) and list_size.value != 0:
2281
raise gnutls.Error("error getting peer certificate")
1273
raise gnutls.errors.GNUTLSError(u"error getting peer"
1274
u" certificate")
2282
1275
if list_size.value == 0:
2283
1276
return None
2284
1277
cert = cert_list[0]
2288
1281
def fingerprint(openpgp):
2289
1282
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
2290
1283
# New GnuTLS "datum" with the OpenPGP public key
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)))
1284
datum = (gnutls.library.types
1285
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1286
ctypes.POINTER
1287
(ctypes.c_ubyte)),
1288
ctypes.c_uint(len(openpgp))))
2295
1289
# New empty GnuTLS certificate
2296
crt = gnutls.openpgp_crt_t()
2297
gnutls.openpgp_crt_init(ctypes.byref(crt))
1290
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1291
(gnutls.library.functions
1292
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2298
1293
# Import the OpenPGP public key into the certificate
2299
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2300
gnutls.OPENPGP_FMT_RAW)
1294
(gnutls.library.functions
1295
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1296
gnutls.library.constants
1297
.GNUTLS_OPENPGP_FMT_RAW))
2301
1298
# Verify the self signature in the key
2302
1299
crtverify = ctypes.c_uint()
2303
gnutls.openpgp_crt_verify_self(crt, 0,
2304
ctypes.byref(crtverify))
1300
(gnutls.library.functions
1301
.gnutls_openpgp_crt_verify_self(crt, 0,
1302
ctypes.byref(crtverify)))
2305
1303
if crtverify.value != 0:
2306
gnutls.openpgp_crt_deinit(crt)
2307
raise gnutls.CertificateSecurityError("Verify failed")
1304
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1305
raise (gnutls.errors.CertificateSecurityError
1306
(u"Verify failed"))
2308
1307
# New buffer for the fingerprint
2309
1308
buf = ctypes.create_string_buffer(20)
2310
1309
buf_len = ctypes.c_size_t()
2311
1310
# Get the fingerprint from the certificate into the buffer
2312
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2313
ctypes.byref(buf_len))
1311
(gnutls.library.functions
1312
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1313
ctypes.byref(buf_len)))
2314
1314
# Deinit the certificate
2315
gnutls.openpgp_crt_deinit(crt)
1315
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2316
1316
# Convert the buffer to a Python bytestring
2317
1317
fpr = ctypes.string_at(buf, buf_len.value)
2318
1318
# Convert the bytestring to hexadecimal notation
2319
hex_fpr = binascii.hexlify(fpr).upper()
1319
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
2320
1320
return hex_fpr
2321
1321
2322
1322
2323
1323
class MultiprocessingMixIn(object):
2324
1324
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2325
2326
1325
def sub_process_main(self, request, address):
2327
1326
try:
2328
1327
self.finish_request(request, address)
2329
except Exception:
1328
except:
2330
1329
self.handle_error(request, address)
2331
1330
self.close_request(request)
2332
1331
2333
1332
def process_request(self, request, address):
2334
1333
"""Start a new process to process the request."""
2335
proc = multiprocessing.Process(target = self.sub_process_main,
2336
args = (request, address))
2337
proc.start()
2338
return proc
2339
1334
multiprocessing.Process(target = self.sub_process_main,
1335
args = (request, address)).start()
2340
1336
2341
1337
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2342
1338
""" adds a pipe to the MixIn """
2343
2344
1339
def process_request(self, request, client_address):
2345
1340
"""Overrides and wraps the original process_request().
2346
1341
2347
1342
This function creates a new pipe in self.pipe
2348
1343
"""
2349
1344
parent_pipe, self.child_pipe = multiprocessing.Pipe()
2350
2351
proc = MultiprocessingMixIn.process_request(self, request,
2352
client_address)
1345
1346
super(MultiprocessingMixInWithPipe,
1347
self).process_request(request, client_address)
2353
1348
self.child_pipe.close()
2354
self.add_pipe(parent_pipe, proc)
2355
2356
def add_pipe(self, parent_pipe, proc):
1349
self.add_pipe(parent_pipe)
1350
1351
def add_pipe(self, parent_pipe):
2357
1352
"""Dummy function; override as necessary"""
2358
raise NotImplementedError()
2359
1353
pass
2360
1354
2361
1355
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2362
1356
socketserver.TCPServer, object):
2367
1361
interface: None or a network interface name (string)
2368
1362
use_ipv6: Boolean; to use IPv6 or not
2369
1363
"""
2370
2371
1364
def __init__(self, server_address, RequestHandlerClass,
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
"""
1365
interface=None, use_ipv6=True):
2378
1366
self.interface = interface
2379
1367
if use_ipv6:
2380
1368
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.
2407
1369
socketserver.TCPServer.__init__(self, server_address,
2408
1370
RequestHandlerClass)
2409
2410
1371
def server_bind(self):
2411
1372
"""This overrides the normal server_bind() function
2412
1373
to bind to an interface if one was specified, and also NOT to
2413
1374
bind to an address or port if they were not specified."""
2414
1375
if self.interface is not None:
2415
1376
if SO_BINDTODEVICE is None:
2416
logger.error("SO_BINDTODEVICE does not exist;"
2417
" cannot bind to interface %s",
1377
logger.error(u"SO_BINDTODEVICE does not exist;"
1378
u" cannot bind to interface %s",
2418
1379
self.interface)
2419
1380
else:
2420
1381
try:
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)
1382
self.socket.setsockopt(socket.SOL_SOCKET,
1383
SO_BINDTODEVICE,
1384
str(self.interface
1385
+ u'\0'))
1386
except socket.error, error:
1387
if error[0] == errno.EPERM:
1388
logger.error(u"No permission to"
1389
u" bind to interface %s",
1390
self.interface)
1391
elif error[0] == errno.ENOPROTOOPT:
1392
logger.error(u"SO_BINDTODEVICE not available;"
1393
u" cannot bind to interface %s",
1394
self.interface)
2435
1395
else:
2436
1396
raise
2437
1397
# Only bind(2) the socket if we really need to.
2438
1398
if self.server_address[0] or self.server_address[1]:
2439
1399
if not self.server_address[0]:
2440
1400
if self.address_family == socket.AF_INET6:
2441
any_address = "::" # in6addr_any
1401
any_address = u"::" # in6addr_any
2442
1402
else:
2443
any_address = "0.0.0.0" # INADDR_ANY
1403
any_address = socket.INADDR_ANY
2444
1404
self.server_address = (any_address,
2445
1405
self.server_address[1])
2446
1406
elif not self.server_address[1]:
2447
self.server_address = (self.server_address[0], 0)
1407
self.server_address = (self.server_address[0],
1408
0)
2448
1409
# if self.interface:
2449
1410
# self.server_address = (self.server_address[0],
2450
1411
# 0, # port
2462
1423
gnutls_priority GnuTLS priority string
2463
1424
use_dbus: Boolean; to emit D-Bus signals or not
2464
1425
2465
Assumes a GObject.MainLoop event loop.
1426
Assumes a gobject.MainLoop event loop.
2466
1427
"""
2467
2468
1428
def __init__(self, server_address, RequestHandlerClass,
2469
interface=None,
2470
use_ipv6=True,
2471
clients=None,
2472
gnutls_priority=None,
2473
use_dbus=True,
2474
socketfd=None):
1429
interface=None, use_ipv6=True, clients=None,
1430
gnutls_priority=None, use_dbus=True):
2475
1431
self.enabled = False
2476
1432
self.clients = clients
2477
1433
if self.clients is None:
2478
self.clients = {}
1434
self.clients = set()
2479
1435
self.use_dbus = use_dbus
2480
1436
self.gnutls_priority = gnutls_priority
2481
1437
IPv6_TCPServer.__init__(self, server_address,
2482
1438
RequestHandlerClass,
2483
1439
interface = interface,
2484
use_ipv6 = use_ipv6,
2485
socketfd = socketfd)
2486
1440
use_ipv6 = use_ipv6)
2487
1441
def server_activate(self):
2488
1442
if self.enabled:
2489
1443
return socketserver.TCPServer.server_activate(self)
2490
2491
1444
def enable(self):
2492
1445
self.enabled = True
2493
2494
def add_pipe(self, parent_pipe, proc):
1446
def add_pipe(self, parent_pipe):
2495
1447
# Call "handle_ipc" for both data and EOF events
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,
1448
gobject.io_add_watch(parent_pipe.fileno(),
1449
gobject.IO_IN | gobject.IO_HUP,
1450
functools.partial(self.handle_ipc,
1451
parent_pipe = parent_pipe))
1452
1453
def handle_ipc(self, source, condition, parent_pipe=None,
2506
1454
client_object=None):
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()
1455
condition_names = {
1456
gobject.IO_IN: u"IN", # There is data to read.
1457
gobject.IO_OUT: u"OUT", # Data can be written (without
1458
# blocking).
1459
gobject.IO_PRI: u"PRI", # There is urgent data to read.
1460
gobject.IO_ERR: u"ERR", # Error condition.
1461
gobject.IO_HUP: u"HUP" # Hung up (the connection has been
1462
# broken, usually for pipes and
1463
# sockets).
1464
}
1465
conditions_string = ' | '.join(name
1466
for cond, name in
1467
condition_names.iteritems()
1468
if cond & condition)
1469
logger.debug(u"Handling IPC: FD = %d, condition = %s", source,
1470
conditions_string)
1471
1472
# error or the other end of multiprocessing.Pipe has closed
1473
if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
2511
1474
return False
2512
1475
2513
1476
# Read a request from the child
2514
1477
request = parent_pipe.recv()
1478
logger.debug(u"IPC request: %s", repr(request))
2515
1479
command = request[0]
2516
1480
2517
1481
if command == 'init':
2518
1482
fpr = request[1]
2519
1483
address = request[2]
2520
1484
2521
for c in self.clients.itervalues():
1485
for c in self.clients:
2522
1486
if c.fingerprint == fpr:
2523
1487
client = c
2524
1488
break
2525
1489
else:
2526
logger.info("Client not found for fingerprint: %s, ad"
2527
"dress: %s", fpr, address)
1490
logger.warning(u"Client not found for fingerprint: %s, ad"
1491
u"dress: %s", fpr, address)
2528
1492
if self.use_dbus:
2529
1493
# Emit D-Bus signal
2530
mandos_dbus_service.ClientNotFound(fpr,
2531
address[0])
1494
mandos_dbus_service.ClientNotFound(fpr, address)
2532
1495
parent_pipe.send(False)
2533
1496
return False
2534
1497
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))
1498
gobject.io_add_watch(parent_pipe.fileno(),
1499
gobject.IO_IN | gobject.IO_HUP,
1500
functools.partial(self.handle_ipc,
1501
parent_pipe = parent_pipe,
1502
client_object = client))
2542
1503
parent_pipe.send(True)
2543
# remove the old hook in favor of the new above hook on
2544
# same fileno
1504
# remove the old hook in favor of the new above hook on same fileno
2545
1505
return False
2546
1506
if command == 'funcall':
2547
1507
funcname = request[1]
2548
1508
args = request[2]
2549
1509
kwargs = request[3]
2550
1510
2551
parent_pipe.send(('data', getattr(client_object,
2552
funcname)(*args,
2553
**kwargs)))
2554
1511
parent_pipe.send(('data', getattr(client_object, funcname)(*args, **kwargs)))
1512
2555
1513
if command == 'getattr':
2556
1514
attrname = request[1]
2557
if isinstance(client_object.__getattribute__(attrname),
2558
collections.Callable):
2559
parent_pipe.send(('function', ))
1515
if callable(client_object.__getattribute__(attrname)):
1516
parent_pipe.send(('function',))
2560
1517
else:
2561
parent_pipe.send((
2562
'data', client_object.__getattribute__(attrname)))
1518
parent_pipe.send(('data', client_object.__getattribute__(attrname)))
2563
1519
2564
1520
if command == 'setattr':
2565
1521
attrname = request[1]
2566
1522
value = request[2]
2567
1523
setattr(client_object, attrname, value)
2568
1524
2569
1525
return True
2570
1526
2571
1527
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
2668
1528
def string_to_delta(interval):
2669
1529
"""Parse a string and return a datetime.timedelta
2670
1530
2671
>>> string_to_delta('7d')
1531
>>> string_to_delta(u'7d')
2672
1532
datetime.timedelta(7)
2673
>>> string_to_delta('60s')
1533
>>> string_to_delta(u'60s')
2674
1534
datetime.timedelta(0, 60)
2675
>>> string_to_delta('60m')
1535
>>> string_to_delta(u'60m')
2676
1536
datetime.timedelta(0, 3600)
2677
>>> string_to_delta('24h')
1537
>>> string_to_delta(u'24h')
2678
1538
datetime.timedelta(1)
2679
>>> string_to_delta('1w')
1539
>>> string_to_delta(u'1w')
2680
1540
datetime.timedelta(7)
2681
>>> string_to_delta('5m 30s')
1541
>>> string_to_delta(u'5m 30s')
2682
1542
datetime.timedelta(0, 330)
2683
1543
"""
2684
2685
try:
2686
return rfc3339_duration_to_delta(interval)
2687
except ValueError:
2688
pass
2689
2690
1544
timevalue = datetime.timedelta(0)
2691
1545
for s in interval.split():
2692
1546
try:
2693
suffix = s[-1]
1547
suffix = unicode(s[-1])
2694
1548
value = int(s[:-1])
2695
if suffix == "d":
1549
if suffix == u"d":
2696
1550
delta = datetime.timedelta(value)
2697
elif suffix == "s":
1551
elif suffix == u"s":
2698
1552
delta = datetime.timedelta(0, value)
2699
elif suffix == "m":
1553
elif suffix == u"m":
2700
1554
delta = datetime.timedelta(0, 0, 0, 0, value)
2701
elif suffix == "h":
1555
elif suffix == u"h":
2702
1556
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
2703
elif suffix == "w":
1557
elif suffix == u"w":
2704
1558
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2705
1559
else:
2706
raise ValueError("Unknown suffix {!r}".format(suffix))
2707
except IndexError as e:
2708
raise ValueError(*(e.args))
1560
raise ValueError(u"Unknown suffix %r" % suffix)
1561
except (ValueError, IndexError), e:
1562
raise ValueError(e.message)
2709
1563
timevalue += delta
2710
1564
return timevalue
2711
1565
2712
1566
1567
def if_nametoindex(interface):
1568
"""Call the C function if_nametoindex(), or equivalent
1569
1570
Note: This function cannot accept a unicode string."""
1571
global if_nametoindex
1572
try:
1573
if_nametoindex = (ctypes.cdll.LoadLibrary
1574
(ctypes.util.find_library(u"c"))
1575
.if_nametoindex)
1576
except (OSError, AttributeError):
1577
logger.warning(u"Doing if_nametoindex the hard way")
1578
def if_nametoindex(interface):
1579
"Get an interface index the hard way, i.e. using fcntl()"
1580
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
1581
with contextlib.closing(socket.socket()) as s:
1582
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1583
struct.pack(str(u"16s16x"),
1584
interface))
1585
interface_index = struct.unpack(str(u"I"),
1586
ifreq[16:20])[0]
1587
return interface_index
1588
return if_nametoindex(interface)
1589
1590
2713
1591
def daemon(nochdir = False, noclose = False):
2714
1592
"""See daemon(3). Standard BSD Unix function.
2715
1593
2718
1596
sys.exit()
2719
1597
os.setsid()
2720
1598
if not nochdir:
2721
os.chdir("/")
1599
os.chdir(u"/")
2722
1600
if os.fork():
2723
1601
sys.exit()
2724
1602
if not noclose:
2725
1603
# Close all standard open file descriptors
2726
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1604
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2727
1605
if not stat.S_ISCHR(os.fstat(null).st_mode):
2728
1606
raise OSError(errno.ENODEV,
2729
"{} not a character device"
2730
.format(os.devnull))
1607
u"%s not a character device"
1608
% os.path.devnull)
2731
1609
os.dup2(null, sys.stdin.fileno())
2732
1610
os.dup2(null, sys.stdout.fileno())
2733
1611
os.dup2(null, sys.stderr.fileno())
2740
1618
##################################################################
2741
1619
# Parsing of options, both command line and config file
2742
1620
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()
1621
parser = optparse.OptionParser(version = "%%prog %s" % version)
1622
parser.add_option("-i", u"--interface", type=u"string",
1623
metavar="IF", help=u"Bind to interface IF")
1624
parser.add_option("-a", u"--address", type=u"string",
1625
help=u"Address to listen for requests on")
1626
parser.add_option("-p", u"--port", type=u"int",
1627
help=u"Port number to receive requests on")
1628
parser.add_option("--check", action=u"store_true",
1629
help=u"Run self-test")
1630
parser.add_option("--debug", action=u"store_true",
1631
help=u"Debug mode; run in foreground and log to"
1632
u" terminal")
1633
parser.add_option("--debuglevel", type=u"string", metavar="Level",
1634
help=u"Debug level for stdout output")
1635
parser.add_option("--priority", type=u"string", help=u"GnuTLS"
1636
u" priority string (see GnuTLS documentation)")
1637
parser.add_option("--servicename", type=u"string",
1638
metavar=u"NAME", help=u"Zeroconf service name")
1639
parser.add_option("--configdir", type=u"string",
1640
default=u"/etc/mandos", metavar=u"DIR",
1641
help=u"Directory to search for configuration"
1642
u" files")
1643
parser.add_option("--no-dbus", action=u"store_false",
1644
dest=u"use_dbus", help=u"Do not provide D-Bus"
1645
u" system bus interface")
1646
parser.add_option("--no-ipv6", action=u"store_false",
1647
dest=u"use_ipv6", help=u"Do not use IPv6")
1648
options = parser.parse_args()[0]
2789
1649
2790
1650
if options.check:
2791
1651
import doctest
2792
fail_count, test_count = doctest.testmod()
2793
sys.exit(os.EX_OK if fail_count == 0 else 1)
1652
doctest.testmod()
1653
sys.exit()
2794
1654
2795
1655
# Default values for config file for server-global settings
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
}
1656
server_defaults = { u"interface": u"",
1657
u"address": u"",
1658
u"port": u"",
1659
u"debug": u"False",
1660
u"priority":
1661
u"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1662
u"servicename": u"Mandos",
1663
u"use_dbus": u"True",
1664
u"use_ipv6": u"True",
1665
u"debuglevel": u"",
1666
}
2813
1667
2814
1668
# Parse config file for server-global settings
2815
1669
server_config = configparser.SafeConfigParser(server_defaults)
2816
1670
del server_defaults
2817
server_config.read(os.path.join(options.configdir, "mandos.conf"))
1671
server_config.read(os.path.join(options.configdir,
1672
u"mandos.conf"))
2818
1673
# Convert the SafeConfigParser object to a dict
2819
1674
server_settings = server_config.defaults()
2820
1675
# Use the appropriate methods on the non-string config options
2821
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2822
server_settings[option] = server_config.getboolean("DEFAULT",
1676
for option in (u"debug", u"use_dbus", u"use_ipv6"):
1677
server_settings[option] = server_config.getboolean(u"DEFAULT",
2823
1678
option)
2824
1679
if server_settings["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"])
1680
server_settings["port"] = server_config.getint(u"DEFAULT",
1681
u"port")
2836
1682
del server_config
2837
1683
2838
1684
# Override the settings from the config file with command line
2839
1685
# options, if set.
2840
for option in ("interface", "address", "port", "debug",
2841
"priority", "servicename", "configdir", "use_dbus",
2842
"use_ipv6", "debuglevel", "restore", "statedir",
2843
"socket", "foreground", "zeroconf"):
1686
for option in (u"interface", u"address", u"port", u"debug",
1687
u"priority", u"servicename", u"configdir",
1688
u"use_dbus", u"use_ipv6", u"debuglevel"):
2844
1689
value = getattr(options, option)
2845
1690
if value is not None:
2846
1691
server_settings[option] = value
2847
1692
del options
2848
1693
# Force all strings to be unicode
2849
1694
for option in server_settings.keys():
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
1695
if type(server_settings[option]) is str:
1696
server_settings[option] = unicode(server_settings[option])
2860
1697
# Now we have our good server settings in "server_settings"
2861
1698
2862
1699
##################################################################
2863
1700
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
2869
1701
# For convenience
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"])))
1702
debug = server_settings[u"debug"]
1703
debuglevel = server_settings[u"debuglevel"]
1704
use_dbus = server_settings[u"use_dbus"]
1705
use_ipv6 = server_settings[u"use_ipv6"]
1706
1707
if server_settings[u"servicename"] != u"Mandos":
1708
syslogger.setFormatter(logging.Formatter
1709
(u'Mandos (%s) [%%(process)d]:'
1710
u' %%(levelname)s: %%(message)s'
1711
% server_settings[u"servicename"]))
2893
1712
2894
1713
# Parse config file with clients
2895
client_config = configparser.SafeConfigParser(Client
2896
.client_defaults)
2897
client_config.read(os.path.join(server_settings["configdir"],
2898
"clients.conf"))
1714
client_defaults = { u"timeout": u"1h",
1715
u"interval": u"5m",
1716
u"checker": u"fping -q -- %%(host)s",
1717
u"host": u"",
1718
u"approved_delay": u"0s",
1719
u"approved_duration": u"1s",
1720
}
1721
client_config = configparser.SafeConfigParser(client_defaults)
1722
client_config.read(os.path.join(server_settings[u"configdir"],
1723
u"clients.conf"))
2899
1724
2900
1725
global mandos_dbus_service
2901
1726
mandos_dbus_service = None
2902
1727
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)
1728
tcp_server = MandosServer((server_settings[u"address"],
1729
server_settings[u"port"]),
1730
ClientHandler,
1731
interface=server_settings[u"interface"],
1732
use_ipv6=use_ipv6,
1733
gnutls_priority=
1734
server_settings[u"priority"],
1735
use_dbus=use_dbus)
1736
pidfilename = u"/var/run/mandos.pid"
1737
try:
1738
pidfile = open(pidfilename, u"w")
1739
except IOError:
1740
logger.error(u"Could not open file %r", pidfilename)
2924
1741
2925
for name, group in (("_mandos", "_mandos"),
2926
("mandos", "mandos"),
2927
("nobody", "nogroup")):
1742
try:
1743
uid = pwd.getpwnam(u"_mandos").pw_uid
1744
gid = pwd.getpwnam(u"_mandos").pw_gid
1745
except KeyError:
2928
1746
try:
2929
uid = pwd.getpwnam(name).pw_uid
2930
gid = pwd.getpwnam(group).pw_gid
2931
break
1747
uid = pwd.getpwnam(u"mandos").pw_uid
1748
gid = pwd.getpwnam(u"mandos").pw_gid
2932
1749
except KeyError:
2933
continue
2934
else:
2935
uid = 65534
2936
gid = 65534
1750
try:
1751
uid = pwd.getpwnam(u"nobody").pw_uid
1752
gid = pwd.getpwnam(u"nobody").pw_gid
1753
except KeyError:
1754
uid = 65534
1755
gid = 65534
2937
1756
try:
2938
1757
os.setgid(gid)
2939
1758
os.setuid(uid)
2940
if debug:
2941
logger.debug("Did setuid/setgid to {}:{}".format(uid,
2942
gid))
2943
except OSError as error:
2944
logger.warning("Failed to setuid/setgid to {}:{}: {}"
2945
.format(uid, gid, os.strerror(error.errno)))
2946
if error.errno != errno.EPERM:
2947
raise
1759
except OSError, error:
1760
if error[0] != errno.EPERM:
1761
raise error
2948
1762
1763
# Enable all possible GnuTLS debugging
1764
1765
1766
if not debug and not debuglevel:
1767
syslogger.setLevel(logging.WARNING)
1768
console.setLevel(logging.WARNING)
1769
if debuglevel:
1770
level = getattr(logging, debuglevel.upper())
1771
syslogger.setLevel(level)
1772
console.setLevel(level)
1773
2949
1774
if debug:
2950
# Enable all possible GnuTLS debugging
2951
2952
1775
# "Use a log level over 10 to enable all debugging options."
2953
1776
# - GnuTLS manual
2954
gnutls.global_set_log_level(11)
1777
gnutls.library.functions.gnutls_global_set_log_level(11)
2955
1778
2956
@gnutls.log_func
1779
@gnutls.library.types.gnutls_log_func
2957
1780
def debug_gnutls(level, string):
2958
logger.debug("GnuTLS: %s", string[:-1])
2959
2960
gnutls.global_set_log_function(debug_gnutls)
2961
1781
logger.debug(u"GnuTLS: %s", string[:-1])
1782
1783
(gnutls.library.functions
1784
.gnutls_global_set_log_function(debug_gnutls))
1785
2962
1786
# Redirect stdin so all checkers get /dev/null
2963
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1787
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2964
1788
os.dup2(null, sys.stdin.fileno())
2965
1789
if null > 2:
2966
1790
os.close(null)
2967
2968
# Need to fork before connecting to D-Bus
2969
if not foreground:
2970
# Close all input and output, do double fork, etc.
2971
daemon()
2972
2973
# multiprocessing will use threads, so before we use GObject we
2974
# need to inform GObject that threads will be used.
2975
GObject.threads_init()
1791
else:
1792
# No console logging
1793
logger.removeHandler(console)
1794
2976
1795
2977
1796
global main_loop
2978
1797
# From the Avahi example code
2979
DBusGMainLoop(set_as_default=True)
2980
main_loop = GObject.MainLoop()
1798
DBusGMainLoop(set_as_default=True )
1799
main_loop = gobject.MainLoop()
2981
1800
bus = dbus.SystemBus()
2982
1801
# End of Avahi example code
2983
1802
if use_dbus:
2984
1803
try:
2985
bus_name = dbus.service.BusName("se.recompile.Mandos",
2986
bus,
2987
do_not_queue=True)
2988
old_bus_name = dbus.service.BusName(
2989
"se.bsnet.fukt.Mandos", bus,
2990
do_not_queue=True)
2991
except dbus.exceptions.DBusException as e:
2992
logger.error("Disabling D-Bus:", exc_info=e)
1804
bus_name = dbus.service.BusName(u"se.bsnet.fukt.Mandos",
1805
bus, do_not_queue=True)
1806
except dbus.exceptions.NameExistsException, e:
1807
logger.error(unicode(e) + u", disabling D-Bus")
2993
1808
use_dbus = False
2994
server_settings["use_dbus"] = False
1809
server_settings[u"use_dbus"] = False
2995
1810
tcp_server.use_dbus = False
2996
if zeroconf:
2997
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2998
service = AvahiServiceToSyslog(
2999
name = server_settings["servicename"],
3000
servicetype = "_mandos._tcp",
3001
protocol = protocol,
3002
bus = bus)
3003
if server_settings["interface"]:
3004
service.interface = if_nametoindex(
3005
server_settings["interface"].encode("utf-8"))
3006
1811
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1812
service = AvahiService(name = server_settings[u"servicename"],
1813
servicetype = u"_mandos._tcp",
1814
protocol = protocol, bus = bus)
1815
if server_settings["interface"]:
1816
service.interface = (if_nametoindex
1817
(str(server_settings[u"interface"])))
1818
1819
if not debug:
1820
# Close all input and output, do double fork, etc.
1821
daemon()
1822
3007
1823
global multiprocessing_manager
3008
1824
multiprocessing_manager = multiprocessing.Manager()
3009
1825
3010
1826
client_class = Client
3011
1827
if use_dbus:
3012
1828
client_class = functools.partial(ClientDBus, bus = bus)
3013
3014
client_settings = Client.config_parser(client_config)
3015
old_client_settings = {}
3016
clients_data = {}
3017
3018
# This is used to redirect stdout and stderr for checker processes
3019
global wnull
3020
wnull = open(os.devnull, "w") # A writable /dev/null
3021
# Only used if server is running in foreground but not in debug
3022
# mode
3023
if debug or not foreground:
3024
wnull.close()
3025
3026
# Get client data and settings from last running state.
3027
if server_settings["restore"]:
3028
try:
3029
with open(stored_state_path, "rb") as stored_state:
3030
clients_data, old_client_settings = pickle.load(
3031
stored_state)
3032
os.remove(stored_state_path)
3033
except IOError as e:
3034
if e.errno == errno.ENOENT:
3035
logger.warning("Could not load persistent state:"
3036
" {}".format(os.strerror(e.errno)))
3037
else:
3038
logger.critical("Could not load persistent state:",
3039
exc_info=e)
3040
raise
3041
except EOFError as e:
3042
logger.warning("Could not load persistent state: "
3043
"EOFError:",
3044
exc_info=e)
3045
3046
with PGPEngine() as pgp:
3047
for client_name, client in clients_data.items():
3048
# Skip removed clients
3049
if client_name not in client_settings:
3050
continue
3051
3052
# Decide which value to use after restoring saved state.
3053
# We have three different values: Old config file,
3054
# new config file, and saved state.
3055
# New config value takes precedence if it differs from old
3056
# config value, otherwise use saved state.
3057
for name, value in client_settings[client_name].items():
3058
try:
3059
# For each value in new config, check if it
3060
# differs from the old config value (Except for
3061
# the "secret" attribute)
3062
if (name != "secret"
3063
and (value !=
3064
old_client_settings[client_name][name])):
3065
client[name] = value
3066
except KeyError:
3067
pass
3068
3069
# Clients who has passed its expire date can still be
3070
# enabled if its last checker was successful. A Client
3071
# whose checker succeeded before we stored its state is
3072
# assumed to have successfully run all checkers during
3073
# downtime.
3074
if client["enabled"]:
3075
if datetime.datetime.utcnow() >= client["expires"]:
3076
if not client["last_checked_ok"]:
3077
logger.warning(
3078
"disabling client {} - Client never "
3079
"performed a successful checker".format(
3080
client_name))
3081
client["enabled"] = False
3082
elif client["last_checker_status"] != 0:
3083
logger.warning(
3084
"disabling client {} - Client last"
3085
" checker failed with error code"
3086
" {}".format(
3087
client_name,
3088
client["last_checker_status"]))
3089
client["enabled"] = False
3090
else:
3091
client["expires"] = (
3092
datetime.datetime.utcnow()
3093
+ client["timeout"])
3094
logger.debug("Last checker succeeded,"
3095
" keeping {} enabled".format(
3096
client_name))
1829
def client_config_items(config, section):
1830
special_settings = {
1831
"approved_by_default":
1832
lambda: config.getboolean(section,
1833
"approved_by_default"),
1834
}
1835
for name, value in config.items(section):
3097
1836
try:
3098
client["secret"] = pgp.decrypt(
3099
client["encrypted_secret"],
3100
client_settings[client_name]["secret"])
3101
except PGPError:
3102
# If decryption fails, we use secret from new settings
3103
logger.debug("Failed to decrypt {} old secret".format(
3104
client_name))
3105
client["secret"] = (client_settings[client_name]
3106
["secret"])
3107
3108
# Add/remove clients based on new changes made to config
3109
for client_name in (set(old_client_settings)
3110
- set(client_settings)):
3111
del clients_data[client_name]
3112
for client_name in (set(client_settings)
3113
- set(old_client_settings)):
3114
clients_data[client_name] = client_settings[client_name]
3115
3116
# Create all client objects
3117
for client_name, client in clients_data.items():
3118
tcp_server.clients[client_name] = client_class(
3119
name = client_name,
3120
settings = client,
3121
server_settings = server_settings)
3122
1837
yield (name, special_settings[name]())
1838
except KeyError:
1839
yield (name, value)
1840
1841
tcp_server.clients.update(set(
1842
client_class(name = section,
1843
config= dict(client_config_items(
1844
client_config, section)))
1845
for section in client_config.sections()))
3123
1846
if not tcp_server.clients:
3124
logger.warning("No clients defined")
3125
3126
if not foreground:
3127
if pidfile is not None:
1847
logger.warning(u"No clients defined")
1848
1849
try:
1850
with pidfile:
3128
1851
pid = os.getpid()
3129
try:
3130
with pidfile:
3131
print(pid, file=pidfile)
3132
except IOError:
3133
logger.error("Could not write to file %r with PID %d",
3134
pidfilename, pid)
1852
pidfile.write(str(pid) + "\n")
3135
1853
del pidfile
3136
del pidfilename
1854
except IOError:
1855
logger.error(u"Could not write to file %r with PID %d",
1856
pidfilename, pid)
1857
except NameError:
1858
# "pidfile" was never created
1859
pass
1860
del pidfilename
3137
1861
1862
if not debug:
1863
signal.signal(signal.SIGINT, signal.SIG_IGN)
3138
1864
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
3139
1865
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
3140
1866
3141
1867
if use_dbus:
3142
3143
@alternate_dbus_interfaces(
3144
{ "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
3145
class MandosDBusService(DBusObjectWithObjectManager):
1868
class MandosDBusService(dbus.service.Object):
3146
1869
"""A D-Bus proxy object"""
3147
3148
1870
def __init__(self):
3149
dbus.service.Object.__init__(self, bus, "/")
3150
3151
_interface = "se.recompile.Mandos"
3152
3153
@dbus.service.signal(_interface, signature="o")
1871
dbus.service.Object.__init__(self, bus, u"/")
1872
_interface = u"se.bsnet.fukt.Mandos"
1873
1874
@dbus.service.signal(_interface, signature=u"o")
3154
1875
def ClientAdded(self, objpath):
3155
1876
"D-Bus signal"
3156
1877
pass
3157
1878
3158
@dbus.service.signal(_interface, signature="ss")
1879
@dbus.service.signal(_interface, signature=u"ss")
3159
1880
def ClientNotFound(self, fingerprint, address):
3160
1881
"D-Bus signal"
3161
1882
pass
3162
1883
3163
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3164
"true"})
3165
@dbus.service.signal(_interface, signature="os")
1884
@dbus.service.signal(_interface, signature=u"os")
3166
1885
def ClientRemoved(self, objpath, name):
3167
1886
"D-Bus signal"
3168
1887
pass
3169
1888
3170
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3171
"true"})
3172
@dbus.service.method(_interface, out_signature="ao")
1889
@dbus.service.method(_interface, out_signature=u"ao")
3173
1890
def GetAllClients(self):
3174
1891
"D-Bus method"
3175
return dbus.Array(c.dbus_object_path for c in
3176
tcp_server.clients.itervalues())
1892
return dbus.Array(c.dbus_object_path
1893
for c in tcp_server.clients)
3177
1894
3178
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3179
"true"})
3180
1895
@dbus.service.method(_interface,
3181
out_signature="a{oa{sv}}")
1896
out_signature=u"a{oa{sv}}")
3182
1897
def GetAllClientsWithProperties(self):
3183
1898
"D-Bus method"
3184
1899
return dbus.Dictionary(
3185
{ c.dbus_object_path: c.GetAll(
3186
"se.recompile.Mandos.Client")
3187
for c in tcp_server.clients.itervalues() },
3188
signature="oa{sv}")
1900
((c.dbus_object_path, c.GetAll(u""))
1901
for c in tcp_server.clients),
1902
signature=u"oa{sv}")
3189
1903
3190
@dbus.service.method(_interface, in_signature="o")
1904
@dbus.service.method(_interface, in_signature=u"o")
3191
1905
def RemoveClient(self, object_path):
3192
1906
"D-Bus method"
3193
for c in tcp_server.clients.itervalues():
1907
for c in tcp_server.clients:
3194
1908
if c.dbus_object_path == object_path:
3195
del tcp_server.clients[c.name]
1909
tcp_server.clients.remove(c)
3196
1910
c.remove_from_connection()
3197
# Don't signal the disabling
1911
# Don't signal anything except ClientRemoved
3198
1912
c.disable(quiet=True)
3199
# Emit D-Bus signal for removal
3200
self.client_removed_signal(c)
1913
# Emit D-Bus signal
1914
self.ClientRemoved(object_path, c.name)
3201
1915
return
3202
1916
raise KeyError(object_path)
3203
1917
3204
1918
del _interface
3205
3206
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3207
out_signature = "a{oa{sa{sv}}}")
3208
def GetManagedObjects(self):
3209
"""D-Bus method"""
3210
return dbus.Dictionary(
3211
{ client.dbus_object_path:
3212
dbus.Dictionary(
3213
{ interface: client.GetAll(interface)
3214
for interface in
3215
client._get_all_interface_names()})
3216
for client in tcp_server.clients.values()})
3217
3218
def client_added_signal(self, client):
3219
"""Send the new standard signal and the old signal"""
3220
if use_dbus:
3221
# New standard signal
3222
self.InterfacesAdded(
3223
client.dbus_object_path,
3224
dbus.Dictionary(
3225
{ interface: client.GetAll(interface)
3226
for interface in
3227
client._get_all_interface_names()}))
3228
# Old signal
3229
self.ClientAdded(client.dbus_object_path)
3230
3231
def client_removed_signal(self, client):
3232
"""Send the new standard signal and the old signal"""
3233
if use_dbus:
3234
# New standard signal
3235
self.InterfacesRemoved(
3236
client.dbus_object_path,
3237
client._get_all_interface_names())
3238
# Old signal
3239
self.ClientRemoved(client.dbus_object_path,
3240
client.name)
3241
1919
3242
1920
mandos_dbus_service = MandosDBusService()
3243
1921
3244
1922
def cleanup():
3245
1923
"Cleanup function; run on exit"
3246
if zeroconf:
3247
service.cleanup()
3248
3249
multiprocessing.active_children()
3250
wnull.close()
3251
if not (tcp_server.clients or client_settings):
3252
return
3253
3254
# Store client before exiting. Secrets are encrypted with key
3255
# based on what config file has. If config file is
3256
# removed/edited, old secret will thus be unrecovable.
3257
clients = {}
3258
with PGPEngine() as pgp:
3259
for client in tcp_server.clients.itervalues():
3260
key = client_settings[client.name]["secret"]
3261
client.encrypted_secret = pgp.encrypt(client.secret,
3262
key)
3263
client_dict = {}
3264
3265
# A list of attributes that can not be pickled
3266
# + secret.
3267
exclude = { "bus", "changedstate", "secret",
3268
"checker", "server_settings" }
3269
for name, typ in inspect.getmembers(dbus.service
3270
.Object):
3271
exclude.add(name)
3272
3273
client_dict["encrypted_secret"] = (client
3274
.encrypted_secret)
3275
for attr in client.client_structure:
3276
if attr not in exclude:
3277
client_dict[attr] = getattr(client, attr)
3278
3279
clients[client.name] = client_dict
3280
del client_settings[client.name]["secret"]
3281
3282
try:
3283
with tempfile.NamedTemporaryFile(
3284
mode='wb',
3285
suffix=".pickle",
3286
prefix='clients-',
3287
dir=os.path.dirname(stored_state_path),
3288
delete=False) as stored_state:
3289
pickle.dump((clients, client_settings), stored_state)
3290
tempname = stored_state.name
3291
os.rename(tempname, stored_state_path)
3292
except (IOError, OSError) as e:
3293
if not debug:
3294
try:
3295
os.remove(tempname)
3296
except NameError:
3297
pass
3298
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3299
logger.warning("Could not save persistent state: {}"
3300
.format(os.strerror(e.errno)))
3301
else:
3302
logger.warning("Could not save persistent state:",
3303
exc_info=e)
3304
raise
3305
3306
# Delete all clients, and settings from config
1924
service.cleanup()
1925
3307
1926
while tcp_server.clients:
3308
name, client = tcp_server.clients.popitem()
1927
client = tcp_server.clients.pop()
3309
1928
if use_dbus:
3310
1929
client.remove_from_connection()
3311
# Don't signal the disabling
1930
client.disable_hook = None
1931
# Don't signal anything except ClientRemoved
3312
1932
client.disable(quiet=True)
3313
# Emit D-Bus signal for removal
3314
1933
if use_dbus:
3315
mandos_dbus_service.client_removed_signal(client)
3316
client_settings.clear()
1934
# Emit D-Bus signal
1935
mandos_dbus_service.ClientRemoved(client.dbus_object_path,
1936
client.name)
3317
1937
3318
1938
atexit.register(cleanup)
3319
1939
3320
for client in tcp_server.clients.itervalues():
1940
for client in tcp_server.clients:
3321
1941
if use_dbus:
3322
# Emit D-Bus signal for adding
3323
mandos_dbus_service.client_added_signal(client)
3324
# Need to initiate checking of clients
3325
if client.enabled:
3326
client.init_checker()
1942
# Emit D-Bus signal
1943
mandos_dbus_service.ClientAdded(client.dbus_object_path)
1944
client.enable()
3327
1945
3328
1946
tcp_server.enable()
3329
1947
tcp_server.server_activate()
3330
1948
3331
1949
# Find out what port we got
3332
if zeroconf:
3333
service.port = tcp_server.socket.getsockname()[1]
1950
service.port = tcp_server.socket.getsockname()[1]
3334
1951
if use_ipv6:
3335
logger.info("Now listening on address %r, port %d,"
3336
" flowinfo %d, scope_id %d",
3337
*tcp_server.socket.getsockname())
1952
logger.info(u"Now listening on address %r, port %d,"
1953
" flowinfo %d, scope_id %d"
1954
% tcp_server.socket.getsockname())
3338
1955
else: # IPv4
3339
logger.info("Now listening on address %r, port %d",
3340
*tcp_server.socket.getsockname())
1956
logger.info(u"Now listening on address %r, port %d"
1957
% tcp_server.socket.getsockname())
3341
1958
3342
1959
#service.interface = tcp_server.socket.getsockname()[3]
3343
1960
3344
1961
try:
3345
if zeroconf:
3346
# From the Avahi example code
3347
try:
3348
service.activate()
3349
except dbus.exceptions.DBusException as error:
3350
logger.critical("D-Bus Exception", exc_info=error)
3351
cleanup()
3352
sys.exit(1)
3353
# End of Avahi example code
1962
# From the Avahi example code
1963
try:
1964
service.activate()
1965
except dbus.exceptions.DBusException, error:
1966
logger.critical(u"DBusException: %s", error)
1967
cleanup()
1968
sys.exit(1)
1969
# End of Avahi example code
3354
1970
3355
GObject.io_add_watch(tcp_server.fileno(), GObject.IO_IN,
1971
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
3356
1972
lambda *args, **kwargs:
3357
1973
(tcp_server.handle_request
3358
1974
(*args[2:], **kwargs) or True))
3359
1975
3360
logger.debug("Starting main loop")
1976
logger.debug(u"Starting main loop")
3361
1977
main_loop.run()
3362
except AvahiError as error:
3363
logger.critical("Avahi Error", exc_info=error)
1978
except AvahiError, error:
1979
logger.critical(u"AvahiError: %s", error)
3364
1980
cleanup()
3365
1981
sys.exit(1)
3366
1982
except KeyboardInterrupt:
3367
1983
if debug:
3368
print("", file=sys.stderr)
3369
logger.debug("Server received KeyboardInterrupt")
3370
logger.debug("Server exiting")
1984
print >> sys.stderr
1985
logger.debug(u"Server received KeyboardInterrupt")
1986
logger.debug(u"Server exiting")
3371
1987
# Must run before the D-Bus bus name gets deregistered
3372
1988
cleanup()
3373
1989
3374
3375
1990
if __name__ == '__main__':
3376
1991
main()
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0