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