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