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