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