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