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