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