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 521
- compare with another revision
- download diff
- download tarball
- view history from revision 521
- Committer: teddy at bsnet
- Date: 2011-11-10 11:08:50 UTC
- Revision ID: teddy@fukt.bsnet.se-20111110110850-ztybq08hduf85vx6
* debian/control (mandos/Depends): Added "python-crypto".
* mandos: Break long lines.
(ClientDBus.add_to_dbus): New.
(ClientDBus.__init__): Call add_to_dbus().
(main): - '' -
* mandos: Break long lines.
(ClientDBus.add_to_dbus): New.
(ClientDBus.__init__): Call add_to_dbus().
(main): - '' -
- 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.5"
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
773
311
last_approval_request: datetime.datetime(); (UTC) or None
774
312
last_checked_ok: datetime.datetime(); (UTC) or None
775
313
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
314
status of last checker. -1 reflect crashed
315
checker, 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()
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
402
in self.__dict__.iterkeys()
898
403
if not attr.startswith("_")]
899
404
self.client_structure.append("client_structure")
900
901
for name, t in inspect.getmembers(
902
type(self), lambda obj: isinstance(obj, property)):
405
406
407
for name, t in inspect.getmembers(type(self),
408
lambda obj:
409
isinstance(obj,
410
property)):
903
411
if not name.startswith("_"):
904
412
self.client_structure.append(name)
905
413
913
421
if getattr(self, "enabled", False):
914
422
# Already enabled
915
423
return
424
self.send_changedstate()
916
425
self.expires = datetime.datetime.utcnow() + self.timeout
917
426
self.enabled = True
918
427
self.last_enabled = datetime.datetime.utcnow()
919
428
self.init_checker()
920
self.send_changedstate()
921
429
922
430
def disable(self, quiet=True):
923
431
"""Disable this client."""
924
432
if not getattr(self, "enabled", False):
925
433
return False
926
434
if not quiet:
435
self.send_changedstate()
436
if not quiet:
927
437
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)
438
if getattr(self, "disable_initiator_tag", False):
439
gobject.source_remove(self.disable_initiator_tag)
930
440
self.disable_initiator_tag = None
931
441
self.expires = None
932
if getattr(self, "checker_initiator_tag", None) is not None:
933
GLib.source_remove(self.checker_initiator_tag)
442
if getattr(self, "checker_initiator_tag", False):
443
gobject.source_remove(self.checker_initiator_tag)
934
444
self.checker_initiator_tag = None
935
445
self.stop_checker()
936
446
self.enabled = False
937
if not quiet:
938
self.send_changedstate()
939
# Do not run this again if called by a GLib.timeout_add
447
# Do not run this again if called by a gobject.timeout_add
940
448
return False
941
449
942
450
def __del__(self):
943
451
self.disable()
944
452
945
453
def init_checker(self):
946
454
# Schedule a new checker to be started an 'interval' from now,
947
455
# 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)
456
self.checker_initiator_tag = (gobject.timeout_add
457
(self.interval_milliseconds(),
458
self.start_checker))
953
459
# 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)
460
self.disable_initiator_tag = (gobject.timeout_add
461
(self.timeout_milliseconds(),
462
self.disable))
958
463
# Also start a new checker *right now*.
959
464
self.start_checker()
960
961
def checker_callback(self, source, condition, connection,
962
command):
465
466
467
def checker_callback(self, pid, condition, command):
963
468
"""The checker has completed, so take appropriate actions."""
964
469
self.checker_callback_tag = None
965
470
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
471
if os.WIFEXITED(condition):
472
self.last_checker_status = os.WEXITSTATUS(condition)
973
473
if self.last_checker_status == 0:
974
474
logger.info("Checker for %(name)s succeeded",
975
475
vars(self))
976
476
self.checked_ok()
977
477
else:
978
logger.info("Checker for %(name)s failed", vars(self))
478
logger.info("Checker for %(name)s failed",
479
vars(self))
979
480
else:
980
481
self.last_checker_status = -1
981
self.last_checker_signal = -returncode
982
482
logger.warning("Checker for %(name)s crashed?",
983
483
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."""
484
485
def checked_ok(self, timeout=None):
486
"""Bump up the timeout for this client.
487
488
This should only be called when the client has been seen,
489
alive and well.
490
"""
995
491
if timeout is None:
996
492
timeout = self.timeout
493
self.last_checked_ok = datetime.datetime.utcnow()
997
494
if self.disable_initiator_tag is not None:
998
GLib.source_remove(self.disable_initiator_tag)
999
self.disable_initiator_tag = None
495
gobject.source_remove(self.disable_initiator_tag)
1000
496
if getattr(self, "enabled", False):
1001
self.disable_initiator_tag = GLib.timeout_add(
1002
int(timeout.total_seconds() * 1000), self.disable)
497
self.disable_initiator_tag = (gobject.timeout_add
498
(_timedelta_to_milliseconds
499
(timeout), self.disable))
1003
500
self.expires = datetime.datetime.utcnow() + timeout
1004
501
1005
502
def need_approval(self):
1011
508
If a checker already exists, leave it running and do
1012
509
nothing."""
1013
510
# 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
511
# did that, then if a checker (for some reason) started
512
# running slowly and taking more than 'interval' time, the
513
# client would inevitably timeout, since no checker would get
514
# a chance to run to completion. If we instead leave running
1018
515
# checkers alone, the checker would have to take more time
1019
516
# than 'timeout' for the client to be disabled, which is as it
1020
517
# should be.
1021
518
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
519
# If a checker exists, make sure it is not a zombie
520
try:
521
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
522
except (AttributeError, OSError) as error:
523
if (isinstance(error, OSError)
524
and error.errno != errno.ECHILD):
525
raise error
526
else:
527
if pid:
528
logger.warning("Checker was a zombie")
529
gobject.source_remove(self.checker_callback_tag)
530
self.checker_callback(pid, status,
531
self.current_checker_command)
1026
532
# Start a new checker if needed
1027
533
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
534
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
535
# In case checker_command has exactly one % operator
536
command = self.checker_command % self.host
537
except TypeError:
538
# Escape attributes for the shell
539
escaped_attrs = dict(
540
(attr,
541
re.escape(unicode(str(getattr(self, attr, "")),
542
errors=
543
'replace')))
544
for attr in
545
self.runtime_expansions)
546
547
try:
548
command = self.checker_command % escaped_attrs
549
except TypeError as error:
550
logger.error('Could not format string "%s":'
551
' %s', self.checker_command, error)
552
return True # Try again later
1039
553
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
554
try:
555
logger.info("Starting checker %r for %s",
556
command, self.name)
557
# We don't need to redirect stdout and stderr, since
558
# in normal mode, that is already done by daemon(),
559
# and in debug mode we don't want to. (Stdin is
560
# always replaced by /dev/null.)
561
self.checker = subprocess.Popen(command,
562
close_fds=True,
563
shell=True, cwd="/")
564
self.checker_callback_tag = (gobject.child_watch_add
565
(self.checker.pid,
566
self.checker_callback,
567
data=command))
568
# The checker may have completed before the gobject
569
# watch was added. Check for this.
570
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
571
if pid:
572
gobject.source_remove(self.checker_callback_tag)
573
self.checker_callback(pid, status, command)
574
except OSError as error:
575
logger.error("Failed to start subprocess: %s",
576
error)
577
# Re-run this periodically if run by gobject.timeout_add
1066
578
return True
1067
579
1068
580
def stop_checker(self):
1069
581
"""Force the checker process, if any, to stop."""
1070
582
if self.checker_callback_tag:
1071
GLib.source_remove(self.checker_callback_tag)
583
gobject.source_remove(self.checker_callback_tag)
1072
584
self.checker_callback_tag = None
1073
585
if getattr(self, "checker", None) is None:
1074
586
return
1075
587
logger.debug("Stopping checker for %(name)s", vars(self))
1076
self.checker.terminate()
588
try:
589
os.kill(self.checker.pid, signal.SIGTERM)
590
#time.sleep(0.5)
591
#if self.checker.poll() is None:
592
# os.kill(self.checker.pid, signal.SIGKILL)
593
except OSError as error:
594
if error.errno != errno.ESRCH: # No such process
595
raise
1077
596
self.checker = None
1078
597
1079
1080
def dbus_service_property(dbus_interface,
1081
signature="v",
1082
access="readwrite",
1083
byte_arrays=False):
598
# Encrypts a client secret and stores it in a varible
599
# encrypted_secret
600
def encrypt_secret(self, key):
601
# Encryption-key need to be of a specific size, so we hash
602
# supplied key
603
hasheng = hashlib.sha256()
604
hasheng.update(key)
605
encryptionkey = hasheng.digest()
606
607
# Create validation hash so we know at decryption if it was
608
# sucessful
609
hasheng = hashlib.sha256()
610
hasheng.update(self.secret)
611
validationhash = hasheng.digest()
612
613
# Encrypt secret
614
iv = os.urandom(Crypto.Cipher.AES.block_size)
615
ciphereng = Crypto.Cipher.AES.new(encryptionkey,
616
Crypto.Cipher.AES.MODE_CFB, iv)
617
ciphertext = ciphereng.encrypt(validationhash+self.secret)
618
self.encrypted_secret = (ciphertext, iv)
619
620
# Decrypt a encrypted client secret
621
def decrypt_secret(self, key):
622
# Decryption-key need to be of a specific size, so we hash
623
# supplied key
624
hasheng = hashlib.sha256()
625
hasheng.update(key)
626
encryptionkey = hasheng.digest()
627
628
# Decrypt encrypted secret
629
ciphertext, iv = self.encrypted_secret
630
ciphereng = Crypto.Cipher.AES.new(encryptionkey,
631
Crypto.Cipher.AES.MODE_CFB, iv)
632
plain = ciphereng.decrypt(ciphertext)
633
634
# Validate decrypted secret to know if it was succesful
635
hasheng = hashlib.sha256()
636
validationhash = plain[:hasheng.digest_size]
637
secret = plain[hasheng.digest_size:]
638
hasheng.update(secret)
639
640
# If validation fails, we use key as new secret. Otherwise, we
641
# use the decrypted secret
642
if hasheng.digest() == validationhash:
643
self.secret = secret
644
else:
645
self.secret = key
646
del self.encrypted_secret
647
648
649
def dbus_service_property(dbus_interface, signature="v",
650
access="readwrite", byte_arrays=False):
1084
651
"""Decorators for marking methods of a DBusObjectWithProperties to
1085
652
become properties on the D-Bus.
1086
653
1095
662
# "Set" method, so we fail early here:
1096
663
if byte_arrays and signature != "ay":
1097
664
raise ValueError("Byte arrays not supported for non-'ay'"
1098
" signature {!r}".format(signature))
1099
665
" signature %r" % signature)
1100
666
def decorator(func):
1101
667
func._dbus_is_property = True
1102
668
func._dbus_interface = dbus_interface
1107
673
func._dbus_name = func._dbus_name[:-14]
1108
674
func._dbus_get_args_options = {'byte_arrays': byte_arrays }
1109
675
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
676
return decorator
1155
677
1156
678
1157
679
class DBusPropertyException(dbus.exceptions.DBusException):
1158
680
"""A base class for D-Bus property-related exceptions
1159
681
"""
1160
pass
682
def __unicode__(self):
683
return unicode(str(self))
1161
684
1162
685
1163
686
class DBusPropertyAccessException(DBusPropertyException):
1172
695
pass
1173
696
1174
697
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):
698
class DBusObjectWithProperties(dbus.service.Object):
1265
699
"""A D-Bus object with properties.
1266
700
1267
701
Classes inheriting from this can use the dbus_service_property
1269
703
standard Get(), Set(), and GetAll() methods on the D-Bus.
1270
704
"""
1271
705
706
@staticmethod
707
def _is_dbus_property(obj):
708
return getattr(obj, "_dbus_is_property", False)
709
710
def _get_all_dbus_properties(self):
711
"""Returns a generator of (name, attribute) pairs
712
"""
713
return ((prop.__get__(self)._dbus_name, prop.__get__(self))
714
for cls in self.__class__.__mro__
715
for name, prop in
716
inspect.getmembers(cls, self._is_dbus_property))
717
1272
718
def _get_dbus_property(self, interface_name, property_name):
1273
719
"""Returns a bound method if one exists which is a D-Bus
1274
720
property with the specified name and interface.
1275
721
"""
1276
for cls in self.__class__.__mro__:
1277
for name, value in inspect.getmembers(
1278
cls, self._is_dbus_thing("property")):
722
for cls in self.__class__.__mro__:
723
for name, value in (inspect.getmembers
724
(cls, self._is_dbus_property)):
1279
725
if (value._dbus_name == property_name
1280
726
and value._dbus_interface == interface_name):
1281
727
return value.__get__(self)
1282
728
1283
729
# 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",
730
raise DBusPropertyNotFound(self.dbus_object_path + ":"
731
+ interface_name + "."
732
+ property_name)
733
734
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
1298
735
out_signature="v")
1299
736
def Get(self, interface_name, property_name):
1300
737
"""Standard D-Bus property Get() method, see D-Bus standard.
1318
755
# The byte_arrays option is not supported yet on
1319
756
# signatures other than "ay".
1320
757
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))
758
raise ValueError
759
value = dbus.ByteArray(''.join(unichr(byte)
760
for byte in value))
1326
761
prop(value)
1327
762
1328
@dbus.service.method(dbus.PROPERTIES_IFACE,
1329
in_signature="s",
763
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
1330
764
out_signature="a{sv}")
1331
765
def GetAll(self, interface_name):
1332
766
"""Standard D-Bus property GetAll() method, see D-Bus
1334
768
1335
769
Note: Will not include properties with access="write".
1336
770
"""
1337
properties = {}
1338
for name, prop in self._get_all_dbus_things("property"):
771
all = {}
772
for name, prop in self._get_all_dbus_properties():
1339
773
if (interface_name
1340
774
and interface_name != prop._dbus_interface):
1341
775
# Interface non-empty but did not match
1345
779
continue
1346
780
value = prop()
1347
781
if not hasattr(value, "variant_level"):
1348
properties[name] = value
782
all[name] = value
1349
783
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
784
all[name] = type(value)(value, variant_level=
785
value.variant_level+1)
786
return dbus.Dictionary(all, signature="sv")
1361
787
1362
788
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1363
789
out_signature="s",
1364
790
path_keyword='object_path',
1365
791
connection_keyword='connection')
1366
792
def Introspect(self, object_path, connection):
1367
"""Overloading of standard D-Bus method.
1368
1369
Inserts property tags and interface annotation tags.
793
"""Standard D-Bus method, overloaded to insert property tags.
1370
794
"""
1371
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1372
object_path,
1373
connection)
795
xmlstring = dbus.service.Object.Introspect(self, object_path,
796
connection)
1374
797
try:
1375
798
document = xml.dom.minidom.parseString(xmlstring)
1376
1377
799
def make_tag(document, name, prop):
1378
800
e = document.createElement("property")
1379
801
e.setAttribute("name", name)
1380
802
e.setAttribute("type", prop._dbus_signature)
1381
803
e.setAttribute("access", prop._dbus_access)
1382
804
return e
1383
1384
805
for if_tag in document.getElementsByTagName("interface"):
1385
# Add property tags
1386
806
for tag in (make_tag(document, name, prop)
1387
807
for name, prop
1388
in self._get_all_dbus_things("property")
808
in self._get_all_dbus_properties()
1389
809
if prop._dbus_interface
1390
810
== if_tag.getAttribute("name")):
1391
811
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
812
# Add the names to the return values for the
1409
813
# "org.freedesktop.DBus.Properties" methods
1410
814
if (if_tag.getAttribute("name")
1425
829
except (AttributeError, xml.dom.DOMException,
1426
830
xml.parsers.expat.ExpatError) as error:
1427
831
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):
832
error)
833
return xmlstring
834
835
836
def datetime_to_dbus (dt, variant_level=0):
1501
837
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1502
838
if dt is None:
1503
839
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).
840
return dbus.String(dt.isoformat(),
841
variant_level=variant_level)
842
843
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
844
.__metaclass__):
845
"""Applied to an empty subclass of a D-Bus object, this metaclass
846
will add additional D-Bus attributes matching a certain pattern.
1529
847
"""
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):
848
def __new__(mcs, name, bases, attr):
849
# Go through all the base classes which could have D-Bus
850
# methods, signals, or properties in them
851
for base in (b for b in bases
852
if issubclass(b, dbus.service.Object)):
853
# Go though all attributes of the base class
854
for attrname, attribute in inspect.getmembers(base):
1538
855
# Ignore non-D-Bus attributes, and D-Bus attributes
1539
856
# with the wrong interface name
1540
857
if (not hasattr(attribute, "_dbus_interface")
1541
or not attribute._dbus_interface.startswith(
1542
orig_interface_name)):
858
or not attribute._dbus_interface
859
.startswith("se.recompile.Mandos")):
1543
860
continue
1544
861
# Create an alternate D-Bus interface name based on
1545
862
# the current name
1546
alt_interface = attribute._dbus_interface.replace(
1547
orig_interface_name, alt_interface_name)
1548
interface_names.add(alt_interface)
863
alt_interface = (attribute._dbus_interface
864
.replace("se.recompile.Mandos",
865
"se.bsnet.fukt.Mandos"))
1549
866
# Is this a D-Bus signal?
1550
867
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(
868
# Extract the original non-method function by
869
# black magic
870
nonmethod_func = (dict(
1555
871
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)
872
attribute.__closure__))["func"]
873
.cell_contents)
1563
874
# Create a new, but exactly alike, function
1564
875
# object, and decorate it to be a new D-Bus signal
1565
876
# 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
877
new_function = (dbus.service.signal
878
(alt_interface,
879
attribute._dbus_signature)
880
(types.FunctionType(
881
nonmethod_func.func_code,
882
nonmethod_func.func_globals,
883
nonmethod_func.func_name,
884
nonmethod_func.func_defaults,
885
nonmethod_func.func_closure)))
1576
886
# 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
887
# old and new functions, so both the old and new
888
# signals gets sent when the function is called
1580
889
def fixscope(func1, func2):
1581
890
"""This function is a scope container to pass
1582
891
func1 and func2 to the "call_both" function
1583
892
outside of its arguments"""
1584
1585
@functools.wraps(func2)
1586
893
def call_both(*args, **kwargs):
1587
894
"""This function will emit two D-Bus
1588
895
signals by calling func1 and func2"""
1589
896
func1(*args, **kwargs)
1590
897
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
898
return call_both
1597
899
# Create the "call_both" function and add it to
1598
900
# the class
1599
attr[attrname] = fixscope(attribute, new_function)
901
attr[attrname] = fixscope(attribute,
902
new_function)
1600
903
# Is this a D-Bus method?
1601
904
elif getattr(attribute, "_dbus_is_method", False):
1602
905
# Create a new, but exactly alike, function
1603
906
# object. Decorate it to be a new D-Bus method
1604
907
# with the alternate D-Bus interface name. Add it
1605
908
# 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
909
attr[attrname] = (dbus.service.method
910
(alt_interface,
911
attribute._dbus_in_signature,
912
attribute._dbus_out_signature)
913
(types.FunctionType
914
(attribute.func_code,
915
attribute.func_globals,
916
attribute.func_name,
917
attribute.func_defaults,
918
attribute.func_closure)))
1618
919
# Is this a D-Bus property?
1619
920
elif getattr(attribute, "_dbus_is_property", False):
1620
921
# Create a new, but exactly alike, function
1621
922
# object, and decorate it to be a new D-Bus
1622
923
# property with the alternate D-Bus interface
1623
924
# 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"})
925
attr[attrname] = (dbus_service_property
926
(alt_interface,
927
attribute._dbus_signature,
928
attribute._dbus_access,
929
attribute
930
._dbus_get_args_options
931
["byte_arrays"])
932
(types.FunctionType
933
(attribute.func_code,
934
attribute.func_globals,
935
attribute.func_name,
936
attribute.func_defaults,
937
attribute.func_closure)))
938
return type.__new__(mcs, name, bases, attr)
939
1676
940
class ClientDBus(Client, DBusObjectWithProperties):
1677
941
"""A Client class using D-Bus
1678
942
1682
946
"""
1683
947
1684
948
runtime_expansions = (Client.runtime_expansions
1685
+ ("dbus_object_path", ))
1686
1687
_interface = "se.recompile.Mandos.Client"
949
+ ("dbus_object_path",))
1688
950
1689
951
# dbus.service.Object doesn't use super(), so we can't either.
1690
952
1691
953
def __init__(self, bus = None, *args, **kwargs):
1692
954
self.bus = bus
955
self._approvals_pending = 0
1693
956
Client.__init__(self, *args, **kwargs)
957
self.add_to_dbus()
958
959
def add_to_dbus(self):
1694
960
# Only now, when this client is initialized, can it show up on
1695
961
# the D-Bus
1696
client_object_name = str(self.name).translate(
962
client_object_name = unicode(self.name).translate(
1697
963
{ord("."): ord("_"),
1698
964
ord("-"): ord("_")})
1699
self.dbus_object_path = dbus.ObjectPath(
1700
"/clients/" + client_object_name)
965
self.dbus_object_path = (dbus.ObjectPath
966
("/clients/" + client_object_name))
1701
967
DBusObjectWithProperties.__init__(self, self.bus,
1702
968
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):
969
970
def notifychangeproperty(transform_func,
971
dbus_name, type_func=lambda x: x,
972
variant_level=1):
1709
973
""" Modify a variable so that it's a property which announces
1710
974
its changes to DBus.
1711
975
1712
976
transform_fun: Function that takes a value and a variant_level
1713
977
and transforms it to a D-Bus type.
1714
978
dbus_name: D-Bus name of the variable
1716
980
to the D-Bus. Default: no transform
1717
981
variant_level: D-Bus variant level. Default: 1
1718
982
"""
1719
attrname = "_{}".format(dbus_name)
1720
983
attrname = "_{0}".format(dbus_name)
1721
984
def setter(self, value):
1722
985
if hasattr(self, "dbus_object_path"):
1723
986
if (not hasattr(self, attrname) or
1724
987
type_func(getattr(self, attrname, None))
1725
988
!= 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())
989
dbus_value = transform_func(type_func(value),
990
variant_level
991
=variant_level)
992
self.PropertyChanged(dbus.String(dbus_name),
993
dbus_value)
1741
994
setattr(self, attrname, value)
1742
995
1743
996
return property(lambda self: getattr(self, attrname), setter)
1744
997
998
1745
999
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1746
1000
approvals_pending = notifychangeproperty(dbus.Boolean,
1747
1001
"ApprovalPending",
1749
1003
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1750
1004
last_enabled = notifychangeproperty(datetime_to_dbus,
1751
1005
"LastEnabled")
1752
checker = notifychangeproperty(
1753
dbus.Boolean, "CheckerRunning",
1754
type_func = lambda checker: checker is not None)
1006
checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1007
type_func = lambda checker:
1008
checker is not None)
1755
1009
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1756
1010
"LastCheckedOK")
1757
last_checker_status = notifychangeproperty(dbus.Int16,
1758
"LastCheckerStatus")
1759
1011
last_approval_request = notifychangeproperty(
1760
1012
datetime_to_dbus, "LastApprovalRequest")
1761
1013
approved_by_default = notifychangeproperty(dbus.Boolean,
1762
1014
"ApprovedByDefault")
1763
approval_delay = notifychangeproperty(
1764
dbus.UInt64, "ApprovalDelay",
1765
type_func = lambda td: td.total_seconds() * 1000)
1015
approval_delay = notifychangeproperty(dbus.UInt16,
1016
"ApprovalDelay",
1017
type_func =
1018
_timedelta_to_milliseconds)
1766
1019
approval_duration = notifychangeproperty(
1767
dbus.UInt64, "ApprovalDuration",
1768
type_func = lambda td: td.total_seconds() * 1000)
1020
dbus.UInt16, "ApprovalDuration",
1021
type_func = _timedelta_to_milliseconds)
1769
1022
host = notifychangeproperty(dbus.String, "Host")
1770
timeout = notifychangeproperty(
1771
dbus.UInt64, "Timeout",
1772
type_func = lambda td: td.total_seconds() * 1000)
1023
timeout = notifychangeproperty(dbus.UInt16, "Timeout",
1024
type_func =
1025
_timedelta_to_milliseconds)
1773
1026
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)
1027
dbus.UInt16, "ExtendedTimeout",
1028
type_func = _timedelta_to_milliseconds)
1029
interval = notifychangeproperty(dbus.UInt16,
1030
"Interval",
1031
type_func =
1032
_timedelta_to_milliseconds)
1779
1033
checker_command = notifychangeproperty(dbus.String, "Checker")
1780
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1781
invalidate_only=True)
1782
1034
1783
1035
del notifychangeproperty
1784
1036
1791
1043
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1792
1044
Client.__del__(self, *args, **kwargs)
1793
1045
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:
1046
def checker_callback(self, pid, condition, command,
1047
*args, **kwargs):
1048
self.checker_callback_tag = None
1049
self.checker = None
1050
if os.WIFEXITED(condition):
1051
exitstatus = os.WEXITSTATUS(condition)
1801
1052
# Emit D-Bus signal
1802
1053
self.CheckerCompleted(dbus.Int16(exitstatus),
1803
# This is specific to GNU libC
1804
dbus.Int64(exitstatus << 8),
1054
dbus.Int64(condition),
1805
1055
dbus.String(command))
1806
1056
else:
1807
1057
# Emit D-Bus signal
1808
1058
self.CheckerCompleted(dbus.Int16(-1),
1809
dbus.Int64(
1810
# This is specific to GNU libC
1811
(exitstatus << 8)
1812
| self.last_checker_signal),
1059
dbus.Int64(condition),
1813
1060
dbus.String(command))
1814
return ret
1061
1062
return Client.checker_callback(self, pid, condition, command,
1063
*args, **kwargs)
1815
1064
1816
1065
def start_checker(self, *args, **kwargs):
1817
old_checker_pid = getattr(self.checker, "pid", None)
1066
old_checker = self.checker
1067
if self.checker is not None:
1068
old_checker_pid = self.checker.pid
1069
else:
1070
old_checker_pid = None
1818
1071
r = Client.start_checker(self, *args, **kwargs)
1819
1072
# Only if new checker process was started
1820
1073
if (self.checker is not None
1824
1077
return r
1825
1078
1826
1079
def _reset_approved(self):
1827
self.approved = None
1080
self._approved = None
1828
1081
return False
1829
1082
1830
1083
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
1084
self.send_changedstate()
1085
self._approved = value
1086
gobject.timeout_add(_timedelta_to_milliseconds
1087
(self.approval_duration),
1088
self._reset_approved)
1089
1835
1090
1836
1091
## D-Bus methods, signals & properties
1837
1838
## Interfaces
1092
_interface = "se.recompile.Mandos.Client"
1839
1093
1840
1094
## Signals
1841
1095
1852
1106
pass
1853
1107
1854
1108
# PropertyChanged - signal
1855
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1856
1109
@dbus.service.signal(_interface, signature="sv")
1857
1110
def PropertyChanged(self, property, value):
1858
1111
"D-Bus signal"
1892
1145
self.checked_ok()
1893
1146
1894
1147
# Enable - method
1895
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1896
1148
@dbus.service.method(_interface)
1897
1149
def Enable(self):
1898
1150
"D-Bus method"
1899
1151
self.enable()
1900
1152
1901
1153
# StartChecker - method
1902
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1903
1154
@dbus.service.method(_interface)
1904
1155
def StartChecker(self):
1905
1156
"D-Bus method"
1906
1157
self.start_checker()
1907
1158
1908
1159
# Disable - method
1909
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1910
1160
@dbus.service.method(_interface)
1911
1161
def Disable(self):
1912
1162
"D-Bus method"
1913
1163
self.disable()
1914
1164
1915
1165
# StopChecker - method
1916
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1917
1166
@dbus.service.method(_interface)
1918
1167
def StopChecker(self):
1919
1168
self.stop_checker()
1926
1175
return dbus.Boolean(bool(self.approvals_pending))
1927
1176
1928
1177
# ApprovedByDefault - property
1929
@dbus_service_property(_interface,
1930
signature="b",
1178
@dbus_service_property(_interface, signature="b",
1931
1179
access="readwrite")
1932
1180
def ApprovedByDefault_dbus_property(self, value=None):
1933
1181
if value is None: # get
1935
1183
self.approved_by_default = bool(value)
1936
1184
1937
1185
# ApprovalDelay - property
1938
@dbus_service_property(_interface,
1939
signature="t",
1186
@dbus_service_property(_interface, signature="t",
1940
1187
access="readwrite")
1941
1188
def ApprovalDelay_dbus_property(self, value=None):
1942
1189
if value is None: # get
1943
return dbus.UInt64(self.approval_delay.total_seconds()
1944
* 1000)
1190
return dbus.UInt64(self.approval_delay_milliseconds())
1945
1191
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1946
1192
1947
1193
# ApprovalDuration - property
1948
@dbus_service_property(_interface,
1949
signature="t",
1194
@dbus_service_property(_interface, signature="t",
1950
1195
access="readwrite")
1951
1196
def ApprovalDuration_dbus_property(self, value=None):
1952
1197
if value is None: # get
1953
return dbus.UInt64(self.approval_duration.total_seconds()
1954
* 1000)
1198
return dbus.UInt64(_timedelta_to_milliseconds(
1199
self.approval_duration))
1955
1200
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1956
1201
1957
1202
# Name - property
1958
@dbus_annotations(
1959
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1960
1203
@dbus_service_property(_interface, signature="s", access="read")
1961
1204
def Name_dbus_property(self):
1962
1205
return dbus.String(self.name)
1963
1206
1964
1207
# Fingerprint - property
1965
@dbus_annotations(
1966
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1967
1208
@dbus_service_property(_interface, signature="s", access="read")
1968
1209
def Fingerprint_dbus_property(self):
1969
1210
return dbus.String(self.fingerprint)
1970
1211
1971
1212
# Host - property
1972
@dbus_service_property(_interface,
1973
signature="s",
1213
@dbus_service_property(_interface, signature="s",
1974
1214
access="readwrite")
1975
1215
def Host_dbus_property(self, value=None):
1976
1216
if value is None: # get
1977
1217
return dbus.String(self.host)
1978
self.host = str(value)
1218
self.host = value
1979
1219
1980
1220
# Created - property
1981
@dbus_annotations(
1982
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1983
1221
@dbus_service_property(_interface, signature="s", access="read")
1984
1222
def Created_dbus_property(self):
1985
return datetime_to_dbus(self.created)
1223
return dbus.String(datetime_to_dbus(self.created))
1986
1224
1987
1225
# LastEnabled - property
1988
1226
@dbus_service_property(_interface, signature="s", access="read")
1990
1228
return datetime_to_dbus(self.last_enabled)
1991
1229
1992
1230
# Enabled - property
1993
@dbus_service_property(_interface,
1994
signature="b",
1231
@dbus_service_property(_interface, signature="b",
1995
1232
access="readwrite")
1996
1233
def Enabled_dbus_property(self, value=None):
1997
1234
if value is None: # get
2002
1239
self.disable()
2003
1240
2004
1241
# LastCheckedOK - property
2005
@dbus_service_property(_interface,
2006
signature="s",
1242
@dbus_service_property(_interface, signature="s",
2007
1243
access="readwrite")
2008
1244
def LastCheckedOK_dbus_property(self, value=None):
2009
1245
if value is not None:
2011
1247
return
2012
1248
return datetime_to_dbus(self.last_checked_ok)
2013
1249
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
1250
# Expires - property
2020
1251
@dbus_service_property(_interface, signature="s", access="read")
2021
1252
def Expires_dbus_property(self):
2027
1258
return datetime_to_dbus(self.last_approval_request)
2028
1259
2029
1260
# Timeout - property
2030
@dbus_service_property(_interface,
2031
signature="t",
1261
@dbus_service_property(_interface, signature="t",
2032
1262
access="readwrite")
2033
1263
def Timeout_dbus_property(self, value=None):
2034
1264
if value is None: # get
2035
return dbus.UInt64(self.timeout.total_seconds() * 1000)
2036
old_timeout = self.timeout
1265
return dbus.UInt64(self.timeout_milliseconds())
2037
1266
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)
1267
if getattr(self, "disable_initiator_tag", None) is None:
1268
return
1269
# Reschedule timeout
1270
gobject.source_remove(self.disable_initiator_tag)
1271
self.disable_initiator_tag = None
1272
self.expires = None
1273
time_to_die = _timedelta_to_milliseconds((self
1274
.last_checked_ok
1275
+ self.timeout)
1276
- datetime.datetime
1277
.utcnow())
1278
if time_to_die <= 0:
1279
# The timeout has passed
1280
self.disable()
1281
else:
1282
self.expires = (datetime.datetime.utcnow()
1283
+ datetime.timedelta(milliseconds =
1284
time_to_die))
1285
self.disable_initiator_tag = (gobject.timeout_add
1286
(time_to_die, self.disable))
2053
1287
2054
1288
# ExtendedTimeout - property
2055
@dbus_service_property(_interface,
2056
signature="t",
1289
@dbus_service_property(_interface, signature="t",
2057
1290
access="readwrite")
2058
1291
def ExtendedTimeout_dbus_property(self, value=None):
2059
1292
if value is None: # get
2060
return dbus.UInt64(self.extended_timeout.total_seconds()
2061
* 1000)
1293
return dbus.UInt64(self.extended_timeout_milliseconds())
2062
1294
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
2063
1295
2064
1296
# Interval - property
2065
@dbus_service_property(_interface,
2066
signature="t",
1297
@dbus_service_property(_interface, signature="t",
2067
1298
access="readwrite")
2068
1299
def Interval_dbus_property(self, value=None):
2069
1300
if value is None: # get
2070
return dbus.UInt64(self.interval.total_seconds() * 1000)
1301
return dbus.UInt64(self.interval_milliseconds())
2071
1302
self.interval = datetime.timedelta(0, 0, 0, value)
2072
1303
if getattr(self, "checker_initiator_tag", None) is None:
2073
1304
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
1305
# Reschedule checker run
1306
gobject.source_remove(self.checker_initiator_tag)
1307
self.checker_initiator_tag = (gobject.timeout_add
1308
(value, self.start_checker))
1309
self.start_checker() # Start one now, too
2080
1310
2081
1311
# Checker - property
2082
@dbus_service_property(_interface,
2083
signature="s",
1312
@dbus_service_property(_interface, signature="s",
2084
1313
access="readwrite")
2085
1314
def Checker_dbus_property(self, value=None):
2086
1315
if value is None: # get
2087
1316
return dbus.String(self.checker_command)
2088
self.checker_command = str(value)
1317
self.checker_command = value
2089
1318
2090
1319
# CheckerRunning - property
2091
@dbus_service_property(_interface,
2092
signature="b",
1320
@dbus_service_property(_interface, signature="b",
2093
1321
access="readwrite")
2094
1322
def CheckerRunning_dbus_property(self, value=None):
2095
1323
if value is None: # get
2100
1328
self.stop_checker()
2101
1329
2102
1330
# ObjectPath - property
2103
@dbus_annotations(
2104
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
2105
"org.freedesktop.DBus.Deprecated": "true"})
2106
1331
@dbus_service_property(_interface, signature="o", access="read")
2107
1332
def ObjectPath_dbus_property(self):
2108
1333
return self.dbus_object_path # is already a dbus.ObjectPath
2109
1334
2110
1335
# 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)
1336
@dbus_service_property(_interface, signature="ay",
1337
access="write", byte_arrays=True)
2118
1338
def Secret_dbus_property(self, value):
2119
self.secret = bytes(value)
1339
self.secret = str(value)
2120
1340
2121
1341
del _interface
2122
1342
2126
1346
self._pipe = child_pipe
2127
1347
self._pipe.send(('init', fpr, address))
2128
1348
if not self._pipe.recv():
2129
raise KeyError(fpr)
1349
raise KeyError()
2130
1350
2131
1351
def __getattribute__(self, name):
2132
if name == '_pipe':
1352
if(name == '_pipe'):
2133
1353
return super(ProxyClient, self).__getattribute__(name)
2134
1354
self._pipe.send(('getattr', name))
2135
1355
data = self._pipe.recv()
2136
1356
if data[0] == 'data':
2137
1357
return data[1]
2138
1358
if data[0] == 'function':
2139
2140
1359
def func(*args, **kwargs):
2141
1360
self._pipe.send(('funcall', name, args, kwargs))
2142
1361
return self._pipe.recv()[1]
2143
2144
1362
return func
2145
1363
2146
1364
def __setattr__(self, name, value):
2147
if name == '_pipe':
1365
if(name == '_pipe'):
2148
1366
return super(ProxyClient, self).__setattr__(name, value)
2149
1367
self._pipe.send(('setattr', name, value))
2150
1368
1369
class ClientDBusTransitional(ClientDBus):
1370
__metaclass__ = AlternateDBusNamesMetaclass
2151
1371
2152
1372
class ClientHandler(socketserver.BaseRequestHandler, object):
2153
1373
"""A class to handle client connections.
2158
1378
def handle(self):
2159
1379
with contextlib.closing(self.server.child_pipe) as child_pipe:
2160
1380
logger.info("TCP connection from: %s",
2161
str(self.client_address))
1381
unicode(self.client_address))
2162
1382
logger.debug("Pipe FD: %d",
2163
1383
self.server.child_pipe.fileno())
2164
1384
2165
session = gnutls.ClientSession(self.request)
1385
session = (gnutls.connection
1386
.ClientSession(self.request,
1387
gnutls.connection
1388
.X509Credentials()))
1389
1390
# Note: gnutls.connection.X509Credentials is really a
1391
# generic GnuTLS certificate credentials object so long as
1392
# no X.509 keys are added to it. Therefore, we can use it
1393
# here despite using OpenPGP certificates.
2166
1394
2167
1395
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
2168
1396
# "+AES-256-CBC", "+SHA1",
2172
1400
priority = self.server.gnutls_priority
2173
1401
if priority is None:
2174
1402
priority = "NORMAL"
2175
gnutls.priority_set_direct(session._c_object, priority,
2176
None)
1403
(gnutls.library.functions
1404
.gnutls_priority_set_direct(session._c_object,
1405
priority, None))
2177
1406
2178
1407
# Start communication using the Mandos protocol
2179
1408
# Get protocol number
2181
1410
logger.debug("Protocol version: %r", line)
2182
1411
try:
2183
1412
if int(line.strip().split()[0]) > 1:
2184
raise RuntimeError(line)
1413
raise RuntimeError
2185
1414
except (ValueError, IndexError, RuntimeError) as error:
2186
1415
logger.error("Unknown protocol version: %s", error)
2187
1416
return
2189
1418
# Start GnuTLS connection
2190
1419
try:
2191
1420
session.handshake()
2192
except gnutls.Error as error:
1421
except gnutls.errors.GNUTLSError as error:
2193
1422
logger.warning("Handshake failed: %s", error)
2194
1423
# Do not run session.bye() here: the session is not
2195
1424
# established. Just abandon the request.
2199
1428
approval_required = False
2200
1429
try:
2201
1430
try:
2202
fpr = self.fingerprint(
2203
self.peer_certificate(session))
2204
except (TypeError, gnutls.Error) as error:
1431
fpr = self.fingerprint(self.peer_certificate
1432
(session))
1433
except (TypeError,
1434
gnutls.errors.GNUTLSError) as error:
2205
1435
logger.warning("Bad certificate: %s", error)
2206
1436
return
2207
1437
logger.debug("Fingerprint: %s", fpr)
2220
1450
while True:
2221
1451
if not client.enabled:
2222
1452
logger.info("Client %s is disabled",
2223
client.name)
1453
client.name)
2224
1454
if self.server.use_dbus:
2225
1455
# Emit D-Bus signal
2226
1456
client.Rejected("Disabled")
2227
1457
return
2228
1458
2229
if client.approved or not client.approval_delay:
1459
if client._approved or not client.approval_delay:
2230
1460
#We are approved or approval is disabled
2231
1461
break
2232
elif client.approved is None:
1462
elif client._approved is None:
2233
1463
logger.info("Client %s needs approval",
2234
1464
client.name)
2235
1465
if self.server.use_dbus:
2236
1466
# Emit D-Bus signal
2237
1467
client.NeedApproval(
2238
client.approval_delay.total_seconds()
2239
* 1000, client.approved_by_default)
1468
client.approval_delay_milliseconds(),
1469
client.approved_by_default)
2240
1470
else:
2241
1471
logger.warning("Client %s was not approved",
2242
1472
client.name)
2248
1478
#wait until timeout or approved
2249
1479
time = datetime.datetime.now()
2250
1480
client.changedstate.acquire()
2251
client.changedstate.wait(delay.total_seconds())
1481
(client.changedstate.wait
1482
(float(client._timedelta_to_milliseconds(delay)
1483
/ 1000)))
2252
1484
client.changedstate.release()
2253
1485
time2 = datetime.datetime.now()
2254
1486
if (time2 - time) >= delay:
2265
1497
else:
2266
1498
delay -= time2 - time
2267
1499
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
1500
sent_size = 0
1501
while sent_size < len(client.secret):
1502
try:
1503
sent = session.send(client.secret[sent_size:])
1504
except gnutls.errors.GNUTLSError as error:
1505
logger.warning("gnutls send failed")
1506
return
1507
logger.debug("Sent: %d, remaining: %d",
1508
sent, len(client.secret)
1509
- (sent_size + sent))
1510
sent_size += sent
2274
1511
2275
1512
logger.info("Sending secret to %s", client.name)
2276
1513
# bump the timeout using extended_timeout
2277
client.bump_timeout(client.extended_timeout)
1514
client.checked_ok(client.extended_timeout)
2278
1515
if self.server.use_dbus:
2279
1516
# Emit D-Bus signal
2280
1517
client.GotSecret()
2284
1521
client.approvals_pending -= 1
2285
1522
try:
2286
1523
session.bye()
2287
except gnutls.Error as error:
2288
logger.warning("GnuTLS bye failed",
2289
exc_info=error)
1524
except gnutls.errors.GNUTLSError as error:
1525
logger.warning("GnuTLS bye failed")
2290
1526
2291
1527
@staticmethod
2292
1528
def peer_certificate(session):
2293
1529
"Return the peer's OpenPGP certificate as a bytestring"
2294
1530
# 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""
1531
if (gnutls.library.functions
1532
.gnutls_certificate_type_get(session._c_object)
1533
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1534
# ...do the normal thing
1535
return session.peer_certificate
2299
1536
list_size = ctypes.c_uint(1)
2300
cert_list = (gnutls.certificate_get_peers
1537
cert_list = (gnutls.library.functions
1538
.gnutls_certificate_get_peers
2301
1539
(session._c_object, ctypes.byref(list_size)))
2302
1540
if not bool(cert_list) and list_size.value != 0:
2303
raise gnutls.Error("error getting peer certificate")
1541
raise gnutls.errors.GNUTLSError("error getting peer"
1542
" certificate")
2304
1543
if list_size.value == 0:
2305
1544
return None
2306
1545
cert = cert_list[0]
2310
1549
def fingerprint(openpgp):
2311
1550
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
2312
1551
# 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)))
1552
datum = (gnutls.library.types
1553
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1554
ctypes.POINTER
1555
(ctypes.c_ubyte)),
1556
ctypes.c_uint(len(openpgp))))
2317
1557
# New empty GnuTLS certificate
2318
crt = gnutls.openpgp_crt_t()
2319
gnutls.openpgp_crt_init(ctypes.byref(crt))
1558
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1559
(gnutls.library.functions
1560
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2320
1561
# Import the OpenPGP public key into the certificate
2321
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2322
gnutls.OPENPGP_FMT_RAW)
1562
(gnutls.library.functions
1563
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1564
gnutls.library.constants
1565
.GNUTLS_OPENPGP_FMT_RAW))
2323
1566
# Verify the self signature in the key
2324
1567
crtverify = ctypes.c_uint()
2325
gnutls.openpgp_crt_verify_self(crt, 0,
2326
ctypes.byref(crtverify))
1568
(gnutls.library.functions
1569
.gnutls_openpgp_crt_verify_self(crt, 0,
1570
ctypes.byref(crtverify)))
2327
1571
if crtverify.value != 0:
2328
gnutls.openpgp_crt_deinit(crt)
2329
raise gnutls.CertificateSecurityError("Verify failed")
1572
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1573
raise (gnutls.errors.CertificateSecurityError
1574
("Verify failed"))
2330
1575
# New buffer for the fingerprint
2331
1576
buf = ctypes.create_string_buffer(20)
2332
1577
buf_len = ctypes.c_size_t()
2333
1578
# Get the fingerprint from the certificate into the buffer
2334
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2335
ctypes.byref(buf_len))
1579
(gnutls.library.functions
1580
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1581
ctypes.byref(buf_len)))
2336
1582
# Deinit the certificate
2337
gnutls.openpgp_crt_deinit(crt)
1583
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2338
1584
# Convert the buffer to a Python bytestring
2339
1585
fpr = ctypes.string_at(buf, buf_len.value)
2340
1586
# Convert the bytestring to hexadecimal notation
2341
hex_fpr = binascii.hexlify(fpr).upper()
1587
hex_fpr = ''.join("%02X" % ord(char) for char in fpr)
2342
1588
return hex_fpr
2343
1589
2344
1590
2345
1591
class MultiprocessingMixIn(object):
2346
1592
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2347
2348
1593
def sub_process_main(self, request, address):
2349
1594
try:
2350
1595
self.finish_request(request, address)
2351
except Exception:
1596
except:
2352
1597
self.handle_error(request, address)
2353
1598
self.close_request(request)
2354
1599
2355
1600
def process_request(self, request, address):
2356
1601
"""Start a new process to process the request."""
2357
1602
proc = multiprocessing.Process(target = self.sub_process_main,
2358
args = (request, address))
1603
args = (request,
1604
address))
2359
1605
proc.start()
2360
1606
return proc
2361
1607
2362
1608
2363
1609
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2364
1610
""" adds a pipe to the MixIn """
2365
2366
1611
def process_request(self, request, client_address):
2367
1612
"""Overrides and wraps the original process_request().
2368
1613
2377
1622
2378
1623
def add_pipe(self, parent_pipe, proc):
2379
1624
"""Dummy function; override as necessary"""
2380
raise NotImplementedError()
1625
raise NotImplementedError
2381
1626
2382
1627
2383
1628
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2389
1634
interface: None or a network interface name (string)
2390
1635
use_ipv6: Boolean; to use IPv6 or not
2391
1636
"""
2392
2393
1637
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
"""
1638
interface=None, use_ipv6=True):
2400
1639
self.interface = interface
2401
1640
if use_ipv6:
2402
1641
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
1642
socketserver.TCPServer.__init__(self, server_address,
2430
1643
RequestHandlerClass)
2431
2432
1644
def server_bind(self):
2433
1645
"""This overrides the normal server_bind() function
2434
1646
to bind to an interface if one was specified, and also NOT to
2440
1652
self.interface)
2441
1653
else:
2442
1654
try:
2443
self.socket.setsockopt(
2444
socket.SOL_SOCKET, SO_BINDTODEVICE,
2445
(self.interface + "\0").encode("utf-8"))
1655
self.socket.setsockopt(socket.SOL_SOCKET,
1656
SO_BINDTODEVICE,
1657
str(self.interface
1658
+ '\0'))
2446
1659
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:
1660
if error[0] == errno.EPERM:
1661
logger.error("No permission to"
1662
" bind to interface %s",
1663
self.interface)
1664
elif error[0] == errno.ENOPROTOOPT:
2451
1665
logger.error("SO_BINDTODEVICE not available;"
2452
1666
" cannot bind to interface %s",
2453
1667
self.interface)
2454
elif error.errno == errno.ENODEV:
2455
logger.error("Interface %s does not exist,"
2456
" cannot bind", self.interface)
2457
1668
else:
2458
1669
raise
2459
1670
# Only bind(2) the socket if we really need to.
2462
1673
if self.address_family == socket.AF_INET6:
2463
1674
any_address = "::" # in6addr_any
2464
1675
else:
2465
any_address = "0.0.0.0" # INADDR_ANY
1676
any_address = socket.INADDR_ANY
2466
1677
self.server_address = (any_address,
2467
1678
self.server_address[1])
2468
1679
elif not self.server_address[1]:
2469
self.server_address = (self.server_address[0], 0)
1680
self.server_address = (self.server_address[0],
1681
0)
2470
1682
# if self.interface:
2471
1683
# self.server_address = (self.server_address[0],
2472
1684
# 0, # port
2484
1696
gnutls_priority GnuTLS priority string
2485
1697
use_dbus: Boolean; to emit D-Bus signals or not
2486
1698
2487
Assumes a GLib.MainLoop event loop.
1699
Assumes a gobject.MainLoop event loop.
2488
1700
"""
2489
2490
1701
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):
1702
interface=None, use_ipv6=True, clients=None,
1703
gnutls_priority=None, use_dbus=True):
2497
1704
self.enabled = False
2498
1705
self.clients = clients
2499
1706
if self.clients is None:
2503
1710
IPv6_TCPServer.__init__(self, server_address,
2504
1711
RequestHandlerClass,
2505
1712
interface = interface,
2506
use_ipv6 = use_ipv6,
2507
socketfd = socketfd)
2508
1713
use_ipv6 = use_ipv6)
2509
1714
def server_activate(self):
2510
1715
if self.enabled:
2511
1716
return socketserver.TCPServer.server_activate(self)
2515
1720
2516
1721
def add_pipe(self, parent_pipe, proc):
2517
1722
# 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))
1723
gobject.io_add_watch(parent_pipe.fileno(),
1724
gobject.IO_IN | gobject.IO_HUP,
1725
functools.partial(self.handle_ipc,
1726
parent_pipe =
1727
parent_pipe,
1728
proc = proc))
2524
1729
2525
def handle_ipc(self, source, condition,
2526
parent_pipe=None,
2527
proc = None,
2528
client_object=None):
1730
def handle_ipc(self, source, condition, parent_pipe=None,
1731
proc = None, client_object=None):
1732
condition_names = {
1733
gobject.IO_IN: "IN", # There is data to read.
1734
gobject.IO_OUT: "OUT", # Data can be written (without
1735
# blocking).
1736
gobject.IO_PRI: "PRI", # There is urgent data to read.
1737
gobject.IO_ERR: "ERR", # Error condition.
1738
gobject.IO_HUP: "HUP" # Hung up (the connection has been
1739
# broken, usually for pipes and
1740
# sockets).
1741
}
1742
conditions_string = ' | '.join(name
1743
for cond, name in
1744
condition_names.iteritems()
1745
if cond & condition)
2529
1746
# error, or the other end of multiprocessing.Pipe has closed
2530
if condition & (GLib.IO_ERR | GLib.IO_HUP):
1747
if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
2531
1748
# Wait for other process to exit
2532
1749
proc.join()
2533
1750
return False
2540
1757
fpr = request[1]
2541
1758
address = request[2]
2542
1759
2543
for c in self.clients.values():
1760
for c in self.clients.itervalues():
2544
1761
if c.fingerprint == fpr:
2545
1762
client = c
2546
1763
break
2554
1771
parent_pipe.send(False)
2555
1772
return False
2556
1773
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))
1774
gobject.io_add_watch(parent_pipe.fileno(),
1775
gobject.IO_IN | gobject.IO_HUP,
1776
functools.partial(self.handle_ipc,
1777
parent_pipe =
1778
parent_pipe,
1779
proc = proc,
1780
client_object =
1781
client))
2564
1782
parent_pipe.send(True)
2565
1783
# remove the old hook in favor of the new above hook on
2566
1784
# same fileno
2572
1790
2573
1791
parent_pipe.send(('data', getattr(client_object,
2574
1792
funcname)(*args,
2575
**kwargs)))
1793
**kwargs)))
2576
1794
2577
1795
if command == 'getattr':
2578
1796
attrname = request[1]
2579
if isinstance(client_object.__getattribute__(attrname),
2580
collections.Callable):
2581
parent_pipe.send(('function', ))
1797
if callable(client_object.__getattribute__(attrname)):
1798
parent_pipe.send(('function',))
2582
1799
else:
2583
parent_pipe.send((
2584
'data', client_object.__getattribute__(attrname)))
1800
parent_pipe.send(('data', client_object
1801
.__getattribute__(attrname)))
2585
1802
2586
1803
if command == 'setattr':
2587
1804
attrname = request[1]
2591
1808
return True
2592
1809
2593
1810
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
1811
def string_to_delta(interval):
2691
1812
"""Parse a string and return a datetime.timedelta
2692
1813
2703
1824
>>> string_to_delta('5m 30s')
2704
1825
datetime.timedelta(0, 330)
2705
1826
"""
2706
2707
try:
2708
return rfc3339_duration_to_delta(interval)
2709
except ValueError:
2710
pass
2711
2712
1827
timevalue = datetime.timedelta(0)
2713
1828
for s in interval.split():
2714
1829
try:
2715
suffix = s[-1]
1830
suffix = unicode(s[-1])
2716
1831
value = int(s[:-1])
2717
1832
if suffix == "d":
2718
1833
delta = datetime.timedelta(value)
2725
1840
elif suffix == "w":
2726
1841
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2727
1842
else:
2728
raise ValueError("Unknown suffix {!r}".format(suffix))
2729
except IndexError as e:
1843
raise ValueError("Unknown suffix %r" % suffix)
1844
except (ValueError, IndexError) as e:
2730
1845
raise ValueError(*(e.args))
2731
1846
timevalue += delta
2732
1847
return timevalue
2733
1848
2734
1849
1850
def if_nametoindex(interface):
1851
"""Call the C function if_nametoindex(), or equivalent
1852
1853
Note: This function cannot accept a unicode string."""
1854
global if_nametoindex
1855
try:
1856
if_nametoindex = (ctypes.cdll.LoadLibrary
1857
(ctypes.util.find_library("c"))
1858
.if_nametoindex)
1859
except (OSError, AttributeError):
1860
logger.warning("Doing if_nametoindex the hard way")
1861
def if_nametoindex(interface):
1862
"Get an interface index the hard way, i.e. using fcntl()"
1863
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
1864
with contextlib.closing(socket.socket()) as s:
1865
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1866
struct.pack(str("16s16x"),
1867
interface))
1868
interface_index = struct.unpack(str("I"),
1869
ifreq[16:20])[0]
1870
return interface_index
1871
return if_nametoindex(interface)
1872
1873
2735
1874
def daemon(nochdir = False, noclose = False):
2736
1875
"""See daemon(3). Standard BSD Unix function.
2737
1876
2745
1884
sys.exit()
2746
1885
if not noclose:
2747
1886
# Close all standard open file descriptors
2748
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1887
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2749
1888
if not stat.S_ISCHR(os.fstat(null).st_mode):
2750
1889
raise OSError(errno.ENODEV,
2751
"{} not a character device"
2752
.format(os.devnull))
1890
"%s not a character device"
1891
% os.path.devnull)
2753
1892
os.dup2(null, sys.stdin.fileno())
2754
1893
os.dup2(null, sys.stdout.fileno())
2755
1894
os.dup2(null, sys.stderr.fileno())
2764
1903
2765
1904
parser = argparse.ArgumentParser()
2766
1905
parser.add_argument("-v", "--version", action="version",
2767
version = "%(prog)s {}".format(version),
1906
version = "%%(prog)s %s" % version,
2768
1907
help="show version number and exit")
2769
1908
parser.add_argument("-i", "--interface", metavar="IF",
2770
1909
help="Bind to interface IF")
2776
1915
help="Run self-test")
2777
1916
parser.add_argument("--debug", action="store_true",
2778
1917
help="Debug mode; run in foreground and log"
2779
" to terminal", default=None)
1918
" to terminal")
2780
1919
parser.add_argument("--debuglevel", metavar="LEVEL",
2781
1920
help="Debug level for stdout output")
2782
1921
parser.add_argument("--priority", help="GnuTLS"
2789
1928
" files")
2790
1929
parser.add_argument("--no-dbus", action="store_false",
2791
1930
dest="use_dbus", help="Do not provide D-Bus"
2792
" system bus interface", default=None)
1931
" system bus interface")
2793
1932
parser.add_argument("--no-ipv6", action="store_false",
2794
dest="use_ipv6", help="Do not use IPv6",
2795
default=None)
1933
dest="use_ipv6", help="Do not use IPv6")
2796
1934
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
1935
dest="restore",
1936
help="Do not restore stored state",
1937
default=True)
1938
2810
1939
options = parser.parse_args()
2811
1940
2812
1941
if options.check:
2813
1942
import doctest
2814
fail_count, test_count = doctest.testmod()
2815
sys.exit(os.EX_OK if fail_count == 0 else 1)
1943
doctest.testmod()
1944
sys.exit()
2816
1945
2817
1946
# Default values for config file for server-global settings
2818
1947
server_defaults = { "interface": "",
2820
1949
"port": "",
2821
1950
"debug": "False",
2822
1951
"priority":
2823
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2824
":+SIGN-DSA-SHA256",
1952
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
2825
1953
"servicename": "Mandos",
2826
1954
"use_dbus": "True",
2827
1955
"use_ipv6": "True",
2828
1956
"debuglevel": "",
2829
"restore": "True",
2830
"socket": "",
2831
"statedir": "/var/lib/mandos",
2832
"foreground": "False",
2833
"zeroconf": "True",
2834
}
1957
}
2835
1958
2836
1959
# Parse config file for server-global settings
2837
1960
server_config = configparser.SafeConfigParser(server_defaults)
2838
1961
del server_defaults
2839
server_config.read(os.path.join(options.configdir, "mandos.conf"))
1962
server_config.read(os.path.join(options.configdir,
1963
"mandos.conf"))
2840
1964
# Convert the SafeConfigParser object to a dict
2841
1965
server_settings = server_config.defaults()
2842
1966
# Use the appropriate methods on the non-string config options
2843
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
1967
for option in ("debug", "use_dbus", "use_ipv6"):
2844
1968
server_settings[option] = server_config.getboolean("DEFAULT",
2845
1969
option)
2846
1970
if server_settings["port"]:
2847
1971
server_settings["port"] = server_config.getint("DEFAULT",
2848
1972
"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
1973
del server_config
2859
1974
2860
1975
# Override the settings from the config file with command line
2861
1976
# options, if set.
2862
1977
for option in ("interface", "address", "port", "debug",
2863
"priority", "servicename", "configdir", "use_dbus",
2864
"use_ipv6", "debuglevel", "restore", "statedir",
2865
"socket", "foreground", "zeroconf"):
1978
"priority", "servicename", "configdir",
1979
"use_dbus", "use_ipv6", "debuglevel", "restore"):
2866
1980
value = getattr(options, option)
2867
1981
if value is not None:
2868
1982
server_settings[option] = value
2869
1983
del options
2870
1984
# Force all strings to be unicode
2871
1985
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
1986
if type(server_settings[option]) is str:
1987
server_settings[option] = unicode(server_settings[option])
2882
1988
# Now we have our good server settings in "server_settings"
2883
1989
2884
1990
##################################################################
2885
1991
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
1992
# For convenience
2892
1993
debug = server_settings["debug"]
2893
1994
debuglevel = server_settings["debuglevel"]
2894
1995
use_dbus = server_settings["use_dbus"]
2895
1996
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
1997
2910
1998
if server_settings["servicename"] != "Mandos":
2911
syslogger.setFormatter(
2912
logging.Formatter('Mandos ({}) [%(process)d]:'
2913
' %(levelname)s: %(message)s'.format(
2914
server_settings["servicename"])))
1999
syslogger.setFormatter(logging.Formatter
2000
('Mandos (%s) [%%(process)d]:'
2001
' %%(levelname)s: %%(message)s'
2002
% server_settings["servicename"]))
2915
2003
2916
2004
# Parse config file with clients
2917
client_config = configparser.SafeConfigParser(Client
2918
.client_defaults)
2005
client_defaults = { "timeout": "5m",
2006
"extended_timeout": "15m",
2007
"interval": "2m",
2008
"checker": "fping -q -- %%(host)s",
2009
"host": "",
2010
"approval_delay": "0s",
2011
"approval_duration": "1s",
2012
}
2013
client_config = configparser.SafeConfigParser(client_defaults)
2919
2014
client_config.read(os.path.join(server_settings["configdir"],
2920
2015
"clients.conf"))
2921
2016
2922
2017
global mandos_dbus_service
2923
2018
mandos_dbus_service = None
2924
2019
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
2020
tcp_server = MandosServer((server_settings["address"],
2021
server_settings["port"]),
2022
ClientHandler,
2023
interface=(server_settings["interface"]
2024
or None),
2025
use_ipv6=use_ipv6,
2026
gnutls_priority=
2027
server_settings["priority"],
2028
use_dbus=use_dbus)
2029
if not debug:
2030
pidfilename = "/var/run/mandos.pid"
2941
2031
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)
2032
pidfile = open(pidfilename, "w")
2033
except IOError:
2034
logger.error("Could not open file %r", pidfilename)
2946
2035
2947
for name, group in (("_mandos", "_mandos"),
2948
("mandos", "mandos"),
2949
("nobody", "nogroup")):
2036
try:
2037
uid = pwd.getpwnam("_mandos").pw_uid
2038
gid = pwd.getpwnam("_mandos").pw_gid
2039
except KeyError:
2950
2040
try:
2951
uid = pwd.getpwnam(name).pw_uid
2952
gid = pwd.getpwnam(group).pw_gid
2953
break
2041
uid = pwd.getpwnam("mandos").pw_uid
2042
gid = pwd.getpwnam("mandos").pw_gid
2954
2043
except KeyError:
2955
continue
2956
else:
2957
uid = 65534
2958
gid = 65534
2044
try:
2045
uid = pwd.getpwnam("nobody").pw_uid
2046
gid = pwd.getpwnam("nobody").pw_gid
2047
except KeyError:
2048
uid = 65534
2049
gid = 65534
2959
2050
try:
2960
2051
os.setgid(gid)
2961
2052
os.setuid(uid)
2962
if debug:
2963
logger.debug("Did setuid/setgid to {}:{}".format(uid,
2964
gid))
2965
2053
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
2054
if error[0] != errno.EPERM:
2055
raise error
2056
2057
if not debug and not debuglevel:
2058
logger.setLevel(logging.WARNING)
2059
if debuglevel:
2060
level = getattr(logging, debuglevel.upper())
2061
logger.setLevel(level)
2970
2062
2971
2063
if debug:
2064
logger.setLevel(logging.DEBUG)
2972
2065
# Enable all possible GnuTLS debugging
2973
2066
2974
2067
# "Use a log level over 10 to enable all debugging options."
2975
2068
# - GnuTLS manual
2976
gnutls.global_set_log_level(11)
2069
gnutls.library.functions.gnutls_global_set_log_level(11)
2977
2070
2978
@gnutls.log_func
2071
@gnutls.library.types.gnutls_log_func
2979
2072
def debug_gnutls(level, string):
2980
2073
logger.debug("GnuTLS: %s", string[:-1])
2981
2074
2982
gnutls.global_set_log_function(debug_gnutls)
2075
(gnutls.library.functions
2076
.gnutls_global_set_log_function(debug_gnutls))
2983
2077
2984
2078
# Redirect stdin so all checkers get /dev/null
2985
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2079
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2986
2080
os.dup2(null, sys.stdin.fileno())
2987
2081
if null > 2:
2988
2082
os.close(null)
2083
else:
2084
# No console logging
2085
logger.removeHandler(console)
2989
2086
2990
2087
# Need to fork before connecting to D-Bus
2991
if not foreground:
2088
if not debug:
2992
2089
# Close all input and output, do double fork, etc.
2993
2090
daemon()
2994
2091
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
2092
global main_loop
3000
2093
# From the Avahi example code
3001
DBusGMainLoop(set_as_default=True)
3002
main_loop = GLib.MainLoop()
2094
DBusGMainLoop(set_as_default=True )
2095
main_loop = gobject.MainLoop()
3003
2096
bus = dbus.SystemBus()
3004
2097
# End of Avahi example code
3005
2098
if use_dbus:
3006
2099
try:
3007
2100
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)
2101
bus, do_not_queue=True)
2102
old_bus_name = (dbus.service.BusName
2103
("se.bsnet.fukt.Mandos", bus,
2104
do_not_queue=True))
2105
except dbus.exceptions.NameExistsException as e:
2106
logger.error(unicode(e) + ", disabling D-Bus")
3015
2107
use_dbus = False
3016
2108
server_settings["use_dbus"] = False
3017
2109
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"))
2110
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2111
service = AvahiServiceToSyslog(name =
2112
server_settings["servicename"],
2113
servicetype = "_mandos._tcp",
2114
protocol = protocol, bus = bus)
2115
if server_settings["interface"]:
2116
service.interface = (if_nametoindex
2117
(str(server_settings["interface"])))
3028
2118
3029
2119
global multiprocessing_manager
3030
2120
multiprocessing_manager = multiprocessing.Manager()
3031
2121
3032
2122
client_class = Client
3033
2123
if use_dbus:
3034
client_class = functools.partial(ClientDBus, bus = bus)
3035
3036
client_settings = Client.config_parser(client_config)
2124
client_class = functools.partial(ClientDBusTransitional,
2125
bus = bus)
2126
2127
special_settings = {
2128
# Some settings need to be accessd by special methods;
2129
# booleans need .getboolean(), etc. Here is a list of them:
2130
"approved_by_default":
2131
lambda section:
2132
client_config.getboolean(section, "approved_by_default"),
2133
}
2134
# Construct a new dict of client settings of this form:
2135
# { client_name: {setting_name: value, ...}, ...}
2136
# with exceptions for any special settings as defined above
2137
client_settings = dict((clientname,
2138
dict((setting,
2139
(value if
2140
setting not in special_settings
2141
else special_settings[setting]
2142
(clientname)))
2143
for setting, value
2144
in client_config.items(clientname)))
2145
for clientname in client_config.sections())
2146
3037
2147
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.
2148
clients_data = []
2149
2150
# Get client data and settings from last running state.
3049
2151
if server_settings["restore"]:
3050
2152
try:
3051
2153
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"))
2154
clients_data, old_client_settings = (
2155
pickle.load(stored_state))
3097
2156
os.remove(stored_state_path)
3098
2157
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)
2158
logger.warning("Could not load persistant state: {0}"
2159
.format(e))
2160
if e.errno != errno.ENOENT:
3105
2161
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))
2162
2163
for client in clients_data:
2164
client_name = client["name"]
2165
2166
# Decide which value to use after restoring saved state.
2167
# We have three different values: Old config file,
2168
# new config file, and saved state.
2169
# New config value takes precedence if it differs from old
2170
# config value, otherwise use saved state.
2171
for name, value in client_settings[client_name].items():
3162
2172
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)
2173
# For each value in new config, check if it differs
2174
# from the old config value (Except for the "secret"
2175
# attribute)
2176
if (name != "secret" and
2177
value != old_client_settings[client_name][name]):
2178
setattr(client, name, value)
2179
except KeyError:
2180
pass
2181
2182
# Clients who has passed its expire date, can still be enabled
2183
# if its last checker was sucessful. Clients who checkers
2184
# failed before we stored it state is asumed to had failed
2185
# checker during downtime.
2186
if client["enabled"] and client["last_checked_ok"]:
2187
if ((datetime.datetime.utcnow()
2188
- client["last_checked_ok"]) > client["interval"]):
2189
if client["last_checker_status"] != 0:
2190
client["enabled"] = False
2191
else:
2192
client["expires"] = (datetime.datetime.utcnow()
2193
+ client["timeout"])
2194
2195
client["changedstate"] = (multiprocessing_manager
2196
.Condition(multiprocessing_manager
2197
.Lock()))
2198
if use_dbus:
2199
new_client = ClientDBusTransitional.__new__(
2200
ClientDBusTransitional)
2201
tcp_server.clients[client_name] = new_client
2202
new_client.bus = bus
2203
for name, value in client.iteritems():
2204
setattr(new_client, name, value)
2205
new_client._approvals_pending = 0
2206
new_client.add_to_dbus()
2207
else:
2208
tcp_server.clients[client_name] = Client.__new__(Client)
2209
for name, value in client.iteritems():
2210
setattr(tcp_server.clients[client_name], name, value)
2211
2212
tcp_server.clients[client_name].decrypt_secret(
2213
client_settings[client_name]["secret"])
2214
2215
# Create/remove clients based on new changes made to config
2216
for clientname in set(old_client_settings) - set(client_settings):
2217
del tcp_server.clients[clientname]
2218
for clientname in set(client_settings) - set(old_client_settings):
2219
tcp_server.clients[clientname] = client_class(name
2220
= clientname,
2221
config =
2222
client_settings
2223
[clientname])
3187
2224
3188
2225
if not tcp_server.clients:
3189
2226
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
2227
2228
if not debug:
2229
try:
2230
with pidfile:
2231
pid = os.getpid()
2232
pidfile.write(str(pid) + "\n".encode("utf-8"))
2233
del pidfile
2234
except IOError:
2235
logger.error("Could not write to file %r with PID %d",
2236
pidfilename, pid)
2237
except NameError:
2238
# "pidfile" was never created
2239
pass
3201
2240
del pidfilename
2241
2242
signal.signal(signal.SIGINT, signal.SIG_IGN)
3202
2243
3203
2244
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
3204
2245
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
3205
2246
3206
2247
if use_dbus:
3207
3208
@alternate_dbus_interfaces(
3209
{ "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
3210
class MandosDBusService(DBusObjectWithObjectManager):
2248
class MandosDBusService(dbus.service.Object):
3211
2249
"""A D-Bus proxy object"""
3212
3213
2250
def __init__(self):
3214
2251
dbus.service.Object.__init__(self, bus, "/")
3215
3216
2252
_interface = "se.recompile.Mandos"
3217
2253
3218
2254
@dbus.service.signal(_interface, signature="o")
3225
2261
"D-Bus signal"
3226
2262
pass
3227
2263
3228
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3229
"true"})
3230
2264
@dbus.service.signal(_interface, signature="os")
3231
2265
def ClientRemoved(self, objpath, name):
3232
2266
"D-Bus signal"
3233
2267
pass
3234
2268
3235
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3236
"true"})
3237
2269
@dbus.service.method(_interface, out_signature="ao")
3238
2270
def GetAllClients(self):
3239
2271
"D-Bus method"
3240
return dbus.Array(c.dbus_object_path for c in
3241
tcp_server.clients.values())
2272
return dbus.Array(c.dbus_object_path
2273
for c in
2274
tcp_server.clients.itervalues())
3242
2275
3243
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3244
"true"})
3245
2276
@dbus.service.method(_interface,
3246
2277
out_signature="a{oa{sv}}")
3247
2278
def GetAllClientsWithProperties(self):
3248
2279
"D-Bus method"
3249
2280
return dbus.Dictionary(
3250
{ c.dbus_object_path: c.GetAll(
3251
"se.recompile.Mandos.Client")
3252
for c in tcp_server.clients.values() },
2281
((c.dbus_object_path, c.GetAll(""))
2282
for c in tcp_server.clients.itervalues()),
3253
2283
signature="oa{sv}")
3254
2284
3255
2285
@dbus.service.method(_interface, in_signature="o")
3256
2286
def RemoveClient(self, object_path):
3257
2287
"D-Bus method"
3258
for c in tcp_server.clients.values():
2288
for c in tcp_server.clients.itervalues():
3259
2289
if c.dbus_object_path == object_path:
3260
2290
del tcp_server.clients[c.name]
3261
2291
c.remove_from_connection()
3262
# Don't signal the disabling
2292
# Don't signal anything except ClientRemoved
3263
2293
c.disable(quiet=True)
3264
# Emit D-Bus signal for removal
3265
self.client_removed_signal(c)
2294
# Emit D-Bus signal
2295
self.ClientRemoved(object_path, c.name)
3266
2296
return
3267
2297
raise KeyError(object_path)
3268
2298
3269
2299
del _interface
3270
3271
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3272
out_signature = "a{oa{sa{sv}}}")
3273
def GetManagedObjects(self):
3274
"""D-Bus method"""
3275
return dbus.Dictionary(
3276
{ client.dbus_object_path:
3277
dbus.Dictionary(
3278
{ interface: client.GetAll(interface)
3279
for interface in
3280
client._get_all_interface_names()})
3281
for client in tcp_server.clients.values()})
3282
3283
def client_added_signal(self, client):
3284
"""Send the new standard signal and the old signal"""
3285
if use_dbus:
3286
# New standard signal
3287
self.InterfacesAdded(
3288
client.dbus_object_path,
3289
dbus.Dictionary(
3290
{ interface: client.GetAll(interface)
3291
for interface in
3292
client._get_all_interface_names()}))
3293
# Old signal
3294
self.ClientAdded(client.dbus_object_path)
3295
3296
def client_removed_signal(self, client):
3297
"""Send the new standard signal and the old signal"""
3298
if use_dbus:
3299
# New standard signal
3300
self.InterfacesRemoved(
3301
client.dbus_object_path,
3302
client._get_all_interface_names())
3303
# Old signal
3304
self.ClientRemoved(client.dbus_object_path,
3305
client.name)
3306
2300
3307
mandos_dbus_service = MandosDBusService()
2301
class MandosDBusServiceTransitional(MandosDBusService):
2302
__metaclass__ = AlternateDBusNamesMetaclass
2303
mandos_dbus_service = MandosDBusServiceTransitional()
3308
2304
3309
2305
def cleanup():
3310
2306
"Cleanup function; run on exit"
3311
if zeroconf:
3312
service.cleanup()
2307
service.cleanup()
3313
2308
3314
2309
multiprocessing.active_children()
3315
wnull.close()
3316
2310
if not (tcp_server.clients or client_settings):
3317
2311
return
3318
2312
3319
2313
# Store client before exiting. Secrets are encrypted with key
3320
2314
# based on what config file has. If config file is
3321
2315
# removed/edited, old secret will thus be unrecovable.
3322
clients = {}
3323
with PGPEngine() as pgp:
3324
for client in tcp_server.clients.values():
3325
key = client_settings[client.name]["secret"]
3326
client.encrypted_secret = pgp.encrypt(client.secret,
3327
key)
3328
client_dict = {}
3329
3330
# A list of attributes that can not be pickled
3331
# + secret.
3332
exclude = { "bus", "changedstate", "secret",
3333
"checker", "server_settings" }
3334
for name, typ in inspect.getmembers(dbus.service
3335
.Object):
3336
exclude.add(name)
3337
3338
client_dict["encrypted_secret"] = (client
3339
.encrypted_secret)
3340
for attr in client.client_structure:
3341
if attr not in exclude:
3342
client_dict[attr] = getattr(client, attr)
3343
3344
clients[client.name] = client_dict
3345
del client_settings[client.name]["secret"]
3346
2316
clients = []
2317
for client in tcp_server.clients.itervalues():
2318
client.encrypt_secret(
2319
client_settings[client.name]["secret"])
2320
2321
client_dict = {}
2322
2323
# A list of attributes that will not be stored when
2324
# shutting down.
2325
exclude = set(("bus", "changedstate", "secret"))
2326
for name, typ in inspect.getmembers(dbus.service.Object):
2327
exclude.add(name)
2328
2329
client_dict["encrypted_secret"] = client.encrypted_secret
2330
for attr in client.client_structure:
2331
if attr not in exclude:
2332
client_dict[attr] = getattr(client, attr)
2333
2334
clients.append(client_dict)
2335
del client_settings[client.name]["secret"]
2336
3347
2337
try:
3348
with tempfile.NamedTemporaryFile(
3349
mode='wb',
3350
suffix=".pickle",
3351
prefix='clients-',
3352
dir=os.path.dirname(stored_state_path),
3353
delete=False) as stored_state:
3354
pickle.dump((clients, client_settings), stored_state,
3355
protocol = 2)
3356
tempname = stored_state.name
3357
os.rename(tempname, stored_state_path)
3358
except (IOError, OSError) as e:
3359
if not debug:
3360
try:
3361
os.remove(tempname)
3362
except NameError:
3363
pass
3364
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3365
logger.warning("Could not save persistent state: {}"
3366
.format(os.strerror(e.errno)))
3367
else:
3368
logger.warning("Could not save persistent state:",
3369
exc_info=e)
2338
with os.fdopen(os.open(stored_state_path,
2339
os.O_CREAT|os.O_WRONLY|os.O_TRUNC,
2340
stat.S_IRUSR | stat.S_IWUSR),
2341
"wb") as stored_state:
2342
pickle.dump((clients, client_settings), stored_state)
2343
except IOError as e:
2344
logger.warning("Could not save persistant state: {0}"
2345
.format(e))
2346
if e.errno != errno.ENOENT:
3370
2347
raise
3371
2348
3372
2349
# Delete all clients, and settings from config
3373
2350
while tcp_server.clients:
3374
2351
name, client = tcp_server.clients.popitem()
3375
2352
if use_dbus:
3376
2353
client.remove_from_connection()
3377
# Don't signal the disabling
2354
# Don't signal anything except ClientRemoved
3378
2355
client.disable(quiet=True)
3379
# Emit D-Bus signal for removal
3380
2356
if use_dbus:
3381
mandos_dbus_service.client_removed_signal(client)
2357
# Emit D-Bus signal
2358
mandos_dbus_service.ClientRemoved(client
2359
.dbus_object_path,
2360
client.name)
3382
2361
client_settings.clear()
3383
2362
3384
2363
atexit.register(cleanup)
3385
2364
3386
for client in tcp_server.clients.values():
2365
for client in tcp_server.clients.itervalues():
3387
2366
if use_dbus:
3388
# Emit D-Bus signal for adding
3389
mandos_dbus_service.client_added_signal(client)
2367
# Emit D-Bus signal
2368
mandos_dbus_service.ClientAdded(client.dbus_object_path)
3390
2369
# Need to initiate checking of clients
3391
2370
if client.enabled:
3392
2371
client.init_checker()
2372
3393
2373
3394
2374
tcp_server.enable()
3395
2375
tcp_server.server_activate()
3396
2376
3397
2377
# Find out what port we got
3398
if zeroconf:
3399
service.port = tcp_server.socket.getsockname()[1]
2378
service.port = tcp_server.socket.getsockname()[1]
3400
2379
if use_ipv6:
3401
2380
logger.info("Now listening on address %r, port %d,"
3402
" flowinfo %d, scope_id %d",
3403
*tcp_server.socket.getsockname())
2381
" flowinfo %d, scope_id %d"
2382
% tcp_server.socket.getsockname())
3404
2383
else: # IPv4
3405
logger.info("Now listening on address %r, port %d",
3406
*tcp_server.socket.getsockname())
2384
logger.info("Now listening on address %r, port %d"
2385
% tcp_server.socket.getsockname())
3407
2386
3408
2387
#service.interface = tcp_server.socket.getsockname()[3]
3409
2388
3410
2389
try:
3411
if zeroconf:
3412
# From the Avahi example code
3413
try:
3414
service.activate()
3415
except dbus.exceptions.DBusException as error:
3416
logger.critical("D-Bus Exception", exc_info=error)
3417
cleanup()
3418
sys.exit(1)
3419
# End of Avahi example code
2390
# From the Avahi example code
2391
try:
2392
service.activate()
2393
except dbus.exceptions.DBusException as error:
2394
logger.critical("DBusException: %s", error)
2395
cleanup()
2396
sys.exit(1)
2397
# End of Avahi example code
3420
2398
3421
GLib.io_add_watch(tcp_server.fileno(), GLib.IO_IN,
3422
lambda *args, **kwargs:
3423
(tcp_server.handle_request
3424
(*args[2:], **kwargs) or True))
2399
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2400
lambda *args, **kwargs:
2401
(tcp_server.handle_request
2402
(*args[2:], **kwargs) or True))
3425
2403
3426
2404
logger.debug("Starting main loop")
3427
2405
main_loop.run()
3428
2406
except AvahiError as error:
3429
logger.critical("Avahi Error", exc_info=error)
2407
logger.critical("AvahiError: %s", error)
3430
2408
cleanup()
3431
2409
sys.exit(1)
3432
2410
except KeyboardInterrupt:
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0