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 520
- compare with another revision
- download diff
- download tarball
- view history from revision 520
- Committer: Björn Påhlsson
- Date: 2011-11-09 17:16:03 UTC
- mfrom: (518.1.1 mandos-persistent)
- Revision ID: belorn@fukt.bsnet.se-20111109171603-srz21uoclpldp5ve
merge persistent state
- files removed:
- bugs.xml
- debian/upstream
- network-hooks.d
- plugin-helpers
- files modified:
- .bzrignore
added
removed
mandos
11
11
# "AvahiService" class, and some lines in "main".
12
12
#
13
13
# Everything else is
14
# Copyright © 2008-2016 Teddy Hogeborn
15
# Copyright © 2008-2016 Björn Påhlsson
14
# Copyright © 2008-2011 Teddy Hogeborn
15
# Copyright © 2008-2011 Björn Påhlsson
16
16
#
17
17
# This program is free software: you can redistribute it and/or modify
18
18
# it under the terms of the GNU General Public License as published by
34
34
from __future__ import (division, absolute_import, print_function,
35
35
unicode_literals)
36
36
37
try:
38
from future_builtins import *
39
except ImportError:
40
pass
41
42
try:
43
import SocketServer as socketserver
44
except ImportError:
45
import socketserver
37
import SocketServer as socketserver
46
38
import socket
47
39
import argparse
48
40
import datetime
49
41
import errno
50
try:
51
import ConfigParser as configparser
52
except ImportError:
53
import configparser
42
import gnutls.crypto
43
import gnutls.connection
44
import gnutls.errors
45
import gnutls.library.functions
46
import gnutls.library.constants
47
import gnutls.library.types
48
import ConfigParser as configparser
54
49
import sys
55
50
import re
56
51
import os
65
60
import struct
66
61
import fcntl
67
62
import functools
68
try:
69
import cPickle as pickle
70
except ImportError:
71
import pickle
63
import cPickle as pickle
72
64
import multiprocessing
73
65
import types
74
import binascii
75
import tempfile
76
import itertools
77
import collections
78
import codecs
66
import hashlib
79
67
80
68
import dbus
81
69
import dbus.service
82
try:
83
from gi.repository import GObject
84
except ImportError:
85
import gobject as GObject
70
import gobject
71
import avahi
86
72
from dbus.mainloop.glib import DBusGMainLoop
87
73
import ctypes
88
74
import ctypes.util
89
75
import xml.dom.minidom
90
76
import inspect
77
import Crypto.Cipher.AES
91
78
92
79
try:
93
80
SO_BINDTODEVICE = socket.SO_BINDTODEVICE
97
84
except ImportError:
98
85
SO_BINDTODEVICE = None
99
86
100
if sys.version_info.major == 2:
101
str = unicode
102
87
103
version = "1.7.5"
104
stored_state_file = "clients.pickle"
88
version = "1.4.1"
105
89
106
90
logger = logging.getLogger()
107
syslogger = None
108
109
try:
110
if_nametoindex = ctypes.cdll.LoadLibrary(
111
ctypes.util.find_library("c")).if_nametoindex
112
except (OSError, AttributeError):
113
114
def if_nametoindex(interface):
115
"Get an interface index the hard way, i.e. using fcntl()"
116
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
117
with contextlib.closing(socket.socket()) as s:
118
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
119
struct.pack(b"16s16x", interface))
120
interface_index = struct.unpack("I", ifreq[16:20])[0]
121
return interface_index
122
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
140
def initlogger(debug, level=logging.WARNING):
141
"""init logger and add loglevel"""
142
143
global syslogger
144
syslogger = (logging.handlers.SysLogHandler(
145
facility = logging.handlers.SysLogHandler.LOG_DAEMON,
146
address = "/dev/log"))
147
syslogger.setFormatter(logging.Formatter
148
('Mandos [%(process)d]: %(levelname)s:'
149
' %(message)s'))
150
logger.addHandler(syslogger)
151
152
if debug:
153
console = logging.StreamHandler()
154
console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
155
' [%(process)d]:'
156
' %(levelname)s:'
157
' %(message)s'))
158
logger.addHandler(console)
159
logger.setLevel(level)
160
161
162
class PGPError(Exception):
163
"""Exception if encryption/decryption fails"""
164
pass
165
166
167
class PGPEngine(object):
168
"""A simple class for OpenPGP symmetric encryption & decryption"""
169
170
def __init__(self):
171
self.tempdir = tempfile.mkdtemp(prefix="mandos-")
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']
188
189
def __enter__(self):
190
return self
191
192
def __exit__(self, exc_type, exc_value, traceback):
193
self._cleanup()
194
return False
195
196
def __del__(self):
197
self._cleanup()
198
199
def _cleanup(self):
200
if self.tempdir is not None:
201
# Delete contents of tempdir
202
for root, dirs, files in os.walk(self.tempdir,
203
topdown = False):
204
for filename in files:
205
os.remove(os.path.join(root, filename))
206
for dirname in dirs:
207
os.rmdir(os.path.join(root, dirname))
208
# Remove tempdir
209
os.rmdir(self.tempdir)
210
self.tempdir = None
211
212
def password_encode(self, password):
213
# Passphrase can not be empty and can not contain newlines or
214
# NUL bytes. So we prefix it and hex encode it.
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
222
223
def encrypt(self, data, password):
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)
239
return ciphertext
240
241
def decrypt(self, data, password):
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)
257
return decrypted_plaintext
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()
91
stored_state_path = "/var/lib/mandos/clients.pickle"
92
93
syslogger = (logging.handlers.SysLogHandler
94
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
95
address = str("/dev/log")))
96
syslogger.setFormatter(logging.Formatter
97
('Mandos [%(process)d]: %(levelname)s:'
98
' %(message)s'))
99
logger.addHandler(syslogger)
100
101
console = logging.StreamHandler()
102
console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
103
' [%(process)d]:'
104
' %(levelname)s:'
105
' %(message)s'))
106
logger.addHandler(console)
107
283
108
284
109
class AvahiError(Exception):
285
110
def __init__(self, value, *args, **kwargs):
286
111
self.value = value
287
return super(AvahiError, self).__init__(value, *args,
288
**kwargs)
289
112
super(AvahiError, self).__init__(value, *args, **kwargs)
113
def __unicode__(self):
114
return unicode(repr(self.value))
290
115
291
116
class AvahiServiceError(AvahiError):
292
117
pass
293
118
294
295
119
class AvahiGroupError(AvahiError):
296
120
pass
297
121
304
128
Used to optionally bind to the specified interface.
305
129
name: string; Example: 'Mandos'
306
130
type: string; Example: '_mandos._tcp'.
307
See <https://www.iana.org/assignments/service-names-port-numbers>
131
See <http://www.dns-sd.org/ServiceTypes.html>
308
132
port: integer; what port to announce
309
133
TXT: list of strings; TXT record for the service
310
134
domain: string; Domain to publish on, default to .local if empty.
316
140
server: D-Bus Server
317
141
bus: dbus.SystemBus()
318
142
"""
319
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):
143
def __init__(self, interface = avahi.IF_UNSPEC, name = None,
144
servicetype = None, port = None, TXT = None,
145
domain = "", host = "", max_renames = 32768,
146
protocol = avahi.PROTO_UNSPEC, bus = None):
331
147
self.interface = interface
332
148
self.name = name
333
149
self.type = servicetype
342
158
self.server = None
343
159
self.bus = bus
344
160
self.entry_group_state_changed_match = None
345
346
def rename(self, remove=True):
161
def rename(self):
347
162
"""Derived from the Avahi example code"""
348
163
if self.rename_count >= self.max_renames:
349
164
logger.critical("No suitable Zeroconf service name found"
350
165
" after %i retries, exiting.",
351
166
self.rename_count)
352
167
raise AvahiServiceError("Too many renames")
353
self.name = str(
354
self.server.GetAlternativeServiceName(self.name))
355
self.rename_count += 1
168
self.name = unicode(self.server
169
.GetAlternativeServiceName(self.name))
356
170
logger.info("Changing Zeroconf service name to %r ...",
357
171
self.name)
358
if remove:
359
self.remove()
172
self.remove()
360
173
try:
361
174
self.add()
362
175
except dbus.exceptions.DBusException as error:
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)
371
176
logger.critical("DBusException: %s", error)
177
self.cleanup()
178
os._exit(1)
179
self.rename_count += 1
372
180
def remove(self):
373
181
"""Derived from the Avahi example code"""
374
182
if self.entry_group_state_changed_match is not None:
376
184
self.entry_group_state_changed_match = None
377
185
if self.group is not None:
378
186
self.group.Reset()
379
380
187
def add(self):
381
188
"""Derived from the Avahi example code"""
382
189
self.remove()
399
206
dbus.UInt16(self.port),
400
207
avahi.string_array_to_txt_array(self.TXT))
401
208
self.group.Commit()
402
403
209
def entry_group_state_changed(self, state, error):
404
210
"""Derived from the Avahi example code"""
405
211
logger.debug("Avahi entry group state change: %i", state)
411
217
self.rename()
412
218
elif state == avahi.ENTRY_GROUP_FAILURE:
413
219
logger.critical("Avahi: Error in group state changed %s",
414
str(error))
415
raise AvahiGroupError("State changed: {!s}".format(error))
416
220
unicode(error))
221
raise AvahiGroupError("State changed: %s"
222
% unicode(error))
417
223
def cleanup(self):
418
224
"""Derived from the Avahi example code"""
419
225
if self.group is not None:
420
226
try:
421
227
self.group.Free()
422
228
except (dbus.exceptions.UnknownMethodException,
423
dbus.exceptions.DBusException):
229
dbus.exceptions.DBusException) as e:
424
230
pass
425
231
self.group = None
426
232
self.remove()
427
428
233
def server_state_changed(self, state, error=None):
429
234
"""Derived from the Avahi example code"""
430
235
logger.debug("Avahi server state change: %i", state)
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
}
236
bad_states = { avahi.SERVER_INVALID:
237
"Zeroconf server invalid",
238
avahi.SERVER_REGISTERING: None,
239
avahi.SERVER_COLLISION:
240
"Zeroconf server name collision",
241
avahi.SERVER_FAILURE:
242
"Zeroconf server failure" }
437
243
if state in bad_states:
438
244
if bad_states[state] is not None:
439
245
if error is None:
442
248
logger.error(bad_states[state] + ": %r", error)
443
249
self.cleanup()
444
250
elif state == avahi.SERVER_RUNNING:
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)
251
self.add()
457
252
else:
458
253
if error is None:
459
254
logger.debug("Unknown state: %r", state)
460
255
else:
461
256
logger.debug("Unknown state: %r: %r", state, error)
462
463
257
def activate(self):
464
258
"""Derived from the Avahi example code"""
465
259
if self.server is None:
469
263
follow_name_owner_changes=True),
470
264
avahi.DBUS_INTERFACE_SERVER)
471
265
self.server.connect_to_signal("StateChanged",
472
self.server_state_changed)
266
self.server_state_changed)
473
267
self.server_state_changed(self.server.GetState())
474
268
475
476
269
class AvahiServiceToSyslog(AvahiService):
477
def rename(self, *args, **kwargs):
270
def rename(self):
478
271
"""Add the new name to the syslog messages"""
479
ret = AvahiService.rename(self, *args, **kwargs)
480
syslogger.setFormatter(logging.Formatter(
481
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
482
.format(self.name)))
272
ret = AvahiService.rename(self)
273
syslogger.setFormatter(logging.Formatter
274
('Mandos (%s) [%%(process)d]:'
275
' %%(levelname)s: %%(message)s'
276
% self.name))
483
277
return ret
484
278
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()
749
279
def _timedelta_to_milliseconds(td):
280
"Convert a datetime.timedelta() to milliseconds"
281
return ((td.days * 24 * 60 * 60 * 1000)
282
+ (td.seconds * 1000)
283
+ (td.microseconds // 1000))
284
750
285
class Client(object):
751
286
"""A representation of a client host served by this server.
752
287
753
288
Attributes:
754
approved: bool(); 'None' if not yet approved/disapproved
289
_approved: bool(); 'None' if not yet approved/disapproved
755
290
approval_delay: datetime.timedelta(); Time to wait for approval
756
291
approval_duration: datetime.timedelta(); Duration of one approval
757
292
checker: subprocess.Popen(); a running checker process used
758
293
to see if the client lives.
759
294
'None' if no process is running.
760
checker_callback_tag: a GObject event source tag, or None
295
checker_callback_tag: a gobject event source tag, or None
761
296
checker_command: string; External command which is run to check
762
297
if client lives. %() expansions are done at
763
298
runtime with vars(self) as dict, so that for
764
299
instance %(name)s can be used in the command.
765
checker_initiator_tag: a GObject event source tag, or None
300
checker_initiator_tag: a gobject event source tag, or None
766
301
created: datetime.datetime(); (UTC) object creation
767
302
client_structure: Object describing what attributes a client has
768
303
and is used for storing the client at exit
769
304
current_checker_command: string; current running checker_command
770
disable_initiator_tag: a GObject event source tag, or None
305
disable_initiator_tag: a gobject event source tag, or None
771
306
enabled: bool()
772
307
fingerprint: string (40 or 32 hexadecimal digits); used to
773
308
uniquely identify the client
775
310
interval: datetime.timedelta(); How often to start a new checker
776
311
last_approval_request: datetime.datetime(); (UTC) or None
777
312
last_checked_ok: datetime.datetime(); (UTC) or None
778
last_checker_status: integer between 0 and 255 reflecting exit
779
status of last checker. -1 reflects crashed
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
783
last_enabled: datetime.datetime(); (UTC) or None
313
last_checker_status: integer between 0 and 255 reflecting exit status
314
of last checker. -1 reflect crashed checker,
315
or None.
316
last_enabled: datetime.datetime(); (UTC)
784
317
name: string; from the config file, used in log messages and
785
318
D-Bus identifiers
786
319
secret: bytestring; sent verbatim (over TLS) to client
787
320
timeout: datetime.timedelta(); How long from last_checked_ok
788
321
until this client is disabled
789
extended_timeout: extra long timeout when secret has been sent
322
extended_timeout: extra long timeout when password has been sent
790
323
runtime_expansions: Allowed attributes for runtime expansion.
791
324
expires: datetime.datetime(); time (UTC) when a client will be
792
325
disabled, or None
793
server_settings: The server_settings dict from main()
794
326
"""
795
327
796
328
runtime_expansions = ("approval_delay", "approval_duration",
797
"created", "enabled", "expires",
798
"fingerprint", "host", "interval",
799
"last_approval_request", "last_checked_ok",
329
"created", "enabled", "fingerprint",
330
"host", "interval", "last_checked_ok",
800
331
"last_enabled", "name", "timeout")
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
}
812
813
@staticmethod
814
def config_parser(config):
815
"""Construct a new dict of client settings of this form:
816
{ client_name: {setting_name: value, ...}, ...}
817
with exceptions for any special settings as defined above.
818
NOTE: Must be a pure function. Must return the same result
819
value given the same arguments.
820
"""
821
settings = {}
822
for client_name in config.sections():
823
section = dict(config.items(client_name))
824
client = settings[client_name] = {}
825
826
client["host"] = section["host"]
827
# Reformat values from string types to Python types
828
client["approved_by_default"] = config.getboolean(
829
client_name, "approved_by_default")
830
client["enabled"] = config.getboolean(client_name,
831
"enabled")
832
833
# Uppercase and remove spaces from fingerprint for later
834
# comparison purposes with return value from the
835
# fingerprint() function
836
client["fingerprint"] = (section["fingerprint"].upper()
837
.replace(" ", ""))
838
if "secret" in section:
839
client["secret"] = codecs.decode(section["secret"]
840
.encode("utf-8"),
841
"base64")
842
elif "secfile" in section:
843
with open(os.path.expanduser(os.path.expandvars
844
(section["secfile"])),
845
"rb") as secfile:
846
client["secret"] = secfile.read()
847
else:
848
raise TypeError("No secret or secfile for section {}"
849
.format(section))
850
client["timeout"] = string_to_delta(section["timeout"])
851
client["extended_timeout"] = string_to_delta(
852
section["extended_timeout"])
853
client["interval"] = string_to_delta(section["interval"])
854
client["approval_delay"] = string_to_delta(
855
section["approval_delay"])
856
client["approval_duration"] = string_to_delta(
857
section["approval_duration"])
858
client["checker_command"] = section["checker"]
859
client["last_approval_request"] = None
860
client["last_checked_ok"] = None
861
client["last_checker_status"] = -2
862
863
return settings
864
865
def __init__(self, settings, name = None, server_settings=None):
332
333
def timeout_milliseconds(self):
334
"Return the 'timeout' attribute in milliseconds"
335
return _timedelta_to_milliseconds(self.timeout)
336
337
def extended_timeout_milliseconds(self):
338
"Return the 'extended_timeout' attribute in milliseconds"
339
return _timedelta_to_milliseconds(self.extended_timeout)
340
341
def interval_milliseconds(self):
342
"Return the 'interval' attribute in milliseconds"
343
return _timedelta_to_milliseconds(self.interval)
344
345
def approval_delay_milliseconds(self):
346
return _timedelta_to_milliseconds(self.approval_delay)
347
348
def __init__(self, name = None, config=None):
349
"""Note: the 'checker' key in 'config' sets the
350
'checker_command' attribute and *not* the 'checker'
351
attribute."""
866
352
self.name = name
867
if server_settings is None:
868
server_settings = {}
869
self.server_settings = server_settings
870
# adding all client settings
871
for setting, value in settings.items():
872
setattr(self, setting, value)
873
874
if self.enabled:
875
if not hasattr(self, "last_enabled"):
876
self.last_enabled = datetime.datetime.utcnow()
877
if not hasattr(self, "expires"):
878
self.expires = (datetime.datetime.utcnow()
879
+ self.timeout)
880
else:
881
self.last_enabled = None
882
self.expires = None
883
353
if config is None:
354
config = {}
884
355
logger.debug("Creating client %r", self.name)
356
# Uppercase and remove spaces from fingerprint for later
357
# comparison purposes with return value from the fingerprint()
358
# function
359
self.fingerprint = (config["fingerprint"].upper()
360
.replace(" ", ""))
885
361
logger.debug(" Fingerprint: %s", self.fingerprint)
886
self.created = settings.get("created",
887
datetime.datetime.utcnow())
888
889
# attributes specific for this server instance
362
if "secret" in config:
363
self.secret = config["secret"].decode("base64")
364
elif "secfile" in config:
365
with open(os.path.expanduser(os.path.expandvars
366
(config["secfile"])),
367
"rb") as secfile:
368
self.secret = secfile.read()
369
else:
370
raise TypeError("No secret or secfile for client %s"
371
% self.name)
372
self.host = config.get("host", "")
373
self.created = datetime.datetime.utcnow()
374
self.enabled = True
375
self.last_approval_request = None
376
self.last_enabled = datetime.datetime.utcnow()
377
self.last_checked_ok = None
378
self.last_checker_status = None
379
self.timeout = string_to_delta(config["timeout"])
380
self.extended_timeout = string_to_delta(config
381
["extended_timeout"])
382
self.interval = string_to_delta(config["interval"])
890
383
self.checker = None
891
384
self.checker_initiator_tag = None
892
385
self.disable_initiator_tag = None
386
self.expires = datetime.datetime.utcnow() + self.timeout
893
387
self.checker_callback_tag = None
388
self.checker_command = config["checker"]
894
389
self.current_checker_command = None
895
self.approved = None
390
self._approved = None
391
self.approved_by_default = config.get("approved_by_default",
392
True)
896
393
self.approvals_pending = 0
897
self.changedstate = multiprocessing_manager.Condition(
898
multiprocessing_manager.Lock())
899
self.client_structure = [attr
900
for attr in self.__dict__.keys()
901
if not attr.startswith("_")]
394
self.approval_delay = string_to_delta(
395
config["approval_delay"])
396
self.approval_duration = string_to_delta(
397
config["approval_duration"])
398
self.changedstate = (multiprocessing_manager
399
.Condition(multiprocessing_manager
400
.Lock()))
401
self.client_structure = [attr for attr in self.__dict__.iterkeys() if not attr.startswith("_")]
902
402
self.client_structure.append("client_structure")
903
904
for name, t in inspect.getmembers(
905
type(self), lambda obj: isinstance(obj, property)):
403
404
405
for name, t in inspect.getmembers(type(self),
406
lambda obj: isinstance(obj, property)):
906
407
if not name.startswith("_"):
907
408
self.client_structure.append(name)
908
409
916
417
if getattr(self, "enabled", False):
917
418
# Already enabled
918
419
return
420
self.send_changedstate()
919
421
self.expires = datetime.datetime.utcnow() + self.timeout
920
422
self.enabled = True
921
423
self.last_enabled = datetime.datetime.utcnow()
922
424
self.init_checker()
923
self.send_changedstate()
924
425
925
426
def disable(self, quiet=True):
926
427
"""Disable this client."""
927
428
if not getattr(self, "enabled", False):
928
429
return False
929
430
if not quiet:
431
self.send_changedstate()
432
if not quiet:
930
433
logger.info("Disabling client %s", self.name)
931
if getattr(self, "disable_initiator_tag", None) is not None:
932
GObject.source_remove(self.disable_initiator_tag)
434
if getattr(self, "disable_initiator_tag", False):
435
gobject.source_remove(self.disable_initiator_tag)
933
436
self.disable_initiator_tag = None
934
437
self.expires = None
935
if getattr(self, "checker_initiator_tag", None) is not None:
936
GObject.source_remove(self.checker_initiator_tag)
438
if getattr(self, "checker_initiator_tag", False):
439
gobject.source_remove(self.checker_initiator_tag)
937
440
self.checker_initiator_tag = None
938
441
self.stop_checker()
939
442
self.enabled = False
940
if not quiet:
941
self.send_changedstate()
942
# Do not run this again if called by a GObject.timeout_add
443
# Do not run this again if called by a gobject.timeout_add
943
444
return False
944
445
945
446
def __del__(self):
946
447
self.disable()
947
448
948
449
def init_checker(self):
949
450
# Schedule a new checker to be started an 'interval' from now,
950
451
# and every interval from then on.
951
if self.checker_initiator_tag is not None:
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)
452
self.checker_initiator_tag = (gobject.timeout_add
453
(self.interval_milliseconds(),
454
self.start_checker))
956
455
# Schedule a disable() when 'timeout' has passed
957
if self.disable_initiator_tag is not None:
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)
456
self.disable_initiator_tag = (gobject.timeout_add
457
(self.timeout_milliseconds(),
458
self.disable))
961
459
# Also start a new checker *right now*.
962
460
self.start_checker()
963
964
def checker_callback(self, source, condition, connection,
965
command):
461
462
463
def checker_callback(self, pid, condition, command):
966
464
"""The checker has completed, so take appropriate actions."""
967
465
self.checker_callback_tag = None
968
466
self.checker = None
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
467
if os.WIFEXITED(condition):
468
self.last_checker_status = os.WEXITSTATUS(condition)
976
469
if self.last_checker_status == 0:
977
470
logger.info("Checker for %(name)s succeeded",
978
471
vars(self))
979
472
self.checked_ok()
980
473
else:
981
logger.info("Checker for %(name)s failed", vars(self))
474
logger.info("Checker for %(name)s failed",
475
vars(self))
982
476
else:
983
477
self.last_checker_status = -1
984
self.last_checker_signal = -returncode
985
478
logger.warning("Checker for %(name)s crashed?",
986
479
vars(self))
987
return False
988
989
def checked_ok(self):
990
"""Assert that the client has been seen, alive and well."""
991
self.last_checked_ok = datetime.datetime.utcnow()
992
self.last_checker_status = 0
993
self.last_checker_signal = None
994
self.bump_timeout()
995
996
def bump_timeout(self, timeout=None):
997
"""Bump up the timeout for this client."""
480
481
def checked_ok(self, timeout=None):
482
"""Bump up the timeout for this client.
483
484
This should only be called when the client has been seen,
485
alive and well.
486
"""
998
487
if timeout is None:
999
488
timeout = self.timeout
489
self.last_checked_ok = datetime.datetime.utcnow()
1000
490
if self.disable_initiator_tag is not None:
1001
GObject.source_remove(self.disable_initiator_tag)
1002
self.disable_initiator_tag = None
491
gobject.source_remove(self.disable_initiator_tag)
1003
492
if getattr(self, "enabled", False):
1004
self.disable_initiator_tag = GObject.timeout_add(
1005
int(timeout.total_seconds() * 1000), self.disable)
493
self.disable_initiator_tag = (gobject.timeout_add
494
(_timedelta_to_milliseconds
495
(timeout), self.disable))
1006
496
self.expires = datetime.datetime.utcnow() + timeout
1007
497
1008
498
def need_approval(self):
1014
504
If a checker already exists, leave it running and do
1015
505
nothing."""
1016
506
# The reason for not killing a running checker is that if we
1017
# did that, and if a checker (for some reason) started running
1018
# slowly and taking more than 'interval' time, then the client
1019
# would inevitably timeout, since no checker would get a
1020
# chance to run to completion. If we instead leave running
507
# did that, then if a checker (for some reason) started
508
# running slowly and taking more than 'interval' time, the
509
# client would inevitably timeout, since no checker would get
510
# a chance to run to completion. If we instead leave running
1021
511
# checkers alone, the checker would have to take more time
1022
512
# than 'timeout' for the client to be disabled, which is as it
1023
513
# should be.
1024
514
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
515
# If a checker exists, make sure it is not a zombie
516
try:
517
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
518
except (AttributeError, OSError) as error:
519
if (isinstance(error, OSError)
520
and error.errno != errno.ECHILD):
521
raise error
522
else:
523
if pid:
524
logger.warning("Checker was a zombie")
525
gobject.source_remove(self.checker_callback_tag)
526
self.checker_callback(pid, status,
527
self.current_checker_command)
1029
528
# Start a new checker if needed
1030
529
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 }
1035
530
try:
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
531
# In case checker_command has exactly one % operator
532
command = self.checker_command % self.host
533
except TypeError:
534
# Escape attributes for the shell
535
escaped_attrs = dict(
536
(attr,
537
re.escape(unicode(str(getattr(self, attr, "")),
538
errors=
539
'replace')))
540
for attr in
541
self.runtime_expansions)
542
543
try:
544
command = self.checker_command % escaped_attrs
545
except TypeError as error:
546
logger.error('Could not format string "%s":'
547
' %s', self.checker_command, error)
548
return True # Try again later
1042
549
self.current_checker_command = command
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
550
try:
551
logger.info("Starting checker %r for %s",
552
command, self.name)
553
# We don't need to redirect stdout and stderr, since
554
# in normal mode, that is already done by daemon(),
555
# and in debug mode we don't want to. (Stdin is
556
# always replaced by /dev/null.)
557
self.checker = subprocess.Popen(command,
558
close_fds=True,
559
shell=True, cwd="/")
560
self.checker_callback_tag = (gobject.child_watch_add
561
(self.checker.pid,
562
self.checker_callback,
563
data=command))
564
# The checker may have completed before the gobject
565
# watch was added. Check for this.
566
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
567
if pid:
568
gobject.source_remove(self.checker_callback_tag)
569
self.checker_callback(pid, status, command)
570
except OSError as error:
571
logger.error("Failed to start subprocess: %s",
572
error)
573
# Re-run this periodically if run by gobject.timeout_add
1069
574
return True
1070
575
1071
576
def stop_checker(self):
1072
577
"""Force the checker process, if any, to stop."""
1073
578
if self.checker_callback_tag:
1074
GObject.source_remove(self.checker_callback_tag)
579
gobject.source_remove(self.checker_callback_tag)
1075
580
self.checker_callback_tag = None
1076
581
if getattr(self, "checker", None) is None:
1077
582
return
1078
583
logger.debug("Stopping checker for %(name)s", vars(self))
1079
self.checker.terminate()
584
try:
585
os.kill(self.checker.pid, signal.SIGTERM)
586
#time.sleep(0.5)
587
#if self.checker.poll() is None:
588
# os.kill(self.checker.pid, signal.SIGKILL)
589
except OSError as error:
590
if error.errno != errno.ESRCH: # No such process
591
raise
1080
592
self.checker = None
1081
593
1082
1083
def dbus_service_property(dbus_interface,
1084
signature="v",
1085
access="readwrite",
1086
byte_arrays=False):
594
# Encrypts a client secret and stores it in a varible encrypted_secret
595
def encrypt_secret(self, key):
596
# Encryption-key need to be of a specific size, so we hash inputed key
597
hasheng = hashlib.sha256()
598
hasheng.update(key)
599
encryptionkey = hasheng.digest()
600
601
# Create validation hash so we know at decryption if it was sucessful
602
hasheng = hashlib.sha256()
603
hasheng.update(self.secret)
604
validationhash = hasheng.digest()
605
606
# Encrypt secret
607
iv = os.urandom(Crypto.Cipher.AES.block_size)
608
ciphereng = Crypto.Cipher.AES.new(encryptionkey,
609
Crypto.Cipher.AES.MODE_CFB, iv)
610
ciphertext = ciphereng.encrypt(validationhash+self.secret)
611
self.encrypted_secret = (ciphertext, iv)
612
613
# Decrypt a encrypted client secret
614
def decrypt_secret(self, key):
615
# Decryption-key need to be of a specific size, so we hash inputed key
616
hasheng = hashlib.sha256()
617
hasheng.update(key)
618
encryptionkey = hasheng.digest()
619
620
# Decrypt encrypted secret
621
ciphertext, iv = self.encrypted_secret
622
ciphereng = Crypto.Cipher.AES.new(encryptionkey,
623
Crypto.Cipher.AES.MODE_CFB, iv)
624
plain = ciphereng.decrypt(ciphertext)
625
626
# Validate decrypted secret to know if it was succesful
627
hasheng = hashlib.sha256()
628
validationhash = plain[:hasheng.digest_size]
629
secret = plain[hasheng.digest_size:]
630
hasheng.update(secret)
631
632
# if validation fails, we use key as new secret. Otherwhise, we use
633
# the decrypted secret
634
if hasheng.digest() == validationhash:
635
self.secret = secret
636
else:
637
self.secret = key
638
del self.encrypted_secret
639
640
641
def dbus_service_property(dbus_interface, signature="v",
642
access="readwrite", byte_arrays=False):
1087
643
"""Decorators for marking methods of a DBusObjectWithProperties to
1088
644
become properties on the D-Bus.
1089
645
1098
654
# "Set" method, so we fail early here:
1099
655
if byte_arrays and signature != "ay":
1100
656
raise ValueError("Byte arrays not supported for non-'ay'"
1101
" signature {!r}".format(signature))
1102
657
" signature %r" % signature)
1103
658
def decorator(func):
1104
659
func._dbus_is_property = True
1105
660
func._dbus_interface = dbus_interface
1110
665
func._dbus_name = func._dbus_name[:-14]
1111
666
func._dbus_get_args_options = {'byte_arrays': byte_arrays }
1112
667
return func
1113
1114
return decorator
1115
1116
1117
def dbus_interface_annotations(dbus_interface):
1118
"""Decorator for marking functions returning interface annotations
1119
1120
Usage:
1121
1122
@dbus_interface_annotations("org.example.Interface")
1123
def _foo(self): # Function name does not matter
1124
return {"org.freedesktop.DBus.Deprecated": "true",
1125
"org.freedesktop.DBus.Property.EmitsChangedSignal":
1126
"false"}
1127
"""
1128
1129
def decorator(func):
1130
func._dbus_is_interface = True
1131
func._dbus_interface = dbus_interface
1132
func._dbus_name = dbus_interface
1133
return func
1134
1135
return decorator
1136
1137
1138
def dbus_annotations(annotations):
1139
"""Decorator to annotate D-Bus methods, signals or properties
1140
Usage:
1141
1142
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
1143
"org.freedesktop.DBus.Property."
1144
"EmitsChangedSignal": "false"})
1145
@dbus_service_property("org.example.Interface", signature="b",
1146
access="r")
1147
def Property_dbus_property(self):
1148
return dbus.Boolean(False)
1149
1150
See also the DBusObjectWithAnnotations class.
1151
"""
1152
1153
def decorator(func):
1154
func._dbus_annotations = annotations
1155
return func
1156
1157
668
return decorator
1158
669
1159
670
1160
671
class DBusPropertyException(dbus.exceptions.DBusException):
1161
672
"""A base class for D-Bus property-related exceptions
1162
673
"""
1163
pass
674
def __unicode__(self):
675
return unicode(str(self))
1164
676
1165
677
1166
678
class DBusPropertyAccessException(DBusPropertyException):
1175
687
pass
1176
688
1177
689
1178
class DBusObjectWithAnnotations(dbus.service.Object):
1179
"""A D-Bus object with annotations.
1180
1181
Classes inheriting from this can use the dbus_annotations
1182
decorator to add annotations to methods or signals.
1183
"""
1184
1185
@staticmethod
1186
def _is_dbus_thing(thing):
1187
"""Returns a function testing if an attribute is a D-Bus thing
1188
1189
If called like _is_dbus_thing("method") it returns a function
1190
suitable for use as predicate to inspect.getmembers().
1191
"""
1192
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
1193
False)
1194
1195
def _get_all_dbus_things(self, thing):
1196
"""Returns a generator of (name, attribute) pairs
1197
"""
1198
return ((getattr(athing.__get__(self), "_dbus_name", name),
1199
athing.__get__(self))
1200
for cls in self.__class__.__mro__
1201
for name, athing in
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):
690
class DBusObjectWithProperties(dbus.service.Object):
1268
691
"""A D-Bus object with properties.
1269
692
1270
693
Classes inheriting from this can use the dbus_service_property
1272
695
standard Get(), Set(), and GetAll() methods on the D-Bus.
1273
696
"""
1274
697
698
@staticmethod
699
def _is_dbus_property(obj):
700
return getattr(obj, "_dbus_is_property", False)
701
702
def _get_all_dbus_properties(self):
703
"""Returns a generator of (name, attribute) pairs
704
"""
705
return ((prop.__get__(self)._dbus_name, prop.__get__(self))
706
for cls in self.__class__.__mro__
707
for name, prop in
708
inspect.getmembers(cls, self._is_dbus_property))
709
1275
710
def _get_dbus_property(self, interface_name, property_name):
1276
711
"""Returns a bound method if one exists which is a D-Bus
1277
712
property with the specified name and interface.
1278
713
"""
1279
for cls in self.__class__.__mro__:
1280
for name, value in inspect.getmembers(
1281
cls, self._is_dbus_thing("property")):
714
for cls in self.__class__.__mro__:
715
for name, value in (inspect.getmembers
716
(cls, self._is_dbus_property)):
1282
717
if (value._dbus_name == property_name
1283
718
and value._dbus_interface == interface_name):
1284
719
return value.__get__(self)
1285
720
1286
721
# No such property
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",
722
raise DBusPropertyNotFound(self.dbus_object_path + ":"
723
+ interface_name + "."
724
+ property_name)
725
726
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
1301
727
out_signature="v")
1302
728
def Get(self, interface_name, property_name):
1303
729
"""Standard D-Bus property Get() method, see D-Bus standard.
1321
747
# The byte_arrays option is not supported yet on
1322
748
# signatures other than "ay".
1323
749
if prop._dbus_signature != "ay":
1324
raise ValueError("Byte arrays not supported for non-"
1325
"'ay' signature {!r}"
1326
.format(prop._dbus_signature))
1327
value = dbus.ByteArray(b''.join(chr(byte)
1328
for byte in value))
750
raise ValueError
751
value = dbus.ByteArray(''.join(unichr(byte)
752
for byte in value))
1329
753
prop(value)
1330
754
1331
@dbus.service.method(dbus.PROPERTIES_IFACE,
1332
in_signature="s",
755
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
1333
756
out_signature="a{sv}")
1334
757
def GetAll(self, interface_name):
1335
758
"""Standard D-Bus property GetAll() method, see D-Bus
1337
760
1338
761
Note: Will not include properties with access="write".
1339
762
"""
1340
properties = {}
1341
for name, prop in self._get_all_dbus_things("property"):
763
all = {}
764
for name, prop in self._get_all_dbus_properties():
1342
765
if (interface_name
1343
766
and interface_name != prop._dbus_interface):
1344
767
# Interface non-empty but did not match
1348
771
continue
1349
772
value = prop()
1350
773
if not hasattr(value, "variant_level"):
1351
properties[name] = value
774
all[name] = value
1352
775
continue
1353
properties[name] = type(value)(
1354
value, variant_level = value.variant_level + 1)
1355
return dbus.Dictionary(properties, signature="sv")
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
776
all[name] = type(value)(value, variant_level=
777
value.variant_level+1)
778
return dbus.Dictionary(all, signature="sv")
1364
779
1365
780
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1366
781
out_signature="s",
1367
782
path_keyword='object_path',
1368
783
connection_keyword='connection')
1369
784
def Introspect(self, object_path, connection):
1370
"""Overloading of standard D-Bus method.
1371
1372
Inserts property tags and interface annotation tags.
785
"""Standard D-Bus method, overloaded to insert property tags.
1373
786
"""
1374
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1375
object_path,
1376
connection)
787
xmlstring = dbus.service.Object.Introspect(self, object_path,
788
connection)
1377
789
try:
1378
790
document = xml.dom.minidom.parseString(xmlstring)
1379
1380
791
def make_tag(document, name, prop):
1381
792
e = document.createElement("property")
1382
793
e.setAttribute("name", name)
1383
794
e.setAttribute("type", prop._dbus_signature)
1384
795
e.setAttribute("access", prop._dbus_access)
1385
796
return e
1386
1387
797
for if_tag in document.getElementsByTagName("interface"):
1388
# Add property tags
1389
798
for tag in (make_tag(document, name, prop)
1390
799
for name, prop
1391
in self._get_all_dbus_things("property")
800
in self._get_all_dbus_properties()
1392
801
if prop._dbus_interface
1393
802
== if_tag.getAttribute("name")):
1394
803
if_tag.appendChild(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)
1411
804
# Add the names to the return values for the
1412
805
# "org.freedesktop.DBus.Properties" methods
1413
806
if (if_tag.getAttribute("name")
1428
821
except (AttributeError, xml.dom.DOMException,
1429
822
xml.parsers.expat.ExpatError) as error:
1430
823
logger.error("Failed to override Introspection method",
1431
exc_info=error)
1432
return xmlstring
1433
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):
824
error)
825
return xmlstring
826
827
828
def datetime_to_dbus (dt, variant_level=0):
1504
829
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1505
830
if dt is None:
1506
831
return dbus.String("", variant_level = variant_level)
1507
return dbus.String(dt.isoformat(), variant_level=variant_level)
1508
1509
1510
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1511
"""A class decorator; applied to a subclass of
1512
dbus.service.Object, it will add alternate D-Bus attributes with
1513
interface names according to the "alt_interface_names" mapping.
1514
Usage:
1515
1516
@alternate_dbus_interfaces({"org.example.Interface":
1517
"net.example.AlternateInterface"})
1518
class SampleDBusObject(dbus.service.Object):
1519
@dbus.service.method("org.example.Interface")
1520
def SampleDBusMethod():
1521
pass
1522
1523
The above "SampleDBusMethod" on "SampleDBusObject" will be
1524
reachable via two interfaces: "org.example.Interface" and
1525
"net.example.AlternateInterface", the latter of which will have
1526
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1527
"true", unless "deprecate" is passed with a False value.
1528
1529
This works for methods and signals, and also for D-Bus properties
1530
(from DBusObjectWithProperties) and interfaces (from the
1531
dbus_interface_annotations decorator).
832
return dbus.String(dt.isoformat(),
833
variant_level=variant_level)
834
835
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
836
.__metaclass__):
837
"""Applied to an empty subclass of a D-Bus object, this metaclass
838
will add additional D-Bus attributes matching a certain pattern.
1532
839
"""
1533
1534
def wrapper(cls):
1535
for orig_interface_name, alt_interface_name in (
1536
alt_interface_names.items()):
1537
attr = {}
1538
interface_names = set()
1539
# Go though all attributes of the class
1540
for attrname, attribute in inspect.getmembers(cls):
840
def __new__(mcs, name, bases, attr):
841
# Go through all the base classes which could have D-Bus
842
# methods, signals, or properties in them
843
for base in (b for b in bases
844
if issubclass(b, dbus.service.Object)):
845
# Go though all attributes of the base class
846
for attrname, attribute in inspect.getmembers(base):
1541
847
# Ignore non-D-Bus attributes, and D-Bus attributes
1542
848
# with the wrong interface name
1543
849
if (not hasattr(attribute, "_dbus_interface")
1544
or not attribute._dbus_interface.startswith(
1545
orig_interface_name)):
850
or not attribute._dbus_interface
851
.startswith("se.recompile.Mandos")):
1546
852
continue
1547
853
# Create an alternate D-Bus interface name based on
1548
854
# the current name
1549
alt_interface = attribute._dbus_interface.replace(
1550
orig_interface_name, alt_interface_name)
1551
interface_names.add(alt_interface)
855
alt_interface = (attribute._dbus_interface
856
.replace("se.recompile.Mandos",
857
"se.bsnet.fukt.Mandos"))
1552
858
# Is this a D-Bus signal?
1553
859
if getattr(attribute, "_dbus_is_signal", False):
1554
# Extract the original non-method undecorated
1555
# function by black magic
1556
if sys.version_info.major == 2:
1557
nonmethod_func = (dict(
860
# Extract the original non-method function by
861
# black magic
862
nonmethod_func = (dict(
1558
863
zip(attribute.func_code.co_freevars,
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)
864
attribute.__closure__))["func"]
865
.cell_contents)
1566
866
# Create a new, but exactly alike, function
1567
867
# object, and decorate it to be a new D-Bus signal
1568
868
# with the alternate D-Bus interface name
1569
new_function = copy_function(nonmethod_func)
1570
new_function = (dbus.service.signal(
1571
alt_interface,
1572
attribute._dbus_signature)(new_function))
1573
# Copy annotations, if any
1574
try:
1575
new_function._dbus_annotations = dict(
1576
attribute._dbus_annotations)
1577
except AttributeError:
1578
pass
869
new_function = (dbus.service.signal
870
(alt_interface,
871
attribute._dbus_signature)
872
(types.FunctionType(
873
nonmethod_func.func_code,
874
nonmethod_func.func_globals,
875
nonmethod_func.func_name,
876
nonmethod_func.func_defaults,
877
nonmethod_func.func_closure)))
1579
878
# Define a creator of a function to call both the
1580
# original and alternate functions, so both the
1581
# original and alternate signals gets sent when
1582
# the function is called
879
# old and new functions, so both the old and new
880
# signals gets sent when the function is called
1583
881
def fixscope(func1, func2):
1584
882
"""This function is a scope container to pass
1585
883
func1 and func2 to the "call_both" function
1586
884
outside of its arguments"""
1587
1588
@functools.wraps(func2)
1589
885
def call_both(*args, **kwargs):
1590
886
"""This function will emit two D-Bus
1591
887
signals by calling func1 and func2"""
1592
888
func1(*args, **kwargs)
1593
889
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
1599
890
return call_both
1600
891
# Create the "call_both" function and add it to
1601
892
# the class
1602
attr[attrname] = fixscope(attribute, new_function)
893
attr[attrname] = fixscope(attribute,
894
new_function)
1603
895
# Is this a D-Bus method?
1604
896
elif getattr(attribute, "_dbus_is_method", False):
1605
897
# Create a new, but exactly alike, function
1606
898
# object. Decorate it to be a new D-Bus method
1607
899
# with the alternate D-Bus interface name. Add it
1608
900
# to the class.
1609
attr[attrname] = (
1610
dbus.service.method(
1611
alt_interface,
1612
attribute._dbus_in_signature,
1613
attribute._dbus_out_signature)
1614
(copy_function(attribute)))
1615
# Copy annotations, if any
1616
try:
1617
attr[attrname]._dbus_annotations = dict(
1618
attribute._dbus_annotations)
1619
except AttributeError:
1620
pass
901
attr[attrname] = (dbus.service.method
902
(alt_interface,
903
attribute._dbus_in_signature,
904
attribute._dbus_out_signature)
905
(types.FunctionType
906
(attribute.func_code,
907
attribute.func_globals,
908
attribute.func_name,
909
attribute.func_defaults,
910
attribute.func_closure)))
1621
911
# Is this a D-Bus property?
1622
912
elif getattr(attribute, "_dbus_is_property", False):
1623
913
# Create a new, but exactly alike, function
1624
914
# object, and decorate it to be a new D-Bus
1625
915
# property with the alternate D-Bus interface
1626
916
# name. Add it to the class.
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)))
1633
# Copy annotations, if any
1634
try:
1635
attr[attrname]._dbus_annotations = dict(
1636
attribute._dbus_annotations)
1637
except AttributeError:
1638
pass
1639
# Is this a D-Bus interface?
1640
elif getattr(attribute, "_dbus_is_interface", False):
1641
# Create a new, but exactly alike, function
1642
# object. Decorate it to be a new D-Bus interface
1643
# with the alternate D-Bus interface name. Add it
1644
# to the class.
1645
attr[attrname] = (
1646
dbus_interface_annotations(alt_interface)
1647
(copy_function(attribute)))
1648
if deprecate:
1649
# Deprecate all alternate interfaces
1650
iname="_AlternateDBusNames_interface_annotation{}"
1651
for interface_name in interface_names:
1652
1653
@dbus_interface_annotations(interface_name)
1654
def func(self):
1655
return { "org.freedesktop.DBus.Deprecated":
1656
"true" }
1657
# Find an unused name
1658
for aname in (iname.format(i)
1659
for i in itertools.count()):
1660
if aname not in attr:
1661
attr[aname] = func
1662
break
1663
if interface_names:
1664
# Replace the class with a new subclass of it with
1665
# methods, signals, etc. as created above.
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)
1672
return cls
1673
1674
return wrapper
1675
1676
1677
@alternate_dbus_interfaces({"se.recompile.Mandos":
1678
"se.bsnet.fukt.Mandos"})
917
attr[attrname] = (dbus_service_property
918
(alt_interface,
919
attribute._dbus_signature,
920
attribute._dbus_access,
921
attribute
922
._dbus_get_args_options
923
["byte_arrays"])
924
(types.FunctionType
925
(attribute.func_code,
926
attribute.func_globals,
927
attribute.func_name,
928
attribute.func_defaults,
929
attribute.func_closure)))
930
return type.__new__(mcs, name, bases, attr)
931
1679
932
class ClientDBus(Client, DBusObjectWithProperties):
1680
933
"""A Client class using D-Bus
1681
934
1685
938
"""
1686
939
1687
940
runtime_expansions = (Client.runtime_expansions
1688
+ ("dbus_object_path", ))
1689
1690
_interface = "se.recompile.Mandos.Client"
941
+ ("dbus_object_path",))
1691
942
1692
943
# dbus.service.Object doesn't use super(), so we can't either.
1693
944
1694
945
def __init__(self, bus = None, *args, **kwargs):
1695
946
self.bus = bus
1696
947
Client.__init__(self, *args, **kwargs)
948
949
self._approvals_pending = 0
1697
950
# Only now, when this client is initialized, can it show up on
1698
951
# the D-Bus
1699
client_object_name = str(self.name).translate(
952
client_object_name = unicode(self.name).translate(
1700
953
{ord("."): ord("_"),
1701
954
ord("-"): ord("_")})
1702
self.dbus_object_path = dbus.ObjectPath(
1703
"/clients/" + client_object_name)
955
self.dbus_object_path = (dbus.ObjectPath
956
("/clients/" + client_object_name))
1704
957
DBusObjectWithProperties.__init__(self, self.bus,
1705
958
self.dbus_object_path)
1706
1707
def notifychangeproperty(transform_func, dbus_name,
1708
type_func=lambda x: x,
1709
variant_level=1,
1710
invalidate_only=False,
1711
_interface=_interface):
959
960
def notifychangeproperty(transform_func,
961
dbus_name, type_func=lambda x: x,
962
variant_level=1):
1712
963
""" Modify a variable so that it's a property which announces
1713
964
its changes to DBus.
1714
965
1715
966
transform_fun: Function that takes a value and a variant_level
1716
967
and transforms it to a D-Bus type.
1717
968
dbus_name: D-Bus name of the variable
1719
970
to the D-Bus. Default: no transform
1720
971
variant_level: D-Bus variant level. Default: 1
1721
972
"""
1722
attrname = "_{}".format(dbus_name)
1723
973
attrname = "_{0}".format(dbus_name)
1724
974
def setter(self, value):
1725
975
if hasattr(self, "dbus_object_path"):
1726
976
if (not hasattr(self, attrname) or
1727
977
type_func(getattr(self, attrname, None))
1728
978
!= type_func(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())
979
dbus_value = transform_func(type_func(value),
980
variant_level
981
=variant_level)
982
self.PropertyChanged(dbus.String(dbus_name),
983
dbus_value)
1744
984
setattr(self, attrname, value)
1745
985
1746
986
return property(lambda self: getattr(self, attrname), setter)
1747
987
988
1748
989
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1749
990
approvals_pending = notifychangeproperty(dbus.Boolean,
1750
991
"ApprovalPending",
1752
993
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1753
994
last_enabled = notifychangeproperty(datetime_to_dbus,
1754
995
"LastEnabled")
1755
checker = notifychangeproperty(
1756
dbus.Boolean, "CheckerRunning",
1757
type_func = lambda checker: checker is not None)
996
checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
997
type_func = lambda checker:
998
checker is not None)
1758
999
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1759
1000
"LastCheckedOK")
1760
last_checker_status = notifychangeproperty(dbus.Int16,
1761
"LastCheckerStatus")
1762
1001
last_approval_request = notifychangeproperty(
1763
1002
datetime_to_dbus, "LastApprovalRequest")
1764
1003
approved_by_default = notifychangeproperty(dbus.Boolean,
1765
1004
"ApprovedByDefault")
1766
approval_delay = notifychangeproperty(
1767
dbus.UInt64, "ApprovalDelay",
1768
type_func = lambda td: td.total_seconds() * 1000)
1005
approval_delay = notifychangeproperty(dbus.UInt16,
1006
"ApprovalDelay",
1007
type_func =
1008
_timedelta_to_milliseconds)
1769
1009
approval_duration = notifychangeproperty(
1770
dbus.UInt64, "ApprovalDuration",
1771
type_func = lambda td: td.total_seconds() * 1000)
1010
dbus.UInt16, "ApprovalDuration",
1011
type_func = _timedelta_to_milliseconds)
1772
1012
host = notifychangeproperty(dbus.String, "Host")
1773
timeout = notifychangeproperty(
1774
dbus.UInt64, "Timeout",
1775
type_func = lambda td: td.total_seconds() * 1000)
1013
timeout = notifychangeproperty(dbus.UInt16, "Timeout",
1014
type_func =
1015
_timedelta_to_milliseconds)
1776
1016
extended_timeout = notifychangeproperty(
1777
dbus.UInt64, "ExtendedTimeout",
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)
1017
dbus.UInt16, "ExtendedTimeout",
1018
type_func = _timedelta_to_milliseconds)
1019
interval = notifychangeproperty(dbus.UInt16,
1020
"Interval",
1021
type_func =
1022
_timedelta_to_milliseconds)
1782
1023
checker_command = notifychangeproperty(dbus.String, "Checker")
1783
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1784
invalidate_only=True)
1785
1024
1786
1025
del notifychangeproperty
1787
1026
1794
1033
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1795
1034
Client.__del__(self, *args, **kwargs)
1796
1035
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:
1036
def checker_callback(self, pid, condition, command,
1037
*args, **kwargs):
1038
self.checker_callback_tag = None
1039
self.checker = None
1040
if os.WIFEXITED(condition):
1041
exitstatus = os.WEXITSTATUS(condition)
1804
1042
# Emit D-Bus signal
1805
1043
self.CheckerCompleted(dbus.Int16(exitstatus),
1806
# This is specific to GNU libC
1807
dbus.Int64(exitstatus << 8),
1044
dbus.Int64(condition),
1808
1045
dbus.String(command))
1809
1046
else:
1810
1047
# Emit D-Bus signal
1811
1048
self.CheckerCompleted(dbus.Int16(-1),
1812
dbus.Int64(
1813
# This is specific to GNU libC
1814
(exitstatus << 8)
1815
| self.last_checker_signal),
1049
dbus.Int64(condition),
1816
1050
dbus.String(command))
1817
return ret
1051
1052
return Client.checker_callback(self, pid, condition, command,
1053
*args, **kwargs)
1818
1054
1819
1055
def start_checker(self, *args, **kwargs):
1820
old_checker_pid = getattr(self.checker, "pid", None)
1056
old_checker = self.checker
1057
if self.checker is not None:
1058
old_checker_pid = self.checker.pid
1059
else:
1060
old_checker_pid = None
1821
1061
r = Client.start_checker(self, *args, **kwargs)
1822
1062
# Only if new checker process was started
1823
1063
if (self.checker is not None
1827
1067
return r
1828
1068
1829
1069
def _reset_approved(self):
1830
self.approved = None
1070
self._approved = None
1831
1071
return False
1832
1072
1833
1073
def approve(self, value=True):
1834
self.approved = value
1835
GObject.timeout_add(int(self.approval_duration.total_seconds()
1836
* 1000), self._reset_approved)
1837
1074
self.send_changedstate()
1075
self._approved = value
1076
gobject.timeout_add(_timedelta_to_milliseconds
1077
(self.approval_duration),
1078
self._reset_approved)
1079
1838
1080
1839
1081
## D-Bus methods, signals & properties
1840
1841
## Interfaces
1082
_interface = "se.recompile.Mandos.Client"
1842
1083
1843
1084
## Signals
1844
1085
1855
1096
pass
1856
1097
1857
1098
# PropertyChanged - signal
1858
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1859
1099
@dbus.service.signal(_interface, signature="sv")
1860
1100
def PropertyChanged(self, property, value):
1861
1101
"D-Bus signal"
1895
1135
self.checked_ok()
1896
1136
1897
1137
# Enable - method
1898
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1899
1138
@dbus.service.method(_interface)
1900
1139
def Enable(self):
1901
1140
"D-Bus method"
1902
1141
self.enable()
1903
1142
1904
1143
# StartChecker - method
1905
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1906
1144
@dbus.service.method(_interface)
1907
1145
def StartChecker(self):
1908
1146
"D-Bus method"
1909
1147
self.start_checker()
1910
1148
1911
1149
# Disable - method
1912
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1913
1150
@dbus.service.method(_interface)
1914
1151
def Disable(self):
1915
1152
"D-Bus method"
1916
1153
self.disable()
1917
1154
1918
1155
# StopChecker - method
1919
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1920
1156
@dbus.service.method(_interface)
1921
1157
def StopChecker(self):
1922
1158
self.stop_checker()
1929
1165
return dbus.Boolean(bool(self.approvals_pending))
1930
1166
1931
1167
# ApprovedByDefault - property
1932
@dbus_service_property(_interface,
1933
signature="b",
1168
@dbus_service_property(_interface, signature="b",
1934
1169
access="readwrite")
1935
1170
def ApprovedByDefault_dbus_property(self, value=None):
1936
1171
if value is None: # get
1938
1173
self.approved_by_default = bool(value)
1939
1174
1940
1175
# ApprovalDelay - property
1941
@dbus_service_property(_interface,
1942
signature="t",
1176
@dbus_service_property(_interface, signature="t",
1943
1177
access="readwrite")
1944
1178
def ApprovalDelay_dbus_property(self, value=None):
1945
1179
if value is None: # get
1946
return dbus.UInt64(self.approval_delay.total_seconds()
1947
* 1000)
1180
return dbus.UInt64(self.approval_delay_milliseconds())
1948
1181
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1949
1182
1950
1183
# ApprovalDuration - property
1951
@dbus_service_property(_interface,
1952
signature="t",
1184
@dbus_service_property(_interface, signature="t",
1953
1185
access="readwrite")
1954
1186
def ApprovalDuration_dbus_property(self, value=None):
1955
1187
if value is None: # get
1956
return dbus.UInt64(self.approval_duration.total_seconds()
1957
* 1000)
1188
return dbus.UInt64(_timedelta_to_milliseconds(
1189
self.approval_duration))
1958
1190
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1959
1191
1960
1192
# Name - property
1961
@dbus_annotations(
1962
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1963
1193
@dbus_service_property(_interface, signature="s", access="read")
1964
1194
def Name_dbus_property(self):
1965
1195
return dbus.String(self.name)
1966
1196
1967
1197
# Fingerprint - property
1968
@dbus_annotations(
1969
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1970
1198
@dbus_service_property(_interface, signature="s", access="read")
1971
1199
def Fingerprint_dbus_property(self):
1972
1200
return dbus.String(self.fingerprint)
1973
1201
1974
1202
# Host - property
1975
@dbus_service_property(_interface,
1976
signature="s",
1203
@dbus_service_property(_interface, signature="s",
1977
1204
access="readwrite")
1978
1205
def Host_dbus_property(self, value=None):
1979
1206
if value is None: # get
1980
1207
return dbus.String(self.host)
1981
self.host = str(value)
1208
self.host = value
1982
1209
1983
1210
# Created - property
1984
@dbus_annotations(
1985
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1986
1211
@dbus_service_property(_interface, signature="s", access="read")
1987
1212
def Created_dbus_property(self):
1988
return datetime_to_dbus(self.created)
1213
return dbus.String(datetime_to_dbus(self.created))
1989
1214
1990
1215
# LastEnabled - property
1991
1216
@dbus_service_property(_interface, signature="s", access="read")
1993
1218
return datetime_to_dbus(self.last_enabled)
1994
1219
1995
1220
# Enabled - property
1996
@dbus_service_property(_interface,
1997
signature="b",
1221
@dbus_service_property(_interface, signature="b",
1998
1222
access="readwrite")
1999
1223
def Enabled_dbus_property(self, value=None):
2000
1224
if value is None: # get
2005
1229
self.disable()
2006
1230
2007
1231
# LastCheckedOK - property
2008
@dbus_service_property(_interface,
2009
signature="s",
1232
@dbus_service_property(_interface, signature="s",
2010
1233
access="readwrite")
2011
1234
def LastCheckedOK_dbus_property(self, value=None):
2012
1235
if value is not None:
2014
1237
return
2015
1238
return datetime_to_dbus(self.last_checked_ok)
2016
1239
2017
# LastCheckerStatus - property
2018
@dbus_service_property(_interface, signature="n", access="read")
2019
def LastCheckerStatus_dbus_property(self):
2020
return dbus.Int16(self.last_checker_status)
2021
2022
1240
# Expires - property
2023
1241
@dbus_service_property(_interface, signature="s", access="read")
2024
1242
def Expires_dbus_property(self):
2030
1248
return datetime_to_dbus(self.last_approval_request)
2031
1249
2032
1250
# Timeout - property
2033
@dbus_service_property(_interface,
2034
signature="t",
1251
@dbus_service_property(_interface, signature="t",
2035
1252
access="readwrite")
2036
1253
def Timeout_dbus_property(self, value=None):
2037
1254
if value is None: # get
2038
return dbus.UInt64(self.timeout.total_seconds() * 1000)
2039
old_timeout = self.timeout
1255
return dbus.UInt64(self.timeout_milliseconds())
2040
1256
self.timeout = datetime.timedelta(0, 0, 0, value)
2041
# Reschedule disabling
2042
if self.enabled:
2043
now = datetime.datetime.utcnow()
2044
self.expires += self.timeout - old_timeout
2045
if self.expires <= now:
2046
# The timeout has passed
2047
self.disable()
2048
else:
2049
if (getattr(self, "disable_initiator_tag", None)
2050
is None):
2051
return
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)
1257
if getattr(self, "disable_initiator_tag", None) is None:
1258
return
1259
# Reschedule timeout
1260
gobject.source_remove(self.disable_initiator_tag)
1261
self.disable_initiator_tag = None
1262
self.expires = None
1263
time_to_die = _timedelta_to_milliseconds((self
1264
.last_checked_ok
1265
+ self.timeout)
1266
- datetime.datetime
1267
.utcnow())
1268
if time_to_die <= 0:
1269
# The timeout has passed
1270
self.disable()
1271
else:
1272
self.expires = (datetime.datetime.utcnow()
1273
+ datetime.timedelta(milliseconds =
1274
time_to_die))
1275
self.disable_initiator_tag = (gobject.timeout_add
1276
(time_to_die, self.disable))
2056
1277
2057
1278
# ExtendedTimeout - property
2058
@dbus_service_property(_interface,
2059
signature="t",
1279
@dbus_service_property(_interface, signature="t",
2060
1280
access="readwrite")
2061
1281
def ExtendedTimeout_dbus_property(self, value=None):
2062
1282
if value is None: # get
2063
return dbus.UInt64(self.extended_timeout.total_seconds()
2064
* 1000)
1283
return dbus.UInt64(self.extended_timeout_milliseconds())
2065
1284
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
2066
1285
2067
1286
# Interval - property
2068
@dbus_service_property(_interface,
2069
signature="t",
1287
@dbus_service_property(_interface, signature="t",
2070
1288
access="readwrite")
2071
1289
def Interval_dbus_property(self, value=None):
2072
1290
if value is None: # get
2073
return dbus.UInt64(self.interval.total_seconds() * 1000)
1291
return dbus.UInt64(self.interval_milliseconds())
2074
1292
self.interval = datetime.timedelta(0, 0, 0, value)
2075
1293
if getattr(self, "checker_initiator_tag", None) is None:
2076
1294
return
2077
if self.enabled:
2078
# Reschedule checker run
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
1295
# Reschedule checker run
1296
gobject.source_remove(self.checker_initiator_tag)
1297
self.checker_initiator_tag = (gobject.timeout_add
1298
(value, self.start_checker))
1299
self.start_checker() # Start one now, too
2083
1300
2084
1301
# Checker - property
2085
@dbus_service_property(_interface,
2086
signature="s",
1302
@dbus_service_property(_interface, signature="s",
2087
1303
access="readwrite")
2088
1304
def Checker_dbus_property(self, value=None):
2089
1305
if value is None: # get
2090
1306
return dbus.String(self.checker_command)
2091
self.checker_command = str(value)
1307
self.checker_command = value
2092
1308
2093
1309
# CheckerRunning - property
2094
@dbus_service_property(_interface,
2095
signature="b",
1310
@dbus_service_property(_interface, signature="b",
2096
1311
access="readwrite")
2097
1312
def CheckerRunning_dbus_property(self, value=None):
2098
1313
if value is None: # get
2103
1318
self.stop_checker()
2104
1319
2105
1320
# ObjectPath - property
2106
@dbus_annotations(
2107
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
2108
"org.freedesktop.DBus.Deprecated": "true"})
2109
1321
@dbus_service_property(_interface, signature="o", access="read")
2110
1322
def ObjectPath_dbus_property(self):
2111
1323
return self.dbus_object_path # is already a dbus.ObjectPath
2112
1324
2113
1325
# Secret = property
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)
1326
@dbus_service_property(_interface, signature="ay",
1327
access="write", byte_arrays=True)
2121
1328
def Secret_dbus_property(self, value):
2122
self.secret = bytes(value)
1329
self.secret = str(value)
2123
1330
2124
1331
del _interface
2125
1332
2129
1336
self._pipe = child_pipe
2130
1337
self._pipe.send(('init', fpr, address))
2131
1338
if not self._pipe.recv():
2132
raise KeyError(fpr)
1339
raise KeyError()
2133
1340
2134
1341
def __getattribute__(self, name):
2135
if name == '_pipe':
1342
if(name == '_pipe'):
2136
1343
return super(ProxyClient, self).__getattribute__(name)
2137
1344
self._pipe.send(('getattr', name))
2138
1345
data = self._pipe.recv()
2139
1346
if data[0] == 'data':
2140
1347
return data[1]
2141
1348
if data[0] == 'function':
2142
2143
1349
def func(*args, **kwargs):
2144
1350
self._pipe.send(('funcall', name, args, kwargs))
2145
1351
return self._pipe.recv()[1]
2146
2147
1352
return func
2148
1353
2149
1354
def __setattr__(self, name, value):
2150
if name == '_pipe':
1355
if(name == '_pipe'):
2151
1356
return super(ProxyClient, self).__setattr__(name, value)
2152
1357
self._pipe.send(('setattr', name, value))
2153
1358
1359
class ClientDBusTransitional(ClientDBus):
1360
__metaclass__ = AlternateDBusNamesMetaclass
2154
1361
2155
1362
class ClientHandler(socketserver.BaseRequestHandler, object):
2156
1363
"""A class to handle client connections.
2161
1368
def handle(self):
2162
1369
with contextlib.closing(self.server.child_pipe) as child_pipe:
2163
1370
logger.info("TCP connection from: %s",
2164
str(self.client_address))
1371
unicode(self.client_address))
2165
1372
logger.debug("Pipe FD: %d",
2166
1373
self.server.child_pipe.fileno())
2167
1374
2168
session = gnutls.ClientSession(self.request)
1375
session = (gnutls.connection
1376
.ClientSession(self.request,
1377
gnutls.connection
1378
.X509Credentials()))
1379
1380
# Note: gnutls.connection.X509Credentials is really a
1381
# generic GnuTLS certificate credentials object so long as
1382
# no X.509 keys are added to it. Therefore, we can use it
1383
# here despite using OpenPGP certificates.
2169
1384
2170
1385
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
2171
1386
# "+AES-256-CBC", "+SHA1",
2175
1390
priority = self.server.gnutls_priority
2176
1391
if priority is None:
2177
1392
priority = "NORMAL"
2178
gnutls.priority_set_direct(session._c_object, priority,
2179
None)
1393
(gnutls.library.functions
1394
.gnutls_priority_set_direct(session._c_object,
1395
priority, None))
2180
1396
2181
1397
# Start communication using the Mandos protocol
2182
1398
# Get protocol number
2184
1400
logger.debug("Protocol version: %r", line)
2185
1401
try:
2186
1402
if int(line.strip().split()[0]) > 1:
2187
raise RuntimeError(line)
1403
raise RuntimeError
2188
1404
except (ValueError, IndexError, RuntimeError) as error:
2189
1405
logger.error("Unknown protocol version: %s", error)
2190
1406
return
2192
1408
# Start GnuTLS connection
2193
1409
try:
2194
1410
session.handshake()
2195
except gnutls.Error as error:
1411
except gnutls.errors.GNUTLSError as error:
2196
1412
logger.warning("Handshake failed: %s", error)
2197
1413
# Do not run session.bye() here: the session is not
2198
1414
# established. Just abandon the request.
2202
1418
approval_required = False
2203
1419
try:
2204
1420
try:
2205
fpr = self.fingerprint(
2206
self.peer_certificate(session))
2207
except (TypeError, gnutls.Error) as error:
1421
fpr = self.fingerprint(self.peer_certificate
1422
(session))
1423
except (TypeError,
1424
gnutls.errors.GNUTLSError) as error:
2208
1425
logger.warning("Bad certificate: %s", error)
2209
1426
return
2210
1427
logger.debug("Fingerprint: %s", fpr)
2223
1440
while True:
2224
1441
if not client.enabled:
2225
1442
logger.info("Client %s is disabled",
2226
client.name)
1443
client.name)
2227
1444
if self.server.use_dbus:
2228
1445
# Emit D-Bus signal
2229
1446
client.Rejected("Disabled")
2230
1447
return
2231
1448
2232
if client.approved or not client.approval_delay:
1449
if client._approved or not client.approval_delay:
2233
1450
#We are approved or approval is disabled
2234
1451
break
2235
elif client.approved is None:
1452
elif client._approved is None:
2236
1453
logger.info("Client %s needs approval",
2237
1454
client.name)
2238
1455
if self.server.use_dbus:
2239
1456
# Emit D-Bus signal
2240
1457
client.NeedApproval(
2241
client.approval_delay.total_seconds()
2242
* 1000, client.approved_by_default)
1458
client.approval_delay_milliseconds(),
1459
client.approved_by_default)
2243
1460
else:
2244
1461
logger.warning("Client %s was not approved",
2245
1462
client.name)
2251
1468
#wait until timeout or approved
2252
1469
time = datetime.datetime.now()
2253
1470
client.changedstate.acquire()
2254
client.changedstate.wait(delay.total_seconds())
1471
(client.changedstate.wait
1472
(float(client._timedelta_to_milliseconds(delay)
1473
/ 1000)))
2255
1474
client.changedstate.release()
2256
1475
time2 = datetime.datetime.now()
2257
1476
if (time2 - time) >= delay:
2268
1487
else:
2269
1488
delay -= time2 - time
2270
1489
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
1490
sent_size = 0
1491
while sent_size < len(client.secret):
1492
try:
1493
sent = session.send(client.secret[sent_size:])
1494
except gnutls.errors.GNUTLSError as error:
1495
logger.warning("gnutls send failed")
1496
return
1497
logger.debug("Sent: %d, remaining: %d",
1498
sent, len(client.secret)
1499
- (sent_size + sent))
1500
sent_size += sent
2277
1501
2278
1502
logger.info("Sending secret to %s", client.name)
2279
1503
# bump the timeout using extended_timeout
2280
client.bump_timeout(client.extended_timeout)
1504
client.checked_ok(client.extended_timeout)
2281
1505
if self.server.use_dbus:
2282
1506
# Emit D-Bus signal
2283
1507
client.GotSecret()
2287
1511
client.approvals_pending -= 1
2288
1512
try:
2289
1513
session.bye()
2290
except gnutls.Error as error:
2291
logger.warning("GnuTLS bye failed",
2292
exc_info=error)
1514
except gnutls.errors.GNUTLSError as error:
1515
logger.warning("GnuTLS bye failed")
2293
1516
2294
1517
@staticmethod
2295
1518
def peer_certificate(session):
2296
1519
"Return the peer's OpenPGP certificate as a bytestring"
2297
1520
# If not an OpenPGP certificate...
2298
if (gnutls.certificate_type_get(session._c_object)
2299
!= gnutls.CRT_OPENPGP):
2300
# ...return invalid data
2301
return b""
1521
if (gnutls.library.functions
1522
.gnutls_certificate_type_get(session._c_object)
1523
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1524
# ...do the normal thing
1525
return session.peer_certificate
2302
1526
list_size = ctypes.c_uint(1)
2303
cert_list = (gnutls.certificate_get_peers
1527
cert_list = (gnutls.library.functions
1528
.gnutls_certificate_get_peers
2304
1529
(session._c_object, ctypes.byref(list_size)))
2305
1530
if not bool(cert_list) and list_size.value != 0:
2306
raise gnutls.Error("error getting peer certificate")
1531
raise gnutls.errors.GNUTLSError("error getting peer"
1532
" certificate")
2307
1533
if list_size.value == 0:
2308
1534
return None
2309
1535
cert = cert_list[0]
2313
1539
def fingerprint(openpgp):
2314
1540
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
2315
1541
# New GnuTLS "datum" with the OpenPGP public key
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)))
1542
datum = (gnutls.library.types
1543
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1544
ctypes.POINTER
1545
(ctypes.c_ubyte)),
1546
ctypes.c_uint(len(openpgp))))
2320
1547
# New empty GnuTLS certificate
2321
crt = gnutls.openpgp_crt_t()
2322
gnutls.openpgp_crt_init(ctypes.byref(crt))
1548
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1549
(gnutls.library.functions
1550
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2323
1551
# Import the OpenPGP public key into the certificate
2324
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2325
gnutls.OPENPGP_FMT_RAW)
1552
(gnutls.library.functions
1553
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1554
gnutls.library.constants
1555
.GNUTLS_OPENPGP_FMT_RAW))
2326
1556
# Verify the self signature in the key
2327
1557
crtverify = ctypes.c_uint()
2328
gnutls.openpgp_crt_verify_self(crt, 0,
2329
ctypes.byref(crtverify))
1558
(gnutls.library.functions
1559
.gnutls_openpgp_crt_verify_self(crt, 0,
1560
ctypes.byref(crtverify)))
2330
1561
if crtverify.value != 0:
2331
gnutls.openpgp_crt_deinit(crt)
2332
raise gnutls.CertificateSecurityError("Verify failed")
1562
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1563
raise (gnutls.errors.CertificateSecurityError
1564
("Verify failed"))
2333
1565
# New buffer for the fingerprint
2334
1566
buf = ctypes.create_string_buffer(20)
2335
1567
buf_len = ctypes.c_size_t()
2336
1568
# Get the fingerprint from the certificate into the buffer
2337
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2338
ctypes.byref(buf_len))
1569
(gnutls.library.functions
1570
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1571
ctypes.byref(buf_len)))
2339
1572
# Deinit the certificate
2340
gnutls.openpgp_crt_deinit(crt)
1573
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2341
1574
# Convert the buffer to a Python bytestring
2342
1575
fpr = ctypes.string_at(buf, buf_len.value)
2343
1576
# Convert the bytestring to hexadecimal notation
2344
hex_fpr = binascii.hexlify(fpr).upper()
1577
hex_fpr = ''.join("%02X" % ord(char) for char in fpr)
2345
1578
return hex_fpr
2346
1579
2347
1580
2348
1581
class MultiprocessingMixIn(object):
2349
1582
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2350
2351
1583
def sub_process_main(self, request, address):
2352
1584
try:
2353
1585
self.finish_request(request, address)
2354
except Exception:
1586
except:
2355
1587
self.handle_error(request, address)
2356
1588
self.close_request(request)
2357
1589
2358
1590
def process_request(self, request, address):
2359
1591
"""Start a new process to process the request."""
2360
1592
proc = multiprocessing.Process(target = self.sub_process_main,
2361
args = (request, address))
1593
args = (request,
1594
address))
2362
1595
proc.start()
2363
1596
return proc
2364
1597
2365
1598
2366
1599
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2367
1600
""" adds a pipe to the MixIn """
2368
2369
1601
def process_request(self, request, client_address):
2370
1602
"""Overrides and wraps the original process_request().
2371
1603
2380
1612
2381
1613
def add_pipe(self, parent_pipe, proc):
2382
1614
"""Dummy function; override as necessary"""
2383
raise NotImplementedError()
1615
raise NotImplementedError
2384
1616
2385
1617
2386
1618
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2392
1624
interface: None or a network interface name (string)
2393
1625
use_ipv6: Boolean; to use IPv6 or not
2394
1626
"""
2395
2396
1627
def __init__(self, server_address, RequestHandlerClass,
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
"""
1628
interface=None, use_ipv6=True):
2403
1629
self.interface = interface
2404
1630
if use_ipv6:
2405
1631
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.
2432
1632
socketserver.TCPServer.__init__(self, server_address,
2433
1633
RequestHandlerClass)
2434
2435
1634
def server_bind(self):
2436
1635
"""This overrides the normal server_bind() function
2437
1636
to bind to an interface if one was specified, and also NOT to
2443
1642
self.interface)
2444
1643
else:
2445
1644
try:
2446
self.socket.setsockopt(
2447
socket.SOL_SOCKET, SO_BINDTODEVICE,
2448
(self.interface + "\0").encode("utf-8"))
1645
self.socket.setsockopt(socket.SOL_SOCKET,
1646
SO_BINDTODEVICE,
1647
str(self.interface
1648
+ '\0'))
2449
1649
except socket.error as error:
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:
1650
if error[0] == errno.EPERM:
1651
logger.error("No permission to"
1652
" bind to interface %s",
1653
self.interface)
1654
elif error[0] == errno.ENOPROTOOPT:
2454
1655
logger.error("SO_BINDTODEVICE not available;"
2455
1656
" cannot bind to interface %s",
2456
1657
self.interface)
2457
elif error.errno == errno.ENODEV:
2458
logger.error("Interface %s does not exist,"
2459
" cannot bind", self.interface)
2460
1658
else:
2461
1659
raise
2462
1660
# Only bind(2) the socket if we really need to.
2465
1663
if self.address_family == socket.AF_INET6:
2466
1664
any_address = "::" # in6addr_any
2467
1665
else:
2468
any_address = "0.0.0.0" # INADDR_ANY
1666
any_address = socket.INADDR_ANY
2469
1667
self.server_address = (any_address,
2470
1668
self.server_address[1])
2471
1669
elif not self.server_address[1]:
2472
self.server_address = (self.server_address[0], 0)
1670
self.server_address = (self.server_address[0],
1671
0)
2473
1672
# if self.interface:
2474
1673
# self.server_address = (self.server_address[0],
2475
1674
# 0, # port
2487
1686
gnutls_priority GnuTLS priority string
2488
1687
use_dbus: Boolean; to emit D-Bus signals or not
2489
1688
2490
Assumes a GObject.MainLoop event loop.
1689
Assumes a gobject.MainLoop event loop.
2491
1690
"""
2492
2493
1691
def __init__(self, server_address, RequestHandlerClass,
2494
interface=None,
2495
use_ipv6=True,
2496
clients=None,
2497
gnutls_priority=None,
2498
use_dbus=True,
2499
socketfd=None):
1692
interface=None, use_ipv6=True, clients=None,
1693
gnutls_priority=None, use_dbus=True):
2500
1694
self.enabled = False
2501
1695
self.clients = clients
2502
1696
if self.clients is None:
2506
1700
IPv6_TCPServer.__init__(self, server_address,
2507
1701
RequestHandlerClass,
2508
1702
interface = interface,
2509
use_ipv6 = use_ipv6,
2510
socketfd = socketfd)
2511
1703
use_ipv6 = use_ipv6)
2512
1704
def server_activate(self):
2513
1705
if self.enabled:
2514
1706
return socketserver.TCPServer.server_activate(self)
2518
1710
2519
1711
def add_pipe(self, parent_pipe, proc):
2520
1712
# Call "handle_ipc" for both data and EOF events
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))
1713
gobject.io_add_watch(parent_pipe.fileno(),
1714
gobject.IO_IN | gobject.IO_HUP,
1715
functools.partial(self.handle_ipc,
1716
parent_pipe =
1717
parent_pipe,
1718
proc = proc))
2527
1719
2528
def handle_ipc(self, source, condition,
2529
parent_pipe=None,
2530
proc = None,
2531
client_object=None):
1720
def handle_ipc(self, source, condition, parent_pipe=None,
1721
proc = None, client_object=None):
1722
condition_names = {
1723
gobject.IO_IN: "IN", # There is data to read.
1724
gobject.IO_OUT: "OUT", # Data can be written (without
1725
# blocking).
1726
gobject.IO_PRI: "PRI", # There is urgent data to read.
1727
gobject.IO_ERR: "ERR", # Error condition.
1728
gobject.IO_HUP: "HUP" # Hung up (the connection has been
1729
# broken, usually for pipes and
1730
# sockets).
1731
}
1732
conditions_string = ' | '.join(name
1733
for cond, name in
1734
condition_names.iteritems()
1735
if cond & condition)
2532
1736
# error, or the other end of multiprocessing.Pipe has closed
2533
if condition & (GObject.IO_ERR | GObject.IO_HUP):
1737
if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
2534
1738
# Wait for other process to exit
2535
1739
proc.join()
2536
1740
return False
2543
1747
fpr = request[1]
2544
1748
address = request[2]
2545
1749
2546
for c in self.clients.values():
1750
for c in self.clients.itervalues():
2547
1751
if c.fingerprint == fpr:
2548
1752
client = c
2549
1753
break
2557
1761
parent_pipe.send(False)
2558
1762
return False
2559
1763
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))
1764
gobject.io_add_watch(parent_pipe.fileno(),
1765
gobject.IO_IN | gobject.IO_HUP,
1766
functools.partial(self.handle_ipc,
1767
parent_pipe =
1768
parent_pipe,
1769
proc = proc,
1770
client_object =
1771
client))
2567
1772
parent_pipe.send(True)
2568
1773
# remove the old hook in favor of the new above hook on
2569
1774
# same fileno
2575
1780
2576
1781
parent_pipe.send(('data', getattr(client_object,
2577
1782
funcname)(*args,
2578
**kwargs)))
1783
**kwargs)))
2579
1784
2580
1785
if command == 'getattr':
2581
1786
attrname = request[1]
2582
if isinstance(client_object.__getattribute__(attrname),
2583
collections.Callable):
2584
parent_pipe.send(('function', ))
1787
if callable(client_object.__getattribute__(attrname)):
1788
parent_pipe.send(('function',))
2585
1789
else:
2586
parent_pipe.send((
2587
'data', client_object.__getattribute__(attrname)))
1790
parent_pipe.send(('data', client_object
1791
.__getattribute__(attrname)))
2588
1792
2589
1793
if command == 'setattr':
2590
1794
attrname = request[1]
2594
1798
return True
2595
1799
2596
1800
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
2693
1801
def string_to_delta(interval):
2694
1802
"""Parse a string and return a datetime.timedelta
2695
1803
2706
1814
>>> string_to_delta('5m 30s')
2707
1815
datetime.timedelta(0, 330)
2708
1816
"""
2709
2710
try:
2711
return rfc3339_duration_to_delta(interval)
2712
except ValueError:
2713
pass
2714
2715
1817
timevalue = datetime.timedelta(0)
2716
1818
for s in interval.split():
2717
1819
try:
2718
suffix = s[-1]
1820
suffix = unicode(s[-1])
2719
1821
value = int(s[:-1])
2720
1822
if suffix == "d":
2721
1823
delta = datetime.timedelta(value)
2728
1830
elif suffix == "w":
2729
1831
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2730
1832
else:
2731
raise ValueError("Unknown suffix {!r}".format(suffix))
2732
except IndexError as e:
1833
raise ValueError("Unknown suffix %r" % suffix)
1834
except (ValueError, IndexError) as e:
2733
1835
raise ValueError(*(e.args))
2734
1836
timevalue += delta
2735
1837
return timevalue
2736
1838
2737
1839
1840
def if_nametoindex(interface):
1841
"""Call the C function if_nametoindex(), or equivalent
1842
1843
Note: This function cannot accept a unicode string."""
1844
global if_nametoindex
1845
try:
1846
if_nametoindex = (ctypes.cdll.LoadLibrary
1847
(ctypes.util.find_library("c"))
1848
.if_nametoindex)
1849
except (OSError, AttributeError):
1850
logger.warning("Doing if_nametoindex the hard way")
1851
def if_nametoindex(interface):
1852
"Get an interface index the hard way, i.e. using fcntl()"
1853
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
1854
with contextlib.closing(socket.socket()) as s:
1855
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1856
struct.pack(str("16s16x"),
1857
interface))
1858
interface_index = struct.unpack(str("I"),
1859
ifreq[16:20])[0]
1860
return interface_index
1861
return if_nametoindex(interface)
1862
1863
2738
1864
def daemon(nochdir = False, noclose = False):
2739
1865
"""See daemon(3). Standard BSD Unix function.
2740
1866
2748
1874
sys.exit()
2749
1875
if not noclose:
2750
1876
# Close all standard open file descriptors
2751
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1877
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2752
1878
if not stat.S_ISCHR(os.fstat(null).st_mode):
2753
1879
raise OSError(errno.ENODEV,
2754
"{} not a character device"
2755
.format(os.devnull))
1880
"%s not a character device"
1881
% os.path.devnull)
2756
1882
os.dup2(null, sys.stdin.fileno())
2757
1883
os.dup2(null, sys.stdout.fileno())
2758
1884
os.dup2(null, sys.stderr.fileno())
2767
1893
2768
1894
parser = argparse.ArgumentParser()
2769
1895
parser.add_argument("-v", "--version", action="version",
2770
version = "%(prog)s {}".format(version),
1896
version = "%%(prog)s %s" % version,
2771
1897
help="show version number and exit")
2772
1898
parser.add_argument("-i", "--interface", metavar="IF",
2773
1899
help="Bind to interface IF")
2779
1905
help="Run self-test")
2780
1906
parser.add_argument("--debug", action="store_true",
2781
1907
help="Debug mode; run in foreground and log"
2782
" to terminal", default=None)
1908
" to terminal")
2783
1909
parser.add_argument("--debuglevel", metavar="LEVEL",
2784
1910
help="Debug level for stdout output")
2785
1911
parser.add_argument("--priority", help="GnuTLS"
2792
1918
" files")
2793
1919
parser.add_argument("--no-dbus", action="store_false",
2794
1920
dest="use_dbus", help="Do not provide D-Bus"
2795
" system bus interface", default=None)
1921
" system bus interface")
2796
1922
parser.add_argument("--no-ipv6", action="store_false",
2797
dest="use_ipv6", help="Do not use IPv6",
2798
default=None)
1923
dest="use_ipv6", help="Do not use IPv6")
2799
1924
parser.add_argument("--no-restore", action="store_false",
2800
dest="restore", help="Do not restore stored"
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")
2805
parser.add_argument("--statedir", metavar="DIR",
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)
2812
1925
dest="restore", help="Do not restore stored state",
1926
default=True)
1927
2813
1928
options = parser.parse_args()
2814
1929
2815
1930
if options.check:
2816
1931
import doctest
2817
fail_count, test_count = doctest.testmod()
2818
sys.exit(os.EX_OK if fail_count == 0 else 1)
1932
doctest.testmod()
1933
sys.exit()
2819
1934
2820
1935
# Default values for config file for server-global settings
2821
1936
server_defaults = { "interface": "",
2823
1938
"port": "",
2824
1939
"debug": "False",
2825
1940
"priority":
2826
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2827
":+SIGN-DSA-SHA256",
1941
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
2828
1942
"servicename": "Mandos",
2829
1943
"use_dbus": "True",
2830
1944
"use_ipv6": "True",
2831
1945
"debuglevel": "",
2832
"restore": "True",
2833
"socket": "",
2834
"statedir": "/var/lib/mandos",
2835
"foreground": "False",
2836
"zeroconf": "True",
2837
}
1946
}
2838
1947
2839
1948
# Parse config file for server-global settings
2840
1949
server_config = configparser.SafeConfigParser(server_defaults)
2841
1950
del server_defaults
2842
server_config.read(os.path.join(options.configdir, "mandos.conf"))
1951
server_config.read(os.path.join(options.configdir,
1952
"mandos.conf"))
2843
1953
# Convert the SafeConfigParser object to a dict
2844
1954
server_settings = server_config.defaults()
2845
1955
# Use the appropriate methods on the non-string config options
2846
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
1956
for option in ("debug", "use_dbus", "use_ipv6"):
2847
1957
server_settings[option] = server_config.getboolean("DEFAULT",
2848
1958
option)
2849
1959
if server_settings["port"]:
2850
1960
server_settings["port"] = server_config.getint("DEFAULT",
2851
1961
"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"])
2861
1962
del server_config
2862
1963
2863
1964
# Override the settings from the config file with command line
2864
1965
# options, if set.
2865
1966
for option in ("interface", "address", "port", "debug",
2866
"priority", "servicename", "configdir", "use_dbus",
2867
"use_ipv6", "debuglevel", "restore", "statedir",
2868
"socket", "foreground", "zeroconf"):
1967
"priority", "servicename", "configdir",
1968
"use_dbus", "use_ipv6", "debuglevel", "restore"):
2869
1969
value = getattr(options, option)
2870
1970
if value is not None:
2871
1971
server_settings[option] = value
2872
1972
del options
2873
1973
# Force all strings to be unicode
2874
1974
for option in server_settings.keys():
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
1975
if type(server_settings[option]) is str:
1976
server_settings[option] = unicode(server_settings[option])
2885
1977
# Now we have our good server settings in "server_settings"
2886
1978
2887
1979
##################################################################
2888
1980
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
2894
1981
# For convenience
2895
1982
debug = server_settings["debug"]
2896
1983
debuglevel = server_settings["debuglevel"]
2897
1984
use_dbus = server_settings["use_dbus"]
2898
1985
use_ipv6 = server_settings["use_ipv6"]
2899
stored_state_path = os.path.join(server_settings["statedir"],
2900
stored_state_file)
2901
foreground = server_settings["foreground"]
2902
zeroconf = server_settings["zeroconf"]
2903
2904
if debug:
2905
initlogger(debug, logging.DEBUG)
2906
else:
2907
if not debuglevel:
2908
initlogger(debug)
2909
else:
2910
level = getattr(logging, debuglevel.upper())
2911
initlogger(debug, level)
2912
1986
2913
1987
if server_settings["servicename"] != "Mandos":
2914
syslogger.setFormatter(
2915
logging.Formatter('Mandos ({}) [%(process)d]:'
2916
' %(levelname)s: %(message)s'.format(
2917
server_settings["servicename"])))
1988
syslogger.setFormatter(logging.Formatter
1989
('Mandos (%s) [%%(process)d]:'
1990
' %%(levelname)s: %%(message)s'
1991
% server_settings["servicename"]))
2918
1992
2919
1993
# Parse config file with clients
2920
client_config = configparser.SafeConfigParser(Client
2921
.client_defaults)
1994
client_defaults = { "timeout": "5m",
1995
"extended_timeout": "15m",
1996
"interval": "2m",
1997
"checker": "fping -q -- %%(host)s",
1998
"host": "",
1999
"approval_delay": "0s",
2000
"approval_duration": "1s",
2001
}
2002
client_config = configparser.SafeConfigParser(client_defaults)
2922
2003
client_config.read(os.path.join(server_settings["configdir"],
2923
2004
"clients.conf"))
2924
2005
2925
2006
global mandos_dbus_service
2926
2007
mandos_dbus_service = None
2927
2008
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
2009
tcp_server = MandosServer((server_settings["address"],
2010
server_settings["port"]),
2011
ClientHandler,
2012
interface=(server_settings["interface"]
2013
or None),
2014
use_ipv6=use_ipv6,
2015
gnutls_priority=
2016
server_settings["priority"],
2017
use_dbus=use_dbus)
2018
if not debug:
2019
pidfilename = "/var/run/mandos.pid"
2944
2020
try:
2945
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
2946
except IOError as e:
2947
logger.error("Could not open file %r", pidfilename,
2948
exc_info=e)
2021
pidfile = open(pidfilename, "w")
2022
except IOError:
2023
logger.error("Could not open file %r", pidfilename)
2949
2024
2950
for name, group in (("_mandos", "_mandos"),
2951
("mandos", "mandos"),
2952
("nobody", "nogroup")):
2025
try:
2026
uid = pwd.getpwnam("_mandos").pw_uid
2027
gid = pwd.getpwnam("_mandos").pw_gid
2028
except KeyError:
2953
2029
try:
2954
uid = pwd.getpwnam(name).pw_uid
2955
gid = pwd.getpwnam(group).pw_gid
2956
break
2030
uid = pwd.getpwnam("mandos").pw_uid
2031
gid = pwd.getpwnam("mandos").pw_gid
2957
2032
except KeyError:
2958
continue
2959
else:
2960
uid = 65534
2961
gid = 65534
2033
try:
2034
uid = pwd.getpwnam("nobody").pw_uid
2035
gid = pwd.getpwnam("nobody").pw_gid
2036
except KeyError:
2037
uid = 65534
2038
gid = 65534
2962
2039
try:
2963
2040
os.setgid(gid)
2964
2041
os.setuid(uid)
2965
if debug:
2966
logger.debug("Did setuid/setgid to {}:{}".format(uid,
2967
gid))
2968
2042
except OSError as 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
2043
if error[0] != errno.EPERM:
2044
raise error
2045
2046
if not debug and not debuglevel:
2047
logger.setLevel(logging.WARNING)
2048
if debuglevel:
2049
level = getattr(logging, debuglevel.upper())
2050
logger.setLevel(level)
2973
2051
2974
2052
if debug:
2053
logger.setLevel(logging.DEBUG)
2975
2054
# Enable all possible GnuTLS debugging
2976
2055
2977
2056
# "Use a log level over 10 to enable all debugging options."
2978
2057
# - GnuTLS manual
2979
gnutls.global_set_log_level(11)
2058
gnutls.library.functions.gnutls_global_set_log_level(11)
2980
2059
2981
@gnutls.log_func
2060
@gnutls.library.types.gnutls_log_func
2982
2061
def debug_gnutls(level, string):
2983
2062
logger.debug("GnuTLS: %s", string[:-1])
2984
2063
2985
gnutls.global_set_log_function(debug_gnutls)
2064
(gnutls.library.functions
2065
.gnutls_global_set_log_function(debug_gnutls))
2986
2066
2987
2067
# Redirect stdin so all checkers get /dev/null
2988
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2068
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2989
2069
os.dup2(null, sys.stdin.fileno())
2990
2070
if null > 2:
2991
2071
os.close(null)
2072
else:
2073
# No console logging
2074
logger.removeHandler(console)
2992
2075
2993
2076
# Need to fork before connecting to D-Bus
2994
if not foreground:
2077
if not debug:
2995
2078
# Close all input and output, do double fork, etc.
2996
2079
daemon()
2997
2080
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()
3001
3002
2081
global main_loop
3003
2082
# From the Avahi example code
3004
DBusGMainLoop(set_as_default=True)
3005
main_loop = GObject.MainLoop()
2083
DBusGMainLoop(set_as_default=True )
2084
main_loop = gobject.MainLoop()
3006
2085
bus = dbus.SystemBus()
3007
2086
# End of Avahi example code
3008
2087
if use_dbus:
3009
2088
try:
3010
2089
bus_name = dbus.service.BusName("se.recompile.Mandos",
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:
3017
logger.error("Disabling D-Bus:", exc_info=e)
2090
bus, do_not_queue=True)
2091
old_bus_name = (dbus.service.BusName
2092
("se.bsnet.fukt.Mandos", bus,
2093
do_not_queue=True))
2094
except dbus.exceptions.NameExistsException as e:
2095
logger.error(unicode(e) + ", disabling D-Bus")
3018
2096
use_dbus = False
3019
2097
server_settings["use_dbus"] = False
3020
2098
tcp_server.use_dbus = False
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"))
2099
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2100
service = AvahiServiceToSyslog(name =
2101
server_settings["servicename"],
2102
servicetype = "_mandos._tcp",
2103
protocol = protocol, bus = bus)
2104
if server_settings["interface"]:
2105
service.interface = (if_nametoindex
2106
(str(server_settings["interface"])))
3031
2107
3032
2108
global multiprocessing_manager
3033
2109
multiprocessing_manager = multiprocessing.Manager()
3034
2110
3035
2111
client_class = Client
3036
2112
if use_dbus:
3037
client_class = functools.partial(ClientDBus, bus = bus)
3038
3039
client_settings = Client.config_parser(client_config)
2113
client_class = functools.partial(ClientDBusTransitional,
2114
bus = bus)
2115
2116
special_settings = {
2117
# Some settings need to be accessd by special methods;
2118
# booleans need .getboolean(), etc. Here is a list of them:
2119
"approved_by_default":
2120
lambda section:
2121
client_config.getboolean(section, "approved_by_default"),
2122
}
2123
# Construct a new dict of client settings of this form:
2124
# { client_name: {setting_name: value, ...}, ...}
2125
# with exceptions for any special settings as defined above
2126
client_settings = dict((clientname,
2127
dict((setting,
2128
(value if setting not in special_settings
2129
else special_settings[setting](clientname)))
2130
for setting, value in client_config.items(clientname)))
2131
for clientname in client_config.sections())
2132
3040
2133
old_client_settings = {}
3041
clients_data = {}
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
3051
# Get client data and settings from last running state.
2134
clients_data = []
2135
2136
# Get client data and settings from last running state.
3052
2137
if server_settings["restore"]:
3053
2138
try:
3054
2139
with open(stored_state_path, "rb") as 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
for key in clients_data:
3070
value = { (k.decode("utf-8")
3071
if isinstance(k, bytes) else k): v
3072
for k, v in
3073
clients_data[key].items() }
3074
clients_data[key] = value
3075
# .client_structure
3076
value["client_structure"] = [
3077
(s.decode("utf-8")
3078
if isinstance(s, bytes)
3079
else s) for s in
3080
value["client_structure"] ]
3081
# .name & .host
3082
for k in ("name", "host"):
3083
if isinstance(value[k], bytes):
3084
value[k] = value[k].decode("utf-8")
3085
## old_client_settings
3086
# .keys
3087
old_client_settings = {
3088
(key.decode("utf-8")
3089
if isinstance(key, bytes)
3090
else key): value
3091
for key, value in
3092
bytes_old_client_settings.items() }
3093
# .host
3094
for value in old_client_settings.values():
3095
value["host"] = value["host"].decode("utf-8")
2140
clients_data, old_client_settings = pickle.load(stored_state)
3096
2141
os.remove(stored_state_path)
3097
2142
except IOError as e:
3098
if e.errno == errno.ENOENT:
3099
logger.warning("Could not load persistent state:"
3100
" {}".format(os.strerror(e.errno)))
3101
else:
3102
logger.critical("Could not load persistent state:",
3103
exc_info=e)
2143
logger.warning("Could not load persistant state: {0}".format(e))
2144
if e.errno != errno.ENOENT:
3104
2145
raise
3105
except EOFError as e:
3106
logger.warning("Could not load persistent state: "
3107
"EOFError:",
3108
exc_info=e)
3109
3110
with PGPEngine() as pgp:
3111
for client_name, client in clients_data.items():
3112
# Skip removed clients
3113
if client_name not in client_settings:
3114
continue
3115
3116
# Decide which value to use after restoring saved state.
3117
# We have three different values: Old config file,
3118
# new config file, and saved state.
3119
# New config value takes precedence if it differs from old
3120
# config value, otherwise use saved state.
3121
for name, value in client_settings[client_name].items():
3122
try:
3123
# For each value in new config, check if it
3124
# differs from the old config value (Except for
3125
# the "secret" attribute)
3126
if (name != "secret"
3127
and (value !=
3128
old_client_settings[client_name][name])):
3129
client[name] = value
3130
except KeyError:
3131
pass
3132
3133
# Clients who has passed its expire date can still be
3134
# enabled if its last checker was successful. A Client
3135
# whose checker succeeded before we stored its state is
3136
# assumed to have successfully run all checkers during
3137
# downtime.
3138
if client["enabled"]:
3139
if datetime.datetime.utcnow() >= client["expires"]:
3140
if not client["last_checked_ok"]:
3141
logger.warning(
3142
"disabling client {} - Client never "
3143
"performed a successful checker".format(
3144
client_name))
3145
client["enabled"] = False
3146
elif client["last_checker_status"] != 0:
3147
logger.warning(
3148
"disabling client {} - Client last"
3149
" checker failed with error code"
3150
" {}".format(
3151
client_name,
3152
client["last_checker_status"]))
3153
client["enabled"] = False
3154
else:
3155
client["expires"] = (
3156
datetime.datetime.utcnow()
3157
+ client["timeout"])
3158
logger.debug("Last checker succeeded,"
3159
" keeping {} enabled".format(
3160
client_name))
2146
2147
for client in clients_data:
2148
client_name = client["name"]
2149
2150
# Decide which value to use after restoring saved state.
2151
# We have three different values: Old config file,
2152
# new config file, and saved state.
2153
# New config value takes precedence if it differs from old
2154
# config value, otherwise use saved state.
2155
for name, value in client_settings[client_name].items():
3161
2156
try:
3162
client["secret"] = pgp.decrypt(
3163
client["encrypted_secret"],
3164
client_settings[client_name]["secret"])
3165
except PGPError:
3166
# If decryption fails, we use secret from new settings
3167
logger.debug("Failed to decrypt {} old secret".format(
3168
client_name))
3169
client["secret"] = (client_settings[client_name]
3170
["secret"])
3171
3172
# Add/remove clients based on new changes made to config
3173
for client_name in (set(old_client_settings)
3174
- set(client_settings)):
3175
del clients_data[client_name]
3176
for client_name in (set(client_settings)
3177
- set(old_client_settings)):
3178
clients_data[client_name] = client_settings[client_name]
3179
3180
# Create all client objects
3181
for client_name, client in clients_data.items():
3182
tcp_server.clients[client_name] = client_class(
3183
name = client_name,
3184
settings = client,
3185
server_settings = server_settings)
3186
2157
# For each value in new config, check if it differs
2158
# from the old config value (Except for the "secret"
2159
# attribute)
2160
if name != "secret" and value != old_client_settings[client_name][name]:
2161
setattr(client, name, value)
2162
except KeyError:
2163
pass
2164
2165
# Clients who has passed its expire date, can still be enabled if its
2166
# last checker was sucessful. Clients who checkers failed before we
2167
# stored it state is asumed to had failed checker during downtime.
2168
if client["enabled"] and client["last_checked_ok"]:
2169
if ((datetime.datetime.utcnow() - client["last_checked_ok"])
2170
> client["interval"]):
2171
if client["last_checker_status"] != 0:
2172
client["enabled"] = False
2173
else:
2174
client["expires"] = datetime.datetime.utcnow() + client["timeout"]
2175
2176
client["changedstate"] = (multiprocessing_manager
2177
.Condition(multiprocessing_manager
2178
.Lock()))
2179
if use_dbus:
2180
new_client = ClientDBusTransitional.__new__(ClientDBusTransitional)
2181
tcp_server.clients[client_name] = new_client
2182
new_client.bus = bus
2183
for name, value in client.iteritems():
2184
setattr(new_client, name, value)
2185
client_object_name = unicode(client_name).translate(
2186
{ord("."): ord("_"),
2187
ord("-"): ord("_")})
2188
new_client.dbus_object_path = (dbus.ObjectPath
2189
("/clients/" + client_object_name))
2190
DBusObjectWithProperties.__init__(new_client,
2191
new_client.bus,
2192
new_client.dbus_object_path)
2193
else:
2194
tcp_server.clients[client_name] = Client.__new__(Client)
2195
for name, value in client.iteritems():
2196
setattr(tcp_server.clients[client_name], name, value)
2197
2198
tcp_server.clients[client_name].decrypt_secret(
2199
client_settings[client_name]["secret"])
2200
2201
# Create/remove clients based on new changes made to config
2202
for clientname in set(old_client_settings) - set(client_settings):
2203
del tcp_server.clients[clientname]
2204
for clientname in set(client_settings) - set(old_client_settings):
2205
tcp_server.clients[clientname] = (client_class(name = clientname,
2206
config =
2207
client_settings
2208
[clientname]))
2209
2210
3187
2211
if not tcp_server.clients:
3188
2212
logger.warning("No clients defined")
3189
3190
if not foreground:
3191
if pidfile is not None:
3192
pid = os.getpid()
3193
try:
3194
with pidfile:
3195
print(pid, file=pidfile)
3196
except IOError:
3197
logger.error("Could not write to file %r with PID %d",
3198
pidfilename, pid)
3199
del pidfile
2213
2214
if not debug:
2215
try:
2216
with pidfile:
2217
pid = os.getpid()
2218
pidfile.write(str(pid) + "\n".encode("utf-8"))
2219
del pidfile
2220
except IOError:
2221
logger.error("Could not write to file %r with PID %d",
2222
pidfilename, pid)
2223
except NameError:
2224
# "pidfile" was never created
2225
pass
3200
2226
del pidfilename
2227
2228
signal.signal(signal.SIGINT, signal.SIG_IGN)
3201
2229
3202
2230
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
3203
2231
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
3204
2232
3205
2233
if use_dbus:
3206
3207
@alternate_dbus_interfaces(
3208
{ "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
3209
class MandosDBusService(DBusObjectWithObjectManager):
2234
class MandosDBusService(dbus.service.Object):
3210
2235
"""A D-Bus proxy object"""
3211
3212
2236
def __init__(self):
3213
2237
dbus.service.Object.__init__(self, bus, "/")
3214
3215
2238
_interface = "se.recompile.Mandos"
3216
2239
3217
2240
@dbus.service.signal(_interface, signature="o")
3224
2247
"D-Bus signal"
3225
2248
pass
3226
2249
3227
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3228
"true"})
3229
2250
@dbus.service.signal(_interface, signature="os")
3230
2251
def ClientRemoved(self, objpath, name):
3231
2252
"D-Bus signal"
3232
2253
pass
3233
2254
3234
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3235
"true"})
3236
2255
@dbus.service.method(_interface, out_signature="ao")
3237
2256
def GetAllClients(self):
3238
2257
"D-Bus method"
3239
return dbus.Array(c.dbus_object_path for c in
3240
tcp_server.clients.values())
2258
return dbus.Array(c.dbus_object_path
2259
for c in
2260
tcp_server.clients.itervalues())
3241
2261
3242
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3243
"true"})
3244
2262
@dbus.service.method(_interface,
3245
2263
out_signature="a{oa{sv}}")
3246
2264
def GetAllClientsWithProperties(self):
3247
2265
"D-Bus method"
3248
2266
return dbus.Dictionary(
3249
{ c.dbus_object_path: c.GetAll(
3250
"se.recompile.Mandos.Client")
3251
for c in tcp_server.clients.values() },
2267
((c.dbus_object_path, c.GetAll(""))
2268
for c in tcp_server.clients.itervalues()),
3252
2269
signature="oa{sv}")
3253
2270
3254
2271
@dbus.service.method(_interface, in_signature="o")
3255
2272
def RemoveClient(self, object_path):
3256
2273
"D-Bus method"
3257
for c in tcp_server.clients.values():
2274
for c in tcp_server.clients.itervalues():
3258
2275
if c.dbus_object_path == object_path:
3259
2276
del tcp_server.clients[c.name]
3260
2277
c.remove_from_connection()
3261
# Don't signal the disabling
2278
# Don't signal anything except ClientRemoved
3262
2279
c.disable(quiet=True)
3263
# Emit D-Bus signal for removal
3264
self.client_removed_signal(c)
2280
# Emit D-Bus signal
2281
self.ClientRemoved(object_path, c.name)
3265
2282
return
3266
2283
raise KeyError(object_path)
3267
2284
3268
2285
del _interface
3269
3270
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3271
out_signature = "a{oa{sa{sv}}}")
3272
def GetManagedObjects(self):
3273
"""D-Bus method"""
3274
return dbus.Dictionary(
3275
{ client.dbus_object_path:
3276
dbus.Dictionary(
3277
{ interface: client.GetAll(interface)
3278
for interface in
3279
client._get_all_interface_names()})
3280
for client in tcp_server.clients.values()})
3281
3282
def client_added_signal(self, client):
3283
"""Send the new standard signal and the old signal"""
3284
if use_dbus:
3285
# New standard signal
3286
self.InterfacesAdded(
3287
client.dbus_object_path,
3288
dbus.Dictionary(
3289
{ interface: client.GetAll(interface)
3290
for interface in
3291
client._get_all_interface_names()}))
3292
# Old signal
3293
self.ClientAdded(client.dbus_object_path)
3294
3295
def client_removed_signal(self, client):
3296
"""Send the new standard signal and the old signal"""
3297
if use_dbus:
3298
# New standard signal
3299
self.InterfacesRemoved(
3300
client.dbus_object_path,
3301
client._get_all_interface_names())
3302
# Old signal
3303
self.ClientRemoved(client.dbus_object_path,
3304
client.name)
3305
2286
3306
mandos_dbus_service = MandosDBusService()
2287
class MandosDBusServiceTransitional(MandosDBusService):
2288
__metaclass__ = AlternateDBusNamesMetaclass
2289
mandos_dbus_service = MandosDBusServiceTransitional()
3307
2290
3308
2291
def cleanup():
3309
2292
"Cleanup function; run on exit"
3310
if zeroconf:
3311
service.cleanup()
2293
service.cleanup()
3312
2294
3313
2295
multiprocessing.active_children()
3314
wnull.close()
3315
2296
if not (tcp_server.clients or client_settings):
3316
2297
return
3317
3318
# Store client before exiting. Secrets are encrypted with key
3319
# based on what config file has. If config file is
3320
# removed/edited, old secret will thus be unrecovable.
3321
clients = {}
3322
with PGPEngine() as pgp:
3323
for client in tcp_server.clients.values():
3324
key = client_settings[client.name]["secret"]
3325
client.encrypted_secret = pgp.encrypt(client.secret,
3326
key)
3327
client_dict = {}
3328
3329
# A list of attributes that can not be pickled
3330
# + secret.
3331
exclude = { "bus", "changedstate", "secret",
3332
"checker", "server_settings" }
3333
for name, typ in inspect.getmembers(dbus.service
3334
.Object):
3335
exclude.add(name)
3336
3337
client_dict["encrypted_secret"] = (client
3338
.encrypted_secret)
3339
for attr in client.client_structure:
3340
if attr not in exclude:
3341
client_dict[attr] = getattr(client, attr)
3342
3343
clients[client.name] = client_dict
3344
del client_settings[client.name]["secret"]
3345
2298
2299
# Store client before exiting. Secrets are encrypted with key based
2300
# on what config file has. If config file is removed/edited, old
2301
# secret will thus be unrecovable.
2302
clients = []
2303
for client in tcp_server.clients.itervalues():
2304
client.encrypt_secret(client_settings[client.name]["secret"])
2305
2306
client_dict = {}
2307
2308
# A list of attributes that will not be stored when shuting down.
2309
exclude = set(("bus", "changedstate", "secret"))
2310
for name, typ in inspect.getmembers(dbus.service.Object):
2311
exclude.add(name)
2312
2313
client_dict["encrypted_secret"] = client.encrypted_secret
2314
for attr in client.client_structure:
2315
if attr not in exclude:
2316
client_dict[attr] = getattr(client, attr)
2317
2318
clients.append(client_dict)
2319
del client_settings[client.name]["secret"]
2320
3346
2321
try:
3347
with tempfile.NamedTemporaryFile(
3348
mode='wb',
3349
suffix=".pickle",
3350
prefix='clients-',
3351
dir=os.path.dirname(stored_state_path),
3352
delete=False) as stored_state:
3353
pickle.dump((clients, client_settings), stored_state,
3354
protocol = 2)
3355
tempname = stored_state.name
3356
os.rename(tempname, stored_state_path)
3357
except (IOError, OSError) as e:
3358
if not debug:
3359
try:
3360
os.remove(tempname)
3361
except NameError:
3362
pass
3363
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3364
logger.warning("Could not save persistent state: {}"
3365
.format(os.strerror(e.errno)))
3366
else:
3367
logger.warning("Could not save persistent state:",
3368
exc_info=e)
2322
with os.fdopen(os.open(stored_state_path, os.O_CREAT|os.O_WRONLY|os.O_TRUNC, 0600), "wb") as stored_state:
2323
pickle.dump((clients, client_settings), stored_state)
2324
except IOError as e:
2325
logger.warning("Could not save persistant state: {0}".format(e))
2326
if e.errno != errno.ENOENT:
3369
2327
raise
3370
2328
3371
2329
# Delete all clients, and settings from config
3372
2330
while tcp_server.clients:
3373
2331
name, client = tcp_server.clients.popitem()
3374
2332
if use_dbus:
3375
2333
client.remove_from_connection()
3376
# Don't signal the disabling
2334
# Don't signal anything except ClientRemoved
3377
2335
client.disable(quiet=True)
3378
# Emit D-Bus signal for removal
3379
2336
if use_dbus:
3380
mandos_dbus_service.client_removed_signal(client)
2337
# Emit D-Bus signal
2338
mandos_dbus_service.ClientRemoved(client
2339
.dbus_object_path,
2340
client.name)
3381
2341
client_settings.clear()
3382
2342
3383
2343
atexit.register(cleanup)
3384
2344
3385
for client in tcp_server.clients.values():
2345
for client in tcp_server.clients.itervalues():
3386
2346
if use_dbus:
3387
# Emit D-Bus signal for adding
3388
mandos_dbus_service.client_added_signal(client)
2347
# Emit D-Bus signal
2348
mandos_dbus_service.ClientAdded(client.dbus_object_path)
3389
2349
# Need to initiate checking of clients
3390
2350
if client.enabled:
3391
2351
client.init_checker()
2352
3392
2353
3393
2354
tcp_server.enable()
3394
2355
tcp_server.server_activate()
3395
2356
3396
2357
# Find out what port we got
3397
if zeroconf:
3398
service.port = tcp_server.socket.getsockname()[1]
2358
service.port = tcp_server.socket.getsockname()[1]
3399
2359
if use_ipv6:
3400
2360
logger.info("Now listening on address %r, port %d,"
3401
" flowinfo %d, scope_id %d",
3402
*tcp_server.socket.getsockname())
2361
" flowinfo %d, scope_id %d"
2362
% tcp_server.socket.getsockname())
3403
2363
else: # IPv4
3404
logger.info("Now listening on address %r, port %d",
3405
*tcp_server.socket.getsockname())
2364
logger.info("Now listening on address %r, port %d"
2365
% tcp_server.socket.getsockname())
3406
2366
3407
2367
#service.interface = tcp_server.socket.getsockname()[3]
3408
2368
3409
2369
try:
3410
if zeroconf:
3411
# From the Avahi example code
3412
try:
3413
service.activate()
3414
except dbus.exceptions.DBusException as error:
3415
logger.critical("D-Bus Exception", exc_info=error)
3416
cleanup()
3417
sys.exit(1)
3418
# End of Avahi example code
2370
# From the Avahi example code
2371
try:
2372
service.activate()
2373
except dbus.exceptions.DBusException as error:
2374
logger.critical("DBusException: %s", error)
2375
cleanup()
2376
sys.exit(1)
2377
# End of Avahi example code
3419
2378
3420
GObject.io_add_watch(tcp_server.fileno(), GObject.IO_IN,
2379
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
3421
2380
lambda *args, **kwargs:
3422
2381
(tcp_server.handle_request
3423
2382
(*args[2:], **kwargs) or True))
3425
2384
logger.debug("Starting main loop")
3426
2385
main_loop.run()
3427
2386
except AvahiError as error:
3428
logger.critical("Avahi Error", exc_info=error)
2387
logger.critical("AvahiError: %s", error)
3429
2388
cleanup()
3430
2389
sys.exit(1)
3431
2390
except KeyboardInterrupt:
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0