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