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