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