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