88
80
except ImportError:
89
81
SO_BINDTODEVICE = None
92
stored_state_file = "clients.pickle"
94
logger = logging.getLogger()
86
#logger = logging.getLogger(u'mandos')
87
logger = logging.Logger(u'mandos')
95
88
syslogger = (logging.handlers.SysLogHandler
96
89
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
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
encoded = b"mandos" + binascii.hexlify(password)
176
if len(encoded) > 2048:
177
# GnuPG can't handle long passwords, so encode differently
178
encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
179
.replace(b"\n", b"\\n")
180
.replace(b"\0", b"\\x00"))
183
def encrypt(self, data, password):
184
passphrase = self.password_encode(password)
185
with tempfile.NamedTemporaryFile(dir=self.tempdir
187
passfile.write(passphrase)
189
proc = subprocess.Popen(['gpg', '--symmetric',
193
stdin = subprocess.PIPE,
194
stdout = subprocess.PIPE,
195
stderr = subprocess.PIPE)
196
ciphertext, err = proc.communicate(input = data)
197
if proc.returncode != 0:
201
def decrypt(self, data, password):
202
passphrase = self.password_encode(password)
203
with tempfile.NamedTemporaryFile(dir = self.tempdir
205
passfile.write(passphrase)
207
proc = subprocess.Popen(['gpg', '--decrypt',
211
stdin = subprocess.PIPE,
212
stdout = subprocess.PIPE,
213
stderr = subprocess.PIPE)
214
decrypted_plaintext, err = proc.communicate(input
216
if proc.returncode != 0:
218
return decrypted_plaintext
90
address = "/dev/log"))
91
syslogger.setFormatter(logging.Formatter
92
(u'Mandos [%(process)d]: %(levelname)s:'
94
logger.addHandler(syslogger)
96
console = logging.StreamHandler()
97
console.setFormatter(logging.Formatter(u'%(name)s [%(process)d]:'
100
logger.addHandler(console)
221
102
class AvahiError(Exception):
222
103
def __init__(self, value, *args, **kwargs):
322
192
dbus.UInt16(self.port),
323
193
avahi.string_array_to_txt_array(self.TXT))
324
194
self.group.Commit()
326
195
def entry_group_state_changed(self, state, error):
327
196
"""Derived from the Avahi example code"""
328
logger.debug("Avahi entry group state change: %i", state)
197
logger.debug(u"Avahi entry group state change: %i", state)
330
199
if state == avahi.ENTRY_GROUP_ESTABLISHED:
331
logger.debug("Zeroconf service established.")
200
logger.debug(u"Zeroconf service established.")
332
201
elif state == avahi.ENTRY_GROUP_COLLISION:
333
logger.info("Zeroconf service name collision.")
202
logger.warning(u"Zeroconf service name collision.")
335
204
elif state == avahi.ENTRY_GROUP_FAILURE:
336
logger.critical("Avahi: Error in group state changed %s",
205
logger.critical(u"Avahi: Error in group state changed %s",
338
raise AvahiGroupError("State changed: {0!s}"
207
raise AvahiGroupError(u"State changed: %s"
341
209
def cleanup(self):
342
210
"""Derived from the Avahi example code"""
343
211
if self.group is not None:
346
except (dbus.exceptions.UnknownMethodException,
347
dbus.exceptions.DBusException):
349
213
self.group = None
352
def server_state_changed(self, state, error=None):
214
def server_state_changed(self, state):
353
215
"""Derived from the Avahi example code"""
354
logger.debug("Avahi server state change: %i", state)
355
bad_states = { avahi.SERVER_INVALID:
356
"Zeroconf server invalid",
357
avahi.SERVER_REGISTERING: None,
358
avahi.SERVER_COLLISION:
359
"Zeroconf server name collision",
360
avahi.SERVER_FAILURE:
361
"Zeroconf server failure" }
362
if state in bad_states:
363
if bad_states[state] is not None:
365
logger.error(bad_states[state])
367
logger.error(bad_states[state] + ": %r", error)
216
logger.debug(u"Avahi server state change: %i", state)
217
if state == avahi.SERVER_COLLISION:
218
logger.error(u"Zeroconf server name collision")
369
220
elif state == avahi.SERVER_RUNNING:
373
logger.debug("Unknown state: %r", state)
375
logger.debug("Unknown state: %r: %r", state, error)
377
222
def activate(self):
378
223
"""Derived from the Avahi example code"""
379
224
if self.server is None:
380
225
self.server = dbus.Interface(
381
226
self.bus.get_object(avahi.DBUS_NAME,
382
avahi.DBUS_PATH_SERVER,
383
follow_name_owner_changes=True),
227
avahi.DBUS_PATH_SERVER),
384
228
avahi.DBUS_INTERFACE_SERVER)
385
self.server.connect_to_signal("StateChanged",
229
self.server.connect_to_signal(u"StateChanged",
386
230
self.server_state_changed)
387
231
self.server_state_changed(self.server.GetState())
390
class AvahiServiceToSyslog(AvahiService):
392
"""Add the new name to the syslog messages"""
393
ret = AvahiService.rename(self)
394
syslogger.setFormatter(logging.Formatter
395
('Mandos ({0}) [%(process)d]:'
396
' %(levelname)s: %(message)s'
401
def timedelta_to_milliseconds(td):
402
"Convert a datetime.timedelta() to milliseconds"
403
return ((td.days * 24 * 60 * 60 * 1000)
404
+ (td.seconds * 1000)
405
+ (td.microseconds // 1000))
408
234
class Client(object):
409
235
"""A representation of a client host served by this server.
412
approved: bool(); 'None' if not yet approved/disapproved
413
approval_delay: datetime.timedelta(); Time to wait for approval
414
approval_duration: datetime.timedelta(); Duration of one approval
238
name: string; from the config file, used in log messages and
240
fingerprint: string (40 or 32 hexadecimal digits); used to
241
uniquely identify the client
242
secret: bytestring; sent verbatim (over TLS) to client
243
host: string; available for use by the checker command
244
created: datetime.datetime(); (UTC) object creation
245
last_enabled: datetime.datetime(); (UTC)
247
last_checked_ok: datetime.datetime(); (UTC) or None
248
timeout: datetime.timedelta(); How long from last_checked_ok
249
until this client is disabled
250
interval: datetime.timedelta(); How often to start a new checker
251
disable_hook: If set, called by disable() as disable_hook(self)
415
252
checker: subprocess.Popen(); a running checker process used
416
253
to see if the client lives.
417
254
'None' if no process is running.
418
checker_callback_tag: a gobject event source tag, or None
419
checker_command: string; External command which is run to check
420
if client lives. %() expansions are done at
255
checker_initiator_tag: a gobject event source tag, or None
256
disable_initiator_tag: - '' -
257
checker_callback_tag: - '' -
258
checker_command: string; External command which is run to check if
259
client lives. %() expansions are done at
421
260
runtime with vars(self) as dict, so that for
422
261
instance %(name)s can be used in the command.
423
checker_initiator_tag: a gobject event source tag, or None
424
created: datetime.datetime(); (UTC) object creation
425
client_structure: Object describing what attributes a client has
426
and is used for storing the client at exit
427
262
current_checker_command: string; current running checker_command
428
disable_initiator_tag: a gobject event source tag, or None
430
fingerprint: string (40 or 32 hexadecimal digits); used to
431
uniquely identify the client
432
host: string; available for use by the checker command
433
interval: datetime.timedelta(); How often to start a new checker
434
last_approval_request: datetime.datetime(); (UTC) or None
435
last_checked_ok: datetime.datetime(); (UTC) or None
436
last_checker_status: integer between 0 and 255 reflecting exit
437
status of last checker. -1 reflects crashed
438
checker, -2 means no checker completed yet.
439
last_enabled: datetime.datetime(); (UTC) or None
440
name: string; from the config file, used in log messages and
442
secret: bytestring; sent verbatim (over TLS) to client
443
timeout: datetime.timedelta(); How long from last_checked_ok
444
until this client is disabled
445
extended_timeout: extra long timeout when secret has been sent
446
runtime_expansions: Allowed attributes for runtime expansion.
447
expires: datetime.datetime(); time (UTC) when a client will be
449
server_settings: The server_settings dict from main()
263
approved_delay: datetime.timedelta(); Time to wait for approval
264
_approved: bool(); 'None' if not yet approved/disapproved
265
approved_duration: datetime.timedelta(); Duration of one approval
452
runtime_expansions = ("approval_delay", "approval_duration",
453
"created", "enabled", "expires",
454
"fingerprint", "host", "interval",
455
"last_approval_request", "last_checked_ok",
456
"last_enabled", "name", "timeout")
457
client_defaults = { "timeout": "PT5M",
458
"extended_timeout": "PT15M",
460
"checker": "fping -q -- %%(host)s",
462
"approval_delay": "PT0S",
463
"approval_duration": "PT1S",
464
"approved_by_default": "True",
269
def _timedelta_to_milliseconds(td):
270
"Convert a datetime.timedelta() to milliseconds"
271
return ((td.days * 24 * 60 * 60 * 1000)
272
+ (td.seconds * 1000)
273
+ (td.microseconds // 1000))
468
275
def timeout_milliseconds(self):
469
276
"Return the 'timeout' attribute in milliseconds"
470
return timedelta_to_milliseconds(self.timeout)
472
def extended_timeout_milliseconds(self):
473
"Return the 'extended_timeout' attribute in milliseconds"
474
return timedelta_to_milliseconds(self.extended_timeout)
277
return self._timedelta_to_milliseconds(self.timeout)
476
279
def interval_milliseconds(self):
477
280
"Return the 'interval' attribute in milliseconds"
478
return timedelta_to_milliseconds(self.interval)
480
def approval_delay_milliseconds(self):
481
return timedelta_to_milliseconds(self.approval_delay)
484
def config_parser(config):
485
"""Construct a new dict of client settings of this form:
486
{ client_name: {setting_name: value, ...}, ...}
487
with exceptions for any special settings as defined above.
488
NOTE: Must be a pure function. Must return the same result
489
value given the same arguments.
492
for client_name in config.sections():
493
section = dict(config.items(client_name))
494
client = settings[client_name] = {}
496
client["host"] = section["host"]
497
# Reformat values from string types to Python types
498
client["approved_by_default"] = config.getboolean(
499
client_name, "approved_by_default")
500
client["enabled"] = config.getboolean(client_name,
503
client["fingerprint"] = (section["fingerprint"].upper()
505
if "secret" in section:
506
client["secret"] = section["secret"].decode("base64")
507
elif "secfile" in section:
508
with open(os.path.expanduser(os.path.expandvars
509
(section["secfile"])),
511
client["secret"] = secfile.read()
513
raise TypeError("No secret or secfile for section {0}"
515
client["timeout"] = string_to_delta(section["timeout"])
516
client["extended_timeout"] = string_to_delta(
517
section["extended_timeout"])
518
client["interval"] = string_to_delta(section["interval"])
519
client["approval_delay"] = string_to_delta(
520
section["approval_delay"])
521
client["approval_duration"] = string_to_delta(
522
section["approval_duration"])
523
client["checker_command"] = section["checker"]
524
client["last_approval_request"] = None
525
client["last_checked_ok"] = None
526
client["last_checker_status"] = -2
530
def __init__(self, settings, name = None, server_settings=None):
281
return self._timedelta_to_milliseconds(self.interval)
283
def approved_delay_milliseconds(self):
284
return self._timedelta_to_milliseconds(self.approved_delay)
286
def __init__(self, name = None, disable_hook=None, config=None):
287
"""Note: the 'checker' key in 'config' sets the
288
'checker_command' attribute and *not* the 'checker'
532
if server_settings is None:
534
self.server_settings = server_settings
535
# adding all client settings
536
for setting, value in settings.iteritems():
537
setattr(self, setting, value)
540
if not hasattr(self, "last_enabled"):
541
self.last_enabled = datetime.datetime.utcnow()
542
if not hasattr(self, "expires"):
543
self.expires = (datetime.datetime.utcnow()
546
self.last_enabled = None
549
logger.debug("Creating client %r", self.name)
293
logger.debug(u"Creating client %r", self.name)
550
294
# Uppercase and remove spaces from fingerprint for later
551
295
# comparison purposes with return value from the fingerprint()
553
logger.debug(" Fingerprint: %s", self.fingerprint)
554
self.created = settings.get("created",
555
datetime.datetime.utcnow())
557
# attributes specific for this server instance
297
self.fingerprint = (config[u"fingerprint"].upper()
299
logger.debug(u" Fingerprint: %s", self.fingerprint)
300
if u"secret" in config:
301
self.secret = config[u"secret"].decode(u"base64")
302
elif u"secfile" in config:
303
with open(os.path.expanduser(os.path.expandvars
304
(config[u"secfile"])),
306
self.secret = secfile.read()
308
raise TypeError(u"No secret or secfile for client %s"
310
self.host = config.get(u"host", u"")
311
self.created = datetime.datetime.utcnow()
313
self.last_enabled = None
314
self.last_checked_ok = None
315
self.timeout = string_to_delta(config[u"timeout"])
316
self.interval = string_to_delta(config[u"interval"])
317
self.disable_hook = disable_hook
558
318
self.checker = None
559
319
self.checker_initiator_tag = None
560
320
self.disable_initiator_tag = None
561
321
self.checker_callback_tag = None
322
self.checker_command = config[u"checker"]
562
323
self.current_checker_command = None
324
self.last_connect = None
325
self._approved = None
326
self.approved_by_default = config.get(u"approved_by_default",
564
328
self.approvals_pending = 0
565
self.changedstate = (multiprocessing_manager
566
.Condition(multiprocessing_manager
568
self.client_structure = [attr for attr in
569
self.__dict__.iterkeys()
570
if not attr.startswith("_")]
571
self.client_structure.append("client_structure")
573
for name, t in inspect.getmembers(type(self),
577
if not name.startswith("_"):
578
self.client_structure.append(name)
329
self.approved_delay = string_to_delta(
330
config[u"approved_delay"])
331
self.approved_duration = string_to_delta(
332
config[u"approved_duration"])
333
self.changedstate = multiprocessing_manager.Condition(multiprocessing_manager.Lock())
580
# Send notice to process children that client state has changed
581
335
def send_changedstate(self):
582
with self.changedstate:
583
self.changedstate.notify_all()
336
self.changedstate.acquire()
337
self.changedstate.notify_all()
338
self.changedstate.release()
585
340
def enable(self):
586
341
"""Start this client's checker and timeout hooks"""
587
if getattr(self, "enabled", False):
342
if getattr(self, u"enabled", False):
588
343
# Already enabled
590
self.expires = datetime.datetime.utcnow() + self.timeout
345
self.send_changedstate()
592
346
self.last_enabled = datetime.datetime.utcnow()
594
self.send_changedstate()
596
def disable(self, quiet=True):
597
"""Disable this client."""
598
if not getattr(self, "enabled", False):
601
logger.info("Disabling client %s", self.name)
602
if getattr(self, "disable_initiator_tag", None) is not None:
603
gobject.source_remove(self.disable_initiator_tag)
604
self.disable_initiator_tag = None
606
if getattr(self, "checker_initiator_tag", None) is not None:
607
gobject.source_remove(self.checker_initiator_tag)
608
self.checker_initiator_tag = None
612
self.send_changedstate()
613
# Do not run this again if called by a gobject.timeout_add
619
def init_checker(self):
620
347
# Schedule a new checker to be started an 'interval' from now,
621
348
# and every interval from then on.
622
if self.checker_initiator_tag is not None:
623
gobject.source_remove(self.checker_initiator_tag)
624
349
self.checker_initiator_tag = (gobject.timeout_add
625
350
(self.interval_milliseconds(),
626
351
self.start_checker))
627
352
# Schedule a disable() when 'timeout' has passed
628
if self.disable_initiator_tag is not None:
629
gobject.source_remove(self.disable_initiator_tag)
630
353
self.disable_initiator_tag = (gobject.timeout_add
631
354
(self.timeout_milliseconds(),
633
357
# Also start a new checker *right now*.
634
358
self.start_checker()
360
def disable(self, quiet=True):
361
"""Disable this client."""
362
if not getattr(self, "enabled", False):
365
self.send_changedstate()
367
logger.info(u"Disabling client %s", self.name)
368
if getattr(self, u"disable_initiator_tag", False):
369
gobject.source_remove(self.disable_initiator_tag)
370
self.disable_initiator_tag = None
371
if getattr(self, u"checker_initiator_tag", False):
372
gobject.source_remove(self.checker_initiator_tag)
373
self.checker_initiator_tag = None
375
if self.disable_hook:
376
self.disable_hook(self)
378
# Do not run this again if called by a gobject.timeout_add
382
self.disable_hook = None
636
385
def checker_callback(self, pid, condition, command):
637
386
"""The checker has completed, so take appropriate actions."""
638
387
self.checker_callback_tag = None
639
388
self.checker = None
640
389
if os.WIFEXITED(condition):
641
self.last_checker_status = os.WEXITSTATUS(condition)
642
if self.last_checker_status == 0:
643
logger.info("Checker for %(name)s succeeded",
390
exitstatus = os.WEXITSTATUS(condition)
392
logger.info(u"Checker for %(name)s succeeded",
645
394
self.checked_ok()
647
logger.info("Checker for %(name)s failed",
396
logger.info(u"Checker for %(name)s failed",
650
self.last_checker_status = -1
651
logger.warning("Checker for %(name)s crashed?",
399
logger.warning(u"Checker for %(name)s crashed?",
654
402
def checked_ok(self):
655
"""Assert that the client has been seen, alive and well."""
403
"""Bump up the timeout for this client.
405
This should only be called when the client has been seen,
656
408
self.last_checked_ok = datetime.datetime.utcnow()
657
self.last_checker_status = 0
660
def bump_timeout(self, timeout=None):
661
"""Bump up the timeout for this client."""
663
timeout = self.timeout
664
if self.disable_initiator_tag is not None:
665
gobject.source_remove(self.disable_initiator_tag)
666
self.disable_initiator_tag = None
667
if getattr(self, "enabled", False):
668
self.disable_initiator_tag = (gobject.timeout_add
669
(timedelta_to_milliseconds
670
(timeout), self.disable))
671
self.expires = datetime.datetime.utcnow() + timeout
673
def need_approval(self):
674
self.last_approval_request = datetime.datetime.utcnow()
409
gobject.source_remove(self.disable_initiator_tag)
410
self.disable_initiator_tag = (gobject.timeout_add
411
(self.timeout_milliseconds(),
676
414
def start_checker(self):
677
415
"""Start a new checker subprocess if one is not running.
690
428
# If a checker exists, make sure it is not a zombie
692
430
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
693
except (AttributeError, OSError) as error:
431
except (AttributeError, OSError), error:
694
432
if (isinstance(error, OSError)
695
433
and error.errno != errno.ECHILD):
699
logger.warning("Checker was a zombie")
437
logger.warning(u"Checker was a zombie")
700
438
gobject.source_remove(self.checker_callback_tag)
701
439
self.checker_callback(pid, status,
702
440
self.current_checker_command)
703
441
# Start a new checker if needed
704
442
if self.checker is None:
705
# Escape attributes for the shell
706
escaped_attrs = dict(
707
(attr, re.escape(unicode(getattr(self, attr))))
709
self.runtime_expansions)
711
command = self.checker_command % escaped_attrs
712
except TypeError as error:
713
logger.error('Could not format string "%s"',
714
self.checker_command, exc_info=error)
715
return True # Try again later
444
# In case checker_command has exactly one % operator
445
command = self.checker_command % self.host
447
# Escape attributes for the shell
448
escaped_attrs = dict((key,
449
re.escape(unicode(str(val),
453
vars(self).iteritems())
455
command = self.checker_command % escaped_attrs
456
except TypeError, error:
457
logger.error(u'Could not format string "%s":'
458
u' %s', self.checker_command, error)
459
return True # Try again later
716
460
self.current_checker_command = command
718
logger.info("Starting checker %r for %s",
462
logger.info(u"Starting checker %r for %s",
719
463
command, self.name)
720
464
# We don't need to redirect stdout and stderr, since
721
465
# in normal mode, that is already done by daemon(),
722
466
# and in debug mode we don't want to. (Stdin is
723
467
# always replaced by /dev/null.)
724
# The exception is when not debugging but nevertheless
725
# running in the foreground; use the previously
728
if (not self.server_settings["debug"]
729
and self.server_settings["foreground"]):
730
popen_args.update({"stdout": wnull,
732
468
self.checker = subprocess.Popen(command,
736
except OSError as error:
737
logger.error("Failed to start subprocess",
740
self.checker_callback_tag = (gobject.child_watch_add
742
self.checker_callback,
744
# The checker may have completed before the gobject
745
# watch was added. Check for this.
470
shell=True, cwd=u"/")
471
self.checker_callback_tag = (gobject.child_watch_add
473
self.checker_callback,
475
# The checker may have completed before the gobject
476
# watch was added. Check for this.
747
477
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
748
except OSError as error:
749
if error.errno == errno.ECHILD:
750
# This should never happen
751
logger.error("Child process vanished",
756
gobject.source_remove(self.checker_callback_tag)
757
self.checker_callback(pid, status, command)
479
gobject.source_remove(self.checker_callback_tag)
480
self.checker_callback(pid, status, command)
481
except OSError, error:
482
logger.error(u"Failed to start subprocess: %s",
758
484
# Re-run this periodically if run by gobject.timeout_add
866
554
class DBusObjectWithProperties(dbus.service.Object):
867
555
"""A D-Bus object with properties.
869
557
Classes inheriting from this can use the dbus_service_property
870
558
decorator to expose methods as D-Bus properties. It exposes the
871
559
standard Get(), Set(), and GetAll() methods on the D-Bus.
875
def _is_dbus_thing(thing):
876
"""Returns a function testing if an attribute is a D-Bus thing
878
If called like _is_dbus_thing("method") it returns a function
879
suitable for use as predicate to inspect.getmembers().
881
return lambda obj: getattr(obj, "_dbus_is_{0}".format(thing),
563
def _is_dbus_property(obj):
564
return getattr(obj, u"_dbus_is_property", False)
884
def _get_all_dbus_things(self, thing):
566
def _get_all_dbus_properties(self):
885
567
"""Returns a generator of (name, attribute) pairs
887
return ((getattr(athing.__get__(self), "_dbus_name",
889
athing.__get__(self))
890
for cls in self.__class__.__mro__
892
inspect.getmembers(cls,
893
self._is_dbus_thing(thing)))
569
return ((prop._dbus_name, prop)
571
inspect.getmembers(self, self._is_dbus_property))
895
573
def _get_dbus_property(self, interface_name, property_name):
896
574
"""Returns a bound method if one exists which is a D-Bus
897
575
property with the specified name and interface.
899
for cls in self.__class__.__mro__:
900
for name, value in (inspect.getmembers
902
self._is_dbus_thing("property"))):
903
if (value._dbus_name == property_name
904
and value._dbus_interface == interface_name):
905
return value.__get__(self)
577
for name in (property_name,
578
property_name + u"_dbus_property"):
579
prop = getattr(self, name, None)
581
or not self._is_dbus_property(prop)
582
or prop._dbus_name != property_name
583
or (interface_name and prop._dbus_interface
584
and interface_name != prop._dbus_interface)):
907
587
# No such property
908
raise DBusPropertyNotFound(self.dbus_object_path + ":"
909
+ interface_name + "."
588
raise DBusPropertyNotFound(self.dbus_object_path + u":"
589
+ interface_name + u"."
912
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
592
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ss",
914
594
def Get(self, interface_name, property_name):
915
595
"""Standard D-Bus property Get() method, see D-Bus standard.
917
597
prop = self._get_dbus_property(interface_name, property_name)
918
if prop._dbus_access == "write":
598
if prop._dbus_access == u"write":
919
599
raise DBusPropertyAccessException(property_name)
921
if not hasattr(value, "variant_level"):
601
if not hasattr(value, u"variant_level"):
923
603
return type(value)(value, variant_level=value.variant_level+1)
925
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
605
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ssv")
926
606
def Set(self, interface_name, property_name, value):
927
607
"""Standard D-Bus property Set() method, see D-Bus standard.
929
609
prop = self._get_dbus_property(interface_name, property_name)
930
if prop._dbus_access == "read":
610
if prop._dbus_access == u"read":
931
611
raise DBusPropertyAccessException(property_name)
932
if prop._dbus_get_args_options["byte_arrays"]:
612
if prop._dbus_get_args_options[u"byte_arrays"]:
933
613
# The byte_arrays option is not supported yet on
934
614
# signatures other than "ay".
935
if prop._dbus_signature != "ay":
615
if prop._dbus_signature != u"ay":
937
value = dbus.ByteArray(b''.join(chr(byte)
617
value = dbus.ByteArray(''.join(unichr(byte)
941
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
942
out_signature="a{sv}")
621
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"s",
622
out_signature=u"a{sv}")
943
623
def GetAll(self, interface_name):
944
624
"""Standard D-Bus property GetAll() method, see D-Bus
947
627
Note: Will not include properties with access="write".
950
for name, prop in self._get_all_dbus_things("property"):
630
for name, prop in self._get_all_dbus_properties():
951
631
if (interface_name
952
632
and interface_name != prop._dbus_interface):
953
633
# Interface non-empty but did not match
955
635
# Ignore write-only properties
956
if prop._dbus_access == "write":
636
if prop._dbus_access == u"write":
959
if not hasattr(value, "variant_level"):
960
properties[name] = value
639
if not hasattr(value, u"variant_level"):
962
properties[name] = type(value)(value, variant_level=
963
value.variant_level+1)
964
return dbus.Dictionary(properties, signature="sv")
642
all[name] = type(value)(value, variant_level=
643
value.variant_level+1)
644
return dbus.Dictionary(all, signature=u"sv")
966
646
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
968
648
path_keyword='object_path',
969
649
connection_keyword='connection')
970
650
def Introspect(self, object_path, connection):
971
"""Overloading of standard D-Bus method.
973
Inserts property tags and interface annotation tags.
651
"""Standard D-Bus method, overloaded to insert property tags.
975
653
xmlstring = dbus.service.Object.Introspect(self, object_path,
978
656
document = xml.dom.minidom.parseString(xmlstring)
979
657
def make_tag(document, name, prop):
980
e = document.createElement("property")
981
e.setAttribute("name", name)
982
e.setAttribute("type", prop._dbus_signature)
983
e.setAttribute("access", prop._dbus_access)
658
e = document.createElement(u"property")
659
e.setAttribute(u"name", name)
660
e.setAttribute(u"type", prop._dbus_signature)
661
e.setAttribute(u"access", prop._dbus_access)
985
for if_tag in document.getElementsByTagName("interface"):
663
for if_tag in document.getElementsByTagName(u"interface"):
987
664
for tag in (make_tag(document, name, prop)
989
in self._get_all_dbus_things("property")
666
in self._get_all_dbus_properties()
990
667
if prop._dbus_interface
991
== if_tag.getAttribute("name")):
668
== if_tag.getAttribute(u"name")):
992
669
if_tag.appendChild(tag)
993
# Add annotation tags
994
for typ in ("method", "signal", "property"):
995
for tag in if_tag.getElementsByTagName(typ):
997
for name, prop in (self.
998
_get_all_dbus_things(typ)):
999
if (name == tag.getAttribute("name")
1000
and prop._dbus_interface
1001
== if_tag.getAttribute("name")):
1002
annots.update(getattr
1004
"_dbus_annotations",
1006
for name, value in annots.iteritems():
1007
ann_tag = document.createElement(
1009
ann_tag.setAttribute("name", name)
1010
ann_tag.setAttribute("value", value)
1011
tag.appendChild(ann_tag)
1012
# Add interface annotation tags
1013
for annotation, value in dict(
1014
itertools.chain.from_iterable(
1015
annotations().iteritems()
1016
for name, annotations in
1017
self._get_all_dbus_things("interface")
1018
if name == if_tag.getAttribute("name")
1020
ann_tag = document.createElement("annotation")
1021
ann_tag.setAttribute("name", annotation)
1022
ann_tag.setAttribute("value", value)
1023
if_tag.appendChild(ann_tag)
1024
670
# Add the names to the return values for the
1025
671
# "org.freedesktop.DBus.Properties" methods
1026
if (if_tag.getAttribute("name")
1027
== "org.freedesktop.DBus.Properties"):
1028
for cn in if_tag.getElementsByTagName("method"):
1029
if cn.getAttribute("name") == "Get":
1030
for arg in cn.getElementsByTagName("arg"):
1031
if (arg.getAttribute("direction")
1033
arg.setAttribute("name", "value")
1034
elif cn.getAttribute("name") == "GetAll":
1035
for arg in cn.getElementsByTagName("arg"):
1036
if (arg.getAttribute("direction")
1038
arg.setAttribute("name", "props")
1039
xmlstring = document.toxml("utf-8")
672
if (if_tag.getAttribute(u"name")
673
== u"org.freedesktop.DBus.Properties"):
674
for cn in if_tag.getElementsByTagName(u"method"):
675
if cn.getAttribute(u"name") == u"Get":
676
for arg in cn.getElementsByTagName(u"arg"):
677
if (arg.getAttribute(u"direction")
679
arg.setAttribute(u"name", u"value")
680
elif cn.getAttribute(u"name") == u"GetAll":
681
for arg in cn.getElementsByTagName(u"arg"):
682
if (arg.getAttribute(u"direction")
684
arg.setAttribute(u"name", u"props")
685
xmlstring = document.toxml(u"utf-8")
1040
686
document.unlink()
1041
687
except (AttributeError, xml.dom.DOMException,
1042
xml.parsers.expat.ExpatError) as error:
1043
logger.error("Failed to override Introspection method",
688
xml.parsers.expat.ExpatError), error:
689
logger.error(u"Failed to override Introspection method",
1045
691
return xmlstring
1048
def datetime_to_dbus(dt, variant_level=0):
1049
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1051
return dbus.String("", variant_level = variant_level)
1052
return dbus.String(dt.isoformat(),
1053
variant_level=variant_level)
1056
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1057
"""A class decorator; applied to a subclass of
1058
dbus.service.Object, it will add alternate D-Bus attributes with
1059
interface names according to the "alt_interface_names" mapping.
1062
@alternate_dbus_interfaces({"org.example.Interface":
1063
"net.example.AlternateInterface"})
1064
class SampleDBusObject(dbus.service.Object):
1065
@dbus.service.method("org.example.Interface")
1066
def SampleDBusMethod():
1069
The above "SampleDBusMethod" on "SampleDBusObject" will be
1070
reachable via two interfaces: "org.example.Interface" and
1071
"net.example.AlternateInterface", the latter of which will have
1072
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1073
"true", unless "deprecate" is passed with a False value.
1075
This works for methods and signals, and also for D-Bus properties
1076
(from DBusObjectWithProperties) and interfaces (from the
1077
dbus_interface_annotations decorator).
1080
for orig_interface_name, alt_interface_name in (
1081
alt_interface_names.iteritems()):
1083
interface_names = set()
1084
# Go though all attributes of the class
1085
for attrname, attribute in inspect.getmembers(cls):
1086
# Ignore non-D-Bus attributes, and D-Bus attributes
1087
# with the wrong interface name
1088
if (not hasattr(attribute, "_dbus_interface")
1089
or not attribute._dbus_interface
1090
.startswith(orig_interface_name)):
1092
# Create an alternate D-Bus interface name based on
1094
alt_interface = (attribute._dbus_interface
1095
.replace(orig_interface_name,
1096
alt_interface_name))
1097
interface_names.add(alt_interface)
1098
# Is this a D-Bus signal?
1099
if getattr(attribute, "_dbus_is_signal", False):
1100
# Extract the original non-method undecorated
1101
# function by black magic
1102
nonmethod_func = (dict(
1103
zip(attribute.func_code.co_freevars,
1104
attribute.__closure__))["func"]
1106
# Create a new, but exactly alike, function
1107
# object, and decorate it to be a new D-Bus signal
1108
# with the alternate D-Bus interface name
1109
new_function = (dbus.service.signal
1111
attribute._dbus_signature)
1112
(types.FunctionType(
1113
nonmethod_func.func_code,
1114
nonmethod_func.func_globals,
1115
nonmethod_func.func_name,
1116
nonmethod_func.func_defaults,
1117
nonmethod_func.func_closure)))
1118
# Copy annotations, if any
1120
new_function._dbus_annotations = (
1121
dict(attribute._dbus_annotations))
1122
except AttributeError:
1124
# Define a creator of a function to call both the
1125
# original and alternate functions, so both the
1126
# original and alternate signals gets sent when
1127
# the function is called
1128
def fixscope(func1, func2):
1129
"""This function is a scope container to pass
1130
func1 and func2 to the "call_both" function
1131
outside of its arguments"""
1132
def call_both(*args, **kwargs):
1133
"""This function will emit two D-Bus
1134
signals by calling func1 and func2"""
1135
func1(*args, **kwargs)
1136
func2(*args, **kwargs)
1138
# Create the "call_both" function and add it to
1140
attr[attrname] = fixscope(attribute, new_function)
1141
# Is this a D-Bus method?
1142
elif getattr(attribute, "_dbus_is_method", False):
1143
# Create a new, but exactly alike, function
1144
# object. Decorate it to be a new D-Bus method
1145
# with the alternate D-Bus interface name. Add it
1147
attr[attrname] = (dbus.service.method
1149
attribute._dbus_in_signature,
1150
attribute._dbus_out_signature)
1152
(attribute.func_code,
1153
attribute.func_globals,
1154
attribute.func_name,
1155
attribute.func_defaults,
1156
attribute.func_closure)))
1157
# Copy annotations, if any
1159
attr[attrname]._dbus_annotations = (
1160
dict(attribute._dbus_annotations))
1161
except AttributeError:
1163
# Is this a D-Bus property?
1164
elif getattr(attribute, "_dbus_is_property", False):
1165
# Create a new, but exactly alike, function
1166
# object, and decorate it to be a new D-Bus
1167
# property with the alternate D-Bus interface
1168
# name. Add it to the class.
1169
attr[attrname] = (dbus_service_property
1171
attribute._dbus_signature,
1172
attribute._dbus_access,
1174
._dbus_get_args_options
1177
(attribute.func_code,
1178
attribute.func_globals,
1179
attribute.func_name,
1180
attribute.func_defaults,
1181
attribute.func_closure)))
1182
# Copy annotations, if any
1184
attr[attrname]._dbus_annotations = (
1185
dict(attribute._dbus_annotations))
1186
except AttributeError:
1188
# Is this a D-Bus interface?
1189
elif getattr(attribute, "_dbus_is_interface", False):
1190
# Create a new, but exactly alike, function
1191
# object. Decorate it to be a new D-Bus interface
1192
# with the alternate D-Bus interface name. Add it
1194
attr[attrname] = (dbus_interface_annotations
1197
(attribute.func_code,
1198
attribute.func_globals,
1199
attribute.func_name,
1200
attribute.func_defaults,
1201
attribute.func_closure)))
1203
# Deprecate all alternate interfaces
1204
iname="_AlternateDBusNames_interface_annotation{0}"
1205
for interface_name in interface_names:
1206
@dbus_interface_annotations(interface_name)
1208
return { "org.freedesktop.DBus.Deprecated":
1210
# Find an unused name
1211
for aname in (iname.format(i)
1212
for i in itertools.count()):
1213
if aname not in attr:
1217
# Replace the class with a new subclass of it with
1218
# methods, signals, etc. as created above.
1219
cls = type(b"{0}Alternate".format(cls.__name__),
1225
@alternate_dbus_interfaces({"se.recompile.Mandos":
1226
"se.bsnet.fukt.Mandos"})
1227
694
class ClientDBus(Client, DBusObjectWithProperties):
1228
695
"""A Client class using D-Bus
1231
698
dbus_object_path: dbus.ObjectPath
1232
699
bus: dbus.SystemBus()
1235
runtime_expansions = (Client.runtime_expansions
1236
+ ("dbus_object_path",))
1238
701
# dbus.service.Object doesn't use super(), so we can't either.
1240
703
def __init__(self, bus = None, *args, **kwargs):
704
self._approvals_pending = 0
1242
706
Client.__init__(self, *args, **kwargs)
1243
707
# Only now, when this client is initialized, can it show up on
1245
client_object_name = unicode(self.name).translate(
1246
{ord("."): ord("_"),
1247
ord("-"): ord("_")})
1248
709
self.dbus_object_path = (dbus.ObjectPath
1249
("/clients/" + client_object_name))
711
+ self.name.replace(u".", u"_")))
1250
712
DBusObjectWithProperties.__init__(self, self.bus,
1251
713
self.dbus_object_path)
1253
def notifychangeproperty(transform_func,
1254
dbus_name, type_func=lambda x: x,
1256
""" Modify a variable so that it's a property which announces
1257
its changes to DBus.
1259
transform_fun: Function that takes a value and a variant_level
1260
and transforms it to a D-Bus type.
1261
dbus_name: D-Bus name of the variable
1262
type_func: Function that transform the value before sending it
1263
to the D-Bus. Default: no transform
1264
variant_level: D-Bus variant level. Default: 1
1266
attrname = "_{0}".format(dbus_name)
1267
def setter(self, value):
1268
if hasattr(self, "dbus_object_path"):
1269
if (not hasattr(self, attrname) or
1270
type_func(getattr(self, attrname, None))
1271
!= type_func(value)):
1272
dbus_value = transform_func(type_func(value),
1275
self.PropertyChanged(dbus.String(dbus_name),
1277
setattr(self, attrname, value)
1279
return property(lambda self: getattr(self, attrname), setter)
1281
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1282
approvals_pending = notifychangeproperty(dbus.Boolean,
1285
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1286
last_enabled = notifychangeproperty(datetime_to_dbus,
1288
checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1289
type_func = lambda checker:
1290
checker is not None)
1291
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1293
last_checker_status = notifychangeproperty(dbus.Int16,
1294
"LastCheckerStatus")
1295
last_approval_request = notifychangeproperty(
1296
datetime_to_dbus, "LastApprovalRequest")
1297
approved_by_default = notifychangeproperty(dbus.Boolean,
1298
"ApprovedByDefault")
1299
approval_delay = notifychangeproperty(dbus.UInt64,
1302
timedelta_to_milliseconds)
1303
approval_duration = notifychangeproperty(
1304
dbus.UInt64, "ApprovalDuration",
1305
type_func = timedelta_to_milliseconds)
1306
host = notifychangeproperty(dbus.String, "Host")
1307
timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1309
timedelta_to_milliseconds)
1310
extended_timeout = notifychangeproperty(
1311
dbus.UInt64, "ExtendedTimeout",
1312
type_func = timedelta_to_milliseconds)
1313
interval = notifychangeproperty(dbus.UInt64,
1316
timedelta_to_milliseconds)
1317
checker_command = notifychangeproperty(dbus.String, "Checker")
1319
del notifychangeproperty
715
def _get_approvals_pending(self):
716
return self._approvals_pending
717
def _set_approvals_pending(self, value):
718
old_value = self._approvals_pending
719
self._approvals_pending = value
721
if (hasattr(self, "dbus_object_path")
722
and bval is not bool(old_value)):
723
dbus_bool = dbus.Boolean(bval, variant_level=1)
724
self.PropertyChanged(dbus.String(u"approved_pending"),
727
approvals_pending = property(_get_approvals_pending,
728
_set_approvals_pending)
729
del _get_approvals_pending, _set_approvals_pending
732
def _datetime_to_dbus(dt, variant_level=0):
733
"""Convert a UTC datetime.datetime() to a D-Bus type."""
734
return dbus.String(dt.isoformat(),
735
variant_level=variant_level)
738
oldstate = getattr(self, u"enabled", False)
739
r = Client.enable(self)
740
if oldstate != self.enabled:
742
self.PropertyChanged(dbus.String(u"enabled"),
743
dbus.Boolean(True, variant_level=1))
744
self.PropertyChanged(
745
dbus.String(u"last_enabled"),
746
self._datetime_to_dbus(self.last_enabled,
750
def disable(self, quiet = False):
751
oldstate = getattr(self, u"enabled", False)
752
r = Client.disable(self, quiet=quiet)
753
if not quiet and oldstate != self.enabled:
755
self.PropertyChanged(dbus.String(u"enabled"),
756
dbus.Boolean(False, variant_level=1))
1321
759
def __del__(self, *args, **kwargs):
1323
761
self.remove_from_connection()
1324
762
except LookupError:
1326
if hasattr(DBusObjectWithProperties, "__del__"):
764
if hasattr(DBusObjectWithProperties, u"__del__"):
1327
765
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1328
766
Client.__del__(self, *args, **kwargs)
1462
# ApprovalPending - property
1463
@dbus_service_property(_interface, signature="b", access="read")
1464
def ApprovalPending_dbus_property(self):
917
# approved_pending - property
918
@dbus_service_property(_interface, signature=u"b", access=u"read")
919
def approved_pending_dbus_property(self):
1465
920
return dbus.Boolean(bool(self.approvals_pending))
1467
# ApprovedByDefault - property
1468
@dbus_service_property(_interface, signature="b",
1470
def ApprovedByDefault_dbus_property(self, value=None):
1471
if value is None: # get
1472
return dbus.Boolean(self.approved_by_default)
1473
self.approved_by_default = bool(value)
1475
# ApprovalDelay - property
1476
@dbus_service_property(_interface, signature="t",
1478
def ApprovalDelay_dbus_property(self, value=None):
1479
if value is None: # get
1480
return dbus.UInt64(self.approval_delay_milliseconds())
1481
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1483
# ApprovalDuration - property
1484
@dbus_service_property(_interface, signature="t",
1486
def ApprovalDuration_dbus_property(self, value=None):
1487
if value is None: # get
1488
return dbus.UInt64(timedelta_to_milliseconds(
1489
self.approval_duration))
1490
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1493
@dbus_service_property(_interface, signature="s", access="read")
1494
def Name_dbus_property(self):
922
# approved_by_default - property
923
@dbus_service_property(_interface, signature=u"b",
925
def approved_by_default_dbus_property(self):
926
return dbus.Boolean(self.approved_by_default)
928
# approved_delay - property
929
@dbus_service_property(_interface, signature=u"t",
931
def approved_delay_dbus_property(self):
932
return dbus.UInt64(self.approved_delay_milliseconds())
934
# approved_duration - property
935
@dbus_service_property(_interface, signature=u"t",
937
def approved_duration_dbus_property(self):
938
return dbus.UInt64(self._timedelta_to_milliseconds(
939
self.approved_duration))
942
@dbus_service_property(_interface, signature=u"s", access=u"read")
943
def name_dbus_property(self):
1495
944
return dbus.String(self.name)
1497
# Fingerprint - property
1498
@dbus_service_property(_interface, signature="s", access="read")
1499
def Fingerprint_dbus_property(self):
946
# fingerprint - property
947
@dbus_service_property(_interface, signature=u"s", access=u"read")
948
def fingerprint_dbus_property(self):
1500
949
return dbus.String(self.fingerprint)
1503
@dbus_service_property(_interface, signature="s",
1505
def Host_dbus_property(self, value=None):
952
@dbus_service_property(_interface, signature=u"s",
954
def host_dbus_property(self, value=None):
1506
955
if value is None: # get
1507
956
return dbus.String(self.host)
1508
self.host = unicode(value)
1510
# Created - property
1511
@dbus_service_property(_interface, signature="s", access="read")
1512
def Created_dbus_property(self):
1513
return datetime_to_dbus(self.created)
1515
# LastEnabled - property
1516
@dbus_service_property(_interface, signature="s", access="read")
1517
def LastEnabled_dbus_property(self):
1518
return datetime_to_dbus(self.last_enabled)
1520
# Enabled - property
1521
@dbus_service_property(_interface, signature="b",
1523
def Enabled_dbus_property(self, value=None):
959
self.PropertyChanged(dbus.String(u"host"),
960
dbus.String(value, variant_level=1))
963
@dbus_service_property(_interface, signature=u"s", access=u"read")
964
def created_dbus_property(self):
965
return dbus.String(self._datetime_to_dbus(self.created))
967
# last_enabled - property
968
@dbus_service_property(_interface, signature=u"s", access=u"read")
969
def last_enabled_dbus_property(self):
970
if self.last_enabled is None:
971
return dbus.String(u"")
972
return dbus.String(self._datetime_to_dbus(self.last_enabled))
975
@dbus_service_property(_interface, signature=u"b",
977
def enabled_dbus_property(self, value=None):
1524
978
if value is None: # get
1525
979
return dbus.Boolean(self.enabled)
1531
# LastCheckedOK - property
1532
@dbus_service_property(_interface, signature="s",
1534
def LastCheckedOK_dbus_property(self, value=None):
985
# last_checked_ok - property
986
@dbus_service_property(_interface, signature=u"s",
988
def last_checked_ok_dbus_property(self, value=None):
1535
989
if value is not None:
1536
990
self.checked_ok()
1538
return datetime_to_dbus(self.last_checked_ok)
1540
# LastCheckerStatus - property
1541
@dbus_service_property(_interface, signature="n",
1543
def LastCheckerStatus_dbus_property(self):
1544
return dbus.Int16(self.last_checker_status)
1546
# Expires - property
1547
@dbus_service_property(_interface, signature="s", access="read")
1548
def Expires_dbus_property(self):
1549
return datetime_to_dbus(self.expires)
1551
# LastApprovalRequest - property
1552
@dbus_service_property(_interface, signature="s", access="read")
1553
def LastApprovalRequest_dbus_property(self):
1554
return datetime_to_dbus(self.last_approval_request)
1556
# Timeout - property
1557
@dbus_service_property(_interface, signature="t",
1559
def Timeout_dbus_property(self, value=None):
992
if self.last_checked_ok is None:
993
return dbus.String(u"")
994
return dbus.String(self._datetime_to_dbus(self
998
@dbus_service_property(_interface, signature=u"t",
1000
def timeout_dbus_property(self, value=None):
1560
1001
if value is None: # get
1561
1002
return dbus.UInt64(self.timeout_milliseconds())
1562
old_timeout = self.timeout
1563
1003
self.timeout = datetime.timedelta(0, 0, 0, value)
1564
# Reschedule disabling
1566
now = datetime.datetime.utcnow()
1567
self.expires += self.timeout - old_timeout
1568
if self.expires <= now:
1569
# The timeout has passed
1572
if (getattr(self, "disable_initiator_tag", None)
1575
gobject.source_remove(self.disable_initiator_tag)
1576
self.disable_initiator_tag = (
1577
gobject.timeout_add(
1578
timedelta_to_milliseconds(self.expires - now),
1581
# ExtendedTimeout - property
1582
@dbus_service_property(_interface, signature="t",
1584
def ExtendedTimeout_dbus_property(self, value=None):
1585
if value is None: # get
1586
return dbus.UInt64(self.extended_timeout_milliseconds())
1587
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1589
# Interval - property
1590
@dbus_service_property(_interface, signature="t",
1592
def Interval_dbus_property(self, value=None):
1005
self.PropertyChanged(dbus.String(u"timeout"),
1006
dbus.UInt64(value, variant_level=1))
1007
if getattr(self, u"disable_initiator_tag", None) is None:
1009
# Reschedule timeout
1010
gobject.source_remove(self.disable_initiator_tag)
1011
self.disable_initiator_tag = None
1012
time_to_die = (self.
1013
_timedelta_to_milliseconds((self
1018
if time_to_die <= 0:
1019
# The timeout has passed
1022
self.disable_initiator_tag = (gobject.timeout_add
1023
(time_to_die, self.disable))
1025
# interval - property
1026
@dbus_service_property(_interface, signature=u"t",
1027
access=u"readwrite")
1028
def interval_dbus_property(self, value=None):
1593
1029
if value is None: # get
1594
1030
return dbus.UInt64(self.interval_milliseconds())
1595
1031
self.interval = datetime.timedelta(0, 0, 0, value)
1596
if getattr(self, "checker_initiator_tag", None) is None:
1033
self.PropertyChanged(dbus.String(u"interval"),
1034
dbus.UInt64(value, variant_level=1))
1035
if getattr(self, u"checker_initiator_tag", None) is None:
1599
# Reschedule checker run
1600
gobject.source_remove(self.checker_initiator_tag)
1601
self.checker_initiator_tag = (gobject.timeout_add
1602
(value, self.start_checker))
1603
self.start_checker() # Start one now, too
1605
# Checker - property
1606
@dbus_service_property(_interface, signature="s",
1608
def Checker_dbus_property(self, value=None):
1037
# Reschedule checker run
1038
gobject.source_remove(self.checker_initiator_tag)
1039
self.checker_initiator_tag = (gobject.timeout_add
1040
(value, self.start_checker))
1041
self.start_checker() # Start one now, too
1043
# checker - property
1044
@dbus_service_property(_interface, signature=u"s",
1045
access=u"readwrite")
1046
def checker_dbus_property(self, value=None):
1609
1047
if value is None: # get
1610
1048
return dbus.String(self.checker_command)
1611
self.checker_command = unicode(value)
1049
self.checker_command = value
1051
self.PropertyChanged(dbus.String(u"checker"),
1052
dbus.String(self.checker_command,
1613
# CheckerRunning - property
1614
@dbus_service_property(_interface, signature="b",
1616
def CheckerRunning_dbus_property(self, value=None):
1055
# checker_running - property
1056
@dbus_service_property(_interface, signature=u"b",
1057
access=u"readwrite")
1058
def checker_running_dbus_property(self, value=None):
1617
1059
if value is None: # get
1618
1060
return dbus.Boolean(self.checker is not None)
1670
1112
def handle(self):
1671
1113
with contextlib.closing(self.server.child_pipe) as child_pipe:
1672
logger.info("TCP connection from: %s",
1114
logger.info(u"TCP connection from: %s",
1673
1115
unicode(self.client_address))
1674
logger.debug("Pipe FD: %d",
1116
logger.debug(u"Pipe FD: %d",
1675
1117
self.server.child_pipe.fileno())
1677
1119
session = (gnutls.connection
1678
1120
.ClientSession(self.request,
1679
1121
gnutls.connection
1680
1122
.X509Credentials()))
1682
1124
# Note: gnutls.connection.X509Credentials is really a
1683
1125
# generic GnuTLS certificate credentials object so long as
1684
1126
# no X.509 keys are added to it. Therefore, we can use it
1685
1127
# here despite using OpenPGP certificates.
1687
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1688
# "+AES-256-CBC", "+SHA1",
1689
# "+COMP-NULL", "+CTYPE-OPENPGP",
1129
#priority = u':'.join((u"NONE", u"+VERS-TLS1.1",
1130
# u"+AES-256-CBC", u"+SHA1",
1131
# u"+COMP-NULL", u"+CTYPE-OPENPGP",
1691
1133
# Use a fallback default, since this MUST be set.
1692
1134
priority = self.server.gnutls_priority
1693
1135
if priority is None:
1136
priority = u"NORMAL"
1695
1137
(gnutls.library.functions
1696
1138
.gnutls_priority_set_direct(session._c_object,
1697
1139
priority, None))
1699
1141
# Start communication using the Mandos protocol
1700
1142
# Get protocol number
1701
1143
line = self.request.makefile().readline()
1702
logger.debug("Protocol version: %r", line)
1144
logger.debug(u"Protocol version: %r", line)
1704
1146
if int(line.strip().split()[0]) > 1:
1705
1147
raise RuntimeError
1706
except (ValueError, IndexError, RuntimeError) as error:
1707
logger.error("Unknown protocol version: %s", error)
1148
except (ValueError, IndexError, RuntimeError), error:
1149
logger.error(u"Unknown protocol version: %s", error)
1710
1152
# Start GnuTLS connection
1712
1154
session.handshake()
1713
except gnutls.errors.GNUTLSError as error:
1714
logger.warning("Handshake failed: %s", error)
1155
except gnutls.errors.GNUTLSError, error:
1156
logger.warning(u"Handshake failed: %s", error)
1715
1157
# Do not run session.bye() here: the session is not
1716
1158
# established. Just abandon the request.
1718
logger.debug("Handshake succeeded")
1160
logger.debug(u"Handshake succeeded")
1720
1162
approval_required = False
1723
1165
fpr = self.fingerprint(self.peer_certificate
1726
gnutls.errors.GNUTLSError) as error:
1727
logger.warning("Bad certificate: %s", error)
1167
except (TypeError, gnutls.errors.GNUTLSError), error:
1168
logger.warning(u"Bad certificate: %s", error)
1729
logger.debug("Fingerprint: %s", fpr)
1170
logger.debug(u"Fingerprint: %s", fpr)
1732
1173
client = ProxyClient(child_pipe, fpr,
1733
1174
self.client_address)
1734
1175
except KeyError:
1737
if client.approval_delay:
1738
delay = client.approval_delay
1178
if client.approved_delay:
1179
delay = client.approved_delay
1739
1180
client.approvals_pending += 1
1740
1181
approval_required = True
1743
1184
if not client.enabled:
1744
logger.info("Client %s is disabled",
1185
logger.warning(u"Client %s is disabled",
1746
1187
if self.server.use_dbus:
1747
1188
# Emit D-Bus signal
1748
client.Rejected("Disabled")
1189
client.Rejected("Disabled")
1751
if client.approved or not client.approval_delay:
1192
if client._approved or not client.approved_delay:
1752
1193
#We are approved or approval is disabled
1754
elif client.approved is None:
1755
logger.info("Client %s needs approval",
1195
elif client._approved is None:
1196
logger.info(u"Client %s need approval",
1757
1198
if self.server.use_dbus:
1758
1199
# Emit D-Bus signal
1759
1200
client.NeedApproval(
1760
client.approval_delay_milliseconds(),
1201
client.approved_delay_milliseconds(),
1761
1202
client.approved_by_default)
1763
logger.warning("Client %s was not approved",
1204
logger.warning(u"Client %s was not approved",
1765
1206
if self.server.use_dbus:
1766
1207
# Emit D-Bus signal
1767
client.Rejected("Denied")
1208
client.Rejected("Disapproved")
1770
1211
#wait until timeout or approved
1212
#x = float(client._timedelta_to_milliseconds(delay))
1771
1213
time = datetime.datetime.now()
1772
1214
client.changedstate.acquire()
1773
client.changedstate.wait(
1774
float(timedelta_to_milliseconds(delay)
1215
client.changedstate.wait(float(client._timedelta_to_milliseconds(delay) / 1000))
1776
1216
client.changedstate.release()
1777
1217
time2 = datetime.datetime.now()
1778
1218
if (time2 - time) >= delay:
1928
1362
use_ipv6: Boolean; to use IPv6 or not
1930
1364
def __init__(self, server_address, RequestHandlerClass,
1931
interface=None, use_ipv6=True, socketfd=None):
1932
"""If socketfd is set, use that file descriptor instead of
1933
creating a new one with socket.socket().
1365
interface=None, use_ipv6=True):
1935
1366
self.interface = interface
1937
1368
self.address_family = socket.AF_INET6
1938
if socketfd is not None:
1939
# Save the file descriptor
1940
self.socketfd = socketfd
1941
# Save the original socket.socket() function
1942
self.socket_socket = socket.socket
1943
# To implement --socket, we monkey patch socket.socket.
1945
# (When socketserver.TCPServer is a new-style class, we
1946
# could make self.socket into a property instead of monkey
1947
# patching socket.socket.)
1949
# Create a one-time-only replacement for socket.socket()
1950
@functools.wraps(socket.socket)
1951
def socket_wrapper(*args, **kwargs):
1952
# Restore original function so subsequent calls are
1954
socket.socket = self.socket_socket
1955
del self.socket_socket
1956
# This time only, return a new socket object from the
1957
# saved file descriptor.
1958
return socket.fromfd(self.socketfd, *args, **kwargs)
1959
# Replace socket.socket() function with wrapper
1960
socket.socket = socket_wrapper
1961
# The socketserver.TCPServer.__init__ will call
1962
# socket.socket(), which might be our replacement,
1963
# socket_wrapper(), if socketfd was set.
1964
1369
socketserver.TCPServer.__init__(self, server_address,
1965
1370
RequestHandlerClass)
1967
1371
def server_bind(self):
1968
1372
"""This overrides the normal server_bind() function
1969
1373
to bind to an interface if one was specified, and also NOT to
1970
1374
bind to an address or port if they were not specified."""
1971
1375
if self.interface is not None:
1972
1376
if SO_BINDTODEVICE is None:
1973
logger.error("SO_BINDTODEVICE does not exist;"
1974
" cannot bind to interface %s",
1377
logger.error(u"SO_BINDTODEVICE does not exist;"
1378
u" cannot bind to interface %s",
1975
1379
self.interface)
1978
1382
self.socket.setsockopt(socket.SOL_SOCKET,
1979
1383
SO_BINDTODEVICE,
1980
str(self.interface + '\0'))
1981
except socket.error as error:
1982
if error.errno == errno.EPERM:
1983
logger.error("No permission to bind to"
1984
" interface %s", self.interface)
1985
elif error.errno == errno.ENOPROTOOPT:
1986
logger.error("SO_BINDTODEVICE not available;"
1987
" cannot bind to interface %s",
1989
elif error.errno == errno.ENODEV:
1990
logger.error("Interface %s does not exist,"
1991
" cannot bind", self.interface)
1386
except socket.error, error:
1387
if error[0] == errno.EPERM:
1388
logger.error(u"No permission to"
1389
u" bind to interface %s",
1391
elif error[0] == errno.ENOPROTOOPT:
1392
logger.error(u"SO_BINDTODEVICE not available;"
1393
u" cannot bind to interface %s",
1994
1397
# Only bind(2) the socket if we really need to.
1995
1398
if self.server_address[0] or self.server_address[1]:
1996
1399
if not self.server_address[0]:
1997
1400
if self.address_family == socket.AF_INET6:
1998
any_address = "::" # in6addr_any
1401
any_address = u"::" # in6addr_any
2000
any_address = "0.0.0.0" # INADDR_ANY
1403
any_address = socket.INADDR_ANY
2001
1404
self.server_address = (any_address,
2002
1405
self.server_address[1])
2003
1406
elif not self.server_address[1]:
2025
1428
def __init__(self, server_address, RequestHandlerClass,
2026
1429
interface=None, use_ipv6=True, clients=None,
2027
gnutls_priority=None, use_dbus=True, socketfd=None):
1430
gnutls_priority=None, use_dbus=True):
2028
1431
self.enabled = False
2029
1432
self.clients = clients
2030
1433
if self.clients is None:
1434
self.clients = set()
2032
1435
self.use_dbus = use_dbus
2033
1436
self.gnutls_priority = gnutls_priority
2034
1437
IPv6_TCPServer.__init__(self, server_address,
2035
1438
RequestHandlerClass,
2036
1439
interface = interface,
2037
use_ipv6 = use_ipv6,
2038
socketfd = socketfd)
1440
use_ipv6 = use_ipv6)
2039
1441
def server_activate(self):
2040
1442
if self.enabled:
2041
1443
return socketserver.TCPServer.server_activate(self)
2043
1444
def enable(self):
2044
1445
self.enabled = True
2046
def add_pipe(self, parent_pipe, proc):
1446
def add_pipe(self, parent_pipe):
2047
1447
# Call "handle_ipc" for both data and EOF events
2048
1448
gobject.io_add_watch(parent_pipe.fileno(),
2049
1449
gobject.IO_IN | gobject.IO_HUP,
2050
1450
functools.partial(self.handle_ipc,
1451
parent_pipe = parent_pipe))
2055
1453
def handle_ipc(self, source, condition, parent_pipe=None,
2056
proc = None, client_object=None):
2057
# error, or the other end of multiprocessing.Pipe has closed
2058
if condition & (gobject.IO_ERR | gobject.IO_HUP):
2059
# Wait for other process to exit
1454
client_object=None):
1456
gobject.IO_IN: u"IN", # There is data to read.
1457
gobject.IO_OUT: u"OUT", # Data can be written (without
1459
gobject.IO_PRI: u"PRI", # There is urgent data to read.
1460
gobject.IO_ERR: u"ERR", # Error condition.
1461
gobject.IO_HUP: u"HUP" # Hung up (the connection has been
1462
# broken, usually for pipes and
1465
conditions_string = ' | '.join(name
1467
condition_names.iteritems()
1468
if cond & condition)
1469
logger.debug(u"Handling IPC: FD = %d, condition = %s", source,
1472
# error or the other end of multiprocessing.Pipe has closed
1473
if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
2063
1476
# Read a request from the child
2064
1477
request = parent_pipe.recv()
1478
logger.debug(u"IPC request: %s", repr(request))
2065
1479
command = request[0]
2067
1481
if command == 'init':
2068
1482
fpr = request[1]
2069
1483
address = request[2]
2071
for c in self.clients.itervalues():
1485
for c in self.clients:
2072
1486
if c.fingerprint == fpr:
2076
logger.info("Client not found for fingerprint: %s, ad"
2077
"dress: %s", fpr, address)
1490
logger.warning(u"Client not found for fingerprint: %s, ad"
1491
u"dress: %s", fpr, address)
2078
1492
if self.use_dbus:
2079
1493
# Emit D-Bus signal
2080
mandos_dbus_service.ClientNotFound(fpr,
1494
mandos_dbus_service.ClientNotFound(fpr, address)
2082
1495
parent_pipe.send(False)
2085
1498
gobject.io_add_watch(parent_pipe.fileno(),
2086
1499
gobject.IO_IN | gobject.IO_HUP,
2087
1500
functools.partial(self.handle_ipc,
1501
parent_pipe = parent_pipe,
1502
client_object = client))
2093
1503
parent_pipe.send(True)
2094
# remove the old hook in favor of the new above hook on
1504
# remove the old hook in favor of the new above hook on same fileno
2097
1506
if command == 'funcall':
2098
1507
funcname = request[1]
2099
1508
args = request[2]
2100
1509
kwargs = request[3]
2102
parent_pipe.send(('data', getattr(client_object,
1511
parent_pipe.send(('data', getattr(client_object, funcname)(*args, **kwargs)))
2106
1513
if command == 'getattr':
2107
1514
attrname = request[1]
2108
1515
if callable(client_object.__getattribute__(attrname)):
2109
1516
parent_pipe.send(('function',))
2111
parent_pipe.send(('data', client_object
2112
.__getattribute__(attrname)))
1518
parent_pipe.send(('data', client_object.__getattribute__(attrname)))
2114
1520
if command == 'setattr':
2115
1521
attrname = request[1]
2116
1522
value = request[2]
2117
1523
setattr(client_object, attrname, value)
2122
def rfc3339_duration_to_delta(duration):
2123
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2125
>>> rfc3339_duration_to_delta("P7D")
2126
datetime.timedelta(7)
2127
>>> rfc3339_duration_to_delta("PT60S")
2128
datetime.timedelta(0, 60)
2129
>>> rfc3339_duration_to_delta("PT60M")
2130
datetime.timedelta(0, 3600)
2131
>>> rfc3339_duration_to_delta("PT24H")
2132
datetime.timedelta(1)
2133
>>> rfc3339_duration_to_delta("P1W")
2134
datetime.timedelta(7)
2135
>>> rfc3339_duration_to_delta("PT5M30S")
2136
datetime.timedelta(0, 330)
2137
>>> rfc3339_duration_to_delta("P1DT3M20S")
2138
datetime.timedelta(1, 200)
2141
# Parsing an RFC 3339 duration with regular expressions is not
2142
# possible - there would have to be multiple places for the same
2143
# values, like seconds. The current code, while more esoteric, is
2144
# cleaner without depending on a parsing library. If Python had a
2145
# built-in library for parsing we would use it, but we'd like to
2146
# avoid excessive use of external libraries.
2148
# New type for defining tokens, syntax, and semantics all-in-one
2149
Token = collections.namedtuple("Token",
2150
("regexp", # To match token; if
2151
# "value" is not None,
2152
# must have a "group"
2154
"value", # datetime.timedelta or
2156
"followers")) # Tokens valid after
2158
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2159
# the "duration" ABNF definition in RFC 3339, Appendix A.
2160
token_end = Token(re.compile(r"$"), None, frozenset())
2161
token_second = Token(re.compile(r"(\d+)S"),
2162
datetime.timedelta(seconds=1),
2163
frozenset((token_end,)))
2164
token_minute = Token(re.compile(r"(\d+)M"),
2165
datetime.timedelta(minutes=1),
2166
frozenset((token_second, token_end)))
2167
token_hour = Token(re.compile(r"(\d+)H"),
2168
datetime.timedelta(hours=1),
2169
frozenset((token_minute, token_end)))
2170
token_time = Token(re.compile(r"T"),
2172
frozenset((token_hour, token_minute,
2174
token_day = Token(re.compile(r"(\d+)D"),
2175
datetime.timedelta(days=1),
2176
frozenset((token_time, token_end)))
2177
token_month = Token(re.compile(r"(\d+)M"),
2178
datetime.timedelta(weeks=4),
2179
frozenset((token_day, token_end)))
2180
token_year = Token(re.compile(r"(\d+)Y"),
2181
datetime.timedelta(weeks=52),
2182
frozenset((token_month, token_end)))
2183
token_week = Token(re.compile(r"(\d+)W"),
2184
datetime.timedelta(weeks=1),
2185
frozenset((token_end,)))
2186
token_duration = Token(re.compile(r"P"), None,
2187
frozenset((token_year, token_month,
2188
token_day, token_time,
2190
# Define starting values
2191
value = datetime.timedelta() # Value so far
2193
followers = frozenset(token_duration,) # Following valid tokens
2194
s = duration # String left to parse
2195
# Loop until end token is found
2196
while found_token is not token_end:
2197
# Search for any currently valid tokens
2198
for token in followers:
2199
match = token.regexp.match(s)
2200
if match is not None:
2202
if token.value is not None:
2203
# Value found, parse digits
2204
factor = int(match.group(1), 10)
2205
# Add to value so far
2206
value += factor * token.value
2207
# Strip token from string
2208
s = token.regexp.sub("", s, 1)
2211
# Set valid next tokens
2212
followers = found_token.followers
2215
# No currently valid tokens were found
2216
raise ValueError("Invalid RFC 3339 duration")
2221
1528
def string_to_delta(interval):
2222
1529
"""Parse a string and return a datetime.timedelta
2224
>>> string_to_delta('7d')
1531
>>> string_to_delta(u'7d')
2225
1532
datetime.timedelta(7)
2226
>>> string_to_delta('60s')
1533
>>> string_to_delta(u'60s')
2227
1534
datetime.timedelta(0, 60)
2228
>>> string_to_delta('60m')
1535
>>> string_to_delta(u'60m')
2229
1536
datetime.timedelta(0, 3600)
2230
>>> string_to_delta('24h')
1537
>>> string_to_delta(u'24h')
2231
1538
datetime.timedelta(1)
2232
>>> string_to_delta('1w')
1539
>>> string_to_delta(u'1w')
2233
1540
datetime.timedelta(7)
2234
>>> string_to_delta('5m 30s')
1541
>>> string_to_delta(u'5m 30s')
2235
1542
datetime.timedelta(0, 330)
2239
return rfc3339_duration_to_delta(interval)
2243
1544
timevalue = datetime.timedelta(0)
2244
1545
for s in interval.split():
2246
1547
suffix = unicode(s[-1])
2247
1548
value = int(s[:-1])
2249
1550
delta = datetime.timedelta(value)
1551
elif suffix == u"s":
2251
1552
delta = datetime.timedelta(0, value)
1553
elif suffix == u"m":
2253
1554
delta = datetime.timedelta(0, 0, 0, 0, value)
1555
elif suffix == u"h":
2255
1556
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
1557
elif suffix == u"w":
2257
1558
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2259
raise ValueError("Unknown suffix {0!r}"
2261
except (ValueError, IndexError) as e:
2262
raise ValueError(*(e.args))
1560
raise ValueError(u"Unknown suffix %r" % suffix)
1561
except (ValueError, IndexError), e:
1562
raise ValueError(e.message)
2263
1563
timevalue += delta
2264
1564
return timevalue
1567
def if_nametoindex(interface):
1568
"""Call the C function if_nametoindex(), or equivalent
1570
Note: This function cannot accept a unicode string."""
1571
global if_nametoindex
1573
if_nametoindex = (ctypes.cdll.LoadLibrary
1574
(ctypes.util.find_library(u"c"))
1576
except (OSError, AttributeError):
1577
logger.warning(u"Doing if_nametoindex the hard way")
1578
def if_nametoindex(interface):
1579
"Get an interface index the hard way, i.e. using fcntl()"
1580
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
1581
with contextlib.closing(socket.socket()) as s:
1582
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1583
struct.pack(str(u"16s16x"),
1585
interface_index = struct.unpack(str(u"I"),
1587
return interface_index
1588
return if_nametoindex(interface)
2267
1591
def daemon(nochdir = False, noclose = False):
2268
1592
"""See daemon(3). Standard BSD Unix function.
2294
1618
##################################################################
2295
1619
# Parsing of options, both command line and config file
2297
parser = argparse.ArgumentParser()
2298
parser.add_argument("-v", "--version", action="version",
2299
version = "%(prog)s {0}".format(version),
2300
help="show version number and exit")
2301
parser.add_argument("-i", "--interface", metavar="IF",
2302
help="Bind to interface IF")
2303
parser.add_argument("-a", "--address",
2304
help="Address to listen for requests on")
2305
parser.add_argument("-p", "--port", type=int,
2306
help="Port number to receive requests on")
2307
parser.add_argument("--check", action="store_true",
2308
help="Run self-test")
2309
parser.add_argument("--debug", action="store_true",
2310
help="Debug mode; run in foreground and log"
2311
" to terminal", default=None)
2312
parser.add_argument("--debuglevel", metavar="LEVEL",
2313
help="Debug level for stdout output")
2314
parser.add_argument("--priority", help="GnuTLS"
2315
" priority string (see GnuTLS documentation)")
2316
parser.add_argument("--servicename",
2317
metavar="NAME", help="Zeroconf service name")
2318
parser.add_argument("--configdir",
2319
default="/etc/mandos", metavar="DIR",
2320
help="Directory to search for configuration"
2322
parser.add_argument("--no-dbus", action="store_false",
2323
dest="use_dbus", help="Do not provide D-Bus"
2324
" system bus interface", default=None)
2325
parser.add_argument("--no-ipv6", action="store_false",
2326
dest="use_ipv6", help="Do not use IPv6",
2328
parser.add_argument("--no-restore", action="store_false",
2329
dest="restore", help="Do not restore stored"
2330
" state", default=None)
2331
parser.add_argument("--socket", type=int,
2332
help="Specify a file descriptor to a network"
2333
" socket to use instead of creating one")
2334
parser.add_argument("--statedir", metavar="DIR",
2335
help="Directory to save/restore state in")
2336
parser.add_argument("--foreground", action="store_true",
2337
help="Run in foreground", default=None)
2339
options = parser.parse_args()
1621
parser = optparse.OptionParser(version = "%%prog %s" % version)
1622
parser.add_option("-i", u"--interface", type=u"string",
1623
metavar="IF", help=u"Bind to interface IF")
1624
parser.add_option("-a", u"--address", type=u"string",
1625
help=u"Address to listen for requests on")
1626
parser.add_option("-p", u"--port", type=u"int",
1627
help=u"Port number to receive requests on")
1628
parser.add_option("--check", action=u"store_true",
1629
help=u"Run self-test")
1630
parser.add_option("--debug", action=u"store_true",
1631
help=u"Debug mode; run in foreground and log to"
1633
parser.add_option("--debuglevel", type=u"string", metavar="Level",
1634
help=u"Debug level for stdout output")
1635
parser.add_option("--priority", type=u"string", help=u"GnuTLS"
1636
u" priority string (see GnuTLS documentation)")
1637
parser.add_option("--servicename", type=u"string",
1638
metavar=u"NAME", help=u"Zeroconf service name")
1639
parser.add_option("--configdir", type=u"string",
1640
default=u"/etc/mandos", metavar=u"DIR",
1641
help=u"Directory to search for configuration"
1643
parser.add_option("--no-dbus", action=u"store_false",
1644
dest=u"use_dbus", help=u"Do not provide D-Bus"
1645
u" system bus interface")
1646
parser.add_option("--no-ipv6", action=u"store_false",
1647
dest=u"use_ipv6", help=u"Do not use IPv6")
1648
options = parser.parse_args()[0]
2341
1650
if options.check:
2399
1694
for option in server_settings.keys():
2400
1695
if type(server_settings[option]) is str:
2401
1696
server_settings[option] = unicode(server_settings[option])
2402
# Force all boolean options to be boolean
2403
for option in ("debug", "use_dbus", "use_ipv6", "restore",
2405
server_settings[option] = bool(server_settings[option])
2406
# Debug implies foreground
2407
if server_settings["debug"]:
2408
server_settings["foreground"] = True
2409
1697
# Now we have our good server settings in "server_settings"
2411
1699
##################################################################
2413
1701
# For convenience
2414
debug = server_settings["debug"]
2415
debuglevel = server_settings["debuglevel"]
2416
use_dbus = server_settings["use_dbus"]
2417
use_ipv6 = server_settings["use_ipv6"]
2418
stored_state_path = os.path.join(server_settings["statedir"],
2420
foreground = server_settings["foreground"]
2423
initlogger(debug, logging.DEBUG)
2428
level = getattr(logging, debuglevel.upper())
2429
initlogger(debug, level)
2431
if server_settings["servicename"] != "Mandos":
1702
debug = server_settings[u"debug"]
1703
debuglevel = server_settings[u"debuglevel"]
1704
use_dbus = server_settings[u"use_dbus"]
1705
use_ipv6 = server_settings[u"use_ipv6"]
1707
if server_settings[u"servicename"] != u"Mandos":
2432
1708
syslogger.setFormatter(logging.Formatter
2433
('Mandos ({0}) [%(process)d]:'
2434
' %(levelname)s: %(message)s'
2435
.format(server_settings
1709
(u'Mandos (%s) [%%(process)d]:'
1710
u' %%(levelname)s: %%(message)s'
1711
% server_settings[u"servicename"]))
2438
1713
# Parse config file with clients
2439
client_config = configparser.SafeConfigParser(Client
2441
client_config.read(os.path.join(server_settings["configdir"],
1714
client_defaults = { u"timeout": u"1h",
1716
u"checker": u"fping -q -- %%(host)s",
1718
u"approved_delay": u"0s",
1719
u"approved_duration": u"1s",
1721
client_config = configparser.SafeConfigParser(client_defaults)
1722
client_config.read(os.path.join(server_settings[u"configdir"],
2444
1725
global mandos_dbus_service
2445
1726
mandos_dbus_service = None
2447
tcp_server = MandosServer((server_settings["address"],
2448
server_settings["port"]),
1728
tcp_server = MandosServer((server_settings[u"address"],
1729
server_settings[u"port"]),
2450
interface=(server_settings["interface"]
1731
interface=server_settings[u"interface"],
2452
1732
use_ipv6=use_ipv6,
2453
1733
gnutls_priority=
2454
server_settings["priority"],
2456
socketfd=(server_settings["socket"]
2459
pidfilename = "/run/mandos.pid"
2462
pidfile = open(pidfilename, "w")
2463
except IOError as e:
2464
logger.error("Could not open file %r", pidfilename,
1734
server_settings[u"priority"],
1736
pidfilename = u"/var/run/mandos.pid"
1738
pidfile = open(pidfilename, u"w")
1740
logger.error(u"Could not open file %r", pidfilename)
2467
for name in ("_mandos", "mandos", "nobody"):
1743
uid = pwd.getpwnam(u"_mandos").pw_uid
1744
gid = pwd.getpwnam(u"_mandos").pw_gid
2469
uid = pwd.getpwnam(name).pw_uid
2470
gid = pwd.getpwnam(name).pw_gid
1747
uid = pwd.getpwnam(u"mandos").pw_uid
1748
gid = pwd.getpwnam(u"mandos").pw_gid
2472
1749
except KeyError:
1751
uid = pwd.getpwnam(u"nobody").pw_uid
1752
gid = pwd.getpwnam(u"nobody").pw_gid
2480
except OSError as error:
2481
if error.errno != errno.EPERM:
1759
except OSError, error:
1760
if error[0] != errno.EPERM:
1763
# Enable all possible GnuTLS debugging
1766
if not debug and not debuglevel:
1767
syslogger.setLevel(logging.WARNING)
1768
console.setLevel(logging.WARNING)
1770
level = getattr(logging, debuglevel.upper())
1771
syslogger.setLevel(level)
1772
console.setLevel(level)
2485
# Enable all possible GnuTLS debugging
2487
1775
# "Use a log level over 10 to enable all debugging options."
2488
1776
# - GnuTLS manual
2489
1777
gnutls.library.functions.gnutls_global_set_log_level(11)
2491
1779
@gnutls.library.types.gnutls_log_func
2492
1780
def debug_gnutls(level, string):
2493
logger.debug("GnuTLS: %s", string[:-1])
1781
logger.debug(u"GnuTLS: %s", string[:-1])
2495
1783
(gnutls.library.functions
2496
1784
.gnutls_global_set_log_function(debug_gnutls))
2498
1786
# Redirect stdin so all checkers get /dev/null
2499
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1787
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2500
1788
os.dup2(null, sys.stdin.fileno())
2504
# Need to fork before connecting to D-Bus
2506
# Close all input and output, do double fork, etc.
2509
# multiprocessing will use threads, so before we use gobject we
2510
# need to inform gobject that threads will be used.
2511
gobject.threads_init()
1792
# No console logging
1793
logger.removeHandler(console)
2513
1796
global main_loop
2514
1797
# From the Avahi example code
2515
DBusGMainLoop(set_as_default=True)
1798
DBusGMainLoop(set_as_default=True )
2516
1799
main_loop = gobject.MainLoop()
2517
1800
bus = dbus.SystemBus()
2518
1801
# End of Avahi example code
2521
bus_name = dbus.service.BusName("se.recompile.Mandos",
1804
bus_name = dbus.service.BusName(u"se.bsnet.fukt.Mandos",
2522
1805
bus, do_not_queue=True)
2523
old_bus_name = (dbus.service.BusName
2524
("se.bsnet.fukt.Mandos", bus,
2526
except dbus.exceptions.NameExistsException as e:
2527
logger.error("Disabling D-Bus:", exc_info=e)
1806
except dbus.exceptions.NameExistsException, e:
1807
logger.error(unicode(e) + u", disabling D-Bus")
2528
1808
use_dbus = False
2529
server_settings["use_dbus"] = False
1809
server_settings[u"use_dbus"] = False
2530
1810
tcp_server.use_dbus = False
2531
1811
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2532
service = AvahiServiceToSyslog(name =
2533
server_settings["servicename"],
2534
servicetype = "_mandos._tcp",
2535
protocol = protocol, bus = bus)
1812
service = AvahiService(name = server_settings[u"servicename"],
1813
servicetype = u"_mandos._tcp",
1814
protocol = protocol, bus = bus)
2536
1815
if server_settings["interface"]:
2537
1816
service.interface = (if_nametoindex
2538
(str(server_settings["interface"])))
1817
(str(server_settings[u"interface"])))
1820
# Close all input and output, do double fork, etc.
2540
1823
global multiprocessing_manager
2541
1824
multiprocessing_manager = multiprocessing.Manager()
2543
1826
client_class = Client
2545
1828
client_class = functools.partial(ClientDBus, bus = bus)
2547
client_settings = Client.config_parser(client_config)
2548
old_client_settings = {}
2551
# This is used to redirect stdout and stderr for checker processes
2553
wnull = open(os.devnull, "w") # A writable /dev/null
2554
# Only used if server is running in foreground but not in debug
2556
if debug or not foreground:
2559
# Get client data and settings from last running state.
2560
if server_settings["restore"]:
2562
with open(stored_state_path, "rb") as stored_state:
2563
clients_data, old_client_settings = (pickle.load
2565
os.remove(stored_state_path)
2566
except IOError as e:
2567
if e.errno == errno.ENOENT:
2568
logger.warning("Could not load persistent state: {0}"
2569
.format(os.strerror(e.errno)))
2571
logger.critical("Could not load persistent state:",
2574
except EOFError as e:
2575
logger.warning("Could not load persistent state: "
2576
"EOFError:", exc_info=e)
2578
with PGPEngine() as pgp:
2579
for client_name, client in clients_data.iteritems():
2580
# Skip removed clients
2581
if client_name not in client_settings:
2584
# Decide which value to use after restoring saved state.
2585
# We have three different values: Old config file,
2586
# new config file, and saved state.
2587
# New config value takes precedence if it differs from old
2588
# config value, otherwise use saved state.
2589
for name, value in client_settings[client_name].items():
2591
# For each value in new config, check if it
2592
# differs from the old config value (Except for
2593
# the "secret" attribute)
2594
if (name != "secret" and
2595
value != old_client_settings[client_name]
2597
client[name] = value
2601
# Clients who has passed its expire date can still be
2602
# enabled if its last checker was successful. Clients
2603
# whose checker succeeded before we stored its state is
2604
# assumed to have successfully run all checkers during
2606
if client["enabled"]:
2607
if datetime.datetime.utcnow() >= client["expires"]:
2608
if not client["last_checked_ok"]:
2610
"disabling client {0} - Client never "
2611
"performed a successful checker"
2612
.format(client_name))
2613
client["enabled"] = False
2614
elif client["last_checker_status"] != 0:
2616
"disabling client {0} - Client "
2617
"last checker failed with error code {1}"
2618
.format(client_name,
2619
client["last_checker_status"]))
2620
client["enabled"] = False
2622
client["expires"] = (datetime.datetime
2624
+ client["timeout"])
2625
logger.debug("Last checker succeeded,"
2626
" keeping {0} enabled"
2627
.format(client_name))
1829
def client_config_items(config, section):
1830
special_settings = {
1831
"approved_by_default":
1832
lambda: config.getboolean(section,
1833
"approved_by_default"),
1835
for name, value in config.items(section):
2629
client["secret"] = (
2630
pgp.decrypt(client["encrypted_secret"],
2631
client_settings[client_name]
2634
# If decryption fails, we use secret from new settings
2635
logger.debug("Failed to decrypt {0} old secret"
2636
.format(client_name))
2637
client["secret"] = (
2638
client_settings[client_name]["secret"])
2640
# Add/remove clients based on new changes made to config
2641
for client_name in (set(old_client_settings)
2642
- set(client_settings)):
2643
del clients_data[client_name]
2644
for client_name in (set(client_settings)
2645
- set(old_client_settings)):
2646
clients_data[client_name] = client_settings[client_name]
2648
# Create all client objects
2649
for client_name, client in clients_data.iteritems():
2650
tcp_server.clients[client_name] = client_class(
2651
name = client_name, settings = client,
2652
server_settings = server_settings)
1837
yield (name, special_settings[name]())
1841
tcp_server.clients.update(set(
1842
client_class(name = section,
1843
config= dict(client_config_items(
1844
client_config, section)))
1845
for section in client_config.sections()))
2654
1846
if not tcp_server.clients:
2655
logger.warning("No clients defined")
2658
if pidfile is not None:
2662
pidfile.write(str(pid) + "\n".encode("utf-8"))
2664
logger.error("Could not write to file %r with PID %d",
1847
logger.warning(u"No clients defined")
1852
pidfile.write(str(pid) + "\n")
1855
logger.error(u"Could not write to file %r with PID %d",
1858
# "pidfile" was never created
1863
signal.signal(signal.SIGINT, signal.SIG_IGN)
2669
1864
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2670
1865
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2673
@alternate_dbus_interfaces({"se.recompile.Mandos":
2674
"se.bsnet.fukt.Mandos"})
2675
class MandosDBusService(DBusObjectWithProperties):
1868
class MandosDBusService(dbus.service.Object):
2676
1869
"""A D-Bus proxy object"""
2677
1870
def __init__(self):
2678
dbus.service.Object.__init__(self, bus, "/")
2679
_interface = "se.recompile.Mandos"
2681
@dbus_interface_annotations(_interface)
2683
return { "org.freedesktop.DBus.Property"
2684
".EmitsChangedSignal":
2687
@dbus.service.signal(_interface, signature="o")
1871
dbus.service.Object.__init__(self, bus, u"/")
1872
_interface = u"se.bsnet.fukt.Mandos"
1874
@dbus.service.signal(_interface, signature=u"o")
2688
1875
def ClientAdded(self, objpath):
2692
@dbus.service.signal(_interface, signature="ss")
1879
@dbus.service.signal(_interface, signature=u"ss")
2693
1880
def ClientNotFound(self, fingerprint, address):
2697
@dbus.service.signal(_interface, signature="os")
1884
@dbus.service.signal(_interface, signature=u"os")
2698
1885
def ClientRemoved(self, objpath, name):
2702
@dbus.service.method(_interface, out_signature="ao")
1889
@dbus.service.method(_interface, out_signature=u"ao")
2703
1890
def GetAllClients(self):
2705
1892
return dbus.Array(c.dbus_object_path
2707
tcp_server.clients.itervalues())
1893
for c in tcp_server.clients)
2709
1895
@dbus.service.method(_interface,
2710
out_signature="a{oa{sv}}")
1896
out_signature=u"a{oa{sv}}")
2711
1897
def GetAllClientsWithProperties(self):
2713
1899
return dbus.Dictionary(
2714
((c.dbus_object_path, c.GetAll(""))
2715
for c in tcp_server.clients.itervalues()),
1900
((c.dbus_object_path, c.GetAll(u""))
1901
for c in tcp_server.clients),
1902
signature=u"oa{sv}")
2718
@dbus.service.method(_interface, in_signature="o")
1904
@dbus.service.method(_interface, in_signature=u"o")
2719
1905
def RemoveClient(self, object_path):
2721
for c in tcp_server.clients.itervalues():
1907
for c in tcp_server.clients:
2722
1908
if c.dbus_object_path == object_path:
2723
del tcp_server.clients[c.name]
1909
tcp_server.clients.remove(c)
2724
1910
c.remove_from_connection()
2725
1911
# Don't signal anything except ClientRemoved
2726
1912
c.disable(quiet=True)