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