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