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