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