79
88
except ImportError:
80
89
SO_BINDTODEVICE = None
85
logger = logging.Logger(u'mandos')
92
stored_state_file = "clients.pickle"
94
logger = logging.getLogger()
86
95
syslogger = (logging.handlers.SysLogHandler
87
96
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
88
address = "/dev/log"))
89
syslogger.setFormatter(logging.Formatter
90
(u'Mandos [%(process)d]: %(levelname)s:'
92
logger.addHandler(syslogger)
94
console = logging.StreamHandler()
95
console.setFormatter(logging.Formatter(u'%(name)s [%(process)d]:'
98
logger.addHandler(console)
97
address = str("/dev/log")))
100
if_nametoindex = (ctypes.cdll.LoadLibrary
101
(ctypes.util.find_library("c"))
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"),
111
interface_index = struct.unpack(str("I"),
113
return interface_index
116
def initlogger(debug, level=logging.WARNING):
117
"""init logger and add loglevel"""
119
syslogger.setFormatter(logging.Formatter
120
('Mandos [%(process)d]: %(levelname)s:'
122
logger.addHandler(syslogger)
125
console = logging.StreamHandler()
126
console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
130
logger.addHandler(console)
131
logger.setLevel(level)
134
class PGPError(Exception):
135
"""Exception if encryption/decryption fails"""
139
class PGPEngine(object):
140
"""A simple class for OpenPGP symmetric encryption & decryption"""
142
self.tempdir = tempfile.mkdtemp(prefix="mandos-")
143
self.gnupgargs = ['--batch',
144
'--home', self.tempdir,
152
def __exit__(self, exc_type, exc_value, traceback):
160
if self.tempdir is not None:
161
# Delete contents of tempdir
162
for root, dirs, files in os.walk(self.tempdir,
164
for filename in files:
165
os.remove(os.path.join(root, filename))
167
os.rmdir(os.path.join(root, dirname))
169
os.rmdir(self.tempdir)
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)
177
def encrypt(self, data, password):
178
passphrase = self.password_encode(password)
179
with tempfile.NamedTemporaryFile(dir=self.tempdir
181
passfile.write(passphrase)
183
proc = subprocess.Popen(['gpg', '--symmetric',
187
stdin = subprocess.PIPE,
188
stdout = subprocess.PIPE,
189
stderr = subprocess.PIPE)
190
ciphertext, err = proc.communicate(input = data)
191
if proc.returncode != 0:
195
def decrypt(self, data, password):
196
passphrase = self.password_encode(password)
197
with tempfile.NamedTemporaryFile(dir = self.tempdir
199
passfile.write(passphrase)
201
proc = subprocess.Popen(['gpg', '--decrypt',
205
stdin = subprocess.PIPE,
206
stdout = subprocess.PIPE,
207
stderr = subprocess.PIPE)
208
decrypted_plaintext, err = proc.communicate(input
210
if proc.returncode != 0:
212
return decrypted_plaintext
100
215
class AvahiError(Exception):
101
216
def __init__(self, value, *args, **kwargs):
190
316
dbus.UInt16(self.port),
191
317
avahi.string_array_to_txt_array(self.TXT))
192
318
self.group.Commit()
193
320
def entry_group_state_changed(self, state, error):
194
321
"""Derived from the Avahi example code"""
195
logger.debug(u"Avahi state change: %i", state)
322
logger.debug("Avahi entry group state change: %i", state)
197
324
if state == avahi.ENTRY_GROUP_ESTABLISHED:
198
logger.debug(u"Zeroconf service established.")
325
logger.debug("Zeroconf service established.")
199
326
elif state == avahi.ENTRY_GROUP_COLLISION:
200
logger.warning(u"Zeroconf service name collision.")
327
logger.info("Zeroconf service name collision.")
202
329
elif state == avahi.ENTRY_GROUP_FAILURE:
203
logger.critical(u"Avahi: Error in group state changed %s",
330
logger.critical("Avahi: Error in group state changed %s",
205
raise AvahiGroupError(u"State changed: %s"
332
raise AvahiGroupError("State changed: {0!s}"
207
335
def cleanup(self):
208
336
"""Derived from the Avahi example code"""
209
337
if self.group is not None:
340
except (dbus.exceptions.UnknownMethodException,
341
dbus.exceptions.DBusException):
211
343
self.group = None
212
def server_state_changed(self, state):
346
def server_state_changed(self, state, error=None):
213
347
"""Derived from the Avahi example code"""
214
if state == avahi.SERVER_COLLISION:
215
logger.error(u"Zeroconf server name collision")
348
logger.debug("Avahi server state change: %i", state)
349
bad_states = { avahi.SERVER_INVALID:
350
"Zeroconf server invalid",
351
avahi.SERVER_REGISTERING: None,
352
avahi.SERVER_COLLISION:
353
"Zeroconf server name collision",
354
avahi.SERVER_FAILURE:
355
"Zeroconf server failure" }
356
if state in bad_states:
357
if bad_states[state] is not None:
359
logger.error(bad_states[state])
361
logger.error(bad_states[state] + ": %r", error)
217
363
elif state == avahi.SERVER_RUNNING:
367
logger.debug("Unknown state: %r", state)
369
logger.debug("Unknown state: %r: %r", state, error)
219
371
def activate(self):
220
372
"""Derived from the Avahi example code"""
221
373
if self.server is None:
222
374
self.server = dbus.Interface(
223
375
self.bus.get_object(avahi.DBUS_NAME,
224
avahi.DBUS_PATH_SERVER),
376
avahi.DBUS_PATH_SERVER,
377
follow_name_owner_changes=True),
225
378
avahi.DBUS_INTERFACE_SERVER)
226
self.server.connect_to_signal(u"StateChanged",
379
self.server.connect_to_signal("StateChanged",
227
380
self.server_state_changed)
228
381
self.server_state_changed(self.server.GetState())
384
class AvahiServiceToSyslog(AvahiService):
386
"""Add the new name to the syslog messages"""
387
ret = AvahiService.rename(self)
388
syslogger.setFormatter(logging.Formatter
389
('Mandos ({0}) [%(process)d]:'
390
' %(levelname)s: %(message)s'
395
def timedelta_to_milliseconds(td):
396
"Convert a datetime.timedelta() to milliseconds"
397
return ((td.days * 24 * 60 * 60 * 1000)
398
+ (td.seconds * 1000)
399
+ (td.microseconds // 1000))
231
402
class Client(object):
232
403
"""A representation of a client host served by this server.
235
name: string; from the config file, used in log messages and
406
approved: bool(); 'None' if not yet approved/disapproved
407
approval_delay: datetime.timedelta(); Time to wait for approval
408
approval_duration: datetime.timedelta(); Duration of one approval
409
checker: subprocess.Popen(); a running checker process used
410
to see if the client lives.
411
'None' if no process is running.
412
checker_callback_tag: a gobject event source tag, or None
413
checker_command: string; External command which is run to check
414
if client lives. %() expansions are done at
415
runtime with vars(self) as dict, so that for
416
instance %(name)s can be used in the command.
417
checker_initiator_tag: a gobject event source tag, or None
418
created: datetime.datetime(); (UTC) object creation
419
client_structure: Object describing what attributes a client has
420
and is used for storing the client at exit
421
current_checker_command: string; current running checker_command
422
disable_initiator_tag: a gobject event source tag, or None
237
424
fingerprint: string (40 or 32 hexadecimal digits); used to
238
425
uniquely identify the client
239
secret: bytestring; sent verbatim (over TLS) to client
240
426
host: string; available for use by the checker command
241
created: datetime.datetime(); (UTC) object creation
242
last_enabled: datetime.datetime(); (UTC)
427
interval: datetime.timedelta(); How often to start a new checker
428
last_approval_request: datetime.datetime(); (UTC) or None
244
429
last_checked_ok: datetime.datetime(); (UTC) or None
430
last_checker_status: integer between 0 and 255 reflecting exit
431
status of last checker. -1 reflects crashed
432
checker, -2 means no checker completed yet.
433
last_enabled: datetime.datetime(); (UTC) or None
434
name: string; from the config file, used in log messages and
436
secret: bytestring; sent verbatim (over TLS) to client
245
437
timeout: datetime.timedelta(); How long from last_checked_ok
246
438
until this client is disabled
247
interval: datetime.timedelta(); How often to start a new checker
248
disable_hook: If set, called by disable() as disable_hook(self)
249
checker: subprocess.Popen(); a running checker process used
250
to see if the client lives.
251
'None' if no process is running.
252
checker_initiator_tag: a gobject event source tag, or None
253
disable_initiator_tag: - '' -
254
checker_callback_tag: - '' -
255
checker_command: string; External command which is run to check if
256
client lives. %() expansions are done at
257
runtime with vars(self) as dict, so that for
258
instance %(name)s can be used in the command.
259
current_checker_command: string; current running checker_command
439
extended_timeout: extra long timeout when secret has been sent
440
runtime_expansions: Allowed attributes for runtime expansion.
441
expires: datetime.datetime(); time (UTC) when a client will be
443
server_settings: The server_settings dict from main()
263
def _timedelta_to_milliseconds(td):
264
"Convert a datetime.timedelta() to milliseconds"
265
return ((td.days * 24 * 60 * 60 * 1000)
266
+ (td.seconds * 1000)
267
+ (td.microseconds // 1000))
446
runtime_expansions = ("approval_delay", "approval_duration",
447
"created", "enabled", "expires",
448
"fingerprint", "host", "interval",
449
"last_approval_request", "last_checked_ok",
450
"last_enabled", "name", "timeout")
451
client_defaults = { "timeout": "PT5M",
452
"extended_timeout": "PT15M",
454
"checker": "fping -q -- %%(host)s",
456
"approval_delay": "PT0S",
457
"approval_duration": "PT1S",
458
"approved_by_default": "True",
269
462
def timeout_milliseconds(self):
270
463
"Return the 'timeout' attribute in milliseconds"
271
return self._timedelta_to_milliseconds(self.timeout)
464
return timedelta_to_milliseconds(self.timeout)
466
def extended_timeout_milliseconds(self):
467
"Return the 'extended_timeout' attribute in milliseconds"
468
return timedelta_to_milliseconds(self.extended_timeout)
273
470
def interval_milliseconds(self):
274
471
"Return the 'interval' attribute in milliseconds"
275
return self._timedelta_to_milliseconds(self.interval)
277
def __init__(self, name = None, disable_hook=None, config=None):
278
"""Note: the 'checker' key in 'config' sets the
279
'checker_command' attribute and *not* the 'checker'
472
return timedelta_to_milliseconds(self.interval)
474
def approval_delay_milliseconds(self):
475
return timedelta_to_milliseconds(self.approval_delay)
478
def config_parser(config):
479
"""Construct a new dict of client settings of this form:
480
{ client_name: {setting_name: value, ...}, ...}
481
with exceptions for any special settings as defined above.
482
NOTE: Must be a pure function. Must return the same result
483
value given the same arguments.
486
for client_name in config.sections():
487
section = dict(config.items(client_name))
488
client = settings[client_name] = {}
490
client["host"] = section["host"]
491
# Reformat values from string types to Python types
492
client["approved_by_default"] = config.getboolean(
493
client_name, "approved_by_default")
494
client["enabled"] = config.getboolean(client_name,
497
client["fingerprint"] = (section["fingerprint"].upper()
499
if "secret" in section:
500
client["secret"] = section["secret"].decode("base64")
501
elif "secfile" in section:
502
with open(os.path.expanduser(os.path.expandvars
503
(section["secfile"])),
505
client["secret"] = secfile.read()
507
raise TypeError("No secret or secfile for section {0}"
509
client["timeout"] = string_to_delta(section["timeout"])
510
client["extended_timeout"] = string_to_delta(
511
section["extended_timeout"])
512
client["interval"] = string_to_delta(section["interval"])
513
client["approval_delay"] = string_to_delta(
514
section["approval_delay"])
515
client["approval_duration"] = string_to_delta(
516
section["approval_duration"])
517
client["checker_command"] = section["checker"]
518
client["last_approval_request"] = None
519
client["last_checked_ok"] = None
520
client["last_checker_status"] = -2
524
def __init__(self, settings, name = None, server_settings=None):
284
logger.debug(u"Creating client %r", self.name)
526
if server_settings is None:
528
self.server_settings = server_settings
529
# adding all client settings
530
for setting, value in settings.iteritems():
531
setattr(self, setting, value)
534
if not hasattr(self, "last_enabled"):
535
self.last_enabled = datetime.datetime.utcnow()
536
if not hasattr(self, "expires"):
537
self.expires = (datetime.datetime.utcnow()
540
self.last_enabled = None
543
logger.debug("Creating client %r", self.name)
285
544
# Uppercase and remove spaces from fingerprint for later
286
545
# comparison purposes with return value from the fingerprint()
288
self.fingerprint = (config[u"fingerprint"].upper()
290
logger.debug(u" Fingerprint: %s", self.fingerprint)
291
if u"secret" in config:
292
self.secret = config[u"secret"].decode(u"base64")
293
elif u"secfile" in config:
294
with open(os.path.expanduser(os.path.expandvars
295
(config[u"secfile"])),
297
self.secret = secfile.read()
299
raise TypeError(u"No secret or secfile for client %s"
301
self.host = config.get(u"host", u"")
302
self.created = datetime.datetime.utcnow()
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
547
logger.debug(" Fingerprint: %s", self.fingerprint)
548
self.created = settings.get("created",
549
datetime.datetime.utcnow())
551
# attributes specific for this server instance
309
552
self.checker = None
310
553
self.checker_initiator_tag = None
311
554
self.disable_initiator_tag = None
312
555
self.checker_callback_tag = None
313
self.checker_command = config[u"checker"]
314
556
self.current_checker_command = None
315
self.last_connect = None
558
self.approvals_pending = 0
559
self.changedstate = (multiprocessing_manager
560
.Condition(multiprocessing_manager
562
self.client_structure = [attr for attr in
563
self.__dict__.iterkeys()
564
if not attr.startswith("_")]
565
self.client_structure.append("client_structure")
567
for name, t in inspect.getmembers(type(self),
571
if not name.startswith("_"):
572
self.client_structure.append(name)
574
# Send notice to process children that client state has changed
575
def send_changedstate(self):
576
with self.changedstate:
577
self.changedstate.notify_all()
317
579
def enable(self):
318
580
"""Start this client's checker and timeout hooks"""
319
if getattr(self, u"enabled", False):
581
if getattr(self, "enabled", False):
320
582
# Already enabled
584
self.expires = datetime.datetime.utcnow() + self.timeout
322
586
self.last_enabled = datetime.datetime.utcnow()
588
self.send_changedstate()
590
def disable(self, quiet=True):
591
"""Disable this client."""
592
if not getattr(self, "enabled", False):
595
logger.info("Disabling client %s", self.name)
596
if getattr(self, "disable_initiator_tag", None) is not None:
597
gobject.source_remove(self.disable_initiator_tag)
598
self.disable_initiator_tag = None
600
if getattr(self, "checker_initiator_tag", None) is not None:
601
gobject.source_remove(self.checker_initiator_tag)
602
self.checker_initiator_tag = None
606
self.send_changedstate()
607
# Do not run this again if called by a gobject.timeout_add
613
def init_checker(self):
323
614
# Schedule a new checker to be started an 'interval' from now,
324
615
# and every interval from then on.
616
if self.checker_initiator_tag is not None:
617
gobject.source_remove(self.checker_initiator_tag)
325
618
self.checker_initiator_tag = (gobject.timeout_add
326
619
(self.interval_milliseconds(),
327
620
self.start_checker))
328
621
# Schedule a disable() when 'timeout' has passed
622
if self.disable_initiator_tag is not None:
623
gobject.source_remove(self.disable_initiator_tag)
329
624
self.disable_initiator_tag = (gobject.timeout_add
330
625
(self.timeout_milliseconds(),
333
627
# Also start a new checker *right now*.
334
628
self.start_checker()
336
def disable(self, quiet=True):
337
"""Disable this client."""
338
if not getattr(self, "enabled", False):
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
349
if self.disable_hook:
350
self.disable_hook(self)
352
# Do not run this again if called by a gobject.timeout_add
356
self.disable_hook = None
359
630
def checker_callback(self, pid, condition, command):
360
631
"""The checker has completed, so take appropriate actions."""
361
632
self.checker_callback_tag = None
362
633
self.checker = None
363
634
if os.WIFEXITED(condition):
364
exitstatus = os.WEXITSTATUS(condition)
366
logger.info(u"Checker for %(name)s succeeded",
635
self.last_checker_status = os.WEXITSTATUS(condition)
636
if self.last_checker_status == 0:
637
logger.info("Checker for %(name)s succeeded",
368
639
self.checked_ok()
370
logger.info(u"Checker for %(name)s failed",
641
logger.info("Checker for %(name)s failed",
373
logger.warning(u"Checker for %(name)s crashed?",
644
self.last_checker_status = -1
645
logger.warning("Checker for %(name)s crashed?",
376
648
def checked_ok(self):
377
"""Bump up the timeout for this client.
379
This should only be called when the client has been seen,
649
"""Assert that the client has been seen, alive and well."""
382
650
self.last_checked_ok = datetime.datetime.utcnow()
383
gobject.source_remove(self.disable_initiator_tag)
384
self.disable_initiator_tag = (gobject.timeout_add
385
(self.timeout_milliseconds(),
651
self.last_checker_status = 0
654
def bump_timeout(self, timeout=None):
655
"""Bump up the timeout for this client."""
657
timeout = self.timeout
658
if self.disable_initiator_tag is not None:
659
gobject.source_remove(self.disable_initiator_tag)
660
self.disable_initiator_tag = None
661
if getattr(self, "enabled", False):
662
self.disable_initiator_tag = (gobject.timeout_add
663
(timedelta_to_milliseconds
664
(timeout), self.disable))
665
self.expires = datetime.datetime.utcnow() + timeout
667
def need_approval(self):
668
self.last_approval_request = datetime.datetime.utcnow()
388
670
def start_checker(self):
389
671
"""Start a new checker subprocess if one is not running.
402
684
# If a checker exists, make sure it is not a zombie
404
686
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
405
except (AttributeError, OSError), error:
687
except (AttributeError, OSError) as error:
406
688
if (isinstance(error, OSError)
407
689
and error.errno != errno.ECHILD):
411
logger.warning(u"Checker was a zombie")
693
logger.warning("Checker was a zombie")
412
694
gobject.source_remove(self.checker_callback_tag)
413
695
self.checker_callback(pid, status,
414
696
self.current_checker_command)
415
697
# Start a new checker if needed
416
698
if self.checker is None:
699
# Escape attributes for the shell
700
escaped_attrs = dict(
701
(attr, re.escape(unicode(getattr(self, attr))))
703
self.runtime_expansions)
418
# In case checker_command has exactly one % operator
419
command = self.checker_command % self.host
421
# Escape attributes for the shell
422
escaped_attrs = dict((key,
423
re.escape(unicode(str(val),
427
vars(self).iteritems())
429
command = self.checker_command % escaped_attrs
430
except TypeError, error:
431
logger.error(u'Could not format string "%s":'
432
u' %s', self.checker_command, error)
433
return True # Try again later
705
command = self.checker_command % escaped_attrs
706
except TypeError as error:
707
logger.error('Could not format string "%s"',
708
self.checker_command, exc_info=error)
709
return True # Try again later
434
710
self.current_checker_command = command
436
logger.info(u"Starting checker %r for %s",
712
logger.info("Starting checker %r for %s",
437
713
command, self.name)
438
714
# We don't need to redirect stdout and stderr, since
439
715
# in normal mode, that is already done by daemon(),
440
716
# and in debug mode we don't want to. (Stdin is
441
717
# always replaced by /dev/null.)
718
# The exception is when not debugging but nevertheless
719
# running in the foreground; use the previously
722
if (not self.server_settings["debug"]
723
and self.server_settings["foreground"]):
724
popen_args.update({"stdout": wnull,
442
726
self.checker = subprocess.Popen(command,
444
shell=True, cwd=u"/")
445
self.checker_callback_tag = (gobject.child_watch_add
447
self.checker_callback,
449
# The checker may have completed before the gobject
450
# watch was added. Check for this.
730
except OSError as error:
731
logger.error("Failed to start subprocess",
734
self.checker_callback_tag = (gobject.child_watch_add
736
self.checker_callback,
738
# The checker may have completed before the gobject
739
# watch was added. Check for this.
451
741
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
453
gobject.source_remove(self.checker_callback_tag)
454
self.checker_callback(pid, status, command)
455
except OSError, error:
456
logger.error(u"Failed to start subprocess: %s",
742
except OSError as error:
743
if error.errno == errno.ECHILD:
744
# This should never happen
745
logger.error("Child process vanished",
750
gobject.source_remove(self.checker_callback_tag)
751
self.checker_callback(pid, status, command)
458
752
# Re-run this periodically if run by gobject.timeout_add
529
860
class DBusObjectWithProperties(dbus.service.Object):
530
861
"""A D-Bus object with properties.
532
863
Classes inheriting from this can use the dbus_service_property
533
864
decorator to expose methods as D-Bus properties. It exposes the
534
865
standard Get(), Set(), and GetAll() methods on the D-Bus.
538
def _is_dbus_property(obj):
539
return getattr(obj, u"_dbus_is_property", False)
869
def _is_dbus_thing(thing):
870
"""Returns a function testing if an attribute is a D-Bus thing
872
If called like _is_dbus_thing("method") it returns a function
873
suitable for use as predicate to inspect.getmembers().
875
return lambda obj: getattr(obj, "_dbus_is_{0}".format(thing),
541
def _get_all_dbus_properties(self):
878
def _get_all_dbus_things(self, thing):
542
879
"""Returns a generator of (name, attribute) pairs
544
return ((prop._dbus_name, prop)
546
inspect.getmembers(self, self._is_dbus_property))
881
return ((getattr(athing.__get__(self), "_dbus_name",
883
athing.__get__(self))
884
for cls in self.__class__.__mro__
886
inspect.getmembers(cls,
887
self._is_dbus_thing(thing)))
548
889
def _get_dbus_property(self, interface_name, property_name):
549
890
"""Returns a bound method if one exists which is a D-Bus
550
891
property with the specified name and interface.
552
for name in (property_name,
553
property_name + u"_dbus_property"):
554
prop = getattr(self, name, None)
556
or not self._is_dbus_property(prop)
557
or prop._dbus_name != property_name
558
or (interface_name and prop._dbus_interface
559
and interface_name != prop._dbus_interface)):
893
for cls in self.__class__.__mro__:
894
for name, value in (inspect.getmembers
896
self._is_dbus_thing("property"))):
897
if (value._dbus_name == property_name
898
and value._dbus_interface == interface_name):
899
return value.__get__(self)
562
901
# No such property
563
raise DBusPropertyNotFound(self.dbus_object_path + u":"
564
+ interface_name + u"."
902
raise DBusPropertyNotFound(self.dbus_object_path + ":"
903
+ interface_name + "."
567
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ss",
906
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
569
908
def Get(self, interface_name, property_name):
570
909
"""Standard D-Bus property Get() method, see D-Bus standard.
572
911
prop = self._get_dbus_property(interface_name, property_name)
573
if prop._dbus_access == u"write":
912
if prop._dbus_access == "write":
574
913
raise DBusPropertyAccessException(property_name)
576
if not hasattr(value, u"variant_level"):
915
if not hasattr(value, "variant_level"):
578
917
return type(value)(value, variant_level=value.variant_level+1)
580
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ssv")
919
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
581
920
def Set(self, interface_name, property_name, value):
582
921
"""Standard D-Bus property Set() method, see D-Bus standard.
584
923
prop = self._get_dbus_property(interface_name, property_name)
585
if prop._dbus_access == u"read":
924
if prop._dbus_access == "read":
586
925
raise DBusPropertyAccessException(property_name)
587
if prop._dbus_get_args_options[u"byte_arrays"]:
926
if prop._dbus_get_args_options["byte_arrays"]:
588
927
# The byte_arrays option is not supported yet on
589
928
# signatures other than "ay".
590
if prop._dbus_signature != u"ay":
929
if prop._dbus_signature != "ay":
592
value = dbus.ByteArray(''.join(unichr(byte)
931
value = dbus.ByteArray(b''.join(chr(byte)
596
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"s",
597
out_signature=u"a{sv}")
935
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
936
out_signature="a{sv}")
598
937
def GetAll(self, interface_name):
599
938
"""Standard D-Bus property GetAll() method, see D-Bus
602
941
Note: Will not include properties with access="write".
605
for name, prop in self._get_all_dbus_properties():
944
for name, prop in self._get_all_dbus_things("property"):
606
945
if (interface_name
607
946
and interface_name != prop._dbus_interface):
608
947
# Interface non-empty but did not match
610
949
# Ignore write-only properties
611
if prop._dbus_access == u"write":
950
if prop._dbus_access == "write":
614
if not hasattr(value, u"variant_level"):
953
if not hasattr(value, "variant_level"):
954
properties[name] = value
617
all[name] = type(value)(value, variant_level=
618
value.variant_level+1)
619
return dbus.Dictionary(all, signature=u"sv")
956
properties[name] = type(value)(value, variant_level=
957
value.variant_level+1)
958
return dbus.Dictionary(properties, signature="sv")
621
960
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
623
962
path_keyword='object_path',
624
963
connection_keyword='connection')
625
964
def Introspect(self, object_path, connection):
626
"""Standard D-Bus method, overloaded to insert property tags.
965
"""Overloading of standard D-Bus method.
967
Inserts property tags and interface annotation tags.
628
969
xmlstring = dbus.service.Object.Introspect(self, object_path,
631
972
document = xml.dom.minidom.parseString(xmlstring)
632
973
def make_tag(document, name, prop):
633
e = document.createElement(u"property")
634
e.setAttribute(u"name", name)
635
e.setAttribute(u"type", prop._dbus_signature)
636
e.setAttribute(u"access", prop._dbus_access)
974
e = document.createElement("property")
975
e.setAttribute("name", name)
976
e.setAttribute("type", prop._dbus_signature)
977
e.setAttribute("access", prop._dbus_access)
638
for if_tag in document.getElementsByTagName(u"interface"):
979
for if_tag in document.getElementsByTagName("interface"):
639
981
for tag in (make_tag(document, name, prop)
641
in self._get_all_dbus_properties()
983
in self._get_all_dbus_things("property")
642
984
if prop._dbus_interface
643
== if_tag.getAttribute(u"name")):
985
== if_tag.getAttribute("name")):
644
986
if_tag.appendChild(tag)
987
# Add annotation tags
988
for typ in ("method", "signal", "property"):
989
for tag in if_tag.getElementsByTagName(typ):
991
for name, prop in (self.
992
_get_all_dbus_things(typ)):
993
if (name == tag.getAttribute("name")
994
and prop._dbus_interface
995
== if_tag.getAttribute("name")):
996
annots.update(getattr
1000
for name, value in annots.iteritems():
1001
ann_tag = document.createElement(
1003
ann_tag.setAttribute("name", name)
1004
ann_tag.setAttribute("value", value)
1005
tag.appendChild(ann_tag)
1006
# Add interface annotation tags
1007
for annotation, value in dict(
1008
itertools.chain.from_iterable(
1009
annotations().iteritems()
1010
for name, annotations in
1011
self._get_all_dbus_things("interface")
1012
if name == if_tag.getAttribute("name")
1014
ann_tag = document.createElement("annotation")
1015
ann_tag.setAttribute("name", annotation)
1016
ann_tag.setAttribute("value", value)
1017
if_tag.appendChild(ann_tag)
645
1018
# Add the names to the return values for the
646
1019
# "org.freedesktop.DBus.Properties" methods
647
if (if_tag.getAttribute(u"name")
648
== u"org.freedesktop.DBus.Properties"):
649
for cn in if_tag.getElementsByTagName(u"method"):
650
if cn.getAttribute(u"name") == u"Get":
651
for arg in cn.getElementsByTagName(u"arg"):
652
if (arg.getAttribute(u"direction")
654
arg.setAttribute(u"name", u"value")
655
elif cn.getAttribute(u"name") == u"GetAll":
656
for arg in cn.getElementsByTagName(u"arg"):
657
if (arg.getAttribute(u"direction")
659
arg.setAttribute(u"name", u"props")
660
xmlstring = document.toxml(u"utf-8")
1020
if (if_tag.getAttribute("name")
1021
== "org.freedesktop.DBus.Properties"):
1022
for cn in if_tag.getElementsByTagName("method"):
1023
if cn.getAttribute("name") == "Get":
1024
for arg in cn.getElementsByTagName("arg"):
1025
if (arg.getAttribute("direction")
1027
arg.setAttribute("name", "value")
1028
elif cn.getAttribute("name") == "GetAll":
1029
for arg in cn.getElementsByTagName("arg"):
1030
if (arg.getAttribute("direction")
1032
arg.setAttribute("name", "props")
1033
xmlstring = document.toxml("utf-8")
661
1034
document.unlink()
662
1035
except (AttributeError, xml.dom.DOMException,
663
xml.parsers.expat.ExpatError), error:
664
logger.error(u"Failed to override Introspection method",
1036
xml.parsers.expat.ExpatError) as error:
1037
logger.error("Failed to override Introspection method",
666
1039
return xmlstring
1042
def datetime_to_dbus(dt, variant_level=0):
1043
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1045
return dbus.String("", variant_level = variant_level)
1046
return dbus.String(dt.isoformat(),
1047
variant_level=variant_level)
1050
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1051
"""A class decorator; applied to a subclass of
1052
dbus.service.Object, it will add alternate D-Bus attributes with
1053
interface names according to the "alt_interface_names" mapping.
1056
@alternate_dbus_interfaces({"org.example.Interface":
1057
"net.example.AlternateInterface"})
1058
class SampleDBusObject(dbus.service.Object):
1059
@dbus.service.method("org.example.Interface")
1060
def SampleDBusMethod():
1063
The above "SampleDBusMethod" on "SampleDBusObject" will be
1064
reachable via two interfaces: "org.example.Interface" and
1065
"net.example.AlternateInterface", the latter of which will have
1066
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1067
"true", unless "deprecate" is passed with a False value.
1069
This works for methods and signals, and also for D-Bus properties
1070
(from DBusObjectWithProperties) and interfaces (from the
1071
dbus_interface_annotations decorator).
1074
for orig_interface_name, alt_interface_name in (
1075
alt_interface_names.iteritems()):
1077
interface_names = set()
1078
# Go though all attributes of the class
1079
for attrname, attribute in inspect.getmembers(cls):
1080
# Ignore non-D-Bus attributes, and D-Bus attributes
1081
# with the wrong interface name
1082
if (not hasattr(attribute, "_dbus_interface")
1083
or not attribute._dbus_interface
1084
.startswith(orig_interface_name)):
1086
# Create an alternate D-Bus interface name based on
1088
alt_interface = (attribute._dbus_interface
1089
.replace(orig_interface_name,
1090
alt_interface_name))
1091
interface_names.add(alt_interface)
1092
# Is this a D-Bus signal?
1093
if getattr(attribute, "_dbus_is_signal", False):
1094
# Extract the original non-method undecorated
1095
# function by black magic
1096
nonmethod_func = (dict(
1097
zip(attribute.func_code.co_freevars,
1098
attribute.__closure__))["func"]
1100
# Create a new, but exactly alike, function
1101
# object, and decorate it to be a new D-Bus signal
1102
# with the alternate D-Bus interface name
1103
new_function = (dbus.service.signal
1105
attribute._dbus_signature)
1106
(types.FunctionType(
1107
nonmethod_func.func_code,
1108
nonmethod_func.func_globals,
1109
nonmethod_func.func_name,
1110
nonmethod_func.func_defaults,
1111
nonmethod_func.func_closure)))
1112
# Copy annotations, if any
1114
new_function._dbus_annotations = (
1115
dict(attribute._dbus_annotations))
1116
except AttributeError:
1118
# Define a creator of a function to call both the
1119
# original and alternate functions, so both the
1120
# original and alternate signals gets sent when
1121
# the function is called
1122
def fixscope(func1, func2):
1123
"""This function is a scope container to pass
1124
func1 and func2 to the "call_both" function
1125
outside of its arguments"""
1126
def call_both(*args, **kwargs):
1127
"""This function will emit two D-Bus
1128
signals by calling func1 and func2"""
1129
func1(*args, **kwargs)
1130
func2(*args, **kwargs)
1132
# Create the "call_both" function and add it to
1134
attr[attrname] = fixscope(attribute, new_function)
1135
# Is this a D-Bus method?
1136
elif getattr(attribute, "_dbus_is_method", False):
1137
# Create a new, but exactly alike, function
1138
# object. Decorate it to be a new D-Bus method
1139
# with the alternate D-Bus interface name. Add it
1141
attr[attrname] = (dbus.service.method
1143
attribute._dbus_in_signature,
1144
attribute._dbus_out_signature)
1146
(attribute.func_code,
1147
attribute.func_globals,
1148
attribute.func_name,
1149
attribute.func_defaults,
1150
attribute.func_closure)))
1151
# Copy annotations, if any
1153
attr[attrname]._dbus_annotations = (
1154
dict(attribute._dbus_annotations))
1155
except AttributeError:
1157
# Is this a D-Bus property?
1158
elif getattr(attribute, "_dbus_is_property", False):
1159
# Create a new, but exactly alike, function
1160
# object, and decorate it to be a new D-Bus
1161
# property with the alternate D-Bus interface
1162
# name. Add it to the class.
1163
attr[attrname] = (dbus_service_property
1165
attribute._dbus_signature,
1166
attribute._dbus_access,
1168
._dbus_get_args_options
1171
(attribute.func_code,
1172
attribute.func_globals,
1173
attribute.func_name,
1174
attribute.func_defaults,
1175
attribute.func_closure)))
1176
# Copy annotations, if any
1178
attr[attrname]._dbus_annotations = (
1179
dict(attribute._dbus_annotations))
1180
except AttributeError:
1182
# Is this a D-Bus interface?
1183
elif getattr(attribute, "_dbus_is_interface", False):
1184
# Create a new, but exactly alike, function
1185
# object. Decorate it to be a new D-Bus interface
1186
# with the alternate D-Bus interface name. Add it
1188
attr[attrname] = (dbus_interface_annotations
1191
(attribute.func_code,
1192
attribute.func_globals,
1193
attribute.func_name,
1194
attribute.func_defaults,
1195
attribute.func_closure)))
1197
# Deprecate all alternate interfaces
1198
iname="_AlternateDBusNames_interface_annotation{0}"
1199
for interface_name in interface_names:
1200
@dbus_interface_annotations(interface_name)
1202
return { "org.freedesktop.DBus.Deprecated":
1204
# Find an unused name
1205
for aname in (iname.format(i)
1206
for i in itertools.count()):
1207
if aname not in attr:
1211
# Replace the class with a new subclass of it with
1212
# methods, signals, etc. as created above.
1213
cls = type(b"{0}Alternate".format(cls.__name__),
1219
@alternate_dbus_interfaces({"se.recompile.Mandos":
1220
"se.bsnet.fukt.Mandos"})
669
1221
class ClientDBus(Client, DBusObjectWithProperties):
670
1222
"""A Client class using D-Bus
680
1236
Client.__init__(self, *args, **kwargs)
681
1237
# Only now, when this client is initialized, can it show up on
1239
client_object_name = unicode(self.name).translate(
1240
{ord("."): ord("_"),
1241
ord("-"): ord("_")})
683
1242
self.dbus_object_path = (dbus.ObjectPath
685
+ self.name.replace(u".", u"_")))
1243
("/clients/" + client_object_name))
686
1244
DBusObjectWithProperties.__init__(self, self.bus,
687
1245
self.dbus_object_path)
690
def _datetime_to_dbus(dt, variant_level=0):
691
"""Convert a UTC datetime.datetime() to a D-Bus type."""
692
return dbus.String(dt.isoformat(),
693
variant_level=variant_level)
696
oldstate = getattr(self, u"enabled", False)
697
r = Client.enable(self)
698
if oldstate != self.enabled:
700
self.PropertyChanged(dbus.String(u"enabled"),
701
dbus.Boolean(True, variant_level=1))
702
self.PropertyChanged(
703
dbus.String(u"last_enabled"),
704
self._datetime_to_dbus(self.last_enabled,
708
def disable(self, quiet = False):
709
oldstate = getattr(self, u"enabled", False)
710
r = Client.disable(self, quiet=quiet)
711
if not quiet and oldstate != self.enabled:
713
self.PropertyChanged(dbus.String(u"enabled"),
714
dbus.Boolean(False, variant_level=1))
1247
def notifychangeproperty(transform_func,
1248
dbus_name, type_func=lambda x: x,
1250
""" Modify a variable so that it's a property which announces
1251
its changes to DBus.
1253
transform_fun: Function that takes a value and a variant_level
1254
and transforms it to a D-Bus type.
1255
dbus_name: D-Bus name of the variable
1256
type_func: Function that transform the value before sending it
1257
to the D-Bus. Default: no transform
1258
variant_level: D-Bus variant level. Default: 1
1260
attrname = "_{0}".format(dbus_name)
1261
def setter(self, value):
1262
if hasattr(self, "dbus_object_path"):
1263
if (not hasattr(self, attrname) or
1264
type_func(getattr(self, attrname, None))
1265
!= type_func(value)):
1266
dbus_value = transform_func(type_func(value),
1269
self.PropertyChanged(dbus.String(dbus_name),
1271
setattr(self, attrname, value)
1273
return property(lambda self: getattr(self, attrname), setter)
1275
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1276
approvals_pending = notifychangeproperty(dbus.Boolean,
1279
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1280
last_enabled = notifychangeproperty(datetime_to_dbus,
1282
checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1283
type_func = lambda checker:
1284
checker is not None)
1285
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1287
last_checker_status = notifychangeproperty(dbus.Int16,
1288
"LastCheckerStatus")
1289
last_approval_request = notifychangeproperty(
1290
datetime_to_dbus, "LastApprovalRequest")
1291
approved_by_default = notifychangeproperty(dbus.Boolean,
1292
"ApprovedByDefault")
1293
approval_delay = notifychangeproperty(dbus.UInt64,
1296
timedelta_to_milliseconds)
1297
approval_duration = notifychangeproperty(
1298
dbus.UInt64, "ApprovalDuration",
1299
type_func = timedelta_to_milliseconds)
1300
host = notifychangeproperty(dbus.String, "Host")
1301
timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1303
timedelta_to_milliseconds)
1304
extended_timeout = notifychangeproperty(
1305
dbus.UInt64, "ExtendedTimeout",
1306
type_func = timedelta_to_milliseconds)
1307
interval = notifychangeproperty(dbus.UInt64,
1310
timedelta_to_milliseconds)
1311
checker_command = notifychangeproperty(dbus.String, "Checker")
1313
del notifychangeproperty
717
1315
def __del__(self, *args, **kwargs):
719
1317
self.remove_from_connection()
720
1318
except LookupError:
722
if hasattr(DBusObjectWithProperties, u"__del__"):
1320
if hasattr(DBusObjectWithProperties, "__del__"):
723
1321
DBusObjectWithProperties.__del__(self, *args, **kwargs)
724
1322
Client.__del__(self, *args, **kwargs)
851
@dbus_service_property(_interface, signature=u"s", access=u"read")
852
def name_dbus_property(self):
1456
# ApprovalPending - property
1457
@dbus_service_property(_interface, signature="b", access="read")
1458
def ApprovalPending_dbus_property(self):
1459
return dbus.Boolean(bool(self.approvals_pending))
1461
# ApprovedByDefault - property
1462
@dbus_service_property(_interface, signature="b",
1464
def ApprovedByDefault_dbus_property(self, value=None):
1465
if value is None: # get
1466
return dbus.Boolean(self.approved_by_default)
1467
self.approved_by_default = bool(value)
1469
# ApprovalDelay - property
1470
@dbus_service_property(_interface, signature="t",
1472
def ApprovalDelay_dbus_property(self, value=None):
1473
if value is None: # get
1474
return dbus.UInt64(self.approval_delay_milliseconds())
1475
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1477
# ApprovalDuration - property
1478
@dbus_service_property(_interface, signature="t",
1480
def ApprovalDuration_dbus_property(self, value=None):
1481
if value is None: # get
1482
return dbus.UInt64(timedelta_to_milliseconds(
1483
self.approval_duration))
1484
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1487
@dbus_service_property(_interface, signature="s", access="read")
1488
def Name_dbus_property(self):
853
1489
return dbus.String(self.name)
855
# fingerprint - property
856
@dbus_service_property(_interface, signature=u"s", access=u"read")
857
def fingerprint_dbus_property(self):
1491
# Fingerprint - property
1492
@dbus_service_property(_interface, signature="s", access="read")
1493
def Fingerprint_dbus_property(self):
858
1494
return dbus.String(self.fingerprint)
861
@dbus_service_property(_interface, signature=u"s",
863
def host_dbus_property(self, value=None):
1497
@dbus_service_property(_interface, signature="s",
1499
def Host_dbus_property(self, value=None):
864
1500
if value is None: # get
865
1501
return dbus.String(self.host)
868
self.PropertyChanged(dbus.String(u"host"),
869
dbus.String(value, variant_level=1))
872
@dbus_service_property(_interface, signature=u"s", access=u"read")
873
def created_dbus_property(self):
874
return dbus.String(self._datetime_to_dbus(self.created))
876
# last_enabled - property
877
@dbus_service_property(_interface, signature=u"s", access=u"read")
878
def last_enabled_dbus_property(self):
879
if self.last_enabled is None:
880
return dbus.String(u"")
881
return dbus.String(self._datetime_to_dbus(self.last_enabled))
884
@dbus_service_property(_interface, signature=u"b",
886
def enabled_dbus_property(self, value=None):
1502
self.host = unicode(value)
1504
# Created - property
1505
@dbus_service_property(_interface, signature="s", access="read")
1506
def Created_dbus_property(self):
1507
return datetime_to_dbus(self.created)
1509
# LastEnabled - property
1510
@dbus_service_property(_interface, signature="s", access="read")
1511
def LastEnabled_dbus_property(self):
1512
return datetime_to_dbus(self.last_enabled)
1514
# Enabled - property
1515
@dbus_service_property(_interface, signature="b",
1517
def Enabled_dbus_property(self, value=None):
887
1518
if value is None: # get
888
1519
return dbus.Boolean(self.enabled)
894
# last_checked_ok - property
895
@dbus_service_property(_interface, signature=u"s",
897
def last_checked_ok_dbus_property(self, value=None):
1525
# LastCheckedOK - property
1526
@dbus_service_property(_interface, signature="s",
1528
def LastCheckedOK_dbus_property(self, value=None):
898
1529
if value is not None:
899
1530
self.checked_ok()
901
if self.last_checked_ok is None:
902
return dbus.String(u"")
903
return dbus.String(self._datetime_to_dbus(self
907
@dbus_service_property(_interface, signature=u"t",
909
def timeout_dbus_property(self, value=None):
1532
return datetime_to_dbus(self.last_checked_ok)
1534
# LastCheckerStatus - property
1535
@dbus_service_property(_interface, signature="n",
1537
def LastCheckerStatus_dbus_property(self):
1538
return dbus.Int16(self.last_checker_status)
1540
# Expires - property
1541
@dbus_service_property(_interface, signature="s", access="read")
1542
def Expires_dbus_property(self):
1543
return datetime_to_dbus(self.expires)
1545
# LastApprovalRequest - property
1546
@dbus_service_property(_interface, signature="s", access="read")
1547
def LastApprovalRequest_dbus_property(self):
1548
return datetime_to_dbus(self.last_approval_request)
1550
# Timeout - property
1551
@dbus_service_property(_interface, signature="t",
1553
def Timeout_dbus_property(self, value=None):
910
1554
if value is None: # get
911
1555
return dbus.UInt64(self.timeout_milliseconds())
1556
old_timeout = self.timeout
912
1557
self.timeout = datetime.timedelta(0, 0, 0, value)
914
self.PropertyChanged(dbus.String(u"timeout"),
915
dbus.UInt64(value, variant_level=1))
916
if getattr(self, u"disable_initiator_tag", None) is None:
919
gobject.source_remove(self.disable_initiator_tag)
920
self.disable_initiator_tag = None
922
_timedelta_to_milliseconds((self
928
# The timeout has passed
931
self.disable_initiator_tag = (gobject.timeout_add
932
(time_to_die, self.disable))
934
# interval - property
935
@dbus_service_property(_interface, signature=u"t",
937
def interval_dbus_property(self, value=None):
1558
# Reschedule disabling
1560
now = datetime.datetime.utcnow()
1561
self.expires += self.timeout - old_timeout
1562
if self.expires <= now:
1563
# The timeout has passed
1566
if (getattr(self, "disable_initiator_tag", None)
1569
gobject.source_remove(self.disable_initiator_tag)
1570
self.disable_initiator_tag = (
1571
gobject.timeout_add(
1572
timedelta_to_milliseconds(self.expires - now),
1575
# ExtendedTimeout - property
1576
@dbus_service_property(_interface, signature="t",
1578
def ExtendedTimeout_dbus_property(self, value=None):
1579
if value is None: # get
1580
return dbus.UInt64(self.extended_timeout_milliseconds())
1581
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1583
# Interval - property
1584
@dbus_service_property(_interface, signature="t",
1586
def Interval_dbus_property(self, value=None):
938
1587
if value is None: # get
939
1588
return dbus.UInt64(self.interval_milliseconds())
940
1589
self.interval = datetime.timedelta(0, 0, 0, value)
942
self.PropertyChanged(dbus.String(u"interval"),
943
dbus.UInt64(value, variant_level=1))
944
if getattr(self, u"checker_initiator_tag", None) is None:
1590
if getattr(self, "checker_initiator_tag", None) is None:
946
# Reschedule checker run
947
gobject.source_remove(self.checker_initiator_tag)
948
self.checker_initiator_tag = (gobject.timeout_add
949
(value, self.start_checker))
950
self.start_checker() # Start one now, too
953
@dbus_service_property(_interface, signature=u"s",
955
def checker_dbus_property(self, value=None):
1593
# Reschedule checker run
1594
gobject.source_remove(self.checker_initiator_tag)
1595
self.checker_initiator_tag = (gobject.timeout_add
1596
(value, self.start_checker))
1597
self.start_checker() # Start one now, too
1599
# Checker - property
1600
@dbus_service_property(_interface, signature="s",
1602
def Checker_dbus_property(self, value=None):
956
1603
if value is None: # get
957
1604
return dbus.String(self.checker_command)
958
self.checker_command = value
960
self.PropertyChanged(dbus.String(u"checker"),
961
dbus.String(self.checker_command,
1605
self.checker_command = unicode(value)
964
# checker_running - property
965
@dbus_service_property(_interface, signature=u"b",
967
def checker_running_dbus_property(self, value=None):
1607
# CheckerRunning - property
1608
@dbus_service_property(_interface, signature="b",
1610
def CheckerRunning_dbus_property(self, value=None):
968
1611
if value is None: # get
969
1612
return dbus.Boolean(self.checker is not None)
993
1662
Note: This will run in its own forked process."""
995
1664
def handle(self):
996
logger.info(u"TCP connection from: %s",
997
unicode(self.client_address))
998
logger.debug(u"IPC Pipe FD: %d",
999
self.server.child_pipe[1].fileno())
1000
# Open IPC pipe to parent process
1001
with contextlib.nested(self.server.child_pipe[1],
1002
self.server.parent_pipe[0]
1003
) as (ipc, ipc_return):
1665
with contextlib.closing(self.server.child_pipe) as child_pipe:
1666
logger.info("TCP connection from: %s",
1667
unicode(self.client_address))
1668
logger.debug("Pipe FD: %d",
1669
self.server.child_pipe.fileno())
1004
1671
session = (gnutls.connection
1005
1672
.ClientSession(self.request,
1006
1673
gnutls.connection
1007
1674
.X509Credentials()))
1009
line = self.request.makefile().readline()
1010
logger.debug(u"Protocol version: %r", line)
1012
if int(line.strip().split()[0]) > 1:
1014
except (ValueError, IndexError, RuntimeError), error:
1015
logger.error(u"Unknown protocol version: %s", error)
1018
1676
# Note: gnutls.connection.X509Credentials is really a
1019
1677
# generic GnuTLS certificate credentials object so long as
1020
1678
# no X.509 keys are added to it. Therefore, we can use it
1021
1679
# here despite using OpenPGP certificates.
1023
#priority = u':'.join((u"NONE", u"+VERS-TLS1.1",
1024
# u"+AES-256-CBC", u"+SHA1",
1025
# u"+COMP-NULL", u"+CTYPE-OPENPGP",
1681
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1682
# "+AES-256-CBC", "+SHA1",
1683
# "+COMP-NULL", "+CTYPE-OPENPGP",
1027
1685
# Use a fallback default, since this MUST be set.
1028
1686
priority = self.server.gnutls_priority
1029
1687
if priority is None:
1030
priority = u"NORMAL"
1031
1689
(gnutls.library.functions
1032
1690
.gnutls_priority_set_direct(session._c_object,
1033
1691
priority, None))
1693
# Start communication using the Mandos protocol
1694
# Get protocol number
1695
line = self.request.makefile().readline()
1696
logger.debug("Protocol version: %r", line)
1698
if int(line.strip().split()[0]) > 1:
1700
except (ValueError, IndexError, RuntimeError) as error:
1701
logger.error("Unknown protocol version: %s", error)
1704
# Start GnuTLS connection
1036
1706
session.handshake()
1037
except gnutls.errors.GNUTLSError, error:
1038
logger.warning(u"Handshake failed: %s", error)
1707
except gnutls.errors.GNUTLSError as error:
1708
logger.warning("Handshake failed: %s", error)
1039
1709
# Do not run session.bye() here: the session is not
1040
1710
# established. Just abandon the request.
1042
logger.debug(u"Handshake succeeded")
1712
logger.debug("Handshake succeeded")
1714
approval_required = False
1045
1717
fpr = self.fingerprint(self.peer_certificate
1047
except (TypeError, gnutls.errors.GNUTLSError), error:
1048
logger.warning(u"Bad certificate: %s", error)
1050
logger.debug(u"Fingerprint: %s", fpr)
1052
for c in self.server.clients:
1053
if c.fingerprint == fpr:
1720
gnutls.errors.GNUTLSError) as error:
1721
logger.warning("Bad certificate: %s", error)
1723
logger.debug("Fingerprint: %s", fpr)
1726
client = ProxyClient(child_pipe, fpr,
1727
self.client_address)
1731
if client.approval_delay:
1732
delay = client.approval_delay
1733
client.approvals_pending += 1
1734
approval_required = True
1737
if not client.enabled:
1738
logger.info("Client %s is disabled",
1740
if self.server.use_dbus:
1742
client.Rejected("Disabled")
1745
if client.approved or not client.approval_delay:
1746
#We are approved or approval is disabled
1057
ipc.write(u"NOTFOUND %s %s\n"
1058
% (fpr, unicode(self.client_address)))
1060
# Have to check if client.enabled, since it is
1061
# possible that the client was disabled since the
1062
# GnuTLS session was established.
1063
ipc.write(u"GETATTR enabled %s\n" % fpr)
1064
enabled = pickle.load(ipc_return)
1066
ipc.write(u"DISABLED %s\n" % client.name)
1068
ipc.write(u"SENDING %s\n" % client.name)
1748
elif client.approved is None:
1749
logger.info("Client %s needs approval",
1751
if self.server.use_dbus:
1753
client.NeedApproval(
1754
client.approval_delay_milliseconds(),
1755
client.approved_by_default)
1757
logger.warning("Client %s was not approved",
1759
if self.server.use_dbus:
1761
client.Rejected("Denied")
1764
#wait until timeout or approved
1765
time = datetime.datetime.now()
1766
client.changedstate.acquire()
1767
client.changedstate.wait(
1768
float(timedelta_to_milliseconds(delay)
1770
client.changedstate.release()
1771
time2 = datetime.datetime.now()
1772
if (time2 - time) >= delay:
1773
if not client.approved_by_default:
1774
logger.warning("Client %s timed out while"
1775
" waiting for approval",
1777
if self.server.use_dbus:
1779
client.Rejected("Approval timed out")
1784
delay -= time2 - time
1070
1787
while sent_size < len(client.secret):
1071
sent = session.send(client.secret[sent_size:])
1072
logger.debug(u"Sent: %d, remaining: %d",
1789
sent = session.send(client.secret[sent_size:])
1790
except gnutls.errors.GNUTLSError as error:
1791
logger.warning("gnutls send failed",
1794
logger.debug("Sent: %d, remaining: %d",
1073
1795
sent, len(client.secret)
1074
1796
- (sent_size + sent))
1075
1797
sent_size += sent
1799
logger.info("Sending secret to %s", client.name)
1800
# bump the timeout using extended_timeout
1801
client.bump_timeout(client.extended_timeout)
1802
if self.server.use_dbus:
1807
if approval_required:
1808
client.approvals_pending -= 1
1811
except gnutls.errors.GNUTLSError as error:
1812
logger.warning("GnuTLS bye failed",
1080
1816
def peer_certificate(session):
1173
1922
use_ipv6: Boolean; to use IPv6 or not
1175
1924
def __init__(self, server_address, RequestHandlerClass,
1176
interface=None, use_ipv6=True):
1925
interface=None, use_ipv6=True, socketfd=None):
1926
"""If socketfd is set, use that file descriptor instead of
1927
creating a new one with socket.socket().
1177
1929
self.interface = interface
1179
1931
self.address_family = socket.AF_INET6
1932
if socketfd is not None:
1933
# Save the file descriptor
1934
self.socketfd = socketfd
1935
# Save the original socket.socket() function
1936
self.socket_socket = socket.socket
1937
# To implement --socket, we monkey patch socket.socket.
1939
# (When socketserver.TCPServer is a new-style class, we
1940
# could make self.socket into a property instead of monkey
1941
# patching socket.socket.)
1943
# Create a one-time-only replacement for socket.socket()
1944
@functools.wraps(socket.socket)
1945
def socket_wrapper(*args, **kwargs):
1946
# Restore original function so subsequent calls are
1948
socket.socket = self.socket_socket
1949
del self.socket_socket
1950
# This time only, return a new socket object from the
1951
# saved file descriptor.
1952
return socket.fromfd(self.socketfd, *args, **kwargs)
1953
# Replace socket.socket() function with wrapper
1954
socket.socket = socket_wrapper
1955
# The socketserver.TCPServer.__init__ will call
1956
# socket.socket(), which might be our replacement,
1957
# socket_wrapper(), if socketfd was set.
1180
1958
socketserver.TCPServer.__init__(self, server_address,
1181
1959
RequestHandlerClass)
1182
1961
def server_bind(self):
1183
1962
"""This overrides the normal server_bind() function
1184
1963
to bind to an interface if one was specified, and also NOT to
1185
1964
bind to an address or port if they were not specified."""
1186
1965
if self.interface is not None:
1187
1966
if SO_BINDTODEVICE is None:
1188
logger.error(u"SO_BINDTODEVICE does not exist;"
1189
u" cannot bind to interface %s",
1967
logger.error("SO_BINDTODEVICE does not exist;"
1968
" cannot bind to interface %s",
1190
1969
self.interface)
1193
1972
self.socket.setsockopt(socket.SOL_SOCKET,
1194
1973
SO_BINDTODEVICE,
1197
except socket.error, error:
1198
if error[0] == errno.EPERM:
1199
logger.error(u"No permission to"
1200
u" bind to interface %s",
1202
elif error[0] == errno.ENOPROTOOPT:
1203
logger.error(u"SO_BINDTODEVICE not available;"
1204
u" cannot bind to interface %s",
1974
str(self.interface + '\0'))
1975
except socket.error as error:
1976
if error.errno == errno.EPERM:
1977
logger.error("No permission to bind to"
1978
" interface %s", self.interface)
1979
elif error.errno == errno.ENOPROTOOPT:
1980
logger.error("SO_BINDTODEVICE not available;"
1981
" cannot bind to interface %s",
1983
elif error.errno == errno.ENODEV:
1984
logger.error("Interface %s does not exist,"
1985
" cannot bind", self.interface)
1208
1988
# Only bind(2) the socket if we really need to.
1209
1989
if self.server_address[0] or self.server_address[1]:
1210
1990
if not self.server_address[0]:
1211
1991
if self.address_family == socket.AF_INET6:
1212
any_address = u"::" # in6addr_any
1992
any_address = "::" # in6addr_any
1214
any_address = socket.INADDR_ANY
1994
any_address = "0.0.0.0" # INADDR_ANY
1215
1995
self.server_address = (any_address,
1216
1996
self.server_address[1])
1217
1997
elif not self.server_address[1]:
1239
2019
def __init__(self, server_address, RequestHandlerClass,
1240
2020
interface=None, use_ipv6=True, clients=None,
1241
gnutls_priority=None, use_dbus=True):
2021
gnutls_priority=None, use_dbus=True, socketfd=None):
1242
2022
self.enabled = False
1243
2023
self.clients = clients
1244
2024
if self.clients is None:
1245
self.clients = set()
1246
2026
self.use_dbus = use_dbus
1247
2027
self.gnutls_priority = gnutls_priority
1248
2028
IPv6_TCPServer.__init__(self, server_address,
1249
2029
RequestHandlerClass,
1250
2030
interface = interface,
1251
use_ipv6 = use_ipv6)
2031
use_ipv6 = use_ipv6,
2032
socketfd = socketfd)
1252
2033
def server_activate(self):
1253
2034
if self.enabled:
1254
2035
return socketserver.TCPServer.server_activate(self)
1255
2037
def enable(self):
1256
2038
self.enabled = True
1257
def add_pipe_fds(self, child_pipe_fd, parent_pipe_fd):
2040
def add_pipe(self, parent_pipe, proc):
1258
2041
# Call "handle_ipc" for both data and EOF events
1259
gobject.io_add_watch(child_pipe_fd.fileno(),
2042
gobject.io_add_watch(parent_pipe.fileno(),
1260
2043
gobject.IO_IN | gobject.IO_HUP,
1261
2044
functools.partial(self.handle_ipc,
1262
reply = parent_pipe_fd,
1263
sender= child_pipe_fd))
1264
def handle_ipc(self, source, condition, reply=None, sender=None):
1266
gobject.IO_IN: u"IN", # There is data to read.
1267
gobject.IO_OUT: u"OUT", # Data can be written (without
1269
gobject.IO_PRI: u"PRI", # There is urgent data to read.
1270
gobject.IO_ERR: u"ERR", # Error condition.
1271
gobject.IO_HUP: u"HUP" # Hung up (the connection has been
1272
# broken, usually for pipes and
1275
conditions_string = ' | '.join(name
1277
condition_names.iteritems()
1278
if cond & condition)
1279
logger.debug(u"Handling IPC: FD = %d, condition = %s", source,
1282
# Read a line from the file object
1283
cmdline = sender.readline()
1284
if not cmdline: # Empty line means end of file
1285
# close the IPC pipes
1289
# Stop calling this function
1292
logger.debug(u"IPC command: %r", cmdline)
1294
# Parse and act on command
1295
cmd, args = cmdline.rstrip(u"\r\n").split(None, 1)
1297
if cmd == u"NOTFOUND":
1298
fpr, address = args.split(None, 1)
1299
logger.warning(u"Client not found for fingerprint: %s, ad"
1300
u"dress: %s", fpr, address)
1303
mandos_dbus_service.ClientNotFound(fpr, address)
1304
elif cmd == u"DISABLED":
1305
for client in self.clients:
1306
if client.name == args:
1307
logger.warning(u"Client %s is disabled", args)
1313
logger.error(u"Unknown client %s is disabled", args)
1314
elif cmd == u"SENDING":
1315
for client in self.clients:
1316
if client.name == args:
1317
logger.info(u"Sending secret to %s", client.name)
1324
logger.error(u"Sending secret to unknown client %s",
1326
elif cmd == u"GETATTR":
1327
attr_name, fpr = args.split(None, 1)
1328
for client in self.clients:
1329
if client.fingerprint == fpr:
1330
attr_value = getattr(client, attr_name, None)
1331
logger.debug("IPC reply: %r", attr_value)
1332
pickle.dump(attr_value, reply)
1335
logger.error(u"Client %s on address %s requesting "
1336
u"attribute %s not found", fpr, address,
1338
pickle.dump(None, reply)
2049
def handle_ipc(self, source, condition, parent_pipe=None,
2050
proc = None, client_object=None):
2051
# error, or the other end of multiprocessing.Pipe has closed
2052
if condition & (gobject.IO_ERR | gobject.IO_HUP):
2053
# Wait for other process to exit
2057
# Read a request from the child
2058
request = parent_pipe.recv()
2059
command = request[0]
2061
if command == 'init':
2063
address = request[2]
2065
for c in self.clients.itervalues():
2066
if c.fingerprint == fpr:
2070
logger.info("Client not found for fingerprint: %s, ad"
2071
"dress: %s", fpr, address)
2074
mandos_dbus_service.ClientNotFound(fpr,
2076
parent_pipe.send(False)
2079
gobject.io_add_watch(parent_pipe.fileno(),
2080
gobject.IO_IN | gobject.IO_HUP,
2081
functools.partial(self.handle_ipc,
2087
parent_pipe.send(True)
2088
# remove the old hook in favor of the new above hook on
2091
if command == 'funcall':
2092
funcname = request[1]
2096
parent_pipe.send(('data', getattr(client_object,
2100
if command == 'getattr':
2101
attrname = request[1]
2102
if callable(client_object.__getattribute__(attrname)):
2103
parent_pipe.send(('function',))
2105
parent_pipe.send(('data', client_object
2106
.__getattribute__(attrname)))
2108
if command == 'setattr':
2109
attrname = request[1]
2111
setattr(client_object, attrname, value)
2116
def rfc3339_duration_to_delta(duration):
2117
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2119
>>> rfc3339_duration_to_delta("P7D")
2120
datetime.timedelta(7)
2121
>>> rfc3339_duration_to_delta("PT60S")
2122
datetime.timedelta(0, 60)
2123
>>> rfc3339_duration_to_delta("PT60M")
2124
datetime.timedelta(0, 3600)
2125
>>> rfc3339_duration_to_delta("PT24H")
2126
datetime.timedelta(1)
2127
>>> rfc3339_duration_to_delta("P1W")
2128
datetime.timedelta(7)
2129
>>> rfc3339_duration_to_delta("PT5M30S")
2130
datetime.timedelta(0, 330)
2131
>>> rfc3339_duration_to_delta("P1DT3M20S")
2132
datetime.timedelta(1, 200)
2135
# Parsing an RFC 3339 duration with regular expressions is not
2136
# possible - there would have to be multiple places for the same
2137
# values, like seconds. The current code, while more esoteric, is
2138
# cleaner without depending on a parsing library. If Python had a
2139
# built-in library for parsing we would use it, but we'd like to
2140
# avoid excessive use of external libraries.
2142
# New type for defining tokens, syntax, and semantics all-in-one
2143
Token = collections.namedtuple("Token",
2144
("regexp", # To match token; if
2145
# "value" is not None,
2146
# must have a "group"
2148
"value", # datetime.timedelta or
2150
"followers")) # Tokens valid after
2152
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2153
# the "duration" ABNF definition in RFC 3339, Appendix A.
2154
token_end = Token(re.compile(r"$"), None, frozenset())
2155
token_second = Token(re.compile(r"(\d+)S"),
2156
datetime.timedelta(seconds=1),
2157
frozenset((token_end,)))
2158
token_minute = Token(re.compile(r"(\d+)M"),
2159
datetime.timedelta(minutes=1),
2160
frozenset((token_second, token_end)))
2161
token_hour = Token(re.compile(r"(\d+)H"),
2162
datetime.timedelta(hours=1),
2163
frozenset((token_minute, token_end)))
2164
token_time = Token(re.compile(r"T"),
2166
frozenset((token_hour, token_minute,
2168
token_day = Token(re.compile(r"(\d+)D"),
2169
datetime.timedelta(days=1),
2170
frozenset((token_time, token_end)))
2171
token_month = Token(re.compile(r"(\d+)M"),
2172
datetime.timedelta(weeks=4),
2173
frozenset((token_day, token_end)))
2174
token_year = Token(re.compile(r"(\d+)Y"),
2175
datetime.timedelta(weeks=52),
2176
frozenset((token_month, token_end)))
2177
token_week = Token(re.compile(r"(\d+)W"),
2178
datetime.timedelta(weeks=1),
2179
frozenset((token_end,)))
2180
token_duration = Token(re.compile(r"P"), None,
2181
frozenset((token_year, token_month,
2182
token_day, token_time,
2184
# Define starting values
2185
value = datetime.timedelta() # Value so far
2187
followers = frozenset(token_duration,) # Following valid tokens
2188
s = duration # String left to parse
2189
# Loop until end token is found
2190
while found_token is not token_end:
2191
# Search for any currently valid tokens
2192
for token in followers:
2193
match = token.regexp.match(s)
2194
if match is not None:
2196
if token.value is not None:
2197
# Value found, parse digits
2198
factor = int(match.group(1), 10)
2199
# Add to value so far
2200
value += factor * token.value
2201
# Strip token from string
2202
s = token.regexp.sub("", s, 1)
2205
# Set valid next tokens
2206
followers = found_token.followers
1340
logger.error(u"Unknown IPC command: %r", cmdline)
1342
# Keep calling this function
2209
# No currently valid tokens were found
2210
raise ValueError("Invalid RFC 3339 duration")
1346
2215
def string_to_delta(interval):
1347
2216
"""Parse a string and return a datetime.timedelta
1349
>>> string_to_delta(u'7d')
2218
>>> string_to_delta('7d')
1350
2219
datetime.timedelta(7)
1351
>>> string_to_delta(u'60s')
2220
>>> string_to_delta('60s')
1352
2221
datetime.timedelta(0, 60)
1353
>>> string_to_delta(u'60m')
2222
>>> string_to_delta('60m')
1354
2223
datetime.timedelta(0, 3600)
1355
>>> string_to_delta(u'24h')
2224
>>> string_to_delta('24h')
1356
2225
datetime.timedelta(1)
1357
>>> string_to_delta(u'1w')
2226
>>> string_to_delta('1w')
1358
2227
datetime.timedelta(7)
1359
>>> string_to_delta(u'5m 30s')
2228
>>> string_to_delta('5m 30s')
1360
2229
datetime.timedelta(0, 330)
2233
return rfc3339_duration_to_delta(interval)
1362
2237
timevalue = datetime.timedelta(0)
1363
2238
for s in interval.split():
1365
2240
suffix = unicode(s[-1])
1366
2241
value = int(s[:-1])
1368
2243
delta = datetime.timedelta(value)
1369
elif suffix == u"s":
1370
2245
delta = datetime.timedelta(0, value)
1371
elif suffix == u"m":
1372
2247
delta = datetime.timedelta(0, 0, 0, 0, value)
1373
elif suffix == u"h":
1374
2249
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
1375
elif suffix == u"w":
1376
2251
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
1378
raise ValueError(u"Unknown suffix %r" % suffix)
1379
except (ValueError, IndexError), e:
1380
raise ValueError(e.message)
2253
raise ValueError("Unknown suffix {0!r}"
2255
except (ValueError, IndexError) as e:
2256
raise ValueError(*(e.args))
1381
2257
timevalue += delta
1382
2258
return timevalue
1385
def if_nametoindex(interface):
1386
"""Call the C function if_nametoindex(), or equivalent
1388
Note: This function cannot accept a unicode string."""
1389
global if_nametoindex
1391
if_nametoindex = (ctypes.cdll.LoadLibrary
1392
(ctypes.util.find_library(u"c"))
1394
except (OSError, AttributeError):
1395
logger.warning(u"Doing if_nametoindex the hard way")
1396
def if_nametoindex(interface):
1397
"Get an interface index the hard way, i.e. using fcntl()"
1398
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
1399
with contextlib.closing(socket.socket()) as s:
1400
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1401
struct.pack(str(u"16s16x"),
1403
interface_index = struct.unpack(str(u"I"),
1405
return interface_index
1406
return if_nametoindex(interface)
1409
2261
def daemon(nochdir = False, noclose = False):
1410
2262
"""See daemon(3). Standard BSD Unix function.
1436
2288
##################################################################
1437
2289
# Parsing of options, both command line and config file
1439
parser = optparse.OptionParser(version = "%%prog %s" % version)
1440
parser.add_option("-i", u"--interface", type=u"string",
1441
metavar="IF", help=u"Bind to interface IF")
1442
parser.add_option("-a", u"--address", type=u"string",
1443
help=u"Address to listen for requests on")
1444
parser.add_option("-p", u"--port", type=u"int",
1445
help=u"Port number to receive requests on")
1446
parser.add_option("--check", action=u"store_true",
1447
help=u"Run self-test")
1448
parser.add_option("--debug", action=u"store_true",
1449
help=u"Debug mode; run in foreground and log to"
1451
parser.add_option("--priority", type=u"string", help=u"GnuTLS"
1452
u" priority string (see GnuTLS documentation)")
1453
parser.add_option("--servicename", type=u"string",
1454
metavar=u"NAME", help=u"Zeroconf service name")
1455
parser.add_option("--configdir", type=u"string",
1456
default=u"/etc/mandos", metavar=u"DIR",
1457
help=u"Directory to search for configuration"
1459
parser.add_option("--no-dbus", action=u"store_false",
1460
dest=u"use_dbus", help=u"Do not provide D-Bus"
1461
u" system bus interface")
1462
parser.add_option("--no-ipv6", action=u"store_false",
1463
dest=u"use_ipv6", help=u"Do not use IPv6")
1464
options = parser.parse_args()[0]
2291
parser = argparse.ArgumentParser()
2292
parser.add_argument("-v", "--version", action="version",
2293
version = "%(prog)s {0}".format(version),
2294
help="show version number and exit")
2295
parser.add_argument("-i", "--interface", metavar="IF",
2296
help="Bind to interface IF")
2297
parser.add_argument("-a", "--address",
2298
help="Address to listen for requests on")
2299
parser.add_argument("-p", "--port", type=int,
2300
help="Port number to receive requests on")
2301
parser.add_argument("--check", action="store_true",
2302
help="Run self-test")
2303
parser.add_argument("--debug", action="store_true",
2304
help="Debug mode; run in foreground and log"
2305
" to terminal", default=None)
2306
parser.add_argument("--debuglevel", metavar="LEVEL",
2307
help="Debug level for stdout output")
2308
parser.add_argument("--priority", help="GnuTLS"
2309
" priority string (see GnuTLS documentation)")
2310
parser.add_argument("--servicename",
2311
metavar="NAME", help="Zeroconf service name")
2312
parser.add_argument("--configdir",
2313
default="/etc/mandos", metavar="DIR",
2314
help="Directory to search for configuration"
2316
parser.add_argument("--no-dbus", action="store_false",
2317
dest="use_dbus", help="Do not provide D-Bus"
2318
" system bus interface", default=None)
2319
parser.add_argument("--no-ipv6", action="store_false",
2320
dest="use_ipv6", help="Do not use IPv6",
2322
parser.add_argument("--no-restore", action="store_false",
2323
dest="restore", help="Do not restore stored"
2324
" state", default=None)
2325
parser.add_argument("--socket", type=int,
2326
help="Specify a file descriptor to a network"
2327
" socket to use instead of creating one")
2328
parser.add_argument("--statedir", metavar="DIR",
2329
help="Directory to save/restore state in")
2330
parser.add_argument("--foreground", action="store_true",
2331
help="Run in foreground", default=None)
2333
options = parser.parse_args()
1466
2335
if options.check:
1509
2393
for option in server_settings.keys():
1510
2394
if type(server_settings[option]) is str:
1511
2395
server_settings[option] = unicode(server_settings[option])
2396
# Force all boolean options to be boolean
2397
for option in ("debug", "use_dbus", "use_ipv6", "restore",
2399
server_settings[option] = bool(server_settings[option])
2400
# Debug implies foreground
2401
if server_settings["debug"]:
2402
server_settings["foreground"] = True
1512
2403
# Now we have our good server settings in "server_settings"
1514
2405
##################################################################
1516
2407
# For convenience
1517
debug = server_settings[u"debug"]
1518
use_dbus = server_settings[u"use_dbus"]
1519
use_ipv6 = server_settings[u"use_ipv6"]
1522
syslogger.setLevel(logging.WARNING)
1523
console.setLevel(logging.WARNING)
1525
if server_settings[u"servicename"] != u"Mandos":
2408
debug = server_settings["debug"]
2409
debuglevel = server_settings["debuglevel"]
2410
use_dbus = server_settings["use_dbus"]
2411
use_ipv6 = server_settings["use_ipv6"]
2412
stored_state_path = os.path.join(server_settings["statedir"],
2414
foreground = server_settings["foreground"]
2417
initlogger(debug, logging.DEBUG)
2422
level = getattr(logging, debuglevel.upper())
2423
initlogger(debug, level)
2425
if server_settings["servicename"] != "Mandos":
1526
2426
syslogger.setFormatter(logging.Formatter
1527
(u'Mandos (%s) [%%(process)d]:'
1528
u' %%(levelname)s: %%(message)s'
1529
% server_settings[u"servicename"]))
2427
('Mandos ({0}) [%(process)d]:'
2428
' %(levelname)s: %(message)s'
2429
.format(server_settings
1531
2432
# Parse config file with clients
1532
client_defaults = { u"timeout": u"1h",
1534
u"checker": u"fping -q -- %%(host)s",
1537
client_config = configparser.SafeConfigParser(client_defaults)
1538
client_config.read(os.path.join(server_settings[u"configdir"],
2433
client_config = configparser.SafeConfigParser(Client
2435
client_config.read(os.path.join(server_settings["configdir"],
1541
2438
global mandos_dbus_service
1542
2439
mandos_dbus_service = None
1544
tcp_server = MandosServer((server_settings[u"address"],
1545
server_settings[u"port"]),
2441
tcp_server = MandosServer((server_settings["address"],
2442
server_settings["port"]),
1547
interface=server_settings[u"interface"],
2444
interface=(server_settings["interface"]
1548
2446
use_ipv6=use_ipv6,
1549
2447
gnutls_priority=
1550
server_settings[u"priority"],
1552
pidfilename = u"/var/run/mandos.pid"
1554
pidfile = open(pidfilename, u"w")
1556
logger.error(u"Could not open file %r", pidfilename)
2448
server_settings["priority"],
2450
socketfd=(server_settings["socket"]
2453
pidfilename = "/var/run/mandos.pid"
2456
pidfile = open(pidfilename, "w")
2457
except IOError as e:
2458
logger.error("Could not open file %r", pidfilename,
1559
uid = pwd.getpwnam(u"_mandos").pw_uid
1560
gid = pwd.getpwnam(u"_mandos").pw_gid
2461
for name in ("_mandos", "mandos", "nobody"):
1563
uid = pwd.getpwnam(u"mandos").pw_uid
1564
gid = pwd.getpwnam(u"mandos").pw_gid
2463
uid = pwd.getpwnam(name).pw_uid
2464
gid = pwd.getpwnam(name).pw_gid
1565
2466
except KeyError:
1567
uid = pwd.getpwnam(u"nobody").pw_uid
1568
gid = pwd.getpwnam(u"nobody").pw_gid
1575
except OSError, error:
1576
if error[0] != errno.EPERM:
2474
except OSError as error:
2475
if error.errno != errno.EPERM:
1579
# Enable all possible GnuTLS debugging
2479
# Enable all possible GnuTLS debugging
1581
2481
# "Use a log level over 10 to enable all debugging options."
1582
2482
# - GnuTLS manual
1583
2483
gnutls.library.functions.gnutls_global_set_log_level(11)
1585
2485
@gnutls.library.types.gnutls_log_func
1586
2486
def debug_gnutls(level, string):
1587
logger.debug(u"GnuTLS: %s", string[:-1])
2487
logger.debug("GnuTLS: %s", string[:-1])
1589
2489
(gnutls.library.functions
1590
2490
.gnutls_global_set_log_function(debug_gnutls))
2492
# Redirect stdin so all checkers get /dev/null
2493
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2494
os.dup2(null, sys.stdin.fileno())
2498
# Need to fork before connecting to D-Bus
2500
# Close all input and output, do double fork, etc.
2503
# multiprocessing will use threads, so before we use gobject we
2504
# need to inform gobject that threads will be used.
2505
gobject.threads_init()
1592
2507
global main_loop
1593
2508
# From the Avahi example code
1594
DBusGMainLoop(set_as_default=True )
2509
DBusGMainLoop(set_as_default=True)
1595
2510
main_loop = gobject.MainLoop()
1596
2511
bus = dbus.SystemBus()
1597
2512
# End of Avahi example code
1600
bus_name = dbus.service.BusName(u"se.bsnet.fukt.Mandos",
2515
bus_name = dbus.service.BusName("se.recompile.Mandos",
1601
2516
bus, do_not_queue=True)
1602
except dbus.exceptions.NameExistsException, e:
1603
logger.error(unicode(e) + u", disabling D-Bus")
2517
old_bus_name = (dbus.service.BusName
2518
("se.bsnet.fukt.Mandos", bus,
2520
except dbus.exceptions.NameExistsException as e:
2521
logger.error("Disabling D-Bus:", exc_info=e)
1604
2522
use_dbus = False
1605
server_settings[u"use_dbus"] = False
2523
server_settings["use_dbus"] = False
1606
2524
tcp_server.use_dbus = False
1607
2525
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1608
service = AvahiService(name = server_settings[u"servicename"],
1609
servicetype = u"_mandos._tcp",
1610
protocol = protocol, bus = bus)
2526
service = AvahiServiceToSyslog(name =
2527
server_settings["servicename"],
2528
servicetype = "_mandos._tcp",
2529
protocol = protocol, bus = bus)
1611
2530
if server_settings["interface"]:
1612
2531
service.interface = (if_nametoindex
1613
(str(server_settings[u"interface"])))
2532
(str(server_settings["interface"])))
2534
global multiprocessing_manager
2535
multiprocessing_manager = multiprocessing.Manager()
1615
2537
client_class = Client
1617
2539
client_class = functools.partial(ClientDBus, bus = bus)
1618
tcp_server.clients.update(set(
1619
client_class(name = section,
1620
config= dict(client_config.items(section)))
1621
for section in client_config.sections()))
2541
client_settings = Client.config_parser(client_config)
2542
old_client_settings = {}
2545
# This is used to redirect stdout and stderr for checker processes
2547
wnull = open(os.devnull, "w") # A writable /dev/null
2548
# Only used if server is running in foreground but not in debug
2550
if debug or not foreground:
2553
# Get client data and settings from last running state.
2554
if server_settings["restore"]:
2556
with open(stored_state_path, "rb") as stored_state:
2557
clients_data, old_client_settings = (pickle.load
2559
os.remove(stored_state_path)
2560
except IOError as e:
2561
if e.errno == errno.ENOENT:
2562
logger.warning("Could not load persistent state: {0}"
2563
.format(os.strerror(e.errno)))
2565
logger.critical("Could not load persistent state:",
2568
except EOFError as e:
2569
logger.warning("Could not load persistent state: "
2570
"EOFError:", exc_info=e)
2572
with PGPEngine() as pgp:
2573
for client_name, client in clients_data.iteritems():
2574
# Skip removed clients
2575
if client_name not in client_settings:
2578
# Decide which value to use after restoring saved state.
2579
# We have three different values: Old config file,
2580
# new config file, and saved state.
2581
# New config value takes precedence if it differs from old
2582
# config value, otherwise use saved state.
2583
for name, value in client_settings[client_name].items():
2585
# For each value in new config, check if it
2586
# differs from the old config value (Except for
2587
# the "secret" attribute)
2588
if (name != "secret" and
2589
value != old_client_settings[client_name]
2591
client[name] = value
2595
# Clients who has passed its expire date can still be
2596
# enabled if its last checker was successful. Clients
2597
# whose checker succeeded before we stored its state is
2598
# assumed to have successfully run all checkers during
2600
if client["enabled"]:
2601
if datetime.datetime.utcnow() >= client["expires"]:
2602
if not client["last_checked_ok"]:
2604
"disabling client {0} - Client never "
2605
"performed a successful checker"
2606
.format(client_name))
2607
client["enabled"] = False
2608
elif client["last_checker_status"] != 0:
2610
"disabling client {0} - Client "
2611
"last checker failed with error code {1}"
2612
.format(client_name,
2613
client["last_checker_status"]))
2614
client["enabled"] = False
2616
client["expires"] = (datetime.datetime
2618
+ client["timeout"])
2619
logger.debug("Last checker succeeded,"
2620
" keeping {0} enabled"
2621
.format(client_name))
2623
client["secret"] = (
2624
pgp.decrypt(client["encrypted_secret"],
2625
client_settings[client_name]
2628
# If decryption fails, we use secret from new settings
2629
logger.debug("Failed to decrypt {0} old secret"
2630
.format(client_name))
2631
client["secret"] = (
2632
client_settings[client_name]["secret"])
2634
# Add/remove clients based on new changes made to config
2635
for client_name in (set(old_client_settings)
2636
- set(client_settings)):
2637
del clients_data[client_name]
2638
for client_name in (set(client_settings)
2639
- set(old_client_settings)):
2640
clients_data[client_name] = client_settings[client_name]
2642
# Create all client objects
2643
for client_name, client in clients_data.iteritems():
2644
tcp_server.clients[client_name] = client_class(
2645
name = client_name, settings = client,
2646
server_settings = server_settings)
1622
2648
if not tcp_server.clients:
1623
logger.warning(u"No clients defined")
1626
# Redirect stdin so all checkers get /dev/null
1627
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
1628
os.dup2(null, sys.stdin.fileno())
1632
# No console logging
1633
logger.removeHandler(console)
1634
# Close all input and output, do double fork, etc.
1640
pidfile.write(str(pid) + "\n")
2649
logger.warning("No clients defined")
2652
if pidfile is not None:
2656
pidfile.write(str(pid) + "\n".encode("utf-8"))
2658
logger.error("Could not write to file %r with PID %d",
1643
logger.error(u"Could not write to file %r with PID %d",
1646
# "pidfile" was never created
1651
signal.signal(signal.SIGINT, signal.SIG_IGN)
1652
2663
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1653
2664
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
1656
class MandosDBusService(dbus.service.Object):
2667
@alternate_dbus_interfaces({"se.recompile.Mandos":
2668
"se.bsnet.fukt.Mandos"})
2669
class MandosDBusService(DBusObjectWithProperties):
1657
2670
"""A D-Bus proxy object"""
1658
2671
def __init__(self):
1659
dbus.service.Object.__init__(self, bus, u"/")
1660
_interface = u"se.bsnet.fukt.Mandos"
1662
@dbus.service.signal(_interface, signature=u"o")
2672
dbus.service.Object.__init__(self, bus, "/")
2673
_interface = "se.recompile.Mandos"
2675
@dbus_interface_annotations(_interface)
2677
return { "org.freedesktop.DBus.Property"
2678
".EmitsChangedSignal":
2681
@dbus.service.signal(_interface, signature="o")
1663
2682
def ClientAdded(self, objpath):
1667
@dbus.service.signal(_interface, signature=u"ss")
2686
@dbus.service.signal(_interface, signature="ss")
1668
2687
def ClientNotFound(self, fingerprint, address):
1672
@dbus.service.signal(_interface, signature=u"os")
2691
@dbus.service.signal(_interface, signature="os")
1673
2692
def ClientRemoved(self, objpath, name):
1677
@dbus.service.method(_interface, out_signature=u"ao")
2696
@dbus.service.method(_interface, out_signature="ao")
1678
2697
def GetAllClients(self):
1680
2699
return dbus.Array(c.dbus_object_path
1681
for c in tcp_server.clients)
2701
tcp_server.clients.itervalues())
1683
2703
@dbus.service.method(_interface,
1684
out_signature=u"a{oa{sv}}")
2704
out_signature="a{oa{sv}}")
1685
2705
def GetAllClientsWithProperties(self):
1687
2707
return dbus.Dictionary(
1688
((c.dbus_object_path, c.GetAll(u""))
1689
for c in tcp_server.clients),
1690
signature=u"oa{sv}")
2708
((c.dbus_object_path, c.GetAll(""))
2709
for c in tcp_server.clients.itervalues()),
1692
@dbus.service.method(_interface, in_signature=u"o")
2712
@dbus.service.method(_interface, in_signature="o")
1693
2713
def RemoveClient(self, object_path):
1695
for c in tcp_server.clients:
2715
for c in tcp_server.clients.itervalues():
1696
2716
if c.dbus_object_path == object_path:
1697
tcp_server.clients.remove(c)
2717
del tcp_server.clients[c.name]
1698
2718
c.remove_from_connection()
1699
2719
# Don't signal anything except ClientRemoved
1700
2720
c.disable(quiet=True)