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