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