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