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