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