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
76
import itertools
77
import collections
78
import codecs
68
79
69
80
import dbus
70
81
import dbus.service
71
import gobject
72
import avahi
82
try:
83
from gi.repository import GObject
84
except ImportError:
85
import gobject as GObject
73
86
from dbus.mainloop.glib import DBusGMainLoop
74
87
import ctypes
75
88
import ctypes.util
76
89
import xml.dom.minidom
77
90
import inspect
78
import GnuPGInterface
79
91
80
92
try:
81
93
SO_BINDTODEVICE = socket.SO_BINDTODEVICE
85
97
except ImportError:
86
98
SO_BINDTODEVICE = None
87
99
88
version = "1.5.0"
100
if sys.version_info.major == 2:
101
str = unicode
102
103
version = "1.7.5"
89
104
stored_state_file = "clients.pickle"
90
105
91
106
logger = logging.getLogger()
92
syslogger = (logging.handlers.SysLogHandler
93
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
94
address = str("/dev/log")))
107
syslogger = None
95
108
96
109
try:
97
if_nametoindex = (ctypes.cdll.LoadLibrary
98
(ctypes.util.find_library("c"))
99
.if_nametoindex)
110
if_nametoindex = ctypes.cdll.LoadLibrary(
111
ctypes.util.find_library("c")).if_nametoindex
100
112
except (OSError, AttributeError):
113
101
114
def if_nametoindex(interface):
102
115
"Get an interface index the hard way, i.e. using fcntl()"
103
116
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
104
117
with contextlib.closing(socket.socket()) as s:
105
118
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
106
struct.pack(str("16s16x"),
107
interface))
108
interface_index = struct.unpack(str("I"),
109
ifreq[16:20])[0]
119
struct.pack(b"16s16x", interface))
120
interface_index = struct.unpack("I", ifreq[16:20])[0]
110
121
return interface_index
111
122
112
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
113
140
def initlogger(debug, level=logging.WARNING):
114
141
"""init logger and add loglevel"""
115
142
143
global syslogger
144
syslogger = (logging.handlers.SysLogHandler(
145
facility = logging.handlers.SysLogHandler.LOG_DAEMON,
146
address = "/dev/log"))
116
147
syslogger.setFormatter(logging.Formatter
117
148
('Mandos [%(process)d]: %(levelname)s:'
118
149
' %(message)s'))
135
166
136
167
class PGPEngine(object):
137
168
"""A simple class for OpenPGP symmetric encryption & decryption"""
169
138
170
def __init__(self):
139
self.gnupg = GnuPGInterface.GnuPG()
140
171
self.tempdir = tempfile.mkdtemp(prefix="mandos-")
141
self.gnupg = GnuPGInterface.GnuPG()
142
self.gnupg.options.meta_interactive = False
143
self.gnupg.options.homedir = self.tempdir
144
self.gnupg.options.extra_args.extend(['--force-mdc',
145
'--quiet',
146
'--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']
147
188
148
189
def __enter__(self):
149
190
return self
150
191
151
def __exit__ (self, exc_type, exc_value, traceback):
192
def __exit__(self, exc_type, exc_value, traceback):
152
193
self._cleanup()
153
194
return False
154
195
171
212
def password_encode(self, password):
172
213
# Passphrase can not be empty and can not contain newlines or
173
214
# NUL bytes. So we prefix it and hex encode it.
174
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
175
222
176
223
def encrypt(self, data, password):
177
self.gnupg.passphrase = self.password_encode(password)
178
with open(os.devnull) as devnull:
179
try:
180
proc = self.gnupg.run(['--symmetric'],
181
create_fhs=['stdin', 'stdout'],
182
attach_fhs={'stderr': devnull})
183
with contextlib.closing(proc.handles['stdin']) as f:
184
f.write(data)
185
with contextlib.closing(proc.handles['stdout']) as f:
186
ciphertext = f.read()
187
proc.wait()
188
except IOError as e:
189
raise PGPError(e)
190
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)
191
239
return ciphertext
192
240
193
241
def decrypt(self, data, password):
194
self.gnupg.passphrase = self.password_encode(password)
195
with open(os.devnull) as devnull:
196
try:
197
proc = self.gnupg.run(['--decrypt'],
198
create_fhs=['stdin', 'stdout'],
199
attach_fhs={'stderr': devnull})
200
with contextlib.closing(proc.handles['stdin'] ) as f:
201
f.write(data)
202
with contextlib.closing(proc.handles['stdout']) as f:
203
decrypted_plaintext = f.read()
204
proc.wait()
205
except IOError as e:
206
raise PGPError(e)
207
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)
208
257
return decrypted_plaintext
209
258
210
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()
211
283
212
284
class AvahiError(Exception):
213
285
def __init__(self, value, *args, **kwargs):
214
286
self.value = value
215
super(AvahiError, self).__init__(value, *args, **kwargs)
216
def __unicode__(self):
217
return unicode(repr(self.value))
287
return super(AvahiError, self).__init__(value, *args,
288
**kwargs)
289
218
290
219
291
class AvahiServiceError(AvahiError):
220
292
pass
221
293
294
222
295
class AvahiGroupError(AvahiError):
223
296
pass
224
297
231
304
Used to optionally bind to the specified interface.
232
305
name: string; Example: 'Mandos'
233
306
type: string; Example: '_mandos._tcp'.
234
See <http://www.dns-sd.org/ServiceTypes.html>
307
See <https://www.iana.org/assignments/service-names-port-numbers>
235
308
port: integer; what port to announce
236
309
TXT: list of strings; TXT record for the service
237
310
domain: string; Domain to publish on, default to .local if empty.
243
316
server: D-Bus Server
244
317
bus: dbus.SystemBus()
245
318
"""
246
def __init__(self, interface = avahi.IF_UNSPEC, name = None,
247
servicetype = None, port = None, TXT = None,
248
domain = "", host = "", max_renames = 32768,
249
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):
250
331
self.interface = interface
251
332
self.name = name
252
333
self.type = servicetype
261
342
self.server = None
262
343
self.bus = bus
263
344
self.entry_group_state_changed_match = None
264
def rename(self):
345
346
def rename(self, remove=True):
265
347
"""Derived from the Avahi example code"""
266
348
if self.rename_count >= self.max_renames:
267
349
logger.critical("No suitable Zeroconf service name found"
268
350
" after %i retries, exiting.",
269
351
self.rename_count)
270
352
raise AvahiServiceError("Too many renames")
271
self.name = unicode(self.server
272
.GetAlternativeServiceName(self.name))
353
self.name = str(
354
self.server.GetAlternativeServiceName(self.name))
355
self.rename_count += 1
273
356
logger.info("Changing Zeroconf service name to %r ...",
274
357
self.name)
275
self.remove()
358
if remove:
359
self.remove()
276
360
try:
277
361
self.add()
278
362
except dbus.exceptions.DBusException as error:
279
logger.critical("DBusException: %s", error)
280
self.cleanup()
281
os._exit(1)
282
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
283
372
def remove(self):
284
373
"""Derived from the Avahi example code"""
285
374
if self.entry_group_state_changed_match is not None:
287
376
self.entry_group_state_changed_match = None
288
377
if self.group is not None:
289
378
self.group.Reset()
379
290
380
def add(self):
291
381
"""Derived from the Avahi example code"""
292
382
self.remove()
309
399
dbus.UInt16(self.port),
310
400
avahi.string_array_to_txt_array(self.TXT))
311
401
self.group.Commit()
402
312
403
def entry_group_state_changed(self, state, error):
313
404
"""Derived from the Avahi example code"""
314
405
logger.debug("Avahi entry group state change: %i", state)
320
411
self.rename()
321
412
elif state == avahi.ENTRY_GROUP_FAILURE:
322
413
logger.critical("Avahi: Error in group state changed %s",
323
unicode(error))
324
raise AvahiGroupError("State changed: %s"
325
% unicode(error))
414
str(error))
415
raise AvahiGroupError("State changed: {!s}".format(error))
416
326
417
def cleanup(self):
327
418
"""Derived from the Avahi example code"""
328
419
if self.group is not None:
333
424
pass
334
425
self.group = None
335
426
self.remove()
427
336
428
def server_state_changed(self, state, error=None):
337
429
"""Derived from the Avahi example code"""
338
430
logger.debug("Avahi server state change: %i", state)
339
bad_states = { avahi.SERVER_INVALID:
340
"Zeroconf server invalid",
341
avahi.SERVER_REGISTERING: None,
342
avahi.SERVER_COLLISION:
343
"Zeroconf server name collision",
344
avahi.SERVER_FAILURE:
345
"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
}
346
437
if state in bad_states:
347
438
if bad_states[state] is not None:
348
439
if error is None:
351
442
logger.error(bad_states[state] + ": %r", error)
352
443
self.cleanup()
353
444
elif state == avahi.SERVER_RUNNING:
354
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)
355
457
else:
356
458
if error is None:
357
459
logger.debug("Unknown state: %r", state)
358
460
else:
359
461
logger.debug("Unknown state: %r: %r", state, error)
462
360
463
def activate(self):
361
464
"""Derived from the Avahi example code"""
362
465
if self.server is None:
366
469
follow_name_owner_changes=True),
367
470
avahi.DBUS_INTERFACE_SERVER)
368
471
self.server.connect_to_signal("StateChanged",
369
self.server_state_changed)
472
self.server_state_changed)
370
473
self.server_state_changed(self.server.GetState())
371
474
475
372
476
class AvahiServiceToSyslog(AvahiService):
373
def rename(self):
477
def rename(self, *args, **kwargs):
374
478
"""Add the new name to the syslog messages"""
375
ret = AvahiService.rename(self)
376
syslogger.setFormatter(logging.Formatter
377
('Mandos (%s) [%%(process)d]:'
378
' %%(levelname)s: %%(message)s'
379
% 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)))
380
483
return ret
381
484
382
def timedelta_to_milliseconds(td):
383
"Convert a datetime.timedelta() to milliseconds"
384
return ((td.days * 24 * 60 * 60 * 1000)
385
+ (td.seconds * 1000)
386
+ (td.microseconds // 1000))
387
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
388
750
class Client(object):
389
751
"""A representation of a client host served by this server.
390
752
395
757
checker: subprocess.Popen(); a running checker process used
396
758
to see if the client lives.
397
759
'None' if no process is running.
398
checker_callback_tag: a gobject event source tag, or None
760
checker_callback_tag: a GObject event source tag, or None
399
761
checker_command: string; External command which is run to check
400
762
if client lives. %() expansions are done at
401
763
runtime with vars(self) as dict, so that for
402
764
instance %(name)s can be used in the command.
403
checker_initiator_tag: a gobject event source tag, or None
765
checker_initiator_tag: a GObject event source tag, or None
404
766
created: datetime.datetime(); (UTC) object creation
405
767
client_structure: Object describing what attributes a client has
406
768
and is used for storing the client at exit
407
769
current_checker_command: string; current running checker_command
408
disable_initiator_tag: a gobject event source tag, or None
770
disable_initiator_tag: a GObject event source tag, or None
409
771
enabled: bool()
410
772
fingerprint: string (40 or 32 hexadecimal digits); used to
411
773
uniquely identify the client
415
777
last_checked_ok: datetime.datetime(); (UTC) or None
416
778
last_checker_status: integer between 0 and 255 reflecting exit
417
779
status of last checker. -1 reflects crashed
418
checker, or None.
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
419
783
last_enabled: datetime.datetime(); (UTC) or None
420
784
name: string; from the config file, used in log messages and
421
785
D-Bus identifiers
422
786
secret: bytestring; sent verbatim (over TLS) to client
423
787
timeout: datetime.timedelta(); How long from last_checked_ok
424
788
until this client is disabled
425
extended_timeout: extra long timeout when password has been sent
789
extended_timeout: extra long timeout when secret has been sent
426
790
runtime_expansions: Allowed attributes for runtime expansion.
427
791
expires: datetime.datetime(); time (UTC) when a client will be
428
792
disabled, or None
793
server_settings: The server_settings dict from main()
429
794
"""
430
795
431
796
runtime_expansions = ("approval_delay", "approval_duration",
432
"created", "enabled", "fingerprint",
433
"host", "interval", "last_checked_ok",
797
"created", "enabled", "expires",
798
"fingerprint", "host", "interval",
799
"last_approval_request", "last_checked_ok",
434
800
"last_enabled", "name", "timeout")
435
client_defaults = { "timeout": "5m",
436
"extended_timeout": "15m",
437
"interval": "2m",
438
"checker": "fping -q -- %%(host)s",
439
"host": "",
440
"approval_delay": "0s",
441
"approval_duration": "1s",
442
"approved_by_default": "True",
443
"enabled": "True",
444
}
445
446
def timeout_milliseconds(self):
447
"Return the 'timeout' attribute in milliseconds"
448
return timedelta_to_milliseconds(self.timeout)
449
450
def extended_timeout_milliseconds(self):
451
"Return the 'extended_timeout' attribute in milliseconds"
452
return timedelta_to_milliseconds(self.extended_timeout)
453
454
def interval_milliseconds(self):
455
"Return the 'interval' attribute in milliseconds"
456
return timedelta_to_milliseconds(self.interval)
457
458
def approval_delay_milliseconds(self):
459
return timedelta_to_milliseconds(self.approval_delay)
460
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
461
813
@staticmethod
462
814
def config_parser(config):
463
815
"""Construct a new dict of client settings of this form:
478
830
client["enabled"] = config.getboolean(client_name,
479
831
"enabled")
480
832
833
# Uppercase and remove spaces from fingerprint for later
834
# comparison purposes with return value from the
835
# fingerprint() function
481
836
client["fingerprint"] = (section["fingerprint"].upper()
482
837
.replace(" ", ""))
483
838
if "secret" in section:
484
client["secret"] = section["secret"].decode("base64")
839
client["secret"] = codecs.decode(section["secret"]
840
.encode("utf-8"),
841
"base64")
485
842
elif "secfile" in section:
486
843
with open(os.path.expanduser(os.path.expandvars
487
844
(section["secfile"])),
488
845
"rb") as secfile:
489
846
client["secret"] = secfile.read()
490
847
else:
491
raise TypeError("No secret or secfile for section %s"
492
% section)
848
raise TypeError("No secret or secfile for section {}"
849
.format(section))
493
850
client["timeout"] = string_to_delta(section["timeout"])
494
851
client["extended_timeout"] = string_to_delta(
495
852
section["extended_timeout"])
501
858
client["checker_command"] = section["checker"]
502
859
client["last_approval_request"] = None
503
860
client["last_checked_ok"] = None
504
client["last_checker_status"] = None
861
client["last_checker_status"] = -2
505
862
506
863
return settings
507
508
509
def __init__(self, settings, name = None):
510
"""Note: the 'checker' key in 'config' sets the
511
'checker_command' attribute and *not* the 'checker'
512
attribute."""
864
865
def __init__(self, settings, name = None, server_settings=None):
513
866
self.name = name
867
if server_settings is None:
868
server_settings = {}
869
self.server_settings = server_settings
514
870
# adding all client settings
515
for setting, value in settings.iteritems():
871
for setting, value in settings.items():
516
872
setattr(self, setting, value)
517
873
518
874
if self.enabled:
524
880
else:
525
881
self.last_enabled = None
526
882
self.expires = None
527
883
528
884
logger.debug("Creating client %r", self.name)
529
# Uppercase and remove spaces from fingerprint for later
530
# comparison purposes with return value from the fingerprint()
531
# function
532
885
logger.debug(" Fingerprint: %s", self.fingerprint)
533
886
self.created = settings.get("created",
534
887
datetime.datetime.utcnow())
535
888
536
889
# attributes specific for this server instance
537
890
self.checker = None
538
891
self.checker_initiator_tag = None
541
894
self.current_checker_command = None
542
895
self.approved = None
543
896
self.approvals_pending = 0
544
self.changedstate = (multiprocessing_manager
545
.Condition(multiprocessing_manager
546
.Lock()))
547
self.client_structure = [attr for attr in
548
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()
549
901
if not attr.startswith("_")]
550
902
self.client_structure.append("client_structure")
551
903
552
for name, t in inspect.getmembers(type(self),
553
lambda obj:
554
isinstance(obj,
555
property)):
904
for name, t in inspect.getmembers(
905
type(self), lambda obj: isinstance(obj, property)):
556
906
if not name.startswith("_"):
557
907
self.client_structure.append(name)
558
908
566
916
if getattr(self, "enabled", False):
567
917
# Already enabled
568
918
return
569
self.send_changedstate()
570
919
self.expires = datetime.datetime.utcnow() + self.timeout
571
920
self.enabled = True
572
921
self.last_enabled = datetime.datetime.utcnow()
573
922
self.init_checker()
923
self.send_changedstate()
574
924
575
925
def disable(self, quiet=True):
576
926
"""Disable this client."""
577
927
if not getattr(self, "enabled", False):
578
928
return False
579
929
if not quiet:
580
self.send_changedstate()
581
if not quiet:
582
930
logger.info("Disabling client %s", self.name)
583
if getattr(self, "disable_initiator_tag", False):
584
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)
585
933
self.disable_initiator_tag = None
586
934
self.expires = None
587
if getattr(self, "checker_initiator_tag", False):
588
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)
589
937
self.checker_initiator_tag = None
590
938
self.stop_checker()
591
939
self.enabled = False
592
# 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
593
943
return False
594
944
595
945
def __del__(self):
598
948
def init_checker(self):
599
949
# Schedule a new checker to be started an 'interval' from now,
600
950
# and every interval from then on.
601
self.checker_initiator_tag = (gobject.timeout_add
602
(self.interval_milliseconds(),
603
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)
604
956
# Schedule a disable() when 'timeout' has passed
605
self.disable_initiator_tag = (gobject.timeout_add
606
(self.timeout_milliseconds(),
607
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)
608
961
# Also start a new checker *right now*.
609
962
self.start_checker()
610
963
611
def checker_callback(self, pid, condition, command):
964
def checker_callback(self, source, condition, connection,
965
command):
612
966
"""The checker has completed, so take appropriate actions."""
613
967
self.checker_callback_tag = None
614
968
self.checker = None
615
if os.WIFEXITED(condition):
616
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
617
976
if self.last_checker_status == 0:
618
977
logger.info("Checker for %(name)s succeeded",
619
978
vars(self))
620
979
self.checked_ok()
621
980
else:
622
logger.info("Checker for %(name)s failed",
623
vars(self))
981
logger.info("Checker for %(name)s failed", vars(self))
624
982
else:
625
983
self.last_checker_status = -1
984
self.last_checker_signal = -returncode
626
985
logger.warning("Checker for %(name)s crashed?",
627
986
vars(self))
628
629
def checked_ok(self, timeout=None):
630
"""Bump up the timeout for this client.
631
632
This should only be called when the client has been seen,
633
alive and well.
634
"""
987
return False
988
989
def checked_ok(self):
990
"""Assert that the client has been seen, alive and well."""
991
self.last_checked_ok = datetime.datetime.utcnow()
992
self.last_checker_status = 0
993
self.last_checker_signal = None
994
self.bump_timeout()
995
996
def bump_timeout(self, timeout=None):
997
"""Bump up the timeout for this client."""
635
998
if timeout is None:
636
999
timeout = self.timeout
637
self.last_checked_ok = datetime.datetime.utcnow()
638
1000
if self.disable_initiator_tag is not None:
639
gobject.source_remove(self.disable_initiator_tag)
1001
GObject.source_remove(self.disable_initiator_tag)
1002
self.disable_initiator_tag = None
640
1003
if getattr(self, "enabled", False):
641
self.disable_initiator_tag = (gobject.timeout_add
642
(timedelta_to_milliseconds
643
(timeout), self.disable))
1004
self.disable_initiator_tag = GObject.timeout_add(
1005
int(timeout.total_seconds() * 1000), self.disable)
644
1006
self.expires = datetime.datetime.utcnow() + timeout
645
1007
646
1008
def need_approval(self):
652
1014
If a checker already exists, leave it running and do
653
1015
nothing."""
654
1016
# The reason for not killing a running checker is that if we
655
# did that, then if a checker (for some reason) started
656
# running slowly and taking more than 'interval' time, the
657
# client would inevitably timeout, since no checker would get
658
# 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
659
1021
# checkers alone, the checker would have to take more time
660
1022
# than 'timeout' for the client to be disabled, which is as it
661
1023
# should be.
662
1024
663
# If a checker exists, make sure it is not a zombie
664
try:
665
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
666
except (AttributeError, OSError) as error:
667
if (isinstance(error, OSError)
668
and error.errno != errno.ECHILD):
669
raise error
670
else:
671
if pid:
672
logger.warning("Checker was a zombie")
673
gobject.source_remove(self.checker_callback_tag)
674
self.checker_callback(pid, status,
675
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
676
1029
# Start a new checker if needed
677
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 }
678
1035
try:
679
# In case checker_command has exactly one % operator
680
command = self.checker_command % self.host
681
except TypeError:
682
# Escape attributes for the shell
683
escaped_attrs = dict(
684
(attr,
685
re.escape(unicode(str(getattr(self, attr, "")),
686
errors=
687
'replace')))
688
for attr in
689
self.runtime_expansions)
690
691
try:
692
command = self.checker_command % escaped_attrs
693
except TypeError as error:
694
logger.error('Could not format string "%s":'
695
' %s', self.checker_command, error)
696
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
697
1042
self.current_checker_command = command
698
try:
699
logger.info("Starting checker %r for %s",
700
command, self.name)
701
# We don't need to redirect stdout and stderr, since
702
# in normal mode, that is already done by daemon(),
703
# and in debug mode we don't want to. (Stdin is
704
# always replaced by /dev/null.)
705
self.checker = subprocess.Popen(command,
706
close_fds=True,
707
shell=True, cwd="/")
708
self.checker_callback_tag = (gobject.child_watch_add
709
(self.checker.pid,
710
self.checker_callback,
711
data=command))
712
# The checker may have completed before the gobject
713
# watch was added. Check for this.
714
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
715
if pid:
716
gobject.source_remove(self.checker_callback_tag)
717
self.checker_callback(pid, status, command)
718
except OSError as error:
719
logger.error("Failed to start subprocess: %s",
720
error)
721
# 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
722
1069
return True
723
1070
724
1071
def stop_checker(self):
725
1072
"""Force the checker process, if any, to stop."""
726
1073
if self.checker_callback_tag:
727
gobject.source_remove(self.checker_callback_tag)
1074
GObject.source_remove(self.checker_callback_tag)
728
1075
self.checker_callback_tag = None
729
1076
if getattr(self, "checker", None) is None:
730
1077
return
731
1078
logger.debug("Stopping checker for %(name)s", vars(self))
732
try:
733
os.kill(self.checker.pid, signal.SIGTERM)
734
#time.sleep(0.5)
735
#if self.checker.poll() is None:
736
# os.kill(self.checker.pid, signal.SIGKILL)
737
except OSError as error:
738
if error.errno != errno.ESRCH: # No such process
739
raise
1079
self.checker.terminate()
740
1080
self.checker = None
741
1081
742
1082
743
def dbus_service_property(dbus_interface, signature="v",
744
access="readwrite", byte_arrays=False):
1083
def dbus_service_property(dbus_interface,
1084
signature="v",
1085
access="readwrite",
1086
byte_arrays=False):
745
1087
"""Decorators for marking methods of a DBusObjectWithProperties to
746
1088
become properties on the D-Bus.
747
1089
756
1098
# "Set" method, so we fail early here:
757
1099
if byte_arrays and signature != "ay":
758
1100
raise ValueError("Byte arrays not supported for non-'ay'"
759
" signature %r" % signature)
1101
" signature {!r}".format(signature))
1102
760
1103
def decorator(func):
761
1104
func._dbus_is_property = True
762
1105
func._dbus_interface = dbus_interface
767
1110
func._dbus_name = func._dbus_name[:-14]
768
1111
func._dbus_get_args_options = {'byte_arrays': byte_arrays }
769
1112
return func
1113
1114
return decorator
1115
1116
1117
def dbus_interface_annotations(dbus_interface):
1118
"""Decorator for marking functions returning interface annotations
1119
1120
Usage:
1121
1122
@dbus_interface_annotations("org.example.Interface")
1123
def _foo(self): # Function name does not matter
1124
return {"org.freedesktop.DBus.Deprecated": "true",
1125
"org.freedesktop.DBus.Property.EmitsChangedSignal":
1126
"false"}
1127
"""
1128
1129
def decorator(func):
1130
func._dbus_is_interface = True
1131
func._dbus_interface = dbus_interface
1132
func._dbus_name = dbus_interface
1133
return func
1134
1135
return decorator
1136
1137
1138
def dbus_annotations(annotations):
1139
"""Decorator to annotate D-Bus methods, signals or properties
1140
Usage:
1141
1142
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
1143
"org.freedesktop.DBus.Property."
1144
"EmitsChangedSignal": "false"})
1145
@dbus_service_property("org.example.Interface", signature="b",
1146
access="r")
1147
def Property_dbus_property(self):
1148
return dbus.Boolean(False)
1149
1150
See also the DBusObjectWithAnnotations class.
1151
"""
1152
1153
def decorator(func):
1154
func._dbus_annotations = annotations
1155
return func
1156
770
1157
return decorator
771
1158
772
1159
773
1160
class DBusPropertyException(dbus.exceptions.DBusException):
774
1161
"""A base class for D-Bus property-related exceptions
775
1162
"""
776
def __unicode__(self):
777
return unicode(str(self))
1163
pass
778
1164
779
1165
780
1166
class DBusPropertyAccessException(DBusPropertyException):
789
1175
pass
790
1176
791
1177
792
class DBusObjectWithProperties(dbus.service.Object):
1178
class DBusObjectWithAnnotations(dbus.service.Object):
1179
"""A D-Bus object with annotations.
1180
1181
Classes inheriting from this can use the dbus_annotations
1182
decorator to add annotations to methods or signals.
1183
"""
1184
1185
@staticmethod
1186
def _is_dbus_thing(thing):
1187
"""Returns a function testing if an attribute is a D-Bus thing
1188
1189
If called like _is_dbus_thing("method") it returns a function
1190
suitable for use as predicate to inspect.getmembers().
1191
"""
1192
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
1193
False)
1194
1195
def _get_all_dbus_things(self, thing):
1196
"""Returns a generator of (name, attribute) pairs
1197
"""
1198
return ((getattr(athing.__get__(self), "_dbus_name", name),
1199
athing.__get__(self))
1200
for cls in self.__class__.__mro__
1201
for name, athing in
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):
793
1268
"""A D-Bus object with properties.
794
1269
795
1270
Classes inheriting from this can use the dbus_service_property
797
1272
standard Get(), Set(), and GetAll() methods on the D-Bus.
798
1273
"""
799
1274
800
@staticmethod
801
def _is_dbus_property(obj):
802
return getattr(obj, "_dbus_is_property", False)
803
804
def _get_all_dbus_properties(self):
805
"""Returns a generator of (name, attribute) pairs
806
"""
807
return ((prop.__get__(self)._dbus_name, prop.__get__(self))
808
for cls in self.__class__.__mro__
809
for name, prop in
810
inspect.getmembers(cls, self._is_dbus_property))
811
812
1275
def _get_dbus_property(self, interface_name, property_name):
813
1276
"""Returns a bound method if one exists which is a D-Bus
814
1277
property with the specified name and interface.
815
1278
"""
816
for cls in self.__class__.__mro__:
817
for name, value in (inspect.getmembers
818
(cls, self._is_dbus_property)):
1279
for cls in self.__class__.__mro__:
1280
for name, value in inspect.getmembers(
1281
cls, self._is_dbus_thing("property")):
819
1282
if (value._dbus_name == property_name
820
1283
and value._dbus_interface == interface_name):
821
1284
return value.__get__(self)
822
1285
823
1286
# No such property
824
raise DBusPropertyNotFound(self.dbus_object_path + ":"
825
+ interface_name + "."
826
+ property_name)
827
828
@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",
829
1301
out_signature="v")
830
1302
def Get(self, interface_name, property_name):
831
1303
"""Standard D-Bus property Get() method, see D-Bus standard.
849
1321
# The byte_arrays option is not supported yet on
850
1322
# signatures other than "ay".
851
1323
if prop._dbus_signature != "ay":
852
raise ValueError
1324
raise ValueError("Byte arrays not supported for non-"
1325
"'ay' signature {!r}"
1326
.format(prop._dbus_signature))
853
1327
value = dbus.ByteArray(b''.join(chr(byte)
854
1328
for byte in value))
855
1329
prop(value)
856
1330
857
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
1331
@dbus.service.method(dbus.PROPERTIES_IFACE,
1332
in_signature="s",
858
1333
out_signature="a{sv}")
859
1334
def GetAll(self, interface_name):
860
1335
"""Standard D-Bus property GetAll() method, see D-Bus
863
1338
Note: Will not include properties with access="write".
864
1339
"""
865
1340
properties = {}
866
for name, prop in self._get_all_dbus_properties():
1341
for name, prop in self._get_all_dbus_things("property"):
867
1342
if (interface_name
868
1343
and interface_name != prop._dbus_interface):
869
1344
# Interface non-empty but did not match
875
1350
if not hasattr(value, "variant_level"):
876
1351
properties[name] = value
877
1352
continue
878
properties[name] = type(value)(value, variant_level=
879
value.variant_level+1)
1353
properties[name] = type(value)(
1354
value, variant_level = value.variant_level + 1)
880
1355
return dbus.Dictionary(properties, signature="sv")
881
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
882
1365
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
883
1366
out_signature="s",
884
1367
path_keyword='object_path',
885
1368
connection_keyword='connection')
886
1369
def Introspect(self, object_path, connection):
887
"""Standard D-Bus method, overloaded to insert property tags.
1370
"""Overloading of standard D-Bus method.
1371
1372
Inserts property tags and interface annotation tags.
888
1373
"""
889
xmlstring = dbus.service.Object.Introspect(self, object_path,
890
connection)
1374
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1375
object_path,
1376
connection)
891
1377
try:
892
1378
document = xml.dom.minidom.parseString(xmlstring)
1379
893
1380
def make_tag(document, name, prop):
894
1381
e = document.createElement("property")
895
1382
e.setAttribute("name", name)
896
1383
e.setAttribute("type", prop._dbus_signature)
897
1384
e.setAttribute("access", prop._dbus_access)
898
1385
return e
1386
899
1387
for if_tag in document.getElementsByTagName("interface"):
1388
# Add property tags
900
1389
for tag in (make_tag(document, name, prop)
901
1390
for name, prop
902
in self._get_all_dbus_properties()
1391
in self._get_all_dbus_things("property")
903
1392
if prop._dbus_interface
904
1393
== if_tag.getAttribute("name")):
905
1394
if_tag.appendChild(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)
906
1411
# Add the names to the return values for the
907
1412
# "org.freedesktop.DBus.Properties" methods
908
1413
if (if_tag.getAttribute("name")
923
1428
except (AttributeError, xml.dom.DOMException,
924
1429
xml.parsers.expat.ExpatError) as error:
925
1430
logger.error("Failed to override Introspection method",
926
error)
927
return xmlstring
928
929
930
def datetime_to_dbus (dt, variant_level=0):
1431
exc_info=error)
1432
return xmlstring
1433
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):
931
1504
"""Convert a UTC datetime.datetime() to a D-Bus type."""
932
1505
if dt is None:
933
1506
return dbus.String("", variant_level = variant_level)
934
return dbus.String(dt.isoformat(),
935
variant_level=variant_level)
936
937
938
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
939
.__metaclass__):
940
"""Applied to an empty subclass of a D-Bus object, this metaclass
941
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).
942
1532
"""
943
def __new__(mcs, name, bases, attr):
944
# Go through all the base classes which could have D-Bus
945
# methods, signals, or properties in them
946
for base in (b for b in bases
947
if issubclass(b, dbus.service.Object)):
948
# Go though all attributes of the base class
949
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):
950
1541
# Ignore non-D-Bus attributes, and D-Bus attributes
951
1542
# with the wrong interface name
952
1543
if (not hasattr(attribute, "_dbus_interface")
953
or not attribute._dbus_interface
954
.startswith("se.recompile.Mandos")):
1544
or not attribute._dbus_interface.startswith(
1545
orig_interface_name)):
955
1546
continue
956
1547
# Create an alternate D-Bus interface name based on
957
1548
# the current name
958
alt_interface = (attribute._dbus_interface
959
.replace("se.recompile.Mandos",
960
"se.bsnet.fukt.Mandos"))
1549
alt_interface = attribute._dbus_interface.replace(
1550
orig_interface_name, alt_interface_name)
1551
interface_names.add(alt_interface)
961
1552
# Is this a D-Bus signal?
962
1553
if getattr(attribute, "_dbus_is_signal", False):
963
# Extract the original non-method function by
964
# black magic
965
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(
966
1558
zip(attribute.func_code.co_freevars,
967
attribute.__closure__))["func"]
968
.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)
969
1566
# Create a new, but exactly alike, function
970
1567
# object, and decorate it to be a new D-Bus signal
971
1568
# with the alternate D-Bus interface name
972
new_function = (dbus.service.signal
973
(alt_interface,
974
attribute._dbus_signature)
975
(types.FunctionType(
976
nonmethod_func.func_code,
977
nonmethod_func.func_globals,
978
nonmethod_func.func_name,
979
nonmethod_func.func_defaults,
980
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))
1573
# Copy annotations, if any
1574
try:
1575
new_function._dbus_annotations = dict(
1576
attribute._dbus_annotations)
1577
except AttributeError:
1578
pass
981
1579
# Define a creator of a function to call both the
982
# old and new functions, so both the old and new
983
# 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
984
1583
def fixscope(func1, func2):
985
1584
"""This function is a scope container to pass
986
1585
func1 and func2 to the "call_both" function
987
1586
outside of its arguments"""
1587
1588
@functools.wraps(func2)
988
1589
def call_both(*args, **kwargs):
989
1590
"""This function will emit two D-Bus
990
1591
signals by calling func1 and func2"""
991
1592
func1(*args, **kwargs)
992
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
993
1599
return call_both
994
1600
# Create the "call_both" function and add it to
995
1601
# the class
996
attr[attrname] = fixscope(attribute,
997
new_function)
1602
attr[attrname] = fixscope(attribute, new_function)
998
1603
# Is this a D-Bus method?
999
1604
elif getattr(attribute, "_dbus_is_method", False):
1000
1605
# Create a new, but exactly alike, function
1001
1606
# object. Decorate it to be a new D-Bus method
1002
1607
# with the alternate D-Bus interface name. Add it
1003
1608
# to the class.
1004
attr[attrname] = (dbus.service.method
1005
(alt_interface,
1006
attribute._dbus_in_signature,
1007
attribute._dbus_out_signature)
1008
(types.FunctionType
1009
(attribute.func_code,
1010
attribute.func_globals,
1011
attribute.func_name,
1012
attribute.func_defaults,
1013
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)))
1615
# Copy annotations, if any
1616
try:
1617
attr[attrname]._dbus_annotations = dict(
1618
attribute._dbus_annotations)
1619
except AttributeError:
1620
pass
1014
1621
# Is this a D-Bus property?
1015
1622
elif getattr(attribute, "_dbus_is_property", False):
1016
1623
# Create a new, but exactly alike, function
1017
1624
# object, and decorate it to be a new D-Bus
1018
1625
# property with the alternate D-Bus interface
1019
1626
# name. Add it to the class.
1020
attr[attrname] = (dbus_service_property
1021
(alt_interface,
1022
attribute._dbus_signature,
1023
attribute._dbus_access,
1024
attribute
1025
._dbus_get_args_options
1026
["byte_arrays"])
1027
(types.FunctionType
1028
(attribute.func_code,
1029
attribute.func_globals,
1030
attribute.func_name,
1031
attribute.func_defaults,
1032
attribute.func_closure)))
1033
return type.__new__(mcs, name, bases, attr)
1034
1035
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)))
1633
# Copy annotations, if any
1634
try:
1635
attr[attrname]._dbus_annotations = dict(
1636
attribute._dbus_annotations)
1637
except AttributeError:
1638
pass
1639
# Is this a D-Bus interface?
1640
elif getattr(attribute, "_dbus_is_interface", False):
1641
# Create a new, but exactly alike, function
1642
# object. Decorate it to be a new D-Bus interface
1643
# with the alternate D-Bus interface name. Add it
1644
# to the class.
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"})
1036
1679
class ClientDBus(Client, DBusObjectWithProperties):
1037
1680
"""A Client class using D-Bus
1038
1681
1042
1685
"""
1043
1686
1044
1687
runtime_expansions = (Client.runtime_expansions
1045
+ ("dbus_object_path",))
1688
+ ("dbus_object_path", ))
1689
1690
_interface = "se.recompile.Mandos.Client"
1046
1691
1047
1692
# dbus.service.Object doesn't use super(), so we can't either.
1048
1693
1049
1694
def __init__(self, bus = None, *args, **kwargs):
1050
1695
self.bus = bus
1051
1696
Client.__init__(self, *args, **kwargs)
1052
self._approvals_pending = 0
1053
1054
self._approvals_pending = 0
1055
1697
# Only now, when this client is initialized, can it show up on
1056
1698
# the D-Bus
1057
client_object_name = unicode(self.name).translate(
1699
client_object_name = str(self.name).translate(
1058
1700
{ord("."): ord("_"),
1059
1701
ord("-"): ord("_")})
1060
self.dbus_object_path = (dbus.ObjectPath
1061
("/clients/" + client_object_name))
1702
self.dbus_object_path = dbus.ObjectPath(
1703
"/clients/" + client_object_name)
1062
1704
DBusObjectWithProperties.__init__(self, self.bus,
1063
1705
self.dbus_object_path)
1064
1065
def notifychangeproperty(transform_func,
1066
dbus_name, type_func=lambda x: x,
1067
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):
1068
1712
""" Modify a variable so that it's a property which announces
1069
1713
its changes to DBus.
1070
1714
1075
1719
to the D-Bus. Default: no transform
1076
1720
variant_level: D-Bus variant level. Default: 1
1077
1721
"""
1078
attrname = "_{0}".format(dbus_name)
1722
attrname = "_{}".format(dbus_name)
1723
1079
1724
def setter(self, value):
1080
1725
if hasattr(self, "dbus_object_path"):
1081
1726
if (not hasattr(self, attrname) or
1082
1727
type_func(getattr(self, attrname, None))
1083
1728
!= type_func(value)):
1084
dbus_value = transform_func(type_func(value),
1085
variant_level
1086
=variant_level)
1087
self.PropertyChanged(dbus.String(dbus_name),
1088
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())
1089
1744
setattr(self, attrname, value)
1090
1745
1091
1746
return property(lambda self: getattr(self, attrname), setter)
1092
1747
1093
1094
1748
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1095
1749
approvals_pending = notifychangeproperty(dbus.Boolean,
1096
1750
"ApprovalPending",
1098
1752
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1099
1753
last_enabled = notifychangeproperty(datetime_to_dbus,
1100
1754
"LastEnabled")
1101
checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1102
type_func = lambda checker:
1103
checker is not None)
1755
checker = notifychangeproperty(
1756
dbus.Boolean, "CheckerRunning",
1757
type_func = lambda checker: checker is not None)
1104
1758
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1105
1759
"LastCheckedOK")
1760
last_checker_status = notifychangeproperty(dbus.Int16,
1761
"LastCheckerStatus")
1106
1762
last_approval_request = notifychangeproperty(
1107
1763
datetime_to_dbus, "LastApprovalRequest")
1108
1764
approved_by_default = notifychangeproperty(dbus.Boolean,
1109
1765
"ApprovedByDefault")
1110
approval_delay = notifychangeproperty(dbus.UInt64,
1111
"ApprovalDelay",
1112
type_func =
1113
timedelta_to_milliseconds)
1766
approval_delay = notifychangeproperty(
1767
dbus.UInt64, "ApprovalDelay",
1768
type_func = lambda td: td.total_seconds() * 1000)
1114
1769
approval_duration = notifychangeproperty(
1115
1770
dbus.UInt64, "ApprovalDuration",
1116
type_func = timedelta_to_milliseconds)
1771
type_func = lambda td: td.total_seconds() * 1000)
1117
1772
host = notifychangeproperty(dbus.String, "Host")
1118
timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1119
type_func =
1120
timedelta_to_milliseconds)
1773
timeout = notifychangeproperty(
1774
dbus.UInt64, "Timeout",
1775
type_func = lambda td: td.total_seconds() * 1000)
1121
1776
extended_timeout = notifychangeproperty(
1122
1777
dbus.UInt64, "ExtendedTimeout",
1123
type_func = timedelta_to_milliseconds)
1124
interval = notifychangeproperty(dbus.UInt64,
1125
"Interval",
1126
type_func =
1127
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)
1128
1782
checker_command = notifychangeproperty(dbus.String, "Checker")
1783
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1784
invalidate_only=True)
1129
1785
1130
1786
del notifychangeproperty
1131
1787
1138
1794
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1139
1795
Client.__del__(self, *args, **kwargs)
1140
1796
1141
def checker_callback(self, pid, condition, command,
1142
*args, **kwargs):
1143
self.checker_callback_tag = None
1144
self.checker = None
1145
if os.WIFEXITED(condition):
1146
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:
1147
1804
# Emit D-Bus signal
1148
1805
self.CheckerCompleted(dbus.Int16(exitstatus),
1149
dbus.Int64(condition),
1806
# This is specific to GNU libC
1807
dbus.Int64(exitstatus << 8),
1150
1808
dbus.String(command))
1151
1809
else:
1152
1810
# Emit D-Bus signal
1153
1811
self.CheckerCompleted(dbus.Int16(-1),
1154
dbus.Int64(condition),
1812
dbus.Int64(
1813
# This is specific to GNU libC
1814
(exitstatus << 8)
1815
| self.last_checker_signal),
1155
1816
dbus.String(command))
1156
1157
return Client.checker_callback(self, pid, condition, command,
1158
*args, **kwargs)
1817
return ret
1159
1818
1160
1819
def start_checker(self, *args, **kwargs):
1161
old_checker = self.checker
1162
if self.checker is not None:
1163
old_checker_pid = self.checker.pid
1164
else:
1165
old_checker_pid = None
1820
old_checker_pid = getattr(self.checker, "pid", None)
1166
1821
r = Client.start_checker(self, *args, **kwargs)
1167
1822
# Only if new checker process was started
1168
1823
if (self.checker is not None
1176
1831
return False
1177
1832
1178
1833
def approve(self, value=True):
1179
self.send_changedstate()
1180
1834
self.approved = value
1181
gobject.timeout_add(timedelta_to_milliseconds
1182
(self.approval_duration),
1183
self._reset_approved)
1184
1835
GObject.timeout_add(int(self.approval_duration.total_seconds()
1836
* 1000), self._reset_approved)
1837
self.send_changedstate()
1185
1838
1186
1839
## D-Bus methods, signals & properties
1187
_interface = "se.recompile.Mandos.Client"
1840
1841
## Interfaces
1188
1842
1189
1843
## Signals
1190
1844
1201
1855
pass
1202
1856
1203
1857
# PropertyChanged - signal
1858
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1204
1859
@dbus.service.signal(_interface, signature="sv")
1205
1860
def PropertyChanged(self, property, value):
1206
1861
"D-Bus signal"
1227
1882
"D-Bus signal"
1228
1883
return self.need_approval()
1229
1884
1230
# NeRwequest - signal
1231
@dbus.service.signal(_interface, signature="s")
1232
def NewRequest(self, ip):
1233
"""D-Bus signal
1234
Is sent after a client request a password.
1235
"""
1236
pass
1237
1238
1885
## Methods
1239
1886
1240
1887
# Approve - method
1248
1895
self.checked_ok()
1249
1896
1250
1897
# Enable - method
1898
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1251
1899
@dbus.service.method(_interface)
1252
1900
def Enable(self):
1253
1901
"D-Bus method"
1254
1902
self.enable()
1255
1903
1256
1904
# StartChecker - method
1905
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1257
1906
@dbus.service.method(_interface)
1258
1907
def StartChecker(self):
1259
1908
"D-Bus method"
1260
1909
self.start_checker()
1261
1910
1262
1911
# Disable - method
1912
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1263
1913
@dbus.service.method(_interface)
1264
1914
def Disable(self):
1265
1915
"D-Bus method"
1266
1916
self.disable()
1267
1917
1268
1918
# StopChecker - method
1919
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1269
1920
@dbus.service.method(_interface)
1270
1921
def StopChecker(self):
1271
1922
self.stop_checker()
1278
1929
return dbus.Boolean(bool(self.approvals_pending))
1279
1930
1280
1931
# ApprovedByDefault - property
1281
@dbus_service_property(_interface, signature="b",
1932
@dbus_service_property(_interface,
1933
signature="b",
1282
1934
access="readwrite")
1283
1935
def ApprovedByDefault_dbus_property(self, value=None):
1284
1936
if value is None: # get
1286
1938
self.approved_by_default = bool(value)
1287
1939
1288
1940
# ApprovalDelay - property
1289
@dbus_service_property(_interface, signature="t",
1941
@dbus_service_property(_interface,
1942
signature="t",
1290
1943
access="readwrite")
1291
1944
def ApprovalDelay_dbus_property(self, value=None):
1292
1945
if value is None: # get
1293
return dbus.UInt64(self.approval_delay_milliseconds())
1946
return dbus.UInt64(self.approval_delay.total_seconds()
1947
* 1000)
1294
1948
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1295
1949
1296
1950
# ApprovalDuration - property
1297
@dbus_service_property(_interface, signature="t",
1951
@dbus_service_property(_interface,
1952
signature="t",
1298
1953
access="readwrite")
1299
1954
def ApprovalDuration_dbus_property(self, value=None):
1300
1955
if value is None: # get
1301
return dbus.UInt64(timedelta_to_milliseconds(
1302
self.approval_duration))
1956
return dbus.UInt64(self.approval_duration.total_seconds()
1957
* 1000)
1303
1958
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1304
1959
1305
1960
# Name - property
1961
@dbus_annotations(
1962
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1306
1963
@dbus_service_property(_interface, signature="s", access="read")
1307
1964
def Name_dbus_property(self):
1308
1965
return dbus.String(self.name)
1309
1966
1310
1967
# Fingerprint - property
1968
@dbus_annotations(
1969
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1311
1970
@dbus_service_property(_interface, signature="s", access="read")
1312
1971
def Fingerprint_dbus_property(self):
1313
1972
return dbus.String(self.fingerprint)
1314
1973
1315
1974
# Host - property
1316
@dbus_service_property(_interface, signature="s",
1975
@dbus_service_property(_interface,
1976
signature="s",
1317
1977
access="readwrite")
1318
1978
def Host_dbus_property(self, value=None):
1319
1979
if value is None: # get
1320
1980
return dbus.String(self.host)
1321
self.host = unicode(value)
1981
self.host = str(value)
1322
1982
1323
1983
# Created - property
1984
@dbus_annotations(
1985
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1324
1986
@dbus_service_property(_interface, signature="s", access="read")
1325
1987
def Created_dbus_property(self):
1326
1988
return datetime_to_dbus(self.created)
1331
1993
return datetime_to_dbus(self.last_enabled)
1332
1994
1333
1995
# Enabled - property
1334
@dbus_service_property(_interface, signature="b",
1996
@dbus_service_property(_interface,
1997
signature="b",
1335
1998
access="readwrite")
1336
1999
def Enabled_dbus_property(self, value=None):
1337
2000
if value is None: # get
1342
2005
self.disable()
1343
2006
1344
2007
# LastCheckedOK - property
1345
@dbus_service_property(_interface, signature="s",
2008
@dbus_service_property(_interface,
2009
signature="s",
1346
2010
access="readwrite")
1347
2011
def LastCheckedOK_dbus_property(self, value=None):
1348
2012
if value is not None:
1350
2014
return
1351
2015
return datetime_to_dbus(self.last_checked_ok)
1352
2016
2017
# LastCheckerStatus - property
2018
@dbus_service_property(_interface, signature="n", access="read")
2019
def LastCheckerStatus_dbus_property(self):
2020
return dbus.Int16(self.last_checker_status)
2021
1353
2022
# Expires - property
1354
2023
@dbus_service_property(_interface, signature="s", access="read")
1355
2024
def Expires_dbus_property(self):
1361
2030
return datetime_to_dbus(self.last_approval_request)
1362
2031
1363
2032
# Timeout - property
1364
@dbus_service_property(_interface, signature="t",
2033
@dbus_service_property(_interface,
2034
signature="t",
1365
2035
access="readwrite")
1366
2036
def Timeout_dbus_property(self, value=None):
1367
2037
if value is None: # get
1368
return dbus.UInt64(self.timeout_milliseconds())
2038
return dbus.UInt64(self.timeout.total_seconds() * 1000)
2039
old_timeout = self.timeout
1369
2040
self.timeout = datetime.timedelta(0, 0, 0, value)
1370
# Reschedule timeout
2041
# Reschedule disabling
1371
2042
if self.enabled:
1372
2043
now = datetime.datetime.utcnow()
1373
time_to_die = timedelta_to_milliseconds(
1374
(self.last_checked_ok + self.timeout) - now)
1375
if time_to_die <= 0:
2044
self.expires += self.timeout - old_timeout
2045
if self.expires <= now:
1376
2046
# The timeout has passed
1377
2047
self.disable()
1378
2048
else:
1379
self.expires = (now +
1380
datetime.timedelta(milliseconds =
1381
time_to_die))
1382
2049
if (getattr(self, "disable_initiator_tag", None)
1383
2050
is None):
1384
2051
return
1385
gobject.source_remove(self.disable_initiator_tag)
1386
self.disable_initiator_tag = (gobject.timeout_add
1387
(time_to_die,
1388
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)
1389
2056
1390
2057
# ExtendedTimeout - property
1391
@dbus_service_property(_interface, signature="t",
2058
@dbus_service_property(_interface,
2059
signature="t",
1392
2060
access="readwrite")
1393
2061
def ExtendedTimeout_dbus_property(self, value=None):
1394
2062
if value is None: # get
1395
return dbus.UInt64(self.extended_timeout_milliseconds())
2063
return dbus.UInt64(self.extended_timeout.total_seconds()
2064
* 1000)
1396
2065
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1397
2066
1398
2067
# Interval - property
1399
@dbus_service_property(_interface, signature="t",
2068
@dbus_service_property(_interface,
2069
signature="t",
1400
2070
access="readwrite")
1401
2071
def Interval_dbus_property(self, value=None):
1402
2072
if value is None: # get
1403
return dbus.UInt64(self.interval_milliseconds())
2073
return dbus.UInt64(self.interval.total_seconds() * 1000)
1404
2074
self.interval = datetime.timedelta(0, 0, 0, value)
1405
2075
if getattr(self, "checker_initiator_tag", None) is None:
1406
2076
return
1407
2077
if self.enabled:
1408
2078
# Reschedule checker run
1409
gobject.source_remove(self.checker_initiator_tag)
1410
self.checker_initiator_tag = (gobject.timeout_add
1411
(value, self.start_checker))
1412
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
1413
2083
1414
2084
# Checker - property
1415
@dbus_service_property(_interface, signature="s",
2085
@dbus_service_property(_interface,
2086
signature="s",
1416
2087
access="readwrite")
1417
2088
def Checker_dbus_property(self, value=None):
1418
2089
if value is None: # get
1419
2090
return dbus.String(self.checker_command)
1420
self.checker_command = unicode(value)
2091
self.checker_command = str(value)
1421
2092
1422
2093
# CheckerRunning - property
1423
@dbus_service_property(_interface, signature="b",
2094
@dbus_service_property(_interface,
2095
signature="b",
1424
2096
access="readwrite")
1425
2097
def CheckerRunning_dbus_property(self, value=None):
1426
2098
if value is None: # get
1431
2103
self.stop_checker()
1432
2104
1433
2105
# ObjectPath - property
2106
@dbus_annotations(
2107
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
2108
"org.freedesktop.DBus.Deprecated": "true"})
1434
2109
@dbus_service_property(_interface, signature="o", access="read")
1435
2110
def ObjectPath_dbus_property(self):
1436
2111
return self.dbus_object_path # is already a dbus.ObjectPath
1437
2112
1438
2113
# Secret = property
1439
@dbus_service_property(_interface, signature="ay",
1440
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)
1441
2121
def Secret_dbus_property(self, value):
1442
self.secret = str(value)
2122
self.secret = bytes(value)
1443
2123
1444
2124
del _interface
1445
2125
1449
2129
self._pipe = child_pipe
1450
2130
self._pipe.send(('init', fpr, address))
1451
2131
if not self._pipe.recv():
1452
raise KeyError()
2132
raise KeyError(fpr)
1453
2133
1454
2134
def __getattribute__(self, name):
1455
2135
if name == '_pipe':
1459
2139
if data[0] == 'data':
1460
2140
return data[1]
1461
2141
if data[0] == 'function':
2142
1462
2143
def func(*args, **kwargs):
1463
2144
self._pipe.send(('funcall', name, args, kwargs))
1464
2145
return self._pipe.recv()[1]
2146
1465
2147
return func
1466
2148
1467
2149
def __setattr__(self, name, value):
1470
2152
self._pipe.send(('setattr', name, value))
1471
2153
1472
2154
1473
class ClientDBusTransitional(ClientDBus):
1474
__metaclass__ = AlternateDBusNamesMetaclass
1475
1476
1477
2155
class ClientHandler(socketserver.BaseRequestHandler, object):
1478
2156
"""A class to handle client connections.
1479
2157
1483
2161
def handle(self):
1484
2162
with contextlib.closing(self.server.child_pipe) as child_pipe:
1485
2163
logger.info("TCP connection from: %s",
1486
unicode(self.client_address))
2164
str(self.client_address))
1487
2165
logger.debug("Pipe FD: %d",
1488
2166
self.server.child_pipe.fileno())
1489
2167
1490
session = (gnutls.connection
1491
.ClientSession(self.request,
1492
gnutls.connection
1493
.X509Credentials()))
1494
1495
# Note: gnutls.connection.X509Credentials is really a
1496
# generic GnuTLS certificate credentials object so long as
1497
# no X.509 keys are added to it. Therefore, we can use it
1498
# here despite using OpenPGP certificates.
2168
session = gnutls.ClientSession(self.request)
1499
2169
1500
2170
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1501
2171
# "+AES-256-CBC", "+SHA1",
1505
2175
priority = self.server.gnutls_priority
1506
2176
if priority is None:
1507
2177
priority = "NORMAL"
1508
(gnutls.library.functions
1509
.gnutls_priority_set_direct(session._c_object,
1510
priority, None))
2178
gnutls.priority_set_direct(session._c_object, priority,
2179
None)
1511
2180
1512
2181
# Start communication using the Mandos protocol
1513
2182
# Get protocol number
1515
2184
logger.debug("Protocol version: %r", line)
1516
2185
try:
1517
2186
if int(line.strip().split()[0]) > 1:
1518
raise RuntimeError
2187
raise RuntimeError(line)
1519
2188
except (ValueError, IndexError, RuntimeError) as error:
1520
2189
logger.error("Unknown protocol version: %s", error)
1521
2190
return
1523
2192
# Start GnuTLS connection
1524
2193
try:
1525
2194
session.handshake()
1526
except gnutls.errors.GNUTLSError as error:
2195
except gnutls.Error as error:
1527
2196
logger.warning("Handshake failed: %s", error)
1528
2197
# Do not run session.bye() here: the session is not
1529
2198
# established. Just abandon the request.
1533
2202
approval_required = False
1534
2203
try:
1535
2204
try:
1536
fpr = self.fingerprint(self.peer_certificate
1537
(session))
1538
except (TypeError,
1539
gnutls.errors.GNUTLSError) as error:
2205
fpr = self.fingerprint(
2206
self.peer_certificate(session))
2207
except (TypeError, gnutls.Error) as error:
1540
2208
logger.warning("Bad certificate: %s", error)
1541
2209
return
1542
2210
logger.debug("Fingerprint: %s", fpr)
1547
2215
except KeyError:
1548
2216
return
1549
2217
1550
if self.server.use_dbus:
1551
# Emit D-Bus signal
1552
client.NewRequest(str(self.client_address))
1553
1554
2218
if client.approval_delay:
1555
2219
delay = client.approval_delay
1556
2220
client.approvals_pending += 1
1559
2223
while True:
1560
2224
if not client.enabled:
1561
2225
logger.info("Client %s is disabled",
1562
client.name)
2226
client.name)
1563
2227
if self.server.use_dbus:
1564
2228
# Emit D-Bus signal
1565
2229
client.Rejected("Disabled")
1574
2238
if self.server.use_dbus:
1575
2239
# Emit D-Bus signal
1576
2240
client.NeedApproval(
1577
client.approval_delay_milliseconds(),
1578
client.approved_by_default)
2241
client.approval_delay.total_seconds()
2242
* 1000, client.approved_by_default)
1579
2243
else:
1580
2244
logger.warning("Client %s was not approved",
1581
2245
client.name)
1587
2251
#wait until timeout or approved
1588
2252
time = datetime.datetime.now()
1589
2253
client.changedstate.acquire()
1590
(client.changedstate.wait
1591
(float(client.timedelta_to_milliseconds(delay)
1592
/ 1000)))
2254
client.changedstate.wait(delay.total_seconds())
1593
2255
client.changedstate.release()
1594
2256
time2 = datetime.datetime.now()
1595
2257
if (time2 - time) >= delay:
1606
2268
else:
1607
2269
delay -= time2 - time
1608
2270
1609
sent_size = 0
1610
while sent_size < len(client.secret):
1611
try:
1612
sent = session.send(client.secret[sent_size:])
1613
except gnutls.errors.GNUTLSError as error:
1614
logger.warning("gnutls send failed")
1615
return
1616
logger.debug("Sent: %d, remaining: %d",
1617
sent, len(client.secret)
1618
- (sent_size + sent))
1619
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
1620
2277
1621
2278
logger.info("Sending secret to %s", client.name)
1622
2279
# bump the timeout using extended_timeout
1623
client.checked_ok(client.extended_timeout)
2280
client.bump_timeout(client.extended_timeout)
1624
2281
if self.server.use_dbus:
1625
2282
# Emit D-Bus signal
1626
2283
client.GotSecret()
1630
2287
client.approvals_pending -= 1
1631
2288
try:
1632
2289
session.bye()
1633
except gnutls.errors.GNUTLSError as error:
1634
logger.warning("GnuTLS bye failed")
2290
except gnutls.Error as error:
2291
logger.warning("GnuTLS bye failed",
2292
exc_info=error)
1635
2293
1636
2294
@staticmethod
1637
2295
def peer_certificate(session):
1638
2296
"Return the peer's OpenPGP certificate as a bytestring"
1639
2297
# If not an OpenPGP certificate...
1640
if (gnutls.library.functions
1641
.gnutls_certificate_type_get(session._c_object)
1642
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1643
# ...do the normal thing
1644
return session.peer_certificate
2298
if (gnutls.certificate_type_get(session._c_object)
2299
!= gnutls.CRT_OPENPGP):
2300
# ...return invalid data
2301
return b""
1645
2302
list_size = ctypes.c_uint(1)
1646
cert_list = (gnutls.library.functions
1647
.gnutls_certificate_get_peers
2303
cert_list = (gnutls.certificate_get_peers
1648
2304
(session._c_object, ctypes.byref(list_size)))
1649
2305
if not bool(cert_list) and list_size.value != 0:
1650
raise gnutls.errors.GNUTLSError("error getting peer"
1651
" certificate")
2306
raise gnutls.Error("error getting peer certificate")
1652
2307
if list_size.value == 0:
1653
2308
return None
1654
2309
cert = cert_list[0]
1658
2313
def fingerprint(openpgp):
1659
2314
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
1660
2315
# New GnuTLS "datum" with the OpenPGP public key
1661
datum = (gnutls.library.types
1662
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1663
ctypes.POINTER
1664
(ctypes.c_ubyte)),
1665
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)))
1666
2320
# New empty GnuTLS certificate
1667
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1668
(gnutls.library.functions
1669
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2321
crt = gnutls.openpgp_crt_t()
2322
gnutls.openpgp_crt_init(ctypes.byref(crt))
1670
2323
# Import the OpenPGP public key into the certificate
1671
(gnutls.library.functions
1672
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1673
gnutls.library.constants
1674
.GNUTLS_OPENPGP_FMT_RAW))
2324
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2325
gnutls.OPENPGP_FMT_RAW)
1675
2326
# Verify the self signature in the key
1676
2327
crtverify = ctypes.c_uint()
1677
(gnutls.library.functions
1678
.gnutls_openpgp_crt_verify_self(crt, 0,
1679
ctypes.byref(crtverify)))
2328
gnutls.openpgp_crt_verify_self(crt, 0,
2329
ctypes.byref(crtverify))
1680
2330
if crtverify.value != 0:
1681
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1682
raise (gnutls.errors.CertificateSecurityError
1683
("Verify failed"))
2331
gnutls.openpgp_crt_deinit(crt)
2332
raise gnutls.CertificateSecurityError("Verify failed")
1684
2333
# New buffer for the fingerprint
1685
2334
buf = ctypes.create_string_buffer(20)
1686
2335
buf_len = ctypes.c_size_t()
1687
2336
# Get the fingerprint from the certificate into the buffer
1688
(gnutls.library.functions
1689
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1690
ctypes.byref(buf_len)))
2337
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2338
ctypes.byref(buf_len))
1691
2339
# Deinit the certificate
1692
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2340
gnutls.openpgp_crt_deinit(crt)
1693
2341
# Convert the buffer to a Python bytestring
1694
2342
fpr = ctypes.string_at(buf, buf_len.value)
1695
2343
# Convert the bytestring to hexadecimal notation
1699
2347
1700
2348
class MultiprocessingMixIn(object):
1701
2349
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2350
1702
2351
def sub_process_main(self, request, address):
1703
2352
try:
1704
2353
self.finish_request(request, address)
1709
2358
def process_request(self, request, address):
1710
2359
"""Start a new process to process the request."""
1711
2360
proc = multiprocessing.Process(target = self.sub_process_main,
1712
args = (request,
1713
address))
2361
args = (request, address))
1714
2362
proc.start()
1715
2363
return proc
1716
2364
1717
2365
1718
2366
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1719
2367
""" adds a pipe to the MixIn """
2368
1720
2369
def process_request(self, request, client_address):
1721
2370
"""Overrides and wraps the original process_request().
1722
2371
1731
2380
1732
2381
def add_pipe(self, parent_pipe, proc):
1733
2382
"""Dummy function; override as necessary"""
1734
raise NotImplementedError
2383
raise NotImplementedError()
1735
2384
1736
2385
1737
2386
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1743
2392
interface: None or a network interface name (string)
1744
2393
use_ipv6: Boolean; to use IPv6 or not
1745
2394
"""
2395
1746
2396
def __init__(self, server_address, RequestHandlerClass,
1747
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
"""
1748
2403
self.interface = interface
1749
2404
if use_ipv6:
1750
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.
1751
2432
socketserver.TCPServer.__init__(self, server_address,
1752
2433
RequestHandlerClass)
2434
1753
2435
def server_bind(self):
1754
2436
"""This overrides the normal server_bind() function
1755
2437
to bind to an interface if one was specified, and also NOT to
1761
2443
self.interface)
1762
2444
else:
1763
2445
try:
1764
self.socket.setsockopt(socket.SOL_SOCKET,
1765
SO_BINDTODEVICE,
1766
str(self.interface
1767
+ '\0'))
2446
self.socket.setsockopt(
2447
socket.SOL_SOCKET, SO_BINDTODEVICE,
2448
(self.interface + "\0").encode("utf-8"))
1768
2449
except socket.error as error:
1769
if error[0] == errno.EPERM:
1770
logger.error("No permission to"
1771
" bind to interface %s",
1772
self.interface)
1773
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:
1774
2454
logger.error("SO_BINDTODEVICE not available;"
1775
2455
" cannot bind to interface %s",
1776
2456
self.interface)
2457
elif error.errno == errno.ENODEV:
2458
logger.error("Interface %s does not exist,"
2459
" cannot bind", self.interface)
1777
2460
else:
1778
2461
raise
1779
2462
# Only bind(2) the socket if we really need to.
1782
2465
if self.address_family == socket.AF_INET6:
1783
2466
any_address = "::" # in6addr_any
1784
2467
else:
1785
any_address = socket.INADDR_ANY
2468
any_address = "0.0.0.0" # INADDR_ANY
1786
2469
self.server_address = (any_address,
1787
2470
self.server_address[1])
1788
2471
elif not self.server_address[1]:
1789
self.server_address = (self.server_address[0],
1790
0)
2472
self.server_address = (self.server_address[0], 0)
1791
2473
# if self.interface:
1792
2474
# self.server_address = (self.server_address[0],
1793
2475
# 0, # port
1805
2487
gnutls_priority GnuTLS priority string
1806
2488
use_dbus: Boolean; to emit D-Bus signals or not
1807
2489
1808
Assumes a gobject.MainLoop event loop.
2490
Assumes a GObject.MainLoop event loop.
1809
2491
"""
2492
1810
2493
def __init__(self, server_address, RequestHandlerClass,
1811
interface=None, use_ipv6=True, clients=None,
1812
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):
1813
2500
self.enabled = False
1814
2501
self.clients = clients
1815
2502
if self.clients is None:
1819
2506
IPv6_TCPServer.__init__(self, server_address,
1820
2507
RequestHandlerClass,
1821
2508
interface = interface,
1822
use_ipv6 = use_ipv6)
2509
use_ipv6 = use_ipv6,
2510
socketfd = socketfd)
2511
1823
2512
def server_activate(self):
1824
2513
if self.enabled:
1825
2514
return socketserver.TCPServer.server_activate(self)
1829
2518
1830
2519
def add_pipe(self, parent_pipe, proc):
1831
2520
# Call "handle_ipc" for both data and EOF events
1832
gobject.io_add_watch(parent_pipe.fileno(),
1833
gobject.IO_IN | gobject.IO_HUP,
1834
functools.partial(self.handle_ipc,
1835
parent_pipe =
1836
parent_pipe,
1837
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))
1838
2527
1839
def handle_ipc(self, source, condition, parent_pipe=None,
1840
proc = None, client_object=None):
1841
condition_names = {
1842
gobject.IO_IN: "IN", # There is data to read.
1843
gobject.IO_OUT: "OUT", # Data can be written (without
1844
# blocking).
1845
gobject.IO_PRI: "PRI", # There is urgent data to read.
1846
gobject.IO_ERR: "ERR", # Error condition.
1847
gobject.IO_HUP: "HUP" # Hung up (the connection has been
1848
# broken, usually for pipes and
1849
# sockets).
1850
}
1851
conditions_string = ' | '.join(name
1852
for cond, name in
1853
condition_names.iteritems()
1854
if cond & condition)
2528
def handle_ipc(self, source, condition,
2529
parent_pipe=None,
2530
proc = None,
2531
client_object=None):
1855
2532
# error, or the other end of multiprocessing.Pipe has closed
1856
if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
2533
if condition & (GObject.IO_ERR | GObject.IO_HUP):
1857
2534
# Wait for other process to exit
1858
2535
proc.join()
1859
2536
return False
1866
2543
fpr = request[1]
1867
2544
address = request[2]
1868
2545
1869
for c in self.clients.itervalues():
2546
for c in self.clients.values():
1870
2547
if c.fingerprint == fpr:
1871
2548
client = c
1872
2549
break
1880
2557
parent_pipe.send(False)
1881
2558
return False
1882
2559
1883
gobject.io_add_watch(parent_pipe.fileno(),
1884
gobject.IO_IN | gobject.IO_HUP,
1885
functools.partial(self.handle_ipc,
1886
parent_pipe =
1887
parent_pipe,
1888
proc = proc,
1889
client_object =
1890
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))
1891
2567
parent_pipe.send(True)
1892
2568
# remove the old hook in favor of the new above hook on
1893
2569
# same fileno
1899
2575
1900
2576
parent_pipe.send(('data', getattr(client_object,
1901
2577
funcname)(*args,
1902
**kwargs)))
2578
**kwargs)))
1903
2579
1904
2580
if command == 'getattr':
1905
2581
attrname = request[1]
1906
if callable(client_object.__getattribute__(attrname)):
1907
parent_pipe.send(('function',))
2582
if isinstance(client_object.__getattribute__(attrname),
2583
collections.Callable):
2584
parent_pipe.send(('function', ))
1908
2585
else:
1909
parent_pipe.send(('data', client_object
1910
.__getattribute__(attrname)))
2586
parent_pipe.send((
2587
'data', client_object.__getattribute__(attrname)))
1911
2588
1912
2589
if command == 'setattr':
1913
2590
attrname = request[1]
1917
2594
return True
1918
2595
1919
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
1920
2693
def string_to_delta(interval):
1921
2694
"""Parse a string and return a datetime.timedelta
1922
2695
1933
2706
>>> string_to_delta('5m 30s')
1934
2707
datetime.timedelta(0, 330)
1935
2708
"""
2709
2710
try:
2711
return rfc3339_duration_to_delta(interval)
2712
except ValueError:
2713
pass
2714
1936
2715
timevalue = datetime.timedelta(0)
1937
2716
for s in interval.split():
1938
2717
try:
1939
suffix = unicode(s[-1])
2718
suffix = s[-1]
1940
2719
value = int(s[:-1])
1941
2720
if suffix == "d":
1942
2721
delta = datetime.timedelta(value)
1949
2728
elif suffix == "w":
1950
2729
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
1951
2730
else:
1952
raise ValueError("Unknown suffix %r" % suffix)
1953
except (ValueError, IndexError) as e:
2731
raise ValueError("Unknown suffix {!r}".format(suffix))
2732
except IndexError as e:
1954
2733
raise ValueError(*(e.args))
1955
2734
timevalue += delta
1956
2735
return timevalue
1969
2748
sys.exit()
1970
2749
if not noclose:
1971
2750
# Close all standard open file descriptors
1972
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2751
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1973
2752
if not stat.S_ISCHR(os.fstat(null).st_mode):
1974
2753
raise OSError(errno.ENODEV,
1975
"%s not a character device"
1976
% os.path.devnull)
2754
"{} not a character device"
2755
.format(os.devnull))
1977
2756
os.dup2(null, sys.stdin.fileno())
1978
2757
os.dup2(null, sys.stdout.fileno())
1979
2758
os.dup2(null, sys.stderr.fileno())
1988
2767
1989
2768
parser = argparse.ArgumentParser()
1990
2769
parser.add_argument("-v", "--version", action="version",
1991
version = "%%(prog)s %s" % version,
2770
version = "%(prog)s {}".format(version),
1992
2771
help="show version number and exit")
1993
2772
parser.add_argument("-i", "--interface", metavar="IF",
1994
2773
help="Bind to interface IF")
2000
2779
help="Run self-test")
2001
2780
parser.add_argument("--debug", action="store_true",
2002
2781
help="Debug mode; run in foreground and log"
2003
" to terminal")
2782
" to terminal", default=None)
2004
2783
parser.add_argument("--debuglevel", metavar="LEVEL",
2005
2784
help="Debug level for stdout output")
2006
2785
parser.add_argument("--priority", help="GnuTLS"
2013
2792
" files")
2014
2793
parser.add_argument("--no-dbus", action="store_false",
2015
2794
dest="use_dbus", help="Do not provide D-Bus"
2016
" system bus interface")
2795
" system bus interface", default=None)
2017
2796
parser.add_argument("--no-ipv6", action="store_false",
2018
dest="use_ipv6", help="Do not use IPv6")
2797
dest="use_ipv6", help="Do not use IPv6",
2798
default=None)
2019
2799
parser.add_argument("--no-restore", action="store_false",
2020
2800
dest="restore", help="Do not restore stored"
2021
" 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")
2022
2805
parser.add_argument("--statedir", metavar="DIR",
2023
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)
2024
2812
2025
2813
options = parser.parse_args()
2026
2814
2027
2815
if options.check:
2028
2816
import doctest
2029
doctest.testmod()
2030
sys.exit()
2817
fail_count, test_count = doctest.testmod()
2818
sys.exit(os.EX_OK if fail_count == 0 else 1)
2031
2819
2032
2820
# Default values for config file for server-global settings
2033
2821
server_defaults = { "interface": "",
2035
2823
"port": "",
2036
2824
"debug": "False",
2037
2825
"priority":
2038
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
2826
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2827
":+SIGN-DSA-SHA256",
2039
2828
"servicename": "Mandos",
2040
2829
"use_dbus": "True",
2041
2830
"use_ipv6": "True",
2042
2831
"debuglevel": "",
2043
2832
"restore": "True",
2044
"statedir": "/var/lib/mandos"
2045
}
2833
"socket": "",
2834
"statedir": "/var/lib/mandos",
2835
"foreground": "False",
2836
"zeroconf": "True",
2837
}
2046
2838
2047
2839
# Parse config file for server-global settings
2048
2840
server_config = configparser.SafeConfigParser(server_defaults)
2049
2841
del server_defaults
2050
server_config.read(os.path.join(options.configdir,
2051
"mandos.conf"))
2842
server_config.read(os.path.join(options.configdir, "mandos.conf"))
2052
2843
# Convert the SafeConfigParser object to a dict
2053
2844
server_settings = server_config.defaults()
2054
2845
# Use the appropriate methods on the non-string config options
2055
for option in ("debug", "use_dbus", "use_ipv6"):
2846
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2056
2847
server_settings[option] = server_config.getboolean("DEFAULT",
2057
2848
option)
2058
2849
if server_settings["port"]:
2059
2850
server_settings["port"] = server_config.getint("DEFAULT",
2060
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"])
2061
2861
del server_config
2062
2862
2063
2863
# Override the settings from the config file with command line
2064
2864
# options, if set.
2065
2865
for option in ("interface", "address", "port", "debug",
2066
"priority", "servicename", "configdir",
2067
"use_dbus", "use_ipv6", "debuglevel", "restore",
2068
"statedir"):
2866
"priority", "servicename", "configdir", "use_dbus",
2867
"use_ipv6", "debuglevel", "restore", "statedir",
2868
"socket", "foreground", "zeroconf"):
2069
2869
value = getattr(options, option)
2070
2870
if value is not None:
2071
2871
server_settings[option] = value
2072
2872
del options
2073
2873
# Force all strings to be unicode
2074
2874
for option in server_settings.keys():
2075
if type(server_settings[option]) is str:
2076
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
2077
2885
# Now we have our good server settings in "server_settings"
2078
2886
2079
2887
##################################################################
2080
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
2081
2894
# For convenience
2082
2895
debug = server_settings["debug"]
2083
2896
debuglevel = server_settings["debuglevel"]
2085
2898
use_ipv6 = server_settings["use_ipv6"]
2086
2899
stored_state_path = os.path.join(server_settings["statedir"],
2087
2900
stored_state_file)
2901
foreground = server_settings["foreground"]
2902
zeroconf = server_settings["zeroconf"]
2088
2903
2089
2904
if debug:
2090
2905
initlogger(debug, logging.DEBUG)
2096
2911
initlogger(debug, level)
2097
2912
2098
2913
if server_settings["servicename"] != "Mandos":
2099
syslogger.setFormatter(logging.Formatter
2100
('Mandos (%s) [%%(process)d]:'
2101
' %%(levelname)s: %%(message)s'
2102
% server_settings["servicename"]))
2914
syslogger.setFormatter(
2915
logging.Formatter('Mandos ({}) [%(process)d]:'
2916
' %(levelname)s: %(message)s'.format(
2917
server_settings["servicename"])))
2103
2918
2104
2919
# Parse config file with clients
2105
2920
client_config = configparser.SafeConfigParser(Client
2110
2925
global mandos_dbus_service
2111
2926
mandos_dbus_service = None
2112
2927
2113
tcp_server = MandosServer((server_settings["address"],
2114
server_settings["port"]),
2115
ClientHandler,
2116
interface=(server_settings["interface"]
2117
or None),
2118
use_ipv6=use_ipv6,
2119
gnutls_priority=
2120
server_settings["priority"],
2121
use_dbus=use_dbus)
2122
if not debug:
2123
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
2124
2944
try:
2125
pidfile = open(pidfilename, "w")
2126
except IOError:
2127
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)
2128
2949
2129
try:
2130
uid = pwd.getpwnam("_mandos").pw_uid
2131
gid = pwd.getpwnam("_mandos").pw_gid
2132
except KeyError:
2950
for name, group in (("_mandos", "_mandos"),
2951
("mandos", "mandos"),
2952
("nobody", "nogroup")):
2133
2953
try:
2134
uid = pwd.getpwnam("mandos").pw_uid
2135
gid = pwd.getpwnam("mandos").pw_gid
2954
uid = pwd.getpwnam(name).pw_uid
2955
gid = pwd.getpwnam(group).pw_gid
2956
break
2136
2957
except KeyError:
2137
try:
2138
uid = pwd.getpwnam("nobody").pw_uid
2139
gid = pwd.getpwnam("nobody").pw_gid
2140
except KeyError:
2141
uid = 65534
2142
gid = 65534
2958
continue
2959
else:
2960
uid = 65534
2961
gid = 65534
2143
2962
try:
2144
2963
os.setgid(gid)
2145
2964
os.setuid(uid)
2965
if debug:
2966
logger.debug("Did setuid/setgid to {}:{}".format(uid,
2967
gid))
2146
2968
except OSError as error:
2147
if error[0] != errno.EPERM:
2148
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
2149
2973
2150
2974
if debug:
2151
2975
# Enable all possible GnuTLS debugging
2152
2976
2153
2977
# "Use a log level over 10 to enable all debugging options."
2154
2978
# - GnuTLS manual
2155
gnutls.library.functions.gnutls_global_set_log_level(11)
2979
gnutls.global_set_log_level(11)
2156
2980
2157
@gnutls.library.types.gnutls_log_func
2981
@gnutls.log_func
2158
2982
def debug_gnutls(level, string):
2159
2983
logger.debug("GnuTLS: %s", string[:-1])
2160
2984
2161
(gnutls.library.functions
2162
.gnutls_global_set_log_function(debug_gnutls))
2985
gnutls.global_set_log_function(debug_gnutls)
2163
2986
2164
2987
# Redirect stdin so all checkers get /dev/null
2165
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2988
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2166
2989
os.dup2(null, sys.stdin.fileno())
2167
2990
if null > 2:
2168
2991
os.close(null)
2169
2992
2170
2993
# Need to fork before connecting to D-Bus
2171
if not debug:
2994
if not foreground:
2172
2995
# Close all input and output, do double fork, etc.
2173
2996
daemon()
2174
2997
2175
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()
2176
3001
2177
3002
global main_loop
2178
3003
# From the Avahi example code
2179
DBusGMainLoop(set_as_default=True )
2180
main_loop = gobject.MainLoop()
3004
DBusGMainLoop(set_as_default=True)
3005
main_loop = GObject.MainLoop()
2181
3006
bus = dbus.SystemBus()
2182
3007
# End of Avahi example code
2183
3008
if use_dbus:
2184
3009
try:
2185
3010
bus_name = dbus.service.BusName("se.recompile.Mandos",
2186
bus, do_not_queue=True)
2187
old_bus_name = (dbus.service.BusName
2188
("se.bsnet.fukt.Mandos", bus,
2189
do_not_queue=True))
2190
except dbus.exceptions.NameExistsException as e:
2191
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)
2192
3018
use_dbus = False
2193
3019
server_settings["use_dbus"] = False
2194
3020
tcp_server.use_dbus = False
2195
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2196
service = AvahiServiceToSyslog(name =
2197
server_settings["servicename"],
2198
servicetype = "_mandos._tcp",
2199
protocol = protocol, bus = bus)
2200
if server_settings["interface"]:
2201
service.interface = (if_nametoindex
2202
(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"))
2203
3031
2204
3032
global multiprocessing_manager
2205
3033
multiprocessing_manager = multiprocessing.Manager()
2206
3034
2207
3035
client_class = Client
2208
3036
if use_dbus:
2209
client_class = functools.partial(ClientDBusTransitional,
2210
bus = bus)
3037
client_class = functools.partial(ClientDBus, bus = bus)
2211
3038
2212
3039
client_settings = Client.config_parser(client_config)
2213
3040
old_client_settings = {}
2214
3041
clients_data = {}
2215
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
2216
3051
# Get client data and settings from last running state.
2217
3052
if server_settings["restore"]:
2218
3053
try:
2219
3054
with open(stored_state_path, "rb") as stored_state:
2220
clients_data, old_client_settings = (pickle.load
2221
(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"))
2222
3100
os.remove(stored_state_path)
2223
3101
except IOError as e:
2224
logger.warning("Could not load persistent state: {0}"
2225
.format(e))
2226
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)
2227
3108
raise
2228
3109
except EOFError as e:
2229
3110
logger.warning("Could not load persistent state: "
2230
"EOFError: {0}".format(e))
3111
"EOFError:",
3112
exc_info=e)
2231
3113
2232
3114
with PGPEngine() as pgp:
2233
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
2234
3120
# Decide which value to use after restoring saved state.
2235
3121
# We have three different values: Old config file,
2236
3122
# new config file, and saved state.
2241
3127
# For each value in new config, check if it
2242
3128
# differs from the old config value (Except for
2243
3129
# the "secret" attribute)
2244
if (name != "secret" and
2245
value != old_client_settings[client_name]
2246
[name]):
3130
if (name != "secret"
3131
and (value !=
3132
old_client_settings[client_name][name])):
2247
3133
client[name] = value
2248
3134
except KeyError:
2249
3135
pass
2250
3136
2251
3137
# Clients who has passed its expire date can still be
2252
# enabled if its last checker was successful. Clients
2253
# whose checker failed before we stored its state is
2254
# assumed to have failed all checkers during downtime.
3138
# enabled if its last checker was successful. A Client
3139
# whose checker succeeded before we stored its state is
3140
# assumed to have successfully run all checkers during
3141
# downtime.
2255
3142
if client["enabled"]:
2256
3143
if datetime.datetime.utcnow() >= client["expires"]:
2257
3144
if not client["last_checked_ok"]:
2258
3145
logger.warning(
2259
"disabling client {0} - Client never "
2260
"performed a successfull checker"
2261
.format(client["name"]))
3146
"disabling client {} - Client never "
3147
"performed a successful checker".format(
3148
client_name))
2262
3149
client["enabled"] = False
2263
3150
elif client["last_checker_status"] != 0:
2264
3151
logger.warning(
2265
"disabling client {0} - Client "
2266
"last checker failed with error code {1}"
2267
.format(client["name"],
2268
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"]))
2269
3157
client["enabled"] = False
2270
3158
else:
2271
client["expires"] = (datetime.datetime
2272
.utcnow()
2273
+ client["timeout"])
3159
client["expires"] = (
3160
datetime.datetime.utcnow()
3161
+ client["timeout"])
2274
3162
logger.debug("Last checker succeeded,"
2275
" keeping {0} enabled"
2276
.format(client["name"]))
3163
" keeping {} enabled".format(
3164
client_name))
2277
3165
try:
2278
client["secret"] = (
2279
pgp.decrypt(client["encrypted_secret"],
2280
client_settings[client_name]
2281
["secret"]))
3166
client["secret"] = pgp.decrypt(
3167
client["encrypted_secret"],
3168
client_settings[client_name]["secret"])
2282
3169
except PGPError:
2283
3170
# If decryption fails, we use secret from new settings
2284
logger.debug("Failed to decrypt {0} old secret"
2285
.format(client_name))
2286
client["secret"] = (
2287
client_settings[client_name]["secret"])
2288
3171
logger.debug("Failed to decrypt {} old secret".format(
3172
client_name))
3173
client["secret"] = (client_settings[client_name]
3174
["secret"])
2289
3175
2290
3176
# Add/remove clients based on new changes made to config
2291
3177
for client_name in (set(old_client_settings)
2294
3180
for client_name in (set(client_settings)
2295
3181
- set(old_client_settings)):
2296
3182
clients_data[client_name] = client_settings[client_name]
2297
2298
# Create clients all clients
2299
for client_name, client in clients_data.iteritems():
3183
3184
# Create all client objects
3185
for client_name, client in clients_data.items():
2300
3186
tcp_server.clients[client_name] = client_class(
2301
name = client_name, settings = client)
3187
name = client_name,
3188
settings = client,
3189
server_settings = server_settings)
2302
3190
2303
3191
if not tcp_server.clients:
2304
3192
logger.warning("No clients defined")
2305
2306
if not debug:
2307
try:
2308
with pidfile:
2309
pid = os.getpid()
2310
pidfile.write(str(pid) + "\n".encode("utf-8"))
2311
del pidfile
2312
except IOError:
2313
logger.error("Could not write to file %r with PID %d",
2314
pidfilename, pid)
2315
except NameError:
2316
# "pidfile" was never created
2317
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
2318
3204
del pidfilename
2319
signal.signal(signal.SIGINT, signal.SIG_IGN)
2320
3205
2321
3206
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2322
3207
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2323
3208
2324
3209
if use_dbus:
2325
class MandosDBusService(dbus.service.Object):
3210
3211
@alternate_dbus_interfaces(
3212
{ "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
3213
class MandosDBusService(DBusObjectWithObjectManager):
2326
3214
"""A D-Bus proxy object"""
3215
2327
3216
def __init__(self):
2328
3217
dbus.service.Object.__init__(self, bus, "/")
3218
2329
3219
_interface = "se.recompile.Mandos"
2330
3220
2331
3221
@dbus.service.signal(_interface, signature="o")
2338
3228
"D-Bus signal"
2339
3229
pass
2340
3230
3231
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3232
"true"})
2341
3233
@dbus.service.signal(_interface, signature="os")
2342
3234
def ClientRemoved(self, objpath, name):
2343
3235
"D-Bus signal"
2344
3236
pass
2345
3237
3238
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3239
"true"})
2346
3240
@dbus.service.method(_interface, out_signature="ao")
2347
3241
def GetAllClients(self):
2348
3242
"D-Bus method"
2349
return dbus.Array(c.dbus_object_path
2350
for c in
2351
tcp_server.clients.itervalues())
3243
return dbus.Array(c.dbus_object_path for c in
3244
tcp_server.clients.values())
2352
3245
3246
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3247
"true"})
2353
3248
@dbus.service.method(_interface,
2354
3249
out_signature="a{oa{sv}}")
2355
3250
def GetAllClientsWithProperties(self):
2356
3251
"D-Bus method"
2357
3252
return dbus.Dictionary(
2358
((c.dbus_object_path, c.GetAll(""))
2359
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() },
2360
3256
signature="oa{sv}")
2361
3257
2362
3258
@dbus.service.method(_interface, in_signature="o")
2363
3259
def RemoveClient(self, object_path):
2364
3260
"D-Bus method"
2365
for c in tcp_server.clients.itervalues():
3261
for c in tcp_server.clients.values():
2366
3262
if c.dbus_object_path == object_path:
2367
3263
del tcp_server.clients[c.name]
2368
3264
c.remove_from_connection()
2369
# Don't signal anything except ClientRemoved
3265
# Don't signal the disabling
2370
3266
c.disable(quiet=True)
2371
# Emit D-Bus signal
2372
self.ClientRemoved(object_path, c.name)
3267
# Emit D-Bus signal for removal
3268
self.client_removed_signal(c)
2373
3269
return
2374
3270
raise KeyError(object_path)
2375
3271
2376
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)
2377
3309
2378
class MandosDBusServiceTransitional(MandosDBusService):
2379
__metaclass__ = AlternateDBusNamesMetaclass
2380
mandos_dbus_service = MandosDBusServiceTransitional()
3310
mandos_dbus_service = MandosDBusService()
2381
3311
2382
3312
def cleanup():
2383
3313
"Cleanup function; run on exit"
2384
service.cleanup()
3314
if zeroconf:
3315
service.cleanup()
2385
3316
2386
3317
multiprocessing.active_children()
3318
wnull.close()
2387
3319
if not (tcp_server.clients or client_settings):
2388
3320
return
2389
3321
2392
3324
# removed/edited, old secret will thus be unrecovable.
2393
3325
clients = {}
2394
3326
with PGPEngine() as pgp:
2395
for client in tcp_server.clients.itervalues():
3327
for client in tcp_server.clients.values():
2396
3328
key = client_settings[client.name]["secret"]
2397
3329
client.encrypted_secret = pgp.encrypt(client.secret,
2398
3330
key)
2400
3332
2401
3333
# A list of attributes that can not be pickled
2402
3334
# + secret.
2403
exclude = set(("bus", "changedstate", "secret",
2404
"checker"))
2405
for name, typ in (inspect.getmembers
2406
(dbus.service.Object)):
3335
exclude = { "bus", "changedstate", "secret",
3336
"checker", "server_settings" }
3337
for name, typ in inspect.getmembers(dbus.service
3338
.Object):
2407
3339
exclude.add(name)
2408
3340
2409
3341
client_dict["encrypted_secret"] = (client
2416
3348
del client_settings[client.name]["secret"]
2417
3349
2418
3350
try:
2419
tempfd, tempname = tempfile.mkstemp(suffix=".pickle",
2420
prefix="clients-",
2421
dir=os.path.dirname
2422
(stored_state_path))
2423
with os.fdopen(tempfd, "wb") as stored_state:
2424
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
2425
3360
os.rename(tempname, stored_state_path)
2426
3361
except (IOError, OSError) as e:
2427
logger.warning("Could not save persistent state: {0}"
2428
.format(e))
2429
3362
if not debug:
2430
3363
try:
2431
3364
os.remove(tempname)
2432
3365
except NameError:
2433
3366
pass
2434
if e.errno not in set((errno.ENOENT, errno.EACCES,
2435
errno.EEXIST)):
2436
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
2437
3374
2438
3375
# Delete all clients, and settings from config
2439
3376
while tcp_server.clients:
2440
3377
name, client = tcp_server.clients.popitem()
2441
3378
if use_dbus:
2442
3379
client.remove_from_connection()
2443
# Don't signal anything except ClientRemoved
3380
# Don't signal the disabling
2444
3381
client.disable(quiet=True)
3382
# Emit D-Bus signal for removal
2445
3383
if use_dbus:
2446
# Emit D-Bus signal
2447
mandos_dbus_service.ClientRemoved(client
2448
.dbus_object_path,
2449
client.name)
3384
mandos_dbus_service.client_removed_signal(client)
2450
3385
client_settings.clear()
2451
3386
2452
3387
atexit.register(cleanup)
2453
3388
2454
for client in tcp_server.clients.itervalues():
3389
for client in tcp_server.clients.values():
2455
3390
if use_dbus:
2456
# Emit D-Bus signal
2457
mandos_dbus_service.ClientAdded(client.dbus_object_path)
3391
# Emit D-Bus signal for adding
3392
mandos_dbus_service.client_added_signal(client)
2458
3393
# Need to initiate checking of clients
2459
3394
if client.enabled:
2460
3395
client.init_checker()
2463
3398
tcp_server.server_activate()
2464
3399
2465
3400
# Find out what port we got
2466
service.port = tcp_server.socket.getsockname()[1]
3401
if zeroconf:
3402
service.port = tcp_server.socket.getsockname()[1]
2467
3403
if use_ipv6:
2468
3404
logger.info("Now listening on address %r, port %d,"
2469
" flowinfo %d, scope_id %d"
2470
% tcp_server.socket.getsockname())
3405
" flowinfo %d, scope_id %d",
3406
*tcp_server.socket.getsockname())
2471
3407
else: # IPv4
2472
logger.info("Now listening on address %r, port %d"
2473
% tcp_server.socket.getsockname())
3408
logger.info("Now listening on address %r, port %d",
3409
*tcp_server.socket.getsockname())
2474
3410
2475
3411
#service.interface = tcp_server.socket.getsockname()[3]
2476
3412
2477
3413
try:
2478
# From the Avahi example code
2479
try:
2480
service.activate()
2481
except dbus.exceptions.DBusException as error:
2482
logger.critical("DBusException: %s", error)
2483
cleanup()
2484
sys.exit(1)
2485
# 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
2486
3423
2487
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
3424
GObject.io_add_watch(tcp_server.fileno(), GObject.IO_IN,
2488
3425
lambda *args, **kwargs:
2489
3426
(tcp_server.handle_request
2490
3427
(*args[2:], **kwargs) or True))
2492
3429
logger.debug("Starting main loop")
2493
3430
main_loop.run()
2494
3431
except AvahiError as error:
2495
logger.critical("AvahiError: %s", error)
3432
logger.critical("Avahi Error", exc_info=error)
2496
3433
cleanup()
2497
3434
sys.exit(1)
2498
3435
except KeyboardInterrupt:
2503
3440
# Must run before the D-Bus bus name gets deregistered
2504
3441
cleanup()
2505
3442
3443
2506
3444
if __name__ == '__main__':
2507
3445
main()
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0