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