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