To get this branch, use:
bzr branch
http://bzr.recompile.se/loggerhead/mandos/release
« back to all changes in this revision
Viewing changes to mandos
- browse files at revision 237.7.392
- compare with another revision
- download diff
- download tarball
- view history from revision 237.7.392
- Committer: Teddy Hogeborn
- Date: 2016-03-23 07:11:22 UTC
- mto: (237.7.594 trunk)
- mto: This revision was merged to the branch mainline in revision 343.
- Revision ID: teddy@recompile.se-20160323071122-55srtjdizr21rr7f
Use HTTPS in home page links
Since we have a real certificate now, change all links to the home
page to use HTTPS.
* README: Use HTTPS in home page links
* debian/control (Source: mandos/Homepage): - '' -
* debian/copyright (Source): - '' -
* intro.xml (SEE ALSO): - '' -
* mandos.lsm (Primary-site): - '' -
Since we have a real certificate now, change all links to the home
page to use HTTPS.
* README: Use HTTPS in home page links
* debian/control (Source: mandos/Homepage): - '' -
* debian/copyright (Source): - '' -
* intro.xml (SEE ALSO): - '' -
* mandos.lsm (Primary-site): - '' -
- files added:
- bugs.xml
- debian/upstream
- network-hooks.d
- plugin-helpers
- files modified:
- .bzrignore
added
removed
mandos
11
11
# "AvahiService" class, and some lines in "main".
12
12
#
13
13
# Everything else is
14
# Copyright © 2008-2010 Teddy Hogeborn
15
# Copyright © 2008-2010 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.2.3"
85
86
#logger = logging.getLogger(u'mandos')
87
logger = logging.Logger(u'mandos')
88
syslogger = (logging.handlers.SysLogHandler
89
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
90
address = "/dev/log"))
91
syslogger.setFormatter(logging.Formatter
92
(u'Mandos [%(process)d]: %(levelname)s:'
93
u' %(message)s'))
94
logger.addHandler(syslogger)
95
96
console = logging.StreamHandler()
97
console.setFormatter(logging.Formatter(u'%(name)s [%(process)d]:'
98
u' %(levelname)s:'
99
u' %(message)s'))
100
logger.addHandler(console)
97
if sys.version_info.major == 2:
98
str = unicode
99
100
version = "1.7.7"
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()
101
280
102
281
class AvahiError(Exception):
103
282
def __init__(self, value, *args, **kwargs):
104
283
self.value = value
105
super(AvahiError, self).__init__(value, *args, **kwargs)
106
def __unicode__(self):
107
return unicode(repr(self.value))
284
return super(AvahiError, self).__init__(value, *args,
285
**kwargs)
286
108
287
109
288
class AvahiServiceError(AvahiError):
110
289
pass
111
290
291
112
292
class AvahiGroupError(AvahiError):
113
293
pass
114
294
119
299
Attributes:
120
300
interface: integer; avahi.IF_UNSPEC or an interface index.
121
301
Used to optionally bind to the specified interface.
122
name: string; Example: u'Mandos'
123
type: string; Example: u'_mandos._tcp'.
124
See <http://www.dns-sd.org/ServiceTypes.html>
302
name: string; Example: 'Mandos'
303
type: string; Example: '_mandos._tcp'.
304
See <https://www.iana.org/assignments/service-names-port-numbers>
125
305
port: integer; what port to announce
126
306
TXT: list of strings; TXT record for the service
127
307
domain: string; Domain to publish on, default to .local if empty.
133
313
server: D-Bus Server
134
314
bus: dbus.SystemBus()
135
315
"""
136
def __init__(self, interface = avahi.IF_UNSPEC, name = None,
137
servicetype = None, port = None, TXT = None,
138
domain = u"", host = u"", max_renames = 32768,
139
protocol = avahi.PROTO_UNSPEC, bus = None):
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):
140
328
self.interface = interface
141
329
self.name = name
142
330
self.type = servicetype
150
338
self.group = None # our entry group
151
339
self.server = None
152
340
self.bus = bus
153
def rename(self):
341
self.entry_group_state_changed_match = None
342
343
def rename(self, remove=True):
154
344
"""Derived from the Avahi example code"""
155
345
if self.rename_count >= self.max_renames:
156
logger.critical(u"No suitable Zeroconf service name found"
157
u" after %i retries, exiting.",
346
logger.critical("No suitable Zeroconf service name found"
347
" after %i retries, exiting.",
158
348
self.rename_count)
159
raise AvahiServiceError(u"Too many renames")
160
self.name = unicode(self.server.GetAlternativeServiceName(self.name))
161
logger.info(u"Changing Zeroconf service name to %r ...",
349
raise AvahiServiceError("Too many renames")
350
self.name = str(
351
self.server.GetAlternativeServiceName(self.name))
352
self.rename_count += 1
353
logger.info("Changing Zeroconf service name to %r ...",
162
354
self.name)
163
syslogger.setFormatter(logging.Formatter
164
(u'Mandos (%s) [%%(process)d]:'
165
u' %%(levelname)s: %%(message)s'
166
% self.name))
167
self.remove()
355
if remove:
356
self.remove()
168
357
try:
169
358
self.add()
170
except dbus.exceptions.DBusException, error:
171
logger.critical(u"DBusException: %s", error)
172
self.cleanup()
173
os._exit(1)
174
self.rename_count += 1
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
175
369
def remove(self):
176
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
177
374
if self.group is not None:
178
375
self.group.Reset()
376
179
377
def add(self):
180
378
"""Derived from the Avahi example code"""
379
self.remove()
181
380
if self.group is None:
182
381
self.group = dbus.Interface(
183
382
self.bus.get_object(avahi.DBUS_NAME,
184
383
self.server.EntryGroupNew()),
185
384
avahi.DBUS_INTERFACE_ENTRY_GROUP)
186
self.group.connect_to_signal('StateChanged',
187
self
188
.entry_group_state_changed)
189
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' ...",
190
389
self.name, self.type)
191
390
self.group.AddService(
192
391
self.interface,
197
396
dbus.UInt16(self.port),
198
397
avahi.string_array_to_txt_array(self.TXT))
199
398
self.group.Commit()
399
200
400
def entry_group_state_changed(self, state, error):
201
401
"""Derived from the Avahi example code"""
202
logger.debug(u"Avahi entry group state change: %i", state)
402
logger.debug("Avahi entry group state change: %i", state)
203
403
204
404
if state == avahi.ENTRY_GROUP_ESTABLISHED:
205
logger.debug(u"Zeroconf service established.")
405
logger.debug("Zeroconf service established.")
206
406
elif state == avahi.ENTRY_GROUP_COLLISION:
207
logger.warning(u"Zeroconf service name collision.")
407
logger.info("Zeroconf service name collision.")
208
408
self.rename()
209
409
elif state == avahi.ENTRY_GROUP_FAILURE:
210
logger.critical(u"Avahi: Error in group state changed %s",
211
unicode(error))
212
raise AvahiGroupError(u"State changed: %s"
213
% unicode(error))
410
logger.critical("Avahi: Error in group state changed %s",
411
str(error))
412
raise AvahiGroupError("State changed: {!s}".format(error))
413
214
414
def cleanup(self):
215
415
"""Derived from the Avahi example code"""
216
416
if self.group is not None:
217
self.group.Free()
417
try:
418
self.group.Free()
419
except (dbus.exceptions.UnknownMethodException,
420
dbus.exceptions.DBusException):
421
pass
218
422
self.group = None
219
def server_state_changed(self, state):
423
self.remove()
424
425
def server_state_changed(self, state, error=None):
220
426
"""Derived from the Avahi example code"""
221
logger.debug(u"Avahi server state change: %i", state)
222
if state == avahi.SERVER_COLLISION:
223
logger.error(u"Zeroconf server name collision")
224
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()
225
441
elif state == avahi.SERVER_RUNNING:
226
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
227
460
def activate(self):
228
461
"""Derived from the Avahi example code"""
229
462
if self.server is None:
230
463
self.server = dbus.Interface(
231
464
self.bus.get_object(avahi.DBUS_NAME,
232
avahi.DBUS_PATH_SERVER),
465
avahi.DBUS_PATH_SERVER,
466
follow_name_owner_changes=True),
233
467
avahi.DBUS_INTERFACE_SERVER)
234
self.server.connect_to_signal(u"StateChanged",
235
self.server_state_changed)
468
self.server.connect_to_signal("StateChanged",
469
self.server_state_changed)
236
470
self.server_state_changed(self.server.GetState())
237
471
238
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
239
747
class Client(object):
240
748
"""A representation of a client host served by this server.
241
749
242
750
Attributes:
243
_approved: bool(); 'None' if not yet approved/disapproved
751
approved: bool(); 'None' if not yet approved/disapproved
244
752
approval_delay: datetime.timedelta(); Time to wait for approval
245
753
approval_duration: datetime.timedelta(); Duration of one approval
246
754
checker: subprocess.Popen(); a running checker process used
247
755
to see if the client lives.
248
756
'None' if no process is running.
249
checker_callback_tag: a gobject event source tag, or None
757
checker_callback_tag: a GLib event source tag, or None
250
758
checker_command: string; External command which is run to check
251
759
if client lives. %() expansions are done at
252
760
runtime with vars(self) as dict, so that for
253
761
instance %(name)s can be used in the command.
254
checker_initiator_tag: a gobject event source tag, or None
762
checker_initiator_tag: a GLib event source tag, or None
255
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
256
766
current_checker_command: string; current running checker_command
257
disable_hook: If set, called by disable() as disable_hook(self)
258
disable_initiator_tag: a gobject event source tag, or None
767
disable_initiator_tag: a GLib event source tag, or None
259
768
enabled: bool()
260
769
fingerprint: string (40 or 32 hexadecimal digits); used to
261
770
uniquely identify the client
263
772
interval: datetime.timedelta(); How often to start a new checker
264
773
last_approval_request: datetime.datetime(); (UTC) or None
265
774
last_checked_ok: datetime.datetime(); (UTC) or None
266
last_enabled: datetime.datetime(); (UTC)
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
267
781
name: string; from the config file, used in log messages and
268
782
D-Bus identifiers
269
783
secret: bytestring; sent verbatim (over TLS) to client
270
784
timeout: datetime.timedelta(); How long from last_checked_ok
271
785
until this client is disabled
786
extended_timeout: extra long timeout when secret has been sent
272
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()
273
791
"""
274
792
275
runtime_expansions = (u"approval_delay", u"approval_duration",
276
u"created", u"enabled", u"fingerprint",
277
u"host", u"interval", u"last_checked_ok",
278
u"last_enabled", u"name", u"timeout")
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
}
279
809
280
810
@staticmethod
281
def _timedelta_to_milliseconds(td):
282
"Convert a datetime.timedelta() to milliseconds"
283
return ((td.days * 24 * 60 * 60 * 1000)
284
+ (td.seconds * 1000)
285
+ (td.microseconds // 1000))
286
287
def timeout_milliseconds(self):
288
"Return the 'timeout' attribute in milliseconds"
289
return self._timedelta_to_milliseconds(self.timeout)
290
291
def interval_milliseconds(self):
292
"Return the 'interval' attribute in milliseconds"
293
return self._timedelta_to_milliseconds(self.interval)
294
295
def approval_delay_milliseconds(self):
296
return self._timedelta_to_milliseconds(self.approval_delay)
297
298
def __init__(self, name = None, disable_hook=None, config=None):
299
"""Note: the 'checker' key in 'config' sets the
300
'checker_command' attribute and *not* the 'checker'
301
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):
302
863
self.name = name
303
if config is None:
304
config = {}
305
logger.debug(u"Creating client %r", self.name)
306
# Uppercase and remove spaces from fingerprint for later
307
# comparison purposes with return value from the fingerprint()
308
# function
309
self.fingerprint = (config[u"fingerprint"].upper()
310
.replace(u" ", u""))
311
logger.debug(u" Fingerprint: %s", self.fingerprint)
312
if u"secret" in config:
313
self.secret = config[u"secret"].decode(u"base64")
314
elif u"secfile" in config:
315
with open(os.path.expanduser(os.path.expandvars
316
(config[u"secfile"])),
317
"rb") as secfile:
318
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)
319
877
else:
320
raise TypeError(u"No secret or secfile for client %s"
321
% self.name)
322
self.host = config.get(u"host", u"")
323
self.created = datetime.datetime.utcnow()
324
self.enabled = False
325
self.last_approval_request = None
326
self.last_enabled = None
327
self.last_checked_ok = None
328
self.timeout = string_to_delta(config[u"timeout"])
329
self.interval = string_to_delta(config[u"interval"])
330
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
331
887
self.checker = None
332
888
self.checker_initiator_tag = None
333
889
self.disable_initiator_tag = None
334
890
self.checker_callback_tag = None
335
self.checker_command = config[u"checker"]
336
891
self.current_checker_command = None
337
self.last_connect = None
338
self._approved = None
339
self.approved_by_default = config.get(u"approved_by_default",
340
True)
892
self.approved = None
341
893
self.approvals_pending = 0
342
self.approval_delay = string_to_delta(
343
config[u"approval_delay"])
344
self.approval_duration = string_to_delta(
345
config[u"approval_duration"])
346
self.changedstate = multiprocessing_manager.Condition(multiprocessing_manager.Lock())
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)
347
905
906
# Send notice to process children that client state has changed
348
907
def send_changedstate(self):
349
self.changedstate.acquire()
350
self.changedstate.notify_all()
351
self.changedstate.release()
352
908
with self.changedstate:
909
self.changedstate.notify_all()
910
353
911
def enable(self):
354
912
"""Start this client's checker and timeout hooks"""
355
if getattr(self, u"enabled", False):
913
if getattr(self, "enabled", False):
356
914
# Already enabled
357
915
return
358
self.send_changedstate()
916
self.expires = datetime.datetime.utcnow() + self.timeout
917
self.enabled = True
359
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):
360
946
# Schedule a new checker to be started an 'interval' from now,
361
947
# and every interval from then on.
362
self.checker_initiator_tag = (gobject.timeout_add
363
(self.interval_milliseconds(),
364
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)
365
953
# Schedule a disable() when 'timeout' has passed
366
self.disable_initiator_tag = (gobject.timeout_add
367
(self.timeout_milliseconds(),
368
self.disable))
369
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)
370
958
# Also start a new checker *right now*.
371
959
self.start_checker()
372
960
373
def disable(self, quiet=True):
374
"""Disable this client."""
375
if not getattr(self, "enabled", False):
376
return False
377
if not quiet:
378
self.send_changedstate()
379
if not quiet:
380
logger.info(u"Disabling client %s", self.name)
381
if getattr(self, u"disable_initiator_tag", False):
382
gobject.source_remove(self.disable_initiator_tag)
383
self.disable_initiator_tag = None
384
if getattr(self, u"checker_initiator_tag", False):
385
gobject.source_remove(self.checker_initiator_tag)
386
self.checker_initiator_tag = None
387
self.stop_checker()
388
if self.disable_hook:
389
self.disable_hook(self)
390
self.enabled = False
391
# Do not run this again if called by a gobject.timeout_add
392
return False
393
394
def __del__(self):
395
self.disable_hook = None
396
self.disable()
397
398
def checker_callback(self, pid, condition, command):
961
def checker_callback(self, source, condition, connection,
962
command):
399
963
"""The checker has completed, so take appropriate actions."""
400
964
self.checker_callback_tag = None
401
965
self.checker = None
402
if os.WIFEXITED(condition):
403
exitstatus = os.WEXITSTATUS(condition)
404
if exitstatus == 0:
405
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",
406
975
vars(self))
407
976
self.checked_ok()
408
977
else:
409
logger.info(u"Checker for %(name)s failed",
410
vars(self))
978
logger.info("Checker for %(name)s failed", vars(self))
411
979
else:
412
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?",
413
983
vars(self))
984
return False
414
985
415
986
def checked_ok(self):
416
"""Bump up the timeout for this client.
417
418
This should only be called when the client has been seen,
419
alive and well.
420
"""
987
"""Assert that the client has been seen, alive and well."""
421
988
self.last_checked_ok = datetime.datetime.utcnow()
422
gobject.source_remove(self.disable_initiator_tag)
423
self.disable_initiator_tag = (gobject.timeout_add
424
(self.timeout_milliseconds(),
425
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
426
1004
427
1005
def need_approval(self):
428
1006
self.last_approval_request = datetime.datetime.utcnow()
433
1011
If a checker already exists, leave it running and do
434
1012
nothing."""
435
1013
# The reason for not killing a running checker is that if we
436
# did that, then if a checker (for some reason) started
437
# running slowly and taking more than 'interval' time, the
438
# client would inevitably timeout, since no checker would get
439
# 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
440
1018
# checkers alone, the checker would have to take more time
441
1019
# than 'timeout' for the client to be disabled, which is as it
442
1020
# should be.
443
1021
444
# If a checker exists, make sure it is not a zombie
445
try:
446
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
447
except (AttributeError, OSError), error:
448
if (isinstance(error, OSError)
449
and error.errno != errno.ECHILD):
450
raise error
451
else:
452
if pid:
453
logger.warning(u"Checker was a zombie")
454
gobject.source_remove(self.checker_callback_tag)
455
self.checker_callback(pid, status,
456
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
457
1026
# Start a new checker if needed
458
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 }
459
1032
try:
460
# In case checker_command has exactly one % operator
461
command = self.checker_command % self.host
462
except TypeError:
463
# Escape attributes for the shell
464
escaped_attrs = dict(
465
(attr,
466
re.escape(unicode(str(getattr(self, attr, u"")),
467
errors=
468
u'replace')))
469
for attr in
470
self.runtime_expansions)
471
472
try:
473
command = self.checker_command % escaped_attrs
474
except TypeError, error:
475
logger.error(u'Could not format string "%s":'
476
u' %s', self.checker_command, error)
477
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
478
1039
self.current_checker_command = command
479
try:
480
logger.info(u"Starting checker %r for %s",
481
command, self.name)
482
# We don't need to redirect stdout and stderr, since
483
# in normal mode, that is already done by daemon(),
484
# and in debug mode we don't want to. (Stdin is
485
# always replaced by /dev/null.)
486
self.checker = subprocess.Popen(command,
487
close_fds=True,
488
shell=True, cwd=u"/")
489
self.checker_callback_tag = (gobject.child_watch_add
490
(self.checker.pid,
491
self.checker_callback,
492
data=command))
493
# The checker may have completed before the gobject
494
# watch was added. Check for this.
495
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
496
if pid:
497
gobject.source_remove(self.checker_callback_tag)
498
self.checker_callback(pid, status, command)
499
except OSError, error:
500
logger.error(u"Failed to start subprocess: %s",
501
error)
502
# 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
503
1066
return True
504
1067
505
1068
def stop_checker(self):
506
1069
"""Force the checker process, if any, to stop."""
507
1070
if self.checker_callback_tag:
508
gobject.source_remove(self.checker_callback_tag)
1071
GLib.source_remove(self.checker_callback_tag)
509
1072
self.checker_callback_tag = None
510
if getattr(self, u"checker", None) is None:
1073
if getattr(self, "checker", None) is None:
511
1074
return
512
logger.debug(u"Stopping checker for %(name)s", vars(self))
513
try:
514
os.kill(self.checker.pid, signal.SIGTERM)
515
#time.sleep(0.5)
516
#if self.checker.poll() is None:
517
# os.kill(self.checker.pid, signal.SIGKILL)
518
except OSError, error:
519
if error.errno != errno.ESRCH: # No such process
520
raise
1075
logger.debug("Stopping checker for %(name)s", vars(self))
1076
self.checker.terminate()
521
1077
self.checker = None
522
1078
523
def dbus_service_property(dbus_interface, signature=u"v",
524
access=u"readwrite", byte_arrays=False):
1079
1080
def dbus_service_property(dbus_interface,
1081
signature="v",
1082
access="readwrite",
1083
byte_arrays=False):
525
1084
"""Decorators for marking methods of a DBusObjectWithProperties to
526
1085
become properties on the D-Bus.
527
1086
534
1093
"""
535
1094
# Encoding deeply encoded byte arrays is not supported yet by the
536
1095
# "Set" method, so we fail early here:
537
if byte_arrays and signature != u"ay":
538
raise ValueError(u"Byte arrays not supported for non-'ay'"
539
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
540
1100
def decorator(func):
541
1101
func._dbus_is_property = True
542
1102
func._dbus_interface = dbus_interface
543
1103
func._dbus_signature = signature
544
1104
func._dbus_access = access
545
1105
func._dbus_name = func.__name__
546
if func._dbus_name.endswith(u"_dbus_property"):
1106
if func._dbus_name.endswith("_dbus_property"):
547
1107
func._dbus_name = func._dbus_name[:-14]
548
func._dbus_get_args_options = {u'byte_arrays': byte_arrays }
549
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
550
1154
return decorator
551
1155
552
1156
553
1157
class DBusPropertyException(dbus.exceptions.DBusException):
554
1158
"""A base class for D-Bus property-related exceptions
555
1159
"""
556
def __unicode__(self):
557
return unicode(str(self))
1160
pass
558
1161
559
1162
560
1163
class DBusPropertyAccessException(DBusPropertyException):
569
1172
pass
570
1173
571
1174
572
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):
573
1265
"""A D-Bus object with properties.
574
1266
575
1267
Classes inheriting from this can use the dbus_service_property
576
1268
decorator to expose methods as D-Bus properties. It exposes the
577
1269
standard Get(), Set(), and GetAll() methods on the D-Bus.
578
1270
"""
579
1271
580
@staticmethod
581
def _is_dbus_property(obj):
582
return getattr(obj, u"_dbus_is_property", False)
583
584
def _get_all_dbus_properties(self):
585
"""Returns a generator of (name, attribute) pairs
586
"""
587
return ((prop._dbus_name, prop)
588
for name, prop in
589
inspect.getmembers(self, self._is_dbus_property))
590
591
1272
def _get_dbus_property(self, interface_name, property_name):
592
1273
"""Returns a bound method if one exists which is a D-Bus
593
1274
property with the specified name and interface.
594
1275
"""
595
for name in (property_name,
596
property_name + u"_dbus_property"):
597
prop = getattr(self, name, None)
598
if (prop is None
599
or not self._is_dbus_property(prop)
600
or prop._dbus_name != property_name
601
or (interface_name and prop._dbus_interface
602
and interface_name != prop._dbus_interface)):
603
continue
604
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
605
1283
# No such property
606
raise DBusPropertyNotFound(self.dbus_object_path + u":"
607
+ interface_name + u"."
608
+ property_name)
609
610
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ss",
611
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")
612
1299
def Get(self, interface_name, property_name):
613
1300
"""Standard D-Bus property Get() method, see D-Bus standard.
614
1301
"""
615
1302
prop = self._get_dbus_property(interface_name, property_name)
616
if prop._dbus_access == u"write":
1303
if prop._dbus_access == "write":
617
1304
raise DBusPropertyAccessException(property_name)
618
1305
value = prop()
619
if not hasattr(value, u"variant_level"):
1306
if not hasattr(value, "variant_level"):
620
1307
return value
621
1308
return type(value)(value, variant_level=value.variant_level+1)
622
1309
623
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ssv")
1310
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
624
1311
def Set(self, interface_name, property_name, value):
625
1312
"""Standard D-Bus property Set() method, see D-Bus standard.
626
1313
"""
627
1314
prop = self._get_dbus_property(interface_name, property_name)
628
if prop._dbus_access == u"read":
1315
if prop._dbus_access == "read":
629
1316
raise DBusPropertyAccessException(property_name)
630
if prop._dbus_get_args_options[u"byte_arrays"]:
1317
if prop._dbus_get_args_options["byte_arrays"]:
631
1318
# The byte_arrays option is not supported yet on
632
1319
# signatures other than "ay".
633
if prop._dbus_signature != u"ay":
634
raise ValueError
635
value = dbus.ByteArray(''.join(unichr(byte)
636
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))
637
1326
prop(value)
638
1327
639
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"s",
640
out_signature=u"a{sv}")
1328
@dbus.service.method(dbus.PROPERTIES_IFACE,
1329
in_signature="s",
1330
out_signature="a{sv}")
641
1331
def GetAll(self, interface_name):
642
1332
"""Standard D-Bus property GetAll() method, see D-Bus
643
1333
standard.
644
1334
645
1335
Note: Will not include properties with access="write".
646
1336
"""
647
all = {}
648
for name, prop in self._get_all_dbus_properties():
1337
properties = {}
1338
for name, prop in self._get_all_dbus_things("property"):
649
1339
if (interface_name
650
1340
and interface_name != prop._dbus_interface):
651
1341
# Interface non-empty but did not match
652
1342
continue
653
1343
# Ignore write-only properties
654
if prop._dbus_access == u"write":
1344
if prop._dbus_access == "write":
655
1345
continue
656
1346
value = prop()
657
if not hasattr(value, u"variant_level"):
658
all[name] = value
1347
if not hasattr(value, "variant_level"):
1348
properties[name] = value
659
1349
continue
660
all[name] = type(value)(value, variant_level=
661
value.variant_level+1)
662
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
663
1361
664
1362
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
665
out_signature=u"s",
1363
out_signature="s",
666
1364
path_keyword='object_path',
667
1365
connection_keyword='connection')
668
1366
def Introspect(self, object_path, connection):
669
"""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.
670
1370
"""
671
xmlstring = dbus.service.Object.Introspect(self, object_path,
672
connection)
1371
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1372
object_path,
1373
connection)
673
1374
try:
674
1375
document = xml.dom.minidom.parseString(xmlstring)
1376
675
1377
def make_tag(document, name, prop):
676
e = document.createElement(u"property")
677
e.setAttribute(u"name", name)
678
e.setAttribute(u"type", prop._dbus_signature)
679
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)
680
1382
return e
681
for if_tag in document.getElementsByTagName(u"interface"):
1383
1384
for if_tag in document.getElementsByTagName("interface"):
1385
# Add property tags
682
1386
for tag in (make_tag(document, name, prop)
683
1387
for name, prop
684
in self._get_all_dbus_properties()
1388
in self._get_all_dbus_things("property")
685
1389
if prop._dbus_interface
686
== if_tag.getAttribute(u"name")):
1390
== if_tag.getAttribute("name")):
687
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)
688
1408
# Add the names to the return values for the
689
1409
# "org.freedesktop.DBus.Properties" methods
690
if (if_tag.getAttribute(u"name")
691
== u"org.freedesktop.DBus.Properties"):
692
for cn in if_tag.getElementsByTagName(u"method"):
693
if cn.getAttribute(u"name") == u"Get":
694
for arg in cn.getElementsByTagName(u"arg"):
695
if (arg.getAttribute(u"direction")
696
== u"out"):
697
arg.setAttribute(u"name", u"value")
698
elif cn.getAttribute(u"name") == u"GetAll":
699
for arg in cn.getElementsByTagName(u"arg"):
700
if (arg.getAttribute(u"direction")
701
== u"out"):
702
arg.setAttribute(u"name", u"props")
703
xmlstring = document.toxml(u"utf-8")
704
document.unlink()
705
except (AttributeError, xml.dom.DOMException,
706
xml.parsers.expat.ExpatError), error:
707
logger.error(u"Failed to override Introspection method",
708
error)
709
return xmlstring
710
711
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"})
712
1676
class ClientDBus(Client, DBusObjectWithProperties):
713
1677
"""A Client class using D-Bus
714
1678
718
1682
"""
719
1683
720
1684
runtime_expansions = (Client.runtime_expansions
721
+ (u"dbus_object_path",))
1685
+ ("dbus_object_path", ))
1686
1687
_interface = "se.recompile.Mandos.Client"
722
1688
723
1689
# dbus.service.Object doesn't use super(), so we can't either.
724
1690
725
1691
def __init__(self, bus = None, *args, **kwargs):
726
self._approvals_pending = 0
727
1692
self.bus = bus
728
1693
Client.__init__(self, *args, **kwargs)
729
1694
# Only now, when this client is initialized, can it show up on
730
1695
# the D-Bus
731
client_object_name = unicode(self.name).translate(
732
{ord(u"."): ord(u"_"),
733
ord(u"-"): ord(u"_")})
734
self.dbus_object_path = (dbus.ObjectPath
735
(u"/clients/" + client_object_name))
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)
736
1701
DBusObjectWithProperties.__init__(self, self.bus,
737
1702
self.dbus_object_path)
738
739
def _get_approvals_pending(self):
740
return self._approvals_pending
741
def _set_approvals_pending(self, value):
742
old_value = self._approvals_pending
743
self._approvals_pending = value
744
bval = bool(value)
745
if (hasattr(self, "dbus_object_path")
746
and bval is not bool(old_value)):
747
dbus_bool = dbus.Boolean(bval, variant_level=1)
748
self.PropertyChanged(dbus.String(u"ApprovalPending"),
749
dbus_bool)
750
751
approvals_pending = property(_get_approvals_pending,
752
_set_approvals_pending)
753
del _get_approvals_pending, _set_approvals_pending
754
755
@staticmethod
756
def _datetime_to_dbus(dt, variant_level=0):
757
"""Convert a UTC datetime.datetime() to a D-Bus type."""
758
return dbus.String(dt.isoformat(),
759
variant_level=variant_level)
760
761
def enable(self):
762
oldstate = getattr(self, u"enabled", False)
763
r = Client.enable(self)
764
if oldstate != self.enabled:
765
# Emit D-Bus signals
766
self.PropertyChanged(dbus.String(u"Enabled"),
767
dbus.Boolean(True, variant_level=1))
768
self.PropertyChanged(
769
dbus.String(u"LastEnabled"),
770
self._datetime_to_dbus(self.last_enabled,
771
variant_level=1))
772
return r
773
774
def disable(self, quiet = False):
775
oldstate = getattr(self, u"enabled", False)
776
r = Client.disable(self, quiet=quiet)
777
if not quiet and oldstate != self.enabled:
778
# Emit D-Bus signal
779
self.PropertyChanged(dbus.String(u"Enabled"),
780
dbus.Boolean(False, variant_level=1))
781
return r
1703
1704
def notifychangeproperty(transform_func, dbus_name,
1705
type_func=lambda x: x,
1706
variant_level=1,
1707
invalidate_only=False,
1708
_interface=_interface):
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
782
1784
783
1785
def __del__(self, *args, **kwargs):
784
1786
try:
785
1787
self.remove_from_connection()
786
1788
except LookupError:
787
1789
pass
788
if hasattr(DBusObjectWithProperties, u"__del__"):
1790
if hasattr(DBusObjectWithProperties, "__del__"):
789
1791
DBusObjectWithProperties.__del__(self, *args, **kwargs)
790
1792
Client.__del__(self, *args, **kwargs)
791
1793
792
def checker_callback(self, pid, condition, command,
793
*args, **kwargs):
794
self.checker_callback_tag = None
795
self.checker = None
796
# Emit D-Bus signal
797
self.PropertyChanged(dbus.String(u"CheckerRunning"),
798
dbus.Boolean(False, variant_level=1))
799
if os.WIFEXITED(condition):
800
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:
801
1801
# Emit D-Bus signal
802
1802
self.CheckerCompleted(dbus.Int16(exitstatus),
803
dbus.Int64(condition),
1803
# This is specific to GNU libC
1804
dbus.Int64(exitstatus << 8),
804
1805
dbus.String(command))
805
1806
else:
806
1807
# Emit D-Bus signal
807
1808
self.CheckerCompleted(dbus.Int16(-1),
808
dbus.Int64(condition),
1809
dbus.Int64(
1810
# This is specific to GNU libC
1811
(exitstatus << 8)
1812
| self.last_checker_signal),
809
1813
dbus.String(command))
810
811
return Client.checker_callback(self, pid, condition, command,
812
*args, **kwargs)
813
814
def checked_ok(self, *args, **kwargs):
815
r = Client.checked_ok(self, *args, **kwargs)
816
# Emit D-Bus signal
817
self.PropertyChanged(
818
dbus.String(u"LastCheckedOK"),
819
(self._datetime_to_dbus(self.last_checked_ok,
820
variant_level=1)))
821
return r
822
823
def need_approval(self, *args, **kwargs):
824
r = Client.need_approval(self, *args, **kwargs)
825
# Emit D-Bus signal
826
self.PropertyChanged(
827
dbus.String(u"LastApprovalRequest"),
828
(self._datetime_to_dbus(self.last_approval_request,
829
variant_level=1)))
830
return r
1814
return ret
831
1815
832
1816
def start_checker(self, *args, **kwargs):
833
old_checker = self.checker
834
if self.checker is not None:
835
old_checker_pid = self.checker.pid
836
else:
837
old_checker_pid = None
1817
old_checker_pid = getattr(self.checker, "pid", None)
838
1818
r = Client.start_checker(self, *args, **kwargs)
839
1819
# Only if new checker process was started
840
1820
if (self.checker is not None
841
1821
and old_checker_pid != self.checker.pid):
842
1822
# Emit D-Bus signal
843
1823
self.CheckerStarted(self.current_checker_command)
844
self.PropertyChanged(
845
dbus.String(u"CheckerRunning"),
846
dbus.Boolean(True, variant_level=1))
847
1824
return r
848
1825
849
def stop_checker(self, *args, **kwargs):
850
old_checker = getattr(self, u"checker", None)
851
r = Client.stop_checker(self, *args, **kwargs)
852
if (old_checker is not None
853
and getattr(self, u"checker", None) is None):
854
self.PropertyChanged(dbus.String(u"CheckerRunning"),
855
dbus.Boolean(False, variant_level=1))
856
return r
857
858
1826
def _reset_approved(self):
859
self._approved = None
1827
self.approved = None
860
1828
return False
861
1829
862
1830
def approve(self, value=True):
1831
self.approved = value
1832
GLib.timeout_add(int(self.approval_duration.total_seconds()
1833
* 1000), self._reset_approved)
863
1834
self.send_changedstate()
864
self._approved = value
865
gobject.timeout_add(self._timedelta_to_milliseconds
866
(self.approval_duration),
867
self._reset_approved)
868
869
1835
870
1836
## D-Bus methods, signals & properties
871
_interface = u"se.bsnet.fukt.Mandos.Client"
1837
1838
## Interfaces
872
1839
873
1840
## Signals
874
1841
875
1842
# CheckerCompleted - signal
876
@dbus.service.signal(_interface, signature=u"nxs")
1843
@dbus.service.signal(_interface, signature="nxs")
877
1844
def CheckerCompleted(self, exitcode, waitstatus, command):
878
1845
"D-Bus signal"
879
1846
pass
880
1847
881
1848
# CheckerStarted - signal
882
@dbus.service.signal(_interface, signature=u"s")
1849
@dbus.service.signal(_interface, signature="s")
883
1850
def CheckerStarted(self, command):
884
1851
"D-Bus signal"
885
1852
pass
886
1853
887
1854
# PropertyChanged - signal
888
@dbus.service.signal(_interface, signature=u"sv")
1855
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1856
@dbus.service.signal(_interface, signature="sv")
889
1857
def PropertyChanged(self, property, value):
890
1858
"D-Bus signal"
891
1859
pass
900
1868
pass
901
1869
902
1870
# Rejected - signal
903
@dbus.service.signal(_interface, signature=u"s")
1871
@dbus.service.signal(_interface, signature="s")
904
1872
def Rejected(self, reason):
905
1873
"D-Bus signal"
906
1874
pass
907
1875
908
1876
# NeedApproval - signal
909
@dbus.service.signal(_interface, signature=u"tb")
1877
@dbus.service.signal(_interface, signature="tb")
910
1878
def NeedApproval(self, timeout, default):
911
1879
"D-Bus signal"
912
1880
return self.need_approval()
914
1882
## Methods
915
1883
916
1884
# Approve - method
917
@dbus.service.method(_interface, in_signature=u"b")
1885
@dbus.service.method(_interface, in_signature="b")
918
1886
def Approve(self, value):
919
1887
self.approve(value)
920
1888
921
1889
# CheckedOK - method
922
1890
@dbus.service.method(_interface)
923
1891
def CheckedOK(self):
924
return self.checked_ok()
1892
self.checked_ok()
925
1893
926
1894
# Enable - method
1895
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
927
1896
@dbus.service.method(_interface)
928
1897
def Enable(self):
929
1898
"D-Bus method"
930
1899
self.enable()
931
1900
932
1901
# StartChecker - method
1902
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
933
1903
@dbus.service.method(_interface)
934
1904
def StartChecker(self):
935
1905
"D-Bus method"
936
1906
self.start_checker()
937
1907
938
1908
# Disable - method
1909
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
939
1910
@dbus.service.method(_interface)
940
1911
def Disable(self):
941
1912
"D-Bus method"
942
1913
self.disable()
943
1914
944
1915
# StopChecker - method
1916
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
945
1917
@dbus.service.method(_interface)
946
1918
def StopChecker(self):
947
1919
self.stop_checker()
949
1921
## Properties
950
1922
951
1923
# ApprovalPending - property
952
@dbus_service_property(_interface, signature=u"b", access=u"read")
1924
@dbus_service_property(_interface, signature="b", access="read")
953
1925
def ApprovalPending_dbus_property(self):
954
1926
return dbus.Boolean(bool(self.approvals_pending))
955
1927
956
1928
# ApprovedByDefault - property
957
@dbus_service_property(_interface, signature=u"b",
958
access=u"readwrite")
1929
@dbus_service_property(_interface,
1930
signature="b",
1931
access="readwrite")
959
1932
def ApprovedByDefault_dbus_property(self, value=None):
960
1933
if value is None: # get
961
1934
return dbus.Boolean(self.approved_by_default)
962
1935
self.approved_by_default = bool(value)
963
# Emit D-Bus signal
964
self.PropertyChanged(dbus.String(u"ApprovedByDefault"),
965
dbus.Boolean(value, variant_level=1))
966
1936
967
1937
# ApprovalDelay - property
968
@dbus_service_property(_interface, signature=u"t",
969
access=u"readwrite")
1938
@dbus_service_property(_interface,
1939
signature="t",
1940
access="readwrite")
970
1941
def ApprovalDelay_dbus_property(self, value=None):
971
1942
if value is None: # get
972
return dbus.UInt64(self.approval_delay_milliseconds())
1943
return dbus.UInt64(self.approval_delay.total_seconds()
1944
* 1000)
973
1945
self.approval_delay = datetime.timedelta(0, 0, 0, value)
974
# Emit D-Bus signal
975
self.PropertyChanged(dbus.String(u"ApprovalDelay"),
976
dbus.UInt64(value, variant_level=1))
977
1946
978
1947
# ApprovalDuration - property
979
@dbus_service_property(_interface, signature=u"t",
980
access=u"readwrite")
1948
@dbus_service_property(_interface,
1949
signature="t",
1950
access="readwrite")
981
1951
def ApprovalDuration_dbus_property(self, value=None):
982
1952
if value is None: # get
983
return dbus.UInt64(self._timedelta_to_milliseconds(
984
self.approval_duration))
1953
return dbus.UInt64(self.approval_duration.total_seconds()
1954
* 1000)
985
1955
self.approval_duration = datetime.timedelta(0, 0, 0, value)
986
# Emit D-Bus signal
987
self.PropertyChanged(dbus.String(u"ApprovalDuration"),
988
dbus.UInt64(value, variant_level=1))
989
1956
990
1957
# Name - property
991
@dbus_service_property(_interface, signature=u"s", access=u"read")
1958
@dbus_annotations(
1959
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1960
@dbus_service_property(_interface, signature="s", access="read")
992
1961
def Name_dbus_property(self):
993
1962
return dbus.String(self.name)
994
1963
995
1964
# Fingerprint - property
996
@dbus_service_property(_interface, signature=u"s", access=u"read")
1965
@dbus_annotations(
1966
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1967
@dbus_service_property(_interface, signature="s", access="read")
997
1968
def Fingerprint_dbus_property(self):
998
1969
return dbus.String(self.fingerprint)
999
1970
1000
1971
# Host - property
1001
@dbus_service_property(_interface, signature=u"s",
1002
access=u"readwrite")
1972
@dbus_service_property(_interface,
1973
signature="s",
1974
access="readwrite")
1003
1975
def Host_dbus_property(self, value=None):
1004
1976
if value is None: # get
1005
1977
return dbus.String(self.host)
1006
self.host = value
1007
# Emit D-Bus signal
1008
self.PropertyChanged(dbus.String(u"Host"),
1009
dbus.String(value, variant_level=1))
1978
self.host = str(value)
1010
1979
1011
1980
# Created - property
1012
@dbus_service_property(_interface, signature=u"s", access=u"read")
1981
@dbus_annotations(
1982
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1983
@dbus_service_property(_interface, signature="s", access="read")
1013
1984
def Created_dbus_property(self):
1014
return dbus.String(self._datetime_to_dbus(self.created))
1985
return datetime_to_dbus(self.created)
1015
1986
1016
1987
# LastEnabled - property
1017
@dbus_service_property(_interface, signature=u"s", access=u"read")
1988
@dbus_service_property(_interface, signature="s", access="read")
1018
1989
def LastEnabled_dbus_property(self):
1019
if self.last_enabled is None:
1020
return dbus.String(u"")
1021
return dbus.String(self._datetime_to_dbus(self.last_enabled))
1990
return datetime_to_dbus(self.last_enabled)
1022
1991
1023
1992
# Enabled - property
1024
@dbus_service_property(_interface, signature=u"b",
1025
access=u"readwrite")
1993
@dbus_service_property(_interface,
1994
signature="b",
1995
access="readwrite")
1026
1996
def Enabled_dbus_property(self, value=None):
1027
1997
if value is None: # get
1028
1998
return dbus.Boolean(self.enabled)
1032
2002
self.disable()
1033
2003
1034
2004
# LastCheckedOK - property
1035
@dbus_service_property(_interface, signature=u"s",
1036
access=u"readwrite")
2005
@dbus_service_property(_interface,
2006
signature="s",
2007
access="readwrite")
1037
2008
def LastCheckedOK_dbus_property(self, value=None):
1038
2009
if value is not None:
1039
2010
self.checked_ok()
1040
2011
return
1041
if self.last_checked_ok is None:
1042
return dbus.String(u"")
1043
return dbus.String(self._datetime_to_dbus(self
1044
.last_checked_ok))
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)
1045
2023
1046
2024
# LastApprovalRequest - property
1047
@dbus_service_property(_interface, signature=u"s", access=u"read")
2025
@dbus_service_property(_interface, signature="s", access="read")
1048
2026
def LastApprovalRequest_dbus_property(self):
1049
if self.last_approval_request is None:
1050
return dbus.String(u"")
1051
return dbus.String(self.
1052
_datetime_to_dbus(self
1053
.last_approval_request))
2027
return datetime_to_dbus(self.last_approval_request)
1054
2028
1055
2029
# Timeout - property
1056
@dbus_service_property(_interface, signature=u"t",
1057
access=u"readwrite")
2030
@dbus_service_property(_interface,
2031
signature="t",
2032
access="readwrite")
1058
2033
def Timeout_dbus_property(self, value=None):
1059
2034
if value is None: # get
1060
return dbus.UInt64(self.timeout_milliseconds())
2035
return dbus.UInt64(self.timeout.total_seconds() * 1000)
2036
old_timeout = self.timeout
1061
2037
self.timeout = datetime.timedelta(0, 0, 0, value)
1062
# Emit D-Bus signal
1063
self.PropertyChanged(dbus.String(u"Timeout"),
1064
dbus.UInt64(value, variant_level=1))
1065
if getattr(self, u"disable_initiator_tag", None) is None:
1066
return
1067
# Reschedule timeout
1068
gobject.source_remove(self.disable_initiator_tag)
1069
self.disable_initiator_tag = None
1070
time_to_die = (self.
1071
_timedelta_to_milliseconds((self
1072
.last_checked_ok
1073
+ self.timeout)
1074
- datetime.datetime
1075
.utcnow()))
1076
if time_to_die <= 0:
1077
# The timeout has passed
1078
self.disable()
1079
else:
1080
self.disable_initiator_tag = (gobject.timeout_add
1081
(time_to_die, self.disable))
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)
1082
2063
1083
2064
# Interval - property
1084
@dbus_service_property(_interface, signature=u"t",
1085
access=u"readwrite")
2065
@dbus_service_property(_interface,
2066
signature="t",
2067
access="readwrite")
1086
2068
def Interval_dbus_property(self, value=None):
1087
2069
if value is None: # get
1088
return dbus.UInt64(self.interval_milliseconds())
2070
return dbus.UInt64(self.interval.total_seconds() * 1000)
1089
2071
self.interval = datetime.timedelta(0, 0, 0, value)
1090
# Emit D-Bus signal
1091
self.PropertyChanged(dbus.String(u"Interval"),
1092
dbus.UInt64(value, variant_level=1))
1093
if getattr(self, u"checker_initiator_tag", None) is None:
2072
if getattr(self, "checker_initiator_tag", None) is None:
1094
2073
return
1095
# Reschedule checker run
1096
gobject.source_remove(self.checker_initiator_tag)
1097
self.checker_initiator_tag = (gobject.timeout_add
1098
(value, self.start_checker))
1099
self.start_checker() # Start one now, too
1100
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
1101
2081
# Checker - property
1102
@dbus_service_property(_interface, signature=u"s",
1103
access=u"readwrite")
2082
@dbus_service_property(_interface,
2083
signature="s",
2084
access="readwrite")
1104
2085
def Checker_dbus_property(self, value=None):
1105
2086
if value is None: # get
1106
2087
return dbus.String(self.checker_command)
1107
self.checker_command = value
1108
# Emit D-Bus signal
1109
self.PropertyChanged(dbus.String(u"Checker"),
1110
dbus.String(self.checker_command,
1111
variant_level=1))
2088
self.checker_command = str(value)
1112
2089
1113
2090
# CheckerRunning - property
1114
@dbus_service_property(_interface, signature=u"b",
1115
access=u"readwrite")
2091
@dbus_service_property(_interface,
2092
signature="b",
2093
access="readwrite")
1116
2094
def CheckerRunning_dbus_property(self, value=None):
1117
2095
if value is None: # get
1118
2096
return dbus.Boolean(self.checker is not None)
1122
2100
self.stop_checker()
1123
2101
1124
2102
# ObjectPath - property
1125
@dbus_service_property(_interface, signature=u"o", access=u"read")
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")
1126
2107
def ObjectPath_dbus_property(self):
1127
2108
return self.dbus_object_path # is already a dbus.ObjectPath
1128
2109
1129
2110
# Secret = property
1130
@dbus_service_property(_interface, signature=u"ay",
1131
access=u"write", byte_arrays=True)
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)
1132
2118
def Secret_dbus_property(self, value):
1133
self.secret = str(value)
2119
self.secret = bytes(value)
1134
2120
1135
2121
del _interface
1136
2122
1140
2126
self._pipe = child_pipe
1141
2127
self._pipe.send(('init', fpr, address))
1142
2128
if not self._pipe.recv():
1143
raise KeyError()
1144
2129
raise KeyError(fpr)
2130
1145
2131
def __getattribute__(self, name):
1146
if(name == '_pipe'):
2132
if name == '_pipe':
1147
2133
return super(ProxyClient, self).__getattribute__(name)
1148
2134
self._pipe.send(('getattr', name))
1149
2135
data = self._pipe.recv()
1150
2136
if data[0] == 'data':
1151
2137
return data[1]
1152
2138
if data[0] == 'function':
2139
1153
2140
def func(*args, **kwargs):
1154
2141
self._pipe.send(('funcall', name, args, kwargs))
1155
2142
return self._pipe.recv()[1]
2143
1156
2144
return func
1157
2145
1158
2146
def __setattr__(self, name, value):
1159
if(name == '_pipe'):
2147
if name == '_pipe':
1160
2148
return super(ProxyClient, self).__setattr__(name, value)
1161
2149
self._pipe.send(('setattr', name, value))
1162
2150
1169
2157
1170
2158
def handle(self):
1171
2159
with contextlib.closing(self.server.child_pipe) as child_pipe:
1172
logger.info(u"TCP connection from: %s",
1173
unicode(self.client_address))
1174
logger.debug(u"Pipe FD: %d",
2160
logger.info("TCP connection from: %s",
2161
str(self.client_address))
2162
logger.debug("Pipe FD: %d",
1175
2163
self.server.child_pipe.fileno())
1176
1177
session = (gnutls.connection
1178
.ClientSession(self.request,
1179
gnutls.connection
1180
.X509Credentials()))
1181
1182
# Note: gnutls.connection.X509Credentials is really a
1183
# generic GnuTLS certificate credentials object so long as
1184
# no X.509 keys are added to it. Therefore, we can use it
1185
# here despite using OpenPGP certificates.
1186
1187
#priority = u':'.join((u"NONE", u"+VERS-TLS1.1",
1188
# u"+AES-256-CBC", u"+SHA1",
1189
# u"+COMP-NULL", u"+CTYPE-OPENPGP",
1190
# 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"))
1191
2171
# Use a fallback default, since this MUST be set.
1192
2172
priority = self.server.gnutls_priority
1193
2173
if priority is None:
1194
priority = u"NORMAL"
1195
(gnutls.library.functions
1196
.gnutls_priority_set_direct(session._c_object,
1197
priority, None))
1198
2174
priority = "NORMAL"
2175
gnutls.priority_set_direct(session._c_object, priority,
2176
None)
2177
1199
2178
# Start communication using the Mandos protocol
1200
2179
# Get protocol number
1201
2180
line = self.request.makefile().readline()
1202
logger.debug(u"Protocol version: %r", line)
2181
logger.debug("Protocol version: %r", line)
1203
2182
try:
1204
2183
if int(line.strip().split()[0]) > 1:
1205
raise RuntimeError
1206
except (ValueError, IndexError, RuntimeError), error:
1207
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)
1208
2187
return
1209
2188
1210
2189
# Start GnuTLS connection
1211
2190
try:
1212
2191
session.handshake()
1213
except gnutls.errors.GNUTLSError, error:
1214
logger.warning(u"Handshake failed: %s", error)
2192
except gnutls.Error as error:
2193
logger.warning("Handshake failed: %s", error)
1215
2194
# Do not run session.bye() here: the session is not
1216
2195
# established. Just abandon the request.
1217
2196
return
1218
logger.debug(u"Handshake succeeded")
1219
2197
logger.debug("Handshake succeeded")
2198
1220
2199
approval_required = False
1221
2200
try:
1222
2201
try:
1223
fpr = self.fingerprint(self.peer_certificate
1224
(session))
1225
except (TypeError, gnutls.errors.GNUTLSError), error:
1226
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)
1227
2206
return
1228
logger.debug(u"Fingerprint: %s", fpr)
1229
2207
logger.debug("Fingerprint: %s", fpr)
2208
1230
2209
try:
1231
2210
client = ProxyClient(child_pipe, fpr,
1232
2211
self.client_address)
1240
2219
1241
2220
while True:
1242
2221
if not client.enabled:
1243
logger.warning(u"Client %s is disabled",
1244
client.name)
2222
logger.info("Client %s is disabled",
2223
client.name)
1245
2224
if self.server.use_dbus:
1246
2225
# Emit D-Bus signal
1247
client.Rejected("Disabled")
2226
client.Rejected("Disabled")
1248
2227
return
1249
2228
1250
if client._approved or not client.approval_delay:
2229
if client.approved or not client.approval_delay:
1251
2230
#We are approved or approval is disabled
1252
2231
break
1253
elif client._approved is None:
1254
logger.info(u"Client %s needs approval",
2232
elif client.approved is None:
2233
logger.info("Client %s needs approval",
1255
2234
client.name)
1256
2235
if self.server.use_dbus:
1257
2236
# Emit D-Bus signal
1258
2237
client.NeedApproval(
1259
client.approval_delay_milliseconds(),
1260
client.approved_by_default)
2238
client.approval_delay.total_seconds()
2239
* 1000, client.approved_by_default)
1261
2240
else:
1262
logger.warning(u"Client %s was not approved",
2241
logger.warning("Client %s was not approved",
1263
2242
client.name)
1264
2243
if self.server.use_dbus:
1265
2244
# Emit D-Bus signal
1267
2246
return
1268
2247
1269
2248
#wait until timeout or approved
1270
#x = float(client._timedelta_to_milliseconds(delay))
1271
2249
time = datetime.datetime.now()
1272
2250
client.changedstate.acquire()
1273
client.changedstate.wait(float(client._timedelta_to_milliseconds(delay) / 1000))
2251
client.changedstate.wait(delay.total_seconds())
1274
2252
client.changedstate.release()
1275
2253
time2 = datetime.datetime.now()
1276
2254
if (time2 - time) >= delay:
1287
2265
else:
1288
2266
delay -= time2 - time
1289
2267
1290
sent_size = 0
1291
while sent_size < len(client.secret):
1292
try:
1293
sent = session.send(client.secret[sent_size:])
1294
except (gnutls.errors.GNUTLSError), error:
1295
logger.warning("gnutls send failed")
1296
return
1297
logger.debug(u"Sent: %d, remaining: %d",
1298
sent, len(client.secret)
1299
- (sent_size + sent))
1300
sent_size += sent
1301
1302
logger.info(u"Sending secret to %s", client.name)
1303
# bump the timeout as if seen
1304
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)
1305
2278
if self.server.use_dbus:
1306
2279
# Emit D-Bus signal
1307
2280
client.GotSecret()
1311
2284
client.approvals_pending -= 1
1312
2285
try:
1313
2286
session.bye()
1314
except (gnutls.errors.GNUTLSError), error:
1315
logger.warning("GnuTLS bye failed")
2287
except gnutls.Error as error:
2288
logger.warning("GnuTLS bye failed",
2289
exc_info=error)
1316
2290
1317
2291
@staticmethod
1318
2292
def peer_certificate(session):
1319
2293
"Return the peer's OpenPGP certificate as a bytestring"
1320
2294
# If not an OpenPGP certificate...
1321
if (gnutls.library.functions
1322
.gnutls_certificate_type_get(session._c_object)
1323
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1324
# ...do the normal thing
1325
return session.peer_certificate
2295
if (gnutls.certificate_type_get(session._c_object)
2296
!= gnutls.CRT_OPENPGP):
2297
# ...return invalid data
2298
return b""
1326
2299
list_size = ctypes.c_uint(1)
1327
cert_list = (gnutls.library.functions
1328
.gnutls_certificate_get_peers
2300
cert_list = (gnutls.certificate_get_peers
1329
2301
(session._c_object, ctypes.byref(list_size)))
1330
2302
if not bool(cert_list) and list_size.value != 0:
1331
raise gnutls.errors.GNUTLSError(u"error getting peer"
1332
u" certificate")
2303
raise gnutls.Error("error getting peer certificate")
1333
2304
if list_size.value == 0:
1334
2305
return None
1335
2306
cert = cert_list[0]
1339
2310
def fingerprint(openpgp):
1340
2311
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
1341
2312
# New GnuTLS "datum" with the OpenPGP public key
1342
datum = (gnutls.library.types
1343
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1344
ctypes.POINTER
1345
(ctypes.c_ubyte)),
1346
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)))
1347
2317
# New empty GnuTLS certificate
1348
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1349
(gnutls.library.functions
1350
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2318
crt = gnutls.openpgp_crt_t()
2319
gnutls.openpgp_crt_init(ctypes.byref(crt))
1351
2320
# Import the OpenPGP public key into the certificate
1352
(gnutls.library.functions
1353
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1354
gnutls.library.constants
1355
.GNUTLS_OPENPGP_FMT_RAW))
2321
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2322
gnutls.OPENPGP_FMT_RAW)
1356
2323
# Verify the self signature in the key
1357
2324
crtverify = ctypes.c_uint()
1358
(gnutls.library.functions
1359
.gnutls_openpgp_crt_verify_self(crt, 0,
1360
ctypes.byref(crtverify)))
2325
gnutls.openpgp_crt_verify_self(crt, 0,
2326
ctypes.byref(crtverify))
1361
2327
if crtverify.value != 0:
1362
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1363
raise (gnutls.errors.CertificateSecurityError
1364
(u"Verify failed"))
2328
gnutls.openpgp_crt_deinit(crt)
2329
raise gnutls.CertificateSecurityError("Verify failed")
1365
2330
# New buffer for the fingerprint
1366
2331
buf = ctypes.create_string_buffer(20)
1367
2332
buf_len = ctypes.c_size_t()
1368
2333
# Get the fingerprint from the certificate into the buffer
1369
(gnutls.library.functions
1370
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1371
ctypes.byref(buf_len)))
2334
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2335
ctypes.byref(buf_len))
1372
2336
# Deinit the certificate
1373
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2337
gnutls.openpgp_crt_deinit(crt)
1374
2338
# Convert the buffer to a Python bytestring
1375
2339
fpr = ctypes.string_at(buf, buf_len.value)
1376
2340
# Convert the bytestring to hexadecimal notation
1377
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
2341
hex_fpr = binascii.hexlify(fpr).upper()
1378
2342
return hex_fpr
1379
2343
1380
2344
1381
2345
class MultiprocessingMixIn(object):
1382
2346
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2347
1383
2348
def sub_process_main(self, request, address):
1384
2349
try:
1385
2350
self.finish_request(request, address)
1386
except:
2351
except Exception:
1387
2352
self.handle_error(request, address)
1388
2353
self.close_request(request)
1389
2354
1390
2355
def process_request(self, request, address):
1391
2356
"""Start a new process to process the request."""
1392
multiprocessing.Process(target = self.sub_process_main,
1393
args = (request, address)).start()
2357
proc = multiprocessing.Process(target = self.sub_process_main,
2358
args = (request, address))
2359
proc.start()
2360
return proc
2361
1394
2362
1395
2363
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1396
2364
""" adds a pipe to the MixIn """
2365
1397
2366
def process_request(self, request, client_address):
1398
2367
"""Overrides and wraps the original process_request().
1399
2368
1400
2369
This function creates a new pipe in self.pipe
1401
2370
"""
1402
2371
parent_pipe, self.child_pipe = multiprocessing.Pipe()
1403
1404
super(MultiprocessingMixInWithPipe,
1405
self).process_request(request, client_address)
2372
2373
proc = MultiprocessingMixIn.process_request(self, request,
2374
client_address)
1406
2375
self.child_pipe.close()
1407
self.add_pipe(parent_pipe)
1408
1409
def add_pipe(self, parent_pipe):
2376
self.add_pipe(parent_pipe, proc)
2377
2378
def add_pipe(self, parent_pipe, proc):
1410
2379
"""Dummy function; override as necessary"""
1411
pass
2380
raise NotImplementedError()
2381
1412
2382
1413
2383
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1414
2384
socketserver.TCPServer, object):
1419
2389
interface: None or a network interface name (string)
1420
2390
use_ipv6: Boolean; to use IPv6 or not
1421
2391
"""
2392
1422
2393
def __init__(self, server_address, RequestHandlerClass,
1423
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
"""
1424
2400
self.interface = interface
1425
2401
if use_ipv6:
1426
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.
1427
2429
socketserver.TCPServer.__init__(self, server_address,
1428
2430
RequestHandlerClass)
2431
1429
2432
def server_bind(self):
1430
2433
"""This overrides the normal server_bind() function
1431
2434
to bind to an interface if one was specified, and also NOT to
1432
2435
bind to an address or port if they were not specified."""
1433
2436
if self.interface is not None:
1434
2437
if SO_BINDTODEVICE is None:
1435
logger.error(u"SO_BINDTODEVICE does not exist;"
1436
u" cannot bind to interface %s",
2438
logger.error("SO_BINDTODEVICE does not exist;"
2439
" cannot bind to interface %s",
1437
2440
self.interface)
1438
2441
else:
1439
2442
try:
1440
self.socket.setsockopt(socket.SOL_SOCKET,
1441
SO_BINDTODEVICE,
1442
str(self.interface
1443
+ u'\0'))
1444
except socket.error, error:
1445
if error[0] == errno.EPERM:
1446
logger.error(u"No permission to"
1447
u" bind to interface %s",
1448
self.interface)
1449
elif error[0] == errno.ENOPROTOOPT:
1450
logger.error(u"SO_BINDTODEVICE not available;"
1451
u" cannot bind to interface %s",
1452
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)
1453
2457
else:
1454
2458
raise
1455
2459
# Only bind(2) the socket if we really need to.
1456
2460
if self.server_address[0] or self.server_address[1]:
1457
2461
if not self.server_address[0]:
1458
2462
if self.address_family == socket.AF_INET6:
1459
any_address = u"::" # in6addr_any
2463
any_address = "::" # in6addr_any
1460
2464
else:
1461
any_address = socket.INADDR_ANY
2465
any_address = "0.0.0.0" # INADDR_ANY
1462
2466
self.server_address = (any_address,
1463
2467
self.server_address[1])
1464
2468
elif not self.server_address[1]:
1465
self.server_address = (self.server_address[0],
1466
0)
2469
self.server_address = (self.server_address[0], 0)
1467
2470
# if self.interface:
1468
2471
# self.server_address = (self.server_address[0],
1469
2472
# 0, # port
1481
2484
gnutls_priority GnuTLS priority string
1482
2485
use_dbus: Boolean; to emit D-Bus signals or not
1483
2486
1484
Assumes a gobject.MainLoop event loop.
2487
Assumes a GLib.MainLoop event loop.
1485
2488
"""
2489
1486
2490
def __init__(self, server_address, RequestHandlerClass,
1487
interface=None, use_ipv6=True, clients=None,
1488
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):
1489
2497
self.enabled = False
1490
2498
self.clients = clients
1491
2499
if self.clients is None:
1492
self.clients = set()
2500
self.clients = {}
1493
2501
self.use_dbus = use_dbus
1494
2502
self.gnutls_priority = gnutls_priority
1495
2503
IPv6_TCPServer.__init__(self, server_address,
1496
2504
RequestHandlerClass,
1497
2505
interface = interface,
1498
use_ipv6 = use_ipv6)
2506
use_ipv6 = use_ipv6,
2507
socketfd = socketfd)
2508
1499
2509
def server_activate(self):
1500
2510
if self.enabled:
1501
2511
return socketserver.TCPServer.server_activate(self)
2512
1502
2513
def enable(self):
1503
2514
self.enabled = True
1504
def add_pipe(self, parent_pipe):
2515
2516
def add_pipe(self, parent_pipe, proc):
1505
2517
# Call "handle_ipc" for both data and EOF events
1506
gobject.io_add_watch(parent_pipe.fileno(),
1507
gobject.IO_IN | gobject.IO_HUP,
1508
functools.partial(self.handle_ipc,
1509
parent_pipe = parent_pipe))
1510
1511
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,
1512
2528
client_object=None):
1513
condition_names = {
1514
gobject.IO_IN: u"IN", # There is data to read.
1515
gobject.IO_OUT: u"OUT", # Data can be written (without
1516
# blocking).
1517
gobject.IO_PRI: u"PRI", # There is urgent data to read.
1518
gobject.IO_ERR: u"ERR", # Error condition.
1519
gobject.IO_HUP: u"HUP" # Hung up (the connection has been
1520
# broken, usually for pipes and
1521
# sockets).
1522
}
1523
conditions_string = ' | '.join(name
1524
for cond, name in
1525
condition_names.iteritems()
1526
if cond & condition)
1527
# error or the other end of multiprocessing.Pipe has closed
1528
if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
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()
1529
2533
return False
1530
2534
1531
2535
# Read a request from the child
1536
2540
fpr = request[1]
1537
2541
address = request[2]
1538
2542
1539
for c in self.clients:
2543
for c in self.clients.values():
1540
2544
if c.fingerprint == fpr:
1541
2545
client = c
1542
2546
break
1543
2547
else:
1544
logger.warning(u"Client not found for fingerprint: %s, ad"
1545
u"dress: %s", fpr, address)
2548
logger.info("Client not found for fingerprint: %s, ad"
2549
"dress: %s", fpr, address)
1546
2550
if self.use_dbus:
1547
2551
# Emit D-Bus signal
1548
mandos_dbus_service.ClientNotFound(fpr, address[0])
2552
mandos_dbus_service.ClientNotFound(fpr,
2553
address[0])
1549
2554
parent_pipe.send(False)
1550
2555
return False
1551
2556
1552
gobject.io_add_watch(parent_pipe.fileno(),
1553
gobject.IO_IN | gobject.IO_HUP,
1554
functools.partial(self.handle_ipc,
1555
parent_pipe = parent_pipe,
1556
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))
1557
2564
parent_pipe.send(True)
1558
# 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
1559
2567
return False
1560
2568
if command == 'funcall':
1561
2569
funcname = request[1]
1562
2570
args = request[2]
1563
2571
kwargs = request[3]
1564
2572
1565
parent_pipe.send(('data', getattr(client_object, funcname)(*args, **kwargs)))
1566
2573
parent_pipe.send(('data', getattr(client_object,
2574
funcname)(*args,
2575
**kwargs)))
2576
1567
2577
if command == 'getattr':
1568
2578
attrname = request[1]
1569
if callable(client_object.__getattribute__(attrname)):
1570
parent_pipe.send(('function',))
2579
if isinstance(client_object.__getattribute__(attrname),
2580
collections.Callable):
2581
parent_pipe.send(('function', ))
1571
2582
else:
1572
parent_pipe.send(('data', client_object.__getattribute__(attrname)))
2583
parent_pipe.send((
2584
'data', client_object.__getattribute__(attrname)))
1573
2585
1574
2586
if command == 'setattr':
1575
2587
attrname = request[1]
1576
2588
value = request[2]
1577
2589
setattr(client_object, attrname, value)
1578
2590
1579
2591
return True
1580
2592
1581
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
1582
2690
def string_to_delta(interval):
1583
2691
"""Parse a string and return a datetime.timedelta
1584
2692
1585
>>> string_to_delta(u'7d')
2693
>>> string_to_delta('7d')
1586
2694
datetime.timedelta(7)
1587
>>> string_to_delta(u'60s')
2695
>>> string_to_delta('60s')
1588
2696
datetime.timedelta(0, 60)
1589
>>> string_to_delta(u'60m')
2697
>>> string_to_delta('60m')
1590
2698
datetime.timedelta(0, 3600)
1591
>>> string_to_delta(u'24h')
2699
>>> string_to_delta('24h')
1592
2700
datetime.timedelta(1)
1593
>>> string_to_delta(u'1w')
2701
>>> string_to_delta('1w')
1594
2702
datetime.timedelta(7)
1595
>>> string_to_delta(u'5m 30s')
2703
>>> string_to_delta('5m 30s')
1596
2704
datetime.timedelta(0, 330)
1597
2705
"""
2706
2707
try:
2708
return rfc3339_duration_to_delta(interval)
2709
except ValueError:
2710
pass
2711
1598
2712
timevalue = datetime.timedelta(0)
1599
2713
for s in interval.split():
1600
2714
try:
1601
suffix = unicode(s[-1])
2715
suffix = s[-1]
1602
2716
value = int(s[:-1])
1603
if suffix == u"d":
2717
if suffix == "d":
1604
2718
delta = datetime.timedelta(value)
1605
elif suffix == u"s":
2719
elif suffix == "s":
1606
2720
delta = datetime.timedelta(0, value)
1607
elif suffix == u"m":
2721
elif suffix == "m":
1608
2722
delta = datetime.timedelta(0, 0, 0, 0, value)
1609
elif suffix == u"h":
2723
elif suffix == "h":
1610
2724
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
1611
elif suffix == u"w":
2725
elif suffix == "w":
1612
2726
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
1613
2727
else:
1614
raise ValueError(u"Unknown suffix %r" % suffix)
1615
except (ValueError, IndexError), e:
1616
raise ValueError(e.message)
2728
raise ValueError("Unknown suffix {!r}".format(suffix))
2729
except IndexError as e:
2730
raise ValueError(*(e.args))
1617
2731
timevalue += delta
1618
2732
return timevalue
1619
2733
1620
2734
1621
def if_nametoindex(interface):
1622
"""Call the C function if_nametoindex(), or equivalent
1623
1624
Note: This function cannot accept a unicode string."""
1625
global if_nametoindex
1626
try:
1627
if_nametoindex = (ctypes.cdll.LoadLibrary
1628
(ctypes.util.find_library(u"c"))
1629
.if_nametoindex)
1630
except (OSError, AttributeError):
1631
logger.warning(u"Doing if_nametoindex the hard way")
1632
def if_nametoindex(interface):
1633
"Get an interface index the hard way, i.e. using fcntl()"
1634
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
1635
with contextlib.closing(socket.socket()) as s:
1636
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1637
struct.pack(str(u"16s16x"),
1638
interface))
1639
interface_index = struct.unpack(str(u"I"),
1640
ifreq[16:20])[0]
1641
return interface_index
1642
return if_nametoindex(interface)
1643
1644
1645
2735
def daemon(nochdir = False, noclose = False):
1646
2736
"""See daemon(3). Standard BSD Unix function.
1647
2737
1650
2740
sys.exit()
1651
2741
os.setsid()
1652
2742
if not nochdir:
1653
os.chdir(u"/")
2743
os.chdir("/")
1654
2744
if os.fork():
1655
2745
sys.exit()
1656
2746
if not noclose:
1657
2747
# Close all standard open file descriptors
1658
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2748
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1659
2749
if not stat.S_ISCHR(os.fstat(null).st_mode):
1660
2750
raise OSError(errno.ENODEV,
1661
u"%s not a character device"
1662
% os.path.devnull)
2751
"{} not a character device"
2752
.format(os.devnull))
1663
2753
os.dup2(null, sys.stdin.fileno())
1664
2754
os.dup2(null, sys.stdout.fileno())
1665
2755
os.dup2(null, sys.stderr.fileno())
1672
2762
##################################################################
1673
2763
# Parsing of options, both command line and config file
1674
2764
1675
parser = optparse.OptionParser(version = "%%prog %s" % version)
1676
parser.add_option("-i", u"--interface", type=u"string",
1677
metavar="IF", help=u"Bind to interface IF")
1678
parser.add_option("-a", u"--address", type=u"string",
1679
help=u"Address to listen for requests on")
1680
parser.add_option("-p", u"--port", type=u"int",
1681
help=u"Port number to receive requests on")
1682
parser.add_option("--check", action=u"store_true",
1683
help=u"Run self-test")
1684
parser.add_option("--debug", action=u"store_true",
1685
help=u"Debug mode; run in foreground and log to"
1686
u" terminal")
1687
parser.add_option("--debuglevel", type=u"string", metavar="LEVEL",
1688
help=u"Debug level for stdout output")
1689
parser.add_option("--priority", type=u"string", help=u"GnuTLS"
1690
u" priority string (see GnuTLS documentation)")
1691
parser.add_option("--servicename", type=u"string",
1692
metavar=u"NAME", help=u"Zeroconf service name")
1693
parser.add_option("--configdir", type=u"string",
1694
default=u"/etc/mandos", metavar=u"DIR",
1695
help=u"Directory to search for configuration"
1696
u" files")
1697
parser.add_option("--no-dbus", action=u"store_false",
1698
dest=u"use_dbus", help=u"Do not provide D-Bus"
1699
u" system bus interface")
1700
parser.add_option("--no-ipv6", action=u"store_false",
1701
dest=u"use_ipv6", help=u"Do not use IPv6")
1702
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()
1703
2811
1704
2812
if options.check:
1705
2813
import doctest
1706
doctest.testmod()
1707
sys.exit()
2814
fail_count, test_count = doctest.testmod()
2815
sys.exit(os.EX_OK if fail_count == 0 else 1)
1708
2816
1709
2817
# Default values for config file for server-global settings
1710
server_defaults = { u"interface": u"",
1711
u"address": u"",
1712
u"port": u"",
1713
u"debug": u"False",
1714
u"priority":
1715
u"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1716
u"servicename": u"Mandos",
1717
u"use_dbus": u"True",
1718
u"use_ipv6": u"True",
1719
u"debuglevel": u"",
1720
}
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
}
1721
2835
1722
2836
# Parse config file for server-global settings
1723
2837
server_config = configparser.SafeConfigParser(server_defaults)
1724
2838
del server_defaults
1725
server_config.read(os.path.join(options.configdir,
1726
u"mandos.conf"))
2839
server_config.read(os.path.join(options.configdir, "mandos.conf"))
1727
2840
# Convert the SafeConfigParser object to a dict
1728
2841
server_settings = server_config.defaults()
1729
2842
# Use the appropriate methods on the non-string config options
1730
for option in (u"debug", u"use_dbus", u"use_ipv6"):
1731
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",
1732
2845
option)
1733
2846
if server_settings["port"]:
1734
server_settings["port"] = server_config.getint(u"DEFAULT",
1735
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"])
1736
2858
del server_config
1737
2859
1738
2860
# Override the settings from the config file with command line
1739
2861
# options, if set.
1740
for option in (u"interface", u"address", u"port", u"debug",
1741
u"priority", u"servicename", u"configdir",
1742
u"use_dbus", u"use_ipv6", u"debuglevel"):
2862
for option in ("interface", "address", "port", "debug",
2863
"priority", "servicename", "configdir", "use_dbus",
2864
"use_ipv6", "debuglevel", "restore", "statedir",
2865
"socket", "foreground", "zeroconf"):
1743
2866
value = getattr(options, option)
1744
2867
if value is not None:
1745
2868
server_settings[option] = value
1746
2869
del options
1747
2870
# Force all strings to be unicode
1748
2871
for option in server_settings.keys():
1749
if type(server_settings[option]) is str:
1750
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
1751
2882
# Now we have our good server settings in "server_settings"
1752
2883
1753
2884
##################################################################
1754
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
1755
2891
# For convenience
1756
debug = server_settings[u"debug"]
1757
debuglevel = server_settings[u"debuglevel"]
1758
use_dbus = server_settings[u"use_dbus"]
1759
use_ipv6 = server_settings[u"use_ipv6"]
1760
1761
if server_settings[u"servicename"] != u"Mandos":
1762
syslogger.setFormatter(logging.Formatter
1763
(u'Mandos (%s) [%%(process)d]:'
1764
u' %%(levelname)s: %%(message)s'
1765
% 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"])))
1766
2915
1767
2916
# Parse config file with clients
1768
client_defaults = { u"timeout": u"1h",
1769
u"interval": u"5m",
1770
u"checker": u"fping -q -- %%(host)s",
1771
u"host": u"",
1772
u"approval_delay": u"0s",
1773
u"approval_duration": u"1s",
1774
}
1775
client_config = configparser.SafeConfigParser(client_defaults)
1776
client_config.read(os.path.join(server_settings[u"configdir"],
1777
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"))
1778
2921
1779
2922
global mandos_dbus_service
1780
2923
mandos_dbus_service = None
1781
2924
1782
tcp_server = MandosServer((server_settings[u"address"],
1783
server_settings[u"port"]),
1784
ClientHandler,
1785
interface=(server_settings[u"interface"]
1786
or None),
1787
use_ipv6=use_ipv6,
1788
gnutls_priority=
1789
server_settings[u"priority"],
1790
use_dbus=use_dbus)
1791
if not debug:
1792
pidfilename = u"/var/run/mandos.pid"
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
1793
2941
try:
1794
pidfile = open(pidfilename, u"w")
1795
except IOError:
1796
logger.error(u"Could not open file %r", pidfilename)
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)
1797
2946
1798
try:
1799
uid = pwd.getpwnam(u"_mandos").pw_uid
1800
gid = pwd.getpwnam(u"_mandos").pw_gid
1801
except KeyError:
2947
for name, group in (("_mandos", "_mandos"),
2948
("mandos", "mandos"),
2949
("nobody", "nogroup")):
1802
2950
try:
1803
uid = pwd.getpwnam(u"mandos").pw_uid
1804
gid = pwd.getpwnam(u"mandos").pw_gid
2951
uid = pwd.getpwnam(name).pw_uid
2952
gid = pwd.getpwnam(group).pw_gid
2953
break
1805
2954
except KeyError:
1806
try:
1807
uid = pwd.getpwnam(u"nobody").pw_uid
1808
gid = pwd.getpwnam(u"nobody").pw_gid
1809
except KeyError:
1810
uid = 65534
1811
gid = 65534
2955
continue
2956
else:
2957
uid = 65534
2958
gid = 65534
1812
2959
try:
1813
2960
os.setgid(gid)
1814
2961
os.setuid(uid)
1815
except OSError, error:
1816
if error[0] != errno.EPERM:
1817
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
1818
2970
1819
if not debug and not debuglevel:
1820
syslogger.setLevel(logging.WARNING)
1821
console.setLevel(logging.WARNING)
1822
if debuglevel:
1823
level = getattr(logging, debuglevel.upper())
1824
syslogger.setLevel(level)
1825
console.setLevel(level)
1826
1827
2971
if debug:
1828
2972
# Enable all possible GnuTLS debugging
1829
2973
1830
2974
# "Use a log level over 10 to enable all debugging options."
1831
2975
# - GnuTLS manual
1832
gnutls.library.functions.gnutls_global_set_log_level(11)
2976
gnutls.global_set_log_level(11)
1833
2977
1834
@gnutls.library.types.gnutls_log_func
2978
@gnutls.log_func
1835
2979
def debug_gnutls(level, string):
1836
logger.debug(u"GnuTLS: %s", string[:-1])
2980
logger.debug("GnuTLS: %s", string[:-1])
1837
2981
1838
(gnutls.library.functions
1839
.gnutls_global_set_log_function(debug_gnutls))
2982
gnutls.global_set_log_function(debug_gnutls)
1840
2983
1841
2984
# Redirect stdin so all checkers get /dev/null
1842
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2985
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1843
2986
os.dup2(null, sys.stdin.fileno())
1844
2987
if null > 2:
1845
2988
os.close(null)
1846
else:
1847
# No console logging
1848
logger.removeHandler(console)
1849
2989
1850
2990
# Need to fork before connecting to D-Bus
1851
if not debug:
2991
if not foreground:
1852
2992
# Close all input and output, do double fork, etc.
1853
2993
daemon()
1854
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()
2998
1855
2999
global main_loop
1856
3000
# From the Avahi example code
1857
DBusGMainLoop(set_as_default=True )
1858
main_loop = gobject.MainLoop()
3001
DBusGMainLoop(set_as_default=True)
3002
main_loop = GLib.MainLoop()
1859
3003
bus = dbus.SystemBus()
1860
3004
# End of Avahi example code
1861
3005
if use_dbus:
1862
3006
try:
1863
bus_name = dbus.service.BusName(u"se.bsnet.fukt.Mandos",
1864
bus, do_not_queue=True)
1865
except dbus.exceptions.NameExistsException, e:
1866
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)
1867
3015
use_dbus = False
1868
server_settings[u"use_dbus"] = False
3016
server_settings["use_dbus"] = False
1869
3017
tcp_server.use_dbus = False
1870
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1871
service = AvahiService(name = server_settings[u"servicename"],
1872
servicetype = u"_mandos._tcp",
1873
protocol = protocol, bus = bus)
1874
if server_settings["interface"]:
1875
service.interface = (if_nametoindex
1876
(str(server_settings[u"interface"])))
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"))
1877
3028
1878
3029
global multiprocessing_manager
1879
3030
multiprocessing_manager = multiprocessing.Manager()
1881
3032
client_class = Client
1882
3033
if use_dbus:
1883
3034
client_class = functools.partial(ClientDBus, bus = bus)
1884
def client_config_items(config, section):
1885
special_settings = {
1886
"approved_by_default":
1887
lambda: config.getboolean(section,
1888
"approved_by_default"),
1889
}
1890
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))
1891
3162
try:
1892
yield (name, special_settings[name]())
1893
except KeyError:
1894
yield (name, value)
1895
1896
tcp_server.clients.update(set(
1897
client_class(name = section,
1898
config= dict(client_config_items(
1899
client_config, section)))
1900
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
1901
3188
if not tcp_server.clients:
1902
logger.warning(u"No clients defined")
1903
1904
if not debug:
1905
try:
1906
with pidfile:
1907
pid = os.getpid()
1908
pidfile.write(str(pid) + "\n")
1909
del pidfile
1910
except IOError:
1911
logger.error(u"Could not write to file %r with PID %d",
1912
pidfilename, pid)
1913
except NameError:
1914
# "pidfile" was never created
1915
pass
3189
logger.warning("No clients defined")
3190
3191
if not foreground:
3192
if pidfile is not None:
3193
pid = os.getpid()
3194
try:
3195
with pidfile:
3196
print(pid, file=pidfile)
3197
except IOError:
3198
logger.error("Could not write to file %r with PID %d",
3199
pidfilename, pid)
3200
del pidfile
1916
3201
del pidfilename
3202
3203
for termsig in (signal.SIGHUP, signal.SIGTERM):
3204
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3205
lambda: main_loop.quit() and False)
3206
3207
if use_dbus:
1917
3208
1918
signal.signal(signal.SIGINT, signal.SIG_IGN)
1919
1920
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1921
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
1922
1923
if use_dbus:
1924
class MandosDBusService(dbus.service.Object):
3209
@alternate_dbus_interfaces(
3210
{ "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
3211
class MandosDBusService(DBusObjectWithObjectManager):
1925
3212
"""A D-Bus proxy object"""
3213
1926
3214
def __init__(self):
1927
dbus.service.Object.__init__(self, bus, u"/")
1928
_interface = u"se.bsnet.fukt.Mandos"
1929
1930
@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")
1931
3220
def ClientAdded(self, objpath):
1932
3221
"D-Bus signal"
1933
3222
pass
1934
3223
1935
@dbus.service.signal(_interface, signature=u"ss")
3224
@dbus.service.signal(_interface, signature="ss")
1936
3225
def ClientNotFound(self, fingerprint, address):
1937
3226
"D-Bus signal"
1938
3227
pass
1939
3228
1940
@dbus.service.signal(_interface, signature=u"os")
3229
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3230
"true"})
3231
@dbus.service.signal(_interface, signature="os")
1941
3232
def ClientRemoved(self, objpath, name):
1942
3233
"D-Bus signal"
1943
3234
pass
1944
3235
1945
@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")
1946
3239
def GetAllClients(self):
1947
3240
"D-Bus method"
1948
return dbus.Array(c.dbus_object_path
1949
for c in tcp_server.clients)
3241
return dbus.Array(c.dbus_object_path for c in
3242
tcp_server.clients.values())
1950
3243
3244
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3245
"true"})
1951
3246
@dbus.service.method(_interface,
1952
out_signature=u"a{oa{sv}}")
3247
out_signature="a{oa{sv}}")
1953
3248
def GetAllClientsWithProperties(self):
1954
3249
"D-Bus method"
1955
3250
return dbus.Dictionary(
1956
((c.dbus_object_path, c.GetAll(u""))
1957
for c in tcp_server.clients),
1958
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}")
1959
3255
1960
@dbus.service.method(_interface, in_signature=u"o")
3256
@dbus.service.method(_interface, in_signature="o")
1961
3257
def RemoveClient(self, object_path):
1962
3258
"D-Bus method"
1963
for c in tcp_server.clients:
3259
for c in tcp_server.clients.values():
1964
3260
if c.dbus_object_path == object_path:
1965
tcp_server.clients.remove(c)
3261
del tcp_server.clients[c.name]
1966
3262
c.remove_from_connection()
1967
# Don't signal anything except ClientRemoved
3263
# Don't signal the disabling
1968
3264
c.disable(quiet=True)
1969
# Emit D-Bus signal
1970
self.ClientRemoved(object_path, c.name)
3265
# Emit D-Bus signal for removal
3266
self.client_removed_signal(c)
1971
3267
return
1972
3268
raise KeyError(object_path)
1973
3269
1974
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)
1975
3307
1976
3308
mandos_dbus_service = MandosDBusService()
1977
3309
1978
3310
def cleanup():
1979
3311
"Cleanup function; run on exit"
1980
service.cleanup()
1981
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
1982
3374
while tcp_server.clients:
1983
client = tcp_server.clients.pop()
3375
name, client = tcp_server.clients.popitem()
1984
3376
if use_dbus:
1985
3377
client.remove_from_connection()
1986
client.disable_hook = None
1987
# Don't signal anything except ClientRemoved
3378
# Don't signal the disabling
1988
3379
client.disable(quiet=True)
3380
# Emit D-Bus signal for removal
1989
3381
if use_dbus:
1990
# Emit D-Bus signal
1991
mandos_dbus_service.ClientRemoved(client.dbus_object_path,
1992
client.name)
3382
mandos_dbus_service.client_removed_signal(client)
3383
client_settings.clear()
1993
3384
1994
3385
atexit.register(cleanup)
1995
3386
1996
for client in tcp_server.clients:
3387
for client in tcp_server.clients.values():
1997
3388
if use_dbus:
1998
# Emit D-Bus signal
1999
mandos_dbus_service.ClientAdded(client.dbus_object_path)
2000
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()
2001
3394
2002
3395
tcp_server.enable()
2003
3396
tcp_server.server_activate()
2004
3397
2005
3398
# Find out what port we got
2006
service.port = tcp_server.socket.getsockname()[1]
3399
if zeroconf:
3400
service.port = tcp_server.socket.getsockname()[1]
2007
3401
if use_ipv6:
2008
logger.info(u"Now listening on address %r, port %d,"
2009
" flowinfo %d, scope_id %d"
2010
% 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())
2011
3405
else: # IPv4
2012
logger.info(u"Now listening on address %r, port %d"
2013
% tcp_server.socket.getsockname())
3406
logger.info("Now listening on address %r, port %d",
3407
*tcp_server.socket.getsockname())
2014
3408
2015
3409
#service.interface = tcp_server.socket.getsockname()[3]
2016
3410
2017
3411
try:
2018
# From the Avahi example code
2019
try:
2020
service.activate()
2021
except dbus.exceptions.DBusException, error:
2022
logger.critical(u"DBusException: %s", error)
2023
cleanup()
2024
sys.exit(1)
2025
# End of Avahi example code
2026
2027
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2028
lambda *args, **kwargs:
2029
(tcp_server.handle_request
2030
(*args[2:], **kwargs) or True))
2031
2032
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")
2033
3428
main_loop.run()
2034
except AvahiError, error:
2035
logger.critical(u"AvahiError: %s", error)
3429
except AvahiError as error:
3430
logger.critical("Avahi Error", exc_info=error)
2036
3431
cleanup()
2037
3432
sys.exit(1)
2038
3433
except KeyboardInterrupt:
2039
3434
if debug:
2040
print >> sys.stderr
2041
logger.debug(u"Server received KeyboardInterrupt")
2042
logger.debug(u"Server exiting")
3435
print("", file=sys.stderr)
3436
logger.debug("Server received KeyboardInterrupt")
3437
logger.debug("Server exiting")
2043
3438
# Must run before the D-Bus bus name gets deregistered
2044
3439
cleanup()
2045
3440
3441
2046
3442
if __name__ == '__main__':
2047
3443
main()
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0