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 581
- compare with another revision
- download diff
- download tarball
- view history from revision 581
- Committer: Teddy Hogeborn
- Date: 2012-05-12 15:45:57 UTC
- Revision ID: teddy@recompile.se-20120512154557-r1yzcb8su8byp4us
* mandos (Client.enable, Client.disable, ClientDBus.approve): Call
self.send_changedstate() after change, not before.
(Client.disable): Bug fix: Handle disable_initiator_tag and
checker_initiator_tag of 0.
(Client.init_checker): Bug fix: Remove old checker_initiator_tag and
disable_initiator_tag, if any.
(Client.bump_timeout): Bug fix: Remove old disable_initiator_tag, if
any.
(ClientDBus.Timeout_dbus_property): Bug fix: Use self.expires.
(ClientHandler.handle): Bug fix: timedelta_to_milliseconds is a
global function, not a class method.
* mandos-monitor (MandosClientWidget._update_timer_callback_lock):
Removed. All users changed.
(MandosClientWidget.last_checked_ok): Removed (unused).
(MandosClientWidget.__init__): Don't call self.using_timer().
(MandosClientWidget.property_changed): Removed unused version.
(MandosClientWidget.using_timer): Stop using the counter
self._update_timer_callback_lock;
be strictly boolean.
(MandosClientWidget.need_approval): Don't call self.using_timer().
(MandosClientWidget.update): Call self.using_timer() throughout.
Bug fix: Never show negative timers.
self.send_changedstate() after change, not before.
(Client.disable): Bug fix: Handle disable_initiator_tag and
checker_initiator_tag of 0.
(Client.init_checker): Bug fix: Remove old checker_initiator_tag and
disable_initiator_tag, if any.
(Client.bump_timeout): Bug fix: Remove old disable_initiator_tag, if
any.
(ClientDBus.Timeout_dbus_property): Bug fix: Use self.expires.
(ClientHandler.handle): Bug fix: timedelta_to_milliseconds is a
global function, not a class method.
* mandos-monitor (MandosClientWidget._update_timer_callback_lock):
Removed. All users changed.
(MandosClientWidget.last_checked_ok): Removed (unused).
(MandosClientWidget.__init__): Don't call self.using_timer().
(MandosClientWidget.property_changed): Removed unused version.
(MandosClientWidget.using_timer): Stop using the counter
self._update_timer_callback_lock;
be strictly boolean.
(MandosClientWidget.need_approval): Don't call self.using_timer().
(MandosClientWidget.update): Call self.using_timer() throughout.
Bug fix: Never show negative timers.
- 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.14"
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):
950
577
self.last_enabled = datetime.datetime.utcnow()
951
578
self.init_checker()
952
579
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):
958
585
if not quiet:
959
586
logger.info("Disabling client %s", self.name)
960
587
if getattr(self, "disable_initiator_tag", None) is not None:
961
GLib.source_remove(self.disable_initiator_tag)
588
gobject.source_remove(self.disable_initiator_tag)
962
589
self.disable_initiator_tag = None
963
590
self.expires = None
964
591
if getattr(self, "checker_initiator_tag", None) is not None:
965
GLib.source_remove(self.checker_initiator_tag)
592
gobject.source_remove(self.checker_initiator_tag)
966
593
self.checker_initiator_tag = None
967
594
self.stop_checker()
968
595
self.enabled = False
969
596
if not quiet:
970
597
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
607
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)
608
gobject.source_remove(self.checker_initiator_tag)
609
self.checker_initiator_tag = (gobject.timeout_add
610
(self.interval_milliseconds(),
611
self.start_checker))
985
612
# Schedule a disable() when 'timeout' has passed
986
613
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)
614
gobject.source_remove(self.disable_initiator_tag)
615
self.disable_initiator_tag = (gobject.timeout_add
616
(self.timeout_milliseconds(),
617
self.disable))
990
618
# Also start a new checker *right now*.
991
619
self.start_checker()
992
993
def checker_callback(self, source, condition, connection,
994
command):
620
621
def checker_callback(self, pid, condition, command):
995
622
"""The checker has completed, so take appropriate actions."""
996
623
self.checker_callback_tag = None
997
624
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
625
if os.WIFEXITED(condition):
626
self.last_checker_status = os.WEXITSTATUS(condition)
1005
627
if self.last_checker_status == 0:
1006
628
logger.info("Checker for %(name)s succeeded",
1007
629
vars(self))
1008
630
self.checked_ok()
1009
631
else:
1010
logger.info("Checker for %(name)s failed", vars(self))
632
logger.info("Checker for %(name)s failed",
633
vars(self))
1011
634
else:
1012
635
self.last_checker_status = -1
1013
self.last_checker_signal = -returncode
1014
636
logger.warning("Checker for %(name)s crashed?",
1015
637
vars(self))
1016
return False
1017
638
1018
639
def checked_ok(self):
1019
640
"""Assert that the client has been seen, alive and well."""
1020
641
self.last_checked_ok = datetime.datetime.utcnow()
1021
642
self.last_checker_status = 0
1022
self.last_checker_signal = None
1023
643
self.bump_timeout()
1024
644
1025
645
def bump_timeout(self, timeout=None):
1026
646
"""Bump up the timeout for this client."""
1027
647
if timeout is None:
1028
648
timeout = self.timeout
1029
649
if self.disable_initiator_tag is not None:
1030
GLib.source_remove(self.disable_initiator_tag)
650
gobject.source_remove(self.disable_initiator_tag)
1031
651
self.disable_initiator_tag = None
1032
652
if getattr(self, "enabled", False):
1033
self.disable_initiator_tag = GLib.timeout_add(
1034
int(timeout.total_seconds() * 1000), self.disable)
653
self.disable_initiator_tag = (gobject.timeout_add
654
(timedelta_to_milliseconds
655
(timeout), self.disable))
1035
656
self.expires = datetime.datetime.utcnow() + timeout
1036
657
1037
658
def need_approval(self):
1038
659
self.last_approval_request = datetime.datetime.utcnow()
1039
660
1040
661
def start_checker(self):
1041
662
"""Start a new checker subprocess if one is not running.
1042
663
1043
664
If a checker already exists, leave it running and do
1044
665
nothing."""
1045
666
# The reason for not killing a running checker is that if we
1050
671
# checkers alone, the checker would have to take more time
1051
672
# than 'timeout' for the client to be disabled, which is as it
1052
673
# 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
674
675
# If a checker exists, make sure it is not a zombie
676
try:
677
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
678
except (AttributeError, OSError) as error:
679
if (isinstance(error, OSError)
680
and error.errno != errno.ECHILD):
681
raise error
682
else:
683
if pid:
684
logger.warning("Checker was a zombie")
685
gobject.source_remove(self.checker_callback_tag)
686
self.checker_callback(pid, status,
687
self.current_checker_command)
1058
688
# Start a new checker if needed
1059
689
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,
690
try:
691
# In case checker_command has exactly one % operator
692
command = self.checker_command % self.host
693
except TypeError:
694
# Escape attributes for the shell
695
escaped_attrs = dict(
696
(attr,
697
re.escape(unicode(str(getattr(self, attr, "")),
698
errors=
699
'replace')))
700
for attr in
701
self.runtime_expansions)
702
703
try:
704
command = self.checker_command % escaped_attrs
705
except TypeError as error:
706
logger.error('Could not format string "%s"',
707
self.checker_command, exc_info=error)
708
return True # Try again later
709
self.current_checker_command = command
710
try:
711
logger.info("Starting checker %r for %s",
712
command, self.name)
713
# We don't need to redirect stdout and stderr, since
714
# in normal mode, that is already done by daemon(),
715
# and in debug mode we don't want to. (Stdin is
716
# always replaced by /dev/null.)
717
self.checker = subprocess.Popen(command,
718
close_fds=True,
719
shell=True, cwd="/")
720
self.checker_callback_tag = (gobject.child_watch_add
721
(self.checker.pid,
722
self.checker_callback,
723
data=command))
724
# The checker may have completed before the gobject
725
# watch was added. Check for this.
726
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
727
if pid:
728
gobject.source_remove(self.checker_callback_tag)
729
self.checker_callback(pid, status, command)
730
except OSError as error:
731
logger.error("Failed to start subprocess",
1069
732
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
733
# Re-run this periodically if run by gobject.timeout_add
1098
734
return True
1099
735
1100
736
def stop_checker(self):
1101
737
"""Force the checker process, if any, to stop."""
1102
738
if self.checker_callback_tag:
1103
GLib.source_remove(self.checker_callback_tag)
739
gobject.source_remove(self.checker_callback_tag)
1104
740
self.checker_callback_tag = None
1105
741
if getattr(self, "checker", None) is None:
1106
742
return
1107
743
logger.debug("Stopping checker for %(name)s", vars(self))
1108
self.checker.terminate()
744
try:
745
self.checker.terminate()
746
#time.sleep(0.5)
747
#if self.checker.poll() is None:
748
# self.checker.kill()
749
except OSError as error:
750
if error.errno != errno.ESRCH: # No such process
751
raise
1109
752
self.checker = None
1110
753
1111
754
1112
def dbus_service_property(dbus_interface,
1113
signature="v",
1114
access="readwrite",
1115
byte_arrays=False):
755
def dbus_service_property(dbus_interface, signature="v",
756
access="readwrite", byte_arrays=False):
1116
757
"""Decorators for marking methods of a DBusObjectWithProperties to
1117
758
become properties on the D-Bus.
1118
759
1119
760
The decorated method will be called with no arguments by "Get"
1120
761
and with one argument by "Set".
1121
762
1122
763
The parameters, where they are supported, are the same as
1123
764
dbus.service.method, except there is only "signature", since the
1124
765
type from Get() and the type sent to Set() is the same.
1127
768
# "Set" method, so we fail early here:
1128
769
if byte_arrays and signature != "ay":
1129
770
raise ValueError("Byte arrays not supported for non-'ay'"
1130
" signature {!r}".format(signature))
1131
771
" signature {0!r}".format(signature))
1132
772
def decorator(func):
1133
773
func._dbus_is_property = True
1134
774
func._dbus_interface = dbus_interface
1137
777
func._dbus_name = func.__name__
1138
778
if func._dbus_name.endswith("_dbus_property"):
1139
779
func._dbus_name = func._dbus_name[:-14]
1140
func._dbus_get_args_options = {'byte_arrays': byte_arrays}
780
func._dbus_get_args_options = {'byte_arrays': byte_arrays }
1141
781
return func
1142
1143
782
return decorator
1144
783
1145
784
1146
785
def dbus_interface_annotations(dbus_interface):
1147
786
"""Decorator for marking functions returning interface annotations
1148
787
1149
788
Usage:
1150
789
1151
790
@dbus_interface_annotations("org.example.Interface")
1152
791
def _foo(self): # Function name does not matter
1153
792
return {"org.freedesktop.DBus.Deprecated": "true",
1154
793
"org.freedesktop.DBus.Property.EmitsChangedSignal":
1155
794
"false"}
1156
795
"""
1157
1158
796
def decorator(func):
1159
797
func._dbus_is_interface = True
1160
798
func._dbus_interface = dbus_interface
1161
799
func._dbus_name = dbus_interface
1162
800
return func
1163
1164
801
return decorator
1165
802
1166
803
1167
804
def dbus_annotations(annotations):
1168
805
"""Decorator to annotate D-Bus methods, signals or properties
1169
806
Usage:
1170
1171
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
1172
"org.freedesktop.DBus.Property."
1173
"EmitsChangedSignal": "false"})
807
1174
808
@dbus_service_property("org.example.Interface", signature="b",
1175
809
access="r")
810
@dbus_annotations({{"org.freedesktop.DBus.Deprecated": "true",
811
"org.freedesktop.DBus.Property."
812
"EmitsChangedSignal": "false"})
1176
813
def Property_dbus_property(self):
1177
814
return dbus.Boolean(False)
1178
1179
See also the DBusObjectWithAnnotations class.
1180
815
"""
1181
1182
816
def decorator(func):
1183
817
func._dbus_annotations = annotations
1184
818
return func
1185
1186
819
return decorator
1187
820
1188
821
1189
822
class DBusPropertyException(dbus.exceptions.DBusException):
1190
823
"""A base class for D-Bus property-related exceptions
1191
824
"""
1192
pass
825
def __unicode__(self):
826
return unicode(str(self))
1193
827
1194
828
1195
829
class DBusPropertyAccessException(DBusPropertyException):
1204
838
pass
1205
839
1206
840
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.
841
class DBusObjectWithProperties(dbus.service.Object):
842
"""A D-Bus object with properties.
843
844
Classes inheriting from this can use the dbus_service_property
845
decorator to expose methods as D-Bus properties. It exposes the
846
standard Get(), Set(), and GetAll() methods on the D-Bus.
1212
847
"""
1213
848
1214
849
@staticmethod
1215
850
def _is_dbus_thing(thing):
1216
851
"""Returns a function testing if an attribute is a D-Bus thing
1217
852
1218
853
If called like _is_dbus_thing("method") it returns a function
1219
854
suitable for use as predicate to inspect.getmembers().
1220
855
"""
1221
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
856
return lambda obj: getattr(obj, "_dbus_is_{0}".format(thing),
1222
857
False)
1223
858
1224
859
def _get_all_dbus_things(self, thing):
1225
860
"""Returns a generator of (name, attribute) pairs
1226
861
"""
1227
return ((getattr(athing.__get__(self), "_dbus_name", name),
862
return ((getattr(athing.__get__(self), "_dbus_name",
863
name),
1228
864
athing.__get__(self))
1229
865
for cls in self.__class__.__mro__
1230
866
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
867
inspect.getmembers(cls,
868
self._is_dbus_thing(thing)))
869
1304
870
def _get_dbus_property(self, interface_name, property_name):
1305
871
"""Returns a bound method if one exists which is a D-Bus
1306
872
property with the specified name and interface.
1307
873
"""
1308
for cls in self.__class__.__mro__:
1309
for name, value in inspect.getmembers(
1310
cls, self._is_dbus_thing("property")):
874
for cls in self.__class__.__mro__:
875
for name, value in (inspect.getmembers
876
(cls,
877
self._is_dbus_thing("property"))):
1311
878
if (value._dbus_name == property_name
1312
879
and value._dbus_interface == interface_name):
1313
880
return value.__get__(self)
1314
881
1315
882
# 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",
883
raise DBusPropertyNotFound(self.dbus_object_path + ":"
884
+ interface_name + "."
885
+ property_name)
886
887
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
1330
888
out_signature="v")
1331
889
def Get(self, interface_name, property_name):
1332
890
"""Standard D-Bus property Get() method, see D-Bus standard.
1338
896
if not hasattr(value, "variant_level"):
1339
897
return value
1340
898
return type(value)(value, variant_level=value.variant_level+1)
1341
899
1342
900
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
1343
901
def Set(self, interface_name, property_name, value):
1344
902
"""Standard D-Bus property Set() method, see D-Bus standard.
1350
908
# The byte_arrays option is not supported yet on
1351
909
# signatures other than "ay".
1352
910
if prop._dbus_signature != "ay":
1353
raise ValueError("Byte arrays not supported for non-"
1354
"'ay' signature {!r}"
1355
.format(prop._dbus_signature))
911
raise ValueError
1356
912
value = dbus.ByteArray(b''.join(chr(byte)
1357
913
for byte in value))
1358
914
prop(value)
1359
1360
@dbus.service.method(dbus.PROPERTIES_IFACE,
1361
in_signature="s",
915
916
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
1362
917
out_signature="a{sv}")
1363
918
def GetAll(self, interface_name):
1364
919
"""Standard D-Bus property GetAll() method, see D-Bus
1365
920
standard.
1366
921
1367
922
Note: Will not include properties with access="write".
1368
923
"""
1369
924
properties = {}
1379
934
if not hasattr(value, "variant_level"):
1380
935
properties[name] = value
1381
936
continue
1382
properties[name] = type(value)(
1383
value, variant_level=value.variant_level + 1)
937
properties[name] = type(value)(value, variant_level=
938
value.variant_level+1)
1384
939
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
940
1394
941
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1395
942
out_signature="s",
1396
943
path_keyword='object_path',
1397
944
connection_keyword='connection')
1398
945
def Introspect(self, object_path, connection):
1399
946
"""Overloading of standard D-Bus method.
1400
947
1401
948
Inserts property tags and interface annotation tags.
1402
949
"""
1403
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1404
object_path,
1405
connection)
950
xmlstring = dbus.service.Object.Introspect(self, object_path,
951
connection)
1406
952
try:
1407
953
document = xml.dom.minidom.parseString(xmlstring)
1408
1409
954
def make_tag(document, name, prop):
1410
955
e = document.createElement("property")
1411
956
e.setAttribute("name", name)
1412
957
e.setAttribute("type", prop._dbus_signature)
1413
958
e.setAttribute("access", prop._dbus_access)
1414
959
return e
1415
1416
960
for if_tag in document.getElementsByTagName("interface"):
1417
961
# Add property tags
1418
962
for tag in (make_tag(document, name, prop)
1421
965
if prop._dbus_interface
1422
966
== if_tag.getAttribute("name")):
1423
967
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)
968
# Add annotation tags
969
for typ in ("method", "signal", "property"):
970
for tag in if_tag.getElementsByTagName(typ):
971
annots = dict()
972
for name, prop in (self.
973
_get_all_dbus_things(typ)):
974
if (name == tag.getAttribute("name")
975
and prop._dbus_interface
976
== if_tag.getAttribute("name")):
977
annots.update(getattr
978
(prop,
979
"_dbus_annotations",
980
{}))
981
for name, value in annots.iteritems():
982
ann_tag = document.createElement(
983
"annotation")
984
ann_tag.setAttribute("name", name)
985
ann_tag.setAttribute("value", value)
986
tag.appendChild(ann_tag)
987
# Add interface annotation tags
988
for annotation, value in dict(
989
itertools.chain.from_iterable(
990
annotations().iteritems()
991
for name, annotations in
992
self._get_all_dbus_things("interface")
993
if name == if_tag.getAttribute("name")
994
)).iteritems():
995
ann_tag = document.createElement("annotation")
996
ann_tag.setAttribute("name", annotation)
997
ann_tag.setAttribute("value", value)
998
if_tag.appendChild(ann_tag)
1440
999
# Add the names to the return values for the
1441
1000
# "org.freedesktop.DBus.Properties" methods
1442
1001
if (if_tag.getAttribute("name")
1461
1020
return xmlstring
1462
1021
1463
1022
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):
1023
def datetime_to_dbus (dt, variant_level=0):
1536
1024
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1537
1025
if dt is None:
1538
return dbus.String("", variant_level=variant_level)
1539
return dbus.String(dt.isoformat(), variant_level=variant_level)
1026
return dbus.String("", variant_level = variant_level)
1027
return dbus.String(dt.isoformat(),
1028
variant_level=variant_level)
1540
1029
1541
1030
1542
1031
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1544
1033
dbus.service.Object, it will add alternate D-Bus attributes with
1545
1034
interface names according to the "alt_interface_names" mapping.
1546
1035
Usage:
1547
1548
@alternate_dbus_interfaces({"org.example.Interface":
1549
"net.example.AlternateInterface"})
1036
1037
@alternate_dbus_names({"org.example.Interface":
1038
"net.example.AlternateInterface"})
1550
1039
class SampleDBusObject(dbus.service.Object):
1551
1040
@dbus.service.method("org.example.Interface")
1552
1041
def SampleDBusMethod():
1553
1042
pass
1554
1043
1555
1044
The above "SampleDBusMethod" on "SampleDBusObject" will be
1556
1045
reachable via two interfaces: "org.example.Interface" and
1557
1046
"net.example.AlternateInterface", the latter of which will have
1558
1047
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1559
1048
"true", unless "deprecate" is passed with a False value.
1560
1049
1561
1050
This works for methods and signals, and also for D-Bus properties
1562
1051
(from DBusObjectWithProperties) and interfaces (from the
1563
1052
dbus_interface_annotations decorator).
1564
1053
"""
1565
1566
1054
def wrapper(cls):
1567
1055
for orig_interface_name, alt_interface_name in (
1568
alt_interface_names.items()):
1056
alt_interface_names.iteritems()):
1569
1057
attr = {}
1570
1058
interface_names = set()
1571
1059
# Go though all attributes of the class
1573
1061
# Ignore non-D-Bus attributes, and D-Bus attributes
1574
1062
# with the wrong interface name
1575
1063
if (not hasattr(attribute, "_dbus_interface")
1576
or not attribute._dbus_interface.startswith(
1577
orig_interface_name)):
1064
or not attribute._dbus_interface
1065
.startswith(orig_interface_name)):
1578
1066
continue
1579
1067
# Create an alternate D-Bus interface name based on
1580
1068
# the current name
1581
alt_interface = attribute._dbus_interface.replace(
1582
orig_interface_name, alt_interface_name)
1069
alt_interface = (attribute._dbus_interface
1070
.replace(orig_interface_name,
1071
alt_interface_name))
1583
1072
interface_names.add(alt_interface)
1584
1073
# Is this a D-Bus signal?
1585
1074
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(
1075
# Extract the original non-method function by
1076
# black magic
1077
nonmethod_func = (dict(
1590
1078
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)
1079
attribute.__closure__))["func"]
1080
.cell_contents)
1598
1081
# Create a new, but exactly alike, function
1599
1082
# object, and decorate it to be a new D-Bus signal
1600
1083
# 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))
1084
new_function = (dbus.service.signal
1085
(alt_interface,
1086
attribute._dbus_signature)
1087
(types.FunctionType(
1088
nonmethod_func.func_code,
1089
nonmethod_func.func_globals,
1090
nonmethod_func.func_name,
1091
nonmethod_func.func_defaults,
1092
nonmethod_func.func_closure)))
1605
1093
# Copy annotations, if any
1606
1094
try:
1607
new_function._dbus_annotations = dict(
1608
attribute._dbus_annotations)
1095
new_function._dbus_annotations = (
1096
dict(attribute._dbus_annotations))
1609
1097
except AttributeError:
1610
1098
pass
1611
1612
1099
# Define a creator of a function to call both the
1613
1100
# original and alternate functions, so both the
1614
1101
# original and alternate signals gets sent when
1617
1104
"""This function is a scope container to pass
1618
1105
func1 and func2 to the "call_both" function
1619
1106
outside of its arguments"""
1620
1621
@functools.wraps(func2)
1622
1107
def call_both(*args, **kwargs):
1623
1108
"""This function will emit two D-Bus
1624
1109
signals by calling func1 and func2"""
1625
1110
func1(*args, **kwargs)
1626
1111
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
1112
return call_both
1634
1113
# Create the "call_both" function and add it to
1635
1114
# the class
1640
1119
# object. Decorate it to be a new D-Bus method
1641
1120
# with the alternate D-Bus interface name. Add it
1642
1121
# 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)))
1122
attr[attrname] = (dbus.service.method
1123
(alt_interface,
1124
attribute._dbus_in_signature,
1125
attribute._dbus_out_signature)
1126
(types.FunctionType
1127
(attribute.func_code,
1128
attribute.func_globals,
1129
attribute.func_name,
1130
attribute.func_defaults,
1131
attribute.func_closure)))
1649
1132
# Copy annotations, if any
1650
1133
try:
1651
attr[attrname]._dbus_annotations = dict(
1652
attribute._dbus_annotations)
1134
attr[attrname]._dbus_annotations = (
1135
dict(attribute._dbus_annotations))
1653
1136
except AttributeError:
1654
1137
pass
1655
1138
# Is this a D-Bus property?
1658
1141
# object, and decorate it to be a new D-Bus
1659
1142
# property with the alternate D-Bus interface
1660
1143
# 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)))
1144
attr[attrname] = (dbus_service_property
1145
(alt_interface,
1146
attribute._dbus_signature,
1147
attribute._dbus_access,
1148
attribute
1149
._dbus_get_args_options
1150
["byte_arrays"])
1151
(types.FunctionType
1152
(attribute.func_code,
1153
attribute.func_globals,
1154
attribute.func_name,
1155
attribute.func_defaults,
1156
attribute.func_closure)))
1667
1157
# Copy annotations, if any
1668
1158
try:
1669
attr[attrname]._dbus_annotations = dict(
1670
attribute._dbus_annotations)
1159
attr[attrname]._dbus_annotations = (
1160
dict(attribute._dbus_annotations))
1671
1161
except AttributeError:
1672
1162
pass
1673
1163
# Is this a D-Bus interface?
1676
1166
# object. Decorate it to be a new D-Bus interface
1677
1167
# with the alternate D-Bus interface name. Add it
1678
1168
# to the class.
1679
attr[attrname] = (
1680
dbus_interface_annotations(alt_interface)
1681
(copy_function(attribute)))
1169
attr[attrname] = (dbus_interface_annotations
1170
(alt_interface)
1171
(types.FunctionType
1172
(attribute.func_code,
1173
attribute.func_globals,
1174
attribute.func_name,
1175
attribute.func_defaults,
1176
attribute.func_closure)))
1682
1177
if deprecate:
1683
1178
# Deprecate all alternate interfaces
1684
iname = "_AlternateDBusNames_interface_annotation{}"
1179
iname="_AlternateDBusNames_interface_annotation{0}"
1685
1180
for interface_name in interface_names:
1686
1687
1181
@dbus_interface_annotations(interface_name)
1688
1182
def func(self):
1689
return {"org.freedesktop.DBus.Deprecated":
1690
"true"}
1183
return { "org.freedesktop.DBus.Deprecated":
1184
"true" }
1691
1185
# Find an unused name
1692
1186
for aname in (iname.format(i)
1693
1187
for i in itertools.count()):
1697
1191
if interface_names:
1698
1192
# Replace the class with a new subclass of it with
1699
1193
# 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)
1194
cls = type(b"{0}Alternate".format(cls.__name__),
1195
(cls,), attr)
1706
1196
return cls
1707
1708
1197
return wrapper
1709
1198
1710
1199
1711
1200
@alternate_dbus_interfaces({"se.recompile.Mandos":
1712
"se.bsnet.fukt.Mandos"})
1201
"se.bsnet.fukt.Mandos"})
1713
1202
class ClientDBus(Client, DBusObjectWithProperties):
1714
1203
"""A Client class using D-Bus
1715
1204
1716
1205
Attributes:
1717
1206
dbus_object_path: dbus.ObjectPath
1718
1207
bus: dbus.SystemBus()
1719
1208
"""
1720
1209
1721
1210
runtime_expansions = (Client.runtime_expansions
1722
+ ("dbus_object_path", ))
1723
1724
_interface = "se.recompile.Mandos.Client"
1725
1211
+ ("dbus_object_path",))
1212
1726
1213
# dbus.service.Object doesn't use super(), so we can't either.
1727
1728
def __init__(self, bus=None, *args, **kwargs):
1214
1215
def __init__(self, bus = None, *args, **kwargs):
1729
1216
self.bus = bus
1730
1217
Client.__init__(self, *args, **kwargs)
1731
1218
# Only now, when this client is initialized, can it show up on
1732
1219
# the D-Bus
1733
client_object_name = str(self.name).translate(
1220
client_object_name = unicode(self.name).translate(
1734
1221
{ord("."): ord("_"),
1735
1222
ord("-"): ord("_")})
1736
self.dbus_object_path = dbus.ObjectPath(
1737
"/clients/" + client_object_name)
1223
self.dbus_object_path = (dbus.ObjectPath
1224
("/clients/" + client_object_name))
1738
1225
DBusObjectWithProperties.__init__(self, self.bus,
1739
1226
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):
1227
1228
def notifychangeproperty(transform_func,
1229
dbus_name, type_func=lambda x: x,
1230
variant_level=1):
1746
1231
""" Modify a variable so that it's a property which announces
1747
1232
its changes to DBus.
1748
1233
1749
1234
transform_fun: Function that takes a value and a variant_level
1750
1235
and transforms it to a D-Bus type.
1751
1236
dbus_name: D-Bus name of the variable
1753
1238
to the D-Bus. Default: no transform
1754
1239
variant_level: D-Bus variant level. Default: 1
1755
1240
"""
1756
attrname = "_{}".format(dbus_name)
1757
1241
attrname = "_{0}".format(dbus_name)
1758
1242
def setter(self, value):
1759
1243
if hasattr(self, "dbus_object_path"):
1760
1244
if (not hasattr(self, attrname) or
1761
1245
type_func(getattr(self, attrname, None))
1762
1246
!= 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())
1247
dbus_value = transform_func(type_func(value),
1248
variant_level
1249
=variant_level)
1250
self.PropertyChanged(dbus.String(dbus_name),
1251
dbus_value)
1778
1252
setattr(self, attrname, value)
1779
1253
1780
1254
return property(lambda self: getattr(self, attrname), setter)
1781
1255
1782
1256
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1783
1257
approvals_pending = notifychangeproperty(dbus.Boolean,
1784
1258
"ApprovalPending",
1785
type_func=bool)
1259
type_func = bool)
1786
1260
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1787
1261
last_enabled = notifychangeproperty(datetime_to_dbus,
1788
1262
"LastEnabled")
1789
checker = notifychangeproperty(
1790
dbus.Boolean, "CheckerRunning",
1791
type_func=lambda checker: checker is not None)
1263
checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1264
type_func = lambda checker:
1265
checker is not None)
1792
1266
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1793
1267
"LastCheckedOK")
1794
1268
last_checker_status = notifychangeproperty(dbus.Int16,
1797
1271
datetime_to_dbus, "LastApprovalRequest")
1798
1272
approved_by_default = notifychangeproperty(dbus.Boolean,
1799
1273
"ApprovedByDefault")
1800
approval_delay = notifychangeproperty(
1801
dbus.UInt64, "ApprovalDelay",
1802
type_func=lambda td: td.total_seconds() * 1000)
1274
approval_delay = notifychangeproperty(dbus.UInt64,
1275
"ApprovalDelay",
1276
type_func =
1277
timedelta_to_milliseconds)
1803
1278
approval_duration = notifychangeproperty(
1804
1279
dbus.UInt64, "ApprovalDuration",
1805
type_func=lambda td: td.total_seconds() * 1000)
1280
type_func = timedelta_to_milliseconds)
1806
1281
host = notifychangeproperty(dbus.String, "Host")
1807
timeout = notifychangeproperty(
1808
dbus.UInt64, "Timeout",
1809
type_func=lambda td: td.total_seconds() * 1000)
1282
timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1283
type_func =
1284
timedelta_to_milliseconds)
1810
1285
extended_timeout = notifychangeproperty(
1811
1286
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)
1287
type_func = timedelta_to_milliseconds)
1288
interval = notifychangeproperty(dbus.UInt64,
1289
"Interval",
1290
type_func =
1291
timedelta_to_milliseconds)
1816
1292
checker_command = notifychangeproperty(dbus.String, "Checker")
1817
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1818
invalidate_only=True)
1819
1293
1820
1294
del notifychangeproperty
1821
1295
1822
1296
def __del__(self, *args, **kwargs):
1823
1297
try:
1824
1298
self.remove_from_connection()
1827
1301
if hasattr(DBusObjectWithProperties, "__del__"):
1828
1302
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1829
1303
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:
1304
1305
def checker_callback(self, pid, condition, command,
1306
*args, **kwargs):
1307
self.checker_callback_tag = None
1308
self.checker = None
1309
if os.WIFEXITED(condition):
1310
exitstatus = os.WEXITSTATUS(condition)
1838
1311
# Emit D-Bus signal
1839
1312
self.CheckerCompleted(dbus.Int16(exitstatus),
1840
# This is specific to GNU libC
1841
dbus.Int64(exitstatus << 8),
1313
dbus.Int64(condition),
1842
1314
dbus.String(command))
1843
1315
else:
1844
1316
# Emit D-Bus signal
1845
1317
self.CheckerCompleted(dbus.Int16(-1),
1846
dbus.Int64(
1847
# This is specific to GNU libC
1848
(exitstatus << 8)
1849
| self.last_checker_signal),
1318
dbus.Int64(condition),
1850
1319
dbus.String(command))
1851
return ret
1852
1320
1321
return Client.checker_callback(self, pid, condition, command,
1322
*args, **kwargs)
1323
1853
1324
def start_checker(self, *args, **kwargs):
1854
old_checker_pid = getattr(self.checker, "pid", None)
1325
old_checker = self.checker
1326
if self.checker is not None:
1327
old_checker_pid = self.checker.pid
1328
else:
1329
old_checker_pid = None
1855
1330
r = Client.start_checker(self, *args, **kwargs)
1856
1331
# Only if new checker process was started
1857
1332
if (self.checker is not None
1859
1334
# Emit D-Bus signal
1860
1335
self.CheckerStarted(self.current_checker_command)
1861
1336
return r
1862
1337
1863
1338
def _reset_approved(self):
1864
1339
self.approved = None
1865
1340
return False
1866
1341
1867
1342
def approve(self, value=True):
1868
1343
self.approved = value
1869
GLib.timeout_add(int(self.approval_duration.total_seconds()
1870
* 1000), self._reset_approved)
1344
gobject.timeout_add(timedelta_to_milliseconds
1345
(self.approval_duration),
1346
self._reset_approved)
1871
1347
self.send_changedstate()
1872
1873
# D-Bus methods, signals & properties
1874
1875
# Interfaces
1876
1877
# Signals
1878
1348
1349
## D-Bus methods, signals & properties
1350
_interface = "se.recompile.Mandos.Client"
1351
1352
## Interfaces
1353
1354
@dbus_interface_annotations(_interface)
1355
def _foo(self):
1356
return { "org.freedesktop.DBus.Property.EmitsChangedSignal":
1357
"false"}
1358
1359
## Signals
1360
1879
1361
# CheckerCompleted - signal
1880
1362
@dbus.service.signal(_interface, signature="nxs")
1881
1363
def CheckerCompleted(self, exitcode, waitstatus, command):
1882
1364
"D-Bus signal"
1883
1365
pass
1884
1366
1885
1367
# CheckerStarted - signal
1886
1368
@dbus.service.signal(_interface, signature="s")
1887
1369
def CheckerStarted(self, command):
1888
1370
"D-Bus signal"
1889
1371
pass
1890
1372
1891
1373
# PropertyChanged - signal
1892
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1893
1374
@dbus.service.signal(_interface, signature="sv")
1894
1375
def PropertyChanged(self, property, value):
1895
1376
"D-Bus signal"
1896
1377
pass
1897
1378
1898
1379
# GotSecret - signal
1899
1380
@dbus.service.signal(_interface)
1900
1381
def GotSecret(self):
1903
1384
server to mandos-client
1904
1385
"""
1905
1386
pass
1906
1387
1907
1388
# Rejected - signal
1908
1389
@dbus.service.signal(_interface, signature="s")
1909
1390
def Rejected(self, reason):
1910
1391
"D-Bus signal"
1911
1392
pass
1912
1393
1913
1394
# NeedApproval - signal
1914
1395
@dbus.service.signal(_interface, signature="tb")
1915
1396
def NeedApproval(self, timeout, default):
1916
1397
"D-Bus signal"
1917
1398
return self.need_approval()
1918
1919
# Methods
1920
1399
1400
## Methods
1401
1921
1402
# Approve - method
1922
1403
@dbus.service.method(_interface, in_signature="b")
1923
1404
def Approve(self, value):
1924
1405
self.approve(value)
1925
1406
1926
1407
# CheckedOK - method
1927
1408
@dbus.service.method(_interface)
1928
1409
def CheckedOK(self):
1929
1410
self.checked_ok()
1930
1411
1931
1412
# Enable - method
1932
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1933
1413
@dbus.service.method(_interface)
1934
1414
def Enable(self):
1935
1415
"D-Bus method"
1936
1416
self.enable()
1937
1417
1938
1418
# StartChecker - method
1939
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1940
1419
@dbus.service.method(_interface)
1941
1420
def StartChecker(self):
1942
1421
"D-Bus method"
1943
1422
self.start_checker()
1944
1423
1945
1424
# Disable - method
1946
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1947
1425
@dbus.service.method(_interface)
1948
1426
def Disable(self):
1949
1427
"D-Bus method"
1950
1428
self.disable()
1951
1429
1952
1430
# StopChecker - method
1953
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1954
1431
@dbus.service.method(_interface)
1955
1432
def StopChecker(self):
1956
1433
self.stop_checker()
1957
1958
# Properties
1959
1434
1435
## Properties
1436
1960
1437
# ApprovalPending - property
1961
1438
@dbus_service_property(_interface, signature="b", access="read")
1962
1439
def ApprovalPending_dbus_property(self):
1963
1440
return dbus.Boolean(bool(self.approvals_pending))
1964
1441
1965
1442
# ApprovedByDefault - property
1966
@dbus_service_property(_interface,
1967
signature="b",
1443
@dbus_service_property(_interface, signature="b",
1968
1444
access="readwrite")
1969
1445
def ApprovedByDefault_dbus_property(self, value=None):
1970
1446
if value is None: # get
1971
1447
return dbus.Boolean(self.approved_by_default)
1972
1448
self.approved_by_default = bool(value)
1973
1449
1974
1450
# ApprovalDelay - property
1975
@dbus_service_property(_interface,
1976
signature="t",
1451
@dbus_service_property(_interface, signature="t",
1977
1452
access="readwrite")
1978
1453
def ApprovalDelay_dbus_property(self, value=None):
1979
1454
if value is None: # get
1980
return dbus.UInt64(self.approval_delay.total_seconds()
1981
* 1000)
1455
return dbus.UInt64(self.approval_delay_milliseconds())
1982
1456
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1983
1457
1984
1458
# ApprovalDuration - property
1985
@dbus_service_property(_interface,
1986
signature="t",
1459
@dbus_service_property(_interface, signature="t",
1987
1460
access="readwrite")
1988
1461
def ApprovalDuration_dbus_property(self, value=None):
1989
1462
if value is None: # get
1990
return dbus.UInt64(self.approval_duration.total_seconds()
1991
* 1000)
1463
return dbus.UInt64(timedelta_to_milliseconds(
1464
self.approval_duration))
1992
1465
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1993
1466
1994
1467
# Name - property
1995
@dbus_annotations(
1996
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1997
1468
@dbus_service_property(_interface, signature="s", access="read")
1998
1469
def Name_dbus_property(self):
1999
1470
return dbus.String(self.name)
2000
1471
2001
1472
# Fingerprint - property
2002
@dbus_annotations(
2003
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2004
1473
@dbus_service_property(_interface, signature="s", access="read")
2005
1474
def Fingerprint_dbus_property(self):
2006
1475
return dbus.String(self.fingerprint)
2007
1476
2008
1477
# Host - property
2009
@dbus_service_property(_interface,
2010
signature="s",
1478
@dbus_service_property(_interface, signature="s",
2011
1479
access="readwrite")
2012
1480
def Host_dbus_property(self, value=None):
2013
1481
if value is None: # get
2014
1482
return dbus.String(self.host)
2015
self.host = str(value)
2016
1483
self.host = unicode(value)
1484
2017
1485
# Created - property
2018
@dbus_annotations(
2019
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2020
1486
@dbus_service_property(_interface, signature="s", access="read")
2021
1487
def Created_dbus_property(self):
2022
1488
return datetime_to_dbus(self.created)
2023
1489
2024
1490
# LastEnabled - property
2025
1491
@dbus_service_property(_interface, signature="s", access="read")
2026
1492
def LastEnabled_dbus_property(self):
2027
1493
return datetime_to_dbus(self.last_enabled)
2028
1494
2029
1495
# Enabled - property
2030
@dbus_service_property(_interface,
2031
signature="b",
1496
@dbus_service_property(_interface, signature="b",
2032
1497
access="readwrite")
2033
1498
def Enabled_dbus_property(self, value=None):
2034
1499
if value is None: # get
2037
1502
self.enable()
2038
1503
else:
2039
1504
self.disable()
2040
1505
2041
1506
# LastCheckedOK - property
2042
@dbus_service_property(_interface,
2043
signature="s",
1507
@dbus_service_property(_interface, signature="s",
2044
1508
access="readwrite")
2045
1509
def LastCheckedOK_dbus_property(self, value=None):
2046
1510
if value is not None:
2047
1511
self.checked_ok()
2048
1512
return
2049
1513
return datetime_to_dbus(self.last_checked_ok)
2050
1514
2051
1515
# LastCheckerStatus - property
2052
@dbus_service_property(_interface, signature="n", access="read")
1516
@dbus_service_property(_interface, signature="n",
1517
access="read")
2053
1518
def LastCheckerStatus_dbus_property(self):
2054
1519
return dbus.Int16(self.last_checker_status)
2055
1520
2056
1521
# Expires - property
2057
1522
@dbus_service_property(_interface, signature="s", access="read")
2058
1523
def Expires_dbus_property(self):
2059
1524
return datetime_to_dbus(self.expires)
2060
1525
2061
1526
# LastApprovalRequest - property
2062
1527
@dbus_service_property(_interface, signature="s", access="read")
2063
1528
def LastApprovalRequest_dbus_property(self):
2064
1529
return datetime_to_dbus(self.last_approval_request)
2065
1530
2066
1531
# Timeout - property
2067
@dbus_service_property(_interface,
2068
signature="t",
1532
@dbus_service_property(_interface, signature="t",
2069
1533
access="readwrite")
2070
1534
def Timeout_dbus_property(self, value=None):
2071
1535
if value is None: # get
2072
return dbus.UInt64(self.timeout.total_seconds() * 1000)
1536
return dbus.UInt64(self.timeout_milliseconds())
2073
1537
old_timeout = self.timeout
2074
1538
self.timeout = datetime.timedelta(0, 0, 0, value)
2075
1539
# Reschedule disabling
2083
1547
if (getattr(self, "disable_initiator_tag", None)
2084
1548
is None):
2085
1549
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
1550
gobject.source_remove(self.disable_initiator_tag)
1551
self.disable_initiator_tag = (
1552
gobject.timeout_add(
1553
timedelta_to_milliseconds(self.expires - now),
1554
self.disable))
1555
2091
1556
# ExtendedTimeout - property
2092
@dbus_service_property(_interface,
2093
signature="t",
1557
@dbus_service_property(_interface, signature="t",
2094
1558
access="readwrite")
2095
1559
def ExtendedTimeout_dbus_property(self, value=None):
2096
1560
if value is None: # get
2097
return dbus.UInt64(self.extended_timeout.total_seconds()
2098
* 1000)
1561
return dbus.UInt64(self.extended_timeout_milliseconds())
2099
1562
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
2100
1563
2101
1564
# Interval - property
2102
@dbus_service_property(_interface,
2103
signature="t",
1565
@dbus_service_property(_interface, signature="t",
2104
1566
access="readwrite")
2105
1567
def Interval_dbus_property(self, value=None):
2106
1568
if value is None: # get
2107
return dbus.UInt64(self.interval.total_seconds() * 1000)
1569
return dbus.UInt64(self.interval_milliseconds())
2108
1570
self.interval = datetime.timedelta(0, 0, 0, value)
2109
1571
if getattr(self, "checker_initiator_tag", None) is None:
2110
1572
return
2111
1573
if self.enabled:
2112
1574
# 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
1575
gobject.source_remove(self.checker_initiator_tag)
1576
self.checker_initiator_tag = (gobject.timeout_add
1577
(value, self.start_checker))
1578
self.start_checker() # Start one now, too
1579
2118
1580
# Checker - property
2119
@dbus_service_property(_interface,
2120
signature="s",
1581
@dbus_service_property(_interface, signature="s",
2121
1582
access="readwrite")
2122
1583
def Checker_dbus_property(self, value=None):
2123
1584
if value is None: # get
2124
1585
return dbus.String(self.checker_command)
2125
self.checker_command = str(value)
2126
1586
self.checker_command = unicode(value)
1587
2127
1588
# CheckerRunning - property
2128
@dbus_service_property(_interface,
2129
signature="b",
1589
@dbus_service_property(_interface, signature="b",
2130
1590
access="readwrite")
2131
1591
def CheckerRunning_dbus_property(self, value=None):
2132
1592
if value is None: # get
2135
1595
self.start_checker()
2136
1596
else:
2137
1597
self.stop_checker()
2138
1598
2139
1599
# ObjectPath - property
2140
@dbus_annotations(
2141
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
2142
"org.freedesktop.DBus.Deprecated": "true"})
2143
1600
@dbus_service_property(_interface, signature="o", access="read")
2144
1601
def ObjectPath_dbus_property(self):
2145
return self.dbus_object_path # is already a dbus.ObjectPath
2146
1602
return self.dbus_object_path # is already a dbus.ObjectPath
1603
2147
1604
# 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)
1605
@dbus_service_property(_interface, signature="ay",
1606
access="write", byte_arrays=True)
2155
1607
def Secret_dbus_property(self, value):
2156
self.secret = bytes(value)
2157
1608
self.secret = str(value)
1609
2158
1610
del _interface
2159
1611
2160
1612
2163
1615
self._pipe = child_pipe
2164
1616
self._pipe.send(('init', fpr, address))
2165
1617
if not self._pipe.recv():
2166
raise KeyError(fpr)
2167
1618
raise KeyError()
1619
2168
1620
def __getattribute__(self, name):
2169
1621
if name == '_pipe':
2170
1622
return super(ProxyClient, self).__getattribute__(name)
2173
1625
if data[0] == 'data':
2174
1626
return data[1]
2175
1627
if data[0] == 'function':
2176
2177
1628
def func(*args, **kwargs):
2178
1629
self._pipe.send(('funcall', name, args, kwargs))
2179
1630
return self._pipe.recv()[1]
2180
2181
1631
return func
2182
1632
2183
1633
def __setattr__(self, name, value):
2184
1634
if name == '_pipe':
2185
1635
return super(ProxyClient, self).__setattr__(name, value)
2188
1638
2189
1639
class ClientHandler(socketserver.BaseRequestHandler, object):
2190
1640
"""A class to handle client connections.
2191
1641
2192
1642
Instantiated once for each connection to handle it.
2193
1643
Note: This will run in its own forked process."""
2194
1644
2195
1645
def handle(self):
2196
1646
with contextlib.closing(self.server.child_pipe) as child_pipe:
2197
1647
logger.info("TCP connection from: %s",
2198
str(self.client_address))
1648
unicode(self.client_address))
2199
1649
logger.debug("Pipe FD: %d",
2200
1650
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"))
1651
1652
session = (gnutls.connection
1653
.ClientSession(self.request,
1654
gnutls.connection
1655
.X509Credentials()))
1656
1657
# Note: gnutls.connection.X509Credentials is really a
1658
# generic GnuTLS certificate credentials object so long as
1659
# no X.509 keys are added to it. Therefore, we can use it
1660
# here despite using OpenPGP certificates.
1661
1662
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1663
# "+AES-256-CBC", "+SHA1",
1664
# "+COMP-NULL", "+CTYPE-OPENPGP",
1665
# "+DHE-DSS"))
2208
1666
# Use a fallback default, since this MUST be set.
2209
1667
priority = self.server.gnutls_priority
2210
1668
if priority is None:
2211
1669
priority = "NORMAL"
2212
gnutls.priority_set_direct(session._c_object,
2213
priority.encode("utf-8"),
2214
None)
2215
1670
(gnutls.library.functions
1671
.gnutls_priority_set_direct(session._c_object,
1672
priority, None))
1673
2216
1674
# Start communication using the Mandos protocol
2217
1675
# Get protocol number
2218
1676
line = self.request.makefile().readline()
2219
1677
logger.debug("Protocol version: %r", line)
2220
1678
try:
2221
1679
if int(line.strip().split()[0]) > 1:
2222
raise RuntimeError(line)
1680
raise RuntimeError
2223
1681
except (ValueError, IndexError, RuntimeError) as error:
2224
1682
logger.error("Unknown protocol version: %s", error)
2225
1683
return
2226
1684
2227
1685
# Start GnuTLS connection
2228
1686
try:
2229
1687
session.handshake()
2230
except gnutls.Error as error:
1688
except gnutls.errors.GNUTLSError as error:
2231
1689
logger.warning("Handshake failed: %s", error)
2232
1690
# Do not run session.bye() here: the session is not
2233
1691
# established. Just abandon the request.
2234
1692
return
2235
1693
logger.debug("Handshake succeeded")
2236
1694
2237
1695
approval_required = False
2238
1696
try:
2239
1697
try:
2240
fpr = self.fingerprint(
2241
self.peer_certificate(session))
2242
except (TypeError, gnutls.Error) as error:
1698
fpr = self.fingerprint(self.peer_certificate
1699
(session))
1700
except (TypeError,
1701
gnutls.errors.GNUTLSError) as error:
2243
1702
logger.warning("Bad certificate: %s", error)
2244
1703
return
2245
1704
logger.debug("Fingerprint: %s", fpr)
2246
1705
2247
1706
try:
2248
1707
client = ProxyClient(child_pipe, fpr,
2249
1708
self.client_address)
2250
1709
except KeyError:
2251
1710
return
2252
1711
2253
1712
if client.approval_delay:
2254
1713
delay = client.approval_delay
2255
1714
client.approvals_pending += 1
2256
1715
approval_required = True
2257
1716
2258
1717
while True:
2259
1718
if not client.enabled:
2260
1719
logger.info("Client %s is disabled",
2261
client.name)
1720
client.name)
2262
1721
if self.server.use_dbus:
2263
1722
# Emit D-Bus signal
2264
1723
client.Rejected("Disabled")
2265
1724
return
2266
1725
2267
1726
if client.approved or not client.approval_delay:
2268
# We are approved or approval is disabled
1727
#We are approved or approval is disabled
2269
1728
break
2270
1729
elif client.approved is None:
2271
1730
logger.info("Client %s needs approval",
2273
1732
if self.server.use_dbus:
2274
1733
# Emit D-Bus signal
2275
1734
client.NeedApproval(
2276
client.approval_delay.total_seconds()
2277
* 1000, client.approved_by_default)
1735
client.approval_delay_milliseconds(),
1736
client.approved_by_default)
2278
1737
else:
2279
1738
logger.warning("Client %s was not approved",
2280
1739
client.name)
2282
1741
# Emit D-Bus signal
2283
1742
client.Rejected("Denied")
2284
1743
return
2285
2286
# wait until timeout or approved
1744
1745
#wait until timeout or approved
2287
1746
time = datetime.datetime.now()
2288
1747
client.changedstate.acquire()
2289
client.changedstate.wait(delay.total_seconds())
1748
client.changedstate.wait(
1749
float(timedelta_to_milliseconds(delay)
1750
/ 1000))
2290
1751
client.changedstate.release()
2291
1752
time2 = datetime.datetime.now()
2292
1753
if (time2 - time) >= delay:
2302
1763
break
2303
1764
else:
2304
1765
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
1766
1767
sent_size = 0
1768
while sent_size < len(client.secret):
1769
try:
1770
sent = session.send(client.secret[sent_size:])
1771
except gnutls.errors.GNUTLSError as error:
1772
logger.warning("gnutls send failed",
1773
exc_info=error)
1774
return
1775
logger.debug("Sent: %d, remaining: %d",
1776
sent, len(client.secret)
1777
- (sent_size + sent))
1778
sent_size += sent
1779
2313
1780
logger.info("Sending secret to %s", client.name)
2314
1781
# bump the timeout using extended_timeout
2315
1782
client.bump_timeout(client.extended_timeout)
2316
1783
if self.server.use_dbus:
2317
1784
# Emit D-Bus signal
2318
1785
client.GotSecret()
2319
1786
2320
1787
finally:
2321
1788
if approval_required:
2322
1789
client.approvals_pending -= 1
2323
1790
try:
2324
1791
session.bye()
2325
except gnutls.Error as error:
1792
except gnutls.errors.GNUTLSError as error:
2326
1793
logger.warning("GnuTLS bye failed",
2327
1794
exc_info=error)
2328
1795
2329
1796
@staticmethod
2330
1797
def peer_certificate(session):
2331
1798
"Return the peer's OpenPGP certificate as a bytestring"
2332
1799
# 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""
1800
if (gnutls.library.functions
1801
.gnutls_certificate_type_get(session._c_object)
1802
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1803
# ...do the normal thing
1804
return session.peer_certificate
2337
1805
list_size = ctypes.c_uint(1)
2338
cert_list = (gnutls.certificate_get_peers
1806
cert_list = (gnutls.library.functions
1807
.gnutls_certificate_get_peers
2339
1808
(session._c_object, ctypes.byref(list_size)))
2340
1809
if not bool(cert_list) and list_size.value != 0:
2341
raise gnutls.Error("error getting peer certificate")
1810
raise gnutls.errors.GNUTLSError("error getting peer"
1811
" certificate")
2342
1812
if list_size.value == 0:
2343
1813
return None
2344
1814
cert = cert_list[0]
2345
1815
return ctypes.string_at(cert.data, cert.size)
2346
1816
2347
1817
@staticmethod
2348
1818
def fingerprint(openpgp):
2349
1819
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
2350
1820
# 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)))
1821
datum = (gnutls.library.types
1822
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1823
ctypes.POINTER
1824
(ctypes.c_ubyte)),
1825
ctypes.c_uint(len(openpgp))))
2355
1826
# New empty GnuTLS certificate
2356
crt = gnutls.openpgp_crt_t()
2357
gnutls.openpgp_crt_init(ctypes.byref(crt))
1827
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1828
(gnutls.library.functions
1829
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2358
1830
# Import the OpenPGP public key into the certificate
2359
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2360
gnutls.OPENPGP_FMT_RAW)
1831
(gnutls.library.functions
1832
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1833
gnutls.library.constants
1834
.GNUTLS_OPENPGP_FMT_RAW))
2361
1835
# Verify the self signature in the key
2362
1836
crtverify = ctypes.c_uint()
2363
gnutls.openpgp_crt_verify_self(crt, 0,
2364
ctypes.byref(crtverify))
1837
(gnutls.library.functions
1838
.gnutls_openpgp_crt_verify_self(crt, 0,
1839
ctypes.byref(crtverify)))
2365
1840
if crtverify.value != 0:
2366
gnutls.openpgp_crt_deinit(crt)
2367
raise gnutls.CertificateSecurityError("Verify failed")
1841
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1842
raise (gnutls.errors.CertificateSecurityError
1843
("Verify failed"))
2368
1844
# New buffer for the fingerprint
2369
1845
buf = ctypes.create_string_buffer(20)
2370
1846
buf_len = ctypes.c_size_t()
2371
1847
# Get the fingerprint from the certificate into the buffer
2372
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2373
ctypes.byref(buf_len))
1848
(gnutls.library.functions
1849
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1850
ctypes.byref(buf_len)))
2374
1851
# Deinit the certificate
2375
gnutls.openpgp_crt_deinit(crt)
1852
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2376
1853
# Convert the buffer to a Python bytestring
2377
1854
fpr = ctypes.string_at(buf, buf_len.value)
2378
1855
# Convert the bytestring to hexadecimal notation
2382
1859
2383
1860
class MultiprocessingMixIn(object):
2384
1861
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2385
2386
1862
def sub_process_main(self, request, address):
2387
1863
try:
2388
1864
self.finish_request(request, address)
2389
1865
except Exception:
2390
1866
self.handle_error(request, address)
2391
1867
self.close_request(request)
2392
1868
2393
1869
def process_request(self, request, address):
2394
1870
"""Start a new process to process the request."""
2395
proc = multiprocessing.Process(target=self.sub_process_main,
2396
args=(request, address))
1871
proc = multiprocessing.Process(target = self.sub_process_main,
1872
args = (request, address))
2397
1873
proc.start()
2398
1874
return proc
2399
1875
2400
1876
2401
1877
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2402
1878
""" adds a pipe to the MixIn """
2403
2404
1879
def process_request(self, request, client_address):
2405
1880
"""Overrides and wraps the original process_request().
2406
1881
2407
1882
This function creates a new pipe in self.pipe
2408
1883
"""
2409
1884
parent_pipe, self.child_pipe = multiprocessing.Pipe()
2410
1885
2411
1886
proc = MultiprocessingMixIn.process_request(self, request,
2412
1887
client_address)
2413
1888
self.child_pipe.close()
2414
1889
self.add_pipe(parent_pipe, proc)
2415
1890
2416
1891
def add_pipe(self, parent_pipe, proc):
2417
1892
"""Dummy function; override as necessary"""
2418
raise NotImplementedError()
1893
raise NotImplementedError
2419
1894
2420
1895
2421
1896
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2422
1897
socketserver.TCPServer, object):
2423
1898
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
2424
1899
2425
1900
Attributes:
2426
1901
enabled: Boolean; whether this server is activated yet
2427
1902
interface: None or a network interface name (string)
2428
1903
use_ipv6: Boolean; to use IPv6 or not
2429
1904
"""
2430
2431
1905
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
"""
1906
interface=None, use_ipv6=True):
2438
1907
self.interface = interface
2439
1908
if use_ipv6:
2440
1909
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
1910
socketserver.TCPServer.__init__(self, server_address,
2469
1911
RequestHandlerClass)
2470
2471
1912
def server_bind(self):
2472
1913
"""This overrides the normal server_bind() function
2473
1914
to bind to an interface if one was specified, and also NOT to
2474
1915
bind to an address or port if they were not specified."""
2475
global SO_BINDTODEVICE
2476
1916
if self.interface is not None:
2477
1917
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
1918
logger.error("SO_BINDTODEVICE does not exist;"
1919
" cannot bind to interface %s",
1920
self.interface)
1921
else:
1922
try:
1923
self.socket.setsockopt(socket.SOL_SOCKET,
1924
SO_BINDTODEVICE,
1925
str(self.interface
1926
+ '\0'))
1927
except socket.error as error:
1928
if error[0] == errno.EPERM:
1929
logger.error("No permission to"
1930
" bind to interface %s",
1931
self.interface)
1932
elif error[0] == errno.ENOPROTOOPT:
1933
logger.error("SO_BINDTODEVICE not available;"
1934
" cannot bind to interface %s",
1935
self.interface)
1936
else:
1937
raise
2499
1938
# Only bind(2) the socket if we really need to.
2500
1939
if self.server_address[0] or self.server_address[1]:
2501
1940
if not self.server_address[0]:
2502
1941
if self.address_family == socket.AF_INET6:
2503
any_address = "::" # in6addr_any
1942
any_address = "::" # in6addr_any
2504
1943
else:
2505
any_address = "0.0.0.0" # INADDR_ANY
1944
any_address = socket.INADDR_ANY
2506
1945
self.server_address = (any_address,
2507
1946
self.server_address[1])
2508
1947
elif not self.server_address[1]:
2509
self.server_address = (self.server_address[0], 0)
1948
self.server_address = (self.server_address[0],
1949
0)
2510
1950
# if self.interface:
2511
1951
# self.server_address = (self.server_address[0],
2512
1952
# 0, # port
2518
1958
2519
1959
class MandosServer(IPv6_TCPServer):
2520
1960
"""Mandos server.
2521
1961
2522
1962
Attributes:
2523
1963
clients: set of Client objects
2524
1964
gnutls_priority GnuTLS priority string
2525
1965
use_dbus: Boolean; to emit D-Bus signals or not
2526
2527
Assumes a GLib.MainLoop event loop.
1966
1967
Assumes a gobject.MainLoop event loop.
2528
1968
"""
2529
2530
1969
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):
1970
interface=None, use_ipv6=True, clients=None,
1971
gnutls_priority=None, use_dbus=True):
2537
1972
self.enabled = False
2538
1973
self.clients = clients
2539
1974
if self.clients is None:
2542
1977
self.gnutls_priority = gnutls_priority
2543
1978
IPv6_TCPServer.__init__(self, server_address,
2544
1979
RequestHandlerClass,
2545
interface=interface,
2546
use_ipv6=use_ipv6,
2547
socketfd=socketfd)
2548
1980
interface = interface,
1981
use_ipv6 = use_ipv6)
2549
1982
def server_activate(self):
2550
1983
if self.enabled:
2551
1984
return socketserver.TCPServer.server_activate(self)
2552
1985
2553
1986
def enable(self):
2554
1987
self.enabled = True
2555
1988
2556
1989
def add_pipe(self, parent_pipe, proc):
2557
1990
# 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):
1991
gobject.io_add_watch(parent_pipe.fileno(),
1992
gobject.IO_IN | gobject.IO_HUP,
1993
functools.partial(self.handle_ipc,
1994
parent_pipe =
1995
parent_pipe,
1996
proc = proc))
1997
1998
def handle_ipc(self, source, condition, parent_pipe=None,
1999
proc = None, client_object=None):
2569
2000
# error, or the other end of multiprocessing.Pipe has closed
2570
if condition & (GLib.IO_ERR | GLib.IO_HUP):
2001
if condition & (gobject.IO_ERR | gobject.IO_HUP):
2571
2002
# Wait for other process to exit
2572
2003
proc.join()
2573
2004
return False
2574
2005
2575
2006
# Read a request from the child
2576
2007
request = parent_pipe.recv()
2577
2008
command = request[0]
2578
2009
2579
2010
if command == 'init':
2580
2011
fpr = request[1]
2581
2012
address = request[2]
2582
2583
for c in self.clients.values():
2013
2014
for c in self.clients.itervalues():
2584
2015
if c.fingerprint == fpr:
2585
2016
client = c
2586
2017
break
2593
2024
address[0])
2594
2025
parent_pipe.send(False)
2595
2026
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))
2027
2028
gobject.io_add_watch(parent_pipe.fileno(),
2029
gobject.IO_IN | gobject.IO_HUP,
2030
functools.partial(self.handle_ipc,
2031
parent_pipe =
2032
parent_pipe,
2033
proc = proc,
2034
client_object =
2035
client))
2604
2036
parent_pipe.send(True)
2605
2037
# remove the old hook in favor of the new above hook on
2606
2038
# same fileno
2609
2041
funcname = request[1]
2610
2042
args = request[2]
2611
2043
kwargs = request[3]
2612
2044
2613
2045
parent_pipe.send(('data', getattr(client_object,
2614
2046
funcname)(*args,
2615
**kwargs)))
2616
2047
**kwargs)))
2048
2617
2049
if command == 'getattr':
2618
2050
attrname = request[1]
2619
if isinstance(client_object.__getattribute__(attrname),
2620
collections.Callable):
2621
parent_pipe.send(('function', ))
2051
if callable(client_object.__getattribute__(attrname)):
2052
parent_pipe.send(('function',))
2622
2053
else:
2623
parent_pipe.send((
2624
'data', client_object.__getattribute__(attrname)))
2625
2054
parent_pipe.send(('data', client_object
2055
.__getattribute__(attrname)))
2056
2626
2057
if command == 'setattr':
2627
2058
attrname = request[1]
2628
2059
value = request[2]
2629
2060
setattr(client_object, attrname, value)
2630
2061
2631
2062
return True
2632
2063
2633
2064
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
2065
def string_to_delta(interval):
2734
2066
"""Parse a string and return a datetime.timedelta
2735
2067
2736
2068
>>> string_to_delta('7d')
2737
2069
datetime.timedelta(7)
2738
2070
>>> string_to_delta('60s')
2746
2078
>>> string_to_delta('5m 30s')
2747
2079
datetime.timedelta(0, 330)
2748
2080
"""
2749
2750
try:
2751
return rfc3339_duration_to_delta(interval)
2752
except ValueError:
2753
pass
2754
2755
2081
timevalue = datetime.timedelta(0)
2756
2082
for s in interval.split():
2757
2083
try:
2758
suffix = s[-1]
2084
suffix = unicode(s[-1])
2759
2085
value = int(s[:-1])
2760
2086
if suffix == "d":
2761
2087
delta = datetime.timedelta(value)
2768
2094
elif suffix == "w":
2769
2095
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2770
2096
else:
2771
raise ValueError("Unknown suffix {!r}".format(suffix))
2772
except IndexError as e:
2097
raise ValueError("Unknown suffix {0!r}"
2098
.format(suffix))
2099
except (ValueError, IndexError) as e:
2773
2100
raise ValueError(*(e.args))
2774
2101
timevalue += delta
2775
2102
return timevalue
2776
2103
2777
2104
2778
def daemon(nochdir=False, noclose=False):
2105
def daemon(nochdir = False, noclose = False):
2779
2106
"""See daemon(3). Standard BSD Unix function.
2780
2107
2781
2108
This should really exist as os.daemon, but it doesn't (yet)."""
2782
2109
if os.fork():
2783
2110
sys.exit()
2791
2118
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2792
2119
if not stat.S_ISCHR(os.fstat(null).st_mode):
2793
2120
raise OSError(errno.ENODEV,
2794
"{} not a character device"
2121
"{0} not a character device"
2795
2122
.format(os.devnull))
2796
2123
os.dup2(null, sys.stdin.fileno())
2797
2124
os.dup2(null, sys.stdout.fileno())
2801
2128
2802
2129
2803
2130
def main():
2804
2131
2805
2132
##################################################################
2806
2133
# Parsing of options, both command line and config file
2807
2134
2808
2135
parser = argparse.ArgumentParser()
2809
2136
parser.add_argument("-v", "--version", action="version",
2810
version="%(prog)s {}".format(version),
2137
version = "%(prog)s {0}".format(version),
2811
2138
help="show version number and exit")
2812
2139
parser.add_argument("-i", "--interface", metavar="IF",
2813
2140
help="Bind to interface IF")
2819
2146
help="Run self-test")
2820
2147
parser.add_argument("--debug", action="store_true",
2821
2148
help="Debug mode; run in foreground and log"
2822
" to terminal", default=None)
2149
" to terminal")
2823
2150
parser.add_argument("--debuglevel", metavar="LEVEL",
2824
2151
help="Debug level for stdout output")
2825
2152
parser.add_argument("--priority", help="GnuTLS"
2832
2159
" files")
2833
2160
parser.add_argument("--no-dbus", action="store_false",
2834
2161
dest="use_dbus", help="Do not provide D-Bus"
2835
" system bus interface", default=None)
2162
" system bus interface")
2836
2163
parser.add_argument("--no-ipv6", action="store_false",
2837
dest="use_ipv6", help="Do not use IPv6",
2838
default=None)
2164
dest="use_ipv6", help="Do not use IPv6")
2839
2165
parser.add_argument("--no-restore", action="store_false",
2840
2166
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")
2167
" state")
2845
2168
parser.add_argument("--statedir", metavar="DIR",
2846
2169
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
2170
2853
2171
options = parser.parse_args()
2854
2172
2855
2173
if options.check:
2856
2174
import doctest
2857
fail_count, test_count = doctest.testmod()
2858
sys.exit(os.EX_OK if fail_count == 0 else 1)
2859
2175
doctest.testmod()
2176
sys.exit()
2177
2860
2178
# 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
2179
server_defaults = { "interface": "",
2180
"address": "",
2181
"port": "",
2182
"debug": "False",
2183
"priority":
2184
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
2185
"servicename": "Mandos",
2186
"use_dbus": "True",
2187
"use_ipv6": "True",
2188
"debuglevel": "",
2189
"restore": "True",
2190
"statedir": "/var/lib/mandos"
2191
}
2192
2879
2193
# Parse config file for server-global settings
2880
2194
server_config = configparser.SafeConfigParser(server_defaults)
2881
2195
del server_defaults
2882
server_config.read(os.path.join(options.configdir, "mandos.conf"))
2196
server_config.read(os.path.join(options.configdir,
2197
"mandos.conf"))
2883
2198
# Convert the SafeConfigParser object to a dict
2884
2199
server_settings = server_config.defaults()
2885
2200
# Use the appropriate methods on the non-string config options
2886
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2201
for option in ("debug", "use_dbus", "use_ipv6"):
2887
2202
server_settings[option] = server_config.getboolean("DEFAULT",
2888
2203
option)
2889
2204
if server_settings["port"]:
2890
2205
server_settings["port"] = server_config.getint("DEFAULT",
2891
2206
"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
2207
del server_config
2902
2208
2903
2209
# Override the settings from the config file with command line
2904
2210
# options, if set.
2905
2211
for option in ("interface", "address", "port", "debug",
2906
"priority", "servicename", "configdir", "use_dbus",
2907
"use_ipv6", "debuglevel", "restore", "statedir",
2908
"socket", "foreground", "zeroconf"):
2212
"priority", "servicename", "configdir",
2213
"use_dbus", "use_ipv6", "debuglevel", "restore",
2214
"statedir"):
2909
2215
value = getattr(options, option)
2910
2216
if value is not None:
2911
2217
server_settings[option] = value
2912
2218
del options
2913
2219
# Force all strings to be unicode
2914
2220
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
2221
if type(server_settings[option]) is str:
2222
server_settings[option] = unicode(server_settings[option])
2925
2223
# Now we have our good server settings in "server_settings"
2926
2224
2927
2225
##################################################################
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
2226
2934
2227
# For convenience
2935
2228
debug = server_settings["debug"]
2936
2229
debuglevel = server_settings["debuglevel"]
2938
2231
use_ipv6 = server_settings["use_ipv6"]
2939
2232
stored_state_path = os.path.join(server_settings["statedir"],
2940
2233
stored_state_file)
2941
foreground = server_settings["foreground"]
2942
zeroconf = server_settings["zeroconf"]
2943
2234
2944
2235
if debug:
2945
2236
initlogger(debug, logging.DEBUG)
2946
2237
else:
2949
2240
else:
2950
2241
level = getattr(logging, debuglevel.upper())
2951
2242
initlogger(debug, level)
2952
2243
2953
2244
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
2245
syslogger.setFormatter(logging.Formatter
2246
('Mandos ({0}) [%(process)d]:'
2247
' %(levelname)s: %(message)s'
2248
.format(server_settings
2249
["servicename"])))
2250
2959
2251
# Parse config file with clients
2960
2252
client_config = configparser.SafeConfigParser(Client
2961
2253
.client_defaults)
2962
2254
client_config.read(os.path.join(server_settings["configdir"],
2963
2255
"clients.conf"))
2964
2256
2965
2257
global mandos_dbus_service
2966
2258
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
2259
2260
tcp_server = MandosServer((server_settings["address"],
2261
server_settings["port"]),
2262
ClientHandler,
2263
interface=(server_settings["interface"]
2264
or None),
2265
use_ipv6=use_ipv6,
2266
gnutls_priority=
2267
server_settings["priority"],
2268
use_dbus=use_dbus)
2269
if not debug:
2270
pidfilename = "/var/run/mandos.pid"
2984
2271
try:
2985
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
2272
pidfile = open(pidfilename, "w")
2986
2273
except IOError as e:
2987
2274
logger.error("Could not open file %r", pidfilename,
2988
2275
exc_info=e)
2989
2990
for name, group in (("_mandos", "_mandos"),
2991
("mandos", "mandos"),
2992
("nobody", "nogroup")):
2276
2277
for name in ("_mandos", "mandos", "nobody"):
2993
2278
try:
2994
2279
uid = pwd.getpwnam(name).pw_uid
2995
gid = pwd.getpwnam(group).pw_gid
2280
gid = pwd.getpwnam(name).pw_gid
2996
2281
break
2997
2282
except KeyError:
2998
2283
continue
3002
2287
try:
3003
2288
os.setgid(gid)
3004
2289
os.setuid(uid)
3005
if debug:
3006
logger.debug("Did setuid/setgid to {}:{}".format(uid,
3007
gid))
3008
2290
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
2291
if error[0] != errno.EPERM:
2292
raise error
2293
3014
2294
if debug:
3015
2295
# Enable all possible GnuTLS debugging
3016
2296
3017
2297
# "Use a log level over 10 to enable all debugging options."
3018
2298
# - GnuTLS manual
3019
gnutls.global_set_log_level(11)
3020
3021
@gnutls.log_func
2299
gnutls.library.functions.gnutls_global_set_log_level(11)
2300
2301
@gnutls.library.types.gnutls_log_func
3022
2302
def debug_gnutls(level, string):
3023
2303
logger.debug("GnuTLS: %s", string[:-1])
3024
3025
gnutls.global_set_log_function(debug_gnutls)
3026
2304
2305
(gnutls.library.functions
2306
.gnutls_global_set_log_function(debug_gnutls))
2307
3027
2308
# Redirect stdin so all checkers get /dev/null
3028
2309
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
3029
2310
os.dup2(null, sys.stdin.fileno())
3030
2311
if null > 2:
3031
2312
os.close(null)
3032
2313
3033
2314
# Need to fork before connecting to D-Bus
3034
if not foreground:
2315
if not debug:
3035
2316
# Close all input and output, do double fork, etc.
3036
2317
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
2318
2319
gobject.threads_init()
2320
3042
2321
global main_loop
3043
2322
# From the Avahi example code
3044
2323
DBusGMainLoop(set_as_default=True)
3045
main_loop = GLib.MainLoop()
2324
main_loop = gobject.MainLoop()
3046
2325
bus = dbus.SystemBus()
3047
2326
# End of Avahi example code
3048
2327
if use_dbus:
3049
2328
try:
3050
2329
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:
2330
bus, do_not_queue=True)
2331
old_bus_name = (dbus.service.BusName
2332
("se.bsnet.fukt.Mandos", bus,
2333
do_not_queue=True))
2334
except dbus.exceptions.NameExistsException as e:
3057
2335
logger.error("Disabling D-Bus:", exc_info=e)
3058
2336
use_dbus = False
3059
2337
server_settings["use_dbus"] = False
3060
2338
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
2339
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2340
service = AvahiServiceToSyslog(name =
2341
server_settings["servicename"],
2342
servicetype = "_mandos._tcp",
2343
protocol = protocol, bus = bus)
2344
if server_settings["interface"]:
2345
service.interface = (if_nametoindex
2346
(str(server_settings["interface"])))
2347
3072
2348
global multiprocessing_manager
3073
2349
multiprocessing_manager = multiprocessing.Manager()
3074
2350
3075
2351
client_class = Client
3076
2352
if use_dbus:
3077
client_class = functools.partial(ClientDBus, bus=bus)
3078
2353
client_class = functools.partial(ClientDBus, bus = bus)
2354
3079
2355
client_settings = Client.config_parser(client_config)
3080
2356
old_client_settings = {}
3081
2357
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
2358
3091
2359
# Get client data and settings from last running state.
3092
2360
if server_settings["restore"]:
3093
2361
try:
3094
2362
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"))
2363
clients_data, old_client_settings = (pickle.load
2364
(stored_state))
3140
2365
os.remove(stored_state_path)
3141
2366
except IOError as e:
3142
2367
if e.errno == errno.ENOENT:
3143
logger.warning("Could not load persistent state:"
3144
" {}".format(os.strerror(e.errno)))
2368
logger.warning("Could not load persistent state: {0}"
2369
.format(os.strerror(e.errno)))
3145
2370
else:
3146
2371
logger.critical("Could not load persistent state:",
3147
2372
exc_info=e)
3148
2373
raise
3149
2374
except EOFError as e:
3150
2375
logger.warning("Could not load persistent state: "
3151
"EOFError:",
3152
exc_info=e)
3153
2376
"EOFError:", exc_info=e)
2377
3154
2378
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
2379
for client_name, client in clients_data.iteritems():
3160
2380
# Decide which value to use after restoring saved state.
3161
2381
# We have three different values: Old config file,
3162
2382
# new config file, and saved state.
3167
2387
# For each value in new config, check if it
3168
2388
# differs from the old config value (Except for
3169
2389
# the "secret" attribute)
3170
if (name != "secret"
3171
and (value !=
3172
old_client_settings[client_name][name])):
2390
if (name != "secret" and
2391
value != old_client_settings[client_name]
2392
[name]):
3173
2393
client[name] = value
3174
2394
except KeyError:
3175
2395
pass
3176
2396
3177
2397
# Clients who has passed its expire date can still be
3178
# enabled if its last checker was successful. A Client
2398
# enabled if its last checker was successful. Clients
3179
2399
# whose checker succeeded before we stored its state is
3180
2400
# assumed to have successfully run all checkers during
3181
2401
# downtime.
3183
2403
if datetime.datetime.utcnow() >= client["expires"]:
3184
2404
if not client["last_checked_ok"]:
3185
2405
logger.warning(
3186
"disabling client {} - Client never "
3187
"performed a successful checker".format(
3188
client_name))
2406
"disabling client {0} - Client never "
2407
"performed a successful checker"
2408
.format(client_name))
3189
2409
client["enabled"] = False
3190
2410
elif client["last_checker_status"] != 0:
3191
2411
logger.warning(
3192
"disabling client {} - Client last"
3193
" checker failed with error code"
3194
" {}".format(
3195
client_name,
3196
client["last_checker_status"]))
2412
"disabling client {0} - Client "
2413
"last checker failed with error code {1}"
2414
.format(client_name,
2415
client["last_checker_status"]))
3197
2416
client["enabled"] = False
3198
2417
else:
3199
client["expires"] = (
3200
datetime.datetime.utcnow()
3201
+ client["timeout"])
2418
client["expires"] = (datetime.datetime
2419
.utcnow()
2420
+ client["timeout"])
3202
2421
logger.debug("Last checker succeeded,"
3203
" keeping {} enabled".format(
3204
client_name))
2422
" keeping {0} enabled"
2423
.format(client_name))
3205
2424
try:
3206
client["secret"] = pgp.decrypt(
3207
client["encrypted_secret"],
3208
client_settings[client_name]["secret"])
2425
client["secret"] = (
2426
pgp.decrypt(client["encrypted_secret"],
2427
client_settings[client_name]
2428
["secret"]))
3209
2429
except PGPError:
3210
2430
# 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
2431
logger.debug("Failed to decrypt {0} old secret"
2432
.format(client_name))
2433
client["secret"] = (
2434
client_settings[client_name]["secret"])
2435
3216
2436
# Add/remove clients based on new changes made to config
3217
2437
for client_name in (set(old_client_settings)
3218
2438
- set(client_settings)):
3220
2440
for client_name in (set(client_settings)
3221
2441
- set(old_client_settings)):
3222
2442
clients_data[client_name] = client_settings[client_name]
3223
2443
3224
2444
# Create all client objects
3225
for client_name, client in clients_data.items():
2445
for client_name, client in clients_data.iteritems():
3226
2446
tcp_server.clients[client_name] = client_class(
3227
name=client_name,
3228
settings=client,
3229
server_settings=server_settings)
3230
2447
name = client_name, settings = client)
2448
3231
2449
if not tcp_server.clients:
3232
2450
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
2451
2452
if not debug:
2453
try:
2454
with pidfile:
2455
pid = os.getpid()
2456
pidfile.write(str(pid) + "\n".encode("utf-8"))
2457
del pidfile
2458
except IOError:
2459
logger.error("Could not write to file %r with PID %d",
2460
pidfilename, pid)
2461
except NameError:
2462
# "pidfile" was never created
2463
pass
3244
2464
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
2465
signal.signal(signal.SIGINT, signal.SIG_IGN)
2466
2467
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2468
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2469
3250
2470
if use_dbus:
3251
3252
@alternate_dbus_interfaces(
3253
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3254
class MandosDBusService(DBusObjectWithObjectManager):
2471
@alternate_dbus_interfaces({"se.recompile.Mandos":
2472
"se.bsnet.fukt.Mandos"})
2473
class MandosDBusService(DBusObjectWithProperties):
3255
2474
"""A D-Bus proxy object"""
3256
3257
2475
def __init__(self):
3258
2476
dbus.service.Object.__init__(self, bus, "/")
3259
3260
2477
_interface = "se.recompile.Mandos"
3261
2478
2479
@dbus_interface_annotations(_interface)
2480
def _foo(self):
2481
return { "org.freedesktop.DBus.Property"
2482
".EmitsChangedSignal":
2483
"false"}
2484
3262
2485
@dbus.service.signal(_interface, signature="o")
3263
2486
def ClientAdded(self, objpath):
3264
2487
"D-Bus signal"
3265
2488
pass
3266
2489
3267
2490
@dbus.service.signal(_interface, signature="ss")
3268
2491
def ClientNotFound(self, fingerprint, address):
3269
2492
"D-Bus signal"
3270
2493
pass
3271
3272
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3273
"true"})
2494
3274
2495
@dbus.service.signal(_interface, signature="os")
3275
2496
def ClientRemoved(self, objpath, name):
3276
2497
"D-Bus signal"
3277
2498
pass
3278
3279
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3280
"true"})
2499
3281
2500
@dbus.service.method(_interface, out_signature="ao")
3282
2501
def GetAllClients(self):
3283
2502
"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"})
2503
return dbus.Array(c.dbus_object_path
2504
for c in
2505
tcp_server.clients.itervalues())
2506
3289
2507
@dbus.service.method(_interface,
3290
2508
out_signature="a{oa{sv}}")
3291
2509
def GetAllClientsWithProperties(self):
3292
2510
"D-Bus method"
3293
2511
return dbus.Dictionary(
3294
{c.dbus_object_path: c.GetAll(
3295
"se.recompile.Mandos.Client")
3296
for c in tcp_server.clients.values()},
2512
((c.dbus_object_path, c.GetAll(""))
2513
for c in tcp_server.clients.itervalues()),
3297
2514
signature="oa{sv}")
3298
2515
3299
2516
@dbus.service.method(_interface, in_signature="o")
3300
2517
def RemoveClient(self, object_path):
3301
2518
"D-Bus method"
3302
for c in tcp_server.clients.values():
2519
for c in tcp_server.clients.itervalues():
3303
2520
if c.dbus_object_path == object_path:
3304
2521
del tcp_server.clients[c.name]
3305
2522
c.remove_from_connection()
3306
# Don't signal the disabling
2523
# Don't signal anything except ClientRemoved
3307
2524
c.disable(quiet=True)
3308
# Emit D-Bus signal for removal
3309
self.client_removed_signal(c)
2525
# Emit D-Bus signal
2526
self.ClientRemoved(object_path, c.name)
3310
2527
return
3311
2528
raise KeyError(object_path)
3312
2529
3313
2530
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
2531
3351
2532
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
2533
3358
2534
def cleanup():
3359
2535
"Cleanup function; run on exit"
3360
if zeroconf:
3361
service.cleanup()
3362
3363
mp.active_children()
3364
wn.close()
2536
service.cleanup()
2537
2538
multiprocessing.active_children()
3365
2539
if not (tcp_server.clients or client_settings):
3366
2540
return
3367
2541
3368
2542
# Store client before exiting. Secrets are encrypted with key
3369
2543
# based on what config file has. If config file is
3370
2544
# removed/edited, old secret will thus be unrecovable.
3371
2545
clients = {}
3372
2546
with PGPEngine() as pgp:
3373
for client in tcp_server.clients.values():
2547
for client in tcp_server.clients.itervalues():
3374
2548
key = client_settings[client.name]["secret"]
3375
2549
client.encrypted_secret = pgp.encrypt(client.secret,
3376
2550
key)
3377
2551
client_dict = {}
3378
2552
3379
2553
# A list of attributes that can not be pickled
3380
2554
# + secret.
3381
exclude = {"bus", "changedstate", "secret",
3382
"checker", "server_settings"}
3383
for name, typ in inspect.getmembers(dbus.service
3384
.Object):
2555
exclude = set(("bus", "changedstate", "secret",
2556
"checker"))
2557
for name, typ in (inspect.getmembers
2558
(dbus.service.Object)):
3385
2559
exclude.add(name)
3386
2560
3387
2561
client_dict["encrypted_secret"] = (client
3388
2562
.encrypted_secret)
3389
2563
for attr in client.client_structure:
3390
2564
if attr not in exclude:
3391
2565
client_dict[attr] = getattr(client, attr)
3392
2566
3393
2567
clients[client.name] = client_dict
3394
2568
del client_settings[client.name]["secret"]
3395
2569
3396
2570
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
2571
with (tempfile.NamedTemporaryFile
2572
(mode='wb', suffix=".pickle", prefix='clients-',
2573
dir=os.path.dirname(stored_state_path),
2574
delete=False)) as stored_state:
2575
pickle.dump((clients, client_settings), stored_state)
2576
tempname=stored_state.name
3406
2577
os.rename(tempname, stored_state_path)
3407
2578
except (IOError, OSError) as e:
3408
2579
if not debug:
3411
2582
except NameError:
3412
2583
pass
3413
2584
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3414
logger.warning("Could not save persistent state: {}"
2585
logger.warning("Could not save persistent state: {0}"
3415
2586
.format(os.strerror(e.errno)))
3416
2587
else:
3417
2588
logger.warning("Could not save persistent state:",
3418
2589
exc_info=e)
3419
raise
3420
2590
raise e
2591
3421
2592
# Delete all clients, and settings from config
3422
2593
while tcp_server.clients:
3423
2594
name, client = tcp_server.clients.popitem()
3424
2595
if use_dbus:
3425
2596
client.remove_from_connection()
3426
# Don't signal the disabling
2597
# Don't signal anything except ClientRemoved
3427
2598
client.disable(quiet=True)
3428
# Emit D-Bus signal for removal
3429
2599
if use_dbus:
3430
mandos_dbus_service.client_removed_signal(client)
2600
# Emit D-Bus signal
2601
mandos_dbus_service.ClientRemoved(client
2602
.dbus_object_path,
2603
client.name)
3431
2604
client_settings.clear()
3432
2605
3433
2606
atexit.register(cleanup)
3434
3435
for client in tcp_server.clients.values():
2607
2608
for client in tcp_server.clients.itervalues():
3436
2609
if use_dbus:
3437
# Emit D-Bus signal for adding
3438
mandos_dbus_service.client_added_signal(client)
2610
# Emit D-Bus signal
2611
mandos_dbus_service.ClientAdded(client.dbus_object_path)
3439
2612
# Need to initiate checking of clients
3440
2613
if client.enabled:
3441
2614
client.init_checker()
3442
2615
3443
2616
tcp_server.enable()
3444
2617
tcp_server.server_activate()
3445
2618
3446
2619
# Find out what port we got
3447
if zeroconf:
3448
service.port = tcp_server.socket.getsockname()[1]
2620
service.port = tcp_server.socket.getsockname()[1]
3449
2621
if use_ipv6:
3450
2622
logger.info("Now listening on address %r, port %d,"
3451
2623
" flowinfo %d, scope_id %d",
3453
2625
else: # IPv4
3454
2626
logger.info("Now listening on address %r, port %d",
3455
2627
*tcp_server.socket.getsockname())
3456
3457
# service.interface = tcp_server.socket.getsockname()[3]
3458
2628
2629
#service.interface = tcp_server.socket.getsockname()[3]
2630
3459
2631
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
2632
# From the Avahi example code
2633
try:
2634
service.activate()
2635
except dbus.exceptions.DBusException as error:
2636
logger.critical("D-Bus Exception", exc_info=error)
2637
cleanup()
2638
sys.exit(1)
2639
# End of Avahi example code
2640
2641
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2642
lambda *args, **kwargs:
2643
(tcp_server.handle_request
2644
(*args[2:], **kwargs) or True))
2645
3475
2646
logger.debug("Starting main loop")
3476
2647
main_loop.run()
3477
2648
except AvahiError as error:
3486
2657
# Must run before the D-Bus bus name gets deregistered
3487
2658
cleanup()
3488
2659
3489
3490
2660
if __name__ == '__main__':
3491
2661
main()
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0