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"""
118
syslogger = (logging.handlers.SysLogHandler
120
logging.handlers.SysLogHandler.LOG_DAEMON,
121
address = str("/dev/log")))
122
syslogger.setFormatter(logging.Formatter
123
('Mandos [%(process)d]: %(levelname)s:'
125
logger.addHandler(syslogger)
128
console = logging.StreamHandler()
129
console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
133
logger.addHandler(console)
134
logger.setLevel(level)
137
class PGPError(Exception):
138
"""Exception if encryption/decryption fails"""
142
class PGPEngine(object):
143
"""A simple class for OpenPGP symmetric encryption & decryption"""
145
self.tempdir = tempfile.mkdtemp(prefix="mandos-")
146
self.gnupgargs = ['--batch',
147
'--home', self.tempdir,
155
def __exit__(self, exc_type, exc_value, traceback):
163
if self.tempdir is not None:
164
# Delete contents of tempdir
165
for root, dirs, files in os.walk(self.tempdir,
167
for filename in files:
168
os.remove(os.path.join(root, filename))
170
os.rmdir(os.path.join(root, dirname))
172
os.rmdir(self.tempdir)
175
def password_encode(self, password):
176
# Passphrase can not be empty and can not contain newlines or
177
# NUL bytes. So we prefix it and hex encode it.
178
encoded = b"mandos" + binascii.hexlify(password)
179
if len(encoded) > 2048:
180
# GnuPG can't handle long passwords, so encode differently
181
encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
182
.replace(b"\n", b"\\n")
183
.replace(b"\0", b"\\x00"))
186
def encrypt(self, data, password):
187
passphrase = self.password_encode(password)
188
with tempfile.NamedTemporaryFile(dir=self.tempdir
190
passfile.write(passphrase)
192
proc = subprocess.Popen(['gpg', '--symmetric',
196
stdin = subprocess.PIPE,
197
stdout = subprocess.PIPE,
198
stderr = subprocess.PIPE)
199
ciphertext, err = proc.communicate(input = data)
200
if proc.returncode != 0:
204
def decrypt(self, data, password):
205
passphrase = self.password_encode(password)
206
with tempfile.NamedTemporaryFile(dir = self.tempdir
208
passfile.write(passphrase)
210
proc = subprocess.Popen(['gpg', '--decrypt',
214
stdin = subprocess.PIPE,
215
stdout = subprocess.PIPE,
216
stderr = subprocess.PIPE)
217
decrypted_plaintext, err = proc.communicate(input
219
if proc.returncode != 0:
221
return decrypted_plaintext
102
224
class AvahiError(Exception):
103
225
def __init__(self, value, *args, **kwargs):
192
325
dbus.UInt16(self.port),
193
326
avahi.string_array_to_txt_array(self.TXT))
194
327
self.group.Commit()
195
329
def entry_group_state_changed(self, state, error):
196
330
"""Derived from the Avahi example code"""
197
logger.debug(u"Avahi entry group state change: %i", state)
331
logger.debug("Avahi entry group state change: %i", state)
199
333
if state == avahi.ENTRY_GROUP_ESTABLISHED:
200
logger.debug(u"Zeroconf service established.")
334
logger.debug("Zeroconf service established.")
201
335
elif state == avahi.ENTRY_GROUP_COLLISION:
202
logger.warning(u"Zeroconf service name collision.")
336
logger.info("Zeroconf service name collision.")
204
338
elif state == avahi.ENTRY_GROUP_FAILURE:
205
logger.critical(u"Avahi: Error in group state changed %s",
339
logger.critical("Avahi: Error in group state changed %s",
207
raise AvahiGroupError(u"State changed: %s"
341
raise AvahiGroupError("State changed: {0!s}"
209
344
def cleanup(self):
210
345
"""Derived from the Avahi example code"""
211
346
if self.group is not None:
349
except (dbus.exceptions.UnknownMethodException,
350
dbus.exceptions.DBusException):
213
352
self.group = None
214
def server_state_changed(self, state):
355
def server_state_changed(self, state, error=None):
215
356
"""Derived from the Avahi example code"""
216
logger.debug(u"Avahi server state change: %i", state)
217
if state == avahi.SERVER_COLLISION:
218
logger.error(u"Zeroconf server name collision")
357
logger.debug("Avahi server state change: %i", state)
358
bad_states = { avahi.SERVER_INVALID:
359
"Zeroconf server invalid",
360
avahi.SERVER_REGISTERING: None,
361
avahi.SERVER_COLLISION:
362
"Zeroconf server name collision",
363
avahi.SERVER_FAILURE:
364
"Zeroconf server failure" }
365
if state in bad_states:
366
if bad_states[state] is not None:
368
logger.error(bad_states[state])
370
logger.error(bad_states[state] + ": %r", error)
220
372
elif state == avahi.SERVER_RUNNING:
376
logger.debug("Unknown state: %r", state)
378
logger.debug("Unknown state: %r: %r", state, error)
222
380
def activate(self):
223
381
"""Derived from the Avahi example code"""
224
382
if self.server is None:
225
383
self.server = dbus.Interface(
226
384
self.bus.get_object(avahi.DBUS_NAME,
227
avahi.DBUS_PATH_SERVER),
385
avahi.DBUS_PATH_SERVER,
386
follow_name_owner_changes=True),
228
387
avahi.DBUS_INTERFACE_SERVER)
229
self.server.connect_to_signal(u"StateChanged",
388
self.server.connect_to_signal("StateChanged",
230
389
self.server_state_changed)
231
390
self.server_state_changed(self.server.GetState())
393
class AvahiServiceToSyslog(AvahiService):
395
"""Add the new name to the syslog messages"""
396
ret = AvahiService.rename(self)
397
syslogger.setFormatter(logging.Formatter
398
('Mandos ({0}) [%(process)d]:'
399
' %(levelname)s: %(message)s'
404
def timedelta_to_milliseconds(td):
405
"Convert a datetime.timedelta() to milliseconds"
406
return ((td.days * 24 * 60 * 60 * 1000)
407
+ (td.seconds * 1000)
408
+ (td.microseconds // 1000))
234
411
class Client(object):
235
412
"""A representation of a client host served by this server.
238
name: string; from the config file, used in log messages and
415
approved: bool(); 'None' if not yet approved/disapproved
416
approval_delay: datetime.timedelta(); Time to wait for approval
417
approval_duration: datetime.timedelta(); Duration of one approval
418
checker: subprocess.Popen(); a running checker process used
419
to see if the client lives.
420
'None' if no process is running.
421
checker_callback_tag: a gobject event source tag, or None
422
checker_command: string; External command which is run to check
423
if client lives. %() expansions are done at
424
runtime with vars(self) as dict, so that for
425
instance %(name)s can be used in the command.
426
checker_initiator_tag: a gobject event source tag, or None
427
created: datetime.datetime(); (UTC) object creation
428
client_structure: Object describing what attributes a client has
429
and is used for storing the client at exit
430
current_checker_command: string; current running checker_command
431
disable_initiator_tag: a gobject event source tag, or None
240
433
fingerprint: string (40 or 32 hexadecimal digits); used to
241
434
uniquely identify the client
242
secret: bytestring; sent verbatim (over TLS) to client
243
435
host: string; available for use by the checker command
244
created: datetime.datetime(); (UTC) object creation
245
last_enabled: datetime.datetime(); (UTC)
436
interval: datetime.timedelta(); How often to start a new checker
437
last_approval_request: datetime.datetime(); (UTC) or None
247
438
last_checked_ok: datetime.datetime(); (UTC) or None
439
last_checker_status: integer between 0 and 255 reflecting exit
440
status of last checker. -1 reflects crashed
441
checker, -2 means no checker completed yet.
442
last_enabled: datetime.datetime(); (UTC) or None
443
name: string; from the config file, used in log messages and
445
secret: bytestring; sent verbatim (over TLS) to client
248
446
timeout: datetime.timedelta(); How long from last_checked_ok
249
447
until this client is disabled
250
interval: datetime.timedelta(); How often to start a new checker
251
disable_hook: If set, called by disable() as disable_hook(self)
252
checker: subprocess.Popen(); a running checker process used
253
to see if the client lives.
254
'None' if no process is running.
255
checker_initiator_tag: a gobject event source tag, or None
256
disable_initiator_tag: - '' -
257
checker_callback_tag: - '' -
258
checker_command: string; External command which is run to check if
259
client lives. %() expansions are done at
260
runtime with vars(self) as dict, so that for
261
instance %(name)s can be used in the command.
262
current_checker_command: string; current running checker_command
263
approved_delay: datetime.timedelta(); Time to wait for approval
264
_approved: bool(); 'None' if not yet approved/disapproved
265
approved_duration: datetime.timedelta(); Duration of one approval
448
extended_timeout: extra long timeout when secret has been sent
449
runtime_expansions: Allowed attributes for runtime expansion.
450
expires: datetime.datetime(); time (UTC) when a client will be
452
server_settings: The server_settings dict from main()
269
def _timedelta_to_milliseconds(td):
270
"Convert a datetime.timedelta() to milliseconds"
271
return ((td.days * 24 * 60 * 60 * 1000)
272
+ (td.seconds * 1000)
273
+ (td.microseconds // 1000))
455
runtime_expansions = ("approval_delay", "approval_duration",
456
"created", "enabled", "expires",
457
"fingerprint", "host", "interval",
458
"last_approval_request", "last_checked_ok",
459
"last_enabled", "name", "timeout")
460
client_defaults = { "timeout": "PT5M",
461
"extended_timeout": "PT15M",
463
"checker": "fping -q -- %%(host)s",
465
"approval_delay": "PT0S",
466
"approval_duration": "PT1S",
467
"approved_by_default": "True",
275
471
def timeout_milliseconds(self):
276
472
"Return the 'timeout' attribute in milliseconds"
277
return self._timedelta_to_milliseconds(self.timeout)
473
return timedelta_to_milliseconds(self.timeout)
475
def extended_timeout_milliseconds(self):
476
"Return the 'extended_timeout' attribute in milliseconds"
477
return timedelta_to_milliseconds(self.extended_timeout)
279
479
def interval_milliseconds(self):
280
480
"Return the 'interval' attribute in milliseconds"
281
return self._timedelta_to_milliseconds(self.interval)
283
def approved_delay_milliseconds(self):
284
return self._timedelta_to_milliseconds(self.approved_delay)
286
def __init__(self, name = None, disable_hook=None, config=None):
287
"""Note: the 'checker' key in 'config' sets the
288
'checker_command' attribute and *not* the 'checker'
481
return timedelta_to_milliseconds(self.interval)
483
def approval_delay_milliseconds(self):
484
return timedelta_to_milliseconds(self.approval_delay)
487
def config_parser(config):
488
"""Construct a new dict of client settings of this form:
489
{ client_name: {setting_name: value, ...}, ...}
490
with exceptions for any special settings as defined above.
491
NOTE: Must be a pure function. Must return the same result
492
value given the same arguments.
495
for client_name in config.sections():
496
section = dict(config.items(client_name))
497
client = settings[client_name] = {}
499
client["host"] = section["host"]
500
# Reformat values from string types to Python types
501
client["approved_by_default"] = config.getboolean(
502
client_name, "approved_by_default")
503
client["enabled"] = config.getboolean(client_name,
506
client["fingerprint"] = (section["fingerprint"].upper()
508
if "secret" in section:
509
client["secret"] = section["secret"].decode("base64")
510
elif "secfile" in section:
511
with open(os.path.expanduser(os.path.expandvars
512
(section["secfile"])),
514
client["secret"] = secfile.read()
516
raise TypeError("No secret or secfile for section {0}"
518
client["timeout"] = string_to_delta(section["timeout"])
519
client["extended_timeout"] = string_to_delta(
520
section["extended_timeout"])
521
client["interval"] = string_to_delta(section["interval"])
522
client["approval_delay"] = string_to_delta(
523
section["approval_delay"])
524
client["approval_duration"] = string_to_delta(
525
section["approval_duration"])
526
client["checker_command"] = section["checker"]
527
client["last_approval_request"] = None
528
client["last_checked_ok"] = None
529
client["last_checker_status"] = -2
533
def __init__(self, settings, name = None, server_settings=None):
293
logger.debug(u"Creating client %r", self.name)
535
if server_settings is None:
537
self.server_settings = server_settings
538
# adding all client settings
539
for setting, value in settings.iteritems():
540
setattr(self, setting, value)
543
if not hasattr(self, "last_enabled"):
544
self.last_enabled = datetime.datetime.utcnow()
545
if not hasattr(self, "expires"):
546
self.expires = (datetime.datetime.utcnow()
549
self.last_enabled = None
552
logger.debug("Creating client %r", self.name)
294
553
# Uppercase and remove spaces from fingerprint for later
295
554
# comparison purposes with return value from the fingerprint()
297
self.fingerprint = (config[u"fingerprint"].upper()
299
logger.debug(u" Fingerprint: %s", self.fingerprint)
300
if u"secret" in config:
301
self.secret = config[u"secret"].decode(u"base64")
302
elif u"secfile" in config:
303
with open(os.path.expanduser(os.path.expandvars
304
(config[u"secfile"])),
306
self.secret = secfile.read()
308
raise TypeError(u"No secret or secfile for client %s"
310
self.host = config.get(u"host", u"")
311
self.created = datetime.datetime.utcnow()
313
self.last_enabled = None
314
self.last_checked_ok = None
315
self.timeout = string_to_delta(config[u"timeout"])
316
self.interval = string_to_delta(config[u"interval"])
317
self.disable_hook = disable_hook
556
logger.debug(" Fingerprint: %s", self.fingerprint)
557
self.created = settings.get("created",
558
datetime.datetime.utcnow())
560
# attributes specific for this server instance
318
561
self.checker = None
319
562
self.checker_initiator_tag = None
320
563
self.disable_initiator_tag = None
321
564
self.checker_callback_tag = None
322
self.checker_command = config[u"checker"]
323
565
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
567
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())
568
self.changedstate = (multiprocessing_manager
569
.Condition(multiprocessing_manager
571
self.client_structure = [attr for attr in
572
self.__dict__.iterkeys()
573
if not attr.startswith("_")]
574
self.client_structure.append("client_structure")
576
for name, t in inspect.getmembers(type(self),
580
if not name.startswith("_"):
581
self.client_structure.append(name)
583
# Send notice to process children that client state has changed
335
584
def send_changedstate(self):
336
self.changedstate.acquire()
337
self.changedstate.notify_all()
338
self.changedstate.release()
585
with self.changedstate:
586
self.changedstate.notify_all()
340
588
def enable(self):
341
589
"""Start this client's checker and timeout hooks"""
342
if getattr(self, u"enabled", False):
590
if getattr(self, "enabled", False):
343
591
# Already enabled
345
self.send_changedstate()
593
self.expires = datetime.datetime.utcnow() + self.timeout
346
595
self.last_enabled = datetime.datetime.utcnow()
597
self.send_changedstate()
599
def disable(self, quiet=True):
600
"""Disable this client."""
601
if not getattr(self, "enabled", False):
604
logger.info("Disabling client %s", self.name)
605
if getattr(self, "disable_initiator_tag", None) is not None:
606
gobject.source_remove(self.disable_initiator_tag)
607
self.disable_initiator_tag = None
609
if getattr(self, "checker_initiator_tag", None) is not None:
610
gobject.source_remove(self.checker_initiator_tag)
611
self.checker_initiator_tag = None
615
self.send_changedstate()
616
# Do not run this again if called by a gobject.timeout_add
622
def init_checker(self):
347
623
# Schedule a new checker to be started an 'interval' from now,
348
624
# and every interval from then on.
625
if self.checker_initiator_tag is not None:
626
gobject.source_remove(self.checker_initiator_tag)
349
627
self.checker_initiator_tag = (gobject.timeout_add
350
628
(self.interval_milliseconds(),
351
629
self.start_checker))
352
630
# Schedule a disable() when 'timeout' has passed
631
if self.disable_initiator_tag is not None:
632
gobject.source_remove(self.disable_initiator_tag)
353
633
self.disable_initiator_tag = (gobject.timeout_add
354
634
(self.timeout_milliseconds(),
357
636
# Also start a new checker *right now*.
358
637
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
639
def checker_callback(self, pid, condition, command):
386
640
"""The checker has completed, so take appropriate actions."""
387
641
self.checker_callback_tag = None
388
642
self.checker = None
389
643
if os.WIFEXITED(condition):
390
exitstatus = os.WEXITSTATUS(condition)
392
logger.info(u"Checker for %(name)s succeeded",
644
self.last_checker_status = os.WEXITSTATUS(condition)
645
if self.last_checker_status == 0:
646
logger.info("Checker for %(name)s succeeded",
394
648
self.checked_ok()
396
logger.info(u"Checker for %(name)s failed",
650
logger.info("Checker for %(name)s failed",
399
logger.warning(u"Checker for %(name)s crashed?",
653
self.last_checker_status = -1
654
logger.warning("Checker for %(name)s crashed?",
402
657
def checked_ok(self):
403
"""Bump up the timeout for this client.
405
This should only be called when the client has been seen,
658
"""Assert that the client has been seen, alive and well."""
408
659
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(),
660
self.last_checker_status = 0
663
def bump_timeout(self, timeout=None):
664
"""Bump up the timeout for this client."""
666
timeout = self.timeout
667
if self.disable_initiator_tag is not None:
668
gobject.source_remove(self.disable_initiator_tag)
669
self.disable_initiator_tag = None
670
if getattr(self, "enabled", False):
671
self.disable_initiator_tag = (gobject.timeout_add
672
(timedelta_to_milliseconds
673
(timeout), self.disable))
674
self.expires = datetime.datetime.utcnow() + timeout
676
def need_approval(self):
677
self.last_approval_request = datetime.datetime.utcnow()
414
679
def start_checker(self):
415
680
"""Start a new checker subprocess if one is not running.
428
693
# If a checker exists, make sure it is not a zombie
430
695
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):
696
except AttributeError:
698
except OSError as error:
699
if error.errno != errno.ECHILD:
437
logger.warning(u"Checker was a zombie")
703
logger.warning("Checker was a zombie")
438
704
gobject.source_remove(self.checker_callback_tag)
439
705
self.checker_callback(pid, status,
440
706
self.current_checker_command)
441
707
# Start a new checker if needed
442
708
if self.checker is None:
709
# Escape attributes for the shell
710
escaped_attrs = dict(
711
(attr, re.escape(unicode(getattr(self, attr))))
713
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
715
command = self.checker_command % escaped_attrs
716
except TypeError as error:
717
logger.error('Could not format string "%s"',
718
self.checker_command, exc_info=error)
719
return True # Try again later
460
720
self.current_checker_command = command
462
logger.info(u"Starting checker %r for %s",
722
logger.info("Starting checker %r for %s",
463
723
command, self.name)
464
724
# We don't need to redirect stdout and stderr, since
465
725
# in normal mode, that is already done by daemon(),
466
726
# and in debug mode we don't want to. (Stdin is
467
727
# always replaced by /dev/null.)
728
# The exception is when not debugging but nevertheless
729
# running in the foreground; use the previously
732
if (not self.server_settings["debug"]
733
and self.server_settings["foreground"]):
734
popen_args.update({"stdout": wnull,
468
736
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.
740
except OSError as error:
741
logger.error("Failed to start subprocess",
744
self.checker_callback_tag = (gobject.child_watch_add
746
self.checker_callback,
748
# The checker may have completed before the gobject
749
# watch was added. Check for this.
477
751
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",
752
except OSError as error:
753
if error.errno == errno.ECHILD:
754
# This should never happen
755
logger.error("Child process vanished",
760
gobject.source_remove(self.checker_callback_tag)
761
self.checker_callback(pid, status, command)
484
762
# Re-run this periodically if run by gobject.timeout_add
554
870
class DBusObjectWithProperties(dbus.service.Object):
555
871
"""A D-Bus object with properties.
557
873
Classes inheriting from this can use the dbus_service_property
558
874
decorator to expose methods as D-Bus properties. It exposes the
559
875
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)
879
def _is_dbus_thing(thing):
880
"""Returns a function testing if an attribute is a D-Bus thing
882
If called like _is_dbus_thing("method") it returns a function
883
suitable for use as predicate to inspect.getmembers().
885
return lambda obj: getattr(obj, "_dbus_is_{0}".format(thing),
566
def _get_all_dbus_properties(self):
888
def _get_all_dbus_things(self, thing):
567
889
"""Returns a generator of (name, attribute) pairs
569
return ((prop._dbus_name, prop)
571
inspect.getmembers(self, self._is_dbus_property))
891
return ((getattr(athing.__get__(self), "_dbus_name",
893
athing.__get__(self))
894
for cls in self.__class__.__mro__
896
inspect.getmembers(cls,
897
self._is_dbus_thing(thing)))
573
899
def _get_dbus_property(self, interface_name, property_name):
574
900
"""Returns a bound method if one exists which is a D-Bus
575
901
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)):
903
for cls in self.__class__.__mro__:
904
for name, value in (inspect.getmembers
906
self._is_dbus_thing("property"))):
907
if (value._dbus_name == property_name
908
and value._dbus_interface == interface_name):
909
return value.__get__(self)
587
911
# No such property
588
raise DBusPropertyNotFound(self.dbus_object_path + u":"
589
+ interface_name + u"."
912
raise DBusPropertyNotFound(self.dbus_object_path + ":"
913
+ interface_name + "."
592
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ss",
916
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
594
918
def Get(self, interface_name, property_name):
595
919
"""Standard D-Bus property Get() method, see D-Bus standard.
597
921
prop = self._get_dbus_property(interface_name, property_name)
598
if prop._dbus_access == u"write":
922
if prop._dbus_access == "write":
599
923
raise DBusPropertyAccessException(property_name)
601
if not hasattr(value, u"variant_level"):
925
if not hasattr(value, "variant_level"):
603
927
return type(value)(value, variant_level=value.variant_level+1)
605
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ssv")
929
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
606
930
def Set(self, interface_name, property_name, value):
607
931
"""Standard D-Bus property Set() method, see D-Bus standard.
609
933
prop = self._get_dbus_property(interface_name, property_name)
610
if prop._dbus_access == u"read":
934
if prop._dbus_access == "read":
611
935
raise DBusPropertyAccessException(property_name)
612
if prop._dbus_get_args_options[u"byte_arrays"]:
936
if prop._dbus_get_args_options["byte_arrays"]:
613
937
# The byte_arrays option is not supported yet on
614
938
# signatures other than "ay".
615
if prop._dbus_signature != u"ay":
617
value = dbus.ByteArray(''.join(unichr(byte)
939
if prop._dbus_signature != "ay":
940
raise ValueError("Byte arrays not supported for non-"
941
"'ay' signature {0!r}"
942
.format(prop._dbus_signature))
943
value = dbus.ByteArray(b''.join(chr(byte)
621
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"s",
622
out_signature=u"a{sv}")
947
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
948
out_signature="a{sv}")
623
949
def GetAll(self, interface_name):
624
950
"""Standard D-Bus property GetAll() method, see D-Bus
627
953
Note: Will not include properties with access="write".
630
for name, prop in self._get_all_dbus_properties():
956
for name, prop in self._get_all_dbus_things("property"):
631
957
if (interface_name
632
958
and interface_name != prop._dbus_interface):
633
959
# Interface non-empty but did not match
635
961
# Ignore write-only properties
636
if prop._dbus_access == u"write":
962
if prop._dbus_access == "write":
639
if not hasattr(value, u"variant_level"):
965
if not hasattr(value, "variant_level"):
966
properties[name] = value
642
all[name] = type(value)(value, variant_level=
643
value.variant_level+1)
644
return dbus.Dictionary(all, signature=u"sv")
968
properties[name] = type(value)(value, variant_level=
969
value.variant_level+1)
970
return dbus.Dictionary(properties, signature="sv")
646
972
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
648
974
path_keyword='object_path',
649
975
connection_keyword='connection')
650
976
def Introspect(self, object_path, connection):
651
"""Standard D-Bus method, overloaded to insert property tags.
977
"""Overloading of standard D-Bus method.
979
Inserts property tags and interface annotation tags.
653
981
xmlstring = dbus.service.Object.Introspect(self, object_path,
656
984
document = xml.dom.minidom.parseString(xmlstring)
657
985
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)
986
e = document.createElement("property")
987
e.setAttribute("name", name)
988
e.setAttribute("type", prop._dbus_signature)
989
e.setAttribute("access", prop._dbus_access)
663
for if_tag in document.getElementsByTagName(u"interface"):
991
for if_tag in document.getElementsByTagName("interface"):
664
993
for tag in (make_tag(document, name, prop)
666
in self._get_all_dbus_properties()
995
in self._get_all_dbus_things("property")
667
996
if prop._dbus_interface
668
== if_tag.getAttribute(u"name")):
997
== if_tag.getAttribute("name")):
669
998
if_tag.appendChild(tag)
999
# Add annotation tags
1000
for typ in ("method", "signal", "property"):
1001
for tag in if_tag.getElementsByTagName(typ):
1003
for name, prop in (self.
1004
_get_all_dbus_things(typ)):
1005
if (name == tag.getAttribute("name")
1006
and prop._dbus_interface
1007
== if_tag.getAttribute("name")):
1008
annots.update(getattr
1010
"_dbus_annotations",
1012
for name, value in annots.iteritems():
1013
ann_tag = document.createElement(
1015
ann_tag.setAttribute("name", name)
1016
ann_tag.setAttribute("value", value)
1017
tag.appendChild(ann_tag)
1018
# Add interface annotation tags
1019
for annotation, value in dict(
1020
itertools.chain.from_iterable(
1021
annotations().iteritems()
1022
for name, annotations in
1023
self._get_all_dbus_things("interface")
1024
if name == if_tag.getAttribute("name")
1026
ann_tag = document.createElement("annotation")
1027
ann_tag.setAttribute("name", annotation)
1028
ann_tag.setAttribute("value", value)
1029
if_tag.appendChild(ann_tag)
670
1030
# Add the names to the return values for the
671
1031
# "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")
1032
if (if_tag.getAttribute("name")
1033
== "org.freedesktop.DBus.Properties"):
1034
for cn in if_tag.getElementsByTagName("method"):
1035
if cn.getAttribute("name") == "Get":
1036
for arg in cn.getElementsByTagName("arg"):
1037
if (arg.getAttribute("direction")
1039
arg.setAttribute("name", "value")
1040
elif cn.getAttribute("name") == "GetAll":
1041
for arg in cn.getElementsByTagName("arg"):
1042
if (arg.getAttribute("direction")
1044
arg.setAttribute("name", "props")
1045
xmlstring = document.toxml("utf-8")
686
1046
document.unlink()
687
1047
except (AttributeError, xml.dom.DOMException,
688
xml.parsers.expat.ExpatError), error:
689
logger.error(u"Failed to override Introspection method",
1048
xml.parsers.expat.ExpatError) as error:
1049
logger.error("Failed to override Introspection method",
691
1051
return xmlstring
1054
def datetime_to_dbus(dt, variant_level=0):
1055
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1057
return dbus.String("", variant_level = variant_level)
1058
return dbus.String(dt.isoformat(),
1059
variant_level=variant_level)
1062
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1063
"""A class decorator; applied to a subclass of
1064
dbus.service.Object, it will add alternate D-Bus attributes with
1065
interface names according to the "alt_interface_names" mapping.
1068
@alternate_dbus_interfaces({"org.example.Interface":
1069
"net.example.AlternateInterface"})
1070
class SampleDBusObject(dbus.service.Object):
1071
@dbus.service.method("org.example.Interface")
1072
def SampleDBusMethod():
1075
The above "SampleDBusMethod" on "SampleDBusObject" will be
1076
reachable via two interfaces: "org.example.Interface" and
1077
"net.example.AlternateInterface", the latter of which will have
1078
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1079
"true", unless "deprecate" is passed with a False value.
1081
This works for methods and signals, and also for D-Bus properties
1082
(from DBusObjectWithProperties) and interfaces (from the
1083
dbus_interface_annotations decorator).
1086
for orig_interface_name, alt_interface_name in (
1087
alt_interface_names.iteritems()):
1089
interface_names = set()
1090
# Go though all attributes of the class
1091
for attrname, attribute in inspect.getmembers(cls):
1092
# Ignore non-D-Bus attributes, and D-Bus attributes
1093
# with the wrong interface name
1094
if (not hasattr(attribute, "_dbus_interface")
1095
or not attribute._dbus_interface
1096
.startswith(orig_interface_name)):
1098
# Create an alternate D-Bus interface name based on
1100
alt_interface = (attribute._dbus_interface
1101
.replace(orig_interface_name,
1102
alt_interface_name))
1103
interface_names.add(alt_interface)
1104
# Is this a D-Bus signal?
1105
if getattr(attribute, "_dbus_is_signal", False):
1106
# Extract the original non-method undecorated
1107
# function by black magic
1108
nonmethod_func = (dict(
1109
zip(attribute.func_code.co_freevars,
1110
attribute.__closure__))["func"]
1112
# Create a new, but exactly alike, function
1113
# object, and decorate it to be a new D-Bus signal
1114
# with the alternate D-Bus interface name
1115
new_function = (dbus.service.signal
1117
attribute._dbus_signature)
1118
(types.FunctionType(
1119
nonmethod_func.func_code,
1120
nonmethod_func.func_globals,
1121
nonmethod_func.func_name,
1122
nonmethod_func.func_defaults,
1123
nonmethod_func.func_closure)))
1124
# Copy annotations, if any
1126
new_function._dbus_annotations = (
1127
dict(attribute._dbus_annotations))
1128
except AttributeError:
1130
# Define a creator of a function to call both the
1131
# original and alternate functions, so both the
1132
# original and alternate signals gets sent when
1133
# the function is called
1134
def fixscope(func1, func2):
1135
"""This function is a scope container to pass
1136
func1 and func2 to the "call_both" function
1137
outside of its arguments"""
1138
def call_both(*args, **kwargs):
1139
"""This function will emit two D-Bus
1140
signals by calling func1 and func2"""
1141
func1(*args, **kwargs)
1142
func2(*args, **kwargs)
1144
# Create the "call_both" function and add it to
1146
attr[attrname] = fixscope(attribute, new_function)
1147
# Is this a D-Bus method?
1148
elif getattr(attribute, "_dbus_is_method", False):
1149
# Create a new, but exactly alike, function
1150
# object. Decorate it to be a new D-Bus method
1151
# with the alternate D-Bus interface name. Add it
1153
attr[attrname] = (dbus.service.method
1155
attribute._dbus_in_signature,
1156
attribute._dbus_out_signature)
1158
(attribute.func_code,
1159
attribute.func_globals,
1160
attribute.func_name,
1161
attribute.func_defaults,
1162
attribute.func_closure)))
1163
# Copy annotations, if any
1165
attr[attrname]._dbus_annotations = (
1166
dict(attribute._dbus_annotations))
1167
except AttributeError:
1169
# Is this a D-Bus property?
1170
elif getattr(attribute, "_dbus_is_property", False):
1171
# Create a new, but exactly alike, function
1172
# object, and decorate it to be a new D-Bus
1173
# property with the alternate D-Bus interface
1174
# name. Add it to the class.
1175
attr[attrname] = (dbus_service_property
1177
attribute._dbus_signature,
1178
attribute._dbus_access,
1180
._dbus_get_args_options
1183
(attribute.func_code,
1184
attribute.func_globals,
1185
attribute.func_name,
1186
attribute.func_defaults,
1187
attribute.func_closure)))
1188
# Copy annotations, if any
1190
attr[attrname]._dbus_annotations = (
1191
dict(attribute._dbus_annotations))
1192
except AttributeError:
1194
# Is this a D-Bus interface?
1195
elif getattr(attribute, "_dbus_is_interface", False):
1196
# Create a new, but exactly alike, function
1197
# object. Decorate it to be a new D-Bus interface
1198
# with the alternate D-Bus interface name. Add it
1200
attr[attrname] = (dbus_interface_annotations
1203
(attribute.func_code,
1204
attribute.func_globals,
1205
attribute.func_name,
1206
attribute.func_defaults,
1207
attribute.func_closure)))
1209
# Deprecate all alternate interfaces
1210
iname="_AlternateDBusNames_interface_annotation{0}"
1211
for interface_name in interface_names:
1212
@dbus_interface_annotations(interface_name)
1214
return { "org.freedesktop.DBus.Deprecated":
1216
# Find an unused name
1217
for aname in (iname.format(i)
1218
for i in itertools.count()):
1219
if aname not in attr:
1223
# Replace the class with a new subclass of it with
1224
# methods, signals, etc. as created above.
1225
cls = type(b"{0}Alternate".format(cls.__name__),
1231
@alternate_dbus_interfaces({"se.recompile.Mandos":
1232
"se.bsnet.fukt.Mandos"})
694
1233
class ClientDBus(Client, DBusObjectWithProperties):
695
1234
"""A Client class using D-Bus
698
1237
dbus_object_path: dbus.ObjectPath
699
1238
bus: dbus.SystemBus()
1241
runtime_expansions = (Client.runtime_expansions
1242
+ ("dbus_object_path",))
701
1244
# dbus.service.Object doesn't use super(), so we can't either.
703
1246
def __init__(self, bus = None, *args, **kwargs):
704
self._approvals_pending = 0
706
1248
Client.__init__(self, *args, **kwargs)
707
1249
# Only now, when this client is initialized, can it show up on
1251
client_object_name = unicode(self.name).translate(
1252
{ord("."): ord("_"),
1253
ord("-"): ord("_")})
709
1254
self.dbus_object_path = (dbus.ObjectPath
711
+ self.name.replace(u".", u"_")))
1255
("/clients/" + client_object_name))
712
1256
DBusObjectWithProperties.__init__(self, self.bus,
713
1257
self.dbus_object_path)
715
def _get_approvals_pending(self):
716
return self._approvals_pending
717
def _set_approvals_pending(self, value):
718
old_value = self._approvals_pending
719
self._approvals_pending = value
721
if (hasattr(self, "dbus_object_path")
722
and bval is not bool(old_value)):
723
dbus_bool = dbus.Boolean(bval, variant_level=1)
724
self.PropertyChanged(dbus.String(u"approved_pending"),
727
approvals_pending = property(_get_approvals_pending,
728
_set_approvals_pending)
729
del _get_approvals_pending, _set_approvals_pending
732
def _datetime_to_dbus(dt, variant_level=0):
733
"""Convert a UTC datetime.datetime() to a D-Bus type."""
734
return dbus.String(dt.isoformat(),
735
variant_level=variant_level)
738
oldstate = getattr(self, u"enabled", False)
739
r = Client.enable(self)
740
if oldstate != self.enabled:
742
self.PropertyChanged(dbus.String(u"enabled"),
743
dbus.Boolean(True, variant_level=1))
744
self.PropertyChanged(
745
dbus.String(u"last_enabled"),
746
self._datetime_to_dbus(self.last_enabled,
750
def disable(self, quiet = False):
751
oldstate = getattr(self, u"enabled", False)
752
r = Client.disable(self, quiet=quiet)
753
if not quiet and oldstate != self.enabled:
755
self.PropertyChanged(dbus.String(u"enabled"),
756
dbus.Boolean(False, variant_level=1))
1259
def notifychangeproperty(transform_func,
1260
dbus_name, type_func=lambda x: x,
1262
""" Modify a variable so that it's a property which announces
1263
its changes to DBus.
1265
transform_fun: Function that takes a value and a variant_level
1266
and transforms it to a D-Bus type.
1267
dbus_name: D-Bus name of the variable
1268
type_func: Function that transform the value before sending it
1269
to the D-Bus. Default: no transform
1270
variant_level: D-Bus variant level. Default: 1
1272
attrname = "_{0}".format(dbus_name)
1273
def setter(self, value):
1274
if hasattr(self, "dbus_object_path"):
1275
if (not hasattr(self, attrname) or
1276
type_func(getattr(self, attrname, None))
1277
!= type_func(value)):
1278
dbus_value = transform_func(type_func(value),
1281
self.PropertyChanged(dbus.String(dbus_name),
1283
setattr(self, attrname, value)
1285
return property(lambda self: getattr(self, attrname), setter)
1287
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1288
approvals_pending = notifychangeproperty(dbus.Boolean,
1291
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1292
last_enabled = notifychangeproperty(datetime_to_dbus,
1294
checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1295
type_func = lambda checker:
1296
checker is not None)
1297
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1299
last_checker_status = notifychangeproperty(dbus.Int16,
1300
"LastCheckerStatus")
1301
last_approval_request = notifychangeproperty(
1302
datetime_to_dbus, "LastApprovalRequest")
1303
approved_by_default = notifychangeproperty(dbus.Boolean,
1304
"ApprovedByDefault")
1305
approval_delay = notifychangeproperty(dbus.UInt64,
1308
timedelta_to_milliseconds)
1309
approval_duration = notifychangeproperty(
1310
dbus.UInt64, "ApprovalDuration",
1311
type_func = timedelta_to_milliseconds)
1312
host = notifychangeproperty(dbus.String, "Host")
1313
timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1315
timedelta_to_milliseconds)
1316
extended_timeout = notifychangeproperty(
1317
dbus.UInt64, "ExtendedTimeout",
1318
type_func = timedelta_to_milliseconds)
1319
interval = notifychangeproperty(dbus.UInt64,
1322
timedelta_to_milliseconds)
1323
checker_command = notifychangeproperty(dbus.String, "Checker")
1325
del notifychangeproperty
759
1327
def __del__(self, *args, **kwargs):
761
1329
self.remove_from_connection()
762
1330
except LookupError:
764
if hasattr(DBusObjectWithProperties, u"__del__"):
1332
if hasattr(DBusObjectWithProperties, "__del__"):
765
1333
DBusObjectWithProperties.__del__(self, *args, **kwargs)
766
1334
Client.__del__(self, *args, **kwargs)
917
# approved_pending - property
918
@dbus_service_property(_interface, signature=u"b", access=u"read")
919
def approved_pending_dbus_property(self):
1464
# ApprovalPending - property
1465
@dbus_service_property(_interface, signature="b", access="read")
1466
def ApprovalPending_dbus_property(self):
920
1467
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):
1469
# ApprovedByDefault - property
1470
@dbus_service_property(_interface, signature="b",
1472
def ApprovedByDefault_dbus_property(self, value=None):
1473
if value is None: # get
1474
return dbus.Boolean(self.approved_by_default)
1475
self.approved_by_default = bool(value)
1477
# ApprovalDelay - property
1478
@dbus_service_property(_interface, signature="t",
1480
def ApprovalDelay_dbus_property(self, value=None):
1481
if value is None: # get
1482
return dbus.UInt64(self.approval_delay_milliseconds())
1483
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1485
# ApprovalDuration - property
1486
@dbus_service_property(_interface, signature="t",
1488
def ApprovalDuration_dbus_property(self, value=None):
1489
if value is None: # get
1490
return dbus.UInt64(timedelta_to_milliseconds(
1491
self.approval_duration))
1492
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1495
@dbus_service_property(_interface, signature="s", access="read")
1496
def Name_dbus_property(self):
944
1497
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):
1499
# Fingerprint - property
1500
@dbus_service_property(_interface, signature="s", access="read")
1501
def Fingerprint_dbus_property(self):
949
1502
return dbus.String(self.fingerprint)
952
@dbus_service_property(_interface, signature=u"s",
954
def host_dbus_property(self, value=None):
1505
@dbus_service_property(_interface, signature="s",
1507
def Host_dbus_property(self, value=None):
955
1508
if value is None: # get
956
1509
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):
1510
self.host = unicode(value)
1512
# Created - property
1513
@dbus_service_property(_interface, signature="s", access="read")
1514
def Created_dbus_property(self):
1515
return datetime_to_dbus(self.created)
1517
# LastEnabled - property
1518
@dbus_service_property(_interface, signature="s", access="read")
1519
def LastEnabled_dbus_property(self):
1520
return datetime_to_dbus(self.last_enabled)
1522
# Enabled - property
1523
@dbus_service_property(_interface, signature="b",
1525
def Enabled_dbus_property(self, value=None):
978
1526
if value is None: # get
979
1527
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):
1533
# LastCheckedOK - property
1534
@dbus_service_property(_interface, signature="s",
1536
def LastCheckedOK_dbus_property(self, value=None):
989
1537
if value is not None:
990
1538
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):
1540
return datetime_to_dbus(self.last_checked_ok)
1542
# LastCheckerStatus - property
1543
@dbus_service_property(_interface, signature="n",
1545
def LastCheckerStatus_dbus_property(self):
1546
return dbus.Int16(self.last_checker_status)
1548
# Expires - property
1549
@dbus_service_property(_interface, signature="s", access="read")
1550
def Expires_dbus_property(self):
1551
return datetime_to_dbus(self.expires)
1553
# LastApprovalRequest - property
1554
@dbus_service_property(_interface, signature="s", access="read")
1555
def LastApprovalRequest_dbus_property(self):
1556
return datetime_to_dbus(self.last_approval_request)
1558
# Timeout - property
1559
@dbus_service_property(_interface, signature="t",
1561
def Timeout_dbus_property(self, value=None):
1001
1562
if value is None: # get
1002
1563
return dbus.UInt64(self.timeout_milliseconds())
1564
old_timeout = self.timeout
1003
1565
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):
1566
# Reschedule disabling
1568
now = datetime.datetime.utcnow()
1569
self.expires += self.timeout - old_timeout
1570
if self.expires <= now:
1571
# The timeout has passed
1574
if (getattr(self, "disable_initiator_tag", None)
1577
gobject.source_remove(self.disable_initiator_tag)
1578
self.disable_initiator_tag = (
1579
gobject.timeout_add(
1580
timedelta_to_milliseconds(self.expires - now),
1583
# ExtendedTimeout - property
1584
@dbus_service_property(_interface, signature="t",
1586
def ExtendedTimeout_dbus_property(self, value=None):
1587
if value is None: # get
1588
return dbus.UInt64(self.extended_timeout_milliseconds())
1589
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1591
# Interval - property
1592
@dbus_service_property(_interface, signature="t",
1594
def Interval_dbus_property(self, value=None):
1029
1595
if value is None: # get
1030
1596
return dbus.UInt64(self.interval_milliseconds())
1031
1597
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:
1598
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):
1601
# Reschedule checker run
1602
gobject.source_remove(self.checker_initiator_tag)
1603
self.checker_initiator_tag = (gobject.timeout_add
1604
(value, self.start_checker))
1605
self.start_checker() # Start one now, too
1607
# Checker - property
1608
@dbus_service_property(_interface, signature="s",
1610
def Checker_dbus_property(self, value=None):
1047
1611
if value is None: # get
1048
1612
return dbus.String(self.checker_command)
1049
self.checker_command = value
1051
self.PropertyChanged(dbus.String(u"checker"),
1052
dbus.String(self.checker_command,
1613
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):
1615
# CheckerRunning - property
1616
@dbus_service_property(_interface, signature="b",
1618
def CheckerRunning_dbus_property(self, value=None):
1059
1619
if value is None: # get
1060
1620
return dbus.Boolean(self.checker is not None)
1112
1672
def handle(self):
1113
1673
with contextlib.closing(self.server.child_pipe) as child_pipe:
1114
logger.info(u"TCP connection from: %s",
1674
logger.info("TCP connection from: %s",
1115
1675
unicode(self.client_address))
1116
logger.debug(u"Pipe FD: %d",
1676
logger.debug("Pipe FD: %d",
1117
1677
self.server.child_pipe.fileno())
1119
1679
session = (gnutls.connection
1120
1680
.ClientSession(self.request,
1121
1681
gnutls.connection
1122
1682
.X509Credentials()))
1124
1684
# Note: gnutls.connection.X509Credentials is really a
1125
1685
# generic GnuTLS certificate credentials object so long as
1126
1686
# no X.509 keys are added to it. Therefore, we can use it
1127
1687
# 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",
1689
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1690
# "+AES-256-CBC", "+SHA1",
1691
# "+COMP-NULL", "+CTYPE-OPENPGP",
1133
1693
# Use a fallback default, since this MUST be set.
1134
1694
priority = self.server.gnutls_priority
1135
1695
if priority is None:
1136
priority = u"NORMAL"
1137
1697
(gnutls.library.functions
1138
1698
.gnutls_priority_set_direct(session._c_object,
1139
1699
priority, None))
1141
1701
# Start communication using the Mandos protocol
1142
1702
# Get protocol number
1143
1703
line = self.request.makefile().readline()
1144
logger.debug(u"Protocol version: %r", line)
1704
logger.debug("Protocol version: %r", line)
1146
1706
if int(line.strip().split()[0]) > 1:
1148
except (ValueError, IndexError, RuntimeError), error:
1149
logger.error(u"Unknown protocol version: %s", error)
1707
raise RuntimeError(line)
1708
except (ValueError, IndexError, RuntimeError) as error:
1709
logger.error("Unknown protocol version: %s", error)
1152
1712
# Start GnuTLS connection
1154
1714
session.handshake()
1155
except gnutls.errors.GNUTLSError, error:
1156
logger.warning(u"Handshake failed: %s", error)
1715
except gnutls.errors.GNUTLSError as error:
1716
logger.warning("Handshake failed: %s", error)
1157
1717
# Do not run session.bye() here: the session is not
1158
1718
# established. Just abandon the request.
1160
logger.debug(u"Handshake succeeded")
1720
logger.debug("Handshake succeeded")
1162
1722
approval_required = False
1165
1725
fpr = self.fingerprint(self.peer_certificate
1167
except (TypeError, gnutls.errors.GNUTLSError), error:
1168
logger.warning(u"Bad certificate: %s", error)
1728
gnutls.errors.GNUTLSError) as error:
1729
logger.warning("Bad certificate: %s", error)
1170
logger.debug(u"Fingerprint: %s", fpr)
1731
logger.debug("Fingerprint: %s", fpr)
1173
1734
client = ProxyClient(child_pipe, fpr,
1174
1735
self.client_address)
1175
1736
except KeyError:
1178
if client.approved_delay:
1179
delay = client.approved_delay
1739
if client.approval_delay:
1740
delay = client.approval_delay
1180
1741
client.approvals_pending += 1
1181
1742
approval_required = True
1184
1745
if not client.enabled:
1185
logger.warning(u"Client %s is disabled",
1746
logger.info("Client %s is disabled",
1187
1748
if self.server.use_dbus:
1188
1749
# Emit D-Bus signal
1189
client.Rejected("Disabled")
1750
client.Rejected("Disabled")
1192
if client._approved or not client.approved_delay:
1753
if client.approved or not client.approval_delay:
1193
1754
#We are approved or approval is disabled
1195
elif client._approved is None:
1196
logger.info(u"Client %s need approval",
1756
elif client.approved is None:
1757
logger.info("Client %s needs approval",
1198
1759
if self.server.use_dbus:
1199
1760
# Emit D-Bus signal
1200
1761
client.NeedApproval(
1201
client.approved_delay_milliseconds(),
1762
client.approval_delay_milliseconds(),
1202
1763
client.approved_by_default)
1204
logger.warning(u"Client %s was not approved",
1765
logger.warning("Client %s was not approved",
1206
1767
if self.server.use_dbus:
1207
1768
# Emit D-Bus signal
1208
client.Rejected("Disapproved")
1769
client.Rejected("Denied")
1211
1772
#wait until timeout or approved
1212
#x = float(client._timedelta_to_milliseconds(delay))
1213
1773
time = datetime.datetime.now()
1214
1774
client.changedstate.acquire()
1215
client.changedstate.wait(float(client._timedelta_to_milliseconds(delay) / 1000))
1775
client.changedstate.wait(
1776
float(timedelta_to_milliseconds(delay)
1216
1778
client.changedstate.release()
1217
1779
time2 = datetime.datetime.now()
1218
1780
if (time2 - time) >= delay:
1362
1930
use_ipv6: Boolean; to use IPv6 or not
1364
1932
def __init__(self, server_address, RequestHandlerClass,
1365
interface=None, use_ipv6=True):
1933
interface=None, use_ipv6=True, socketfd=None):
1934
"""If socketfd is set, use that file descriptor instead of
1935
creating a new one with socket.socket().
1366
1937
self.interface = interface
1368
1939
self.address_family = socket.AF_INET6
1940
if socketfd is not None:
1941
# Save the file descriptor
1942
self.socketfd = socketfd
1943
# Save the original socket.socket() function
1944
self.socket_socket = socket.socket
1945
# To implement --socket, we monkey patch socket.socket.
1947
# (When socketserver.TCPServer is a new-style class, we
1948
# could make self.socket into a property instead of monkey
1949
# patching socket.socket.)
1951
# Create a one-time-only replacement for socket.socket()
1952
@functools.wraps(socket.socket)
1953
def socket_wrapper(*args, **kwargs):
1954
# Restore original function so subsequent calls are
1956
socket.socket = self.socket_socket
1957
del self.socket_socket
1958
# This time only, return a new socket object from the
1959
# saved file descriptor.
1960
return socket.fromfd(self.socketfd, *args, **kwargs)
1961
# Replace socket.socket() function with wrapper
1962
socket.socket = socket_wrapper
1963
# The socketserver.TCPServer.__init__ will call
1964
# socket.socket(), which might be our replacement,
1965
# socket_wrapper(), if socketfd was set.
1369
1966
socketserver.TCPServer.__init__(self, server_address,
1370
1967
RequestHandlerClass)
1371
1969
def server_bind(self):
1372
1970
"""This overrides the normal server_bind() function
1373
1971
to bind to an interface if one was specified, and also NOT to
1374
1972
bind to an address or port if they were not specified."""
1375
1973
if self.interface is not None:
1376
1974
if SO_BINDTODEVICE is None:
1377
logger.error(u"SO_BINDTODEVICE does not exist;"
1378
u" cannot bind to interface %s",
1975
logger.error("SO_BINDTODEVICE does not exist;"
1976
" cannot bind to interface %s",
1379
1977
self.interface)
1382
1980
self.socket.setsockopt(socket.SOL_SOCKET,
1383
1981
SO_BINDTODEVICE,
1386
except socket.error, error:
1387
if error[0] == errno.EPERM:
1388
logger.error(u"No permission to"
1389
u" bind to interface %s",
1391
elif error[0] == errno.ENOPROTOOPT:
1392
logger.error(u"SO_BINDTODEVICE not available;"
1393
u" cannot bind to interface %s",
1982
str(self.interface + '\0'))
1983
except socket.error as error:
1984
if error.errno == errno.EPERM:
1985
logger.error("No permission to bind to"
1986
" interface %s", self.interface)
1987
elif error.errno == errno.ENOPROTOOPT:
1988
logger.error("SO_BINDTODEVICE not available;"
1989
" cannot bind to interface %s",
1991
elif error.errno == errno.ENODEV:
1992
logger.error("Interface %s does not exist,"
1993
" cannot bind", self.interface)
1397
1996
# Only bind(2) the socket if we really need to.
1398
1997
if self.server_address[0] or self.server_address[1]:
1399
1998
if not self.server_address[0]:
1400
1999
if self.address_family == socket.AF_INET6:
1401
any_address = u"::" # in6addr_any
2000
any_address = "::" # in6addr_any
1403
any_address = socket.INADDR_ANY
2002
any_address = "0.0.0.0" # INADDR_ANY
1404
2003
self.server_address = (any_address,
1405
2004
self.server_address[1])
1406
2005
elif not self.server_address[1]:
1428
2027
def __init__(self, server_address, RequestHandlerClass,
1429
2028
interface=None, use_ipv6=True, clients=None,
1430
gnutls_priority=None, use_dbus=True):
2029
gnutls_priority=None, use_dbus=True, socketfd=None):
1431
2030
self.enabled = False
1432
2031
self.clients = clients
1433
2032
if self.clients is None:
1434
self.clients = set()
1435
2034
self.use_dbus = use_dbus
1436
2035
self.gnutls_priority = gnutls_priority
1437
2036
IPv6_TCPServer.__init__(self, server_address,
1438
2037
RequestHandlerClass,
1439
2038
interface = interface,
1440
use_ipv6 = use_ipv6)
2039
use_ipv6 = use_ipv6,
2040
socketfd = socketfd)
1441
2041
def server_activate(self):
1442
2042
if self.enabled:
1443
2043
return socketserver.TCPServer.server_activate(self)
1444
2045
def enable(self):
1445
2046
self.enabled = True
1446
def add_pipe(self, parent_pipe):
2048
def add_pipe(self, parent_pipe, proc):
1447
2049
# Call "handle_ipc" for both data and EOF events
1448
2050
gobject.io_add_watch(parent_pipe.fileno(),
1449
2051
gobject.IO_IN | gobject.IO_HUP,
1450
2052
functools.partial(self.handle_ipc,
1451
parent_pipe = parent_pipe))
1453
2057
def handle_ipc(self, source, condition, parent_pipe=None,
1454
client_object=None):
1456
gobject.IO_IN: u"IN", # There is data to read.
1457
gobject.IO_OUT: u"OUT", # Data can be written (without
1459
gobject.IO_PRI: u"PRI", # There is urgent data to read.
1460
gobject.IO_ERR: u"ERR", # Error condition.
1461
gobject.IO_HUP: u"HUP" # Hung up (the connection has been
1462
# broken, usually for pipes and
1465
conditions_string = ' | '.join(name
1467
condition_names.iteritems()
1468
if cond & condition)
1469
logger.debug(u"Handling IPC: FD = %d, condition = %s", source,
1472
# error or the other end of multiprocessing.Pipe has closed
1473
if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
2058
proc = None, client_object=None):
2059
# error, or the other end of multiprocessing.Pipe has closed
2060
if condition & (gobject.IO_ERR | gobject.IO_HUP):
2061
# Wait for other process to exit
1476
2065
# Read a request from the child
1477
2066
request = parent_pipe.recv()
1478
logger.debug(u"IPC request: %s", repr(request))
1479
2067
command = request[0]
1481
2069
if command == 'init':
1482
2070
fpr = request[1]
1483
2071
address = request[2]
1485
for c in self.clients:
2073
for c in self.clients.itervalues():
1486
2074
if c.fingerprint == fpr:
1490
logger.warning(u"Client not found for fingerprint: %s, ad"
1491
u"dress: %s", fpr, address)
2078
logger.info("Client not found for fingerprint: %s, ad"
2079
"dress: %s", fpr, address)
1492
2080
if self.use_dbus:
1493
2081
# Emit D-Bus signal
1494
mandos_dbus_service.ClientNotFound(fpr, address)
2082
mandos_dbus_service.ClientNotFound(fpr,
1495
2084
parent_pipe.send(False)
1498
2087
gobject.io_add_watch(parent_pipe.fileno(),
1499
2088
gobject.IO_IN | gobject.IO_HUP,
1500
2089
functools.partial(self.handle_ipc,
1501
parent_pipe = parent_pipe,
1502
client_object = client))
1503
2095
parent_pipe.send(True)
1504
# remove the old hook in favor of the new above hook on same fileno
2096
# remove the old hook in favor of the new above hook on
1506
2099
if command == 'funcall':
1507
2100
funcname = request[1]
1508
2101
args = request[2]
1509
2102
kwargs = request[3]
1511
parent_pipe.send(('data', getattr(client_object, funcname)(*args, **kwargs)))
2104
parent_pipe.send(('data', getattr(client_object,
1513
2108
if command == 'getattr':
1514
2109
attrname = request[1]
1515
2110
if callable(client_object.__getattribute__(attrname)):
1516
2111
parent_pipe.send(('function',))
1518
parent_pipe.send(('data', client_object.__getattribute__(attrname)))
2113
parent_pipe.send(('data', client_object
2114
.__getattribute__(attrname)))
1520
2116
if command == 'setattr':
1521
2117
attrname = request[1]
1522
2118
value = request[2]
1523
2119
setattr(client_object, attrname, value)
2124
def rfc3339_duration_to_delta(duration):
2125
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2127
>>> rfc3339_duration_to_delta("P7D")
2128
datetime.timedelta(7)
2129
>>> rfc3339_duration_to_delta("PT60S")
2130
datetime.timedelta(0, 60)
2131
>>> rfc3339_duration_to_delta("PT60M")
2132
datetime.timedelta(0, 3600)
2133
>>> rfc3339_duration_to_delta("PT24H")
2134
datetime.timedelta(1)
2135
>>> rfc3339_duration_to_delta("P1W")
2136
datetime.timedelta(7)
2137
>>> rfc3339_duration_to_delta("PT5M30S")
2138
datetime.timedelta(0, 330)
2139
>>> rfc3339_duration_to_delta("P1DT3M20S")
2140
datetime.timedelta(1, 200)
2143
# Parsing an RFC 3339 duration with regular expressions is not
2144
# possible - there would have to be multiple places for the same
2145
# values, like seconds. The current code, while more esoteric, is
2146
# cleaner without depending on a parsing library. If Python had a
2147
# built-in library for parsing we would use it, but we'd like to
2148
# avoid excessive use of external libraries.
2150
# New type for defining tokens, syntax, and semantics all-in-one
2151
Token = collections.namedtuple("Token",
2152
("regexp", # To match token; if
2153
# "value" is not None,
2154
# must have a "group"
2156
"value", # datetime.timedelta or
2158
"followers")) # Tokens valid after
2160
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2161
# the "duration" ABNF definition in RFC 3339, Appendix A.
2162
token_end = Token(re.compile(r"$"), None, frozenset())
2163
token_second = Token(re.compile(r"(\d+)S"),
2164
datetime.timedelta(seconds=1),
2165
frozenset((token_end,)))
2166
token_minute = Token(re.compile(r"(\d+)M"),
2167
datetime.timedelta(minutes=1),
2168
frozenset((token_second, token_end)))
2169
token_hour = Token(re.compile(r"(\d+)H"),
2170
datetime.timedelta(hours=1),
2171
frozenset((token_minute, token_end)))
2172
token_time = Token(re.compile(r"T"),
2174
frozenset((token_hour, token_minute,
2176
token_day = Token(re.compile(r"(\d+)D"),
2177
datetime.timedelta(days=1),
2178
frozenset((token_time, token_end)))
2179
token_month = Token(re.compile(r"(\d+)M"),
2180
datetime.timedelta(weeks=4),
2181
frozenset((token_day, token_end)))
2182
token_year = Token(re.compile(r"(\d+)Y"),
2183
datetime.timedelta(weeks=52),
2184
frozenset((token_month, token_end)))
2185
token_week = Token(re.compile(r"(\d+)W"),
2186
datetime.timedelta(weeks=1),
2187
frozenset((token_end,)))
2188
token_duration = Token(re.compile(r"P"), None,
2189
frozenset((token_year, token_month,
2190
token_day, token_time,
2192
# Define starting values
2193
value = datetime.timedelta() # Value so far
2195
followers = frozenset(token_duration,) # Following valid tokens
2196
s = duration # String left to parse
2197
# Loop until end token is found
2198
while found_token is not token_end:
2199
# Search for any currently valid tokens
2200
for token in followers:
2201
match = token.regexp.match(s)
2202
if match is not None:
2204
if token.value is not None:
2205
# Value found, parse digits
2206
factor = int(match.group(1), 10)
2207
# Add to value so far
2208
value += factor * token.value
2209
# Strip token from string
2210
s = token.regexp.sub("", s, 1)
2213
# Set valid next tokens
2214
followers = found_token.followers
2217
# No currently valid tokens were found
2218
raise ValueError("Invalid RFC 3339 duration")
1528
2223
def string_to_delta(interval):
1529
2224
"""Parse a string and return a datetime.timedelta
1531
>>> string_to_delta(u'7d')
2226
>>> string_to_delta('7d')
1532
2227
datetime.timedelta(7)
1533
>>> string_to_delta(u'60s')
2228
>>> string_to_delta('60s')
1534
2229
datetime.timedelta(0, 60)
1535
>>> string_to_delta(u'60m')
2230
>>> string_to_delta('60m')
1536
2231
datetime.timedelta(0, 3600)
1537
>>> string_to_delta(u'24h')
2232
>>> string_to_delta('24h')
1538
2233
datetime.timedelta(1)
1539
>>> string_to_delta(u'1w')
2234
>>> string_to_delta('1w')
1540
2235
datetime.timedelta(7)
1541
>>> string_to_delta(u'5m 30s')
2236
>>> string_to_delta('5m 30s')
1542
2237
datetime.timedelta(0, 330)
2241
return rfc3339_duration_to_delta(interval)
1544
2245
timevalue = datetime.timedelta(0)
1545
2246
for s in interval.split():
1547
2248
suffix = unicode(s[-1])
1548
2249
value = int(s[:-1])
1550
2251
delta = datetime.timedelta(value)
1551
elif suffix == u"s":
1552
2253
delta = datetime.timedelta(0, value)
1553
elif suffix == u"m":
1554
2255
delta = datetime.timedelta(0, 0, 0, 0, value)
1555
elif suffix == u"h":
1556
2257
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
1557
elif suffix == u"w":
1558
2259
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
1560
raise ValueError(u"Unknown suffix %r" % suffix)
1561
except (ValueError, IndexError), e:
1562
raise ValueError(e.message)
2261
raise ValueError("Unknown suffix {0!r}"
2263
except IndexError as e:
2264
raise ValueError(*(e.args))
1563
2265
timevalue += delta
1564
2266
return timevalue
1567
def if_nametoindex(interface):
1568
"""Call the C function if_nametoindex(), or equivalent
1570
Note: This function cannot accept a unicode string."""
1571
global if_nametoindex
1573
if_nametoindex = (ctypes.cdll.LoadLibrary
1574
(ctypes.util.find_library(u"c"))
1576
except (OSError, AttributeError):
1577
logger.warning(u"Doing if_nametoindex the hard way")
1578
def if_nametoindex(interface):
1579
"Get an interface index the hard way, i.e. using fcntl()"
1580
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
1581
with contextlib.closing(socket.socket()) as s:
1582
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1583
struct.pack(str(u"16s16x"),
1585
interface_index = struct.unpack(str(u"I"),
1587
return interface_index
1588
return if_nametoindex(interface)
1591
2269
def daemon(nochdir = False, noclose = False):
1592
2270
"""See daemon(3). Standard BSD Unix function.
1618
2296
##################################################################
1619
2297
# Parsing of options, both command line and config file
1621
parser = optparse.OptionParser(version = "%%prog %s" % version)
1622
parser.add_option("-i", u"--interface", type=u"string",
1623
metavar="IF", help=u"Bind to interface IF")
1624
parser.add_option("-a", u"--address", type=u"string",
1625
help=u"Address to listen for requests on")
1626
parser.add_option("-p", u"--port", type=u"int",
1627
help=u"Port number to receive requests on")
1628
parser.add_option("--check", action=u"store_true",
1629
help=u"Run self-test")
1630
parser.add_option("--debug", action=u"store_true",
1631
help=u"Debug mode; run in foreground and log to"
1633
parser.add_option("--debuglevel", type=u"string", metavar="Level",
1634
help=u"Debug level for stdout output")
1635
parser.add_option("--priority", type=u"string", help=u"GnuTLS"
1636
u" priority string (see GnuTLS documentation)")
1637
parser.add_option("--servicename", type=u"string",
1638
metavar=u"NAME", help=u"Zeroconf service name")
1639
parser.add_option("--configdir", type=u"string",
1640
default=u"/etc/mandos", metavar=u"DIR",
1641
help=u"Directory to search for configuration"
1643
parser.add_option("--no-dbus", action=u"store_false",
1644
dest=u"use_dbus", help=u"Do not provide D-Bus"
1645
u" system bus interface")
1646
parser.add_option("--no-ipv6", action=u"store_false",
1647
dest=u"use_ipv6", help=u"Do not use IPv6")
1648
options = parser.parse_args()[0]
2299
parser = argparse.ArgumentParser()
2300
parser.add_argument("-v", "--version", action="version",
2301
version = "%(prog)s {0}".format(version),
2302
help="show version number and exit")
2303
parser.add_argument("-i", "--interface", metavar="IF",
2304
help="Bind to interface IF")
2305
parser.add_argument("-a", "--address",
2306
help="Address to listen for requests on")
2307
parser.add_argument("-p", "--port", type=int,
2308
help="Port number to receive requests on")
2309
parser.add_argument("--check", action="store_true",
2310
help="Run self-test")
2311
parser.add_argument("--debug", action="store_true",
2312
help="Debug mode; run in foreground and log"
2313
" to terminal", default=None)
2314
parser.add_argument("--debuglevel", metavar="LEVEL",
2315
help="Debug level for stdout output")
2316
parser.add_argument("--priority", help="GnuTLS"
2317
" priority string (see GnuTLS documentation)")
2318
parser.add_argument("--servicename",
2319
metavar="NAME", help="Zeroconf service name")
2320
parser.add_argument("--configdir",
2321
default="/etc/mandos", metavar="DIR",
2322
help="Directory to search for configuration"
2324
parser.add_argument("--no-dbus", action="store_false",
2325
dest="use_dbus", help="Do not provide D-Bus"
2326
" system bus interface", default=None)
2327
parser.add_argument("--no-ipv6", action="store_false",
2328
dest="use_ipv6", help="Do not use IPv6",
2330
parser.add_argument("--no-restore", action="store_false",
2331
dest="restore", help="Do not restore stored"
2332
" state", default=None)
2333
parser.add_argument("--socket", type=int,
2334
help="Specify a file descriptor to a network"
2335
" socket to use instead of creating one")
2336
parser.add_argument("--statedir", metavar="DIR",
2337
help="Directory to save/restore state in")
2338
parser.add_argument("--foreground", action="store_true",
2339
help="Run in foreground", default=None)
2340
parser.add_argument("--no-zeroconf", action="store_false",
2341
dest="zeroconf", help="Do not use Zeroconf",
2344
options = parser.parse_args()
1650
2346
if options.check:
2348
fail_count, test_count = doctest.testmod()
2349
sys.exit(os.EX_OK if fail_count == 0 else 1)
1655
2351
# Default values for config file for server-global settings
1656
server_defaults = { u"interface": u"",
1661
u"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1662
u"servicename": u"Mandos",
1663
u"use_dbus": u"True",
1664
u"use_ipv6": u"True",
2352
server_defaults = { "interface": "",
2357
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",
2358
"servicename": "Mandos",
2364
"statedir": "/var/lib/mandos",
2365
"foreground": "False",
1668
2369
# Parse config file for server-global settings
1669
2370
server_config = configparser.SafeConfigParser(server_defaults)
1670
2371
del server_defaults
1671
2372
server_config.read(os.path.join(options.configdir,
1673
2374
# Convert the SafeConfigParser object to a dict
1674
2375
server_settings = server_config.defaults()
1675
2376
# Use the appropriate methods on the non-string config options
1676
for option in (u"debug", u"use_dbus", u"use_ipv6"):
1677
server_settings[option] = server_config.getboolean(u"DEFAULT",
2377
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2378
server_settings[option] = server_config.getboolean("DEFAULT",
1679
2380
if server_settings["port"]:
1680
server_settings["port"] = server_config.getint(u"DEFAULT",
2381
server_settings["port"] = server_config.getint("DEFAULT",
2383
if server_settings["socket"]:
2384
server_settings["socket"] = server_config.getint("DEFAULT",
2386
# Later, stdin will, and stdout and stderr might, be dup'ed
2387
# over with an opened os.devnull. But we don't want this to
2388
# happen with a supplied network socket.
2389
if 0 <= server_settings["socket"] <= 2:
2390
server_settings["socket"] = os.dup(server_settings
1682
2392
del server_config
1684
2394
# Override the settings from the config file with command line
1685
2395
# options, if set.
1686
for option in (u"interface", u"address", u"port", u"debug",
1687
u"priority", u"servicename", u"configdir",
1688
u"use_dbus", u"use_ipv6", u"debuglevel"):
2396
for option in ("interface", "address", "port", "debug",
2397
"priority", "servicename", "configdir",
2398
"use_dbus", "use_ipv6", "debuglevel", "restore",
2399
"statedir", "socket", "foreground", "zeroconf"):
1689
2400
value = getattr(options, option)
1690
2401
if value is not None:
1691
2402
server_settings[option] = value
1694
2405
for option in server_settings.keys():
1695
2406
if type(server_settings[option]) is str:
1696
2407
server_settings[option] = unicode(server_settings[option])
2408
# Force all boolean options to be boolean
2409
for option in ("debug", "use_dbus", "use_ipv6", "restore",
2410
"foreground", "zeroconf"):
2411
server_settings[option] = bool(server_settings[option])
2412
# Debug implies foreground
2413
if server_settings["debug"]:
2414
server_settings["foreground"] = True
1697
2415
# Now we have our good server settings in "server_settings"
1699
2417
##################################################################
2419
if (not server_settings["zeroconf"] and
2420
not (server_settings["port"]
2421
or server_settings["socket"] != "")):
2422
parser.error("Needs port or socket to work without"
1701
2425
# For convenience
1702
debug = server_settings[u"debug"]
1703
debuglevel = server_settings[u"debuglevel"]
1704
use_dbus = server_settings[u"use_dbus"]
1705
use_ipv6 = server_settings[u"use_ipv6"]
1707
if server_settings[u"servicename"] != u"Mandos":
2426
debug = server_settings["debug"]
2427
debuglevel = server_settings["debuglevel"]
2428
use_dbus = server_settings["use_dbus"]
2429
use_ipv6 = server_settings["use_ipv6"]
2430
stored_state_path = os.path.join(server_settings["statedir"],
2432
foreground = server_settings["foreground"]
2433
zeroconf = server_settings["zeroconf"]
2436
initlogger(debug, logging.DEBUG)
2441
level = getattr(logging, debuglevel.upper())
2442
initlogger(debug, level)
2444
if server_settings["servicename"] != "Mandos":
1708
2445
syslogger.setFormatter(logging.Formatter
1709
(u'Mandos (%s) [%%(process)d]:'
1710
u' %%(levelname)s: %%(message)s'
1711
% server_settings[u"servicename"]))
2446
('Mandos ({0}) [%(process)d]:'
2447
' %(levelname)s: %(message)s'
2448
.format(server_settings
1713
2451
# Parse config file with clients
1714
client_defaults = { u"timeout": u"1h",
1716
u"checker": u"fping -q -- %%(host)s",
1718
u"approved_delay": u"0s",
1719
u"approved_duration": u"1s",
1721
client_config = configparser.SafeConfigParser(client_defaults)
1722
client_config.read(os.path.join(server_settings[u"configdir"],
2452
client_config = configparser.SafeConfigParser(Client
2454
client_config.read(os.path.join(server_settings["configdir"],
1725
2457
global mandos_dbus_service
1726
2458
mandos_dbus_service = None
1728
tcp_server = MandosServer((server_settings[u"address"],
1729
server_settings[u"port"]),
2461
if server_settings["socket"] != "":
2462
socketfd = server_settings["socket"]
2463
tcp_server = MandosServer((server_settings["address"],
2464
server_settings["port"]),
1731
interface=server_settings[u"interface"],
2466
interface=(server_settings["interface"]
1732
2468
use_ipv6=use_ipv6,
1733
2469
gnutls_priority=
1734
server_settings[u"priority"],
1736
pidfilename = u"/var/run/mandos.pid"
1738
pidfile = open(pidfilename, u"w")
1740
logger.error(u"Could not open file %r", pidfilename)
2470
server_settings["priority"],
2474
pidfilename = "/run/mandos.pid"
2475
if not os.path.isdir("/run/."):
2476
pidfilename = "/var/run/mandos.pid"
2479
pidfile = open(pidfilename, "w")
2480
except IOError as e:
2481
logger.error("Could not open file %r", pidfilename,
1743
uid = pwd.getpwnam(u"_mandos").pw_uid
1744
gid = pwd.getpwnam(u"_mandos").pw_gid
2484
for name in ("_mandos", "mandos", "nobody"):
1747
uid = pwd.getpwnam(u"mandos").pw_uid
1748
gid = pwd.getpwnam(u"mandos").pw_gid
2486
uid = pwd.getpwnam(name).pw_uid
2487
gid = pwd.getpwnam(name).pw_gid
1749
2489
except KeyError:
1751
uid = pwd.getpwnam(u"nobody").pw_uid
1752
gid = pwd.getpwnam(u"nobody").pw_gid
1759
except OSError, error:
1760
if error[0] != errno.EPERM:
2497
except OSError as error:
2498
if error.errno != errno.EPERM:
1763
# Enable all possible GnuTLS debugging
1766
if not debug and not debuglevel:
1767
syslogger.setLevel(logging.WARNING)
1768
console.setLevel(logging.WARNING)
1770
level = getattr(logging, debuglevel.upper())
1771
syslogger.setLevel(level)
1772
console.setLevel(level)
2502
# Enable all possible GnuTLS debugging
1775
2504
# "Use a log level over 10 to enable all debugging options."
1776
2505
# - GnuTLS manual
1777
2506
gnutls.library.functions.gnutls_global_set_log_level(11)
1779
2508
@gnutls.library.types.gnutls_log_func
1780
2509
def debug_gnutls(level, string):
1781
logger.debug(u"GnuTLS: %s", string[:-1])
2510
logger.debug("GnuTLS: %s", string[:-1])
1783
2512
(gnutls.library.functions
1784
2513
.gnutls_global_set_log_function(debug_gnutls))
1786
2515
# Redirect stdin so all checkers get /dev/null
1787
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2516
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1788
2517
os.dup2(null, sys.stdin.fileno())
1792
# No console logging
1793
logger.removeHandler(console)
2521
# Need to fork before connecting to D-Bus
2523
# Close all input and output, do double fork, etc.
2526
# multiprocessing will use threads, so before we use gobject we
2527
# need to inform gobject that threads will be used.
2528
gobject.threads_init()
1796
2530
global main_loop
1797
2531
# From the Avahi example code
1798
DBusGMainLoop(set_as_default=True )
2532
DBusGMainLoop(set_as_default=True)
1799
2533
main_loop = gobject.MainLoop()
1800
2534
bus = dbus.SystemBus()
1801
2535
# End of Avahi example code
1804
bus_name = dbus.service.BusName(u"se.bsnet.fukt.Mandos",
2538
bus_name = dbus.service.BusName("se.recompile.Mandos",
1805
2539
bus, do_not_queue=True)
1806
except dbus.exceptions.NameExistsException, e:
1807
logger.error(unicode(e) + u", disabling D-Bus")
2540
old_bus_name = (dbus.service.BusName
2541
("se.bsnet.fukt.Mandos", bus,
2543
except dbus.exceptions.NameExistsException as e:
2544
logger.error("Disabling D-Bus:", exc_info=e)
1808
2545
use_dbus = False
1809
server_settings[u"use_dbus"] = False
2546
server_settings["use_dbus"] = False
1810
2547
tcp_server.use_dbus = False
1811
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1812
service = AvahiService(name = server_settings[u"servicename"],
1813
servicetype = u"_mandos._tcp",
1814
protocol = protocol, bus = bus)
1815
if server_settings["interface"]:
1816
service.interface = (if_nametoindex
1817
(str(server_settings[u"interface"])))
1820
# Close all input and output, do double fork, etc.
2549
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2550
service = AvahiServiceToSyslog(name =
2551
server_settings["servicename"],
2552
servicetype = "_mandos._tcp",
2553
protocol = protocol, bus = bus)
2554
if server_settings["interface"]:
2555
service.interface = (if_nametoindex
2556
(str(server_settings["interface"])))
1823
2558
global multiprocessing_manager
1824
2559
multiprocessing_manager = multiprocessing.Manager()
1826
2561
client_class = Client
1828
2563
client_class = functools.partial(ClientDBus, bus = bus)
1829
def client_config_items(config, section):
1830
special_settings = {
1831
"approved_by_default":
1832
lambda: config.getboolean(section,
1833
"approved_by_default"),
1835
for name, value in config.items(section):
2565
client_settings = Client.config_parser(client_config)
2566
old_client_settings = {}
2569
# This is used to redirect stdout and stderr for checker processes
2571
wnull = open(os.devnull, "w") # A writable /dev/null
2572
# Only used if server is running in foreground but not in debug
2574
if debug or not foreground:
2577
# Get client data and settings from last running state.
2578
if server_settings["restore"]:
2580
with open(stored_state_path, "rb") as stored_state:
2581
clients_data, old_client_settings = (pickle.load
2583
os.remove(stored_state_path)
2584
except IOError as e:
2585
if e.errno == errno.ENOENT:
2586
logger.warning("Could not load persistent state: {0}"
2587
.format(os.strerror(e.errno)))
2589
logger.critical("Could not load persistent state:",
2592
except EOFError as e:
2593
logger.warning("Could not load persistent state: "
2594
"EOFError:", exc_info=e)
2596
with PGPEngine() as pgp:
2597
for client_name, client in clients_data.iteritems():
2598
# Skip removed clients
2599
if client_name not in client_settings:
2602
# Decide which value to use after restoring saved state.
2603
# We have three different values: Old config file,
2604
# new config file, and saved state.
2605
# New config value takes precedence if it differs from old
2606
# config value, otherwise use saved state.
2607
for name, value in client_settings[client_name].items():
2609
# For each value in new config, check if it
2610
# differs from the old config value (Except for
2611
# the "secret" attribute)
2612
if (name != "secret" and
2613
value != old_client_settings[client_name]
2615
client[name] = value
2619
# Clients who has passed its expire date can still be
2620
# enabled if its last checker was successful. Clients
2621
# whose checker succeeded before we stored its state is
2622
# assumed to have successfully run all checkers during
2624
if client["enabled"]:
2625
if datetime.datetime.utcnow() >= client["expires"]:
2626
if not client["last_checked_ok"]:
2628
"disabling client {0} - Client never "
2629
"performed a successful checker"
2630
.format(client_name))
2631
client["enabled"] = False
2632
elif client["last_checker_status"] != 0:
2634
"disabling client {0} - Client "
2635
"last checker failed with error code {1}"
2636
.format(client_name,
2637
client["last_checker_status"]))
2638
client["enabled"] = False
2640
client["expires"] = (datetime.datetime
2642
+ client["timeout"])
2643
logger.debug("Last checker succeeded,"
2644
" keeping {0} enabled"
2645
.format(client_name))
1837
yield (name, special_settings[name]())
1841
tcp_server.clients.update(set(
1842
client_class(name = section,
1843
config= dict(client_config_items(
1844
client_config, section)))
1845
for section in client_config.sections()))
2647
client["secret"] = (
2648
pgp.decrypt(client["encrypted_secret"],
2649
client_settings[client_name]
2652
# If decryption fails, we use secret from new settings
2653
logger.debug("Failed to decrypt {0} old secret"
2654
.format(client_name))
2655
client["secret"] = (
2656
client_settings[client_name]["secret"])
2658
# Add/remove clients based on new changes made to config
2659
for client_name in (set(old_client_settings)
2660
- set(client_settings)):
2661
del clients_data[client_name]
2662
for client_name in (set(client_settings)
2663
- set(old_client_settings)):
2664
clients_data[client_name] = client_settings[client_name]
2666
# Create all client objects
2667
for client_name, client in clients_data.iteritems():
2668
tcp_server.clients[client_name] = client_class(
2669
name = client_name, settings = client,
2670
server_settings = server_settings)
1846
2672
if not tcp_server.clients:
1847
logger.warning(u"No clients defined")
1852
pidfile.write(str(pid) + "\n")
2673
logger.warning("No clients defined")
2676
if pidfile is not None:
2680
pidfile.write(str(pid) + "\n".encode("utf-8"))
2682
logger.error("Could not write to file %r with PID %d",
1855
logger.error(u"Could not write to file %r with PID %d",
1858
# "pidfile" was never created
1863
signal.signal(signal.SIGINT, signal.SIG_IGN)
1864
2687
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1865
2688
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
1868
class MandosDBusService(dbus.service.Object):
2691
@alternate_dbus_interfaces({"se.recompile.Mandos":
2692
"se.bsnet.fukt.Mandos"})
2693
class MandosDBusService(DBusObjectWithProperties):
1869
2694
"""A D-Bus proxy object"""
1870
2695
def __init__(self):
1871
dbus.service.Object.__init__(self, bus, u"/")
1872
_interface = u"se.bsnet.fukt.Mandos"
1874
@dbus.service.signal(_interface, signature=u"o")
2696
dbus.service.Object.__init__(self, bus, "/")
2697
_interface = "se.recompile.Mandos"
2699
@dbus_interface_annotations(_interface)
2701
return { "org.freedesktop.DBus.Property"
2702
".EmitsChangedSignal":
2705
@dbus.service.signal(_interface, signature="o")
1875
2706
def ClientAdded(self, objpath):
1879
@dbus.service.signal(_interface, signature=u"ss")
2710
@dbus.service.signal(_interface, signature="ss")
1880
2711
def ClientNotFound(self, fingerprint, address):
1884
@dbus.service.signal(_interface, signature=u"os")
2715
@dbus.service.signal(_interface, signature="os")
1885
2716
def ClientRemoved(self, objpath, name):
1889
@dbus.service.method(_interface, out_signature=u"ao")
2720
@dbus.service.method(_interface, out_signature="ao")
1890
2721
def GetAllClients(self):
1892
2723
return dbus.Array(c.dbus_object_path
1893
for c in tcp_server.clients)
2725
tcp_server.clients.itervalues())
1895
2727
@dbus.service.method(_interface,
1896
out_signature=u"a{oa{sv}}")
2728
out_signature="a{oa{sv}}")
1897
2729
def GetAllClientsWithProperties(self):
1899
2731
return dbus.Dictionary(
1900
((c.dbus_object_path, c.GetAll(u""))
1901
for c in tcp_server.clients),
1902
signature=u"oa{sv}")
2732
((c.dbus_object_path, c.GetAll(""))
2733
for c in tcp_server.clients.itervalues()),
1904
@dbus.service.method(_interface, in_signature=u"o")
2736
@dbus.service.method(_interface, in_signature="o")
1905
2737
def RemoveClient(self, object_path):
1907
for c in tcp_server.clients:
2739
for c in tcp_server.clients.itervalues():
1908
2740
if c.dbus_object_path == object_path:
1909
tcp_server.clients.remove(c)
2741
del tcp_server.clients[c.name]
1910
2742
c.remove_from_connection()
1911
2743
# Don't signal anything except ClientRemoved
1912
2744
c.disable(quiet=True)
1923
2755
"Cleanup function; run on exit"
2759
multiprocessing.active_children()
2761
if not (tcp_server.clients or client_settings):
2764
# Store client before exiting. Secrets are encrypted with key
2765
# based on what config file has. If config file is
2766
# removed/edited, old secret will thus be unrecovable.
2768
with PGPEngine() as pgp:
2769
for client in tcp_server.clients.itervalues():
2770
key = client_settings[client.name]["secret"]
2771
client.encrypted_secret = pgp.encrypt(client.secret,
2775
# A list of attributes that can not be pickled
2777
exclude = set(("bus", "changedstate", "secret",
2778
"checker", "server_settings"))
2779
for name, typ in (inspect.getmembers
2780
(dbus.service.Object)):
2783
client_dict["encrypted_secret"] = (client
2785
for attr in client.client_structure:
2786
if attr not in exclude:
2787
client_dict[attr] = getattr(client, attr)
2789
clients[client.name] = client_dict
2790
del client_settings[client.name]["secret"]
2793
with (tempfile.NamedTemporaryFile
2794
(mode='wb', suffix=".pickle", prefix='clients-',
2795
dir=os.path.dirname(stored_state_path),
2796
delete=False)) as stored_state:
2797
pickle.dump((clients, client_settings), stored_state)
2798
tempname=stored_state.name
2799
os.rename(tempname, stored_state_path)
2800
except (IOError, OSError) as e:
2806
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
2807
logger.warning("Could not save persistent state: {0}"
2808
.format(os.strerror(e.errno)))
2810
logger.warning("Could not save persistent state:",
2814
# Delete all clients, and settings from config
1926
2815
while tcp_server.clients:
1927
client = tcp_server.clients.pop()
2816
name, client = tcp_server.clients.popitem()
1929
2818
client.remove_from_connection()
1930
client.disable_hook = None
1931
2819
# Don't signal anything except ClientRemoved
1932
2820
client.disable(quiet=True)
1934
2822
# Emit D-Bus signal
1935
mandos_dbus_service.ClientRemoved(client.dbus_object_path,
2823
mandos_dbus_service.ClientRemoved(client
2826
client_settings.clear()
1938
2828
atexit.register(cleanup)
1940
for client in tcp_server.clients:
2830
for client in tcp_server.clients.itervalues():
1942
2832
# Emit D-Bus signal
1943
2833
mandos_dbus_service.ClientAdded(client.dbus_object_path)
2834
# Need to initiate checking of clients
2836
client.init_checker()
1946
2838
tcp_server.enable()
1947
2839
tcp_server.server_activate()
1949
2841
# Find out what port we got
1950
service.port = tcp_server.socket.getsockname()[1]
2843
service.port = tcp_server.socket.getsockname()[1]
1952
logger.info(u"Now listening on address %r, port %d,"
1953
" flowinfo %d, scope_id %d"
1954
% tcp_server.socket.getsockname())
2845
logger.info("Now listening on address %r, port %d,"
2846
" flowinfo %d, scope_id %d",
2847
*tcp_server.socket.getsockname())
1956
logger.info(u"Now listening on address %r, port %d"
1957
% tcp_server.socket.getsockname())
2849
logger.info("Now listening on address %r, port %d",
2850
*tcp_server.socket.getsockname())
1959
2852
#service.interface = tcp_server.socket.getsockname()[3]
1962
# From the Avahi example code
1965
except dbus.exceptions.DBusException, error:
1966
logger.critical(u"DBusException: %s", error)
1969
# End of Avahi example code
2856
# From the Avahi example code
2859
except dbus.exceptions.DBusException as error:
2860
logger.critical("D-Bus Exception", exc_info=error)
2863
# End of Avahi example code
1971
2865
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
1972
2866
lambda *args, **kwargs:
1973
2867
(tcp_server.handle_request
1974
2868
(*args[2:], **kwargs) or True))
1976
logger.debug(u"Starting main loop")
2870
logger.debug("Starting main loop")
1977
2871
main_loop.run()
1978
except AvahiError, error:
1979
logger.critical(u"AvahiError: %s", error)
2872
except AvahiError as error:
2873
logger.critical("Avahi Error", exc_info=error)
1982
2876
except KeyboardInterrupt:
1985
logger.debug(u"Server received KeyboardInterrupt")
1986
logger.debug(u"Server exiting")
2878
print("", file=sys.stderr)
2879
logger.debug("Server received KeyboardInterrupt")
2880
logger.debug("Server exiting")
1987
2881
# Must run before the D-Bus bus name gets deregistered