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