80
88
except ImportError:
81
89
SO_BINDTODEVICE = None
86
#logger = logging.getLogger(u'mandos')
87
logger = logging.Logger(u'mandos')
92
stored_state_file = "clients.pickle"
94
logger = logging.getLogger()
88
95
syslogger = (logging.handlers.SysLogHandler
89
96
(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)
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.gnupg = GnuPGInterface.GnuPG()
143
self.tempdir = tempfile.mkdtemp(prefix="mandos-")
144
self.gnupg = GnuPGInterface.GnuPG()
145
self.gnupg.options.meta_interactive = False
146
self.gnupg.options.homedir = self.tempdir
147
self.gnupg.options.extra_args.extend(['--force-mdc',
154
def __exit__(self, exc_type, exc_value, traceback):
162
if self.tempdir is not None:
163
# Delete contents of tempdir
164
for root, dirs, files in os.walk(self.tempdir,
166
for filename in files:
167
os.remove(os.path.join(root, filename))
169
os.rmdir(os.path.join(root, dirname))
171
os.rmdir(self.tempdir)
174
def password_encode(self, password):
175
# Passphrase can not be empty and can not contain newlines or
176
# NUL bytes. So we prefix it and hex encode it.
177
return b"mandos" + binascii.hexlify(password)
179
def encrypt(self, data, password):
180
self.gnupg.passphrase = self.password_encode(password)
181
with open(os.devnull, "w") as devnull:
183
proc = self.gnupg.run(['--symmetric'],
184
create_fhs=['stdin', 'stdout'],
185
attach_fhs={'stderr': devnull})
186
with contextlib.closing(proc.handles['stdin']) as f:
188
with contextlib.closing(proc.handles['stdout']) as f:
189
ciphertext = f.read()
193
self.gnupg.passphrase = None
196
def decrypt(self, data, password):
197
self.gnupg.passphrase = self.password_encode(password)
198
with open(os.devnull, "w") as devnull:
200
proc = self.gnupg.run(['--decrypt'],
201
create_fhs=['stdin', 'stdout'],
202
attach_fhs={'stderr': devnull})
203
with contextlib.closing(proc.handles['stdin']) as f:
205
with contextlib.closing(proc.handles['stdout']) as f:
206
decrypted_plaintext = f.read()
210
self.gnupg.passphrase = None
211
return decrypted_plaintext
102
214
class AvahiError(Exception):
103
215
def __init__(self, value, *args, **kwargs):
197
315
dbus.UInt16(self.port),
198
316
avahi.string_array_to_txt_array(self.TXT))
199
317
self.group.Commit()
200
319
def entry_group_state_changed(self, state, error):
201
320
"""Derived from the Avahi example code"""
202
logger.debug(u"Avahi entry group state change: %i", state)
321
logger.debug("Avahi entry group state change: %i", state)
204
323
if state == avahi.ENTRY_GROUP_ESTABLISHED:
205
logger.debug(u"Zeroconf service established.")
324
logger.debug("Zeroconf service established.")
206
325
elif state == avahi.ENTRY_GROUP_COLLISION:
207
logger.warning(u"Zeroconf service name collision.")
326
logger.info("Zeroconf service name collision.")
209
328
elif state == avahi.ENTRY_GROUP_FAILURE:
210
logger.critical(u"Avahi: Error in group state changed %s",
329
logger.critical("Avahi: Error in group state changed %s",
212
raise AvahiGroupError(u"State changed: %s"
331
raise AvahiGroupError("State changed: {0!s}"
214
334
def cleanup(self):
215
335
"""Derived from the Avahi example code"""
216
336
if self.group is not None:
339
except (dbus.exceptions.UnknownMethodException,
340
dbus.exceptions.DBusException):
218
342
self.group = None
219
def server_state_changed(self, state):
345
def server_state_changed(self, state, error=None):
220
346
"""Derived from the Avahi example code"""
221
logger.debug(u"Avahi server state change: %i", state)
222
if state == avahi.SERVER_COLLISION:
223
logger.error(u"Zeroconf server name collision")
347
logger.debug("Avahi server state change: %i", state)
348
bad_states = { avahi.SERVER_INVALID:
349
"Zeroconf server invalid",
350
avahi.SERVER_REGISTERING: None,
351
avahi.SERVER_COLLISION:
352
"Zeroconf server name collision",
353
avahi.SERVER_FAILURE:
354
"Zeroconf server failure" }
355
if state in bad_states:
356
if bad_states[state] is not None:
358
logger.error(bad_states[state])
360
logger.error(bad_states[state] + ": %r", error)
225
362
elif state == avahi.SERVER_RUNNING:
366
logger.debug("Unknown state: %r", state)
368
logger.debug("Unknown state: %r: %r", state, error)
227
370
def activate(self):
228
371
"""Derived from the Avahi example code"""
229
372
if self.server is None:
230
373
self.server = dbus.Interface(
231
374
self.bus.get_object(avahi.DBUS_NAME,
232
avahi.DBUS_PATH_SERVER),
375
avahi.DBUS_PATH_SERVER,
376
follow_name_owner_changes=True),
233
377
avahi.DBUS_INTERFACE_SERVER)
234
self.server.connect_to_signal(u"StateChanged",
378
self.server.connect_to_signal("StateChanged",
235
379
self.server_state_changed)
236
380
self.server_state_changed(self.server.GetState())
383
class AvahiServiceToSyslog(AvahiService):
385
"""Add the new name to the syslog messages"""
386
ret = AvahiService.rename(self)
387
syslogger.setFormatter(logging.Formatter
388
('Mandos ({0}) [%(process)d]:'
389
' %(levelname)s: %(message)s'
394
def timedelta_to_milliseconds(td):
395
"Convert a datetime.timedelta() to milliseconds"
396
return ((td.days * 24 * 60 * 60 * 1000)
397
+ (td.seconds * 1000)
398
+ (td.microseconds // 1000))
239
401
class Client(object):
240
402
"""A representation of a client host served by this server.
243
_approved: bool(); 'None' if not yet approved/disapproved
405
approved: bool(); 'None' if not yet approved/disapproved
244
406
approval_delay: datetime.timedelta(); Time to wait for approval
245
407
approval_duration: datetime.timedelta(); Duration of one approval
246
408
checker: subprocess.Popen(); a running checker process used
247
409
to see if the client lives.
248
410
'None' if no process is running.
249
checker_callback_tag: - '' -
411
checker_callback_tag: a gobject event source tag, or None
250
412
checker_command: string; External command which is run to check
251
413
if client lives. %() expansions are done at
252
414
runtime with vars(self) as dict, so that for
253
415
instance %(name)s can be used in the command.
254
416
checker_initiator_tag: a gobject event source tag, or None
255
417
created: datetime.datetime(); (UTC) object creation
418
client_structure: Object describing what attributes a client has
419
and is used for storing the client at exit
256
420
current_checker_command: string; current running checker_command
257
disable_hook: If set, called by disable() as disable_hook(self)
258
disable_initiator_tag: - '' -
421
disable_initiator_tag: a gobject event source tag, or None
260
423
fingerprint: string (40 or 32 hexadecimal digits); used to
261
424
uniquely identify the client
262
425
host: string; available for use by the checker command
263
426
interval: datetime.timedelta(); How often to start a new checker
427
last_approval_request: datetime.datetime(); (UTC) or None
264
428
last_checked_ok: datetime.datetime(); (UTC) or None
265
last_enabled: datetime.datetime(); (UTC)
429
last_checker_status: integer between 0 and 255 reflecting exit
430
status of last checker. -1 reflects crashed
431
checker, -2 means no checker completed yet.
432
last_enabled: datetime.datetime(); (UTC) or None
266
433
name: string; from the config file, used in log messages and
267
434
D-Bus identifiers
268
435
secret: bytestring; sent verbatim (over TLS) to client
269
436
timeout: datetime.timedelta(); How long from last_checked_ok
270
437
until this client is disabled
438
extended_timeout: extra long timeout when secret has been sent
271
439
runtime_expansions: Allowed attributes for runtime expansion.
440
expires: datetime.datetime(); time (UTC) when a client will be
274
runtime_expansions = (u"approval_delay", u"approval_duration",
275
u"created", u"enabled", u"fingerprint",
276
u"host", u"interval", u"last_checked_ok",
277
u"last_enabled", u"name", u"timeout")
280
def _timedelta_to_milliseconds(td):
281
"Convert a datetime.timedelta() to milliseconds"
282
return ((td.days * 24 * 60 * 60 * 1000)
283
+ (td.seconds * 1000)
284
+ (td.microseconds // 1000))
444
runtime_expansions = ("approval_delay", "approval_duration",
445
"created", "enabled", "expires",
446
"fingerprint", "host", "interval",
447
"last_approval_request", "last_checked_ok",
448
"last_enabled", "name", "timeout")
449
client_defaults = { "timeout": "5m",
450
"extended_timeout": "15m",
452
"checker": "fping -q -- %%(host)s",
454
"approval_delay": "0s",
455
"approval_duration": "1s",
456
"approved_by_default": "True",
286
460
def timeout_milliseconds(self):
287
461
"Return the 'timeout' attribute in milliseconds"
288
return self._timedelta_to_milliseconds(self.timeout)
462
return timedelta_to_milliseconds(self.timeout)
464
def extended_timeout_milliseconds(self):
465
"Return the 'extended_timeout' attribute in milliseconds"
466
return timedelta_to_milliseconds(self.extended_timeout)
290
468
def interval_milliseconds(self):
291
469
"Return the 'interval' attribute in milliseconds"
292
return self._timedelta_to_milliseconds(self.interval)
470
return timedelta_to_milliseconds(self.interval)
294
472
def approval_delay_milliseconds(self):
295
return self._timedelta_to_milliseconds(self.approval_delay)
297
def __init__(self, name = None, disable_hook=None, config=None):
298
"""Note: the 'checker' key in 'config' sets the
299
'checker_command' attribute and *not* the 'checker'
473
return timedelta_to_milliseconds(self.approval_delay)
476
def config_parser(config):
477
"""Construct a new dict of client settings of this form:
478
{ client_name: {setting_name: value, ...}, ...}
479
with exceptions for any special settings as defined above.
480
NOTE: Must be a pure function. Must return the same result
481
value given the same arguments.
484
for client_name in config.sections():
485
section = dict(config.items(client_name))
486
client = settings[client_name] = {}
488
client["host"] = section["host"]
489
# Reformat values from string types to Python types
490
client["approved_by_default"] = config.getboolean(
491
client_name, "approved_by_default")
492
client["enabled"] = config.getboolean(client_name,
495
client["fingerprint"] = (section["fingerprint"].upper()
497
if "secret" in section:
498
client["secret"] = section["secret"].decode("base64")
499
elif "secfile" in section:
500
with open(os.path.expanduser(os.path.expandvars
501
(section["secfile"])),
503
client["secret"] = secfile.read()
505
raise TypeError("No secret or secfile for section {0}"
507
client["timeout"] = string_to_delta(section["timeout"])
508
client["extended_timeout"] = string_to_delta(
509
section["extended_timeout"])
510
client["interval"] = string_to_delta(section["interval"])
511
client["approval_delay"] = string_to_delta(
512
section["approval_delay"])
513
client["approval_duration"] = string_to_delta(
514
section["approval_duration"])
515
client["checker_command"] = section["checker"]
516
client["last_approval_request"] = None
517
client["last_checked_ok"] = None
518
client["last_checker_status"] = -2
522
def __init__(self, settings, name = None):
304
logger.debug(u"Creating client %r", self.name)
524
# adding all client settings
525
for setting, value in settings.iteritems():
526
setattr(self, setting, value)
529
if not hasattr(self, "last_enabled"):
530
self.last_enabled = datetime.datetime.utcnow()
531
if not hasattr(self, "expires"):
532
self.expires = (datetime.datetime.utcnow()
535
self.last_enabled = None
538
logger.debug("Creating client %r", self.name)
305
539
# Uppercase and remove spaces from fingerprint for later
306
540
# comparison purposes with return value from the fingerprint()
308
self.fingerprint = (config[u"fingerprint"].upper()
310
logger.debug(u" Fingerprint: %s", self.fingerprint)
311
if u"secret" in config:
312
self.secret = config[u"secret"].decode(u"base64")
313
elif u"secfile" in config:
314
with open(os.path.expanduser(os.path.expandvars
315
(config[u"secfile"])),
317
self.secret = secfile.read()
319
raise TypeError(u"No secret or secfile for client %s"
321
self.host = config.get(u"host", u"")
322
self.created = datetime.datetime.utcnow()
324
self.last_enabled = None
325
self.last_checked_ok = None
326
self.timeout = string_to_delta(config[u"timeout"])
327
self.interval = string_to_delta(config[u"interval"])
328
self.disable_hook = disable_hook
542
logger.debug(" Fingerprint: %s", self.fingerprint)
543
self.created = settings.get("created",
544
datetime.datetime.utcnow())
546
# attributes specific for this server instance
329
547
self.checker = None
330
548
self.checker_initiator_tag = None
331
549
self.disable_initiator_tag = None
332
550
self.checker_callback_tag = None
333
self.checker_command = config[u"checker"]
334
551
self.current_checker_command = None
335
self.last_connect = None
336
self._approved = None
337
self.approved_by_default = config.get(u"approved_by_default",
339
553
self.approvals_pending = 0
340
self.approval_delay = string_to_delta(
341
config[u"approval_delay"])
342
self.approval_duration = string_to_delta(
343
config[u"approval_duration"])
344
self.changedstate = multiprocessing_manager.Condition(multiprocessing_manager.Lock())
554
self.changedstate = (multiprocessing_manager
555
.Condition(multiprocessing_manager
557
self.client_structure = [attr for attr in
558
self.__dict__.iterkeys()
559
if not attr.startswith("_")]
560
self.client_structure.append("client_structure")
562
for name, t in inspect.getmembers(type(self),
566
if not name.startswith("_"):
567
self.client_structure.append(name)
569
# Send notice to process children that client state has changed
346
570
def send_changedstate(self):
347
self.changedstate.acquire()
348
self.changedstate.notify_all()
349
self.changedstate.release()
571
with self.changedstate:
572
self.changedstate.notify_all()
351
574
def enable(self):
352
575
"""Start this client's checker and timeout hooks"""
353
if getattr(self, u"enabled", False):
576
if getattr(self, "enabled", False):
354
577
# Already enabled
356
self.send_changedstate()
579
self.expires = datetime.datetime.utcnow() + self.timeout
357
581
self.last_enabled = datetime.datetime.utcnow()
583
self.send_changedstate()
585
def disable(self, quiet=True):
586
"""Disable this client."""
587
if not getattr(self, "enabled", False):
590
logger.info("Disabling client %s", self.name)
591
if getattr(self, "disable_initiator_tag", None) is not None:
592
gobject.source_remove(self.disable_initiator_tag)
593
self.disable_initiator_tag = None
595
if getattr(self, "checker_initiator_tag", None) is not None:
596
gobject.source_remove(self.checker_initiator_tag)
597
self.checker_initiator_tag = None
601
self.send_changedstate()
602
# Do not run this again if called by a gobject.timeout_add
608
def init_checker(self):
358
609
# Schedule a new checker to be started an 'interval' from now,
359
610
# and every interval from then on.
611
if self.checker_initiator_tag is not None:
612
gobject.source_remove(self.checker_initiator_tag)
360
613
self.checker_initiator_tag = (gobject.timeout_add
361
614
(self.interval_milliseconds(),
362
615
self.start_checker))
363
616
# Schedule a disable() when 'timeout' has passed
617
if self.disable_initiator_tag is not None:
618
gobject.source_remove(self.disable_initiator_tag)
364
619
self.disable_initiator_tag = (gobject.timeout_add
365
620
(self.timeout_milliseconds(),
368
622
# Also start a new checker *right now*.
369
623
self.start_checker()
371
def disable(self, quiet=True):
372
"""Disable this client."""
373
if not getattr(self, "enabled", False):
376
self.send_changedstate()
378
logger.info(u"Disabling client %s", self.name)
379
if getattr(self, u"disable_initiator_tag", False):
380
gobject.source_remove(self.disable_initiator_tag)
381
self.disable_initiator_tag = None
382
if getattr(self, u"checker_initiator_tag", False):
383
gobject.source_remove(self.checker_initiator_tag)
384
self.checker_initiator_tag = None
386
if self.disable_hook:
387
self.disable_hook(self)
389
# Do not run this again if called by a gobject.timeout_add
393
self.disable_hook = None
396
625
def checker_callback(self, pid, condition, command):
397
626
"""The checker has completed, so take appropriate actions."""
398
627
self.checker_callback_tag = None
399
628
self.checker = None
400
629
if os.WIFEXITED(condition):
401
exitstatus = os.WEXITSTATUS(condition)
403
logger.info(u"Checker for %(name)s succeeded",
630
self.last_checker_status = os.WEXITSTATUS(condition)
631
if self.last_checker_status == 0:
632
logger.info("Checker for %(name)s succeeded",
405
634
self.checked_ok()
407
logger.info(u"Checker for %(name)s failed",
636
logger.info("Checker for %(name)s failed",
410
logger.warning(u"Checker for %(name)s crashed?",
639
self.last_checker_status = -1
640
logger.warning("Checker for %(name)s crashed?",
413
643
def checked_ok(self):
414
"""Bump up the timeout for this client.
416
This should only be called when the client has been seen,
644
"""Assert that the client has been seen, alive and well."""
419
645
self.last_checked_ok = datetime.datetime.utcnow()
420
gobject.source_remove(self.disable_initiator_tag)
421
self.disable_initiator_tag = (gobject.timeout_add
422
(self.timeout_milliseconds(),
646
self.last_checker_status = 0
649
def bump_timeout(self, timeout=None):
650
"""Bump up the timeout for this client."""
652
timeout = self.timeout
653
if self.disable_initiator_tag is not None:
654
gobject.source_remove(self.disable_initiator_tag)
655
self.disable_initiator_tag = None
656
if getattr(self, "enabled", False):
657
self.disable_initiator_tag = (gobject.timeout_add
658
(timedelta_to_milliseconds
659
(timeout), self.disable))
660
self.expires = datetime.datetime.utcnow() + timeout
662
def need_approval(self):
663
self.last_approval_request = datetime.datetime.utcnow()
425
665
def start_checker(self):
426
666
"""Start a new checker subprocess if one is not running.
567
837
class DBusObjectWithProperties(dbus.service.Object):
568
838
"""A D-Bus object with properties.
570
840
Classes inheriting from this can use the dbus_service_property
571
841
decorator to expose methods as D-Bus properties. It exposes the
572
842
standard Get(), Set(), and GetAll() methods on the D-Bus.
576
def _is_dbus_property(obj):
577
return getattr(obj, u"_dbus_is_property", False)
846
def _is_dbus_thing(thing):
847
"""Returns a function testing if an attribute is a D-Bus thing
849
If called like _is_dbus_thing("method") it returns a function
850
suitable for use as predicate to inspect.getmembers().
852
return lambda obj: getattr(obj, "_dbus_is_{0}".format(thing),
579
def _get_all_dbus_properties(self):
855
def _get_all_dbus_things(self, thing):
580
856
"""Returns a generator of (name, attribute) pairs
582
return ((prop._dbus_name, prop)
584
inspect.getmembers(self, self._is_dbus_property))
858
return ((getattr(athing.__get__(self), "_dbus_name",
860
athing.__get__(self))
861
for cls in self.__class__.__mro__
863
inspect.getmembers(cls,
864
self._is_dbus_thing(thing)))
586
866
def _get_dbus_property(self, interface_name, property_name):
587
867
"""Returns a bound method if one exists which is a D-Bus
588
868
property with the specified name and interface.
590
for name in (property_name,
591
property_name + u"_dbus_property"):
592
prop = getattr(self, name, None)
594
or not self._is_dbus_property(prop)
595
or prop._dbus_name != property_name
596
or (interface_name and prop._dbus_interface
597
and interface_name != prop._dbus_interface)):
870
for cls in self.__class__.__mro__:
871
for name, value in (inspect.getmembers
873
self._is_dbus_thing("property"))):
874
if (value._dbus_name == property_name
875
and value._dbus_interface == interface_name):
876
return value.__get__(self)
600
878
# No such property
601
raise DBusPropertyNotFound(self.dbus_object_path + u":"
602
+ interface_name + u"."
879
raise DBusPropertyNotFound(self.dbus_object_path + ":"
880
+ interface_name + "."
605
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ss",
883
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
607
885
def Get(self, interface_name, property_name):
608
886
"""Standard D-Bus property Get() method, see D-Bus standard.
610
888
prop = self._get_dbus_property(interface_name, property_name)
611
if prop._dbus_access == u"write":
889
if prop._dbus_access == "write":
612
890
raise DBusPropertyAccessException(property_name)
614
if not hasattr(value, u"variant_level"):
892
if not hasattr(value, "variant_level"):
616
894
return type(value)(value, variant_level=value.variant_level+1)
618
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ssv")
896
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
619
897
def Set(self, interface_name, property_name, value):
620
898
"""Standard D-Bus property Set() method, see D-Bus standard.
622
900
prop = self._get_dbus_property(interface_name, property_name)
623
if prop._dbus_access == u"read":
901
if prop._dbus_access == "read":
624
902
raise DBusPropertyAccessException(property_name)
625
if prop._dbus_get_args_options[u"byte_arrays"]:
903
if prop._dbus_get_args_options["byte_arrays"]:
626
904
# The byte_arrays option is not supported yet on
627
905
# signatures other than "ay".
628
if prop._dbus_signature != u"ay":
906
if prop._dbus_signature != "ay":
630
value = dbus.ByteArray(''.join(unichr(byte)
908
value = dbus.ByteArray(b''.join(chr(byte)
634
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"s",
635
out_signature=u"a{sv}")
912
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
913
out_signature="a{sv}")
636
914
def GetAll(self, interface_name):
637
915
"""Standard D-Bus property GetAll() method, see D-Bus
640
918
Note: Will not include properties with access="write".
643
for name, prop in self._get_all_dbus_properties():
921
for name, prop in self._get_all_dbus_things("property"):
644
922
if (interface_name
645
923
and interface_name != prop._dbus_interface):
646
924
# Interface non-empty but did not match
648
926
# Ignore write-only properties
649
if prop._dbus_access == u"write":
927
if prop._dbus_access == "write":
652
if not hasattr(value, u"variant_level"):
930
if not hasattr(value, "variant_level"):
931
properties[name] = value
655
all[name] = type(value)(value, variant_level=
656
value.variant_level+1)
657
return dbus.Dictionary(all, signature=u"sv")
933
properties[name] = type(value)(value, variant_level=
934
value.variant_level+1)
935
return dbus.Dictionary(properties, signature="sv")
659
937
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
661
939
path_keyword='object_path',
662
940
connection_keyword='connection')
663
941
def Introspect(self, object_path, connection):
664
"""Standard D-Bus method, overloaded to insert property tags.
942
"""Overloading of standard D-Bus method.
944
Inserts property tags and interface annotation tags.
666
946
xmlstring = dbus.service.Object.Introspect(self, object_path,
669
949
document = xml.dom.minidom.parseString(xmlstring)
670
950
def make_tag(document, name, prop):
671
e = document.createElement(u"property")
672
e.setAttribute(u"name", name)
673
e.setAttribute(u"type", prop._dbus_signature)
674
e.setAttribute(u"access", prop._dbus_access)
951
e = document.createElement("property")
952
e.setAttribute("name", name)
953
e.setAttribute("type", prop._dbus_signature)
954
e.setAttribute("access", prop._dbus_access)
676
for if_tag in document.getElementsByTagName(u"interface"):
956
for if_tag in document.getElementsByTagName("interface"):
677
958
for tag in (make_tag(document, name, prop)
679
in self._get_all_dbus_properties()
960
in self._get_all_dbus_things("property")
680
961
if prop._dbus_interface
681
== if_tag.getAttribute(u"name")):
962
== if_tag.getAttribute("name")):
682
963
if_tag.appendChild(tag)
964
# Add annotation tags
965
for typ in ("method", "signal", "property"):
966
for tag in if_tag.getElementsByTagName(typ):
968
for name, prop in (self.
969
_get_all_dbus_things(typ)):
970
if (name == tag.getAttribute("name")
971
and prop._dbus_interface
972
== if_tag.getAttribute("name")):
973
annots.update(getattr
977
for name, value in annots.iteritems():
978
ann_tag = document.createElement(
980
ann_tag.setAttribute("name", name)
981
ann_tag.setAttribute("value", value)
982
tag.appendChild(ann_tag)
983
# Add interface annotation tags
984
for annotation, value in dict(
985
itertools.chain.from_iterable(
986
annotations().iteritems()
987
for name, annotations in
988
self._get_all_dbus_things("interface")
989
if name == if_tag.getAttribute("name")
991
ann_tag = document.createElement("annotation")
992
ann_tag.setAttribute("name", annotation)
993
ann_tag.setAttribute("value", value)
994
if_tag.appendChild(ann_tag)
683
995
# Add the names to the return values for the
684
996
# "org.freedesktop.DBus.Properties" methods
685
if (if_tag.getAttribute(u"name")
686
== u"org.freedesktop.DBus.Properties"):
687
for cn in if_tag.getElementsByTagName(u"method"):
688
if cn.getAttribute(u"name") == u"Get":
689
for arg in cn.getElementsByTagName(u"arg"):
690
if (arg.getAttribute(u"direction")
692
arg.setAttribute(u"name", u"value")
693
elif cn.getAttribute(u"name") == u"GetAll":
694
for arg in cn.getElementsByTagName(u"arg"):
695
if (arg.getAttribute(u"direction")
697
arg.setAttribute(u"name", u"props")
698
xmlstring = document.toxml(u"utf-8")
997
if (if_tag.getAttribute("name")
998
== "org.freedesktop.DBus.Properties"):
999
for cn in if_tag.getElementsByTagName("method"):
1000
if cn.getAttribute("name") == "Get":
1001
for arg in cn.getElementsByTagName("arg"):
1002
if (arg.getAttribute("direction")
1004
arg.setAttribute("name", "value")
1005
elif cn.getAttribute("name") == "GetAll":
1006
for arg in cn.getElementsByTagName("arg"):
1007
if (arg.getAttribute("direction")
1009
arg.setAttribute("name", "props")
1010
xmlstring = document.toxml("utf-8")
699
1011
document.unlink()
700
1012
except (AttributeError, xml.dom.DOMException,
701
xml.parsers.expat.ExpatError), error:
702
logger.error(u"Failed to override Introspection method",
1013
xml.parsers.expat.ExpatError) as error:
1014
logger.error("Failed to override Introspection method",
704
1016
return xmlstring
1019
def datetime_to_dbus(dt, variant_level=0):
1020
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1022
return dbus.String("", variant_level = variant_level)
1023
return dbus.String(dt.isoformat(),
1024
variant_level=variant_level)
1027
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1028
"""A class decorator; applied to a subclass of
1029
dbus.service.Object, it will add alternate D-Bus attributes with
1030
interface names according to the "alt_interface_names" mapping.
1033
@alternate_dbus_interfaces({"org.example.Interface":
1034
"net.example.AlternateInterface"})
1035
class SampleDBusObject(dbus.service.Object):
1036
@dbus.service.method("org.example.Interface")
1037
def SampleDBusMethod():
1040
The above "SampleDBusMethod" on "SampleDBusObject" will be
1041
reachable via two interfaces: "org.example.Interface" and
1042
"net.example.AlternateInterface", the latter of which will have
1043
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1044
"true", unless "deprecate" is passed with a False value.
1046
This works for methods and signals, and also for D-Bus properties
1047
(from DBusObjectWithProperties) and interfaces (from the
1048
dbus_interface_annotations decorator).
1051
for orig_interface_name, alt_interface_name in (
1052
alt_interface_names.iteritems()):
1054
interface_names = set()
1055
# Go though all attributes of the class
1056
for attrname, attribute in inspect.getmembers(cls):
1057
# Ignore non-D-Bus attributes, and D-Bus attributes
1058
# with the wrong interface name
1059
if (not hasattr(attribute, "_dbus_interface")
1060
or not attribute._dbus_interface
1061
.startswith(orig_interface_name)):
1063
# Create an alternate D-Bus interface name based on
1065
alt_interface = (attribute._dbus_interface
1066
.replace(orig_interface_name,
1067
alt_interface_name))
1068
interface_names.add(alt_interface)
1069
# Is this a D-Bus signal?
1070
if getattr(attribute, "_dbus_is_signal", False):
1071
# Extract the original non-method function by
1073
nonmethod_func = (dict(
1074
zip(attribute.func_code.co_freevars,
1075
attribute.__closure__))["func"]
1077
# Create a new, but exactly alike, function
1078
# object, and decorate it to be a new D-Bus signal
1079
# with the alternate D-Bus interface name
1080
new_function = (dbus.service.signal
1082
attribute._dbus_signature)
1083
(types.FunctionType(
1084
nonmethod_func.func_code,
1085
nonmethod_func.func_globals,
1086
nonmethod_func.func_name,
1087
nonmethod_func.func_defaults,
1088
nonmethod_func.func_closure)))
1089
# Copy annotations, if any
1091
new_function._dbus_annotations = (
1092
dict(attribute._dbus_annotations))
1093
except AttributeError:
1095
# Define a creator of a function to call both the
1096
# original and alternate functions, so both the
1097
# original and alternate signals gets sent when
1098
# the function is called
1099
def fixscope(func1, func2):
1100
"""This function is a scope container to pass
1101
func1 and func2 to the "call_both" function
1102
outside of its arguments"""
1103
def call_both(*args, **kwargs):
1104
"""This function will emit two D-Bus
1105
signals by calling func1 and func2"""
1106
func1(*args, **kwargs)
1107
func2(*args, **kwargs)
1109
# Create the "call_both" function and add it to
1111
attr[attrname] = fixscope(attribute, new_function)
1112
# Is this a D-Bus method?
1113
elif getattr(attribute, "_dbus_is_method", False):
1114
# Create a new, but exactly alike, function
1115
# object. Decorate it to be a new D-Bus method
1116
# with the alternate D-Bus interface name. Add it
1118
attr[attrname] = (dbus.service.method
1120
attribute._dbus_in_signature,
1121
attribute._dbus_out_signature)
1123
(attribute.func_code,
1124
attribute.func_globals,
1125
attribute.func_name,
1126
attribute.func_defaults,
1127
attribute.func_closure)))
1128
# Copy annotations, if any
1130
attr[attrname]._dbus_annotations = (
1131
dict(attribute._dbus_annotations))
1132
except AttributeError:
1134
# Is this a D-Bus property?
1135
elif getattr(attribute, "_dbus_is_property", False):
1136
# Create a new, but exactly alike, function
1137
# object, and decorate it to be a new D-Bus
1138
# property with the alternate D-Bus interface
1139
# name. Add it to the class.
1140
attr[attrname] = (dbus_service_property
1142
attribute._dbus_signature,
1143
attribute._dbus_access,
1145
._dbus_get_args_options
1148
(attribute.func_code,
1149
attribute.func_globals,
1150
attribute.func_name,
1151
attribute.func_defaults,
1152
attribute.func_closure)))
1153
# Copy annotations, if any
1155
attr[attrname]._dbus_annotations = (
1156
dict(attribute._dbus_annotations))
1157
except AttributeError:
1159
# Is this a D-Bus interface?
1160
elif getattr(attribute, "_dbus_is_interface", False):
1161
# Create a new, but exactly alike, function
1162
# object. Decorate it to be a new D-Bus interface
1163
# with the alternate D-Bus interface name. Add it
1165
attr[attrname] = (dbus_interface_annotations
1168
(attribute.func_code,
1169
attribute.func_globals,
1170
attribute.func_name,
1171
attribute.func_defaults,
1172
attribute.func_closure)))
1174
# Deprecate all alternate interfaces
1175
iname="_AlternateDBusNames_interface_annotation{0}"
1176
for interface_name in interface_names:
1177
@dbus_interface_annotations(interface_name)
1179
return { "org.freedesktop.DBus.Deprecated":
1181
# Find an unused name
1182
for aname in (iname.format(i)
1183
for i in itertools.count()):
1184
if aname not in attr:
1188
# Replace the class with a new subclass of it with
1189
# methods, signals, etc. as created above.
1190
cls = type(b"{0}Alternate".format(cls.__name__),
1196
@alternate_dbus_interfaces({"se.recompile.Mandos":
1197
"se.bsnet.fukt.Mandos"})
707
1198
class ClientDBus(Client, DBusObjectWithProperties):
708
1199
"""A Client class using D-Bus
715
1206
runtime_expansions = (Client.runtime_expansions
716
+ (u"dbus_object_path",))
1207
+ ("dbus_object_path",))
718
1209
# dbus.service.Object doesn't use super(), so we can't either.
720
1211
def __init__(self, bus = None, *args, **kwargs):
721
self._approvals_pending = 0
723
1213
Client.__init__(self, *args, **kwargs)
724
1214
# Only now, when this client is initialized, can it show up on
1216
client_object_name = unicode(self.name).translate(
1217
{ord("."): ord("_"),
1218
ord("-"): ord("_")})
726
1219
self.dbus_object_path = (dbus.ObjectPath
728
+ self.name.replace(u".", u"_")))
1220
("/clients/" + client_object_name))
729
1221
DBusObjectWithProperties.__init__(self, self.bus,
730
1222
self.dbus_object_path)
732
def _get_approvals_pending(self):
733
return self._approvals_pending
734
def _set_approvals_pending(self, value):
735
old_value = self._approvals_pending
736
self._approvals_pending = value
738
if (hasattr(self, "dbus_object_path")
739
and bval is not bool(old_value)):
740
dbus_bool = dbus.Boolean(bval, variant_level=1)
741
self.PropertyChanged(dbus.String(u"ApprovalPending"),
744
approvals_pending = property(_get_approvals_pending,
745
_set_approvals_pending)
746
del _get_approvals_pending, _set_approvals_pending
749
def _datetime_to_dbus(dt, variant_level=0):
750
"""Convert a UTC datetime.datetime() to a D-Bus type."""
751
return dbus.String(dt.isoformat(),
752
variant_level=variant_level)
755
oldstate = getattr(self, u"enabled", False)
756
r = Client.enable(self)
757
if oldstate != self.enabled:
759
self.PropertyChanged(dbus.String(u"Enabled"),
760
dbus.Boolean(True, variant_level=1))
761
self.PropertyChanged(
762
dbus.String(u"LastEnabled"),
763
self._datetime_to_dbus(self.last_enabled,
767
def disable(self, quiet = False):
768
oldstate = getattr(self, u"enabled", False)
769
r = Client.disable(self, quiet=quiet)
770
if not quiet and oldstate != self.enabled:
772
self.PropertyChanged(dbus.String(u"Enabled"),
773
dbus.Boolean(False, variant_level=1))
1224
def notifychangeproperty(transform_func,
1225
dbus_name, type_func=lambda x: x,
1227
""" Modify a variable so that it's a property which announces
1228
its changes to DBus.
1230
transform_fun: Function that takes a value and a variant_level
1231
and transforms it to a D-Bus type.
1232
dbus_name: D-Bus name of the variable
1233
type_func: Function that transform the value before sending it
1234
to the D-Bus. Default: no transform
1235
variant_level: D-Bus variant level. Default: 1
1237
attrname = "_{0}".format(dbus_name)
1238
def setter(self, value):
1239
if hasattr(self, "dbus_object_path"):
1240
if (not hasattr(self, attrname) or
1241
type_func(getattr(self, attrname, None))
1242
!= type_func(value)):
1243
dbus_value = transform_func(type_func(value),
1246
self.PropertyChanged(dbus.String(dbus_name),
1248
setattr(self, attrname, value)
1250
return property(lambda self: getattr(self, attrname), setter)
1252
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1253
approvals_pending = notifychangeproperty(dbus.Boolean,
1256
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1257
last_enabled = notifychangeproperty(datetime_to_dbus,
1259
checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1260
type_func = lambda checker:
1261
checker is not None)
1262
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1264
last_checker_status = notifychangeproperty(dbus.Int16,
1265
"LastCheckerStatus")
1266
last_approval_request = notifychangeproperty(
1267
datetime_to_dbus, "LastApprovalRequest")
1268
approved_by_default = notifychangeproperty(dbus.Boolean,
1269
"ApprovedByDefault")
1270
approval_delay = notifychangeproperty(dbus.UInt64,
1273
timedelta_to_milliseconds)
1274
approval_duration = notifychangeproperty(
1275
dbus.UInt64, "ApprovalDuration",
1276
type_func = timedelta_to_milliseconds)
1277
host = notifychangeproperty(dbus.String, "Host")
1278
timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1280
timedelta_to_milliseconds)
1281
extended_timeout = notifychangeproperty(
1282
dbus.UInt64, "ExtendedTimeout",
1283
type_func = timedelta_to_milliseconds)
1284
interval = notifychangeproperty(dbus.UInt64,
1287
timedelta_to_milliseconds)
1288
checker_command = notifychangeproperty(dbus.String, "Checker")
1290
del notifychangeproperty
776
1292
def __del__(self, *args, **kwargs):
778
1294
self.remove_from_connection()
779
1295
except LookupError:
781
if hasattr(DBusObjectWithProperties, u"__del__"):
1297
if hasattr(DBusObjectWithProperties, "__del__"):
782
1298
DBusObjectWithProperties.__del__(self, *args, **kwargs)
783
1299
Client.__del__(self, *args, **kwargs)
935
1433
# ApprovalPending - property
936
@dbus_service_property(_interface, signature=u"b", access=u"read")
1434
@dbus_service_property(_interface, signature="b", access="read")
937
1435
def ApprovalPending_dbus_property(self):
938
1436
return dbus.Boolean(bool(self.approvals_pending))
940
1438
# ApprovedByDefault - property
941
@dbus_service_property(_interface, signature=u"b",
1439
@dbus_service_property(_interface, signature="b",
943
1441
def ApprovedByDefault_dbus_property(self, value=None):
944
1442
if value is None: # get
945
1443
return dbus.Boolean(self.approved_by_default)
946
1444
self.approved_by_default = bool(value)
948
self.PropertyChanged(dbus.String(u"ApprovedByDefault"),
949
dbus.Boolean(value, variant_level=1))
951
1446
# ApprovalDelay - property
952
@dbus_service_property(_interface, signature=u"t",
1447
@dbus_service_property(_interface, signature="t",
954
1449
def ApprovalDelay_dbus_property(self, value=None):
955
1450
if value is None: # get
956
1451
return dbus.UInt64(self.approval_delay_milliseconds())
957
1452
self.approval_delay = datetime.timedelta(0, 0, 0, value)
959
self.PropertyChanged(dbus.String(u"ApprovalDelay"),
960
dbus.UInt64(value, variant_level=1))
962
1454
# ApprovalDuration - property
963
@dbus_service_property(_interface, signature=u"t",
1455
@dbus_service_property(_interface, signature="t",
965
1457
def ApprovalDuration_dbus_property(self, value=None):
966
1458
if value is None: # get
967
return dbus.UInt64(self._timedelta_to_milliseconds(
1459
return dbus.UInt64(timedelta_to_milliseconds(
968
1460
self.approval_duration))
969
1461
self.approval_duration = datetime.timedelta(0, 0, 0, value)
971
self.PropertyChanged(dbus.String(u"ApprovalDuration"),
972
dbus.UInt64(value, variant_level=1))
974
1463
# Name - property
975
@dbus_service_property(_interface, signature=u"s", access=u"read")
1464
@dbus_service_property(_interface, signature="s", access="read")
976
1465
def Name_dbus_property(self):
977
1466
return dbus.String(self.name)
979
1468
# Fingerprint - property
980
@dbus_service_property(_interface, signature=u"s", access=u"read")
1469
@dbus_service_property(_interface, signature="s", access="read")
981
1470
def Fingerprint_dbus_property(self):
982
1471
return dbus.String(self.fingerprint)
984
1473
# Host - property
985
@dbus_service_property(_interface, signature=u"s",
1474
@dbus_service_property(_interface, signature="s",
987
1476
def Host_dbus_property(self, value=None):
988
1477
if value is None: # get
989
1478
return dbus.String(self.host)
992
self.PropertyChanged(dbus.String(u"Host"),
993
dbus.String(value, variant_level=1))
1479
self.host = unicode(value)
995
1481
# Created - property
996
@dbus_service_property(_interface, signature=u"s", access=u"read")
1482
@dbus_service_property(_interface, signature="s", access="read")
997
1483
def Created_dbus_property(self):
998
return dbus.String(self._datetime_to_dbus(self.created))
1484
return datetime_to_dbus(self.created)
1000
1486
# LastEnabled - property
1001
@dbus_service_property(_interface, signature=u"s", access=u"read")
1487
@dbus_service_property(_interface, signature="s", access="read")
1002
1488
def LastEnabled_dbus_property(self):
1003
if self.last_enabled is None:
1004
return dbus.String(u"")
1005
return dbus.String(self._datetime_to_dbus(self.last_enabled))
1489
return datetime_to_dbus(self.last_enabled)
1007
1491
# Enabled - property
1008
@dbus_service_property(_interface, signature=u"b",
1009
access=u"readwrite")
1492
@dbus_service_property(_interface, signature="b",
1010
1494
def Enabled_dbus_property(self, value=None):
1011
1495
if value is None: # get
1012
1496
return dbus.Boolean(self.enabled)
1018
1502
# LastCheckedOK - property
1019
@dbus_service_property(_interface, signature=u"s",
1020
access=u"readwrite")
1503
@dbus_service_property(_interface, signature="s",
1021
1505
def LastCheckedOK_dbus_property(self, value=None):
1022
1506
if value is not None:
1023
1507
self.checked_ok()
1025
if self.last_checked_ok is None:
1026
return dbus.String(u"")
1027
return dbus.String(self._datetime_to_dbus(self
1509
return datetime_to_dbus(self.last_checked_ok)
1511
# LastCheckerStatus - property
1512
@dbus_service_property(_interface, signature="n",
1514
def LastCheckerStatus_dbus_property(self):
1515
return dbus.Int16(self.last_checker_status)
1517
# Expires - property
1518
@dbus_service_property(_interface, signature="s", access="read")
1519
def Expires_dbus_property(self):
1520
return datetime_to_dbus(self.expires)
1522
# LastApprovalRequest - property
1523
@dbus_service_property(_interface, signature="s", access="read")
1524
def LastApprovalRequest_dbus_property(self):
1525
return datetime_to_dbus(self.last_approval_request)
1030
1527
# Timeout - property
1031
@dbus_service_property(_interface, signature=u"t",
1032
access=u"readwrite")
1528
@dbus_service_property(_interface, signature="t",
1033
1530
def Timeout_dbus_property(self, value=None):
1034
1531
if value is None: # get
1035
1532
return dbus.UInt64(self.timeout_milliseconds())
1533
old_timeout = self.timeout
1036
1534
self.timeout = datetime.timedelta(0, 0, 0, value)
1038
self.PropertyChanged(dbus.String(u"Timeout"),
1039
dbus.UInt64(value, variant_level=1))
1040
if getattr(self, u"disable_initiator_tag", None) is None:
1042
# Reschedule timeout
1043
gobject.source_remove(self.disable_initiator_tag)
1044
self.disable_initiator_tag = None
1045
time_to_die = (self.
1046
_timedelta_to_milliseconds((self
1051
if time_to_die <= 0:
1052
# The timeout has passed
1055
self.disable_initiator_tag = (gobject.timeout_add
1056
(time_to_die, self.disable))
1535
# Reschedule disabling
1537
now = datetime.datetime.utcnow()
1538
self.expires += self.timeout - old_timeout
1539
if self.expires <= now:
1540
# The timeout has passed
1543
if (getattr(self, "disable_initiator_tag", None)
1546
gobject.source_remove(self.disable_initiator_tag)
1547
self.disable_initiator_tag = (
1548
gobject.timeout_add(
1549
timedelta_to_milliseconds(self.expires - now),
1552
# ExtendedTimeout - property
1553
@dbus_service_property(_interface, signature="t",
1555
def ExtendedTimeout_dbus_property(self, value=None):
1556
if value is None: # get
1557
return dbus.UInt64(self.extended_timeout_milliseconds())
1558
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1058
1560
# Interval - property
1059
@dbus_service_property(_interface, signature=u"t",
1060
access=u"readwrite")
1561
@dbus_service_property(_interface, signature="t",
1061
1563
def Interval_dbus_property(self, value=None):
1062
1564
if value is None: # get
1063
1565
return dbus.UInt64(self.interval_milliseconds())
1064
1566
self.interval = datetime.timedelta(0, 0, 0, value)
1066
self.PropertyChanged(dbus.String(u"Interval"),
1067
dbus.UInt64(value, variant_level=1))
1068
if getattr(self, u"checker_initiator_tag", None) is None:
1567
if getattr(self, "checker_initiator_tag", None) is None:
1070
# Reschedule checker run
1071
gobject.source_remove(self.checker_initiator_tag)
1072
self.checker_initiator_tag = (gobject.timeout_add
1073
(value, self.start_checker))
1074
self.start_checker() # Start one now, too
1570
# Reschedule checker run
1571
gobject.source_remove(self.checker_initiator_tag)
1572
self.checker_initiator_tag = (gobject.timeout_add
1573
(value, self.start_checker))
1574
self.start_checker() # Start one now, too
1076
1576
# Checker - property
1077
@dbus_service_property(_interface, signature=u"s",
1078
access=u"readwrite")
1577
@dbus_service_property(_interface, signature="s",
1079
1579
def Checker_dbus_property(self, value=None):
1080
1580
if value is None: # get
1081
1581
return dbus.String(self.checker_command)
1082
self.checker_command = value
1084
self.PropertyChanged(dbus.String(u"Checker"),
1085
dbus.String(self.checker_command,
1582
self.checker_command = unicode(value)
1088
1584
# CheckerRunning - property
1089
@dbus_service_property(_interface, signature=u"b",
1090
access=u"readwrite")
1585
@dbus_service_property(_interface, signature="b",
1091
1587
def CheckerRunning_dbus_property(self, value=None):
1092
1588
if value is None: # get
1093
1589
return dbus.Boolean(self.checker is not None)
1145
1641
def handle(self):
1146
1642
with contextlib.closing(self.server.child_pipe) as child_pipe:
1147
logger.info(u"TCP connection from: %s",
1643
logger.info("TCP connection from: %s",
1148
1644
unicode(self.client_address))
1149
logger.debug(u"Pipe FD: %d",
1645
logger.debug("Pipe FD: %d",
1150
1646
self.server.child_pipe.fileno())
1152
1648
session = (gnutls.connection
1153
1649
.ClientSession(self.request,
1154
1650
gnutls.connection
1155
1651
.X509Credentials()))
1157
1653
# Note: gnutls.connection.X509Credentials is really a
1158
1654
# generic GnuTLS certificate credentials object so long as
1159
1655
# no X.509 keys are added to it. Therefore, we can use it
1160
1656
# here despite using OpenPGP certificates.
1162
#priority = u':'.join((u"NONE", u"+VERS-TLS1.1",
1163
# u"+AES-256-CBC", u"+SHA1",
1164
# u"+COMP-NULL", u"+CTYPE-OPENPGP",
1658
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1659
# "+AES-256-CBC", "+SHA1",
1660
# "+COMP-NULL", "+CTYPE-OPENPGP",
1166
1662
# Use a fallback default, since this MUST be set.
1167
1663
priority = self.server.gnutls_priority
1168
1664
if priority is None:
1169
priority = u"NORMAL"
1170
1666
(gnutls.library.functions
1171
1667
.gnutls_priority_set_direct(session._c_object,
1172
1668
priority, None))
1174
1670
# Start communication using the Mandos protocol
1175
1671
# Get protocol number
1176
1672
line = self.request.makefile().readline()
1177
logger.debug(u"Protocol version: %r", line)
1673
logger.debug("Protocol version: %r", line)
1179
1675
if int(line.strip().split()[0]) > 1:
1180
1676
raise RuntimeError
1181
except (ValueError, IndexError, RuntimeError), error:
1182
logger.error(u"Unknown protocol version: %s", error)
1677
except (ValueError, IndexError, RuntimeError) as error:
1678
logger.error("Unknown protocol version: %s", error)
1185
1681
# Start GnuTLS connection
1187
1683
session.handshake()
1188
except gnutls.errors.GNUTLSError, error:
1189
logger.warning(u"Handshake failed: %s", error)
1684
except gnutls.errors.GNUTLSError as error:
1685
logger.warning("Handshake failed: %s", error)
1190
1686
# Do not run session.bye() here: the session is not
1191
1687
# established. Just abandon the request.
1193
logger.debug(u"Handshake succeeded")
1689
logger.debug("Handshake succeeded")
1195
1691
approval_required = False
1198
1694
fpr = self.fingerprint(self.peer_certificate
1200
except (TypeError, gnutls.errors.GNUTLSError), error:
1201
logger.warning(u"Bad certificate: %s", error)
1697
gnutls.errors.GNUTLSError) as error:
1698
logger.warning("Bad certificate: %s", error)
1203
logger.debug(u"Fingerprint: %s", fpr)
1700
logger.debug("Fingerprint: %s", fpr)
1206
1703
client = ProxyClient(child_pipe, fpr,
1207
1704
self.client_address)
1395
1899
use_ipv6: Boolean; to use IPv6 or not
1397
1901
def __init__(self, server_address, RequestHandlerClass,
1398
interface=None, use_ipv6=True):
1902
interface=None, use_ipv6=True, socketfd=None):
1903
"""If socketfd is set, use that file descriptor instead of
1904
creating a new one with socket.socket().
1399
1906
self.interface = interface
1401
1908
self.address_family = socket.AF_INET6
1909
if socketfd is not None:
1910
# Save the file descriptor
1911
self.socketfd = socketfd
1912
# Save the original socket.socket() function
1913
self.socket_socket = socket.socket
1914
# To implement --socket, we monkey patch socket.socket.
1916
# (When socketserver.TCPServer is a new-style class, we
1917
# could make self.socket into a property instead of monkey
1918
# patching socket.socket.)
1920
# Create a one-time-only replacement for socket.socket()
1921
@functools.wraps(socket.socket)
1922
def socket_wrapper(*args, **kwargs):
1923
# Restore original function so subsequent calls are
1925
socket.socket = self.socket_socket
1926
del self.socket_socket
1927
# This time only, return a new socket object from the
1928
# saved file descriptor.
1929
return socket.fromfd(self.socketfd, *args, **kwargs)
1930
# Replace socket.socket() function with wrapper
1931
socket.socket = socket_wrapper
1932
# The socketserver.TCPServer.__init__ will call
1933
# socket.socket(), which might be our replacement,
1934
# socket_wrapper(), if socketfd was set.
1402
1935
socketserver.TCPServer.__init__(self, server_address,
1403
1936
RequestHandlerClass)
1404
1938
def server_bind(self):
1405
1939
"""This overrides the normal server_bind() function
1406
1940
to bind to an interface if one was specified, and also NOT to
1407
1941
bind to an address or port if they were not specified."""
1408
1942
if self.interface is not None:
1409
1943
if SO_BINDTODEVICE is None:
1410
logger.error(u"SO_BINDTODEVICE does not exist;"
1411
u" cannot bind to interface %s",
1944
logger.error("SO_BINDTODEVICE does not exist;"
1945
" cannot bind to interface %s",
1412
1946
self.interface)
1415
1949
self.socket.setsockopt(socket.SOL_SOCKET,
1416
1950
SO_BINDTODEVICE,
1419
except socket.error, error:
1420
if error[0] == errno.EPERM:
1421
logger.error(u"No permission to"
1422
u" bind to interface %s",
1424
elif error[0] == errno.ENOPROTOOPT:
1425
logger.error(u"SO_BINDTODEVICE not available;"
1426
u" cannot bind to interface %s",
1951
str(self.interface + '\0'))
1952
except socket.error as error:
1953
if error.errno == errno.EPERM:
1954
logger.error("No permission to bind to"
1955
" interface %s", self.interface)
1956
elif error.errno == errno.ENOPROTOOPT:
1957
logger.error("SO_BINDTODEVICE not available;"
1958
" cannot bind to interface %s",
1960
elif error.errno == errno.ENODEV:
1961
logger.error("Interface %s does not exist,"
1962
" cannot bind", self.interface)
1430
1965
# Only bind(2) the socket if we really need to.
1431
1966
if self.server_address[0] or self.server_address[1]:
1432
1967
if not self.server_address[0]:
1433
1968
if self.address_family == socket.AF_INET6:
1434
any_address = u"::" # in6addr_any
1969
any_address = "::" # in6addr_any
1436
1971
any_address = socket.INADDR_ANY
1437
1972
self.server_address = (any_address,
1647
2160
##################################################################
1648
2161
# Parsing of options, both command line and config file
1650
parser = optparse.OptionParser(version = "%%prog %s" % version)
1651
parser.add_option("-i", u"--interface", type=u"string",
1652
metavar="IF", help=u"Bind to interface IF")
1653
parser.add_option("-a", u"--address", type=u"string",
1654
help=u"Address to listen for requests on")
1655
parser.add_option("-p", u"--port", type=u"int",
1656
help=u"Port number to receive requests on")
1657
parser.add_option("--check", action=u"store_true",
1658
help=u"Run self-test")
1659
parser.add_option("--debug", action=u"store_true",
1660
help=u"Debug mode; run in foreground and log to"
1662
parser.add_option("--debuglevel", type=u"string", metavar="Level",
1663
help=u"Debug level for stdout output")
1664
parser.add_option("--priority", type=u"string", help=u"GnuTLS"
1665
u" priority string (see GnuTLS documentation)")
1666
parser.add_option("--servicename", type=u"string",
1667
metavar=u"NAME", help=u"Zeroconf service name")
1668
parser.add_option("--configdir", type=u"string",
1669
default=u"/etc/mandos", metavar=u"DIR",
1670
help=u"Directory to search for configuration"
1672
parser.add_option("--no-dbus", action=u"store_false",
1673
dest=u"use_dbus", help=u"Do not provide D-Bus"
1674
u" system bus interface")
1675
parser.add_option("--no-ipv6", action=u"store_false",
1676
dest=u"use_ipv6", help=u"Do not use IPv6")
1677
options = parser.parse_args()[0]
2163
parser = argparse.ArgumentParser()
2164
parser.add_argument("-v", "--version", action="version",
2165
version = "%(prog)s {0}".format(version),
2166
help="show version number and exit")
2167
parser.add_argument("-i", "--interface", metavar="IF",
2168
help="Bind to interface IF")
2169
parser.add_argument("-a", "--address",
2170
help="Address to listen for requests on")
2171
parser.add_argument("-p", "--port", type=int,
2172
help="Port number to receive requests on")
2173
parser.add_argument("--check", action="store_true",
2174
help="Run self-test")
2175
parser.add_argument("--debug", action="store_true",
2176
help="Debug mode; run in foreground and log"
2178
parser.add_argument("--debuglevel", metavar="LEVEL",
2179
help="Debug level for stdout output")
2180
parser.add_argument("--priority", help="GnuTLS"
2181
" priority string (see GnuTLS documentation)")
2182
parser.add_argument("--servicename",
2183
metavar="NAME", help="Zeroconf service name")
2184
parser.add_argument("--configdir",
2185
default="/etc/mandos", metavar="DIR",
2186
help="Directory to search for configuration"
2188
parser.add_argument("--no-dbus", action="store_false",
2189
dest="use_dbus", help="Do not provide D-Bus"
2190
" system bus interface")
2191
parser.add_argument("--no-ipv6", action="store_false",
2192
dest="use_ipv6", help="Do not use IPv6")
2193
parser.add_argument("--no-restore", action="store_false",
2194
dest="restore", help="Do not restore stored"
2196
parser.add_argument("--socket", type=int,
2197
help="Specify a file descriptor to a network"
2198
" socket to use instead of creating one")
2199
parser.add_argument("--statedir", metavar="DIR",
2200
help="Directory to save/restore state in")
2201
parser.add_argument("--foreground", action="store_true",
2202
help="Run in foreground")
2204
options = parser.parse_args()
1679
2206
if options.check:
1723
2264
for option in server_settings.keys():
1724
2265
if type(server_settings[option]) is str:
1725
2266
server_settings[option] = unicode(server_settings[option])
2267
# Debug implies foreground
2268
if server_settings["debug"]:
2269
server_settings["foreground"] = True
1726
2270
# Now we have our good server settings in "server_settings"
1728
2272
##################################################################
1730
2274
# For convenience
1731
debug = server_settings[u"debug"]
1732
debuglevel = server_settings[u"debuglevel"]
1733
use_dbus = server_settings[u"use_dbus"]
1734
use_ipv6 = server_settings[u"use_ipv6"]
1736
if server_settings[u"servicename"] != u"Mandos":
2275
debug = server_settings["debug"]
2276
debuglevel = server_settings["debuglevel"]
2277
use_dbus = server_settings["use_dbus"]
2278
use_ipv6 = server_settings["use_ipv6"]
2279
stored_state_path = os.path.join(server_settings["statedir"],
2281
foreground = server_settings["foreground"]
2284
initlogger(debug, logging.DEBUG)
2289
level = getattr(logging, debuglevel.upper())
2290
initlogger(debug, level)
2292
if server_settings["servicename"] != "Mandos":
1737
2293
syslogger.setFormatter(logging.Formatter
1738
(u'Mandos (%s) [%%(process)d]:'
1739
u' %%(levelname)s: %%(message)s'
1740
% server_settings[u"servicename"]))
2294
('Mandos ({0}) [%(process)d]:'
2295
' %(levelname)s: %(message)s'
2296
.format(server_settings
1742
2299
# Parse config file with clients
1743
client_defaults = { u"timeout": u"1h",
1745
u"checker": u"fping -q -- %%(host)s",
1747
u"approval_delay": u"0s",
1748
u"approval_duration": u"1s",
1750
client_config = configparser.SafeConfigParser(client_defaults)
1751
client_config.read(os.path.join(server_settings[u"configdir"],
2300
client_config = configparser.SafeConfigParser(Client
2302
client_config.read(os.path.join(server_settings["configdir"],
1754
2305
global mandos_dbus_service
1755
2306
mandos_dbus_service = None
1757
tcp_server = MandosServer((server_settings[u"address"],
1758
server_settings[u"port"]),
2308
tcp_server = MandosServer((server_settings["address"],
2309
server_settings["port"]),
1760
interface=(server_settings[u"interface"]
2311
interface=(server_settings["interface"]
1762
2313
use_ipv6=use_ipv6,
1763
2314
gnutls_priority=
1764
server_settings[u"priority"],
1766
pidfilename = u"/var/run/mandos.pid"
1768
pidfile = open(pidfilename, u"w")
1770
logger.error(u"Could not open file %r", pidfilename)
2315
server_settings["priority"],
2317
socketfd=(server_settings["socket"]
2320
pidfilename = "/var/run/mandos.pid"
2323
pidfile = open(pidfilename, "w")
2324
except IOError as e:
2325
logger.error("Could not open file %r", pidfilename,
1773
uid = pwd.getpwnam(u"_mandos").pw_uid
1774
gid = pwd.getpwnam(u"_mandos").pw_gid
2328
for name in ("_mandos", "mandos", "nobody"):
1777
uid = pwd.getpwnam(u"mandos").pw_uid
1778
gid = pwd.getpwnam(u"mandos").pw_gid
2330
uid = pwd.getpwnam(name).pw_uid
2331
gid = pwd.getpwnam(name).pw_gid
1779
2333
except KeyError:
1781
uid = pwd.getpwnam(u"nobody").pw_uid
1782
gid = pwd.getpwnam(u"nobody").pw_gid
1789
except OSError, error:
1790
if error[0] != errno.EPERM:
2341
except OSError as error:
2342
if error.errno != errno.EPERM:
1793
if not debug and not debuglevel:
1794
syslogger.setLevel(logging.WARNING)
1795
console.setLevel(logging.WARNING)
1797
level = getattr(logging, debuglevel.upper())
1798
syslogger.setLevel(level)
1799
console.setLevel(level)
1802
2346
# Enable all possible GnuTLS debugging
1808
2352
@gnutls.library.types.gnutls_log_func
1809
2353
def debug_gnutls(level, string):
1810
logger.debug(u"GnuTLS: %s", string[:-1])
2354
logger.debug("GnuTLS: %s", string[:-1])
1812
2356
(gnutls.library.functions
1813
2357
.gnutls_global_set_log_function(debug_gnutls))
1815
2359
# Redirect stdin so all checkers get /dev/null
1816
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2360
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1817
2361
os.dup2(null, sys.stdin.fileno())
1821
# No console logging
1822
logger.removeHandler(console)
2365
# Need to fork before connecting to D-Bus
2367
# Close all input and output, do double fork, etc.
2370
# multiprocessing will use threads, so before we use gobject we
2371
# need to inform gobject that threads will be used.
2372
gobject.threads_init()
1825
2374
global main_loop
1826
2375
# From the Avahi example code
1827
DBusGMainLoop(set_as_default=True )
2376
DBusGMainLoop(set_as_default=True)
1828
2377
main_loop = gobject.MainLoop()
1829
2378
bus = dbus.SystemBus()
1830
2379
# End of Avahi example code
1833
bus_name = dbus.service.BusName(u"se.bsnet.fukt.Mandos",
2382
bus_name = dbus.service.BusName("se.recompile.Mandos",
1834
2383
bus, do_not_queue=True)
1835
except dbus.exceptions.NameExistsException, e:
1836
logger.error(unicode(e) + u", disabling D-Bus")
2384
old_bus_name = (dbus.service.BusName
2385
("se.bsnet.fukt.Mandos", bus,
2387
except dbus.exceptions.NameExistsException as e:
2388
logger.error("Disabling D-Bus:", exc_info=e)
1837
2389
use_dbus = False
1838
server_settings[u"use_dbus"] = False
2390
server_settings["use_dbus"] = False
1839
2391
tcp_server.use_dbus = False
1840
2392
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1841
service = AvahiService(name = server_settings[u"servicename"],
1842
servicetype = u"_mandos._tcp",
1843
protocol = protocol, bus = bus)
2393
service = AvahiServiceToSyslog(name =
2394
server_settings["servicename"],
2395
servicetype = "_mandos._tcp",
2396
protocol = protocol, bus = bus)
1844
2397
if server_settings["interface"]:
1845
2398
service.interface = (if_nametoindex
1846
(str(server_settings[u"interface"])))
1849
# Close all input and output, do double fork, etc.
2399
(str(server_settings["interface"])))
1852
2401
global multiprocessing_manager
1853
2402
multiprocessing_manager = multiprocessing.Manager()
1855
2404
client_class = Client
1857
2406
client_class = functools.partial(ClientDBus, bus = bus)
1858
def client_config_items(config, section):
1859
special_settings = {
1860
"approved_by_default":
1861
lambda: config.getboolean(section,
1862
"approved_by_default"),
1864
for name, value in config.items(section):
2408
client_settings = Client.config_parser(client_config)
2409
old_client_settings = {}
2412
# Get client data and settings from last running state.
2413
if server_settings["restore"]:
2415
with open(stored_state_path, "rb") as stored_state:
2416
clients_data, old_client_settings = (pickle.load
2418
os.remove(stored_state_path)
2419
except IOError as e:
2420
if e.errno == errno.ENOENT:
2421
logger.warning("Could not load persistent state: {0}"
2422
.format(os.strerror(e.errno)))
2424
logger.critical("Could not load persistent state:",
2427
except EOFError as e:
2428
logger.warning("Could not load persistent state: "
2429
"EOFError:", exc_info=e)
2431
with PGPEngine() as pgp:
2432
for client_name, client in clients_data.iteritems():
2433
# Decide which value to use after restoring saved state.
2434
# We have three different values: Old config file,
2435
# new config file, and saved state.
2436
# New config value takes precedence if it differs from old
2437
# config value, otherwise use saved state.
2438
for name, value in client_settings[client_name].items():
2440
# For each value in new config, check if it
2441
# differs from the old config value (Except for
2442
# the "secret" attribute)
2443
if (name != "secret" and
2444
value != old_client_settings[client_name]
2446
client[name] = value
2450
# Clients who has passed its expire date can still be
2451
# enabled if its last checker was successful. Clients
2452
# whose checker succeeded before we stored its state is
2453
# assumed to have successfully run all checkers during
2455
if client["enabled"]:
2456
if datetime.datetime.utcnow() >= client["expires"]:
2457
if not client["last_checked_ok"]:
2459
"disabling client {0} - Client never "
2460
"performed a successful checker"
2461
.format(client_name))
2462
client["enabled"] = False
2463
elif client["last_checker_status"] != 0:
2465
"disabling client {0} - Client "
2466
"last checker failed with error code {1}"
2467
.format(client_name,
2468
client["last_checker_status"]))
2469
client["enabled"] = False
2471
client["expires"] = (datetime.datetime
2473
+ client["timeout"])
2474
logger.debug("Last checker succeeded,"
2475
" keeping {0} enabled"
2476
.format(client_name))
1866
yield (name, special_settings[name]())
1870
tcp_server.clients.update(set(
1871
client_class(name = section,
1872
config= dict(client_config_items(
1873
client_config, section)))
1874
for section in client_config.sections()))
2478
client["secret"] = (
2479
pgp.decrypt(client["encrypted_secret"],
2480
client_settings[client_name]
2483
# If decryption fails, we use secret from new settings
2484
logger.debug("Failed to decrypt {0} old secret"
2485
.format(client_name))
2486
client["secret"] = (
2487
client_settings[client_name]["secret"])
2489
# Add/remove clients based on new changes made to config
2490
for client_name in (set(old_client_settings)
2491
- set(client_settings)):
2492
del clients_data[client_name]
2493
for client_name in (set(client_settings)
2494
- set(old_client_settings)):
2495
clients_data[client_name] = client_settings[client_name]
2497
# Create all client objects
2498
for client_name, client in clients_data.iteritems():
2499
tcp_server.clients[client_name] = client_class(
2500
name = client_name, settings = client)
1875
2502
if not tcp_server.clients:
1876
logger.warning(u"No clients defined")
1881
pidfile.write(str(pid) + "\n")
2503
logger.warning("No clients defined")
2506
if pidfile is not None:
2510
pidfile.write(str(pid) + "\n".encode("utf-8"))
2512
logger.error("Could not write to file %r with PID %d",
1884
logger.error(u"Could not write to file %r with PID %d",
1887
# "pidfile" was never created
1892
signal.signal(signal.SIGINT, signal.SIG_IGN)
1893
2517
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1894
2518
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
1897
class MandosDBusService(dbus.service.Object):
2521
@alternate_dbus_interfaces({"se.recompile.Mandos":
2522
"se.bsnet.fukt.Mandos"})
2523
class MandosDBusService(DBusObjectWithProperties):
1898
2524
"""A D-Bus proxy object"""
1899
2525
def __init__(self):
1900
dbus.service.Object.__init__(self, bus, u"/")
1901
_interface = u"se.bsnet.fukt.Mandos"
1903
@dbus.service.signal(_interface, signature=u"o")
2526
dbus.service.Object.__init__(self, bus, "/")
2527
_interface = "se.recompile.Mandos"
2529
@dbus_interface_annotations(_interface)
2531
return { "org.freedesktop.DBus.Property"
2532
".EmitsChangedSignal":
2535
@dbus.service.signal(_interface, signature="o")
1904
2536
def ClientAdded(self, objpath):
1908
@dbus.service.signal(_interface, signature=u"ss")
2540
@dbus.service.signal(_interface, signature="ss")
1909
2541
def ClientNotFound(self, fingerprint, address):
1913
@dbus.service.signal(_interface, signature=u"os")
2545
@dbus.service.signal(_interface, signature="os")
1914
2546
def ClientRemoved(self, objpath, name):
1918
@dbus.service.method(_interface, out_signature=u"ao")
2550
@dbus.service.method(_interface, out_signature="ao")
1919
2551
def GetAllClients(self):
1921
2553
return dbus.Array(c.dbus_object_path
1922
for c in tcp_server.clients)
2555
tcp_server.clients.itervalues())
1924
2557
@dbus.service.method(_interface,
1925
out_signature=u"a{oa{sv}}")
2558
out_signature="a{oa{sv}}")
1926
2559
def GetAllClientsWithProperties(self):
1928
2561
return dbus.Dictionary(
1929
((c.dbus_object_path, c.GetAll(u""))
1930
for c in tcp_server.clients),
1931
signature=u"oa{sv}")
2562
((c.dbus_object_path, c.GetAll(""))
2563
for c in tcp_server.clients.itervalues()),
1933
@dbus.service.method(_interface, in_signature=u"o")
2566
@dbus.service.method(_interface, in_signature="o")
1934
2567
def RemoveClient(self, object_path):
1936
for c in tcp_server.clients:
2569
for c in tcp_server.clients.itervalues():
1937
2570
if c.dbus_object_path == object_path:
1938
tcp_server.clients.remove(c)
2571
del tcp_server.clients[c.name]
1939
2572
c.remove_from_connection()
1940
2573
# Don't signal anything except ClientRemoved
1941
2574
c.disable(quiet=True)