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