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