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