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