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