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