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