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