248
110
max_renames: integer; maximum number of renames
249
111
rename_count: integer; counter so we only rename after collisions
250
112
a sensible number of times
251
group: D-Bus Entry Group
253
bus: dbus.SystemBus()
256
114
def __init__(self, interface = avahi.IF_UNSPEC, name = None,
257
servicetype = None, port = None, TXT = None,
258
domain = "", host = "", max_renames = 32768,
259
protocol = avahi.PROTO_UNSPEC, bus = None):
115
type = None, port = None, TXT = None, domain = "",
116
host = "", max_renames = 12):
260
117
self.interface = interface
262
self.type = servicetype
264
self.TXT = TXT if TXT is not None else []
265
125
self.domain = domain
267
127
self.rename_count = 0
268
self.max_renames = max_renames
269
self.protocol = protocol
270
self.group = None # our entry group
273
self.entry_group_state_changed_match = None
275
128
def rename(self):
276
129
"""Derived from the Avahi example code"""
277
130
if self.rename_count >= self.max_renames:
278
logger.critical("No suitable Zeroconf service name found"
279
" after %i retries, exiting.",
131
logger.critical(u"No suitable service name found after %i"
132
u" retries, exiting.", rename_count)
281
133
raise AvahiServiceError("Too many renames")
282
self.name = unicode(self.server
283
.GetAlternativeServiceName(self.name))
284
logger.info("Changing Zeroconf service name to %r ...",
134
name = server.GetAlternativeServiceName(name)
135
logger.error(u"Changing name to %r ...", name)
289
except dbus.exceptions.DBusException as error:
290
logger.critical("D-Bus Exception", exc_info=error)
293
138
self.rename_count += 1
295
139
def remove(self):
296
140
"""Derived from the Avahi example code"""
297
if self.entry_group_state_changed_match is not None:
298
self.entry_group_state_changed_match.remove()
299
self.entry_group_state_changed_match = None
300
if self.group is not None:
141
if group is not None:
304
144
"""Derived from the Avahi example code"""
306
if self.group is None:
307
self.group = dbus.Interface(
308
self.bus.get_object(avahi.DBUS_NAME,
309
self.server.EntryGroupNew()),
310
avahi.DBUS_INTERFACE_ENTRY_GROUP)
311
self.entry_group_state_changed_match = (
312
self.group.connect_to_signal(
313
'StateChanged', self.entry_group_state_changed))
314
logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
315
self.name, self.type)
316
self.group.AddService(
319
dbus.UInt32(0), # flags
320
self.name, self.type,
321
self.domain, self.host,
322
dbus.UInt16(self.port),
323
avahi.string_array_to_txt_array(self.TXT))
326
def entry_group_state_changed(self, state, error):
327
"""Derived from the Avahi example code"""
328
logger.debug("Avahi entry group state change: %i", state)
330
if state == avahi.ENTRY_GROUP_ESTABLISHED:
331
logger.debug("Zeroconf service established.")
332
elif state == avahi.ENTRY_GROUP_COLLISION:
333
logger.info("Zeroconf service name collision.")
335
elif state == avahi.ENTRY_GROUP_FAILURE:
336
logger.critical("Avahi: Error in group state changed %s",
338
raise AvahiGroupError("State changed: {0!s}"
342
"""Derived from the Avahi example code"""
343
if self.group is not None:
346
except (dbus.exceptions.UnknownMethodException,
347
dbus.exceptions.DBusException):
352
def server_state_changed(self, state, error=None):
353
"""Derived from the Avahi example code"""
354
logger.debug("Avahi server state change: %i", state)
355
bad_states = { avahi.SERVER_INVALID:
356
"Zeroconf server invalid",
357
avahi.SERVER_REGISTERING: None,
358
avahi.SERVER_COLLISION:
359
"Zeroconf server name collision",
360
avahi.SERVER_FAILURE:
361
"Zeroconf server failure" }
362
if state in bad_states:
363
if bad_states[state] is not None:
365
logger.error(bad_states[state])
367
logger.error(bad_states[state] + ": %r", error)
369
elif state == avahi.SERVER_RUNNING:
373
logger.debug("Unknown state: %r", state)
375
logger.debug("Unknown state: %r: %r", state, error)
378
"""Derived from the Avahi example code"""
379
if self.server is None:
380
self.server = dbus.Interface(
381
self.bus.get_object(avahi.DBUS_NAME,
382
avahi.DBUS_PATH_SERVER,
383
follow_name_owner_changes=True),
384
avahi.DBUS_INTERFACE_SERVER)
385
self.server.connect_to_signal("StateChanged",
386
self.server_state_changed)
387
self.server_state_changed(self.server.GetState())
390
class AvahiServiceToSyslog(AvahiService):
392
"""Add the new name to the syslog messages"""
393
ret = AvahiService.rename(self)
394
syslogger.setFormatter(logging.Formatter
395
('Mandos ({0}) [%(process)d]:'
396
' %(levelname)s: %(message)s'
401
def timedelta_to_milliseconds(td):
402
"Convert a datetime.timedelta() to milliseconds"
403
return ((td.days * 24 * 60 * 60 * 1000)
404
+ (td.seconds * 1000)
405
+ (td.microseconds // 1000))
147
group = dbus.Interface\
148
(bus.get_object(avahi.DBUS_NAME,
149
server.EntryGroupNew()),
150
avahi.DBUS_INTERFACE_ENTRY_GROUP)
151
group.connect_to_signal('StateChanged',
152
entry_group_state_changed)
153
logger.debug(u"Adding service '%s' of type '%s' ...",
154
service.name, service.type)
156
self.interface, # interface
157
avahi.PROTO_INET6, # protocol
158
dbus.UInt32(0), # flags
159
self.name, self.type,
160
self.domain, self.host,
161
dbus.UInt16(self.port),
162
avahi.string_array_to_txt_array(self.TXT))
165
# From the Avahi example code:
166
group = None # our entry group
167
# End of Avahi example code
408
170
class Client(object):
409
171
"""A representation of a client host served by this server.
412
approved: bool(); 'None' if not yet approved/disapproved
413
approval_delay: datetime.timedelta(); Time to wait for approval
414
approval_duration: datetime.timedelta(); Duration of one approval
415
checker: subprocess.Popen(); a running checker process used
416
to see if the client lives.
417
'None' if no process is running.
418
checker_callback_tag: a gobject event source tag, or None
419
checker_command: string; External command which is run to check
420
if client lives. %() expansions are done at
173
name: string; from the config file, used in log messages
174
fingerprint: string (40 or 32 hexadecimal digits); used to
175
uniquely identify the client
176
secret: bytestring; sent verbatim (over TLS) to client
177
fqdn: string (FQDN); available for use by the checker command
178
created: datetime.datetime(); object creation, not client host
179
last_checked_ok: datetime.datetime() or None if not yet checked OK
180
timeout: datetime.timedelta(); How long from last_checked_ok
181
until this client is invalid
182
interval: datetime.timedelta(); How often to start a new checker
183
stop_hook: If set, called by stop() as stop_hook(self)
184
checker: subprocess.Popen(); a running checker process used
185
to see if the client lives.
186
'None' if no process is running.
187
checker_initiator_tag: a gobject event source tag, or None
188
stop_initiator_tag: - '' -
189
checker_callback_tag: - '' -
190
checker_command: string; External command which is run to check if
191
client lives. %() expansions are done at
421
192
runtime with vars(self) as dict, so that for
422
193
instance %(name)s can be used in the command.
423
checker_initiator_tag: a gobject event source tag, or None
424
created: datetime.datetime(); (UTC) object creation
425
client_structure: Object describing what attributes a client has
426
and is used for storing the client at exit
427
current_checker_command: string; current running checker_command
428
disable_initiator_tag: a gobject event source tag, or None
430
fingerprint: string (40 or 32 hexadecimal digits); used to
431
uniquely identify the client
432
host: string; available for use by the checker command
433
interval: datetime.timedelta(); How often to start a new checker
434
last_approval_request: datetime.datetime(); (UTC) or None
435
last_checked_ok: datetime.datetime(); (UTC) or None
436
last_checker_status: integer between 0 and 255 reflecting exit
437
status of last checker. -1 reflects crashed
438
checker, -2 means no checker completed yet.
439
last_enabled: datetime.datetime(); (UTC) or None
440
name: string; from the config file, used in log messages and
442
secret: bytestring; sent verbatim (over TLS) to client
443
timeout: datetime.timedelta(); How long from last_checked_ok
444
until this client is disabled
445
extended_timeout: extra long timeout when secret has been sent
446
runtime_expansions: Allowed attributes for runtime expansion.
447
expires: datetime.datetime(); time (UTC) when a client will be
449
server_settings: The server_settings dict from main()
195
_timeout: Real variable for 'timeout'
196
_interval: Real variable for 'interval'
197
_timeout_milliseconds: Used when calling gobject.timeout_add()
198
_interval_milliseconds: - '' -
452
runtime_expansions = ("approval_delay", "approval_duration",
453
"created", "enabled", "expires",
454
"fingerprint", "host", "interval",
455
"last_approval_request", "last_checked_ok",
456
"last_enabled", "name", "timeout")
457
client_defaults = { "timeout": "PT5M",
458
"extended_timeout": "PT15M",
460
"checker": "fping -q -- %%(host)s",
462
"approval_delay": "PT0S",
463
"approval_duration": "PT1S",
464
"approved_by_default": "True",
468
def timeout_milliseconds(self):
469
"Return the 'timeout' attribute in milliseconds"
470
return timedelta_to_milliseconds(self.timeout)
472
def extended_timeout_milliseconds(self):
473
"Return the 'extended_timeout' attribute in milliseconds"
474
return timedelta_to_milliseconds(self.extended_timeout)
476
def interval_milliseconds(self):
477
"Return the 'interval' attribute in milliseconds"
478
return timedelta_to_milliseconds(self.interval)
480
def approval_delay_milliseconds(self):
481
return timedelta_to_milliseconds(self.approval_delay)
484
def config_parser(config):
485
"""Construct a new dict of client settings of this form:
486
{ client_name: {setting_name: value, ...}, ...}
487
with exceptions for any special settings as defined above.
488
NOTE: Must be a pure function. Must return the same result
489
value given the same arguments.
492
for client_name in config.sections():
493
section = dict(config.items(client_name))
494
client = settings[client_name] = {}
496
client["host"] = section["host"]
497
# Reformat values from string types to Python types
498
client["approved_by_default"] = config.getboolean(
499
client_name, "approved_by_default")
500
client["enabled"] = config.getboolean(client_name,
503
client["fingerprint"] = (section["fingerprint"].upper()
505
if "secret" in section:
506
client["secret"] = section["secret"].decode("base64")
507
elif "secfile" in section:
508
with open(os.path.expanduser(os.path.expandvars
509
(section["secfile"])),
511
client["secret"] = secfile.read()
513
raise TypeError("No secret or secfile for section {0}"
515
client["timeout"] = string_to_delta(section["timeout"])
516
client["extended_timeout"] = string_to_delta(
517
section["extended_timeout"])
518
client["interval"] = string_to_delta(section["interval"])
519
client["approval_delay"] = string_to_delta(
520
section["approval_delay"])
521
client["approval_duration"] = string_to_delta(
522
section["approval_duration"])
523
client["checker_command"] = section["checker"]
524
client["last_approval_request"] = None
525
client["last_checked_ok"] = None
526
client["last_checker_status"] = -2
530
def __init__(self, settings, name = None, server_settings=None):
200
def _set_timeout(self, timeout):
201
"Setter function for 'timeout' attribute"
202
self._timeout = timeout
203
self._timeout_milliseconds = ((self.timeout.days
204
* 24 * 60 * 60 * 1000)
205
+ (self.timeout.seconds * 1000)
206
+ (self.timeout.microseconds
208
timeout = property(lambda self: self._timeout,
211
def _set_interval(self, interval):
212
"Setter function for 'interval' attribute"
213
self._interval = interval
214
self._interval_milliseconds = ((self.interval.days
215
* 24 * 60 * 60 * 1000)
216
+ (self.interval.seconds
218
+ (self.interval.microseconds
220
interval = property(lambda self: self._interval,
223
def __init__(self, name = None, stop_hook=None, config={}):
224
"""Note: the 'checker' key in 'config' sets the
225
'checker_command' attribute and *not* the 'checker'
532
if server_settings is None:
534
self.server_settings = server_settings
535
# adding all client settings
536
for setting, value in settings.iteritems():
537
setattr(self, setting, value)
540
if not hasattr(self, "last_enabled"):
541
self.last_enabled = datetime.datetime.utcnow()
542
if not hasattr(self, "expires"):
543
self.expires = (datetime.datetime.utcnow()
546
self.last_enabled = None
549
logger.debug("Creating client %r", self.name)
228
logger.debug(u"Creating client %r", self.name)
550
229
# Uppercase and remove spaces from fingerprint for later
551
230
# comparison purposes with return value from the fingerprint()
553
logger.debug(" Fingerprint: %s", self.fingerprint)
554
self.created = settings.get("created",
555
datetime.datetime.utcnow())
557
# attributes specific for this server instance
232
self.fingerprint = config["fingerprint"].upper()\
234
logger.debug(u" Fingerprint: %s", self.fingerprint)
235
if "secret" in config:
236
self.secret = config["secret"].decode(u"base64")
237
elif "secfile" in config:
238
sf = open(config["secfile"])
239
self.secret = sf.read()
242
raise TypeError(u"No secret or secfile for client %s"
244
self.fqdn = config.get("fqdn", "")
245
self.created = datetime.datetime.now()
246
self.last_checked_ok = None
247
self.timeout = string_to_delta(config["timeout"])
248
self.interval = string_to_delta(config["interval"])
249
self.stop_hook = stop_hook
558
250
self.checker = None
559
251
self.checker_initiator_tag = None
560
self.disable_initiator_tag = None
252
self.stop_initiator_tag = None
561
253
self.checker_callback_tag = None
562
self.current_checker_command = None
564
self.approvals_pending = 0
565
self.changedstate = (multiprocessing_manager
566
.Condition(multiprocessing_manager
568
self.client_structure = [attr for attr in
569
self.__dict__.iterkeys()
570
if not attr.startswith("_")]
571
self.client_structure.append("client_structure")
573
for name, t in inspect.getmembers(type(self),
577
if not name.startswith("_"):
578
self.client_structure.append(name)
580
# Send notice to process children that client state has changed
581
def send_changedstate(self):
582
with self.changedstate:
583
self.changedstate.notify_all()
254
self.check_command = config["checker"]
586
256
"""Start this client's checker and timeout hooks"""
587
if getattr(self, "enabled", False):
590
self.expires = datetime.datetime.utcnow() + self.timeout
592
self.last_enabled = datetime.datetime.utcnow()
594
self.send_changedstate()
596
def disable(self, quiet=True):
597
"""Disable this client."""
598
if not getattr(self, "enabled", False):
601
logger.info("Disabling client %s", self.name)
602
if getattr(self, "disable_initiator_tag", None) is not None:
603
gobject.source_remove(self.disable_initiator_tag)
604
self.disable_initiator_tag = None
606
if getattr(self, "checker_initiator_tag", None) is not None:
607
gobject.source_remove(self.checker_initiator_tag)
608
self.checker_initiator_tag = None
612
self.send_changedstate()
613
# Do not run this again if called by a gobject.timeout_add
619
def init_checker(self):
620
257
# Schedule a new checker to be started an 'interval' from now,
621
258
# and every interval from then on.
622
if self.checker_initiator_tag is not None:
623
gobject.source_remove(self.checker_initiator_tag)
624
self.checker_initiator_tag = (gobject.timeout_add
625
(self.interval_milliseconds(),
627
# Schedule a disable() when 'timeout' has passed
628
if self.disable_initiator_tag is not None:
629
gobject.source_remove(self.disable_initiator_tag)
630
self.disable_initiator_tag = (gobject.timeout_add
631
(self.timeout_milliseconds(),
259
self.checker_initiator_tag = gobject.timeout_add\
260
(self._interval_milliseconds,
633
262
# Also start a new checker *right now*.
634
263
self.start_checker()
636
def checker_callback(self, pid, condition, command):
264
# Schedule a stop() when 'timeout' has passed
265
self.stop_initiator_tag = gobject.timeout_add\
266
(self._timeout_milliseconds,
270
The possibility that a client might be restarted is left open,
271
but not currently used."""
272
# If this client doesn't have a secret, it is already stopped.
274
logger.info(u"Stopping client %s", self.name)
278
if getattr(self, "stop_initiator_tag", False):
279
gobject.source_remove(self.stop_initiator_tag)
280
self.stop_initiator_tag = None
281
if getattr(self, "checker_initiator_tag", False):
282
gobject.source_remove(self.checker_initiator_tag)
283
self.checker_initiator_tag = None
287
# Do not run this again if called by a gobject.timeout_add
290
self.stop_hook = None
292
def checker_callback(self, pid, condition):
637
293
"""The checker has completed, so take appropriate actions."""
294
now = datetime.datetime.now()
638
295
self.checker_callback_tag = None
639
296
self.checker = None
640
if os.WIFEXITED(condition):
641
self.last_checker_status = os.WEXITSTATUS(condition)
642
if self.last_checker_status == 0:
643
logger.info("Checker for %(name)s succeeded",
647
logger.info("Checker for %(name)s failed",
650
self.last_checker_status = -1
651
logger.warning("Checker for %(name)s crashed?",
297
if os.WIFEXITED(condition) \
298
and (os.WEXITSTATUS(condition) == 0):
299
logger.info(u"Checker for %(name)s succeeded",
301
self.last_checked_ok = now
302
gobject.source_remove(self.stop_initiator_tag)
303
self.stop_initiator_tag = gobject.timeout_add\
304
(self._timeout_milliseconds,
306
elif not os.WIFEXITED(condition):
307
logger.warning(u"Checker for %(name)s crashed?",
654
def checked_ok(self):
655
"""Assert that the client has been seen, alive and well."""
656
self.last_checked_ok = datetime.datetime.utcnow()
657
self.last_checker_status = 0
660
def bump_timeout(self, timeout=None):
661
"""Bump up the timeout for this client."""
663
timeout = self.timeout
664
if self.disable_initiator_tag is not None:
665
gobject.source_remove(self.disable_initiator_tag)
666
self.disable_initiator_tag = None
667
if getattr(self, "enabled", False):
668
self.disable_initiator_tag = (gobject.timeout_add
669
(timedelta_to_milliseconds
670
(timeout), self.disable))
671
self.expires = datetime.datetime.utcnow() + timeout
673
def need_approval(self):
674
self.last_approval_request = datetime.datetime.utcnow()
310
logger.info(u"Checker for %(name)s failed",
676
312
def start_checker(self):
677
313
"""Start a new checker subprocess if one is not running.
679
314
If a checker already exists, leave it running and do
681
316
# The reason for not killing a running checker is that if we
682
# did that, and if a checker (for some reason) started running
683
# slowly and taking more than 'interval' time, then the client
684
# would inevitably timeout, since no checker would get a
685
# chance to run to completion. If we instead leave running
317
# did that, then if a checker (for some reason) started
318
# running slowly and taking more than 'interval' time, the
319
# client would inevitably timeout, since no checker would get
320
# a chance to run to completion. If we instead leave running
686
321
# checkers alone, the checker would have to take more time
687
# than 'timeout' for the client to be disabled, which is as it
690
# If a checker exists, make sure it is not a zombie
692
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
693
except AttributeError:
695
except OSError as error:
696
if error.errno != errno.ECHILD:
700
logger.warning("Checker was a zombie")
701
gobject.source_remove(self.checker_callback_tag)
702
self.checker_callback(pid, status,
703
self.current_checker_command)
704
# Start a new checker if needed
322
# than 'timeout' for the client to be declared invalid, which
323
# is as it should be.
705
324
if self.checker is None:
706
# Escape attributes for the shell
707
escaped_attrs = dict(
708
(attr, re.escape(unicode(getattr(self, attr))))
710
self.runtime_expansions)
712
command = self.checker_command % escaped_attrs
713
except TypeError as error:
714
logger.error('Could not format string "%s"',
715
self.checker_command, exc_info=error)
716
return True # Try again later
717
self.current_checker_command = command
719
logger.info("Starting checker %r for %s",
326
# In case check_command has exactly one % operator
327
command = self.check_command % self.fqdn
329
# Escape attributes for the shell
330
escaped_attrs = dict((key, re.escape(str(val)))
332
vars(self).iteritems())
334
command = self.check_command % escaped_attrs
335
except TypeError, error:
336
logger.error(u'Could not format string "%s":'
337
u' %s', self.check_command, error)
338
return True # Try again later
340
logger.info(u"Starting checker %r for %s",
720
341
command, self.name)
721
# We don't need to redirect stdout and stderr, since
722
# in normal mode, that is already done by daemon(),
723
# and in debug mode we don't want to. (Stdin is
724
# always replaced by /dev/null.)
725
# The exception is when not debugging but nevertheless
726
# running in the foreground; use the previously
729
if (not self.server_settings["debug"]
730
and self.server_settings["foreground"]):
731
popen_args.update({"stdout": wnull,
733
342
self.checker = subprocess.Popen(command,
737
except OSError as error:
738
logger.error("Failed to start subprocess",
741
self.checker_callback_tag = (gobject.child_watch_add
743
self.checker_callback,
745
# The checker may have completed before the gobject
746
# watch was added. Check for this.
748
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
749
except OSError as error:
750
if error.errno == errno.ECHILD:
751
# This should never happen
752
logger.error("Child process vanished",
757
gobject.source_remove(self.checker_callback_tag)
758
self.checker_callback(pid, status, command)
345
self.checker_callback_tag = gobject.child_watch_add\
347
self.checker_callback)
348
except subprocess.OSError, error:
349
logger.error(u"Failed to start subprocess: %s",
759
351
# Re-run this periodically if run by gobject.timeout_add
762
353
def stop_checker(self):
763
354
"""Force the checker process, if any, to stop."""
764
355
if self.checker_callback_tag:
769
360
logger.debug("Stopping checker for %(name)s", vars(self))
771
self.checker.terminate()
362
os.kill(self.checker.pid, signal.SIGTERM)
773
364
#if self.checker.poll() is None:
774
# self.checker.kill()
775
except OSError as error:
365
# os.kill(self.checker.pid, signal.SIGKILL)
366
except OSError, error:
776
367
if error.errno != errno.ESRCH: # No such process
778
369
self.checker = None
781
def dbus_service_property(dbus_interface, signature="v",
782
access="readwrite", byte_arrays=False):
783
"""Decorators for marking methods of a DBusObjectWithProperties to
784
become properties on the D-Bus.
786
The decorated method will be called with no arguments by "Get"
787
and with one argument by "Set".
789
The parameters, where they are supported, are the same as
790
dbus.service.method, except there is only "signature", since the
791
type from Get() and the type sent to Set() is the same.
793
# Encoding deeply encoded byte arrays is not supported yet by the
794
# "Set" method, so we fail early here:
795
if byte_arrays and signature != "ay":
796
raise ValueError("Byte arrays not supported for non-'ay'"
797
" signature {0!r}".format(signature))
799
func._dbus_is_property = True
800
func._dbus_interface = dbus_interface
801
func._dbus_signature = signature
802
func._dbus_access = access
803
func._dbus_name = func.__name__
804
if func._dbus_name.endswith("_dbus_property"):
805
func._dbus_name = func._dbus_name[:-14]
806
func._dbus_get_args_options = {'byte_arrays': byte_arrays }
811
def dbus_interface_annotations(dbus_interface):
812
"""Decorator for marking functions returning interface annotations
816
@dbus_interface_annotations("org.example.Interface")
817
def _foo(self): # Function name does not matter
818
return {"org.freedesktop.DBus.Deprecated": "true",
819
"org.freedesktop.DBus.Property.EmitsChangedSignal":
823
func._dbus_is_interface = True
824
func._dbus_interface = dbus_interface
825
func._dbus_name = dbus_interface
830
def dbus_annotations(annotations):
831
"""Decorator to annotate D-Bus methods, signals or properties
834
@dbus_service_property("org.example.Interface", signature="b",
836
@dbus_annotations({{"org.freedesktop.DBus.Deprecated": "true",
837
"org.freedesktop.DBus.Property."
838
"EmitsChangedSignal": "false"})
839
def Property_dbus_property(self):
840
return dbus.Boolean(False)
843
func._dbus_annotations = annotations
848
class DBusPropertyException(dbus.exceptions.DBusException):
849
"""A base class for D-Bus property-related exceptions
851
def __unicode__(self):
852
return unicode(str(self))
855
class DBusPropertyAccessException(DBusPropertyException):
856
"""A property's access permissions disallows an operation.
861
class DBusPropertyNotFound(DBusPropertyException):
862
"""An attempt was made to access a non-existing property.
867
class DBusObjectWithProperties(dbus.service.Object):
868
"""A D-Bus object with properties.
870
Classes inheriting from this can use the dbus_service_property
871
decorator to expose methods as D-Bus properties. It exposes the
872
standard Get(), Set(), and GetAll() methods on the D-Bus.
876
def _is_dbus_thing(thing):
877
"""Returns a function testing if an attribute is a D-Bus thing
879
If called like _is_dbus_thing("method") it returns a function
880
suitable for use as predicate to inspect.getmembers().
882
return lambda obj: getattr(obj, "_dbus_is_{0}".format(thing),
885
def _get_all_dbus_things(self, thing):
886
"""Returns a generator of (name, attribute) pairs
888
return ((getattr(athing.__get__(self), "_dbus_name",
890
athing.__get__(self))
891
for cls in self.__class__.__mro__
893
inspect.getmembers(cls,
894
self._is_dbus_thing(thing)))
896
def _get_dbus_property(self, interface_name, property_name):
897
"""Returns a bound method if one exists which is a D-Bus
898
property with the specified name and interface.
900
for cls in self.__class__.__mro__:
901
for name, value in (inspect.getmembers
903
self._is_dbus_thing("property"))):
904
if (value._dbus_name == property_name
905
and value._dbus_interface == interface_name):
906
return value.__get__(self)
909
raise DBusPropertyNotFound(self.dbus_object_path + ":"
910
+ interface_name + "."
913
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
915
def Get(self, interface_name, property_name):
916
"""Standard D-Bus property Get() method, see D-Bus standard.
918
prop = self._get_dbus_property(interface_name, property_name)
919
if prop._dbus_access == "write":
920
raise DBusPropertyAccessException(property_name)
922
if not hasattr(value, "variant_level"):
924
return type(value)(value, variant_level=value.variant_level+1)
926
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
927
def Set(self, interface_name, property_name, value):
928
"""Standard D-Bus property Set() method, see D-Bus standard.
930
prop = self._get_dbus_property(interface_name, property_name)
931
if prop._dbus_access == "read":
932
raise DBusPropertyAccessException(property_name)
933
if prop._dbus_get_args_options["byte_arrays"]:
934
# The byte_arrays option is not supported yet on
935
# signatures other than "ay".
936
if prop._dbus_signature != "ay":
937
raise ValueError("Byte arrays not supported for non-"
938
"'ay' signature {0!r}"
939
.format(prop._dbus_signature))
940
value = dbus.ByteArray(b''.join(chr(byte)
944
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
945
out_signature="a{sv}")
946
def GetAll(self, interface_name):
947
"""Standard D-Bus property GetAll() method, see D-Bus
950
Note: Will not include properties with access="write".
953
for name, prop in self._get_all_dbus_things("property"):
955
and interface_name != prop._dbus_interface):
956
# Interface non-empty but did not match
958
# Ignore write-only properties
959
if prop._dbus_access == "write":
962
if not hasattr(value, "variant_level"):
963
properties[name] = value
965
properties[name] = type(value)(value, variant_level=
966
value.variant_level+1)
967
return dbus.Dictionary(properties, signature="sv")
969
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
971
path_keyword='object_path',
972
connection_keyword='connection')
973
def Introspect(self, object_path, connection):
974
"""Overloading of standard D-Bus method.
976
Inserts property tags and interface annotation tags.
978
xmlstring = dbus.service.Object.Introspect(self, object_path,
981
document = xml.dom.minidom.parseString(xmlstring)
982
def make_tag(document, name, prop):
983
e = document.createElement("property")
984
e.setAttribute("name", name)
985
e.setAttribute("type", prop._dbus_signature)
986
e.setAttribute("access", prop._dbus_access)
988
for if_tag in document.getElementsByTagName("interface"):
990
for tag in (make_tag(document, name, prop)
992
in self._get_all_dbus_things("property")
993
if prop._dbus_interface
994
== if_tag.getAttribute("name")):
995
if_tag.appendChild(tag)
996
# Add annotation tags
997
for typ in ("method", "signal", "property"):
998
for tag in if_tag.getElementsByTagName(typ):
1000
for name, prop in (self.
1001
_get_all_dbus_things(typ)):
1002
if (name == tag.getAttribute("name")
1003
and prop._dbus_interface
1004
== if_tag.getAttribute("name")):
1005
annots.update(getattr
1007
"_dbus_annotations",
1009
for name, value in annots.iteritems():
1010
ann_tag = document.createElement(
1012
ann_tag.setAttribute("name", name)
1013
ann_tag.setAttribute("value", value)
1014
tag.appendChild(ann_tag)
1015
# Add interface annotation tags
1016
for annotation, value in dict(
1017
itertools.chain.from_iterable(
1018
annotations().iteritems()
1019
for name, annotations in
1020
self._get_all_dbus_things("interface")
1021
if name == if_tag.getAttribute("name")
1023
ann_tag = document.createElement("annotation")
1024
ann_tag.setAttribute("name", annotation)
1025
ann_tag.setAttribute("value", value)
1026
if_tag.appendChild(ann_tag)
1027
# Add the names to the return values for the
1028
# "org.freedesktop.DBus.Properties" methods
1029
if (if_tag.getAttribute("name")
1030
== "org.freedesktop.DBus.Properties"):
1031
for cn in if_tag.getElementsByTagName("method"):
1032
if cn.getAttribute("name") == "Get":
1033
for arg in cn.getElementsByTagName("arg"):
1034
if (arg.getAttribute("direction")
1036
arg.setAttribute("name", "value")
1037
elif cn.getAttribute("name") == "GetAll":
1038
for arg in cn.getElementsByTagName("arg"):
1039
if (arg.getAttribute("direction")
1041
arg.setAttribute("name", "props")
1042
xmlstring = document.toxml("utf-8")
1044
except (AttributeError, xml.dom.DOMException,
1045
xml.parsers.expat.ExpatError) as error:
1046
logger.error("Failed to override Introspection method",
1051
def datetime_to_dbus(dt, variant_level=0):
1052
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1054
return dbus.String("", variant_level = variant_level)
1055
return dbus.String(dt.isoformat(),
1056
variant_level=variant_level)
1059
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1060
"""A class decorator; applied to a subclass of
1061
dbus.service.Object, it will add alternate D-Bus attributes with
1062
interface names according to the "alt_interface_names" mapping.
1065
@alternate_dbus_interfaces({"org.example.Interface":
1066
"net.example.AlternateInterface"})
1067
class SampleDBusObject(dbus.service.Object):
1068
@dbus.service.method("org.example.Interface")
1069
def SampleDBusMethod():
1072
The above "SampleDBusMethod" on "SampleDBusObject" will be
1073
reachable via two interfaces: "org.example.Interface" and
1074
"net.example.AlternateInterface", the latter of which will have
1075
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1076
"true", unless "deprecate" is passed with a False value.
1078
This works for methods and signals, and also for D-Bus properties
1079
(from DBusObjectWithProperties) and interfaces (from the
1080
dbus_interface_annotations decorator).
1083
for orig_interface_name, alt_interface_name in (
1084
alt_interface_names.iteritems()):
1086
interface_names = set()
1087
# Go though all attributes of the class
1088
for attrname, attribute in inspect.getmembers(cls):
1089
# Ignore non-D-Bus attributes, and D-Bus attributes
1090
# with the wrong interface name
1091
if (not hasattr(attribute, "_dbus_interface")
1092
or not attribute._dbus_interface
1093
.startswith(orig_interface_name)):
1095
# Create an alternate D-Bus interface name based on
1097
alt_interface = (attribute._dbus_interface
1098
.replace(orig_interface_name,
1099
alt_interface_name))
1100
interface_names.add(alt_interface)
1101
# Is this a D-Bus signal?
1102
if getattr(attribute, "_dbus_is_signal", False):
1103
# Extract the original non-method undecorated
1104
# function by black magic
1105
nonmethod_func = (dict(
1106
zip(attribute.func_code.co_freevars,
1107
attribute.__closure__))["func"]
1109
# Create a new, but exactly alike, function
1110
# object, and decorate it to be a new D-Bus signal
1111
# with the alternate D-Bus interface name
1112
new_function = (dbus.service.signal
1114
attribute._dbus_signature)
1115
(types.FunctionType(
1116
nonmethod_func.func_code,
1117
nonmethod_func.func_globals,
1118
nonmethod_func.func_name,
1119
nonmethod_func.func_defaults,
1120
nonmethod_func.func_closure)))
1121
# Copy annotations, if any
1123
new_function._dbus_annotations = (
1124
dict(attribute._dbus_annotations))
1125
except AttributeError:
1127
# Define a creator of a function to call both the
1128
# original and alternate functions, so both the
1129
# original and alternate signals gets sent when
1130
# the function is called
1131
def fixscope(func1, func2):
1132
"""This function is a scope container to pass
1133
func1 and func2 to the "call_both" function
1134
outside of its arguments"""
1135
def call_both(*args, **kwargs):
1136
"""This function will emit two D-Bus
1137
signals by calling func1 and func2"""
1138
func1(*args, **kwargs)
1139
func2(*args, **kwargs)
1141
# Create the "call_both" function and add it to
1143
attr[attrname] = fixscope(attribute, new_function)
1144
# Is this a D-Bus method?
1145
elif getattr(attribute, "_dbus_is_method", False):
1146
# Create a new, but exactly alike, function
1147
# object. Decorate it to be a new D-Bus method
1148
# with the alternate D-Bus interface name. Add it
1150
attr[attrname] = (dbus.service.method
1152
attribute._dbus_in_signature,
1153
attribute._dbus_out_signature)
1155
(attribute.func_code,
1156
attribute.func_globals,
1157
attribute.func_name,
1158
attribute.func_defaults,
1159
attribute.func_closure)))
1160
# Copy annotations, if any
1162
attr[attrname]._dbus_annotations = (
1163
dict(attribute._dbus_annotations))
1164
except AttributeError:
1166
# Is this a D-Bus property?
1167
elif getattr(attribute, "_dbus_is_property", False):
1168
# Create a new, but exactly alike, function
1169
# object, and decorate it to be a new D-Bus
1170
# property with the alternate D-Bus interface
1171
# name. Add it to the class.
1172
attr[attrname] = (dbus_service_property
1174
attribute._dbus_signature,
1175
attribute._dbus_access,
1177
._dbus_get_args_options
1180
(attribute.func_code,
1181
attribute.func_globals,
1182
attribute.func_name,
1183
attribute.func_defaults,
1184
attribute.func_closure)))
1185
# Copy annotations, if any
1187
attr[attrname]._dbus_annotations = (
1188
dict(attribute._dbus_annotations))
1189
except AttributeError:
1191
# Is this a D-Bus interface?
1192
elif getattr(attribute, "_dbus_is_interface", False):
1193
# Create a new, but exactly alike, function
1194
# object. Decorate it to be a new D-Bus interface
1195
# with the alternate D-Bus interface name. Add it
1197
attr[attrname] = (dbus_interface_annotations
1200
(attribute.func_code,
1201
attribute.func_globals,
1202
attribute.func_name,
1203
attribute.func_defaults,
1204
attribute.func_closure)))
1206
# Deprecate all alternate interfaces
1207
iname="_AlternateDBusNames_interface_annotation{0}"
1208
for interface_name in interface_names:
1209
@dbus_interface_annotations(interface_name)
1211
return { "org.freedesktop.DBus.Deprecated":
1213
# Find an unused name
1214
for aname in (iname.format(i)
1215
for i in itertools.count()):
1216
if aname not in attr:
1220
# Replace the class with a new subclass of it with
1221
# methods, signals, etc. as created above.
1222
cls = type(b"{0}Alternate".format(cls.__name__),
1228
@alternate_dbus_interfaces({"se.recompile.Mandos":
1229
"se.bsnet.fukt.Mandos"})
1230
class ClientDBus(Client, DBusObjectWithProperties):
1231
"""A Client class using D-Bus
1234
dbus_object_path: dbus.ObjectPath
1235
bus: dbus.SystemBus()
1238
runtime_expansions = (Client.runtime_expansions
1239
+ ("dbus_object_path",))
1241
# dbus.service.Object doesn't use super(), so we can't either.
1243
def __init__(self, bus = None, *args, **kwargs):
1245
Client.__init__(self, *args, **kwargs)
1246
# Only now, when this client is initialized, can it show up on
1248
client_object_name = unicode(self.name).translate(
1249
{ord("."): ord("_"),
1250
ord("-"): ord("_")})
1251
self.dbus_object_path = (dbus.ObjectPath
1252
("/clients/" + client_object_name))
1253
DBusObjectWithProperties.__init__(self, self.bus,
1254
self.dbus_object_path)
1256
def notifychangeproperty(transform_func,
1257
dbus_name, type_func=lambda x: x,
1259
""" Modify a variable so that it's a property which announces
1260
its changes to DBus.
1262
transform_fun: Function that takes a value and a variant_level
1263
and transforms it to a D-Bus type.
1264
dbus_name: D-Bus name of the variable
1265
type_func: Function that transform the value before sending it
1266
to the D-Bus. Default: no transform
1267
variant_level: D-Bus variant level. Default: 1
1269
attrname = "_{0}".format(dbus_name)
1270
def setter(self, value):
1271
if hasattr(self, "dbus_object_path"):
1272
if (not hasattr(self, attrname) or
1273
type_func(getattr(self, attrname, None))
1274
!= type_func(value)):
1275
dbus_value = transform_func(type_func(value),
1278
self.PropertyChanged(dbus.String(dbus_name),
1280
setattr(self, attrname, value)
1282
return property(lambda self: getattr(self, attrname), setter)
1284
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1285
approvals_pending = notifychangeproperty(dbus.Boolean,
1288
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1289
last_enabled = notifychangeproperty(datetime_to_dbus,
1291
checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1292
type_func = lambda checker:
1293
checker is not None)
1294
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1296
last_checker_status = notifychangeproperty(dbus.Int16,
1297
"LastCheckerStatus")
1298
last_approval_request = notifychangeproperty(
1299
datetime_to_dbus, "LastApprovalRequest")
1300
approved_by_default = notifychangeproperty(dbus.Boolean,
1301
"ApprovedByDefault")
1302
approval_delay = notifychangeproperty(dbus.UInt64,
1305
timedelta_to_milliseconds)
1306
approval_duration = notifychangeproperty(
1307
dbus.UInt64, "ApprovalDuration",
1308
type_func = timedelta_to_milliseconds)
1309
host = notifychangeproperty(dbus.String, "Host")
1310
timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1312
timedelta_to_milliseconds)
1313
extended_timeout = notifychangeproperty(
1314
dbus.UInt64, "ExtendedTimeout",
1315
type_func = timedelta_to_milliseconds)
1316
interval = notifychangeproperty(dbus.UInt64,
1319
timedelta_to_milliseconds)
1320
checker_command = notifychangeproperty(dbus.String, "Checker")
1322
del notifychangeproperty
1324
def __del__(self, *args, **kwargs):
1326
self.remove_from_connection()
1329
if hasattr(DBusObjectWithProperties, "__del__"):
1330
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1331
Client.__del__(self, *args, **kwargs)
1333
def checker_callback(self, pid, condition, command,
1335
self.checker_callback_tag = None
1337
if os.WIFEXITED(condition):
1338
exitstatus = os.WEXITSTATUS(condition)
1340
self.CheckerCompleted(dbus.Int16(exitstatus),
1341
dbus.Int64(condition),
1342
dbus.String(command))
1345
self.CheckerCompleted(dbus.Int16(-1),
1346
dbus.Int64(condition),
1347
dbus.String(command))
1349
return Client.checker_callback(self, pid, condition, command,
1352
def start_checker(self, *args, **kwargs):
1353
old_checker = self.checker
1354
if self.checker is not None:
1355
old_checker_pid = self.checker.pid
1357
old_checker_pid = None
1358
r = Client.start_checker(self, *args, **kwargs)
1359
# Only if new checker process was started
1360
if (self.checker is not None
1361
and old_checker_pid != self.checker.pid):
1363
self.CheckerStarted(self.current_checker_command)
1366
def _reset_approved(self):
1367
self.approved = None
1370
def approve(self, value=True):
1371
self.approved = value
1372
gobject.timeout_add(timedelta_to_milliseconds
1373
(self.approval_duration),
1374
self._reset_approved)
1375
self.send_changedstate()
1377
## D-Bus methods, signals & properties
1378
_interface = "se.recompile.Mandos.Client"
1382
@dbus_interface_annotations(_interface)
1384
return { "org.freedesktop.DBus.Property.EmitsChangedSignal":
1389
# CheckerCompleted - signal
1390
@dbus.service.signal(_interface, signature="nxs")
1391
def CheckerCompleted(self, exitcode, waitstatus, command):
1395
# CheckerStarted - signal
1396
@dbus.service.signal(_interface, signature="s")
1397
def CheckerStarted(self, command):
1401
# PropertyChanged - signal
1402
@dbus.service.signal(_interface, signature="sv")
1403
def PropertyChanged(self, property, value):
1407
# GotSecret - signal
1408
@dbus.service.signal(_interface)
1409
def GotSecret(self):
1411
Is sent after a successful transfer of secret from the Mandos
1412
server to mandos-client
1417
@dbus.service.signal(_interface, signature="s")
1418
def Rejected(self, reason):
1422
# NeedApproval - signal
1423
@dbus.service.signal(_interface, signature="tb")
1424
def NeedApproval(self, timeout, default):
1426
return self.need_approval()
1431
@dbus.service.method(_interface, in_signature="b")
1432
def Approve(self, value):
1435
# CheckedOK - method
1436
@dbus.service.method(_interface)
1437
def CheckedOK(self):
1441
@dbus.service.method(_interface)
1446
# StartChecker - method
1447
@dbus.service.method(_interface)
1448
def StartChecker(self):
1450
self.start_checker()
1453
@dbus.service.method(_interface)
1458
# StopChecker - method
1459
@dbus.service.method(_interface)
1460
def StopChecker(self):
1465
# ApprovalPending - property
1466
@dbus_service_property(_interface, signature="b", access="read")
1467
def ApprovalPending_dbus_property(self):
1468
return dbus.Boolean(bool(self.approvals_pending))
1470
# ApprovedByDefault - property
1471
@dbus_service_property(_interface, signature="b",
1473
def ApprovedByDefault_dbus_property(self, value=None):
1474
if value is None: # get
1475
return dbus.Boolean(self.approved_by_default)
1476
self.approved_by_default = bool(value)
1478
# ApprovalDelay - property
1479
@dbus_service_property(_interface, signature="t",
1481
def ApprovalDelay_dbus_property(self, value=None):
1482
if value is None: # get
1483
return dbus.UInt64(self.approval_delay_milliseconds())
1484
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1486
# ApprovalDuration - property
1487
@dbus_service_property(_interface, signature="t",
1489
def ApprovalDuration_dbus_property(self, value=None):
1490
if value is None: # get
1491
return dbus.UInt64(timedelta_to_milliseconds(
1492
self.approval_duration))
1493
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1496
@dbus_service_property(_interface, signature="s", access="read")
1497
def Name_dbus_property(self):
1498
return dbus.String(self.name)
1500
# Fingerprint - property
1501
@dbus_service_property(_interface, signature="s", access="read")
1502
def Fingerprint_dbus_property(self):
1503
return dbus.String(self.fingerprint)
1506
@dbus_service_property(_interface, signature="s",
1508
def Host_dbus_property(self, value=None):
1509
if value is None: # get
1510
return dbus.String(self.host)
1511
self.host = unicode(value)
1513
# Created - property
1514
@dbus_service_property(_interface, signature="s", access="read")
1515
def Created_dbus_property(self):
1516
return datetime_to_dbus(self.created)
1518
# LastEnabled - property
1519
@dbus_service_property(_interface, signature="s", access="read")
1520
def LastEnabled_dbus_property(self):
1521
return datetime_to_dbus(self.last_enabled)
1523
# Enabled - property
1524
@dbus_service_property(_interface, signature="b",
1526
def Enabled_dbus_property(self, value=None):
1527
if value is None: # get
1528
return dbus.Boolean(self.enabled)
1534
# LastCheckedOK - property
1535
@dbus_service_property(_interface, signature="s",
1537
def LastCheckedOK_dbus_property(self, value=None):
1538
if value is not None:
1541
return datetime_to_dbus(self.last_checked_ok)
1543
# LastCheckerStatus - property
1544
@dbus_service_property(_interface, signature="n",
1546
def LastCheckerStatus_dbus_property(self):
1547
return dbus.Int16(self.last_checker_status)
1549
# Expires - property
1550
@dbus_service_property(_interface, signature="s", access="read")
1551
def Expires_dbus_property(self):
1552
return datetime_to_dbus(self.expires)
1554
# LastApprovalRequest - property
1555
@dbus_service_property(_interface, signature="s", access="read")
1556
def LastApprovalRequest_dbus_property(self):
1557
return datetime_to_dbus(self.last_approval_request)
1559
# Timeout - property
1560
@dbus_service_property(_interface, signature="t",
1562
def Timeout_dbus_property(self, value=None):
1563
if value is None: # get
1564
return dbus.UInt64(self.timeout_milliseconds())
1565
old_timeout = self.timeout
1566
self.timeout = datetime.timedelta(0, 0, 0, value)
1567
# Reschedule disabling
1569
now = datetime.datetime.utcnow()
1570
self.expires += self.timeout - old_timeout
1571
if self.expires <= now:
1572
# The timeout has passed
1575
if (getattr(self, "disable_initiator_tag", None)
1578
gobject.source_remove(self.disable_initiator_tag)
1579
self.disable_initiator_tag = (
1580
gobject.timeout_add(
1581
timedelta_to_milliseconds(self.expires - now),
1584
# ExtendedTimeout - property
1585
@dbus_service_property(_interface, signature="t",
1587
def ExtendedTimeout_dbus_property(self, value=None):
1588
if value is None: # get
1589
return dbus.UInt64(self.extended_timeout_milliseconds())
1590
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1592
# Interval - property
1593
@dbus_service_property(_interface, signature="t",
1595
def Interval_dbus_property(self, value=None):
1596
if value is None: # get
1597
return dbus.UInt64(self.interval_milliseconds())
1598
self.interval = datetime.timedelta(0, 0, 0, value)
1599
if getattr(self, "checker_initiator_tag", None) is None:
1602
# Reschedule checker run
1603
gobject.source_remove(self.checker_initiator_tag)
1604
self.checker_initiator_tag = (gobject.timeout_add
1605
(value, self.start_checker))
1606
self.start_checker() # Start one now, too
1608
# Checker - property
1609
@dbus_service_property(_interface, signature="s",
1611
def Checker_dbus_property(self, value=None):
1612
if value is None: # get
1613
return dbus.String(self.checker_command)
1614
self.checker_command = unicode(value)
1616
# CheckerRunning - property
1617
@dbus_service_property(_interface, signature="b",
1619
def CheckerRunning_dbus_property(self, value=None):
1620
if value is None: # get
1621
return dbus.Boolean(self.checker is not None)
1623
self.start_checker()
1627
# ObjectPath - property
1628
@dbus_service_property(_interface, signature="o", access="read")
1629
def ObjectPath_dbus_property(self):
1630
return self.dbus_object_path # is already a dbus.ObjectPath
1633
@dbus_service_property(_interface, signature="ay",
1634
access="write", byte_arrays=True)
1635
def Secret_dbus_property(self, value):
1636
self.secret = str(value)
1641
class ProxyClient(object):
1642
def __init__(self, child_pipe, fpr, address):
1643
self._pipe = child_pipe
1644
self._pipe.send(('init', fpr, address))
1645
if not self._pipe.recv():
1648
def __getattribute__(self, name):
1650
return super(ProxyClient, self).__getattribute__(name)
1651
self._pipe.send(('getattr', name))
1652
data = self._pipe.recv()
1653
if data[0] == 'data':
1655
if data[0] == 'function':
1656
def func(*args, **kwargs):
1657
self._pipe.send(('funcall', name, args, kwargs))
1658
return self._pipe.recv()[1]
1661
def __setattr__(self, name, value):
1663
return super(ProxyClient, self).__setattr__(name, value)
1664
self._pipe.send(('setattr', name, value))
1667
class ClientHandler(socketserver.BaseRequestHandler, object):
1668
"""A class to handle client connections.
1670
Instantiated once for each connection to handle it.
370
def still_valid(self):
371
"""Has the timeout not yet passed for this client?"""
372
now = datetime.datetime.now()
373
if self.last_checked_ok is None:
374
return now < (self.created + self.timeout)
376
return now < (self.last_checked_ok + self.timeout)
379
def peer_certificate(session):
380
"Return the peer's OpenPGP certificate as a bytestring"
381
# If not an OpenPGP certificate...
382
if gnutls.library.functions.gnutls_certificate_type_get\
383
(session._c_object) \
384
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP:
385
# ...do the normal thing
386
return session.peer_certificate
387
list_size = ctypes.c_uint()
388
cert_list = gnutls.library.functions.gnutls_certificate_get_peers\
389
(session._c_object, ctypes.byref(list_size))
390
if list_size.value == 0:
393
return ctypes.string_at(cert.data, cert.size)
396
def fingerprint(openpgp):
397
"Convert an OpenPGP bytestring to a hexdigit fingerprint string"
398
# New GnuTLS "datum" with the OpenPGP public key
399
datum = gnutls.library.types.gnutls_datum_t\
400
(ctypes.cast(ctypes.c_char_p(openpgp),
401
ctypes.POINTER(ctypes.c_ubyte)),
402
ctypes.c_uint(len(openpgp)))
403
# New empty GnuTLS certificate
404
crt = gnutls.library.types.gnutls_openpgp_crt_t()
405
gnutls.library.functions.gnutls_openpgp_crt_init\
407
# Import the OpenPGP public key into the certificate
408
gnutls.library.functions.gnutls_openpgp_crt_import\
409
(crt, ctypes.byref(datum),
410
gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
411
# New buffer for the fingerprint
412
buffer = ctypes.create_string_buffer(20)
413
buffer_length = ctypes.c_size_t()
414
# Get the fingerprint from the certificate into the buffer
415
gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint\
416
(crt, ctypes.byref(buffer), ctypes.byref(buffer_length))
417
# Deinit the certificate
418
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
419
# Convert the buffer to a Python bytestring
420
fpr = ctypes.string_at(buffer, buffer_length.value)
421
# Convert the bytestring to hexadecimal notation
422
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
426
class tcp_handler(SocketServer.BaseRequestHandler, object):
427
"""A TCP request handler class.
428
Instantiated by IPv6_TCPServer for each request to handle it.
1671
429
Note: This will run in its own forked process."""
1673
431
def handle(self):
1674
with contextlib.closing(self.server.child_pipe) as child_pipe:
1675
logger.info("TCP connection from: %s",
1676
unicode(self.client_address))
1677
logger.debug("Pipe FD: %d",
1678
self.server.child_pipe.fileno())
1680
session = (gnutls.connection
1681
.ClientSession(self.request,
1683
.X509Credentials()))
1685
# Note: gnutls.connection.X509Credentials is really a
1686
# generic GnuTLS certificate credentials object so long as
1687
# no X.509 keys are added to it. Therefore, we can use it
1688
# here despite using OpenPGP certificates.
1690
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1691
# "+AES-256-CBC", "+SHA1",
1692
# "+COMP-NULL", "+CTYPE-OPENPGP",
1694
# Use a fallback default, since this MUST be set.
1695
priority = self.server.gnutls_priority
1696
if priority is None:
1698
(gnutls.library.functions
1699
.gnutls_priority_set_direct(session._c_object,
1702
# Start communication using the Mandos protocol
1703
# Get protocol number
1704
line = self.request.makefile().readline()
1705
logger.debug("Protocol version: %r", line)
1707
if int(line.strip().split()[0]) > 1:
1708
raise RuntimeError(line)
1709
except (ValueError, IndexError, RuntimeError) as error:
1710
logger.error("Unknown protocol version: %s", error)
1713
# Start GnuTLS connection
1716
except gnutls.errors.GNUTLSError as error:
1717
logger.warning("Handshake failed: %s", error)
1718
# Do not run session.bye() here: the session is not
1719
# established. Just abandon the request.
1721
logger.debug("Handshake succeeded")
1723
approval_required = False
1726
fpr = self.fingerprint(self.peer_certificate
1729
gnutls.errors.GNUTLSError) as error:
1730
logger.warning("Bad certificate: %s", error)
1732
logger.debug("Fingerprint: %s", fpr)
1735
client = ProxyClient(child_pipe, fpr,
1736
self.client_address)
1740
if client.approval_delay:
1741
delay = client.approval_delay
1742
client.approvals_pending += 1
1743
approval_required = True
1746
if not client.enabled:
1747
logger.info("Client %s is disabled",
1749
if self.server.use_dbus:
1751
client.Rejected("Disabled")
1754
if client.approved or not client.approval_delay:
1755
#We are approved or approval is disabled
1757
elif client.approved is None:
1758
logger.info("Client %s needs approval",
1760
if self.server.use_dbus:
1762
client.NeedApproval(
1763
client.approval_delay_milliseconds(),
1764
client.approved_by_default)
1766
logger.warning("Client %s was not approved",
1768
if self.server.use_dbus:
1770
client.Rejected("Denied")
1773
#wait until timeout or approved
1774
time = datetime.datetime.now()
1775
client.changedstate.acquire()
1776
client.changedstate.wait(
1777
float(timedelta_to_milliseconds(delay)
1779
client.changedstate.release()
1780
time2 = datetime.datetime.now()
1781
if (time2 - time) >= delay:
1782
if not client.approved_by_default:
1783
logger.warning("Client %s timed out while"
1784
" waiting for approval",
1786
if self.server.use_dbus:
1788
client.Rejected("Approval timed out")
1793
delay -= time2 - time
1796
while sent_size < len(client.secret):
1798
sent = session.send(client.secret[sent_size:])
1799
except gnutls.errors.GNUTLSError as error:
1800
logger.warning("gnutls send failed",
1803
logger.debug("Sent: %d, remaining: %d",
1804
sent, len(client.secret)
1805
- (sent_size + sent))
1808
logger.info("Sending secret to %s", client.name)
1809
# bump the timeout using extended_timeout
1810
client.bump_timeout(client.extended_timeout)
1811
if self.server.use_dbus:
1816
if approval_required:
1817
client.approvals_pending -= 1
1820
except gnutls.errors.GNUTLSError as error:
1821
logger.warning("GnuTLS bye failed",
1825
def peer_certificate(session):
1826
"Return the peer's OpenPGP certificate as a bytestring"
1827
# If not an OpenPGP certificate...
1828
if (gnutls.library.functions
1829
.gnutls_certificate_type_get(session._c_object)
1830
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1831
# ...do the normal thing
1832
return session.peer_certificate
1833
list_size = ctypes.c_uint(1)
1834
cert_list = (gnutls.library.functions
1835
.gnutls_certificate_get_peers
1836
(session._c_object, ctypes.byref(list_size)))
1837
if not bool(cert_list) and list_size.value != 0:
1838
raise gnutls.errors.GNUTLSError("error getting peer"
1840
if list_size.value == 0:
1843
return ctypes.string_at(cert.data, cert.size)
1846
def fingerprint(openpgp):
1847
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
1848
# New GnuTLS "datum" with the OpenPGP public key
1849
datum = (gnutls.library.types
1850
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1853
ctypes.c_uint(len(openpgp))))
1854
# New empty GnuTLS certificate
1855
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1856
(gnutls.library.functions
1857
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
1858
# Import the OpenPGP public key into the certificate
1859
(gnutls.library.functions
1860
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1861
gnutls.library.constants
1862
.GNUTLS_OPENPGP_FMT_RAW))
1863
# Verify the self signature in the key
1864
crtverify = ctypes.c_uint()
1865
(gnutls.library.functions
1866
.gnutls_openpgp_crt_verify_self(crt, 0,
1867
ctypes.byref(crtverify)))
1868
if crtverify.value != 0:
1869
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1870
raise (gnutls.errors.CertificateSecurityError
1872
# New buffer for the fingerprint
1873
buf = ctypes.create_string_buffer(20)
1874
buf_len = ctypes.c_size_t()
1875
# Get the fingerprint from the certificate into the buffer
1876
(gnutls.library.functions
1877
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1878
ctypes.byref(buf_len)))
1879
# Deinit the certificate
1880
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1881
# Convert the buffer to a Python bytestring
1882
fpr = ctypes.string_at(buf, buf_len.value)
1883
# Convert the bytestring to hexadecimal notation
1884
hex_fpr = binascii.hexlify(fpr).upper()
1888
class MultiprocessingMixIn(object):
1889
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
1890
def sub_process_main(self, request, address):
1892
self.finish_request(request, address)
1894
self.handle_error(request, address)
1895
self.close_request(request)
1897
def process_request(self, request, address):
1898
"""Start a new process to process the request."""
1899
proc = multiprocessing.Process(target = self.sub_process_main,
1900
args = (request, address))
1905
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1906
""" adds a pipe to the MixIn """
1907
def process_request(self, request, client_address):
1908
"""Overrides and wraps the original process_request().
1910
This function creates a new pipe in self.pipe
1912
parent_pipe, self.child_pipe = multiprocessing.Pipe()
1914
proc = MultiprocessingMixIn.process_request(self, request,
1916
self.child_pipe.close()
1917
self.add_pipe(parent_pipe, proc)
1919
def add_pipe(self, parent_pipe, proc):
1920
"""Dummy function; override as necessary"""
1921
raise NotImplementedError()
1924
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1925
socketserver.TCPServer, object):
1926
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
432
logger.info(u"TCP connection from: %s",
433
unicode(self.client_address))
434
session = gnutls.connection.ClientSession\
435
(self.request, gnutls.connection.X509Credentials())
437
line = self.request.makefile().readline()
438
logger.debug(u"Protocol version: %r", line)
440
if int(line.strip().split()[0]) > 1:
442
except (ValueError, IndexError, RuntimeError), error:
443
logger.error(u"Unknown protocol version: %s", error)
446
# Note: gnutls.connection.X509Credentials is really a generic
447
# GnuTLS certificate credentials object so long as no X.509
448
# keys are added to it. Therefore, we can use it here despite
449
# using OpenPGP certificates.
451
#priority = ':'.join(("NONE", "+VERS-TLS1.1", "+AES-256-CBC",
452
# "+SHA1", "+COMP-NULL", "+CTYPE-OPENPGP",
454
priority = "NORMAL" # Fallback default, since this
456
if self.server.settings["priority"]:
457
priority = self.server.settings["priority"]
458
gnutls.library.functions.gnutls_priority_set_direct\
459
(session._c_object, priority, None);
463
except gnutls.errors.GNUTLSError, error:
464
logger.warning(u"Handshake failed: %s", error)
465
# Do not run session.bye() here: the session is not
466
# established. Just abandon the request.
469
fpr = fingerprint(peer_certificate(session))
470
except (TypeError, gnutls.errors.GNUTLSError), error:
471
logger.warning(u"Bad certificate: %s", error)
474
logger.debug(u"Fingerprint: %s", fpr)
476
for c in self.server.clients:
477
if c.fingerprint == fpr:
481
logger.warning(u"Client not found for fingerprint: %s",
485
# Have to check if client.still_valid(), since it is possible
486
# that the client timed out while establishing the GnuTLS
488
if not client.still_valid():
489
logger.warning(u"Client %(name)s is invalid",
494
while sent_size < len(client.secret):
495
sent = session.send(client.secret[sent_size:])
496
logger.debug(u"Sent: %d, remaining: %d",
497
sent, len(client.secret)
498
- (sent_size + sent))
503
class IPv6_TCPServer(SocketServer.ForkingTCPServer, object):
504
"""IPv6 TCP server. Accepts 'None' as address and/or port.
1929
enabled: Boolean; whether this server is activated yet
1930
interface: None or a network interface name (string)
1931
use_ipv6: Boolean; to use IPv6 or not
506
settings: Server settings
507
clients: Set() of Client objects
1933
def __init__(self, server_address, RequestHandlerClass,
1934
interface=None, use_ipv6=True, socketfd=None):
1935
"""If socketfd is set, use that file descriptor instead of
1936
creating a new one with socket.socket().
1938
self.interface = interface
1940
self.address_family = socket.AF_INET6
1941
if socketfd is not None:
1942
# Save the file descriptor
1943
self.socketfd = socketfd
1944
# Save the original socket.socket() function
1945
self.socket_socket = socket.socket
1946
# To implement --socket, we monkey patch socket.socket.
1948
# (When socketserver.TCPServer is a new-style class, we
1949
# could make self.socket into a property instead of monkey
1950
# patching socket.socket.)
1952
# Create a one-time-only replacement for socket.socket()
1953
@functools.wraps(socket.socket)
1954
def socket_wrapper(*args, **kwargs):
1955
# Restore original function so subsequent calls are
1957
socket.socket = self.socket_socket
1958
del self.socket_socket
1959
# This time only, return a new socket object from the
1960
# saved file descriptor.
1961
return socket.fromfd(self.socketfd, *args, **kwargs)
1962
# Replace socket.socket() function with wrapper
1963
socket.socket = socket_wrapper
1964
# The socketserver.TCPServer.__init__ will call
1965
# socket.socket(), which might be our replacement,
1966
# socket_wrapper(), if socketfd was set.
1967
socketserver.TCPServer.__init__(self, server_address,
1968
RequestHandlerClass)
509
address_family = socket.AF_INET6
510
def __init__(self, *args, **kwargs):
511
if "settings" in kwargs:
512
self.settings = kwargs["settings"]
513
del kwargs["settings"]
514
if "clients" in kwargs:
515
self.clients = kwargs["clients"]
516
del kwargs["clients"]
517
return super(type(self), self).__init__(*args, **kwargs)
1970
518
def server_bind(self):
1971
519
"""This overrides the normal server_bind() function
1972
520
to bind to an interface if one was specified, and also NOT to
1973
521
bind to an address or port if they were not specified."""
1974
if self.interface is not None:
1975
if SO_BINDTODEVICE is None:
1976
logger.error("SO_BINDTODEVICE does not exist;"
1977
" cannot bind to interface %s",
1981
self.socket.setsockopt(socket.SOL_SOCKET,
1983
str(self.interface + '\0'))
1984
except socket.error as error:
1985
if error.errno == errno.EPERM:
1986
logger.error("No permission to bind to"
1987
" interface %s", self.interface)
1988
elif error.errno == errno.ENOPROTOOPT:
1989
logger.error("SO_BINDTODEVICE not available;"
1990
" cannot bind to interface %s",
1992
elif error.errno == errno.ENODEV:
1993
logger.error("Interface %s does not exist,"
1994
" cannot bind", self.interface)
522
if self.settings["interface"]:
523
# 25 is from /usr/include/asm-i486/socket.h
524
SO_BINDTODEVICE = getattr(socket, "SO_BINDTODEVICE", 25)
526
self.socket.setsockopt(socket.SOL_SOCKET,
528
self.settings["interface"])
529
except socket.error, error:
530
if error[0] == errno.EPERM:
531
logger.error(u"No permission to"
532
u" bind to interface %s",
533
self.settings["interface"])
1997
536
# Only bind(2) the socket if we really need to.
1998
537
if self.server_address[0] or self.server_address[1]:
1999
538
if not self.server_address[0]:
2000
if self.address_family == socket.AF_INET6:
2001
any_address = "::" # in6addr_any
2003
any_address = "0.0.0.0" # INADDR_ANY
2004
self.server_address = (any_address,
540
self.server_address = (in6addr_any,
2005
541
self.server_address[1])
2006
elif not self.server_address[1]:
542
elif self.server_address[1] is None:
2007
543
self.server_address = (self.server_address[0],
2009
# if self.interface:
2010
# self.server_address = (self.server_address[0],
2015
return socketserver.TCPServer.server_bind(self)
2018
class MandosServer(IPv6_TCPServer):
2022
clients: set of Client objects
2023
gnutls_priority GnuTLS priority string
2024
use_dbus: Boolean; to emit D-Bus signals or not
2026
Assumes a gobject.MainLoop event loop.
2028
def __init__(self, server_address, RequestHandlerClass,
2029
interface=None, use_ipv6=True, clients=None,
2030
gnutls_priority=None, use_dbus=True, socketfd=None):
2031
self.enabled = False
2032
self.clients = clients
2033
if self.clients is None:
2035
self.use_dbus = use_dbus
2036
self.gnutls_priority = gnutls_priority
2037
IPv6_TCPServer.__init__(self, server_address,
2038
RequestHandlerClass,
2039
interface = interface,
2040
use_ipv6 = use_ipv6,
2041
socketfd = socketfd)
2042
def server_activate(self):
2044
return socketserver.TCPServer.server_activate(self)
2049
def add_pipe(self, parent_pipe, proc):
2050
# Call "handle_ipc" for both data and EOF events
2051
gobject.io_add_watch(parent_pipe.fileno(),
2052
gobject.IO_IN | gobject.IO_HUP,
2053
functools.partial(self.handle_ipc,
2058
def handle_ipc(self, source, condition, parent_pipe=None,
2059
proc = None, client_object=None):
2060
# error, or the other end of multiprocessing.Pipe has closed
2061
if condition & (gobject.IO_ERR | gobject.IO_HUP):
2062
# Wait for other process to exit
2066
# Read a request from the child
2067
request = parent_pipe.recv()
2068
command = request[0]
2070
if command == 'init':
2072
address = request[2]
2074
for c in self.clients.itervalues():
2075
if c.fingerprint == fpr:
2079
logger.info("Client not found for fingerprint: %s, ad"
2080
"dress: %s", fpr, address)
2083
mandos_dbus_service.ClientNotFound(fpr,
2085
parent_pipe.send(False)
2088
gobject.io_add_watch(parent_pipe.fileno(),
2089
gobject.IO_IN | gobject.IO_HUP,
2090
functools.partial(self.handle_ipc,
2096
parent_pipe.send(True)
2097
# remove the old hook in favor of the new above hook on
2100
if command == 'funcall':
2101
funcname = request[1]
2105
parent_pipe.send(('data', getattr(client_object,
2109
if command == 'getattr':
2110
attrname = request[1]
2111
if callable(client_object.__getattribute__(attrname)):
2112
parent_pipe.send(('function',))
2114
parent_pipe.send(('data', client_object
2115
.__getattribute__(attrname)))
2117
if command == 'setattr':
2118
attrname = request[1]
2120
setattr(client_object, attrname, value)
2125
def rfc3339_duration_to_delta(duration):
2126
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2128
>>> rfc3339_duration_to_delta("P7D")
2129
datetime.timedelta(7)
2130
>>> rfc3339_duration_to_delta("PT60S")
2131
datetime.timedelta(0, 60)
2132
>>> rfc3339_duration_to_delta("PT60M")
2133
datetime.timedelta(0, 3600)
2134
>>> rfc3339_duration_to_delta("PT24H")
2135
datetime.timedelta(1)
2136
>>> rfc3339_duration_to_delta("P1W")
2137
datetime.timedelta(7)
2138
>>> rfc3339_duration_to_delta("PT5M30S")
2139
datetime.timedelta(0, 330)
2140
>>> rfc3339_duration_to_delta("P1DT3M20S")
2141
datetime.timedelta(1, 200)
2144
# Parsing an RFC 3339 duration with regular expressions is not
2145
# possible - there would have to be multiple places for the same
2146
# values, like seconds. The current code, while more esoteric, is
2147
# cleaner without depending on a parsing library. If Python had a
2148
# built-in library for parsing we would use it, but we'd like to
2149
# avoid excessive use of external libraries.
2151
# New type for defining tokens, syntax, and semantics all-in-one
2152
Token = collections.namedtuple("Token",
2153
("regexp", # To match token; if
2154
# "value" is not None,
2155
# must have a "group"
2157
"value", # datetime.timedelta or
2159
"followers")) # Tokens valid after
2161
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2162
# the "duration" ABNF definition in RFC 3339, Appendix A.
2163
token_end = Token(re.compile(r"$"), None, frozenset())
2164
token_second = Token(re.compile(r"(\d+)S"),
2165
datetime.timedelta(seconds=1),
2166
frozenset((token_end,)))
2167
token_minute = Token(re.compile(r"(\d+)M"),
2168
datetime.timedelta(minutes=1),
2169
frozenset((token_second, token_end)))
2170
token_hour = Token(re.compile(r"(\d+)H"),
2171
datetime.timedelta(hours=1),
2172
frozenset((token_minute, token_end)))
2173
token_time = Token(re.compile(r"T"),
2175
frozenset((token_hour, token_minute,
2177
token_day = Token(re.compile(r"(\d+)D"),
2178
datetime.timedelta(days=1),
2179
frozenset((token_time, token_end)))
2180
token_month = Token(re.compile(r"(\d+)M"),
2181
datetime.timedelta(weeks=4),
2182
frozenset((token_day, token_end)))
2183
token_year = Token(re.compile(r"(\d+)Y"),
2184
datetime.timedelta(weeks=52),
2185
frozenset((token_month, token_end)))
2186
token_week = Token(re.compile(r"(\d+)W"),
2187
datetime.timedelta(weeks=1),
2188
frozenset((token_end,)))
2189
token_duration = Token(re.compile(r"P"), None,
2190
frozenset((token_year, token_month,
2191
token_day, token_time,
2193
# Define starting values
2194
value = datetime.timedelta() # Value so far
2196
followers = frozenset(token_duration,) # Following valid tokens
2197
s = duration # String left to parse
2198
# Loop until end token is found
2199
while found_token is not token_end:
2200
# Search for any currently valid tokens
2201
for token in followers:
2202
match = token.regexp.match(s)
2203
if match is not None:
2205
if token.value is not None:
2206
# Value found, parse digits
2207
factor = int(match.group(1), 10)
2208
# Add to value so far
2209
value += factor * token.value
2210
# Strip token from string
2211
s = token.regexp.sub("", s, 1)
2214
# Set valid next tokens
2215
followers = found_token.followers
2218
# No currently valid tokens were found
2219
raise ValueError("Invalid RFC 3339 duration")
545
return super(type(self), self).server_bind()
2224
548
def string_to_delta(interval):
2225
549
"""Parse a string and return a datetime.timedelta
2227
551
>>> string_to_delta('7d')
2228
552
datetime.timedelta(7)
2229
553
>>> string_to_delta('60s')
2353
686
"debug": "False",
2355
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",
688
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
2356
689
"servicename": "Mandos",
2362
"statedir": "/var/lib/mandos",
2363
"foreground": "False",
2366
692
# Parse config file for server-global settings
2367
server_config = configparser.SafeConfigParser(server_defaults)
693
server_config = ConfigParser.SafeConfigParser(server_defaults)
2368
694
del server_defaults
2369
server_config.read(os.path.join(options.configdir,
695
server_config.read(os.path.join(options.configdir, "server.conf"))
696
server_section = "server"
2371
697
# Convert the SafeConfigParser object to a dict
2372
server_settings = server_config.defaults()
2373
# Use the appropriate methods on the non-string config options
2374
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2375
server_settings[option] = server_config.getboolean("DEFAULT",
2377
if server_settings["port"]:
2378
server_settings["port"] = server_config.getint("DEFAULT",
2380
if server_settings["socket"]:
2381
server_settings["socket"] = server_config.getint("DEFAULT",
2383
# Later, stdin will, and stdout and stderr might, be dup'ed
2384
# over with an opened os.devnull. But we don't want this to
2385
# happen with a supplied network socket.
2386
if 0 <= server_settings["socket"] <= 2:
2387
server_settings["socket"] = os.dup(server_settings
698
server_settings = dict(server_config.items(server_section))
699
# Use getboolean on the boolean config option
700
server_settings["debug"] = server_config.getboolean\
701
(server_section, "debug")
2389
702
del server_config
2391
704
# Override the settings from the config file with command line
2392
705
# options, if set.
2393
706
for option in ("interface", "address", "port", "debug",
2394
"priority", "servicename", "configdir",
2395
"use_dbus", "use_ipv6", "debuglevel", "restore",
2396
"statedir", "socket", "foreground"):
707
"priority", "servicename", "configdir"):
2397
708
value = getattr(options, option)
2398
709
if value is not None:
2399
710
server_settings[option] = value
2401
# Force all strings to be unicode
2402
for option in server_settings.keys():
2403
if type(server_settings[option]) is str:
2404
server_settings[option] = unicode(server_settings[option])
2405
# Force all boolean options to be boolean
2406
for option in ("debug", "use_dbus", "use_ipv6", "restore",
2408
server_settings[option] = bool(server_settings[option])
2409
# Debug implies foreground
2410
if server_settings["debug"]:
2411
server_settings["foreground"] = True
2412
712
# Now we have our good server settings in "server_settings"
2414
##################################################################
2417
debug = server_settings["debug"]
2418
debuglevel = server_settings["debuglevel"]
2419
use_dbus = server_settings["use_dbus"]
2420
use_ipv6 = server_settings["use_ipv6"]
2421
stored_state_path = os.path.join(server_settings["statedir"],
2423
foreground = server_settings["foreground"]
2426
initlogger(debug, logging.DEBUG)
2431
level = getattr(logging, debuglevel.upper())
2432
initlogger(debug, level)
2434
if server_settings["servicename"] != "Mandos":
2435
syslogger.setFormatter(logging.Formatter
2436
('Mandos ({0}) [%(process)d]:'
2437
' %(levelname)s: %(message)s'
2438
.format(server_settings
2441
714
# Parse config file with clients
2442
client_config = configparser.SafeConfigParser(Client
715
client_defaults = { "timeout": "1h",
717
"checker": "fping -q -- %%(fqdn)s",
719
client_config = ConfigParser.SafeConfigParser(client_defaults)
2444
720
client_config.read(os.path.join(server_settings["configdir"],
2445
721
"clients.conf"))
2447
global mandos_dbus_service
2448
mandos_dbus_service = None
2450
tcp_server = MandosServer((server_settings["address"],
2451
server_settings["port"]),
2453
interface=(server_settings["interface"]
2457
server_settings["priority"],
2459
socketfd=(server_settings["socket"]
2462
pidfilename = "/run/mandos.pid"
2463
if not os.path.isdir("/run/."):
2464
pidfilename = "/var/run/mandos.pid"
2467
pidfile = open(pidfilename, "w")
2468
except IOError as e:
2469
logger.error("Could not open file %r", pidfilename,
2472
for name in ("_mandos", "mandos", "nobody"):
2474
uid = pwd.getpwnam(name).pw_uid
2475
gid = pwd.getpwnam(name).pw_gid
2485
except OSError as error:
2486
if error.errno != errno.EPERM:
2490
# Enable all possible GnuTLS debugging
2492
# "Use a log level over 10 to enable all debugging options."
2494
gnutls.library.functions.gnutls_global_set_log_level(11)
2496
@gnutls.library.types.gnutls_log_func
2497
def debug_gnutls(level, string):
2498
logger.debug("GnuTLS: %s", string[:-1])
2500
(gnutls.library.functions
2501
.gnutls_global_set_log_function(debug_gnutls))
2503
# Redirect stdin so all checkers get /dev/null
2504
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2505
os.dup2(null, sys.stdin.fileno())
2509
# Need to fork before connecting to D-Bus
2511
# Close all input and output, do double fork, etc.
2514
# multiprocessing will use threads, so before we use gobject we
2515
# need to inform gobject that threads will be used.
2516
gobject.threads_init()
724
service = AvahiService(name = server_settings["servicename"],
725
type = "_mandos._tcp", );
726
if server_settings["interface"]:
727
service.interface = if_nametoindex(server_settings["interface"])
2518
729
global main_loop
2519
732
# From the Avahi example code
2520
DBusGMainLoop(set_as_default=True)
733
DBusGMainLoop(set_as_default=True )
2521
734
main_loop = gobject.MainLoop()
2522
735
bus = dbus.SystemBus()
736
server = dbus.Interface(
737
bus.get_object( avahi.DBUS_NAME, avahi.DBUS_PATH_SERVER ),
738
avahi.DBUS_INTERFACE_SERVER )
2523
739
# End of Avahi example code
2526
bus_name = dbus.service.BusName("se.recompile.Mandos",
2527
bus, do_not_queue=True)
2528
old_bus_name = (dbus.service.BusName
2529
("se.bsnet.fukt.Mandos", bus,
2531
except dbus.exceptions.NameExistsException as e:
2532
logger.error("Disabling D-Bus:", exc_info=e)
2534
server_settings["use_dbus"] = False
2535
tcp_server.use_dbus = False
2536
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2537
service = AvahiServiceToSyslog(name =
2538
server_settings["servicename"],
2539
servicetype = "_mandos._tcp",
2540
protocol = protocol, bus = bus)
2541
if server_settings["interface"]:
2542
service.interface = (if_nametoindex
2543
(str(server_settings["interface"])))
2545
global multiprocessing_manager
2546
multiprocessing_manager = multiprocessing.Manager()
2548
client_class = Client
2550
client_class = functools.partial(ClientDBus, bus = bus)
2552
client_settings = Client.config_parser(client_config)
2553
old_client_settings = {}
2556
# This is used to redirect stdout and stderr for checker processes
2558
wnull = open(os.devnull, "w") # A writable /dev/null
2559
# Only used if server is running in foreground but not in debug
2561
if debug or not foreground:
2564
# Get client data and settings from last running state.
2565
if server_settings["restore"]:
2567
with open(stored_state_path, "rb") as stored_state:
2568
clients_data, old_client_settings = (pickle.load
2570
os.remove(stored_state_path)
2571
except IOError as e:
2572
if e.errno == errno.ENOENT:
2573
logger.warning("Could not load persistent state: {0}"
2574
.format(os.strerror(e.errno)))
2576
logger.critical("Could not load persistent state:",
2579
except EOFError as e:
2580
logger.warning("Could not load persistent state: "
2581
"EOFError:", exc_info=e)
2583
with PGPEngine() as pgp:
2584
for client_name, client in clients_data.iteritems():
2585
# Skip removed clients
2586
if client_name not in client_settings:
2589
# Decide which value to use after restoring saved state.
2590
# We have three different values: Old config file,
2591
# new config file, and saved state.
2592
# New config value takes precedence if it differs from old
2593
# config value, otherwise use saved state.
2594
for name, value in client_settings[client_name].items():
2596
# For each value in new config, check if it
2597
# differs from the old config value (Except for
2598
# the "secret" attribute)
2599
if (name != "secret" and
2600
value != old_client_settings[client_name]
2602
client[name] = value
2606
# Clients who has passed its expire date can still be
2607
# enabled if its last checker was successful. Clients
2608
# whose checker succeeded before we stored its state is
2609
# assumed to have successfully run all checkers during
2611
if client["enabled"]:
2612
if datetime.datetime.utcnow() >= client["expires"]:
2613
if not client["last_checked_ok"]:
2615
"disabling client {0} - Client never "
2616
"performed a successful checker"
2617
.format(client_name))
2618
client["enabled"] = False
2619
elif client["last_checker_status"] != 0:
2621
"disabling client {0} - Client "
2622
"last checker failed with error code {1}"
2623
.format(client_name,
2624
client["last_checker_status"]))
2625
client["enabled"] = False
2627
client["expires"] = (datetime.datetime
2629
+ client["timeout"])
2630
logger.debug("Last checker succeeded,"
2631
" keeping {0} enabled"
2632
.format(client_name))
2634
client["secret"] = (
2635
pgp.decrypt(client["encrypted_secret"],
2636
client_settings[client_name]
2639
# If decryption fails, we use secret from new settings
2640
logger.debug("Failed to decrypt {0} old secret"
2641
.format(client_name))
2642
client["secret"] = (
2643
client_settings[client_name]["secret"])
2645
# Add/remove clients based on new changes made to config
2646
for client_name in (set(old_client_settings)
2647
- set(client_settings)):
2648
del clients_data[client_name]
2649
for client_name in (set(client_settings)
2650
- set(old_client_settings)):
2651
clients_data[client_name] = client_settings[client_name]
2653
# Create all client objects
2654
for client_name, client in clients_data.iteritems():
2655
tcp_server.clients[client_name] = client_class(
2656
name = client_name, settings = client,
2657
server_settings = server_settings)
2659
if not tcp_server.clients:
2660
logger.warning("No clients defined")
2663
if pidfile is not None:
2667
pidfile.write(str(pid) + "\n".encode("utf-8"))
2669
logger.error("Could not write to file %r with PID %d",
2674
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2675
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2678
@alternate_dbus_interfaces({"se.recompile.Mandos":
2679
"se.bsnet.fukt.Mandos"})
2680
class MandosDBusService(DBusObjectWithProperties):
2681
"""A D-Bus proxy object"""
2683
dbus.service.Object.__init__(self, bus, "/")
2684
_interface = "se.recompile.Mandos"
2686
@dbus_interface_annotations(_interface)
2688
return { "org.freedesktop.DBus.Property"
2689
".EmitsChangedSignal":
2692
@dbus.service.signal(_interface, signature="o")
2693
def ClientAdded(self, objpath):
2697
@dbus.service.signal(_interface, signature="ss")
2698
def ClientNotFound(self, fingerprint, address):
2702
@dbus.service.signal(_interface, signature="os")
2703
def ClientRemoved(self, objpath, name):
2707
@dbus.service.method(_interface, out_signature="ao")
2708
def GetAllClients(self):
2710
return dbus.Array(c.dbus_object_path
2712
tcp_server.clients.itervalues())
2714
@dbus.service.method(_interface,
2715
out_signature="a{oa{sv}}")
2716
def GetAllClientsWithProperties(self):
2718
return dbus.Dictionary(
2719
((c.dbus_object_path, c.GetAll(""))
2720
for c in tcp_server.clients.itervalues()),
2723
@dbus.service.method(_interface, in_signature="o")
2724
def RemoveClient(self, object_path):
2726
for c in tcp_server.clients.itervalues():
2727
if c.dbus_object_path == object_path:
2728
del tcp_server.clients[c.name]
2729
c.remove_from_connection()
2730
# Don't signal anything except ClientRemoved
2731
c.disable(quiet=True)
2733
self.ClientRemoved(object_path, c.name)
2735
raise KeyError(object_path)
2739
mandos_dbus_service = MandosDBusService()
741
debug = server_settings["debug"]
744
console = logging.StreamHandler()
745
# console.setLevel(logging.DEBUG)
746
console.setFormatter(logging.Formatter\
747
('%(levelname)s: %(message)s'))
748
logger.addHandler(console)
752
def remove_from_clients(client):
753
clients.remove(client)
755
logger.critical(u"No clients left, exiting")
758
clients.update(Set(Client(name = section,
759
stop_hook = remove_from_clients,
761
= dict(client_config.items(section)))
762
for section in client_config.sections()))
2742
768
"Cleanup function; run on exit"
2745
multiprocessing.active_children()
2747
if not (tcp_server.clients or client_settings):
2750
# Store client before exiting. Secrets are encrypted with key
2751
# based on what config file has. If config file is
2752
# removed/edited, old secret will thus be unrecovable.
2754
with PGPEngine() as pgp:
2755
for client in tcp_server.clients.itervalues():
2756
key = client_settings[client.name]["secret"]
2757
client.encrypted_secret = pgp.encrypt(client.secret,
2761
# A list of attributes that can not be pickled
2763
exclude = set(("bus", "changedstate", "secret",
2764
"checker", "server_settings"))
2765
for name, typ in (inspect.getmembers
2766
(dbus.service.Object)):
2769
client_dict["encrypted_secret"] = (client
2771
for attr in client.client_structure:
2772
if attr not in exclude:
2773
client_dict[attr] = getattr(client, attr)
2775
clients[client.name] = client_dict
2776
del client_settings[client.name]["secret"]
2779
with (tempfile.NamedTemporaryFile
2780
(mode='wb', suffix=".pickle", prefix='clients-',
2781
dir=os.path.dirname(stored_state_path),
2782
delete=False)) as stored_state:
2783
pickle.dump((clients, client_settings), stored_state)
2784
tempname=stored_state.name
2785
os.rename(tempname, stored_state_path)
2786
except (IOError, OSError) as e:
2792
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
2793
logger.warning("Could not save persistent state: {0}"
2794
.format(os.strerror(e.errno)))
2796
logger.warning("Could not save persistent state:",
2800
# Delete all clients, and settings from config
2801
while tcp_server.clients:
2802
name, client = tcp_server.clients.popitem()
2804
client.remove_from_connection()
2805
# Don't signal anything except ClientRemoved
2806
client.disable(quiet=True)
2809
mandos_dbus_service.ClientRemoved(client
2812
client_settings.clear()
770
# From the Avahi example code
771
if not group is None:
774
# End of Avahi example code
777
client = clients.pop()
778
client.stop_hook = None
2814
781
atexit.register(cleanup)
2816
for client in tcp_server.clients.itervalues():
2819
mandos_dbus_service.ClientAdded(client.dbus_object_path)
2820
# Need to initiate checking of clients
2822
client.init_checker()
2825
tcp_server.server_activate()
784
signal.signal(signal.SIGINT, signal.SIG_IGN)
785
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
786
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
788
for client in clients:
791
tcp_server = IPv6_TCPServer((server_settings["address"],
792
server_settings["port"]),
794
settings=server_settings,
2827
796
# Find out what port we got
2828
797
service.port = tcp_server.socket.getsockname()[1]
2830
logger.info("Now listening on address %r, port %d,"
2831
" flowinfo %d, scope_id %d",
2832
*tcp_server.socket.getsockname())
2834
logger.info("Now listening on address %r, port %d",
2835
*tcp_server.socket.getsockname())
798
logger.info(u"Now listening on address %r, port %d, flowinfo %d,"
799
u" scope_id %d" % tcp_server.socket.getsockname())
2837
801
#service.interface = tcp_server.socket.getsockname()[3]
2840
804
# From the Avahi example code
805
server.connect_to_signal("StateChanged", server_state_changed)
2843
except dbus.exceptions.DBusException as error:
2844
logger.critical("D-Bus Exception", exc_info=error)
807
server_state_changed(server.GetState())
808
except dbus.exceptions.DBusException, error:
809
logger.critical(u"DBusException: %s", error)
2847
811
# End of Avahi example code
2849
813
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2850
814
lambda *args, **kwargs:
2851
(tcp_server.handle_request
2852
(*args[2:], **kwargs) or True))
815
tcp_server.handle_request\
816
(*args[2:], **kwargs) or True)
2854
818
logger.debug("Starting main loop")
819
main_loop_started = True
2856
except AvahiError as error:
2857
logger.critical("Avahi Error", exc_info=error)
821
except AvahiError, error:
822
logger.critical(u"AvahiError: %s" + unicode(error))
2860
824
except KeyboardInterrupt:
2862
print("", file=sys.stderr)
2863
logger.debug("Server received KeyboardInterrupt")
2864
logger.debug("Server exiting")
2865
# Must run before the D-Bus bus name gets deregistered
2868
828
if __name__ == '__main__':