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