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