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