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