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