80
88
except ImportError:
81
89
SO_BINDTODEVICE = None
86
#logger = logging.getLogger(u'mandos')
87
logger = logging.Logger(u'mandos')
88
syslogger = (logging.handlers.SysLogHandler
89
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
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)
92
stored_state_file = "clients.pickle"
94
logger = logging.getLogger()
98
if_nametoindex = (ctypes.cdll.LoadLibrary
99
(ctypes.util.find_library("c"))
101
except (OSError, AttributeError):
102
def if_nametoindex(interface):
103
"Get an interface index the hard way, i.e. using fcntl()"
104
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
105
with contextlib.closing(socket.socket()) as s:
106
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
107
struct.pack(str("16s16x"),
109
interface_index = struct.unpack(str("I"),
111
return interface_index
114
def initlogger(debug, level=logging.WARNING):
115
"""init logger and add loglevel"""
117
syslogger = (logging.handlers.SysLogHandler
119
logging.handlers.SysLogHandler.LOG_DAEMON,
120
address = str("/dev/log")))
121
syslogger.setFormatter(logging.Formatter
122
('Mandos [%(process)d]: %(levelname)s:'
124
logger.addHandler(syslogger)
127
console = logging.StreamHandler()
128
console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
132
logger.addHandler(console)
133
logger.setLevel(level)
136
class PGPError(Exception):
137
"""Exception if encryption/decryption fails"""
141
class PGPEngine(object):
142
"""A simple class for OpenPGP symmetric encryption & decryption"""
144
self.tempdir = tempfile.mkdtemp(prefix="mandos-")
145
self.gnupgargs = ['--batch',
146
'--home', self.tempdir,
154
def __exit__(self, exc_type, exc_value, traceback):
162
if self.tempdir is not None:
163
# Delete contents of tempdir
164
for root, dirs, files in os.walk(self.tempdir,
166
for filename in files:
167
os.remove(os.path.join(root, filename))
169
os.rmdir(os.path.join(root, dirname))
171
os.rmdir(self.tempdir)
174
def password_encode(self, password):
175
# Passphrase can not be empty and can not contain newlines or
176
# NUL bytes. So we prefix it and hex encode it.
177
encoded = b"mandos" + binascii.hexlify(password)
178
if len(encoded) > 2048:
179
# GnuPG can't handle long passwords, so encode differently
180
encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
181
.replace(b"\n", b"\\n")
182
.replace(b"\0", b"\\x00"))
185
def encrypt(self, data, password):
186
passphrase = self.password_encode(password)
187
with tempfile.NamedTemporaryFile(dir=self.tempdir
189
passfile.write(passphrase)
191
proc = subprocess.Popen(['gpg', '--symmetric',
195
stdin = subprocess.PIPE,
196
stdout = subprocess.PIPE,
197
stderr = subprocess.PIPE)
198
ciphertext, err = proc.communicate(input = data)
199
if proc.returncode != 0:
203
def decrypt(self, data, password):
204
passphrase = self.password_encode(password)
205
with tempfile.NamedTemporaryFile(dir = self.tempdir
207
passfile.write(passphrase)
209
proc = subprocess.Popen(['gpg', '--decrypt',
213
stdin = subprocess.PIPE,
214
stdout = subprocess.PIPE,
215
stderr = subprocess.PIPE)
216
decrypted_plaintext, err = proc.communicate(input
218
if proc.returncode != 0:
220
return decrypted_plaintext
102
223
class AvahiError(Exception):
103
224
def __init__(self, value, *args, **kwargs):
192
324
dbus.UInt16(self.port),
193
325
avahi.string_array_to_txt_array(self.TXT))
194
326
self.group.Commit()
195
328
def entry_group_state_changed(self, state, error):
196
329
"""Derived from the Avahi example code"""
197
logger.debug(u"Avahi state change: %i", state)
330
logger.debug("Avahi entry group state change: %i", state)
199
332
if state == avahi.ENTRY_GROUP_ESTABLISHED:
200
logger.debug(u"Zeroconf service established.")
333
logger.debug("Zeroconf service established.")
201
334
elif state == avahi.ENTRY_GROUP_COLLISION:
202
logger.warning(u"Zeroconf service name collision.")
335
logger.info("Zeroconf service name collision.")
204
337
elif state == avahi.ENTRY_GROUP_FAILURE:
205
logger.critical(u"Avahi: Error in group state changed %s",
338
logger.critical("Avahi: Error in group state changed %s",
207
raise AvahiGroupError(u"State changed: %s"
340
raise AvahiGroupError("State changed: {0!s}"
209
343
def cleanup(self):
210
344
"""Derived from the Avahi example code"""
211
345
if self.group is not None:
348
except (dbus.exceptions.UnknownMethodException,
349
dbus.exceptions.DBusException):
213
351
self.group = None
214
def server_state_changed(self, state):
354
def server_state_changed(self, state, error=None):
215
355
"""Derived from the Avahi example code"""
216
if state == avahi.SERVER_COLLISION:
217
logger.error(u"Zeroconf server name collision")
356
logger.debug("Avahi server state change: %i", state)
357
bad_states = { avahi.SERVER_INVALID:
358
"Zeroconf server invalid",
359
avahi.SERVER_REGISTERING: None,
360
avahi.SERVER_COLLISION:
361
"Zeroconf server name collision",
362
avahi.SERVER_FAILURE:
363
"Zeroconf server failure" }
364
if state in bad_states:
365
if bad_states[state] is not None:
367
logger.error(bad_states[state])
369
logger.error(bad_states[state] + ": %r", error)
219
371
elif state == avahi.SERVER_RUNNING:
375
logger.debug("Unknown state: %r", state)
377
logger.debug("Unknown state: %r: %r", state, error)
221
379
def activate(self):
222
380
"""Derived from the Avahi example code"""
223
381
if self.server is None:
224
382
self.server = dbus.Interface(
225
383
self.bus.get_object(avahi.DBUS_NAME,
226
avahi.DBUS_PATH_SERVER),
384
avahi.DBUS_PATH_SERVER,
385
follow_name_owner_changes=True),
227
386
avahi.DBUS_INTERFACE_SERVER)
228
self.server.connect_to_signal(u"StateChanged",
387
self.server.connect_to_signal("StateChanged",
229
388
self.server_state_changed)
230
389
self.server_state_changed(self.server.GetState())
392
class AvahiServiceToSyslog(AvahiService):
394
"""Add the new name to the syslog messages"""
395
ret = AvahiService.rename(self)
396
syslogger.setFormatter(logging.Formatter
397
('Mandos ({0}) [%(process)d]:'
398
' %(levelname)s: %(message)s'
403
def timedelta_to_milliseconds(td):
404
"Convert a datetime.timedelta() to milliseconds"
405
return ((td.days * 24 * 60 * 60 * 1000)
406
+ (td.seconds * 1000)
407
+ (td.microseconds // 1000))
233
410
class Client(object):
234
411
"""A representation of a client host served by this server.
237
name: string; from the config file, used in log messages and
414
approved: bool(); 'None' if not yet approved/disapproved
415
approval_delay: datetime.timedelta(); Time to wait for approval
416
approval_duration: datetime.timedelta(); Duration of one approval
417
checker: subprocess.Popen(); a running checker process used
418
to see if the client lives.
419
'None' if no process is running.
420
checker_callback_tag: a gobject event source tag, or None
421
checker_command: string; External command which is run to check
422
if client lives. %() expansions are done at
423
runtime with vars(self) as dict, so that for
424
instance %(name)s can be used in the command.
425
checker_initiator_tag: a gobject event source tag, or None
426
created: datetime.datetime(); (UTC) object creation
427
client_structure: Object describing what attributes a client has
428
and is used for storing the client at exit
429
current_checker_command: string; current running checker_command
430
disable_initiator_tag: a gobject event source tag, or None
239
432
fingerprint: string (40 or 32 hexadecimal digits); used to
240
433
uniquely identify the client
241
secret: bytestring; sent verbatim (over TLS) to client
242
434
host: string; available for use by the checker command
243
created: datetime.datetime(); (UTC) object creation
244
last_enabled: datetime.datetime(); (UTC)
435
interval: datetime.timedelta(); How often to start a new checker
436
last_approval_request: datetime.datetime(); (UTC) or None
246
437
last_checked_ok: datetime.datetime(); (UTC) or None
438
last_checker_status: integer between 0 and 255 reflecting exit
439
status of last checker. -1 reflects crashed
440
checker, -2 means no checker completed yet.
441
last_enabled: datetime.datetime(); (UTC) or None
442
name: string; from the config file, used in log messages and
444
secret: bytestring; sent verbatim (over TLS) to client
247
445
timeout: datetime.timedelta(); How long from last_checked_ok
248
446
until this client is disabled
249
interval: datetime.timedelta(); How often to start a new checker
250
disable_hook: If set, called by disable() as disable_hook(self)
251
checker: subprocess.Popen(); a running checker process used
252
to see if the client lives.
253
'None' if no process is running.
254
checker_initiator_tag: a gobject event source tag, or None
255
disable_initiator_tag: - '' -
256
checker_callback_tag: - '' -
257
checker_command: string; External command which is run to check if
258
client lives. %() expansions are done at
259
runtime with vars(self) as dict, so that for
260
instance %(name)s can be used in the command.
261
current_checker_command: string; current running checker_command
262
approved_delay: datetime.timedelta(); Time to wait for approval
263
_approved: bool(); 'None' if not yet approved/disapproved
264
approved_duration: datetime.timedelta(); Duration of one approval
447
extended_timeout: extra long timeout when secret has been sent
448
runtime_expansions: Allowed attributes for runtime expansion.
449
expires: datetime.datetime(); time (UTC) when a client will be
451
server_settings: The server_settings dict from main()
268
def _timedelta_to_milliseconds(td):
269
"Convert a datetime.timedelta() to milliseconds"
270
return ((td.days * 24 * 60 * 60 * 1000)
271
+ (td.seconds * 1000)
272
+ (td.microseconds // 1000))
454
runtime_expansions = ("approval_delay", "approval_duration",
455
"created", "enabled", "expires",
456
"fingerprint", "host", "interval",
457
"last_approval_request", "last_checked_ok",
458
"last_enabled", "name", "timeout")
459
client_defaults = { "timeout": "PT5M",
460
"extended_timeout": "PT15M",
462
"checker": "fping -q -- %%(host)s",
464
"approval_delay": "PT0S",
465
"approval_duration": "PT1S",
466
"approved_by_default": "True",
274
470
def timeout_milliseconds(self):
275
471
"Return the 'timeout' attribute in milliseconds"
276
return self._timedelta_to_milliseconds(self.timeout)
472
return timedelta_to_milliseconds(self.timeout)
474
def extended_timeout_milliseconds(self):
475
"Return the 'extended_timeout' attribute in milliseconds"
476
return timedelta_to_milliseconds(self.extended_timeout)
278
478
def interval_milliseconds(self):
279
479
"Return the 'interval' attribute in milliseconds"
280
return self._timedelta_to_milliseconds(self.interval)
282
def approved_delay_milliseconds(self):
283
return self._timedelta_to_milliseconds(self.approved_delay)
285
def __init__(self, name = None, disable_hook=None, config=None):
286
"""Note: the 'checker' key in 'config' sets the
287
'checker_command' attribute and *not* the 'checker'
480
return timedelta_to_milliseconds(self.interval)
482
def approval_delay_milliseconds(self):
483
return timedelta_to_milliseconds(self.approval_delay)
486
def config_parser(config):
487
"""Construct a new dict of client settings of this form:
488
{ client_name: {setting_name: value, ...}, ...}
489
with exceptions for any special settings as defined above.
490
NOTE: Must be a pure function. Must return the same result
491
value given the same arguments.
494
for client_name in config.sections():
495
section = dict(config.items(client_name))
496
client = settings[client_name] = {}
498
client["host"] = section["host"]
499
# Reformat values from string types to Python types
500
client["approved_by_default"] = config.getboolean(
501
client_name, "approved_by_default")
502
client["enabled"] = config.getboolean(client_name,
505
client["fingerprint"] = (section["fingerprint"].upper()
507
if "secret" in section:
508
client["secret"] = section["secret"].decode("base64")
509
elif "secfile" in section:
510
with open(os.path.expanduser(os.path.expandvars
511
(section["secfile"])),
513
client["secret"] = secfile.read()
515
raise TypeError("No secret or secfile for section {0}"
517
client["timeout"] = string_to_delta(section["timeout"])
518
client["extended_timeout"] = string_to_delta(
519
section["extended_timeout"])
520
client["interval"] = string_to_delta(section["interval"])
521
client["approval_delay"] = string_to_delta(
522
section["approval_delay"])
523
client["approval_duration"] = string_to_delta(
524
section["approval_duration"])
525
client["checker_command"] = section["checker"]
526
client["last_approval_request"] = None
527
client["last_checked_ok"] = None
528
client["last_checker_status"] = -2
532
def __init__(self, settings, name = None, server_settings=None):
292
logger.debug(u"Creating client %r", self.name)
534
if server_settings is None:
536
self.server_settings = server_settings
537
# adding all client settings
538
for setting, value in settings.iteritems():
539
setattr(self, setting, value)
542
if not hasattr(self, "last_enabled"):
543
self.last_enabled = datetime.datetime.utcnow()
544
if not hasattr(self, "expires"):
545
self.expires = (datetime.datetime.utcnow()
548
self.last_enabled = None
551
logger.debug("Creating client %r", self.name)
293
552
# Uppercase and remove spaces from fingerprint for later
294
553
# comparison purposes with return value from the fingerprint()
296
self.fingerprint = (config[u"fingerprint"].upper()
298
logger.debug(u" Fingerprint: %s", self.fingerprint)
299
if u"secret" in config:
300
self.secret = config[u"secret"].decode(u"base64")
301
elif u"secfile" in config:
302
with open(os.path.expanduser(os.path.expandvars
303
(config[u"secfile"])),
305
self.secret = secfile.read()
307
#XXX Need to allow secret on demand!
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
555
logger.debug(" Fingerprint: %s", self.fingerprint)
556
self.created = settings.get("created",
557
datetime.datetime.utcnow())
559
# attributes specific for this server instance
318
560
self.checker = None
319
561
self.checker_initiator_tag = None
320
562
self.disable_initiator_tag = None
321
563
self.checker_callback_tag = None
322
self.checker_command = config[u"checker"]
323
564
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",
328
566
self.approvals_pending = 0
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())
567
self.changedstate = (multiprocessing_manager
568
.Condition(multiprocessing_manager
570
self.client_structure = [attr for attr in
571
self.__dict__.iterkeys()
572
if not attr.startswith("_")]
573
self.client_structure.append("client_structure")
575
for name, t in inspect.getmembers(type(self),
579
if not name.startswith("_"):
580
self.client_structure.append(name)
582
# Send notice to process children that client state has changed
335
583
def send_changedstate(self):
336
self.changedstate.acquire()
337
self.changedstate.notify_all()
338
self.changedstate.release()
584
with self.changedstate:
585
self.changedstate.notify_all()
340
587
def enable(self):
341
588
"""Start this client's checker and timeout hooks"""
342
if getattr(self, u"enabled", False):
589
if getattr(self, "enabled", False):
343
590
# Already enabled
345
self.send_changedstate()
592
self.expires = datetime.datetime.utcnow() + self.timeout
346
594
self.last_enabled = datetime.datetime.utcnow()
596
self.send_changedstate()
598
def disable(self, quiet=True):
599
"""Disable this client."""
600
if not getattr(self, "enabled", False):
603
logger.info("Disabling client %s", self.name)
604
if getattr(self, "disable_initiator_tag", None) is not None:
605
gobject.source_remove(self.disable_initiator_tag)
606
self.disable_initiator_tag = None
608
if getattr(self, "checker_initiator_tag", None) is not None:
609
gobject.source_remove(self.checker_initiator_tag)
610
self.checker_initiator_tag = None
614
self.send_changedstate()
615
# Do not run this again if called by a gobject.timeout_add
621
def init_checker(self):
347
622
# Schedule a new checker to be started an 'interval' from now,
348
623
# and every interval from then on.
624
if self.checker_initiator_tag is not None:
625
gobject.source_remove(self.checker_initiator_tag)
349
626
self.checker_initiator_tag = (gobject.timeout_add
350
627
(self.interval_milliseconds(),
351
628
self.start_checker))
352
629
# Schedule a disable() when 'timeout' has passed
630
if self.disable_initiator_tag is not None:
631
gobject.source_remove(self.disable_initiator_tag)
353
632
self.disable_initiator_tag = (gobject.timeout_add
354
633
(self.timeout_milliseconds(),
357
635
# Also start a new checker *right now*.
358
636
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
385
638
def checker_callback(self, pid, condition, command):
386
639
"""The checker has completed, so take appropriate actions."""
387
640
self.checker_callback_tag = None
388
641
self.checker = None
389
642
if os.WIFEXITED(condition):
390
exitstatus = os.WEXITSTATUS(condition)
392
logger.info(u"Checker for %(name)s succeeded",
643
self.last_checker_status = os.WEXITSTATUS(condition)
644
if self.last_checker_status == 0:
645
logger.info("Checker for %(name)s succeeded",
394
647
self.checked_ok()
396
logger.info(u"Checker for %(name)s failed",
649
logger.info("Checker for %(name)s failed",
399
logger.warning(u"Checker for %(name)s crashed?",
652
self.last_checker_status = -1
653
logger.warning("Checker for %(name)s crashed?",
402
656
def checked_ok(self):
403
"""Bump up the timeout for this client.
405
This should only be called when the client has been seen,
657
"""Assert that the client has been seen, alive and well."""
408
658
self.last_checked_ok = datetime.datetime.utcnow()
409
gobject.source_remove(self.disable_initiator_tag)
410
self.disable_initiator_tag = (gobject.timeout_add
411
(self.timeout_milliseconds(),
659
self.last_checker_status = 0
662
def bump_timeout(self, timeout=None):
663
"""Bump up the timeout for this client."""
665
timeout = self.timeout
666
if self.disable_initiator_tag is not None:
667
gobject.source_remove(self.disable_initiator_tag)
668
self.disable_initiator_tag = None
669
if getattr(self, "enabled", False):
670
self.disable_initiator_tag = (gobject.timeout_add
671
(timedelta_to_milliseconds
672
(timeout), self.disable))
673
self.expires = datetime.datetime.utcnow() + timeout
675
def need_approval(self):
676
self.last_approval_request = datetime.datetime.utcnow()
414
678
def start_checker(self):
415
679
"""Start a new checker subprocess if one is not running.
428
692
# If a checker exists, make sure it is not a zombie
430
694
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
431
except (AttributeError, OSError), error:
432
if (isinstance(error, OSError)
433
and error.errno != errno.ECHILD):
695
except AttributeError:
697
except OSError as error:
698
if error.errno != errno.ECHILD:
437
logger.warning(u"Checker was a zombie")
702
logger.warning("Checker was a zombie")
438
703
gobject.source_remove(self.checker_callback_tag)
439
704
self.checker_callback(pid, status,
440
705
self.current_checker_command)
441
706
# Start a new checker if needed
442
707
if self.checker is None:
708
# Escape attributes for the shell
709
escaped_attrs = dict(
710
(attr, re.escape(unicode(getattr(self, attr))))
712
self.runtime_expansions)
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
714
command = self.checker_command % escaped_attrs
715
except TypeError as error:
716
logger.error('Could not format string "%s"',
717
self.checker_command, exc_info=error)
718
return True # Try again later
460
719
self.current_checker_command = command
462
logger.info(u"Starting checker %r for %s",
721
logger.info("Starting checker %r for %s",
463
722
command, self.name)
464
723
# We don't need to redirect stdout and stderr, since
465
724
# in normal mode, that is already done by daemon(),
466
725
# and in debug mode we don't want to. (Stdin is
467
726
# always replaced by /dev/null.)
727
# The exception is when not debugging but nevertheless
728
# running in the foreground; use the previously
731
if (not self.server_settings["debug"]
732
and self.server_settings["foreground"]):
733
popen_args.update({"stdout": wnull,
468
735
self.checker = subprocess.Popen(command,
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.
739
except OSError as error:
740
logger.error("Failed to start subprocess",
743
self.checker_callback_tag = (gobject.child_watch_add
745
self.checker_callback,
747
# The checker may have completed before the gobject
748
# watch was added. Check for this.
477
750
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
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",
751
except OSError as error:
752
if error.errno == errno.ECHILD:
753
# This should never happen
754
logger.error("Child process vanished",
759
gobject.source_remove(self.checker_callback_tag)
760
self.checker_callback(pid, status, command)
484
761
# Re-run this periodically if run by gobject.timeout_add
554
869
class DBusObjectWithProperties(dbus.service.Object):
555
870
"""A D-Bus object with properties.
557
872
Classes inheriting from this can use the dbus_service_property
558
873
decorator to expose methods as D-Bus properties. It exposes the
559
874
standard Get(), Set(), and GetAll() methods on the D-Bus.
563
def _is_dbus_property(obj):
564
return getattr(obj, u"_dbus_is_property", False)
878
def _is_dbus_thing(thing):
879
"""Returns a function testing if an attribute is a D-Bus thing
881
If called like _is_dbus_thing("method") it returns a function
882
suitable for use as predicate to inspect.getmembers().
884
return lambda obj: getattr(obj, "_dbus_is_{0}".format(thing),
566
def _get_all_dbus_properties(self):
887
def _get_all_dbus_things(self, thing):
567
888
"""Returns a generator of (name, attribute) pairs
569
return ((prop._dbus_name, prop)
571
inspect.getmembers(self, self._is_dbus_property))
890
return ((getattr(athing.__get__(self), "_dbus_name",
892
athing.__get__(self))
893
for cls in self.__class__.__mro__
895
inspect.getmembers(cls,
896
self._is_dbus_thing(thing)))
573
898
def _get_dbus_property(self, interface_name, property_name):
574
899
"""Returns a bound method if one exists which is a D-Bus
575
900
property with the specified name and interface.
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)):
902
for cls in self.__class__.__mro__:
903
for name, value in (inspect.getmembers
905
self._is_dbus_thing("property"))):
906
if (value._dbus_name == property_name
907
and value._dbus_interface == interface_name):
908
return value.__get__(self)
587
910
# No such property
588
raise DBusPropertyNotFound(self.dbus_object_path + u":"
589
+ interface_name + u"."
911
raise DBusPropertyNotFound(self.dbus_object_path + ":"
912
+ interface_name + "."
592
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ss",
915
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
594
917
def Get(self, interface_name, property_name):
595
918
"""Standard D-Bus property Get() method, see D-Bus standard.
597
920
prop = self._get_dbus_property(interface_name, property_name)
598
if prop._dbus_access == u"write":
921
if prop._dbus_access == "write":
599
922
raise DBusPropertyAccessException(property_name)
601
if not hasattr(value, u"variant_level"):
924
if not hasattr(value, "variant_level"):
603
926
return type(value)(value, variant_level=value.variant_level+1)
605
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ssv")
928
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
606
929
def Set(self, interface_name, property_name, value):
607
930
"""Standard D-Bus property Set() method, see D-Bus standard.
609
932
prop = self._get_dbus_property(interface_name, property_name)
610
if prop._dbus_access == u"read":
933
if prop._dbus_access == "read":
611
934
raise DBusPropertyAccessException(property_name)
612
if prop._dbus_get_args_options[u"byte_arrays"]:
935
if prop._dbus_get_args_options["byte_arrays"]:
613
936
# The byte_arrays option is not supported yet on
614
937
# signatures other than "ay".
615
if prop._dbus_signature != u"ay":
617
value = dbus.ByteArray(''.join(unichr(byte)
938
if prop._dbus_signature != "ay":
939
raise ValueError("Byte arrays not supported for non-"
940
"'ay' signature {0!r}"
941
.format(prop._dbus_signature))
942
value = dbus.ByteArray(b''.join(chr(byte)
621
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"s",
622
out_signature=u"a{sv}")
946
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
947
out_signature="a{sv}")
623
948
def GetAll(self, interface_name):
624
949
"""Standard D-Bus property GetAll() method, see D-Bus
627
952
Note: Will not include properties with access="write".
630
for name, prop in self._get_all_dbus_properties():
955
for name, prop in self._get_all_dbus_things("property"):
631
956
if (interface_name
632
957
and interface_name != prop._dbus_interface):
633
958
# Interface non-empty but did not match
635
960
# Ignore write-only properties
636
if prop._dbus_access == u"write":
961
if prop._dbus_access == "write":
639
if not hasattr(value, u"variant_level"):
964
if not hasattr(value, "variant_level"):
965
properties[name] = value
642
all[name] = type(value)(value, variant_level=
643
value.variant_level+1)
644
return dbus.Dictionary(all, signature=u"sv")
967
properties[name] = type(value)(value, variant_level=
968
value.variant_level+1)
969
return dbus.Dictionary(properties, signature="sv")
646
971
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
648
973
path_keyword='object_path',
649
974
connection_keyword='connection')
650
975
def Introspect(self, object_path, connection):
651
"""Standard D-Bus method, overloaded to insert property tags.
976
"""Overloading of standard D-Bus method.
978
Inserts property tags and interface annotation tags.
653
980
xmlstring = dbus.service.Object.Introspect(self, object_path,
656
983
document = xml.dom.minidom.parseString(xmlstring)
657
984
def make_tag(document, name, prop):
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
e = document.createElement("property")
986
e.setAttribute("name", name)
987
e.setAttribute("type", prop._dbus_signature)
988
e.setAttribute("access", prop._dbus_access)
663
for if_tag in document.getElementsByTagName(u"interface"):
990
for if_tag in document.getElementsByTagName("interface"):
664
992
for tag in (make_tag(document, name, prop)
666
in self._get_all_dbus_properties()
994
in self._get_all_dbus_things("property")
667
995
if prop._dbus_interface
668
== if_tag.getAttribute(u"name")):
996
== if_tag.getAttribute("name")):
669
997
if_tag.appendChild(tag)
998
# Add annotation tags
999
for typ in ("method", "signal", "property"):
1000
for tag in if_tag.getElementsByTagName(typ):
1002
for name, prop in (self.
1003
_get_all_dbus_things(typ)):
1004
if (name == tag.getAttribute("name")
1005
and prop._dbus_interface
1006
== if_tag.getAttribute("name")):
1007
annots.update(getattr
1009
"_dbus_annotations",
1011
for name, value in annots.iteritems():
1012
ann_tag = document.createElement(
1014
ann_tag.setAttribute("name", name)
1015
ann_tag.setAttribute("value", value)
1016
tag.appendChild(ann_tag)
1017
# Add interface annotation tags
1018
for annotation, value in dict(
1019
itertools.chain.from_iterable(
1020
annotations().iteritems()
1021
for name, annotations in
1022
self._get_all_dbus_things("interface")
1023
if name == if_tag.getAttribute("name")
1025
ann_tag = document.createElement("annotation")
1026
ann_tag.setAttribute("name", annotation)
1027
ann_tag.setAttribute("value", value)
1028
if_tag.appendChild(ann_tag)
670
1029
# Add the names to the return values for the
671
1030
# "org.freedesktop.DBus.Properties" methods
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")
1031
if (if_tag.getAttribute("name")
1032
== "org.freedesktop.DBus.Properties"):
1033
for cn in if_tag.getElementsByTagName("method"):
1034
if cn.getAttribute("name") == "Get":
1035
for arg in cn.getElementsByTagName("arg"):
1036
if (arg.getAttribute("direction")
1038
arg.setAttribute("name", "value")
1039
elif cn.getAttribute("name") == "GetAll":
1040
for arg in cn.getElementsByTagName("arg"):
1041
if (arg.getAttribute("direction")
1043
arg.setAttribute("name", "props")
1044
xmlstring = document.toxml("utf-8")
686
1045
document.unlink()
687
1046
except (AttributeError, xml.dom.DOMException,
688
xml.parsers.expat.ExpatError), error:
689
logger.error(u"Failed to override Introspection method",
1047
xml.parsers.expat.ExpatError) as error:
1048
logger.error("Failed to override Introspection method",
691
1050
return xmlstring
1053
def datetime_to_dbus(dt, variant_level=0):
1054
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1056
return dbus.String("", variant_level = variant_level)
1057
return dbus.String(dt.isoformat(),
1058
variant_level=variant_level)
1061
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1062
"""A class decorator; applied to a subclass of
1063
dbus.service.Object, it will add alternate D-Bus attributes with
1064
interface names according to the "alt_interface_names" mapping.
1067
@alternate_dbus_interfaces({"org.example.Interface":
1068
"net.example.AlternateInterface"})
1069
class SampleDBusObject(dbus.service.Object):
1070
@dbus.service.method("org.example.Interface")
1071
def SampleDBusMethod():
1074
The above "SampleDBusMethod" on "SampleDBusObject" will be
1075
reachable via two interfaces: "org.example.Interface" and
1076
"net.example.AlternateInterface", the latter of which will have
1077
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1078
"true", unless "deprecate" is passed with a False value.
1080
This works for methods and signals, and also for D-Bus properties
1081
(from DBusObjectWithProperties) and interfaces (from the
1082
dbus_interface_annotations decorator).
1085
for orig_interface_name, alt_interface_name in (
1086
alt_interface_names.iteritems()):
1088
interface_names = set()
1089
# Go though all attributes of the class
1090
for attrname, attribute in inspect.getmembers(cls):
1091
# Ignore non-D-Bus attributes, and D-Bus attributes
1092
# with the wrong interface name
1093
if (not hasattr(attribute, "_dbus_interface")
1094
or not attribute._dbus_interface
1095
.startswith(orig_interface_name)):
1097
# Create an alternate D-Bus interface name based on
1099
alt_interface = (attribute._dbus_interface
1100
.replace(orig_interface_name,
1101
alt_interface_name))
1102
interface_names.add(alt_interface)
1103
# Is this a D-Bus signal?
1104
if getattr(attribute, "_dbus_is_signal", False):
1105
# Extract the original non-method undecorated
1106
# function by black magic
1107
nonmethod_func = (dict(
1108
zip(attribute.func_code.co_freevars,
1109
attribute.__closure__))["func"]
1111
# Create a new, but exactly alike, function
1112
# object, and decorate it to be a new D-Bus signal
1113
# with the alternate D-Bus interface name
1114
new_function = (dbus.service.signal
1116
attribute._dbus_signature)
1117
(types.FunctionType(
1118
nonmethod_func.func_code,
1119
nonmethod_func.func_globals,
1120
nonmethod_func.func_name,
1121
nonmethod_func.func_defaults,
1122
nonmethod_func.func_closure)))
1123
# Copy annotations, if any
1125
new_function._dbus_annotations = (
1126
dict(attribute._dbus_annotations))
1127
except AttributeError:
1129
# Define a creator of a function to call both the
1130
# original and alternate functions, so both the
1131
# original and alternate signals gets sent when
1132
# the function is called
1133
def fixscope(func1, func2):
1134
"""This function is a scope container to pass
1135
func1 and func2 to the "call_both" function
1136
outside of its arguments"""
1137
def call_both(*args, **kwargs):
1138
"""This function will emit two D-Bus
1139
signals by calling func1 and func2"""
1140
func1(*args, **kwargs)
1141
func2(*args, **kwargs)
1143
# Create the "call_both" function and add it to
1145
attr[attrname] = fixscope(attribute, new_function)
1146
# Is this a D-Bus method?
1147
elif getattr(attribute, "_dbus_is_method", False):
1148
# Create a new, but exactly alike, function
1149
# object. Decorate it to be a new D-Bus method
1150
# with the alternate D-Bus interface name. Add it
1152
attr[attrname] = (dbus.service.method
1154
attribute._dbus_in_signature,
1155
attribute._dbus_out_signature)
1157
(attribute.func_code,
1158
attribute.func_globals,
1159
attribute.func_name,
1160
attribute.func_defaults,
1161
attribute.func_closure)))
1162
# Copy annotations, if any
1164
attr[attrname]._dbus_annotations = (
1165
dict(attribute._dbus_annotations))
1166
except AttributeError:
1168
# Is this a D-Bus property?
1169
elif getattr(attribute, "_dbus_is_property", False):
1170
# Create a new, but exactly alike, function
1171
# object, and decorate it to be a new D-Bus
1172
# property with the alternate D-Bus interface
1173
# name. Add it to the class.
1174
attr[attrname] = (dbus_service_property
1176
attribute._dbus_signature,
1177
attribute._dbus_access,
1179
._dbus_get_args_options
1182
(attribute.func_code,
1183
attribute.func_globals,
1184
attribute.func_name,
1185
attribute.func_defaults,
1186
attribute.func_closure)))
1187
# Copy annotations, if any
1189
attr[attrname]._dbus_annotations = (
1190
dict(attribute._dbus_annotations))
1191
except AttributeError:
1193
# Is this a D-Bus interface?
1194
elif getattr(attribute, "_dbus_is_interface", False):
1195
# Create a new, but exactly alike, function
1196
# object. Decorate it to be a new D-Bus interface
1197
# with the alternate D-Bus interface name. Add it
1199
attr[attrname] = (dbus_interface_annotations
1202
(attribute.func_code,
1203
attribute.func_globals,
1204
attribute.func_name,
1205
attribute.func_defaults,
1206
attribute.func_closure)))
1208
# Deprecate all alternate interfaces
1209
iname="_AlternateDBusNames_interface_annotation{0}"
1210
for interface_name in interface_names:
1211
@dbus_interface_annotations(interface_name)
1213
return { "org.freedesktop.DBus.Deprecated":
1215
# Find an unused name
1216
for aname in (iname.format(i)
1217
for i in itertools.count()):
1218
if aname not in attr:
1222
# Replace the class with a new subclass of it with
1223
# methods, signals, etc. as created above.
1224
cls = type(b"{0}Alternate".format(cls.__name__),
1230
@alternate_dbus_interfaces({"se.recompile.Mandos":
1231
"se.bsnet.fukt.Mandos"})
694
1232
class ClientDBus(Client, DBusObjectWithProperties):
695
1233
"""A Client class using D-Bus
698
1236
dbus_object_path: dbus.ObjectPath
699
1237
bus: dbus.SystemBus()
1240
runtime_expansions = (Client.runtime_expansions
1241
+ ("dbus_object_path",))
701
1243
# dbus.service.Object doesn't use super(), so we can't either.
703
1245
def __init__(self, bus = None, *args, **kwargs):
704
self._approvals_pending = 0
706
1247
Client.__init__(self, *args, **kwargs)
707
1248
# Only now, when this client is initialized, can it show up on
1250
client_object_name = unicode(self.name).translate(
1251
{ord("."): ord("_"),
1252
ord("-"): ord("_")})
709
1253
self.dbus_object_path = (dbus.ObjectPath
711
+ self.name.replace(u".", u"_")))
1254
("/clients/" + client_object_name))
712
1255
DBusObjectWithProperties.__init__(self, self.bus,
713
1256
self.dbus_object_path)
715
#Could possible return a bool(self._approvals_pending),
716
#but this could mess up approvals_pending += 1 XXX
717
def _get_approvals_pending(self):
718
return self._approvals_pending
719
def _set_approvals_pending(self, value):
720
old_value = self._approvals_pending
721
self._approvals_pending = value
723
if (hasattr(self, "dbus_object_path")
724
and bval is not bool(old_value)):
725
dbus_bool = dbus.Boolean(bval, variant_level=1)
726
self.PropertyChanged(dbus.String(u"approved_pending"),
729
approvals_pending = property(_get_approvals_pending,
730
_set_approvals_pending)
731
del _get_approvals_pending, _set_approvals_pending
734
def _datetime_to_dbus(dt, variant_level=0):
735
"""Convert a UTC datetime.datetime() to a D-Bus type."""
736
return dbus.String(dt.isoformat(),
737
variant_level=variant_level)
740
oldstate = getattr(self, u"enabled", False)
741
r = Client.enable(self)
742
if oldstate != self.enabled:
744
self.PropertyChanged(dbus.String(u"enabled"),
745
dbus.Boolean(True, variant_level=1))
746
self.PropertyChanged(
747
dbus.String(u"last_enabled"),
748
self._datetime_to_dbus(self.last_enabled,
752
def disable(self, quiet = False):
753
oldstate = getattr(self, u"enabled", False)
754
r = Client.disable(self, quiet=quiet)
755
if not quiet and oldstate != self.enabled:
757
self.PropertyChanged(dbus.String(u"enabled"),
758
dbus.Boolean(False, variant_level=1))
1258
def notifychangeproperty(transform_func,
1259
dbus_name, type_func=lambda x: x,
1261
""" Modify a variable so that it's a property which announces
1262
its changes to DBus.
1264
transform_fun: Function that takes a value and a variant_level
1265
and transforms it to a D-Bus type.
1266
dbus_name: D-Bus name of the variable
1267
type_func: Function that transform the value before sending it
1268
to the D-Bus. Default: no transform
1269
variant_level: D-Bus variant level. Default: 1
1271
attrname = "_{0}".format(dbus_name)
1272
def setter(self, value):
1273
if hasattr(self, "dbus_object_path"):
1274
if (not hasattr(self, attrname) or
1275
type_func(getattr(self, attrname, None))
1276
!= type_func(value)):
1277
dbus_value = transform_func(type_func(value),
1280
self.PropertyChanged(dbus.String(dbus_name),
1282
setattr(self, attrname, value)
1284
return property(lambda self: getattr(self, attrname), setter)
1286
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1287
approvals_pending = notifychangeproperty(dbus.Boolean,
1290
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1291
last_enabled = notifychangeproperty(datetime_to_dbus,
1293
checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1294
type_func = lambda checker:
1295
checker is not None)
1296
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1298
last_checker_status = notifychangeproperty(dbus.Int16,
1299
"LastCheckerStatus")
1300
last_approval_request = notifychangeproperty(
1301
datetime_to_dbus, "LastApprovalRequest")
1302
approved_by_default = notifychangeproperty(dbus.Boolean,
1303
"ApprovedByDefault")
1304
approval_delay = notifychangeproperty(dbus.UInt64,
1307
timedelta_to_milliseconds)
1308
approval_duration = notifychangeproperty(
1309
dbus.UInt64, "ApprovalDuration",
1310
type_func = timedelta_to_milliseconds)
1311
host = notifychangeproperty(dbus.String, "Host")
1312
timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1314
timedelta_to_milliseconds)
1315
extended_timeout = notifychangeproperty(
1316
dbus.UInt64, "ExtendedTimeout",
1317
type_func = timedelta_to_milliseconds)
1318
interval = notifychangeproperty(dbus.UInt64,
1321
timedelta_to_milliseconds)
1322
checker_command = notifychangeproperty(dbus.String, "Checker")
1324
del notifychangeproperty
761
1326
def __del__(self, *args, **kwargs):
763
1328
self.remove_from_connection()
764
1329
except LookupError:
766
if hasattr(DBusObjectWithProperties, u"__del__"):
1331
if hasattr(DBusObjectWithProperties, "__del__"):
767
1332
DBusObjectWithProperties.__del__(self, *args, **kwargs)
768
1333
Client.__del__(self, *args, **kwargs)
789
1351
return Client.checker_callback(self, pid, condition, command,
790
1352
*args, **kwargs)
792
def checked_ok(self, *args, **kwargs):
793
r = Client.checked_ok(self, *args, **kwargs)
795
self.PropertyChanged(
796
dbus.String(u"last_checked_ok"),
797
(self._datetime_to_dbus(self.last_checked_ok,
801
1354
def start_checker(self, *args, **kwargs):
802
old_checker = self.checker
803
if self.checker is not None:
804
old_checker_pid = self.checker.pid
806
old_checker_pid = None
1355
old_checker_pid = getattr(self.checker, "pid", None)
807
1356
r = Client.start_checker(self, *args, **kwargs)
808
1357
# Only if new checker process was started
809
1358
if (self.checker is not None
810
1359
and old_checker_pid != self.checker.pid):
811
1360
# Emit D-Bus signal
812
1361
self.CheckerStarted(self.current_checker_command)
813
self.PropertyChanged(
814
dbus.String(u"checker_running"),
815
dbus.Boolean(True, variant_level=1))
818
def stop_checker(self, *args, **kwargs):
819
old_checker = getattr(self, u"checker", None)
820
r = Client.stop_checker(self, *args, **kwargs)
821
if (old_checker is not None
822
and getattr(self, u"checker", None) is None):
823
self.PropertyChanged(dbus.String(u"checker_running"),
824
dbus.Boolean(False, variant_level=1))
827
1364
def _reset_approved(self):
828
self._approved = None
1365
self.approved = None
831
1368
def approve(self, value=True):
832
self.send_changedstate()
833
self._approved = value
834
gobject.timeout_add(self._timedelta_to_milliseconds(self.approved_duration),
1369
self.approved = value
1370
gobject.timeout_add(timedelta_to_milliseconds
1371
(self.approval_duration),
835
1372
self._reset_approved)
1373
self.send_changedstate()
838
1375
## D-Bus methods, signals & properties
839
_interface = u"se.bsnet.fukt.Mandos.Client"
1376
_interface = "se.recompile.Mandos.Client"
1380
@dbus_interface_annotations(_interface)
1382
return { "org.freedesktop.DBus.Property.EmitsChangedSignal":
843
1387
# CheckerCompleted - signal
844
@dbus.service.signal(_interface, signature=u"nxs")
1388
@dbus.service.signal(_interface, signature="nxs")
845
1389
def CheckerCompleted(self, exitcode, waitstatus, command):
849
1393
# CheckerStarted - signal
850
@dbus.service.signal(_interface, signature=u"s")
1394
@dbus.service.signal(_interface, signature="s")
851
1395
def CheckerStarted(self, command):
855
1399
# PropertyChanged - signal
856
@dbus.service.signal(_interface, signature=u"sv")
1400
@dbus.service.signal(_interface, signature="sv")
857
1401
def PropertyChanged(self, property, value):
861
1405
# GotSecret - signal
862
# XXXTEDDY Is sent after succesfull transfer of secret from mandos-server to mandos-client
863
1406
@dbus.service.signal(_interface)
864
1407
def GotSecret(self):
1409
Is sent after a successful transfer of secret from the Mandos
1410
server to mandos-client
868
1414
# Rejected - signal
869
@dbus.service.signal(_interface, signature=u"s")
1415
@dbus.service.signal(_interface, signature="s")
870
1416
def Rejected(self, reason):
874
1420
# NeedApproval - signal
875
@dbus.service.signal(_interface, signature=u"db")
1421
@dbus.service.signal(_interface, signature="tb")
876
1422
def NeedApproval(self, timeout, default):
1424
return self.need_approval()
882
1428
# Approve - method
883
@dbus.service.method(_interface, in_signature=u"b")
1429
@dbus.service.method(_interface, in_signature="b")
884
1430
def Approve(self, value):
885
1431
self.approve(value)
887
1433
# CheckedOK - method
888
1434
@dbus.service.method(_interface)
889
1435
def CheckedOK(self):
890
return self.checked_ok()
892
1438
# Enable - method
893
1439
@dbus.service.method(_interface)
917
# approved_pending - property
918
@dbus_service_property(_interface, signature=u"b", access=u"read")
919
def approved_pending_dbus_property(self):
1463
# ApprovalPending - property
1464
@dbus_service_property(_interface, signature="b", access="read")
1465
def ApprovalPending_dbus_property(self):
920
1466
return dbus.Boolean(bool(self.approvals_pending))
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):
1468
# ApprovedByDefault - property
1469
@dbus_service_property(_interface, signature="b",
1471
def ApprovedByDefault_dbus_property(self, value=None):
1472
if value is None: # get
1473
return dbus.Boolean(self.approved_by_default)
1474
self.approved_by_default = bool(value)
1476
# ApprovalDelay - property
1477
@dbus_service_property(_interface, signature="t",
1479
def ApprovalDelay_dbus_property(self, value=None):
1480
if value is None: # get
1481
return dbus.UInt64(self.approval_delay_milliseconds())
1482
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1484
# ApprovalDuration - property
1485
@dbus_service_property(_interface, signature="t",
1487
def ApprovalDuration_dbus_property(self, value=None):
1488
if value is None: # get
1489
return dbus.UInt64(timedelta_to_milliseconds(
1490
self.approval_duration))
1491
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1494
@dbus_service_property(_interface, signature="s", access="read")
1495
def Name_dbus_property(self):
944
1496
return dbus.String(self.name)
946
# fingerprint - property
947
@dbus_service_property(_interface, signature=u"s", access=u"read")
948
def fingerprint_dbus_property(self):
1498
# Fingerprint - property
1499
@dbus_service_property(_interface, signature="s", access="read")
1500
def Fingerprint_dbus_property(self):
949
1501
return dbus.String(self.fingerprint)
952
@dbus_service_property(_interface, signature=u"s",
954
def host_dbus_property(self, value=None):
1504
@dbus_service_property(_interface, signature="s",
1506
def Host_dbus_property(self, value=None):
955
1507
if value is None: # get
956
1508
return dbus.String(self.host)
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):
1509
self.host = unicode(value)
1511
# Created - property
1512
@dbus_service_property(_interface, signature="s", access="read")
1513
def Created_dbus_property(self):
1514
return datetime_to_dbus(self.created)
1516
# LastEnabled - property
1517
@dbus_service_property(_interface, signature="s", access="read")
1518
def LastEnabled_dbus_property(self):
1519
return datetime_to_dbus(self.last_enabled)
1521
# Enabled - property
1522
@dbus_service_property(_interface, signature="b",
1524
def Enabled_dbus_property(self, value=None):
978
1525
if value is None: # get
979
1526
return dbus.Boolean(self.enabled)
985
# last_checked_ok - property
986
@dbus_service_property(_interface, signature=u"s",
988
def last_checked_ok_dbus_property(self, value=None):
1532
# LastCheckedOK - property
1533
@dbus_service_property(_interface, signature="s",
1535
def LastCheckedOK_dbus_property(self, value=None):
989
1536
if value is not None:
990
1537
self.checked_ok()
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):
1539
return datetime_to_dbus(self.last_checked_ok)
1541
# LastCheckerStatus - property
1542
@dbus_service_property(_interface, signature="n",
1544
def LastCheckerStatus_dbus_property(self):
1545
return dbus.Int16(self.last_checker_status)
1547
# Expires - property
1548
@dbus_service_property(_interface, signature="s", access="read")
1549
def Expires_dbus_property(self):
1550
return datetime_to_dbus(self.expires)
1552
# LastApprovalRequest - property
1553
@dbus_service_property(_interface, signature="s", access="read")
1554
def LastApprovalRequest_dbus_property(self):
1555
return datetime_to_dbus(self.last_approval_request)
1557
# Timeout - property
1558
@dbus_service_property(_interface, signature="t",
1560
def Timeout_dbus_property(self, value=None):
1001
1561
if value is None: # get
1002
1562
return dbus.UInt64(self.timeout_milliseconds())
1563
old_timeout = self.timeout
1003
1564
self.timeout = datetime.timedelta(0, 0, 0, value)
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):
1565
# Reschedule disabling
1567
now = datetime.datetime.utcnow()
1568
self.expires += self.timeout - old_timeout
1569
if self.expires <= now:
1570
# The timeout has passed
1573
if (getattr(self, "disable_initiator_tag", None)
1576
gobject.source_remove(self.disable_initiator_tag)
1577
self.disable_initiator_tag = (
1578
gobject.timeout_add(
1579
timedelta_to_milliseconds(self.expires - now),
1582
# ExtendedTimeout - property
1583
@dbus_service_property(_interface, signature="t",
1585
def ExtendedTimeout_dbus_property(self, value=None):
1586
if value is None: # get
1587
return dbus.UInt64(self.extended_timeout_milliseconds())
1588
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1590
# Interval - property
1591
@dbus_service_property(_interface, signature="t",
1593
def Interval_dbus_property(self, value=None):
1029
1594
if value is None: # get
1030
1595
return dbus.UInt64(self.interval_milliseconds())
1031
1596
self.interval = datetime.timedelta(0, 0, 0, value)
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:
1597
if getattr(self, "checker_initiator_tag", None) is 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):
1600
# Reschedule checker run
1601
gobject.source_remove(self.checker_initiator_tag)
1602
self.checker_initiator_tag = (gobject.timeout_add
1603
(value, self.start_checker))
1604
self.start_checker() # Start one now, too
1606
# Checker - property
1607
@dbus_service_property(_interface, signature="s",
1609
def Checker_dbus_property(self, value=None):
1047
1610
if value is None: # get
1048
1611
return dbus.String(self.checker_command)
1049
self.checker_command = value
1051
self.PropertyChanged(dbus.String(u"checker"),
1052
dbus.String(self.checker_command,
1612
self.checker_command = unicode(value)
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):
1614
# CheckerRunning - property
1615
@dbus_service_property(_interface, signature="b",
1617
def CheckerRunning_dbus_property(self, value=None):
1059
1618
if value is None: # get
1060
1619
return dbus.Boolean(self.checker is not None)
1112
1671
def handle(self):
1113
1672
with contextlib.closing(self.server.child_pipe) as child_pipe:
1114
logger.info(u"TCP connection from: %s",
1673
logger.info("TCP connection from: %s",
1115
1674
unicode(self.client_address))
1116
logger.debug(u"Pipe FD: %d",
1675
logger.debug("Pipe FD: %d",
1117
1676
self.server.child_pipe.fileno())
1119
1678
session = (gnutls.connection
1120
1679
.ClientSession(self.request,
1121
1680
gnutls.connection
1122
1681
.X509Credentials()))
1124
1683
# Note: gnutls.connection.X509Credentials is really a
1125
1684
# generic GnuTLS certificate credentials object so long as
1126
1685
# no X.509 keys are added to it. Therefore, we can use it
1127
1686
# here despite using OpenPGP certificates.
1129
#priority = u':'.join((u"NONE", u"+VERS-TLS1.1",
1130
# u"+AES-256-CBC", u"+SHA1",
1131
# u"+COMP-NULL", u"+CTYPE-OPENPGP",
1688
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1689
# "+AES-256-CBC", "+SHA1",
1690
# "+COMP-NULL", "+CTYPE-OPENPGP",
1133
1692
# Use a fallback default, since this MUST be set.
1134
1693
priority = self.server.gnutls_priority
1135
1694
if priority is None:
1136
priority = u"NORMAL"
1137
1696
(gnutls.library.functions
1138
1697
.gnutls_priority_set_direct(session._c_object,
1139
1698
priority, None))
1141
1700
# Start communication using the Mandos protocol
1142
1701
# Get protocol number
1143
1702
line = self.request.makefile().readline()
1144
logger.debug(u"Protocol version: %r", line)
1703
logger.debug("Protocol version: %r", line)
1146
1705
if int(line.strip().split()[0]) > 1:
1148
except (ValueError, IndexError, RuntimeError), error:
1149
logger.error(u"Unknown protocol version: %s", error)
1706
raise RuntimeError(line)
1707
except (ValueError, IndexError, RuntimeError) as error:
1708
logger.error("Unknown protocol version: %s", error)
1152
1711
# Start GnuTLS connection
1154
1713
session.handshake()
1155
except gnutls.errors.GNUTLSError, error:
1156
logger.warning(u"Handshake failed: %s", error)
1714
except gnutls.errors.GNUTLSError as error:
1715
logger.warning("Handshake failed: %s", error)
1157
1716
# Do not run session.bye() here: the session is not
1158
1717
# established. Just abandon the request.
1160
logger.debug(u"Handshake succeeded")
1719
logger.debug("Handshake succeeded")
1162
1721
approval_required = False
1165
1724
fpr = self.fingerprint(self.peer_certificate
1167
except (TypeError, gnutls.errors.GNUTLSError), error:
1168
logger.warning(u"Bad certificate: %s", error)
1727
gnutls.errors.GNUTLSError) as error:
1728
logger.warning("Bad certificate: %s", error)
1170
logger.debug(u"Fingerprint: %s", fpr)
1730
logger.debug("Fingerprint: %s", fpr)
1173
1733
client = ProxyClient(child_pipe, fpr,
1174
1734
self.client_address)
1175
1735
except KeyError:
1178
if client.approved_delay:
1179
delay = client.approved_delay
1738
if client.approval_delay:
1739
delay = client.approval_delay
1180
1740
client.approvals_pending += 1
1181
1741
approval_required = True
1184
1744
if not client.enabled:
1185
logger.warning(u"Client %s is disabled",
1745
logger.info("Client %s is disabled",
1187
1747
if self.server.use_dbus:
1188
1748
# Emit D-Bus signal
1189
client.Rejected("Disabled")
1749
client.Rejected("Disabled")
1192
if client._approved or not client.approved_delay:
1752
if client.approved or not client.approval_delay:
1193
1753
#We are approved or approval is disabled
1195
elif client._approved is None:
1196
logger.info(u"Client %s need approval",
1755
elif client.approved is None:
1756
logger.info("Client %s needs approval",
1198
1758
if self.server.use_dbus:
1199
1759
# Emit D-Bus signal
1200
1760
client.NeedApproval(
1201
client.approved_delay_milliseconds(),
1761
client.approval_delay_milliseconds(),
1202
1762
client.approved_by_default)
1204
logger.warning(u"Client %s was not approved",
1764
logger.warning("Client %s was not approved",
1206
1766
if self.server.use_dbus:
1207
1767
# Emit D-Bus signal
1208
client.Rejected("Disapproved")
1768
client.Rejected("Denied")
1211
1771
#wait until timeout or approved
1212
#x = float(client._timedelta_to_milliseconds(delay))
1213
1772
time = datetime.datetime.now()
1214
1773
client.changedstate.acquire()
1215
client.changedstate.wait(float(client._timedelta_to_milliseconds(delay) / 1000))
1774
client.changedstate.wait(
1775
float(timedelta_to_milliseconds(delay)
1216
1777
client.changedstate.release()
1217
1778
time2 = datetime.datetime.now()
1218
1779
if (time2 - time) >= delay:
1356
1929
use_ipv6: Boolean; to use IPv6 or not
1358
1931
def __init__(self, server_address, RequestHandlerClass,
1359
interface=None, use_ipv6=True):
1932
interface=None, use_ipv6=True, socketfd=None):
1933
"""If socketfd is set, use that file descriptor instead of
1934
creating a new one with socket.socket().
1360
1936
self.interface = interface
1362
1938
self.address_family = socket.AF_INET6
1939
if socketfd is not None:
1940
# Save the file descriptor
1941
self.socketfd = socketfd
1942
# Save the original socket.socket() function
1943
self.socket_socket = socket.socket
1944
# To implement --socket, we monkey patch socket.socket.
1946
# (When socketserver.TCPServer is a new-style class, we
1947
# could make self.socket into a property instead of monkey
1948
# patching socket.socket.)
1950
# Create a one-time-only replacement for socket.socket()
1951
@functools.wraps(socket.socket)
1952
def socket_wrapper(*args, **kwargs):
1953
# Restore original function so subsequent calls are
1955
socket.socket = self.socket_socket
1956
del self.socket_socket
1957
# This time only, return a new socket object from the
1958
# saved file descriptor.
1959
return socket.fromfd(self.socketfd, *args, **kwargs)
1960
# Replace socket.socket() function with wrapper
1961
socket.socket = socket_wrapper
1962
# The socketserver.TCPServer.__init__ will call
1963
# socket.socket(), which might be our replacement,
1964
# socket_wrapper(), if socketfd was set.
1363
1965
socketserver.TCPServer.__init__(self, server_address,
1364
1966
RequestHandlerClass)
1365
1968
def server_bind(self):
1366
1969
"""This overrides the normal server_bind() function
1367
1970
to bind to an interface if one was specified, and also NOT to
1368
1971
bind to an address or port if they were not specified."""
1369
1972
if self.interface is not None:
1370
1973
if SO_BINDTODEVICE is None:
1371
logger.error(u"SO_BINDTODEVICE does not exist;"
1372
u" cannot bind to interface %s",
1974
logger.error("SO_BINDTODEVICE does not exist;"
1975
" cannot bind to interface %s",
1373
1976
self.interface)
1376
1979
self.socket.setsockopt(socket.SOL_SOCKET,
1377
1980
SO_BINDTODEVICE,
1380
except socket.error, error:
1381
if error[0] == errno.EPERM:
1382
logger.error(u"No permission to"
1383
u" bind to interface %s",
1385
elif error[0] == errno.ENOPROTOOPT:
1386
logger.error(u"SO_BINDTODEVICE not available;"
1387
u" cannot bind to interface %s",
1981
str(self.interface + '\0'))
1982
except socket.error as error:
1983
if error.errno == errno.EPERM:
1984
logger.error("No permission to bind to"
1985
" interface %s", self.interface)
1986
elif error.errno == errno.ENOPROTOOPT:
1987
logger.error("SO_BINDTODEVICE not available;"
1988
" cannot bind to interface %s",
1990
elif error.errno == errno.ENODEV:
1991
logger.error("Interface %s does not exist,"
1992
" cannot bind", self.interface)
1391
1995
# Only bind(2) the socket if we really need to.
1392
1996
if self.server_address[0] or self.server_address[1]:
1393
1997
if not self.server_address[0]:
1394
1998
if self.address_family == socket.AF_INET6:
1395
any_address = u"::" # in6addr_any
1999
any_address = "::" # in6addr_any
1397
any_address = socket.INADDR_ANY
2001
any_address = "0.0.0.0" # INADDR_ANY
1398
2002
self.server_address = (any_address,
1399
2003
self.server_address[1])
1400
2004
elif not self.server_address[1]:
1422
2026
def __init__(self, server_address, RequestHandlerClass,
1423
2027
interface=None, use_ipv6=True, clients=None,
1424
gnutls_priority=None, use_dbus=True):
2028
gnutls_priority=None, use_dbus=True, socketfd=None):
1425
2029
self.enabled = False
1426
2030
self.clients = clients
1427
2031
if self.clients is None:
1428
self.clients = set()
1429
2033
self.use_dbus = use_dbus
1430
2034
self.gnutls_priority = gnutls_priority
1431
2035
IPv6_TCPServer.__init__(self, server_address,
1432
2036
RequestHandlerClass,
1433
2037
interface = interface,
1434
use_ipv6 = use_ipv6)
2038
use_ipv6 = use_ipv6,
2039
socketfd = socketfd)
1435
2040
def server_activate(self):
1436
2041
if self.enabled:
1437
2042
return socketserver.TCPServer.server_activate(self)
1438
2044
def enable(self):
1439
2045
self.enabled = True
1440
def add_pipe(self, parent_pipe):
2047
def add_pipe(self, parent_pipe, proc):
1441
2048
# Call "handle_ipc" for both data and EOF events
1442
2049
gobject.io_add_watch(parent_pipe.fileno(),
1443
2050
gobject.IO_IN | gobject.IO_HUP,
1444
2051
functools.partial(self.handle_ipc,
1445
parent_pipe = parent_pipe))
1447
2056
def handle_ipc(self, source, condition, parent_pipe=None,
1448
client_object=None):
1450
gobject.IO_IN: u"IN", # There is data to read.
1451
gobject.IO_OUT: u"OUT", # Data can be written (without
1453
gobject.IO_PRI: u"PRI", # There is urgent data to read.
1454
gobject.IO_ERR: u"ERR", # Error condition.
1455
gobject.IO_HUP: u"HUP" # Hung up (the connection has been
1456
# broken, usually for pipes and
1459
conditions_string = ' | '.join(name
1461
condition_names.iteritems()
1462
if cond & condition)
1463
logger.debug(u"Handling IPC: FD = %d, condition = %s", source,
1466
# XXXTEDDY error or the other end of multiprocessing.Pipe has closed
1467
if condition & gobject.IO_HUP or condition & gobject.IO_ERR:
2057
proc = None, client_object=None):
2058
# error, or the other end of multiprocessing.Pipe has closed
2059
if condition & (gobject.IO_ERR | gobject.IO_HUP):
2060
# Wait for other process to exit
1470
2064
# Read a request from the child
1471
2065
request = parent_pipe.recv()
1472
logger.debug(u"IPC request: %s", repr(request))
1473
2066
command = request[0]
1475
2068
if command == 'init':
1476
2069
fpr = request[1]
1477
2070
address = request[2]
1479
for c in self.clients:
2072
for c in self.clients.itervalues():
1480
2073
if c.fingerprint == fpr:
1484
logger.warning(u"Client not found for fingerprint: %s, ad"
1485
u"dress: %s", fpr, address)
2077
logger.info("Client not found for fingerprint: %s, ad"
2078
"dress: %s", fpr, address)
1486
2079
if self.use_dbus:
1487
2080
# Emit D-Bus signal
1488
mandos_dbus_service.ClientNotFound(fpr, address)
2081
mandos_dbus_service.ClientNotFound(fpr,
1489
2083
parent_pipe.send(False)
1492
2086
gobject.io_add_watch(parent_pipe.fileno(),
1493
2087
gobject.IO_IN | gobject.IO_HUP,
1494
2088
functools.partial(self.handle_ipc,
1495
parent_pipe = parent_pipe,
1496
client_object = client))
1497
2094
parent_pipe.send(True)
1498
# remove the old hook in favor of the new above hook on same fileno
2095
# remove the old hook in favor of the new above hook on
1500
2098
if command == 'funcall':
1501
2099
funcname = request[1]
1502
2100
args = request[2]
1503
2101
kwargs = request[3]
1505
parent_pipe.send(('data', getattr(client_object, funcname)(*args, **kwargs)))
2103
parent_pipe.send(('data', getattr(client_object,
1507
2107
if command == 'getattr':
1508
2108
attrname = request[1]
1509
2109
if callable(client_object.__getattribute__(attrname)):
1510
2110
parent_pipe.send(('function',))
1512
parent_pipe.send(('data', client_object.__getattribute__(attrname)))
2112
parent_pipe.send(('data', client_object
2113
.__getattribute__(attrname)))
1514
2115
if command == 'setattr':
1515
2116
attrname = request[1]
1516
2117
value = request[2]
1517
2118
setattr(client_object, attrname, value)
2123
def rfc3339_duration_to_delta(duration):
2124
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2126
>>> rfc3339_duration_to_delta("P7D")
2127
datetime.timedelta(7)
2128
>>> rfc3339_duration_to_delta("PT60S")
2129
datetime.timedelta(0, 60)
2130
>>> rfc3339_duration_to_delta("PT60M")
2131
datetime.timedelta(0, 3600)
2132
>>> rfc3339_duration_to_delta("PT24H")
2133
datetime.timedelta(1)
2134
>>> rfc3339_duration_to_delta("P1W")
2135
datetime.timedelta(7)
2136
>>> rfc3339_duration_to_delta("PT5M30S")
2137
datetime.timedelta(0, 330)
2138
>>> rfc3339_duration_to_delta("P1DT3M20S")
2139
datetime.timedelta(1, 200)
2142
# Parsing an RFC 3339 duration with regular expressions is not
2143
# possible - there would have to be multiple places for the same
2144
# values, like seconds. The current code, while more esoteric, is
2145
# cleaner without depending on a parsing library. If Python had a
2146
# built-in library for parsing we would use it, but we'd like to
2147
# avoid excessive use of external libraries.
2149
# New type for defining tokens, syntax, and semantics all-in-one
2150
Token = collections.namedtuple("Token",
2151
("regexp", # To match token; if
2152
# "value" is not None,
2153
# must have a "group"
2155
"value", # datetime.timedelta or
2157
"followers")) # Tokens valid after
2159
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2160
# the "duration" ABNF definition in RFC 3339, Appendix A.
2161
token_end = Token(re.compile(r"$"), None, frozenset())
2162
token_second = Token(re.compile(r"(\d+)S"),
2163
datetime.timedelta(seconds=1),
2164
frozenset((token_end,)))
2165
token_minute = Token(re.compile(r"(\d+)M"),
2166
datetime.timedelta(minutes=1),
2167
frozenset((token_second, token_end)))
2168
token_hour = Token(re.compile(r"(\d+)H"),
2169
datetime.timedelta(hours=1),
2170
frozenset((token_minute, token_end)))
2171
token_time = Token(re.compile(r"T"),
2173
frozenset((token_hour, token_minute,
2175
token_day = Token(re.compile(r"(\d+)D"),
2176
datetime.timedelta(days=1),
2177
frozenset((token_time, token_end)))
2178
token_month = Token(re.compile(r"(\d+)M"),
2179
datetime.timedelta(weeks=4),
2180
frozenset((token_day, token_end)))
2181
token_year = Token(re.compile(r"(\d+)Y"),
2182
datetime.timedelta(weeks=52),
2183
frozenset((token_month, token_end)))
2184
token_week = Token(re.compile(r"(\d+)W"),
2185
datetime.timedelta(weeks=1),
2186
frozenset((token_end,)))
2187
token_duration = Token(re.compile(r"P"), None,
2188
frozenset((token_year, token_month,
2189
token_day, token_time,
2191
# Define starting values
2192
value = datetime.timedelta() # Value so far
2194
followers = frozenset(token_duration,) # Following valid tokens
2195
s = duration # String left to parse
2196
# Loop until end token is found
2197
while found_token is not token_end:
2198
# Search for any currently valid tokens
2199
for token in followers:
2200
match = token.regexp.match(s)
2201
if match is not None:
2203
if token.value is not None:
2204
# Value found, parse digits
2205
factor = int(match.group(1), 10)
2206
# Add to value so far
2207
value += factor * token.value
2208
# Strip token from string
2209
s = token.regexp.sub("", s, 1)
2212
# Set valid next tokens
2213
followers = found_token.followers
2216
# No currently valid tokens were found
2217
raise ValueError("Invalid RFC 3339 duration")
1522
2222
def string_to_delta(interval):
1523
2223
"""Parse a string and return a datetime.timedelta
1525
>>> string_to_delta(u'7d')
2225
>>> string_to_delta('7d')
1526
2226
datetime.timedelta(7)
1527
>>> string_to_delta(u'60s')
2227
>>> string_to_delta('60s')
1528
2228
datetime.timedelta(0, 60)
1529
>>> string_to_delta(u'60m')
2229
>>> string_to_delta('60m')
1530
2230
datetime.timedelta(0, 3600)
1531
>>> string_to_delta(u'24h')
2231
>>> string_to_delta('24h')
1532
2232
datetime.timedelta(1)
1533
>>> string_to_delta(u'1w')
2233
>>> string_to_delta('1w')
1534
2234
datetime.timedelta(7)
1535
>>> string_to_delta(u'5m 30s')
2235
>>> string_to_delta('5m 30s')
1536
2236
datetime.timedelta(0, 330)
2240
return rfc3339_duration_to_delta(interval)
1538
2244
timevalue = datetime.timedelta(0)
1539
2245
for s in interval.split():
1541
2247
suffix = unicode(s[-1])
1542
2248
value = int(s[:-1])
1544
2250
delta = datetime.timedelta(value)
1545
elif suffix == u"s":
1546
2252
delta = datetime.timedelta(0, value)
1547
elif suffix == u"m":
1548
2254
delta = datetime.timedelta(0, 0, 0, 0, value)
1549
elif suffix == u"h":
1550
2256
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
1551
elif suffix == u"w":
1552
2258
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
1554
raise ValueError(u"Unknown suffix %r" % suffix)
1555
except (ValueError, IndexError), e:
1556
raise ValueError(e.message)
2260
raise ValueError("Unknown suffix {0!r}"
2262
except IndexError as e:
2263
raise ValueError(*(e.args))
1557
2264
timevalue += delta
1558
2265
return timevalue
1561
def if_nametoindex(interface):
1562
"""Call the C function if_nametoindex(), or equivalent
1564
Note: This function cannot accept a unicode string."""
1565
global if_nametoindex
1567
if_nametoindex = (ctypes.cdll.LoadLibrary
1568
(ctypes.util.find_library(u"c"))
1570
except (OSError, AttributeError):
1571
logger.warning(u"Doing if_nametoindex the hard way")
1572
def if_nametoindex(interface):
1573
"Get an interface index the hard way, i.e. using fcntl()"
1574
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
1575
with contextlib.closing(socket.socket()) as s:
1576
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1577
struct.pack(str(u"16s16x"),
1579
interface_index = struct.unpack(str(u"I"),
1581
return interface_index
1582
return if_nametoindex(interface)
1585
2268
def daemon(nochdir = False, noclose = False):
1586
2269
"""See daemon(3). Standard BSD Unix function.
1612
2295
##################################################################
1613
2296
# Parsing of options, both command line and config file
1615
parser = optparse.OptionParser(version = "%%prog %s" % version)
1616
parser.add_option("-i", u"--interface", type=u"string",
1617
metavar="IF", help=u"Bind to interface IF")
1618
parser.add_option("-a", u"--address", type=u"string",
1619
help=u"Address to listen for requests on")
1620
parser.add_option("-p", u"--port", type=u"int",
1621
help=u"Port number to receive requests on")
1622
parser.add_option("--check", action=u"store_true",
1623
help=u"Run self-test")
1624
parser.add_option("--debug", action=u"store_true",
1625
help=u"Debug mode; run in foreground and log to"
1627
parser.add_option("--priority", type=u"string", help=u"GnuTLS"
1628
u" priority string (see GnuTLS documentation)")
1629
parser.add_option("--servicename", type=u"string",
1630
metavar=u"NAME", help=u"Zeroconf service name")
1631
parser.add_option("--configdir", type=u"string",
1632
default=u"/etc/mandos", metavar=u"DIR",
1633
help=u"Directory to search for configuration"
1635
parser.add_option("--no-dbus", action=u"store_false",
1636
dest=u"use_dbus", help=u"Do not provide D-Bus"
1637
u" system bus interface")
1638
parser.add_option("--no-ipv6", action=u"store_false",
1639
dest=u"use_ipv6", help=u"Do not use IPv6")
1640
options = parser.parse_args()[0]
2298
parser = argparse.ArgumentParser()
2299
parser.add_argument("-v", "--version", action="version",
2300
version = "%(prog)s {0}".format(version),
2301
help="show version number and exit")
2302
parser.add_argument("-i", "--interface", metavar="IF",
2303
help="Bind to interface IF")
2304
parser.add_argument("-a", "--address",
2305
help="Address to listen for requests on")
2306
parser.add_argument("-p", "--port", type=int,
2307
help="Port number to receive requests on")
2308
parser.add_argument("--check", action="store_true",
2309
help="Run self-test")
2310
parser.add_argument("--debug", action="store_true",
2311
help="Debug mode; run in foreground and log"
2312
" to terminal", default=None)
2313
parser.add_argument("--debuglevel", metavar="LEVEL",
2314
help="Debug level for stdout output")
2315
parser.add_argument("--priority", help="GnuTLS"
2316
" priority string (see GnuTLS documentation)")
2317
parser.add_argument("--servicename",
2318
metavar="NAME", help="Zeroconf service name")
2319
parser.add_argument("--configdir",
2320
default="/etc/mandos", metavar="DIR",
2321
help="Directory to search for configuration"
2323
parser.add_argument("--no-dbus", action="store_false",
2324
dest="use_dbus", help="Do not provide D-Bus"
2325
" system bus interface", default=None)
2326
parser.add_argument("--no-ipv6", action="store_false",
2327
dest="use_ipv6", help="Do not use IPv6",
2329
parser.add_argument("--no-restore", action="store_false",
2330
dest="restore", help="Do not restore stored"
2331
" state", default=None)
2332
parser.add_argument("--socket", type=int,
2333
help="Specify a file descriptor to a network"
2334
" socket to use instead of creating one")
2335
parser.add_argument("--statedir", metavar="DIR",
2336
help="Directory to save/restore state in")
2337
parser.add_argument("--foreground", action="store_true",
2338
help="Run in foreground", default=None)
2340
options = parser.parse_args()
1642
2342
if options.check:
2344
fail_count, test_count = doctest.testmod()
2345
sys.exit(os.EX_OK if fail_count == 0 else 1)
1647
2347
# Default values for config file for server-global settings
1648
server_defaults = { u"interface": u"",
1653
u"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1654
u"servicename": u"Mandos",
1655
u"use_dbus": u"True",
1656
u"use_ipv6": u"True",
2348
server_defaults = { "interface": "",
2353
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",
2354
"servicename": "Mandos",
2360
"statedir": "/var/lib/mandos",
2361
"foreground": "False",
1659
2364
# Parse config file for server-global settings
1660
2365
server_config = configparser.SafeConfigParser(server_defaults)
1661
2366
del server_defaults
1662
2367
server_config.read(os.path.join(options.configdir,
1664
2369
# Convert the SafeConfigParser object to a dict
1665
2370
server_settings = server_config.defaults()
1666
2371
# Use the appropriate methods on the non-string config options
1667
for option in (u"debug", u"use_dbus", u"use_ipv6"):
1668
server_settings[option] = server_config.getboolean(u"DEFAULT",
2372
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2373
server_settings[option] = server_config.getboolean("DEFAULT",
1670
2375
if server_settings["port"]:
1671
server_settings["port"] = server_config.getint(u"DEFAULT",
2376
server_settings["port"] = server_config.getint("DEFAULT",
2378
if server_settings["socket"]:
2379
server_settings["socket"] = server_config.getint("DEFAULT",
2381
# Later, stdin will, and stdout and stderr might, be dup'ed
2382
# over with an opened os.devnull. But we don't want this to
2383
# happen with a supplied network socket.
2384
if 0 <= server_settings["socket"] <= 2:
2385
server_settings["socket"] = os.dup(server_settings
1673
2387
del server_config
1675
2389
# Override the settings from the config file with command line
1676
2390
# options, if set.
1677
for option in (u"interface", u"address", u"port", u"debug",
1678
u"priority", u"servicename", u"configdir",
1679
u"use_dbus", u"use_ipv6"):
2391
for option in ("interface", "address", "port", "debug",
2392
"priority", "servicename", "configdir",
2393
"use_dbus", "use_ipv6", "debuglevel", "restore",
2394
"statedir", "socket", "foreground"):
1680
2395
value = getattr(options, option)
1681
2396
if value is not None:
1682
2397
server_settings[option] = value
1685
2400
for option in server_settings.keys():
1686
2401
if type(server_settings[option]) is str:
1687
2402
server_settings[option] = unicode(server_settings[option])
2403
# Force all boolean options to be boolean
2404
for option in ("debug", "use_dbus", "use_ipv6", "restore",
2406
server_settings[option] = bool(server_settings[option])
2407
# Debug implies foreground
2408
if server_settings["debug"]:
2409
server_settings["foreground"] = True
1688
2410
# Now we have our good server settings in "server_settings"
1690
2412
##################################################################
1692
2414
# For convenience
1693
debug = server_settings[u"debug"]
1694
use_dbus = server_settings[u"use_dbus"]
1695
use_ipv6 = server_settings[u"use_ipv6"]
1698
syslogger.setLevel(logging.WARNING)
1699
console.setLevel(logging.WARNING)
1701
if server_settings[u"servicename"] != u"Mandos":
2415
debug = server_settings["debug"]
2416
debuglevel = server_settings["debuglevel"]
2417
use_dbus = server_settings["use_dbus"]
2418
use_ipv6 = server_settings["use_ipv6"]
2419
stored_state_path = os.path.join(server_settings["statedir"],
2421
foreground = server_settings["foreground"]
2424
initlogger(debug, logging.DEBUG)
2429
level = getattr(logging, debuglevel.upper())
2430
initlogger(debug, level)
2432
if server_settings["servicename"] != "Mandos":
1702
2433
syslogger.setFormatter(logging.Formatter
1703
(u'Mandos (%s) [%%(process)d]:'
1704
u' %%(levelname)s: %%(message)s'
1705
% server_settings[u"servicename"]))
2434
('Mandos ({0}) [%(process)d]:'
2435
' %(levelname)s: %(message)s'
2436
.format(server_settings
1707
2439
# Parse config file with clients
1708
client_defaults = { u"timeout": u"1h",
1710
u"checker": u"fping -q -- %%(host)s",
1712
u"approved_delay": u"0s",
1713
u"approved_duration": u"1s",
1715
client_config = configparser.SafeConfigParser(client_defaults)
1716
client_config.read(os.path.join(server_settings[u"configdir"],
2440
client_config = configparser.SafeConfigParser(Client
2442
client_config.read(os.path.join(server_settings["configdir"],
1719
2445
global mandos_dbus_service
1720
2446
mandos_dbus_service = None
1722
tcp_server = MandosServer((server_settings[u"address"],
1723
server_settings[u"port"]),
2448
tcp_server = MandosServer((server_settings["address"],
2449
server_settings["port"]),
1725
interface=server_settings[u"interface"],
2451
interface=(server_settings["interface"]
1726
2453
use_ipv6=use_ipv6,
1727
2454
gnutls_priority=
1728
server_settings[u"priority"],
1730
pidfilename = u"/var/run/mandos.pid"
1732
pidfile = open(pidfilename, u"w")
1734
logger.error(u"Could not open file %r", pidfilename)
2455
server_settings["priority"],
2457
socketfd=(server_settings["socket"]
2460
pidfilename = "/run/mandos.pid"
2461
if not os.path.isdir("/run/."):
2462
pidfilename = "/var/run/mandos.pid"
2465
pidfile = open(pidfilename, "w")
2466
except IOError as e:
2467
logger.error("Could not open file %r", pidfilename,
1737
uid = pwd.getpwnam(u"_mandos").pw_uid
1738
gid = pwd.getpwnam(u"_mandos").pw_gid
2470
for name in ("_mandos", "mandos", "nobody"):
1741
uid = pwd.getpwnam(u"mandos").pw_uid
1742
gid = pwd.getpwnam(u"mandos").pw_gid
2472
uid = pwd.getpwnam(name).pw_uid
2473
gid = pwd.getpwnam(name).pw_gid
1743
2475
except KeyError:
1745
uid = pwd.getpwnam(u"nobody").pw_uid
1746
gid = pwd.getpwnam(u"nobody").pw_gid
1753
except OSError, error:
1754
if error[0] != errno.EPERM:
2483
except OSError as error:
2484
if error.errno != errno.EPERM:
1757
# Enable all possible GnuTLS debugging
2488
# Enable all possible GnuTLS debugging
1759
2490
# "Use a log level over 10 to enable all debugging options."
1760
2491
# - GnuTLS manual
1761
2492
gnutls.library.functions.gnutls_global_set_log_level(11)
1763
2494
@gnutls.library.types.gnutls_log_func
1764
2495
def debug_gnutls(level, string):
1765
logger.debug(u"GnuTLS: %s", string[:-1])
2496
logger.debug("GnuTLS: %s", string[:-1])
1767
2498
(gnutls.library.functions
1768
2499
.gnutls_global_set_log_function(debug_gnutls))
2501
# Redirect stdin so all checkers get /dev/null
2502
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2503
os.dup2(null, sys.stdin.fileno())
2507
# Need to fork before connecting to D-Bus
2509
# Close all input and output, do double fork, etc.
2512
# multiprocessing will use threads, so before we use gobject we
2513
# need to inform gobject that threads will be used.
2514
gobject.threads_init()
1770
2516
global main_loop
1771
2517
# From the Avahi example code
1772
DBusGMainLoop(set_as_default=True )
2518
DBusGMainLoop(set_as_default=True)
1773
2519
main_loop = gobject.MainLoop()
1774
2520
bus = dbus.SystemBus()
1775
2521
# End of Avahi example code
1778
bus_name = dbus.service.BusName(u"se.bsnet.fukt.Mandos",
2524
bus_name = dbus.service.BusName("se.recompile.Mandos",
1779
2525
bus, do_not_queue=True)
1780
except dbus.exceptions.NameExistsException, e:
1781
logger.error(unicode(e) + u", disabling D-Bus")
2526
old_bus_name = (dbus.service.BusName
2527
("se.bsnet.fukt.Mandos", bus,
2529
except dbus.exceptions.NameExistsException as e:
2530
logger.error("Disabling D-Bus:", exc_info=e)
1782
2531
use_dbus = False
1783
server_settings[u"use_dbus"] = False
2532
server_settings["use_dbus"] = False
1784
2533
tcp_server.use_dbus = False
1785
2534
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1786
service = AvahiService(name = server_settings[u"servicename"],
1787
servicetype = u"_mandos._tcp",
1788
protocol = protocol, bus = bus)
2535
service = AvahiServiceToSyslog(name =
2536
server_settings["servicename"],
2537
servicetype = "_mandos._tcp",
2538
protocol = protocol, bus = bus)
1789
2539
if server_settings["interface"]:
1790
2540
service.interface = (if_nametoindex
1791
(str(server_settings[u"interface"])))
2541
(str(server_settings["interface"])))
1793
2543
global multiprocessing_manager
1794
2544
multiprocessing_manager = multiprocessing.Manager()
1796
2546
client_class = Client
1798
2548
client_class = functools.partial(ClientDBus, bus = bus)
1799
def client_config_items(config, section):
1800
special_settings = {
1801
"approved_by_default":
1802
lambda: config.getboolean(section,
1803
"approved_by_default"),
1805
for name, value in config.items(section):
2550
client_settings = Client.config_parser(client_config)
2551
old_client_settings = {}
2554
# This is used to redirect stdout and stderr for checker processes
2556
wnull = open(os.devnull, "w") # A writable /dev/null
2557
# Only used if server is running in foreground but not in debug
2559
if debug or not foreground:
2562
# Get client data and settings from last running state.
2563
if server_settings["restore"]:
2565
with open(stored_state_path, "rb") as stored_state:
2566
clients_data, old_client_settings = (pickle.load
2568
os.remove(stored_state_path)
2569
except IOError as e:
2570
if e.errno == errno.ENOENT:
2571
logger.warning("Could not load persistent state: {0}"
2572
.format(os.strerror(e.errno)))
2574
logger.critical("Could not load persistent state:",
2577
except EOFError as e:
2578
logger.warning("Could not load persistent state: "
2579
"EOFError:", exc_info=e)
2581
with PGPEngine() as pgp:
2582
for client_name, client in clients_data.iteritems():
2583
# Skip removed clients
2584
if client_name not in client_settings:
2587
# Decide which value to use after restoring saved state.
2588
# We have three different values: Old config file,
2589
# new config file, and saved state.
2590
# New config value takes precedence if it differs from old
2591
# config value, otherwise use saved state.
2592
for name, value in client_settings[client_name].items():
2594
# For each value in new config, check if it
2595
# differs from the old config value (Except for
2596
# the "secret" attribute)
2597
if (name != "secret" and
2598
value != old_client_settings[client_name]
2600
client[name] = value
2604
# Clients who has passed its expire date can still be
2605
# enabled if its last checker was successful. Clients
2606
# whose checker succeeded before we stored its state is
2607
# assumed to have successfully run all checkers during
2609
if client["enabled"]:
2610
if datetime.datetime.utcnow() >= client["expires"]:
2611
if not client["last_checked_ok"]:
2613
"disabling client {0} - Client never "
2614
"performed a successful checker"
2615
.format(client_name))
2616
client["enabled"] = False
2617
elif client["last_checker_status"] != 0:
2619
"disabling client {0} - Client "
2620
"last checker failed with error code {1}"
2621
.format(client_name,
2622
client["last_checker_status"]))
2623
client["enabled"] = False
2625
client["expires"] = (datetime.datetime
2627
+ client["timeout"])
2628
logger.debug("Last checker succeeded,"
2629
" keeping {0} enabled"
2630
.format(client_name))
1807
yield (name, special_settings[name]())
1811
tcp_server.clients.update(set(
1812
client_class(name = section,
1813
config= dict(client_config_items(
1814
client_config, section)))
1815
for section in client_config.sections()))
2632
client["secret"] = (
2633
pgp.decrypt(client["encrypted_secret"],
2634
client_settings[client_name]
2637
# If decryption fails, we use secret from new settings
2638
logger.debug("Failed to decrypt {0} old secret"
2639
.format(client_name))
2640
client["secret"] = (
2641
client_settings[client_name]["secret"])
2643
# Add/remove clients based on new changes made to config
2644
for client_name in (set(old_client_settings)
2645
- set(client_settings)):
2646
del clients_data[client_name]
2647
for client_name in (set(client_settings)
2648
- set(old_client_settings)):
2649
clients_data[client_name] = client_settings[client_name]
2651
# Create all client objects
2652
for client_name, client in clients_data.iteritems():
2653
tcp_server.clients[client_name] = client_class(
2654
name = client_name, settings = client,
2655
server_settings = server_settings)
1816
2657
if not tcp_server.clients:
1817
logger.warning(u"No clients defined")
1820
# Redirect stdin so all checkers get /dev/null
1821
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
1822
os.dup2(null, sys.stdin.fileno())
1826
# No console logging
1827
logger.removeHandler(console)
1828
# Close all input and output, do double fork, etc.
1834
pidfile.write(str(pid) + "\n")
2658
logger.warning("No clients defined")
2661
if pidfile is not None:
2665
pidfile.write(str(pid) + "\n".encode("utf-8"))
2667
logger.error("Could not write to file %r with PID %d",
1837
logger.error(u"Could not write to file %r with PID %d",
1840
# "pidfile" was never created
1845
signal.signal(signal.SIGINT, signal.SIG_IGN)
1846
2672
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1847
2673
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
1850
class MandosDBusService(dbus.service.Object):
2676
@alternate_dbus_interfaces({"se.recompile.Mandos":
2677
"se.bsnet.fukt.Mandos"})
2678
class MandosDBusService(DBusObjectWithProperties):
1851
2679
"""A D-Bus proxy object"""
1852
2680
def __init__(self):
1853
dbus.service.Object.__init__(self, bus, u"/")
1854
_interface = u"se.bsnet.fukt.Mandos"
1856
@dbus.service.signal(_interface, signature=u"o")
2681
dbus.service.Object.__init__(self, bus, "/")
2682
_interface = "se.recompile.Mandos"
2684
@dbus_interface_annotations(_interface)
2686
return { "org.freedesktop.DBus.Property"
2687
".EmitsChangedSignal":
2690
@dbus.service.signal(_interface, signature="o")
1857
2691
def ClientAdded(self, objpath):
1861
@dbus.service.signal(_interface, signature=u"ss")
2695
@dbus.service.signal(_interface, signature="ss")
1862
2696
def ClientNotFound(self, fingerprint, address):
1866
@dbus.service.signal(_interface, signature=u"os")
2700
@dbus.service.signal(_interface, signature="os")
1867
2701
def ClientRemoved(self, objpath, name):
1871
@dbus.service.method(_interface, out_signature=u"ao")
2705
@dbus.service.method(_interface, out_signature="ao")
1872
2706
def GetAllClients(self):
1874
2708
return dbus.Array(c.dbus_object_path
1875
for c in tcp_server.clients)
2710
tcp_server.clients.itervalues())
1877
2712
@dbus.service.method(_interface,
1878
out_signature=u"a{oa{sv}}")
2713
out_signature="a{oa{sv}}")
1879
2714
def GetAllClientsWithProperties(self):
1881
2716
return dbus.Dictionary(
1882
((c.dbus_object_path, c.GetAll(u""))
1883
for c in tcp_server.clients),
1884
signature=u"oa{sv}")
2717
((c.dbus_object_path, c.GetAll(""))
2718
for c in tcp_server.clients.itervalues()),
1886
@dbus.service.method(_interface, in_signature=u"o")
2721
@dbus.service.method(_interface, in_signature="o")
1887
2722
def RemoveClient(self, object_path):
1889
for c in tcp_server.clients:
2724
for c in tcp_server.clients.itervalues():
1890
2725
if c.dbus_object_path == object_path:
1891
tcp_server.clients.remove(c)
2726
del tcp_server.clients[c.name]
1892
2727
c.remove_from_connection()
1893
2728
# Don't signal anything except ClientRemoved
1894
2729
c.disable(quiet=True)