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