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 856
- compare with another revision
- download diff
- download tarball
- view history from revision 856
- Committer: Teddy Hogeborn
- Date: 2016-06-22 04:42:23 UTC
- Revision ID: teddy@recompile.se-20160622044223-ew442xmt3c3bg76n
Client: Do not install intro(8mandos) manual page
When installing client, do not include the intro(8mandos) manual page
to avoid a conflict with the files from a server install.
* Makefile (install-client-nokey): Do not install intro.8mandos.
When installing client, do not include the intro(8mandos) manual page
to avoid a conflict with the files from a server install.
* Makefile (install-client-nokey): Do not install intro.8mandos.
- files added:
- bugs.xml
- debian/upstream
- 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-2011 Teddy Hogeborn
15
# Copyright © 2008-2011 Björn Påhlsson
14
# Copyright © 2008-2016 Teddy Hogeborn
15
# Copyright © 2008-2016 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
import SocketServer as socketserver
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
38
46
import socket
39
47
import argparse
40
48
import datetime
41
49
import errno
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
50
try:
51
import ConfigParser as configparser
52
except ImportError:
53
import configparser
49
54
import sys
50
55
import re
51
56
import os
60
65
import struct
61
66
import fcntl
62
67
import functools
63
import cPickle as pickle
68
try:
69
import cPickle as pickle
70
except ImportError:
71
import pickle
64
72
import multiprocessing
65
73
import types
74
import binascii
75
import tempfile
76
import itertools
77
import collections
78
import codecs
66
79
67
80
import dbus
68
81
import dbus.service
69
import gobject
70
import avahi
82
from gi.repository import GLib
71
83
from dbus.mainloop.glib import DBusGMainLoop
72
84
import ctypes
73
85
import ctypes.util
74
86
import xml.dom.minidom
75
87
import inspect
76
88
89
# Try to find the value of SO_BINDTODEVICE:
77
90
try:
91
# This is where SO_BINDTODEVICE is in Python 3.3 (or 3.4?) and
92
# newer, and it is also the most natural place for it:
78
93
SO_BINDTODEVICE = socket.SO_BINDTODEVICE
79
94
except AttributeError:
80
95
try:
96
# This is where SO_BINDTODEVICE was up to and including Python
97
# 2.6, and also 3.2:
81
98
from IN import SO_BINDTODEVICE
82
99
except ImportError:
83
SO_BINDTODEVICE = None
84
85
86
version = "1.4.1"
87
88
#logger = logging.getLogger('mandos')
89
logger = logging.Logger('mandos')
90
syslogger = (logging.handlers.SysLogHandler
91
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
92
address = str("/dev/log")))
93
syslogger.setFormatter(logging.Formatter
94
('Mandos [%(process)d]: %(levelname)s:'
95
' %(message)s'))
96
logger.addHandler(syslogger)
97
98
console = logging.StreamHandler()
99
console.setFormatter(logging.Formatter('%(name)s [%(process)d]:'
100
' %(levelname)s:'
101
' %(message)s'))
102
logger.addHandler(console)
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.8"
118
stored_state_file = "clients.pickle"
119
120
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()
103
299
104
300
class AvahiError(Exception):
105
301
def __init__(self, value, *args, **kwargs):
106
302
self.value = value
107
super(AvahiError, self).__init__(value, *args, **kwargs)
108
def __unicode__(self):
109
return unicode(repr(self.value))
303
return super(AvahiError, self).__init__(value, *args,
304
**kwargs)
305
110
306
111
307
class AvahiServiceError(AvahiError):
112
308
pass
113
309
310
114
311
class AvahiGroupError(AvahiError):
115
312
pass
116
313
123
320
Used to optionally bind to the specified interface.
124
321
name: string; Example: 'Mandos'
125
322
type: string; Example: '_mandos._tcp'.
126
See <http://www.dns-sd.org/ServiceTypes.html>
323
See <https://www.iana.org/assignments/service-names-port-numbers>
127
324
port: integer; what port to announce
128
325
TXT: list of strings; TXT record for the service
129
326
domain: string; Domain to publish on, default to .local if empty.
135
332
server: D-Bus Server
136
333
bus: dbus.SystemBus()
137
334
"""
138
def __init__(self, interface = avahi.IF_UNSPEC, name = None,
139
servicetype = None, port = None, TXT = None,
140
domain = "", host = "", max_renames = 32768,
141
protocol = avahi.PROTO_UNSPEC, bus = None):
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):
142
347
self.interface = interface
143
348
self.name = name
144
349
self.type = servicetype
153
358
self.server = None
154
359
self.bus = bus
155
360
self.entry_group_state_changed_match = None
156
def rename(self):
361
362
def rename(self, remove=True):
157
363
"""Derived from the Avahi example code"""
158
364
if self.rename_count >= self.max_renames:
159
365
logger.critical("No suitable Zeroconf service name found"
160
366
" after %i retries, exiting.",
161
367
self.rename_count)
162
368
raise AvahiServiceError("Too many renames")
163
self.name = unicode(self.server
164
.GetAlternativeServiceName(self.name))
369
self.name = str(
370
self.server.GetAlternativeServiceName(self.name))
371
self.rename_count += 1
165
372
logger.info("Changing Zeroconf service name to %r ...",
166
373
self.name)
167
syslogger.setFormatter(logging.Formatter
168
('Mandos (%s) [%%(process)d]:'
169
' %%(levelname)s: %%(message)s'
170
% self.name))
171
self.remove()
374
if remove:
375
self.remove()
172
376
try:
173
377
self.add()
174
378
except dbus.exceptions.DBusException as error:
175
logger.critical("DBusException: %s", error)
176
self.cleanup()
177
os._exit(1)
178
self.rename_count += 1
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
179
388
def remove(self):
180
389
"""Derived from the Avahi example code"""
181
390
if self.entry_group_state_changed_match is not None:
183
392
self.entry_group_state_changed_match = None
184
393
if self.group is not None:
185
394
self.group.Reset()
395
186
396
def add(self):
187
397
"""Derived from the Avahi example code"""
188
398
self.remove()
193
403
avahi.DBUS_INTERFACE_ENTRY_GROUP)
194
404
self.entry_group_state_changed_match = (
195
405
self.group.connect_to_signal(
196
'StateChanged', self .entry_group_state_changed))
406
'StateChanged', self.entry_group_state_changed))
197
407
logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
198
408
self.name, self.type)
199
409
self.group.AddService(
205
415
dbus.UInt16(self.port),
206
416
avahi.string_array_to_txt_array(self.TXT))
207
417
self.group.Commit()
418
208
419
def entry_group_state_changed(self, state, error):
209
420
"""Derived from the Avahi example code"""
210
421
logger.debug("Avahi entry group state change: %i", state)
216
427
self.rename()
217
428
elif state == avahi.ENTRY_GROUP_FAILURE:
218
429
logger.critical("Avahi: Error in group state changed %s",
219
unicode(error))
220
raise AvahiGroupError("State changed: %s"
221
% unicode(error))
430
str(error))
431
raise AvahiGroupError("State changed: {!s}".format(error))
432
222
433
def cleanup(self):
223
434
"""Derived from the Avahi example code"""
224
435
if self.group is not None:
225
436
try:
226
437
self.group.Free()
227
438
except (dbus.exceptions.UnknownMethodException,
228
dbus.exceptions.DBusException) as e:
439
dbus.exceptions.DBusException):
229
440
pass
230
441
self.group = None
231
442
self.remove()
443
232
444
def server_state_changed(self, state, error=None):
233
445
"""Derived from the Avahi example code"""
234
446
logger.debug("Avahi server state change: %i", state)
235
bad_states = { avahi.SERVER_INVALID:
236
"Zeroconf server invalid",
237
avahi.SERVER_REGISTERING: None,
238
avahi.SERVER_COLLISION:
239
"Zeroconf server name collision",
240
avahi.SERVER_FAILURE:
241
"Zeroconf server failure" }
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
}
242
453
if state in bad_states:
243
454
if bad_states[state] is not None:
244
455
if error is None:
247
458
logger.error(bad_states[state] + ": %r", error)
248
459
self.cleanup()
249
460
elif state == avahi.SERVER_RUNNING:
250
self.add()
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
473
else:
252
474
if error is None:
253
475
logger.debug("Unknown state: %r", state)
254
476
else:
255
477
logger.debug("Unknown state: %r: %r", state, error)
478
256
479
def activate(self):
257
480
"""Derived from the Avahi example code"""
258
481
if self.server is None:
262
485
follow_name_owner_changes=True),
263
486
avahi.DBUS_INTERFACE_SERVER)
264
487
self.server.connect_to_signal("StateChanged",
265
self.server_state_changed)
488
self.server_state_changed)
266
489
self.server_state_changed(self.server.GetState())
267
490
268
491
269
def _timedelta_to_milliseconds(td):
270
"Convert a datetime.timedelta() to milliseconds"
271
return ((td.days * 24 * 60 * 60 * 1000)
272
+ (td.seconds * 1000)
273
+ (td.microseconds // 1000))
274
492
class AvahiServiceToSyslog(AvahiService):
493
def rename(self, *args, **kwargs):
494
"""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)))
499
return ret
500
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
275
766
class Client(object):
276
767
"""A representation of a client host served by this server.
277
768
278
769
Attributes:
279
_approved: bool(); 'None' if not yet approved/disapproved
770
approved: bool(); 'None' if not yet approved/disapproved
280
771
approval_delay: datetime.timedelta(); Time to wait for approval
281
772
approval_duration: datetime.timedelta(); Duration of one approval
282
773
checker: subprocess.Popen(); a running checker process used
283
774
to see if the client lives.
284
775
'None' if no process is running.
285
checker_callback_tag: a gobject event source tag, or None
776
checker_callback_tag: a GLib event source tag, or None
286
777
checker_command: string; External command which is run to check
287
778
if client lives. %() expansions are done at
288
779
runtime with vars(self) as dict, so that for
289
780
instance %(name)s can be used in the command.
290
checker_initiator_tag: a gobject event source tag, or None
781
checker_initiator_tag: a GLib event source tag, or None
291
782
created: datetime.datetime(); (UTC) object creation
783
client_structure: Object describing what attributes a client has
784
and is used for storing the client at exit
292
785
current_checker_command: string; current running checker_command
293
disable_hook: If set, called by disable() as disable_hook(self)
294
disable_initiator_tag: a gobject event source tag, or None
786
disable_initiator_tag: a GLib event source tag, or None
295
787
enabled: bool()
296
788
fingerprint: string (40 or 32 hexadecimal digits); used to
297
789
uniquely identify the client
299
791
interval: datetime.timedelta(); How often to start a new checker
300
792
last_approval_request: datetime.datetime(); (UTC) or None
301
793
last_checked_ok: datetime.datetime(); (UTC) or None
302
last_enabled: datetime.datetime(); (UTC)
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
303
800
name: string; from the config file, used in log messages and
304
801
D-Bus identifiers
305
802
secret: bytestring; sent verbatim (over TLS) to client
306
803
timeout: datetime.timedelta(); How long from last_checked_ok
307
804
until this client is disabled
308
extended_timeout: extra long timeout when password has been sent
805
extended_timeout: extra long timeout when secret has been sent
309
806
runtime_expansions: Allowed attributes for runtime expansion.
310
807
expires: datetime.datetime(); time (UTC) when a client will be
311
808
disabled, or None
809
server_settings: The server_settings dict from main()
312
810
"""
313
811
314
812
runtime_expansions = ("approval_delay", "approval_duration",
315
"created", "enabled", "fingerprint",
316
"host", "interval", "last_checked_ok",
813
"created", "enabled", "expires",
814
"fingerprint", "host", "interval",
815
"last_approval_request", "last_checked_ok",
317
816
"last_enabled", "name", "timeout")
318
319
def timeout_milliseconds(self):
320
"Return the 'timeout' attribute in milliseconds"
321
return _timedelta_to_milliseconds(self.timeout)
322
323
def extended_timeout_milliseconds(self):
324
"Return the 'extended_timeout' attribute in milliseconds"
325
return _timedelta_to_milliseconds(self.extended_timeout)
326
327
def interval_milliseconds(self):
328
"Return the 'interval' attribute in milliseconds"
329
return _timedelta_to_milliseconds(self.interval)
330
331
def approval_delay_milliseconds(self):
332
return _timedelta_to_milliseconds(self.approval_delay)
333
334
def __init__(self, name = None, disable_hook=None, config=None):
335
"""Note: the 'checker' key in 'config' sets the
336
'checker_command' attribute and *not* the 'checker'
337
attribute."""
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):
338
882
self.name = name
339
if config is None:
340
config = {}
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
341
900
logger.debug("Creating client %r", self.name)
342
# Uppercase and remove spaces from fingerprint for later
343
# comparison purposes with return value from the fingerprint()
344
# function
345
self.fingerprint = (config["fingerprint"].upper()
346
.replace(" ", ""))
347
901
logger.debug(" Fingerprint: %s", self.fingerprint)
348
if "secret" in config:
349
self.secret = config["secret"].decode("base64")
350
elif "secfile" in config:
351
with open(os.path.expanduser(os.path.expandvars
352
(config["secfile"])),
353
"rb") as secfile:
354
self.secret = secfile.read()
355
else:
356
raise TypeError("No secret or secfile for client %s"
357
% self.name)
358
self.host = config.get("host", "")
359
self.created = datetime.datetime.utcnow()
360
self.enabled = False
361
self.last_approval_request = None
362
self.last_enabled = None
363
self.last_checked_ok = None
364
self.timeout = string_to_delta(config["timeout"])
365
self.extended_timeout = string_to_delta(config
366
["extended_timeout"])
367
self.interval = string_to_delta(config["interval"])
368
self.disable_hook = disable_hook
902
self.created = settings.get("created",
903
datetime.datetime.utcnow())
904
905
# attributes specific for this server instance
369
906
self.checker = None
370
907
self.checker_initiator_tag = None
371
908
self.disable_initiator_tag = None
372
self.expires = None
373
909
self.checker_callback_tag = None
374
self.checker_command = config["checker"]
375
910
self.current_checker_command = None
376
self.last_connect = None
377
self._approved = None
378
self.approved_by_default = config.get("approved_by_default",
379
True)
911
self.approved = None
380
912
self.approvals_pending = 0
381
self.approval_delay = string_to_delta(
382
config["approval_delay"])
383
self.approval_duration = string_to_delta(
384
config["approval_duration"])
385
self.changedstate = (multiprocessing_manager
386
.Condition(multiprocessing_manager
387
.Lock()))
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("_")]
918
self.client_structure.append("client_structure")
919
920
for name, t in inspect.getmembers(
921
type(self), lambda obj: isinstance(obj, property)):
922
if not name.startswith("_"):
923
self.client_structure.append(name)
388
924
925
# Send notice to process children that client state has changed
389
926
def send_changedstate(self):
390
self.changedstate.acquire()
391
self.changedstate.notify_all()
392
self.changedstate.release()
927
with self.changedstate:
928
self.changedstate.notify_all()
393
929
394
930
def enable(self):
395
931
"""Start this client's checker and timeout hooks"""
396
932
if getattr(self, "enabled", False):
397
933
# Already enabled
398
934
return
399
self.send_changedstate()
400
# Schedule a new checker to be started an 'interval' from now,
401
# and every interval from then on.
402
self.checker_initiator_tag = (gobject.timeout_add
403
(self.interval_milliseconds(),
404
self.start_checker))
405
# Schedule a disable() when 'timeout' has passed
406
935
self.expires = datetime.datetime.utcnow() + self.timeout
407
self.disable_initiator_tag = (gobject.timeout_add
408
(self.timeout_milliseconds(),
409
self.disable))
410
936
self.enabled = True
411
937
self.last_enabled = datetime.datetime.utcnow()
412
# Also start a new checker *right now*.
413
self.start_checker()
938
self.init_checker()
939
self.send_changedstate()
414
940
415
941
def disable(self, quiet=True):
416
942
"""Disable this client."""
417
943
if not getattr(self, "enabled", False):
418
944
return False
419
945
if not quiet:
420
self.send_changedstate()
421
if not quiet:
422
946
logger.info("Disabling client %s", self.name)
423
if getattr(self, "disable_initiator_tag", False):
424
gobject.source_remove(self.disable_initiator_tag)
947
if getattr(self, "disable_initiator_tag", None) is not None:
948
GLib.source_remove(self.disable_initiator_tag)
425
949
self.disable_initiator_tag = None
426
950
self.expires = None
427
if getattr(self, "checker_initiator_tag", False):
428
gobject.source_remove(self.checker_initiator_tag)
951
if getattr(self, "checker_initiator_tag", None) is not None:
952
GLib.source_remove(self.checker_initiator_tag)
429
953
self.checker_initiator_tag = None
430
954
self.stop_checker()
431
if self.disable_hook:
432
self.disable_hook(self)
433
955
self.enabled = False
434
# Do not run this again if called by a gobject.timeout_add
956
if not quiet:
957
self.send_changedstate()
958
# Do not run this again if called by a GLib.timeout_add
435
959
return False
436
960
437
961
def __del__(self):
438
self.disable_hook = None
439
962
self.disable()
440
963
441
def checker_callback(self, pid, condition, command):
964
def init_checker(self):
965
# Schedule a new checker to be started an 'interval' from now,
966
# 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)
972
# 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)
977
# Also start a new checker *right now*.
978
self.start_checker()
979
980
def checker_callback(self, source, condition, connection,
981
command):
442
982
"""The checker has completed, so take appropriate actions."""
443
983
self.checker_callback_tag = None
444
984
self.checker = None
445
if os.WIFEXITED(condition):
446
exitstatus = os.WEXITSTATUS(condition)
447
if exitstatus == 0:
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
992
if self.last_checker_status == 0:
448
993
logger.info("Checker for %(name)s succeeded",
449
994
vars(self))
450
995
self.checked_ok()
451
996
else:
452
logger.info("Checker for %(name)s failed",
453
vars(self))
997
logger.info("Checker for %(name)s failed", vars(self))
454
998
else:
999
self.last_checker_status = -1
1000
self.last_checker_signal = -returncode
455
1001
logger.warning("Checker for %(name)s crashed?",
456
1002
vars(self))
457
458
def checked_ok(self, timeout=None):
459
"""Bump up the timeout for this client.
460
461
This should only be called when the client has been seen,
462
alive and well.
463
"""
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."""
464
1014
if timeout is None:
465
1015
timeout = self.timeout
466
self.last_checked_ok = datetime.datetime.utcnow()
467
1016
if self.disable_initiator_tag is not None:
468
gobject.source_remove(self.disable_initiator_tag)
1017
GLib.source_remove(self.disable_initiator_tag)
1018
self.disable_initiator_tag = None
469
1019
if getattr(self, "enabled", False):
470
self.disable_initiator_tag = (gobject.timeout_add
471
(_timedelta_to_milliseconds
472
(timeout), self.disable))
1020
self.disable_initiator_tag = GLib.timeout_add(
1021
int(timeout.total_seconds() * 1000), self.disable)
473
1022
self.expires = datetime.datetime.utcnow() + timeout
474
1023
475
1024
def need_approval(self):
481
1030
If a checker already exists, leave it running and do
482
1031
nothing."""
483
1032
# The reason for not killing a running checker is that if we
484
# did that, then if a checker (for some reason) started
485
# running slowly and taking more than 'interval' time, the
486
# client would inevitably timeout, since no checker would get
487
# a chance to run to completion. If we instead leave running
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
488
1037
# checkers alone, the checker would have to take more time
489
1038
# than 'timeout' for the client to be disabled, which is as it
490
1039
# should be.
491
1040
492
# If a checker exists, make sure it is not a zombie
493
try:
494
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
495
except (AttributeError, OSError) as error:
496
if (isinstance(error, OSError)
497
and error.errno != errno.ECHILD):
498
raise error
499
else:
500
if pid:
501
logger.warning("Checker was a zombie")
502
gobject.source_remove(self.checker_callback_tag)
503
self.checker_callback(pid, status,
504
self.current_checker_command)
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
505
1045
# Start a new checker if needed
506
1046
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 }
507
1051
try:
508
# In case checker_command has exactly one % operator
509
command = self.checker_command % self.host
510
except TypeError:
511
# Escape attributes for the shell
512
escaped_attrs = dict(
513
(attr,
514
re.escape(unicode(str(getattr(self, attr, "")),
515
errors=
516
'replace')))
517
for attr in
518
self.runtime_expansions)
519
520
try:
521
command = self.checker_command % escaped_attrs
522
except TypeError as error:
523
logger.error('Could not format string "%s":'
524
' %s', self.checker_command, error)
525
return True # Try again later
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
526
1058
self.current_checker_command = command
527
try:
528
logger.info("Starting checker %r for %s",
529
command, self.name)
530
# We don't need to redirect stdout and stderr, since
531
# in normal mode, that is already done by daemon(),
532
# and in debug mode we don't want to. (Stdin is
533
# always replaced by /dev/null.)
534
self.checker = subprocess.Popen(command,
535
close_fds=True,
536
shell=True, cwd="/")
537
self.checker_callback_tag = (gobject.child_watch_add
538
(self.checker.pid,
539
self.checker_callback,
540
data=command))
541
# The checker may have completed before the gobject
542
# watch was added. Check for this.
543
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
544
if pid:
545
gobject.source_remove(self.checker_callback_tag)
546
self.checker_callback(pid, status, command)
547
except OSError as error:
548
logger.error("Failed to start subprocess: %s",
549
error)
550
# Re-run this periodically if run by gobject.timeout_add
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
551
1085
return True
552
1086
553
1087
def stop_checker(self):
554
1088
"""Force the checker process, if any, to stop."""
555
1089
if self.checker_callback_tag:
556
gobject.source_remove(self.checker_callback_tag)
1090
GLib.source_remove(self.checker_callback_tag)
557
1091
self.checker_callback_tag = None
558
1092
if getattr(self, "checker", None) is None:
559
1093
return
560
1094
logger.debug("Stopping checker for %(name)s", vars(self))
561
try:
562
os.kill(self.checker.pid, signal.SIGTERM)
563
#time.sleep(0.5)
564
#if self.checker.poll() is None:
565
# os.kill(self.checker.pid, signal.SIGKILL)
566
except OSError as error:
567
if error.errno != errno.ESRCH: # No such process
568
raise
1095
self.checker.terminate()
569
1096
self.checker = None
570
1097
571
1098
572
def dbus_service_property(dbus_interface, signature="v",
573
access="readwrite", byte_arrays=False):
1099
def dbus_service_property(dbus_interface,
1100
signature="v",
1101
access="readwrite",
1102
byte_arrays=False):
574
1103
"""Decorators for marking methods of a DBusObjectWithProperties to
575
1104
become properties on the D-Bus.
576
1105
585
1114
# "Set" method, so we fail early here:
586
1115
if byte_arrays and signature != "ay":
587
1116
raise ValueError("Byte arrays not supported for non-'ay'"
588
" signature %r" % signature)
1117
" signature {!r}".format(signature))
1118
589
1119
def decorator(func):
590
1120
func._dbus_is_property = True
591
1121
func._dbus_interface = dbus_interface
596
1126
func._dbus_name = func._dbus_name[:-14]
597
1127
func._dbus_get_args_options = {'byte_arrays': byte_arrays }
598
1128
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
599
1173
return decorator
600
1174
601
1175
602
1176
class DBusPropertyException(dbus.exceptions.DBusException):
603
1177
"""A base class for D-Bus property-related exceptions
604
1178
"""
605
def __unicode__(self):
606
return unicode(str(self))
1179
pass
607
1180
608
1181
609
1182
class DBusPropertyAccessException(DBusPropertyException):
618
1191
pass
619
1192
620
1193
621
class DBusObjectWithProperties(dbus.service.Object):
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):
622
1284
"""A D-Bus object with properties.
623
1285
624
1286
Classes inheriting from this can use the dbus_service_property
626
1288
standard Get(), Set(), and GetAll() methods on the D-Bus.
627
1289
"""
628
1290
629
@staticmethod
630
def _is_dbus_property(obj):
631
return getattr(obj, "_dbus_is_property", False)
632
633
def _get_all_dbus_properties(self):
634
"""Returns a generator of (name, attribute) pairs
635
"""
636
return ((prop.__get__(self)._dbus_name, prop.__get__(self))
637
for cls in self.__class__.__mro__
638
for name, prop in
639
inspect.getmembers(cls, self._is_dbus_property))
640
641
1291
def _get_dbus_property(self, interface_name, property_name):
642
1292
"""Returns a bound method if one exists which is a D-Bus
643
1293
property with the specified name and interface.
644
1294
"""
645
for cls in self.__class__.__mro__:
646
for name, value in (inspect.getmembers
647
(cls, self._is_dbus_property)):
1295
for cls in self.__class__.__mro__:
1296
for name, value in inspect.getmembers(
1297
cls, self._is_dbus_thing("property")):
648
1298
if (value._dbus_name == property_name
649
1299
and value._dbus_interface == interface_name):
650
1300
return value.__get__(self)
651
1301
652
1302
# No such property
653
raise DBusPropertyNotFound(self.dbus_object_path + ":"
654
+ interface_name + "."
655
+ property_name)
656
657
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
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",
658
1317
out_signature="v")
659
1318
def Get(self, interface_name, property_name):
660
1319
"""Standard D-Bus property Get() method, see D-Bus standard.
678
1337
# The byte_arrays option is not supported yet on
679
1338
# signatures other than "ay".
680
1339
if prop._dbus_signature != "ay":
681
raise ValueError
682
value = dbus.ByteArray(''.join(unichr(byte)
683
for byte in value))
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))
684
1345
prop(value)
685
1346
686
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
1347
@dbus.service.method(dbus.PROPERTIES_IFACE,
1348
in_signature="s",
687
1349
out_signature="a{sv}")
688
1350
def GetAll(self, interface_name):
689
1351
"""Standard D-Bus property GetAll() method, see D-Bus
691
1353
692
1354
Note: Will not include properties with access="write".
693
1355
"""
694
all = {}
695
for name, prop in self._get_all_dbus_properties():
1356
properties = {}
1357
for name, prop in self._get_all_dbus_things("property"):
696
1358
if (interface_name
697
1359
and interface_name != prop._dbus_interface):
698
1360
# Interface non-empty but did not match
702
1364
continue
703
1365
value = prop()
704
1366
if not hasattr(value, "variant_level"):
705
all[name] = value
1367
properties[name] = value
706
1368
continue
707
all[name] = type(value)(value, variant_level=
708
value.variant_level+1)
709
return dbus.Dictionary(all, signature="sv")
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
710
1380
711
1381
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
712
1382
out_signature="s",
713
1383
path_keyword='object_path',
714
1384
connection_keyword='connection')
715
1385
def Introspect(self, object_path, connection):
716
"""Standard D-Bus method, overloaded to insert property tags.
1386
"""Overloading of standard D-Bus method.
1387
1388
Inserts property tags and interface annotation tags.
717
1389
"""
718
xmlstring = dbus.service.Object.Introspect(self, object_path,
719
connection)
1390
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1391
object_path,
1392
connection)
720
1393
try:
721
1394
document = xml.dom.minidom.parseString(xmlstring)
1395
722
1396
def make_tag(document, name, prop):
723
1397
e = document.createElement("property")
724
1398
e.setAttribute("name", name)
725
1399
e.setAttribute("type", prop._dbus_signature)
726
1400
e.setAttribute("access", prop._dbus_access)
727
1401
return e
1402
728
1403
for if_tag in document.getElementsByTagName("interface"):
1404
# Add property tags
729
1405
for tag in (make_tag(document, name, prop)
730
1406
for name, prop
731
in self._get_all_dbus_properties()
1407
in self._get_all_dbus_things("property")
732
1408
if prop._dbus_interface
733
1409
== if_tag.getAttribute("name")):
734
1410
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)
735
1427
# Add the names to the return values for the
736
1428
# "org.freedesktop.DBus.Properties" methods
737
1429
if (if_tag.getAttribute("name")
752
1444
except (AttributeError, xml.dom.DOMException,
753
1445
xml.parsers.expat.ExpatError) as error:
754
1446
logger.error("Failed to override Introspection method",
755
error)
756
return xmlstring
757
758
759
def datetime_to_dbus (dt, variant_level=0):
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):
760
1520
"""Convert a UTC datetime.datetime() to a D-Bus type."""
761
1521
if dt is None:
762
1522
return dbus.String("", variant_level = variant_level)
763
return dbus.String(dt.isoformat(),
764
variant_level=variant_level)
765
766
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
767
.__metaclass__):
768
"""Applied to an empty subclass of a D-Bus object, this metaclass
769
will add additional D-Bus attributes matching a certain pattern.
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).
770
1548
"""
771
def __new__(mcs, name, bases, attr):
772
# Go through all the base classes which could have D-Bus
773
# methods, signals, or properties in them
774
for base in (b for b in bases
775
if issubclass(b, dbus.service.Object)):
776
# Go though all attributes of the base class
777
for attrname, attribute in inspect.getmembers(base):
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):
778
1557
# Ignore non-D-Bus attributes, and D-Bus attributes
779
1558
# with the wrong interface name
780
1559
if (not hasattr(attribute, "_dbus_interface")
781
or not attribute._dbus_interface
782
.startswith("se.recompile.Mandos")):
1560
or not attribute._dbus_interface.startswith(
1561
orig_interface_name)):
783
1562
continue
784
1563
# Create an alternate D-Bus interface name based on
785
1564
# the current name
786
alt_interface = (attribute._dbus_interface
787
.replace("se.recompile.Mandos",
788
"se.bsnet.fukt.Mandos"))
1565
alt_interface = attribute._dbus_interface.replace(
1566
orig_interface_name, alt_interface_name)
1567
interface_names.add(alt_interface)
789
1568
# Is this a D-Bus signal?
790
1569
if getattr(attribute, "_dbus_is_signal", False):
791
# Extract the original non-method function by
792
# black magic
793
nonmethod_func = (dict(
1570
# Extract the original non-method undecorated
1571
# function by black magic
1572
if sys.version_info.major == 2:
1573
nonmethod_func = (dict(
794
1574
zip(attribute.func_code.co_freevars,
795
attribute.__closure__))["func"]
796
.cell_contents)
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)
797
1582
# Create a new, but exactly alike, function
798
1583
# object, and decorate it to be a new D-Bus signal
799
1584
# with the alternate D-Bus interface name
800
new_function = (dbus.service.signal
801
(alt_interface,
802
attribute._dbus_signature)
803
(types.FunctionType(
804
nonmethod_func.func_code,
805
nonmethod_func.func_globals,
806
nonmethod_func.func_name,
807
nonmethod_func.func_defaults,
808
nonmethod_func.func_closure)))
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
809
1595
# Define a creator of a function to call both the
810
# old and new functions, so both the old and new
811
# signals gets sent when the function is called
1596
# original and alternate functions, so both the
1597
# original and alternate signals gets sent when
1598
# the function is called
812
1599
def fixscope(func1, func2):
813
1600
"""This function is a scope container to pass
814
1601
func1 and func2 to the "call_both" function
815
1602
outside of its arguments"""
1603
1604
@functools.wraps(func2)
816
1605
def call_both(*args, **kwargs):
817
1606
"""This function will emit two D-Bus
818
1607
signals by calling func1 and func2"""
819
1608
func1(*args, **kwargs)
820
1609
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
821
1615
return call_both
822
1616
# Create the "call_both" function and add it to
823
1617
# the class
824
attr[attrname] = fixscope(attribute,
825
new_function)
1618
attr[attrname] = fixscope(attribute, new_function)
826
1619
# Is this a D-Bus method?
827
1620
elif getattr(attribute, "_dbus_is_method", False):
828
1621
# Create a new, but exactly alike, function
829
1622
# object. Decorate it to be a new D-Bus method
830
1623
# with the alternate D-Bus interface name. Add it
831
1624
# to the class.
832
attr[attrname] = (dbus.service.method
833
(alt_interface,
834
attribute._dbus_in_signature,
835
attribute._dbus_out_signature)
836
(types.FunctionType
837
(attribute.func_code,
838
attribute.func_globals,
839
attribute.func_name,
840
attribute.func_defaults,
841
attribute.func_closure)))
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
842
1637
# Is this a D-Bus property?
843
1638
elif getattr(attribute, "_dbus_is_property", False):
844
1639
# Create a new, but exactly alike, function
845
1640
# object, and decorate it to be a new D-Bus
846
1641
# property with the alternate D-Bus interface
847
1642
# name. Add it to the class.
848
attr[attrname] = (dbus_service_property
849
(alt_interface,
850
attribute._dbus_signature,
851
attribute._dbus_access,
852
attribute
853
._dbus_get_args_options
854
["byte_arrays"])
855
(types.FunctionType
856
(attribute.func_code,
857
attribute.func_globals,
858
attribute.func_name,
859
attribute.func_defaults,
860
attribute.func_closure)))
861
return type.__new__(mcs, name, bases, attr)
862
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"})
863
1695
class ClientDBus(Client, DBusObjectWithProperties):
864
1696
"""A Client class using D-Bus
865
1697
869
1701
"""
870
1702
871
1703
runtime_expansions = (Client.runtime_expansions
872
+ ("dbus_object_path",))
1704
+ ("dbus_object_path", ))
1705
1706
_interface = "se.recompile.Mandos.Client"
873
1707
874
1708
# dbus.service.Object doesn't use super(), so we can't either.
875
1709
876
1710
def __init__(self, bus = None, *args, **kwargs):
877
self._approvals_pending = 0
878
1711
self.bus = bus
879
1712
Client.__init__(self, *args, **kwargs)
880
1713
# Only now, when this client is initialized, can it show up on
881
1714
# the D-Bus
882
client_object_name = unicode(self.name).translate(
1715
client_object_name = str(self.name).translate(
883
1716
{ord("."): ord("_"),
884
1717
ord("-"): ord("_")})
885
self.dbus_object_path = (dbus.ObjectPath
886
("/clients/" + client_object_name))
1718
self.dbus_object_path = dbus.ObjectPath(
1719
"/clients/" + client_object_name)
887
1720
DBusObjectWithProperties.__init__(self, self.bus,
888
1721
self.dbus_object_path)
889
890
def notifychangeproperty(transform_func,
891
dbus_name, type_func=lambda x: x,
892
variant_level=1):
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):
893
1728
""" Modify a variable so that it's a property which announces
894
1729
its changes to DBus.
895
1730
896
1731
transform_fun: Function that takes a value and a variant_level
897
1732
and transforms it to a D-Bus type.
898
1733
dbus_name: D-Bus name of the variable
900
1735
to the D-Bus. Default: no transform
901
1736
variant_level: D-Bus variant level. Default: 1
902
1737
"""
903
attrname = "_{0}".format(dbus_name)
1738
attrname = "_{}".format(dbus_name)
1739
904
1740
def setter(self, value):
905
1741
if hasattr(self, "dbus_object_path"):
906
1742
if (not hasattr(self, attrname) or
907
1743
type_func(getattr(self, attrname, None))
908
1744
!= type_func(value)):
909
dbus_value = transform_func(type_func(value),
910
variant_level
911
=variant_level)
912
self.PropertyChanged(dbus.String(dbus_name),
913
dbus_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())
914
1760
setattr(self, attrname, value)
915
1761
916
1762
return property(lambda self: getattr(self, attrname), setter)
917
1763
918
919
1764
expires = notifychangeproperty(datetime_to_dbus, "Expires")
920
1765
approvals_pending = notifychangeproperty(dbus.Boolean,
921
1766
"ApprovalPending",
923
1768
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
924
1769
last_enabled = notifychangeproperty(datetime_to_dbus,
925
1770
"LastEnabled")
926
checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
927
type_func = lambda checker:
928
checker is not None)
1771
checker = notifychangeproperty(
1772
dbus.Boolean, "CheckerRunning",
1773
type_func = lambda checker: checker is not None)
929
1774
last_checked_ok = notifychangeproperty(datetime_to_dbus,
930
1775
"LastCheckedOK")
1776
last_checker_status = notifychangeproperty(dbus.Int16,
1777
"LastCheckerStatus")
931
1778
last_approval_request = notifychangeproperty(
932
1779
datetime_to_dbus, "LastApprovalRequest")
933
1780
approved_by_default = notifychangeproperty(dbus.Boolean,
934
1781
"ApprovedByDefault")
935
approval_delay = notifychangeproperty(dbus.UInt16,
936
"ApprovalDelay",
937
type_func =
938
_timedelta_to_milliseconds)
1782
approval_delay = notifychangeproperty(
1783
dbus.UInt64, "ApprovalDelay",
1784
type_func = lambda td: td.total_seconds() * 1000)
939
1785
approval_duration = notifychangeproperty(
940
dbus.UInt16, "ApprovalDuration",
941
type_func = _timedelta_to_milliseconds)
1786
dbus.UInt64, "ApprovalDuration",
1787
type_func = lambda td: td.total_seconds() * 1000)
942
1788
host = notifychangeproperty(dbus.String, "Host")
943
timeout = notifychangeproperty(dbus.UInt16, "Timeout",
944
type_func =
945
_timedelta_to_milliseconds)
1789
timeout = notifychangeproperty(
1790
dbus.UInt64, "Timeout",
1791
type_func = lambda td: td.total_seconds() * 1000)
946
1792
extended_timeout = notifychangeproperty(
947
dbus.UInt16, "ExtendedTimeout",
948
type_func = _timedelta_to_milliseconds)
949
interval = notifychangeproperty(dbus.UInt16,
950
"Interval",
951
type_func =
952
_timedelta_to_milliseconds)
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)
953
1798
checker_command = notifychangeproperty(dbus.String, "Checker")
1799
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1800
invalidate_only=True)
954
1801
955
1802
del notifychangeproperty
956
1803
963
1810
DBusObjectWithProperties.__del__(self, *args, **kwargs)
964
1811
Client.__del__(self, *args, **kwargs)
965
1812
966
def checker_callback(self, pid, condition, command,
967
*args, **kwargs):
968
self.checker_callback_tag = None
969
self.checker = None
970
if os.WIFEXITED(condition):
971
exitstatus = os.WEXITSTATUS(condition)
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:
972
1820
# Emit D-Bus signal
973
1821
self.CheckerCompleted(dbus.Int16(exitstatus),
974
dbus.Int64(condition),
1822
# This is specific to GNU libC
1823
dbus.Int64(exitstatus << 8),
975
1824
dbus.String(command))
976
1825
else:
977
1826
# Emit D-Bus signal
978
1827
self.CheckerCompleted(dbus.Int16(-1),
979
dbus.Int64(condition),
1828
dbus.Int64(
1829
# This is specific to GNU libC
1830
(exitstatus << 8)
1831
| self.last_checker_signal),
980
1832
dbus.String(command))
981
982
return Client.checker_callback(self, pid, condition, command,
983
*args, **kwargs)
1833
return ret
984
1834
985
1835
def start_checker(self, *args, **kwargs):
986
old_checker = self.checker
987
if self.checker is not None:
988
old_checker_pid = self.checker.pid
989
else:
990
old_checker_pid = None
1836
old_checker_pid = getattr(self.checker, "pid", None)
991
1837
r = Client.start_checker(self, *args, **kwargs)
992
1838
# Only if new checker process was started
993
1839
if (self.checker is not None
997
1843
return r
998
1844
999
1845
def _reset_approved(self):
1000
self._approved = None
1846
self.approved = None
1001
1847
return False
1002
1848
1003
1849
def approve(self, value=True):
1850
self.approved = value
1851
GLib.timeout_add(int(self.approval_duration.total_seconds()
1852
* 1000), self._reset_approved)
1004
1853
self.send_changedstate()
1005
self._approved = value
1006
gobject.timeout_add(_timedelta_to_milliseconds
1007
(self.approval_duration),
1008
self._reset_approved)
1009
1010
1854
1011
1855
## D-Bus methods, signals & properties
1012
_interface = "se.recompile.Mandos.Client"
1856
1857
## Interfaces
1013
1858
1014
1859
## Signals
1015
1860
1026
1871
pass
1027
1872
1028
1873
# PropertyChanged - signal
1874
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1029
1875
@dbus.service.signal(_interface, signature="sv")
1030
1876
def PropertyChanged(self, property, value):
1031
1877
"D-Bus signal"
1065
1911
self.checked_ok()
1066
1912
1067
1913
# Enable - method
1914
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1068
1915
@dbus.service.method(_interface)
1069
1916
def Enable(self):
1070
1917
"D-Bus method"
1071
1918
self.enable()
1072
1919
1073
1920
# StartChecker - method
1921
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1074
1922
@dbus.service.method(_interface)
1075
1923
def StartChecker(self):
1076
1924
"D-Bus method"
1077
1925
self.start_checker()
1078
1926
1079
1927
# Disable - method
1928
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1080
1929
@dbus.service.method(_interface)
1081
1930
def Disable(self):
1082
1931
"D-Bus method"
1083
1932
self.disable()
1084
1933
1085
1934
# StopChecker - method
1935
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1086
1936
@dbus.service.method(_interface)
1087
1937
def StopChecker(self):
1088
1938
self.stop_checker()
1095
1945
return dbus.Boolean(bool(self.approvals_pending))
1096
1946
1097
1947
# ApprovedByDefault - property
1098
@dbus_service_property(_interface, signature="b",
1948
@dbus_service_property(_interface,
1949
signature="b",
1099
1950
access="readwrite")
1100
1951
def ApprovedByDefault_dbus_property(self, value=None):
1101
1952
if value is None: # get
1103
1954
self.approved_by_default = bool(value)
1104
1955
1105
1956
# ApprovalDelay - property
1106
@dbus_service_property(_interface, signature="t",
1957
@dbus_service_property(_interface,
1958
signature="t",
1107
1959
access="readwrite")
1108
1960
def ApprovalDelay_dbus_property(self, value=None):
1109
1961
if value is None: # get
1110
return dbus.UInt64(self.approval_delay_milliseconds())
1962
return dbus.UInt64(self.approval_delay.total_seconds()
1963
* 1000)
1111
1964
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1112
1965
1113
1966
# ApprovalDuration - property
1114
@dbus_service_property(_interface, signature="t",
1967
@dbus_service_property(_interface,
1968
signature="t",
1115
1969
access="readwrite")
1116
1970
def ApprovalDuration_dbus_property(self, value=None):
1117
1971
if value is None: # get
1118
return dbus.UInt64(_timedelta_to_milliseconds(
1119
self.approval_duration))
1972
return dbus.UInt64(self.approval_duration.total_seconds()
1973
* 1000)
1120
1974
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1121
1975
1122
1976
# Name - property
1977
@dbus_annotations(
1978
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1123
1979
@dbus_service_property(_interface, signature="s", access="read")
1124
1980
def Name_dbus_property(self):
1125
1981
return dbus.String(self.name)
1126
1982
1127
1983
# Fingerprint - property
1984
@dbus_annotations(
1985
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1128
1986
@dbus_service_property(_interface, signature="s", access="read")
1129
1987
def Fingerprint_dbus_property(self):
1130
1988
return dbus.String(self.fingerprint)
1131
1989
1132
1990
# Host - property
1133
@dbus_service_property(_interface, signature="s",
1991
@dbus_service_property(_interface,
1992
signature="s",
1134
1993
access="readwrite")
1135
1994
def Host_dbus_property(self, value=None):
1136
1995
if value is None: # get
1137
1996
return dbus.String(self.host)
1138
self.host = value
1997
self.host = str(value)
1139
1998
1140
1999
# Created - property
2000
@dbus_annotations(
2001
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1141
2002
@dbus_service_property(_interface, signature="s", access="read")
1142
2003
def Created_dbus_property(self):
1143
return dbus.String(datetime_to_dbus(self.created))
2004
return datetime_to_dbus(self.created)
1144
2005
1145
2006
# LastEnabled - property
1146
2007
@dbus_service_property(_interface, signature="s", access="read")
1148
2009
return datetime_to_dbus(self.last_enabled)
1149
2010
1150
2011
# Enabled - property
1151
@dbus_service_property(_interface, signature="b",
2012
@dbus_service_property(_interface,
2013
signature="b",
1152
2014
access="readwrite")
1153
2015
def Enabled_dbus_property(self, value=None):
1154
2016
if value is None: # get
1159
2021
self.disable()
1160
2022
1161
2023
# LastCheckedOK - property
1162
@dbus_service_property(_interface, signature="s",
2024
@dbus_service_property(_interface,
2025
signature="s",
1163
2026
access="readwrite")
1164
2027
def LastCheckedOK_dbus_property(self, value=None):
1165
2028
if value is not None:
1167
2030
return
1168
2031
return datetime_to_dbus(self.last_checked_ok)
1169
2032
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
1170
2038
# Expires - property
1171
2039
@dbus_service_property(_interface, signature="s", access="read")
1172
2040
def Expires_dbus_property(self):
1178
2046
return datetime_to_dbus(self.last_approval_request)
1179
2047
1180
2048
# Timeout - property
1181
@dbus_service_property(_interface, signature="t",
2049
@dbus_service_property(_interface,
2050
signature="t",
1182
2051
access="readwrite")
1183
2052
def Timeout_dbus_property(self, value=None):
1184
2053
if value is None: # get
1185
return dbus.UInt64(self.timeout_milliseconds())
2054
return dbus.UInt64(self.timeout.total_seconds() * 1000)
2055
old_timeout = self.timeout
1186
2056
self.timeout = datetime.timedelta(0, 0, 0, value)
1187
if getattr(self, "disable_initiator_tag", None) is None:
1188
return
1189
# Reschedule timeout
1190
gobject.source_remove(self.disable_initiator_tag)
1191
self.disable_initiator_tag = None
1192
self.expires = None
1193
time_to_die = _timedelta_to_milliseconds((self
1194
.last_checked_ok
1195
+ self.timeout)
1196
- datetime.datetime
1197
.utcnow())
1198
if time_to_die <= 0:
1199
# The timeout has passed
1200
self.disable()
1201
else:
1202
self.expires = (datetime.datetime.utcnow()
1203
+ datetime.timedelta(milliseconds =
1204
time_to_die))
1205
self.disable_initiator_tag = (gobject.timeout_add
1206
(time_to_die, self.disable))
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)
1207
2072
1208
2073
# ExtendedTimeout - property
1209
@dbus_service_property(_interface, signature="t",
2074
@dbus_service_property(_interface,
2075
signature="t",
1210
2076
access="readwrite")
1211
2077
def ExtendedTimeout_dbus_property(self, value=None):
1212
2078
if value is None: # get
1213
return dbus.UInt64(self.extended_timeout_milliseconds())
2079
return dbus.UInt64(self.extended_timeout.total_seconds()
2080
* 1000)
1214
2081
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1215
2082
1216
2083
# Interval - property
1217
@dbus_service_property(_interface, signature="t",
2084
@dbus_service_property(_interface,
2085
signature="t",
1218
2086
access="readwrite")
1219
2087
def Interval_dbus_property(self, value=None):
1220
2088
if value is None: # get
1221
return dbus.UInt64(self.interval_milliseconds())
2089
return dbus.UInt64(self.interval.total_seconds() * 1000)
1222
2090
self.interval = datetime.timedelta(0, 0, 0, value)
1223
2091
if getattr(self, "checker_initiator_tag", None) is None:
1224
2092
return
1225
# Reschedule checker run
1226
gobject.source_remove(self.checker_initiator_tag)
1227
self.checker_initiator_tag = (gobject.timeout_add
1228
(value, self.start_checker))
1229
self.start_checker() # Start one now, too
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
1230
2099
1231
2100
# Checker - property
1232
@dbus_service_property(_interface, signature="s",
2101
@dbus_service_property(_interface,
2102
signature="s",
1233
2103
access="readwrite")
1234
2104
def Checker_dbus_property(self, value=None):
1235
2105
if value is None: # get
1236
2106
return dbus.String(self.checker_command)
1237
self.checker_command = value
2107
self.checker_command = str(value)
1238
2108
1239
2109
# CheckerRunning - property
1240
@dbus_service_property(_interface, signature="b",
2110
@dbus_service_property(_interface,
2111
signature="b",
1241
2112
access="readwrite")
1242
2113
def CheckerRunning_dbus_property(self, value=None):
1243
2114
if value is None: # get
1248
2119
self.stop_checker()
1249
2120
1250
2121
# ObjectPath - property
2122
@dbus_annotations(
2123
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
2124
"org.freedesktop.DBus.Deprecated": "true"})
1251
2125
@dbus_service_property(_interface, signature="o", access="read")
1252
2126
def ObjectPath_dbus_property(self):
1253
2127
return self.dbus_object_path # is already a dbus.ObjectPath
1254
2128
1255
2129
# Secret = property
1256
@dbus_service_property(_interface, signature="ay",
1257
access="write", byte_arrays=True)
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)
1258
2137
def Secret_dbus_property(self, value):
1259
self.secret = str(value)
2138
self.secret = bytes(value)
1260
2139
1261
2140
del _interface
1262
2141
1266
2145
self._pipe = child_pipe
1267
2146
self._pipe.send(('init', fpr, address))
1268
2147
if not self._pipe.recv():
1269
raise KeyError()
2148
raise KeyError(fpr)
1270
2149
1271
2150
def __getattribute__(self, name):
1272
if(name == '_pipe'):
2151
if name == '_pipe':
1273
2152
return super(ProxyClient, self).__getattribute__(name)
1274
2153
self._pipe.send(('getattr', name))
1275
2154
data = self._pipe.recv()
1276
2155
if data[0] == 'data':
1277
2156
return data[1]
1278
2157
if data[0] == 'function':
2158
1279
2159
def func(*args, **kwargs):
1280
2160
self._pipe.send(('funcall', name, args, kwargs))
1281
2161
return self._pipe.recv()[1]
2162
1282
2163
return func
1283
2164
1284
2165
def __setattr__(self, name, value):
1285
if(name == '_pipe'):
2166
if name == '_pipe':
1286
2167
return super(ProxyClient, self).__setattr__(name, value)
1287
2168
self._pipe.send(('setattr', name, value))
1288
2169
1289
class ClientDBusTransitional(ClientDBus):
1290
__metaclass__ = AlternateDBusNamesMetaclass
1291
2170
1292
2171
class ClientHandler(socketserver.BaseRequestHandler, object):
1293
2172
"""A class to handle client connections.
1298
2177
def handle(self):
1299
2178
with contextlib.closing(self.server.child_pipe) as child_pipe:
1300
2179
logger.info("TCP connection from: %s",
1301
unicode(self.client_address))
2180
str(self.client_address))
1302
2181
logger.debug("Pipe FD: %d",
1303
2182
self.server.child_pipe.fileno())
1304
2183
1305
session = (gnutls.connection
1306
.ClientSession(self.request,
1307
gnutls.connection
1308
.X509Credentials()))
1309
1310
# Note: gnutls.connection.X509Credentials is really a
1311
# generic GnuTLS certificate credentials object so long as
1312
# no X.509 keys are added to it. Therefore, we can use it
1313
# here despite using OpenPGP certificates.
2184
session = gnutls.ClientSession(self.request)
1314
2185
1315
2186
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1316
2187
# "+AES-256-CBC", "+SHA1",
1320
2191
priority = self.server.gnutls_priority
1321
2192
if priority is None:
1322
2193
priority = "NORMAL"
1323
(gnutls.library.functions
1324
.gnutls_priority_set_direct(session._c_object,
1325
priority, None))
2194
gnutls.priority_set_direct(session._c_object,
2195
priority.encode("utf-8"),
2196
None)
1326
2197
1327
2198
# Start communication using the Mandos protocol
1328
2199
# Get protocol number
1330
2201
logger.debug("Protocol version: %r", line)
1331
2202
try:
1332
2203
if int(line.strip().split()[0]) > 1:
1333
raise RuntimeError
2204
raise RuntimeError(line)
1334
2205
except (ValueError, IndexError, RuntimeError) as error:
1335
2206
logger.error("Unknown protocol version: %s", error)
1336
2207
return
1338
2209
# Start GnuTLS connection
1339
2210
try:
1340
2211
session.handshake()
1341
except gnutls.errors.GNUTLSError as error:
2212
except gnutls.Error as error:
1342
2213
logger.warning("Handshake failed: %s", error)
1343
2214
# Do not run session.bye() here: the session is not
1344
2215
# established. Just abandon the request.
1348
2219
approval_required = False
1349
2220
try:
1350
2221
try:
1351
fpr = self.fingerprint(self.peer_certificate
1352
(session))
1353
except (TypeError,
1354
gnutls.errors.GNUTLSError) as error:
2222
fpr = self.fingerprint(
2223
self.peer_certificate(session))
2224
except (TypeError, gnutls.Error) as error:
1355
2225
logger.warning("Bad certificate: %s", error)
1356
2226
return
1357
2227
logger.debug("Fingerprint: %s", fpr)
1370
2240
while True:
1371
2241
if not client.enabled:
1372
2242
logger.info("Client %s is disabled",
1373
client.name)
2243
client.name)
1374
2244
if self.server.use_dbus:
1375
2245
# Emit D-Bus signal
1376
2246
client.Rejected("Disabled")
1377
2247
return
1378
2248
1379
if client._approved or not client.approval_delay:
2249
if client.approved or not client.approval_delay:
1380
2250
#We are approved or approval is disabled
1381
2251
break
1382
elif client._approved is None:
2252
elif client.approved is None:
1383
2253
logger.info("Client %s needs approval",
1384
2254
client.name)
1385
2255
if self.server.use_dbus:
1386
2256
# Emit D-Bus signal
1387
2257
client.NeedApproval(
1388
client.approval_delay_milliseconds(),
1389
client.approved_by_default)
2258
client.approval_delay.total_seconds()
2259
* 1000, client.approved_by_default)
1390
2260
else:
1391
2261
logger.warning("Client %s was not approved",
1392
2262
client.name)
1398
2268
#wait until timeout or approved
1399
2269
time = datetime.datetime.now()
1400
2270
client.changedstate.acquire()
1401
(client.changedstate.wait
1402
(float(client._timedelta_to_milliseconds(delay)
1403
/ 1000)))
2271
client.changedstate.wait(delay.total_seconds())
1404
2272
client.changedstate.release()
1405
2273
time2 = datetime.datetime.now()
1406
2274
if (time2 - time) >= delay:
1417
2285
else:
1418
2286
delay -= time2 - time
1419
2287
1420
sent_size = 0
1421
while sent_size < len(client.secret):
1422
try:
1423
sent = session.send(client.secret[sent_size:])
1424
except gnutls.errors.GNUTLSError as error:
1425
logger.warning("gnutls send failed")
1426
return
1427
logger.debug("Sent: %d, remaining: %d",
1428
sent, len(client.secret)
1429
- (sent_size + sent))
1430
sent_size += sent
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
1431
2294
1432
2295
logger.info("Sending secret to %s", client.name)
1433
2296
# bump the timeout using extended_timeout
1434
client.checked_ok(client.extended_timeout)
2297
client.bump_timeout(client.extended_timeout)
1435
2298
if self.server.use_dbus:
1436
2299
# Emit D-Bus signal
1437
2300
client.GotSecret()
1441
2304
client.approvals_pending -= 1
1442
2305
try:
1443
2306
session.bye()
1444
except gnutls.errors.GNUTLSError as error:
1445
logger.warning("GnuTLS bye failed")
2307
except gnutls.Error as error:
2308
logger.warning("GnuTLS bye failed",
2309
exc_info=error)
1446
2310
1447
2311
@staticmethod
1448
2312
def peer_certificate(session):
1449
2313
"Return the peer's OpenPGP certificate as a bytestring"
1450
2314
# If not an OpenPGP certificate...
1451
if (gnutls.library.functions
1452
.gnutls_certificate_type_get(session._c_object)
1453
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1454
# ...do the normal thing
1455
return session.peer_certificate
2315
if (gnutls.certificate_type_get(session._c_object)
2316
!= gnutls.CRT_OPENPGP):
2317
# ...return invalid data
2318
return b""
1456
2319
list_size = ctypes.c_uint(1)
1457
cert_list = (gnutls.library.functions
1458
.gnutls_certificate_get_peers
2320
cert_list = (gnutls.certificate_get_peers
1459
2321
(session._c_object, ctypes.byref(list_size)))
1460
2322
if not bool(cert_list) and list_size.value != 0:
1461
raise gnutls.errors.GNUTLSError("error getting peer"
1462
" certificate")
2323
raise gnutls.Error("error getting peer certificate")
1463
2324
if list_size.value == 0:
1464
2325
return None
1465
2326
cert = cert_list[0]
1469
2330
def fingerprint(openpgp):
1470
2331
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
1471
2332
# New GnuTLS "datum" with the OpenPGP public key
1472
datum = (gnutls.library.types
1473
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1474
ctypes.POINTER
1475
(ctypes.c_ubyte)),
1476
ctypes.c_uint(len(openpgp))))
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)))
1477
2337
# New empty GnuTLS certificate
1478
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1479
(gnutls.library.functions
1480
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2338
crt = gnutls.openpgp_crt_t()
2339
gnutls.openpgp_crt_init(ctypes.byref(crt))
1481
2340
# Import the OpenPGP public key into the certificate
1482
(gnutls.library.functions
1483
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1484
gnutls.library.constants
1485
.GNUTLS_OPENPGP_FMT_RAW))
2341
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2342
gnutls.OPENPGP_FMT_RAW)
1486
2343
# Verify the self signature in the key
1487
2344
crtverify = ctypes.c_uint()
1488
(gnutls.library.functions
1489
.gnutls_openpgp_crt_verify_self(crt, 0,
1490
ctypes.byref(crtverify)))
2345
gnutls.openpgp_crt_verify_self(crt, 0,
2346
ctypes.byref(crtverify))
1491
2347
if crtverify.value != 0:
1492
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1493
raise (gnutls.errors.CertificateSecurityError
1494
("Verify failed"))
2348
gnutls.openpgp_crt_deinit(crt)
2349
raise gnutls.CertificateSecurityError("Verify failed")
1495
2350
# New buffer for the fingerprint
1496
2351
buf = ctypes.create_string_buffer(20)
1497
2352
buf_len = ctypes.c_size_t()
1498
2353
# Get the fingerprint from the certificate into the buffer
1499
(gnutls.library.functions
1500
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1501
ctypes.byref(buf_len)))
2354
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2355
ctypes.byref(buf_len))
1502
2356
# Deinit the certificate
1503
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2357
gnutls.openpgp_crt_deinit(crt)
1504
2358
# Convert the buffer to a Python bytestring
1505
2359
fpr = ctypes.string_at(buf, buf_len.value)
1506
2360
# Convert the bytestring to hexadecimal notation
1507
hex_fpr = ''.join("%02X" % ord(char) for char in fpr)
2361
hex_fpr = binascii.hexlify(fpr).upper()
1508
2362
return hex_fpr
1509
2363
1510
2364
1511
2365
class MultiprocessingMixIn(object):
1512
2366
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2367
1513
2368
def sub_process_main(self, request, address):
1514
2369
try:
1515
2370
self.finish_request(request, address)
1516
except:
2371
except Exception:
1517
2372
self.handle_error(request, address)
1518
2373
self.close_request(request)
1519
2374
1520
2375
def process_request(self, request, address):
1521
2376
"""Start a new process to process the request."""
1522
2377
proc = multiprocessing.Process(target = self.sub_process_main,
1523
args = (request,
1524
address))
2378
args = (request, address))
1525
2379
proc.start()
1526
2380
return proc
1527
2381
1528
2382
1529
2383
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1530
2384
""" adds a pipe to the MixIn """
2385
1531
2386
def process_request(self, request, client_address):
1532
2387
"""Overrides and wraps the original process_request().
1533
2388
1542
2397
1543
2398
def add_pipe(self, parent_pipe, proc):
1544
2399
"""Dummy function; override as necessary"""
1545
raise NotImplementedError
2400
raise NotImplementedError()
1546
2401
1547
2402
1548
2403
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1554
2409
interface: None or a network interface name (string)
1555
2410
use_ipv6: Boolean; to use IPv6 or not
1556
2411
"""
2412
1557
2413
def __init__(self, server_address, RequestHandlerClass,
1558
interface=None, use_ipv6=True):
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
"""
1559
2420
self.interface = interface
1560
2421
if use_ipv6:
1561
2422
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.
1562
2449
socketserver.TCPServer.__init__(self, server_address,
1563
2450
RequestHandlerClass)
2451
1564
2452
def server_bind(self):
1565
2453
"""This overrides the normal server_bind() function
1566
2454
to bind to an interface if one was specified, and also NOT to
1567
2455
bind to an address or port if they were not specified."""
1568
2456
if self.interface is not None:
1569
2457
if SO_BINDTODEVICE is None:
1570
logger.error("SO_BINDTODEVICE does not exist;"
1571
" cannot bind to interface %s",
1572
self.interface)
1573
else:
1574
try:
1575
self.socket.setsockopt(socket.SOL_SOCKET,
1576
SO_BINDTODEVICE,
1577
str(self.interface
1578
+ '\0'))
1579
except socket.error as error:
1580
if error[0] == errno.EPERM:
1581
logger.error("No permission to"
1582
" bind to interface %s",
1583
self.interface)
1584
elif error[0] == errno.ENOPROTOOPT:
1585
logger.error("SO_BINDTODEVICE not available;"
1586
" cannot bind to interface %s",
1587
self.interface)
1588
else:
1589
raise
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
1590
2479
# Only bind(2) the socket if we really need to.
1591
2480
if self.server_address[0] or self.server_address[1]:
1592
2481
if not self.server_address[0]:
1593
2482
if self.address_family == socket.AF_INET6:
1594
2483
any_address = "::" # in6addr_any
1595
2484
else:
1596
any_address = socket.INADDR_ANY
2485
any_address = "0.0.0.0" # INADDR_ANY
1597
2486
self.server_address = (any_address,
1598
2487
self.server_address[1])
1599
2488
elif not self.server_address[1]:
1600
self.server_address = (self.server_address[0],
1601
0)
2489
self.server_address = (self.server_address[0], 0)
1602
2490
# if self.interface:
1603
2491
# self.server_address = (self.server_address[0],
1604
2492
# 0, # port
1616
2504
gnutls_priority GnuTLS priority string
1617
2505
use_dbus: Boolean; to emit D-Bus signals or not
1618
2506
1619
Assumes a gobject.MainLoop event loop.
2507
Assumes a GLib.MainLoop event loop.
1620
2508
"""
2509
1621
2510
def __init__(self, server_address, RequestHandlerClass,
1622
interface=None, use_ipv6=True, clients=None,
1623
gnutls_priority=None, use_dbus=True):
2511
interface=None,
2512
use_ipv6=True,
2513
clients=None,
2514
gnutls_priority=None,
2515
use_dbus=True,
2516
socketfd=None):
1624
2517
self.enabled = False
1625
2518
self.clients = clients
1626
2519
if self.clients is None:
1627
self.clients = set()
2520
self.clients = {}
1628
2521
self.use_dbus = use_dbus
1629
2522
self.gnutls_priority = gnutls_priority
1630
2523
IPv6_TCPServer.__init__(self, server_address,
1631
2524
RequestHandlerClass,
1632
2525
interface = interface,
1633
use_ipv6 = use_ipv6)
2526
use_ipv6 = use_ipv6,
2527
socketfd = socketfd)
2528
1634
2529
def server_activate(self):
1635
2530
if self.enabled:
1636
2531
return socketserver.TCPServer.server_activate(self)
1640
2535
1641
2536
def add_pipe(self, parent_pipe, proc):
1642
2537
# Call "handle_ipc" for both data and EOF events
1643
gobject.io_add_watch(parent_pipe.fileno(),
1644
gobject.IO_IN | gobject.IO_HUP,
1645
functools.partial(self.handle_ipc,
1646
parent_pipe =
1647
parent_pipe,
1648
proc = proc))
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))
1649
2544
1650
def handle_ipc(self, source, condition, parent_pipe=None,
1651
proc = None, client_object=None):
1652
condition_names = {
1653
gobject.IO_IN: "IN", # There is data to read.
1654
gobject.IO_OUT: "OUT", # Data can be written (without
1655
# blocking).
1656
gobject.IO_PRI: "PRI", # There is urgent data to read.
1657
gobject.IO_ERR: "ERR", # Error condition.
1658
gobject.IO_HUP: "HUP" # Hung up (the connection has been
1659
# broken, usually for pipes and
1660
# sockets).
1661
}
1662
conditions_string = ' | '.join(name
1663
for cond, name in
1664
condition_names.iteritems()
1665
if cond & condition)
2545
def handle_ipc(self, source, condition,
2546
parent_pipe=None,
2547
proc = None,
2548
client_object=None):
1666
2549
# error, or the other end of multiprocessing.Pipe has closed
1667
if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
2550
if condition & (GLib.IO_ERR | GLib.IO_HUP):
1668
2551
# Wait for other process to exit
1669
2552
proc.join()
1670
2553
return False
1677
2560
fpr = request[1]
1678
2561
address = request[2]
1679
2562
1680
for c in self.clients:
2563
for c in self.clients.values():
1681
2564
if c.fingerprint == fpr:
1682
2565
client = c
1683
2566
break
1691
2574
parent_pipe.send(False)
1692
2575
return False
1693
2576
1694
gobject.io_add_watch(parent_pipe.fileno(),
1695
gobject.IO_IN | gobject.IO_HUP,
1696
functools.partial(self.handle_ipc,
1697
parent_pipe =
1698
parent_pipe,
1699
proc = proc,
1700
client_object =
1701
client))
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))
1702
2584
parent_pipe.send(True)
1703
2585
# remove the old hook in favor of the new above hook on
1704
2586
# same fileno
1710
2592
1711
2593
parent_pipe.send(('data', getattr(client_object,
1712
2594
funcname)(*args,
1713
**kwargs)))
2595
**kwargs)))
1714
2596
1715
2597
if command == 'getattr':
1716
2598
attrname = request[1]
1717
if callable(client_object.__getattribute__(attrname)):
1718
parent_pipe.send(('function',))
2599
if isinstance(client_object.__getattribute__(attrname),
2600
collections.Callable):
2601
parent_pipe.send(('function', ))
1719
2602
else:
1720
parent_pipe.send(('data', client_object
1721
.__getattribute__(attrname)))
2603
parent_pipe.send((
2604
'data', client_object.__getattribute__(attrname)))
1722
2605
1723
2606
if command == 'setattr':
1724
2607
attrname = request[1]
1728
2611
return True
1729
2612
1730
2613
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
1731
2710
def string_to_delta(interval):
1732
2711
"""Parse a string and return a datetime.timedelta
1733
2712
1744
2723
>>> string_to_delta('5m 30s')
1745
2724
datetime.timedelta(0, 330)
1746
2725
"""
2726
2727
try:
2728
return rfc3339_duration_to_delta(interval)
2729
except ValueError:
2730
pass
2731
1747
2732
timevalue = datetime.timedelta(0)
1748
2733
for s in interval.split():
1749
2734
try:
1750
suffix = unicode(s[-1])
2735
suffix = s[-1]
1751
2736
value = int(s[:-1])
1752
2737
if suffix == "d":
1753
2738
delta = datetime.timedelta(value)
1760
2745
elif suffix == "w":
1761
2746
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
1762
2747
else:
1763
raise ValueError("Unknown suffix %r" % suffix)
1764
except (ValueError, IndexError) as e:
2748
raise ValueError("Unknown suffix {!r}".format(suffix))
2749
except IndexError as e:
1765
2750
raise ValueError(*(e.args))
1766
2751
timevalue += delta
1767
2752
return timevalue
1768
2753
1769
2754
1770
def if_nametoindex(interface):
1771
"""Call the C function if_nametoindex(), or equivalent
1772
1773
Note: This function cannot accept a unicode string."""
1774
global if_nametoindex
1775
try:
1776
if_nametoindex = (ctypes.cdll.LoadLibrary
1777
(ctypes.util.find_library("c"))
1778
.if_nametoindex)
1779
except (OSError, AttributeError):
1780
logger.warning("Doing if_nametoindex the hard way")
1781
def if_nametoindex(interface):
1782
"Get an interface index the hard way, i.e. using fcntl()"
1783
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
1784
with contextlib.closing(socket.socket()) as s:
1785
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1786
struct.pack(str("16s16x"),
1787
interface))
1788
interface_index = struct.unpack(str("I"),
1789
ifreq[16:20])[0]
1790
return interface_index
1791
return if_nametoindex(interface)
1792
1793
1794
2755
def daemon(nochdir = False, noclose = False):
1795
2756
"""See daemon(3). Standard BSD Unix function.
1796
2757
1804
2765
sys.exit()
1805
2766
if not noclose:
1806
2767
# Close all standard open file descriptors
1807
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2768
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1808
2769
if not stat.S_ISCHR(os.fstat(null).st_mode):
1809
2770
raise OSError(errno.ENODEV,
1810
"%s not a character device"
1811
% os.path.devnull)
2771
"{} not a character device"
2772
.format(os.devnull))
1812
2773
os.dup2(null, sys.stdin.fileno())
1813
2774
os.dup2(null, sys.stdout.fileno())
1814
2775
os.dup2(null, sys.stderr.fileno())
1823
2784
1824
2785
parser = argparse.ArgumentParser()
1825
2786
parser.add_argument("-v", "--version", action="version",
1826
version = "%%(prog)s %s" % version,
2787
version = "%(prog)s {}".format(version),
1827
2788
help="show version number and exit")
1828
2789
parser.add_argument("-i", "--interface", metavar="IF",
1829
2790
help="Bind to interface IF")
1835
2796
help="Run self-test")
1836
2797
parser.add_argument("--debug", action="store_true",
1837
2798
help="Debug mode; run in foreground and log"
1838
" to terminal")
2799
" to terminal", default=None)
1839
2800
parser.add_argument("--debuglevel", metavar="LEVEL",
1840
2801
help="Debug level for stdout output")
1841
2802
parser.add_argument("--priority", help="GnuTLS"
1848
2809
" files")
1849
2810
parser.add_argument("--no-dbus", action="store_false",
1850
2811
dest="use_dbus", help="Do not provide D-Bus"
1851
" system bus interface")
2812
" system bus interface", default=None)
1852
2813
parser.add_argument("--no-ipv6", action="store_false",
1853
dest="use_ipv6", help="Do not use IPv6")
2814
dest="use_ipv6", help="Do not use IPv6",
2815
default=None)
2816
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
1854
2830
options = parser.parse_args()
1855
2831
1856
2832
if options.check:
1857
2833
import doctest
1858
doctest.testmod()
1859
sys.exit()
2834
fail_count, test_count = doctest.testmod()
2835
sys.exit(os.EX_OK if fail_count == 0 else 1)
1860
2836
1861
2837
# Default values for config file for server-global settings
1862
2838
server_defaults = { "interface": "",
1864
2840
"port": "",
1865
2841
"debug": "False",
1866
2842
"priority":
1867
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
2843
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2844
":+SIGN-DSA-SHA256",
1868
2845
"servicename": "Mandos",
1869
2846
"use_dbus": "True",
1870
2847
"use_ipv6": "True",
1871
2848
"debuglevel": "",
1872
}
2849
"restore": "True",
2850
"socket": "",
2851
"statedir": "/var/lib/mandos",
2852
"foreground": "False",
2853
"zeroconf": "True",
2854
}
1873
2855
1874
2856
# Parse config file for server-global settings
1875
2857
server_config = configparser.SafeConfigParser(server_defaults)
1876
2858
del server_defaults
1877
server_config.read(os.path.join(options.configdir,
1878
"mandos.conf"))
2859
server_config.read(os.path.join(options.configdir, "mandos.conf"))
1879
2860
# Convert the SafeConfigParser object to a dict
1880
2861
server_settings = server_config.defaults()
1881
2862
# Use the appropriate methods on the non-string config options
1882
for option in ("debug", "use_dbus", "use_ipv6"):
2863
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
1883
2864
server_settings[option] = server_config.getboolean("DEFAULT",
1884
2865
option)
1885
2866
if server_settings["port"]:
1886
2867
server_settings["port"] = server_config.getint("DEFAULT",
1887
2868
"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"])
1888
2878
del server_config
1889
2879
1890
2880
# Override the settings from the config file with command line
1891
2881
# options, if set.
1892
2882
for option in ("interface", "address", "port", "debug",
1893
"priority", "servicename", "configdir",
1894
"use_dbus", "use_ipv6", "debuglevel"):
2883
"priority", "servicename", "configdir", "use_dbus",
2884
"use_ipv6", "debuglevel", "restore", "statedir",
2885
"socket", "foreground", "zeroconf"):
1895
2886
value = getattr(options, option)
1896
2887
if value is not None:
1897
2888
server_settings[option] = value
1898
2889
del options
1899
2890
# Force all strings to be unicode
1900
2891
for option in server_settings.keys():
1901
if type(server_settings[option]) is str:
1902
server_settings[option] = unicode(server_settings[option])
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
1903
2902
# Now we have our good server settings in "server_settings"
1904
2903
1905
2904
##################################################################
1906
2905
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
1907
2911
# For convenience
1908
2912
debug = server_settings["debug"]
1909
2913
debuglevel = server_settings["debuglevel"]
1910
2914
use_dbus = server_settings["use_dbus"]
1911
2915
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)
1912
2929
1913
2930
if server_settings["servicename"] != "Mandos":
1914
syslogger.setFormatter(logging.Formatter
1915
('Mandos (%s) [%%(process)d]:'
1916
' %%(levelname)s: %%(message)s'
1917
% server_settings["servicename"]))
2931
syslogger.setFormatter(
2932
logging.Formatter('Mandos ({}) [%(process)d]:'
2933
' %(levelname)s: %(message)s'.format(
2934
server_settings["servicename"])))
1918
2935
1919
2936
# Parse config file with clients
1920
client_defaults = { "timeout": "5m",
1921
"extended_timeout": "15m",
1922
"interval": "2m",
1923
"checker": "fping -q -- %%(host)s",
1924
"host": "",
1925
"approval_delay": "0s",
1926
"approval_duration": "1s",
1927
}
1928
client_config = configparser.SafeConfigParser(client_defaults)
2937
client_config = configparser.SafeConfigParser(Client
2938
.client_defaults)
1929
2939
client_config.read(os.path.join(server_settings["configdir"],
1930
2940
"clients.conf"))
1931
2941
1932
2942
global mandos_dbus_service
1933
2943
mandos_dbus_service = None
1934
2944
1935
tcp_server = MandosServer((server_settings["address"],
1936
server_settings["port"]),
1937
ClientHandler,
1938
interface=(server_settings["interface"]
1939
or None),
1940
use_ipv6=use_ipv6,
1941
gnutls_priority=
1942
server_settings["priority"],
1943
use_dbus=use_dbus)
1944
if not debug:
1945
pidfilename = "/var/run/mandos.pid"
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
1946
2961
try:
1947
pidfile = open(pidfilename, "w")
1948
except IOError:
1949
logger.error("Could not open file %r", pidfilename)
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)
1950
2966
1951
try:
1952
uid = pwd.getpwnam("_mandos").pw_uid
1953
gid = pwd.getpwnam("_mandos").pw_gid
1954
except KeyError:
2967
for name, group in (("_mandos", "_mandos"),
2968
("mandos", "mandos"),
2969
("nobody", "nogroup")):
1955
2970
try:
1956
uid = pwd.getpwnam("mandos").pw_uid
1957
gid = pwd.getpwnam("mandos").pw_gid
2971
uid = pwd.getpwnam(name).pw_uid
2972
gid = pwd.getpwnam(group).pw_gid
2973
break
1958
2974
except KeyError:
1959
try:
1960
uid = pwd.getpwnam("nobody").pw_uid
1961
gid = pwd.getpwnam("nobody").pw_gid
1962
except KeyError:
1963
uid = 65534
1964
gid = 65534
2975
continue
2976
else:
2977
uid = 65534
2978
gid = 65534
1965
2979
try:
1966
2980
os.setgid(gid)
1967
2981
os.setuid(uid)
2982
if debug:
2983
logger.debug("Did setuid/setgid to {}:{}".format(uid,
2984
gid))
1968
2985
except OSError as error:
1969
if error[0] != errno.EPERM:
1970
raise error
1971
1972
if not debug and not debuglevel:
1973
syslogger.setLevel(logging.WARNING)
1974
console.setLevel(logging.WARNING)
1975
if debuglevel:
1976
level = getattr(logging, debuglevel.upper())
1977
syslogger.setLevel(level)
1978
console.setLevel(level)
2986
logger.warning("Failed to setuid/setgid to {}:{}: {}"
2987
.format(uid, gid, os.strerror(error.errno)))
2988
if error.errno != errno.EPERM:
2989
raise
1979
2990
1980
2991
if debug:
1981
2992
# Enable all possible GnuTLS debugging
1982
2993
1983
2994
# "Use a log level over 10 to enable all debugging options."
1984
2995
# - GnuTLS manual
1985
gnutls.library.functions.gnutls_global_set_log_level(11)
2996
gnutls.global_set_log_level(11)
1986
2997
1987
@gnutls.library.types.gnutls_log_func
2998
@gnutls.log_func
1988
2999
def debug_gnutls(level, string):
1989
3000
logger.debug("GnuTLS: %s", string[:-1])
1990
3001
1991
(gnutls.library.functions
1992
.gnutls_global_set_log_function(debug_gnutls))
3002
gnutls.global_set_log_function(debug_gnutls)
1993
3003
1994
3004
# Redirect stdin so all checkers get /dev/null
1995
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
3005
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1996
3006
os.dup2(null, sys.stdin.fileno())
1997
3007
if null > 2:
1998
3008
os.close(null)
1999
else:
2000
# No console logging
2001
logger.removeHandler(console)
2002
3009
2003
3010
# Need to fork before connecting to D-Bus
2004
if not debug:
3011
if not foreground:
2005
3012
# Close all input and output, do double fork, etc.
2006
3013
daemon()
2007
3014
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
2008
3019
global main_loop
2009
3020
# From the Avahi example code
2010
DBusGMainLoop(set_as_default=True )
2011
main_loop = gobject.MainLoop()
3021
DBusGMainLoop(set_as_default=True)
3022
main_loop = GLib.MainLoop()
2012
3023
bus = dbus.SystemBus()
2013
3024
# End of Avahi example code
2014
3025
if use_dbus:
2015
3026
try:
2016
3027
bus_name = dbus.service.BusName("se.recompile.Mandos",
2017
bus, do_not_queue=True)
2018
old_bus_name = (dbus.service.BusName
2019
("se.bsnet.fukt.Mandos", bus,
2020
do_not_queue=True))
2021
except dbus.exceptions.NameExistsException as e:
2022
logger.error(unicode(e) + ", disabling D-Bus")
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)
2023
3035
use_dbus = False
2024
3036
server_settings["use_dbus"] = False
2025
3037
tcp_server.use_dbus = False
2026
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2027
service = AvahiService(name = server_settings["servicename"],
2028
servicetype = "_mandos._tcp",
2029
protocol = protocol, bus = bus)
2030
if server_settings["interface"]:
2031
service.interface = (if_nametoindex
2032
(str(server_settings["interface"])))
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"))
2033
3048
2034
3049
global multiprocessing_manager
2035
3050
multiprocessing_manager = multiprocessing.Manager()
2036
3051
2037
3052
client_class = Client
2038
3053
if use_dbus:
2039
client_class = functools.partial(ClientDBusTransitional,
2040
bus = bus)
2041
def client_config_items(config, section):
2042
special_settings = {
2043
"approved_by_default":
2044
lambda: config.getboolean(section,
2045
"approved_by_default"),
2046
}
2047
for name, value in config.items(section):
3054
client_class = functools.partial(ClientDBus, bus = bus)
3055
3056
client_settings = Client.config_parser(client_config)
3057
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.
3069
if server_settings["restore"]:
3070
try:
3071
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"))
3117
os.remove(stored_state_path)
3118
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)
3125
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))
2048
3182
try:
2049
yield (name, special_settings[name]())
2050
except KeyError:
2051
yield (name, value)
2052
2053
tcp_server.clients.update(set(
2054
client_class(name = section,
2055
config= dict(client_config_items(
2056
client_config, section)))
2057
for section in client_config.sections()))
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
2058
3208
if not tcp_server.clients:
2059
3209
logger.warning("No clients defined")
2060
2061
if not debug:
2062
try:
2063
with pidfile:
2064
pid = os.getpid()
2065
pidfile.write(str(pid) + "\n".encode("utf-8"))
2066
del pidfile
2067
except IOError:
2068
logger.error("Could not write to file %r with PID %d",
2069
pidfilename, pid)
2070
except NameError:
2071
# "pidfile" was never created
2072
pass
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
2073
3221
del pidfilename
3222
3223
for termsig in (signal.SIGHUP, signal.SIGTERM):
3224
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3225
lambda: main_loop.quit() and False)
3226
3227
if use_dbus:
2074
3228
2075
signal.signal(signal.SIGINT, signal.SIG_IGN)
2076
2077
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2078
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2079
2080
if use_dbus:
2081
class MandosDBusService(dbus.service.Object):
3229
@alternate_dbus_interfaces(
3230
{ "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
3231
class MandosDBusService(DBusObjectWithObjectManager):
2082
3232
"""A D-Bus proxy object"""
3233
2083
3234
def __init__(self):
2084
3235
dbus.service.Object.__init__(self, bus, "/")
3236
2085
3237
_interface = "se.recompile.Mandos"
2086
3238
2087
3239
@dbus.service.signal(_interface, signature="o")
2094
3246
"D-Bus signal"
2095
3247
pass
2096
3248
3249
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3250
"true"})
2097
3251
@dbus.service.signal(_interface, signature="os")
2098
3252
def ClientRemoved(self, objpath, name):
2099
3253
"D-Bus signal"
2100
3254
pass
2101
3255
3256
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3257
"true"})
2102
3258
@dbus.service.method(_interface, out_signature="ao")
2103
3259
def GetAllClients(self):
2104
3260
"D-Bus method"
2105
return dbus.Array(c.dbus_object_path
2106
for c in tcp_server.clients)
3261
return dbus.Array(c.dbus_object_path for c in
3262
tcp_server.clients.values())
2107
3263
3264
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3265
"true"})
2108
3266
@dbus.service.method(_interface,
2109
3267
out_signature="a{oa{sv}}")
2110
3268
def GetAllClientsWithProperties(self):
2111
3269
"D-Bus method"
2112
3270
return dbus.Dictionary(
2113
((c.dbus_object_path, c.GetAll(""))
2114
for c in tcp_server.clients),
3271
{ c.dbus_object_path: c.GetAll(
3272
"se.recompile.Mandos.Client")
3273
for c in tcp_server.clients.values() },
2115
3274
signature="oa{sv}")
2116
3275
2117
3276
@dbus.service.method(_interface, in_signature="o")
2118
3277
def RemoveClient(self, object_path):
2119
3278
"D-Bus method"
2120
for c in tcp_server.clients:
3279
for c in tcp_server.clients.values():
2121
3280
if c.dbus_object_path == object_path:
2122
tcp_server.clients.remove(c)
3281
del tcp_server.clients[c.name]
2123
3282
c.remove_from_connection()
2124
# Don't signal anything except ClientRemoved
3283
# Don't signal the disabling
2125
3284
c.disable(quiet=True)
2126
# Emit D-Bus signal
2127
self.ClientRemoved(object_path, c.name)
3285
# Emit D-Bus signal for removal
3286
self.client_removed_signal(c)
2128
3287
return
2129
3288
raise KeyError(object_path)
2130
3289
2131
3290
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)
2132
3327
2133
class MandosDBusServiceTransitional(MandosDBusService):
2134
__metaclass__ = AlternateDBusNamesMetaclass
2135
mandos_dbus_service = MandosDBusServiceTransitional()
3328
mandos_dbus_service = MandosDBusService()
2136
3329
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
2137
3334
def cleanup():
2138
3335
"Cleanup function; run on exit"
2139
service.cleanup()
2140
2141
multiprocessing.active_children()
3336
if zeroconf:
3337
service.cleanup()
3338
3339
mp.active_children()
3340
wn.close()
3341
if not (tcp_server.clients or client_settings):
3342
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
3372
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)
3395
raise
3396
3397
# Delete all clients, and settings from config
2142
3398
while tcp_server.clients:
2143
client = tcp_server.clients.pop()
3399
name, client = tcp_server.clients.popitem()
2144
3400
if use_dbus:
2145
3401
client.remove_from_connection()
2146
client.disable_hook = None
2147
# Don't signal anything except ClientRemoved
3402
# Don't signal the disabling
2148
3403
client.disable(quiet=True)
3404
# Emit D-Bus signal for removal
2149
3405
if use_dbus:
2150
# Emit D-Bus signal
2151
mandos_dbus_service.ClientRemoved(client
2152
.dbus_object_path,
2153
client.name)
3406
mandos_dbus_service.client_removed_signal(client)
3407
client_settings.clear()
2154
3408
2155
3409
atexit.register(cleanup)
2156
3410
2157
for client in tcp_server.clients:
3411
for client in tcp_server.clients.values():
2158
3412
if use_dbus:
2159
# Emit D-Bus signal
2160
mandos_dbus_service.ClientAdded(client.dbus_object_path)
2161
client.enable()
3413
# Emit D-Bus signal for adding
3414
mandos_dbus_service.client_added_signal(client)
3415
# Need to initiate checking of clients
3416
if client.enabled:
3417
client.init_checker()
2162
3418
2163
3419
tcp_server.enable()
2164
3420
tcp_server.server_activate()
2165
3421
2166
3422
# Find out what port we got
2167
service.port = tcp_server.socket.getsockname()[1]
3423
if zeroconf:
3424
service.port = tcp_server.socket.getsockname()[1]
2168
3425
if use_ipv6:
2169
3426
logger.info("Now listening on address %r, port %d,"
2170
" flowinfo %d, scope_id %d"
2171
% tcp_server.socket.getsockname())
3427
" flowinfo %d, scope_id %d",
3428
*tcp_server.socket.getsockname())
2172
3429
else: # IPv4
2173
logger.info("Now listening on address %r, port %d"
2174
% tcp_server.socket.getsockname())
3430
logger.info("Now listening on address %r, port %d",
3431
*tcp_server.socket.getsockname())
2175
3432
2176
3433
#service.interface = tcp_server.socket.getsockname()[3]
2177
3434
2178
3435
try:
2179
# From the Avahi example code
2180
try:
2181
service.activate()
2182
except dbus.exceptions.DBusException as error:
2183
logger.critical("DBusException: %s", error)
2184
cleanup()
2185
sys.exit(1)
2186
# End of Avahi example code
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
2187
3445
2188
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2189
lambda *args, **kwargs:
2190
(tcp_server.handle_request
2191
(*args[2:], **kwargs) or True))
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))
2192
3450
2193
3451
logger.debug("Starting main loop")
2194
3452
main_loop.run()
2195
3453
except AvahiError as error:
2196
logger.critical("AvahiError: %s", error)
3454
logger.critical("Avahi Error", exc_info=error)
2197
3455
cleanup()
2198
3456
sys.exit(1)
2199
3457
except KeyboardInterrupt:
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0