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