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