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