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