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