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