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