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