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