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