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