242
106
max_renames: integer; maximum number of renames
243
107
rename_count: integer; counter so we only rename after collisions
244
108
a sensible number of times
245
group: D-Bus Entry Group
247
bus: dbus.SystemBus()
250
110
def __init__(self, interface = avahi.IF_UNSPEC, name = None,
251
servicetype = None, port = None, TXT = None,
252
domain = "", host = "", max_renames = 32768,
253
protocol = avahi.PROTO_UNSPEC, bus = None):
111
type = None, port = None, TXT = None, domain = "",
112
host = "", max_renames = 32768):
254
113
self.interface = interface
256
self.type = servicetype
258
self.TXT = TXT if TXT is not None else []
259
121
self.domain = domain
261
123
self.rename_count = 0
262
124
self.max_renames = max_renames
263
self.protocol = protocol
264
self.group = None # our entry group
267
self.entry_group_state_changed_match = None
269
125
def rename(self):
270
126
"""Derived from the Avahi example code"""
271
127
if self.rename_count >= self.max_renames:
272
logger.critical("No suitable Zeroconf service name found"
273
" after %i retries, exiting.",
128
logger.critical(u"No suitable Zeroconf service name found"
129
u" after %i retries, exiting.",
275
131
raise AvahiServiceError("Too many renames")
276
self.name = unicode(self.server
277
.GetAlternativeServiceName(self.name))
278
logger.info("Changing Zeroconf service name to %r ...",
132
self.name = server.GetAlternativeServiceName(self.name)
133
logger.info(u"Changing Zeroconf service name to %r ...",
135
syslogger.setFormatter(logging.Formatter\
136
('Mandos (%s): %%(levelname)s:'
137
' %%(message)s' % self.name))
283
except dbus.exceptions.DBusException as error:
284
logger.critical("D-Bus Exception", exc_info=error)
287
140
self.rename_count += 1
289
141
def remove(self):
290
142
"""Derived from the Avahi example code"""
291
if self.entry_group_state_changed_match is not None:
292
self.entry_group_state_changed_match.remove()
293
self.entry_group_state_changed_match = None
294
if self.group is not None:
143
if group is not None:
298
146
"""Derived from the Avahi example code"""
300
if self.group is None:
301
self.group = dbus.Interface(
302
self.bus.get_object(avahi.DBUS_NAME,
303
self.server.EntryGroupNew()),
304
avahi.DBUS_INTERFACE_ENTRY_GROUP)
305
self.entry_group_state_changed_match = (
306
self.group.connect_to_signal(
307
'StateChanged', self.entry_group_state_changed))
308
logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
309
self.name, self.type)
310
self.group.AddService(
313
dbus.UInt32(0), # flags
314
self.name, self.type,
315
self.domain, self.host,
316
dbus.UInt16(self.port),
317
avahi.string_array_to_txt_array(self.TXT))
320
def entry_group_state_changed(self, state, error):
321
"""Derived from the Avahi example code"""
322
logger.debug("Avahi entry group state change: %i", state)
324
if state == avahi.ENTRY_GROUP_ESTABLISHED:
325
logger.debug("Zeroconf service established.")
326
elif state == avahi.ENTRY_GROUP_COLLISION:
327
logger.info("Zeroconf service name collision.")
329
elif state == avahi.ENTRY_GROUP_FAILURE:
330
logger.critical("Avahi: Error in group state changed %s",
332
raise AvahiGroupError("State changed: {0!s}"
336
"""Derived from the Avahi example code"""
337
if self.group is not None:
340
except (dbus.exceptions.UnknownMethodException,
341
dbus.exceptions.DBusException):
346
def server_state_changed(self, state, error=None):
347
"""Derived from the Avahi example code"""
348
logger.debug("Avahi server state change: %i", state)
349
bad_states = { avahi.SERVER_INVALID:
350
"Zeroconf server invalid",
351
avahi.SERVER_REGISTERING: None,
352
avahi.SERVER_COLLISION:
353
"Zeroconf server name collision",
354
avahi.SERVER_FAILURE:
355
"Zeroconf server failure" }
356
if state in bad_states:
357
if bad_states[state] is not None:
359
logger.error(bad_states[state])
361
logger.error(bad_states[state] + ": %r", error)
363
elif state == avahi.SERVER_RUNNING:
367
logger.debug("Unknown state: %r", state)
369
logger.debug("Unknown state: %r: %r", state, error)
372
"""Derived from the Avahi example code"""
373
if self.server is None:
374
self.server = dbus.Interface(
375
self.bus.get_object(avahi.DBUS_NAME,
376
avahi.DBUS_PATH_SERVER,
377
follow_name_owner_changes=True),
378
avahi.DBUS_INTERFACE_SERVER)
379
self.server.connect_to_signal("StateChanged",
380
self.server_state_changed)
381
self.server_state_changed(self.server.GetState())
384
class AvahiServiceToSyslog(AvahiService):
386
"""Add the new name to the syslog messages"""
387
ret = AvahiService.rename(self)
388
syslogger.setFormatter(logging.Formatter
389
('Mandos ({0}) [%(process)d]:'
390
' %(levelname)s: %(message)s'
395
def timedelta_to_milliseconds(td):
396
"Convert a datetime.timedelta() to milliseconds"
397
return ((td.days * 24 * 60 * 60 * 1000)
398
+ (td.seconds * 1000)
399
+ (td.microseconds // 1000))
149
group = dbus.Interface\
150
(bus.get_object(avahi.DBUS_NAME,
151
server.EntryGroupNew()),
152
avahi.DBUS_INTERFACE_ENTRY_GROUP)
153
group.connect_to_signal('StateChanged',
154
entry_group_state_changed)
155
logger.debug(u"Adding Zeroconf service '%s' of type '%s' ...",
156
service.name, service.type)
158
self.interface, # interface
159
avahi.PROTO_INET6, # protocol
160
dbus.UInt32(0), # flags
161
self.name, self.type,
162
self.domain, self.host,
163
dbus.UInt16(self.port),
164
avahi.string_array_to_txt_array(self.TXT))
167
# From the Avahi example code:
168
group = None # our entry group
169
# End of Avahi example code
402
172
class Client(object):
403
173
"""A representation of a client host served by this server.
406
approved: bool(); 'None' if not yet approved/disapproved
407
approval_delay: datetime.timedelta(); Time to wait for approval
408
approval_duration: datetime.timedelta(); Duration of one approval
409
checker: subprocess.Popen(); a running checker process used
410
to see if the client lives.
411
'None' if no process is running.
412
checker_callback_tag: a gobject event source tag, or None
413
checker_command: string; External command which is run to check
414
if client lives. %() expansions are done at
175
name: string; from the config file, used in log messages
176
fingerprint: string (40 or 32 hexadecimal digits); used to
177
uniquely identify the client
178
secret: bytestring; sent verbatim (over TLS) to client
179
host: string; available for use by the checker command
180
created: datetime.datetime(); object creation, not client host
181
last_checked_ok: datetime.datetime() or None if not yet checked OK
182
timeout: datetime.timedelta(); How long from last_checked_ok
183
until this client is invalid
184
interval: datetime.timedelta(); How often to start a new checker
185
stop_hook: If set, called by stop() as stop_hook(self)
186
checker: subprocess.Popen(); a running checker process used
187
to see if the client lives.
188
'None' if no process is running.
189
checker_initiator_tag: a gobject event source tag, or None
190
stop_initiator_tag: - '' -
191
checker_callback_tag: - '' -
192
checker_command: string; External command which is run to check if
193
client lives. %() expansions are done at
415
194
runtime with vars(self) as dict, so that for
416
195
instance %(name)s can be used in the command.
417
checker_initiator_tag: a gobject event source tag, or None
418
created: datetime.datetime(); (UTC) object creation
419
client_structure: Object describing what attributes a client has
420
and is used for storing the client at exit
421
current_checker_command: string; current running checker_command
422
disable_initiator_tag: a gobject event source tag, or None
424
fingerprint: string (40 or 32 hexadecimal digits); used to
425
uniquely identify the client
426
host: string; available for use by the checker command
427
interval: datetime.timedelta(); How often to start a new checker
428
last_approval_request: datetime.datetime(); (UTC) or None
429
last_checked_ok: datetime.datetime(); (UTC) or None
430
last_checker_status: integer between 0 and 255 reflecting exit
431
status of last checker. -1 reflects crashed
432
checker, -2 means no checker completed yet.
433
last_enabled: datetime.datetime(); (UTC) or None
434
name: string; from the config file, used in log messages and
436
secret: bytestring; sent verbatim (over TLS) to client
437
timeout: datetime.timedelta(); How long from last_checked_ok
438
until this client is disabled
439
extended_timeout: extra long timeout when secret has been sent
440
runtime_expansions: Allowed attributes for runtime expansion.
441
expires: datetime.datetime(); time (UTC) when a client will be
197
_timeout: Real variable for 'timeout'
198
_interval: Real variable for 'interval'
199
_timeout_milliseconds: Used when calling gobject.timeout_add()
200
_interval_milliseconds: - '' -
445
runtime_expansions = ("approval_delay", "approval_duration",
446
"created", "enabled", "expires",
447
"fingerprint", "host", "interval",
448
"last_approval_request", "last_checked_ok",
449
"last_enabled", "name", "timeout")
450
client_defaults = { "timeout": "PT5M",
451
"extended_timeout": "PT15M",
453
"checker": "fping -q -- %%(host)s",
455
"approval_delay": "PT0S",
456
"approval_duration": "PT1S",
457
"approved_by_default": "True",
461
def timeout_milliseconds(self):
462
"Return the 'timeout' attribute in milliseconds"
463
return timedelta_to_milliseconds(self.timeout)
465
def extended_timeout_milliseconds(self):
466
"Return the 'extended_timeout' attribute in milliseconds"
467
return timedelta_to_milliseconds(self.extended_timeout)
469
def interval_milliseconds(self):
470
"Return the 'interval' attribute in milliseconds"
471
return timedelta_to_milliseconds(self.interval)
473
def approval_delay_milliseconds(self):
474
return timedelta_to_milliseconds(self.approval_delay)
477
def config_parser(config):
478
"""Construct a new dict of client settings of this form:
479
{ client_name: {setting_name: value, ...}, ...}
480
with exceptions for any special settings as defined above.
481
NOTE: Must be a pure function. Must return the same result
482
value given the same arguments.
485
for client_name in config.sections():
486
section = dict(config.items(client_name))
487
client = settings[client_name] = {}
489
client["host"] = section["host"]
490
# Reformat values from string types to Python types
491
client["approved_by_default"] = config.getboolean(
492
client_name, "approved_by_default")
493
client["enabled"] = config.getboolean(client_name,
496
client["fingerprint"] = (section["fingerprint"].upper()
498
if "secret" in section:
499
client["secret"] = section["secret"].decode("base64")
500
elif "secfile" in section:
501
with open(os.path.expanduser(os.path.expandvars
502
(section["secfile"])),
504
client["secret"] = secfile.read()
506
raise TypeError("No secret or secfile for section {0}"
508
client["timeout"] = string_to_delta(section["timeout"])
509
client["extended_timeout"] = string_to_delta(
510
section["extended_timeout"])
511
client["interval"] = string_to_delta(section["interval"])
512
client["approval_delay"] = string_to_delta(
513
section["approval_delay"])
514
client["approval_duration"] = string_to_delta(
515
section["approval_duration"])
516
client["checker_command"] = section["checker"]
517
client["last_approval_request"] = None
518
client["last_checked_ok"] = None
519
client["last_checker_status"] = -2
523
def __init__(self, settings, name = None):
202
def _set_timeout(self, timeout):
203
"Setter function for 'timeout' attribute"
204
self._timeout = timeout
205
self._timeout_milliseconds = ((self.timeout.days
206
* 24 * 60 * 60 * 1000)
207
+ (self.timeout.seconds * 1000)
208
+ (self.timeout.microseconds
210
timeout = property(lambda self: self._timeout,
213
def _set_interval(self, interval):
214
"Setter function for 'interval' attribute"
215
self._interval = interval
216
self._interval_milliseconds = ((self.interval.days
217
* 24 * 60 * 60 * 1000)
218
+ (self.interval.seconds
220
+ (self.interval.microseconds
222
interval = property(lambda self: self._interval,
225
def __init__(self, name = None, stop_hook=None, config={}):
226
"""Note: the 'checker' key in 'config' sets the
227
'checker_command' attribute and *not* the 'checker'
525
# adding all client settings
526
for setting, value in settings.iteritems():
527
setattr(self, setting, value)
530
if not hasattr(self, "last_enabled"):
531
self.last_enabled = datetime.datetime.utcnow()
532
if not hasattr(self, "expires"):
533
self.expires = (datetime.datetime.utcnow()
536
self.last_enabled = None
539
logger.debug("Creating client %r", self.name)
230
logger.debug(u"Creating client %r", self.name)
540
231
# Uppercase and remove spaces from fingerprint for later
541
232
# comparison purposes with return value from the fingerprint()
543
logger.debug(" Fingerprint: %s", self.fingerprint)
544
self.created = settings.get("created",
545
datetime.datetime.utcnow())
547
# attributes specific for this server instance
234
self.fingerprint = config["fingerprint"].upper()\
236
logger.debug(u" Fingerprint: %s", self.fingerprint)
237
if "secret" in config:
238
self.secret = config["secret"].decode(u"base64")
239
elif "secfile" in config:
240
sf = open(config["secfile"])
241
self.secret = sf.read()
244
raise TypeError(u"No secret or secfile for client %s"
246
self.host = config.get("host", "")
247
self.created = datetime.datetime.now()
248
self.last_checked_ok = None
249
self.timeout = string_to_delta(config["timeout"])
250
self.interval = string_to_delta(config["interval"])
251
self.stop_hook = stop_hook
548
252
self.checker = None
549
253
self.checker_initiator_tag = None
550
self.disable_initiator_tag = None
254
self.stop_initiator_tag = None
551
255
self.checker_callback_tag = None
552
self.current_checker_command = None
554
self.approvals_pending = 0
555
self.changedstate = (multiprocessing_manager
556
.Condition(multiprocessing_manager
558
self.client_structure = [attr for attr in
559
self.__dict__.iterkeys()
560
if not attr.startswith("_")]
561
self.client_structure.append("client_structure")
563
for name, t in inspect.getmembers(type(self),
567
if not name.startswith("_"):
568
self.client_structure.append(name)
570
# Send notice to process children that client state has changed
571
def send_changedstate(self):
572
with self.changedstate:
573
self.changedstate.notify_all()
256
self.check_command = config["checker"]
576
258
"""Start this client's checker and timeout hooks"""
577
if getattr(self, "enabled", False):
580
self.expires = datetime.datetime.utcnow() + self.timeout
582
self.last_enabled = datetime.datetime.utcnow()
584
self.send_changedstate()
586
def disable(self, quiet=True):
587
"""Disable this client."""
588
if not getattr(self, "enabled", False):
591
logger.info("Disabling client %s", self.name)
592
if getattr(self, "disable_initiator_tag", None) is not None:
593
gobject.source_remove(self.disable_initiator_tag)
594
self.disable_initiator_tag = None
596
if getattr(self, "checker_initiator_tag", None) is not None:
597
gobject.source_remove(self.checker_initiator_tag)
598
self.checker_initiator_tag = None
602
self.send_changedstate()
603
# Do not run this again if called by a gobject.timeout_add
609
def init_checker(self):
610
259
# Schedule a new checker to be started an 'interval' from now,
611
260
# and every interval from then on.
612
if self.checker_initiator_tag is not None:
613
gobject.source_remove(self.checker_initiator_tag)
614
self.checker_initiator_tag = (gobject.timeout_add
615
(self.interval_milliseconds(),
617
# Schedule a disable() when 'timeout' has passed
618
if self.disable_initiator_tag is not None:
619
gobject.source_remove(self.disable_initiator_tag)
620
self.disable_initiator_tag = (gobject.timeout_add
621
(self.timeout_milliseconds(),
261
self.checker_initiator_tag = gobject.timeout_add\
262
(self._interval_milliseconds,
623
264
# Also start a new checker *right now*.
624
265
self.start_checker()
626
def checker_callback(self, pid, condition, command):
266
# Schedule a stop() when 'timeout' has passed
267
self.stop_initiator_tag = gobject.timeout_add\
268
(self._timeout_milliseconds,
272
The possibility that a client might be restarted is left open,
273
but not currently used."""
274
# If this client doesn't have a secret, it is already stopped.
275
if hasattr(self, "secret") and self.secret:
276
logger.info(u"Stopping client %s", self.name)
280
if getattr(self, "stop_initiator_tag", False):
281
gobject.source_remove(self.stop_initiator_tag)
282
self.stop_initiator_tag = None
283
if getattr(self, "checker_initiator_tag", False):
284
gobject.source_remove(self.checker_initiator_tag)
285
self.checker_initiator_tag = None
289
# Do not run this again if called by a gobject.timeout_add
292
self.stop_hook = None
294
def checker_callback(self, pid, condition):
627
295
"""The checker has completed, so take appropriate actions."""
296
now = datetime.datetime.now()
628
297
self.checker_callback_tag = None
629
298
self.checker = None
630
if os.WIFEXITED(condition):
631
self.last_checker_status = os.WEXITSTATUS(condition)
632
if self.last_checker_status == 0:
633
logger.info("Checker for %(name)s succeeded",
637
logger.info("Checker for %(name)s failed",
640
self.last_checker_status = -1
641
logger.warning("Checker for %(name)s crashed?",
299
if os.WIFEXITED(condition) \
300
and (os.WEXITSTATUS(condition) == 0):
301
logger.info(u"Checker for %(name)s succeeded",
303
self.last_checked_ok = now
304
gobject.source_remove(self.stop_initiator_tag)
305
self.stop_initiator_tag = gobject.timeout_add\
306
(self._timeout_milliseconds,
308
elif not os.WIFEXITED(condition):
309
logger.warning(u"Checker for %(name)s crashed?",
644
def checked_ok(self):
645
"""Assert that the client has been seen, alive and well."""
646
self.last_checked_ok = datetime.datetime.utcnow()
647
self.last_checker_status = 0
650
def bump_timeout(self, timeout=None):
651
"""Bump up the timeout for this client."""
653
timeout = self.timeout
654
if self.disable_initiator_tag is not None:
655
gobject.source_remove(self.disable_initiator_tag)
656
self.disable_initiator_tag = None
657
if getattr(self, "enabled", False):
658
self.disable_initiator_tag = (gobject.timeout_add
659
(timedelta_to_milliseconds
660
(timeout), self.disable))
661
self.expires = datetime.datetime.utcnow() + timeout
663
def need_approval(self):
664
self.last_approval_request = datetime.datetime.utcnow()
312
logger.info(u"Checker for %(name)s failed",
666
314
def start_checker(self):
667
315
"""Start a new checker subprocess if one is not running.
669
316
If a checker already exists, leave it running and do
671
318
# The reason for not killing a running checker is that if we
672
# did that, and if a checker (for some reason) started running
673
# slowly and taking more than 'interval' time, then the client
674
# would inevitably timeout, since no checker would get a
675
# chance to run to completion. If we instead leave running
319
# did that, then if a checker (for some reason) started
320
# running slowly and taking more than 'interval' time, the
321
# client would inevitably timeout, since no checker would get
322
# a chance to run to completion. If we instead leave running
676
323
# checkers alone, the checker would have to take more time
677
# than 'timeout' for the client to be disabled, which is as it
680
# If a checker exists, make sure it is not a zombie
682
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
683
except (AttributeError, OSError) as error:
684
if (isinstance(error, OSError)
685
and error.errno != errno.ECHILD):
689
logger.warning("Checker was a zombie")
690
gobject.source_remove(self.checker_callback_tag)
691
self.checker_callback(pid, status,
692
self.current_checker_command)
693
# Start a new checker if needed
324
# than 'timeout' for the client to be declared invalid, which
325
# is as it should be.
694
326
if self.checker is None:
695
# Escape attributes for the shell
696
escaped_attrs = dict(
697
(attr, re.escape(unicode(getattr(self, attr))))
699
self.runtime_expansions)
701
command = self.checker_command % escaped_attrs
702
except TypeError as error:
703
logger.error('Could not format string "%s"',
704
self.checker_command, exc_info=error)
705
return True # Try again later
706
self.current_checker_command = command
708
logger.info("Starting checker %r for %s",
328
# In case check_command has exactly one % operator
329
command = self.check_command % self.host
331
# Escape attributes for the shell
332
escaped_attrs = dict((key, re.escape(str(val)))
334
vars(self).iteritems())
336
command = self.check_command % escaped_attrs
337
except TypeError, error:
338
logger.error(u'Could not format string "%s":'
339
u' %s', self.check_command, error)
340
return True # Try again later
342
logger.info(u"Starting checker %r for %s",
709
343
command, self.name)
710
344
# We don't need to redirect stdout and stderr, since
711
345
# in normal mode, that is already done by daemon(),
746
363
self.checker_callback_tag = None
747
364
if getattr(self, "checker", None) is None:
749
logger.debug("Stopping checker for %(name)s", vars(self))
366
logger.debug(u"Stopping checker for %(name)s", vars(self))
751
self.checker.terminate()
368
os.kill(self.checker.pid, signal.SIGTERM)
753
370
#if self.checker.poll() is None:
754
# self.checker.kill()
755
except OSError as error:
371
# os.kill(self.checker.pid, signal.SIGKILL)
372
except OSError, error:
756
373
if error.errno != errno.ESRCH: # No such process
758
375
self.checker = None
761
def dbus_service_property(dbus_interface, signature="v",
762
access="readwrite", byte_arrays=False):
763
"""Decorators for marking methods of a DBusObjectWithProperties to
764
become properties on the D-Bus.
766
The decorated method will be called with no arguments by "Get"
767
and with one argument by "Set".
769
The parameters, where they are supported, are the same as
770
dbus.service.method, except there is only "signature", since the
771
type from Get() and the type sent to Set() is the same.
773
# Encoding deeply encoded byte arrays is not supported yet by the
774
# "Set" method, so we fail early here:
775
if byte_arrays and signature != "ay":
776
raise ValueError("Byte arrays not supported for non-'ay'"
777
" signature {0!r}".format(signature))
779
func._dbus_is_property = True
780
func._dbus_interface = dbus_interface
781
func._dbus_signature = signature
782
func._dbus_access = access
783
func._dbus_name = func.__name__
784
if func._dbus_name.endswith("_dbus_property"):
785
func._dbus_name = func._dbus_name[:-14]
786
func._dbus_get_args_options = {'byte_arrays': byte_arrays }
791
def dbus_interface_annotations(dbus_interface):
792
"""Decorator for marking functions returning interface annotations
796
@dbus_interface_annotations("org.example.Interface")
797
def _foo(self): # Function name does not matter
798
return {"org.freedesktop.DBus.Deprecated": "true",
799
"org.freedesktop.DBus.Property.EmitsChangedSignal":
803
func._dbus_is_interface = True
804
func._dbus_interface = dbus_interface
805
func._dbus_name = dbus_interface
810
def dbus_annotations(annotations):
811
"""Decorator to annotate D-Bus methods, signals or properties
814
@dbus_service_property("org.example.Interface", signature="b",
816
@dbus_annotations({{"org.freedesktop.DBus.Deprecated": "true",
817
"org.freedesktop.DBus.Property."
818
"EmitsChangedSignal": "false"})
819
def Property_dbus_property(self):
820
return dbus.Boolean(False)
823
func._dbus_annotations = annotations
828
class DBusPropertyException(dbus.exceptions.DBusException):
829
"""A base class for D-Bus property-related exceptions
831
def __unicode__(self):
832
return unicode(str(self))
835
class DBusPropertyAccessException(DBusPropertyException):
836
"""A property's access permissions disallows an operation.
841
class DBusPropertyNotFound(DBusPropertyException):
842
"""An attempt was made to access a non-existing property.
847
class DBusObjectWithProperties(dbus.service.Object):
848
"""A D-Bus object with properties.
850
Classes inheriting from this can use the dbus_service_property
851
decorator to expose methods as D-Bus properties. It exposes the
852
standard Get(), Set(), and GetAll() methods on the D-Bus.
856
def _is_dbus_thing(thing):
857
"""Returns a function testing if an attribute is a D-Bus thing
859
If called like _is_dbus_thing("method") it returns a function
860
suitable for use as predicate to inspect.getmembers().
862
return lambda obj: getattr(obj, "_dbus_is_{0}".format(thing),
865
def _get_all_dbus_things(self, thing):
866
"""Returns a generator of (name, attribute) pairs
868
return ((getattr(athing.__get__(self), "_dbus_name",
870
athing.__get__(self))
871
for cls in self.__class__.__mro__
873
inspect.getmembers(cls,
874
self._is_dbus_thing(thing)))
876
def _get_dbus_property(self, interface_name, property_name):
877
"""Returns a bound method if one exists which is a D-Bus
878
property with the specified name and interface.
880
for cls in self.__class__.__mro__:
881
for name, value in (inspect.getmembers
883
self._is_dbus_thing("property"))):
884
if (value._dbus_name == property_name
885
and value._dbus_interface == interface_name):
886
return value.__get__(self)
889
raise DBusPropertyNotFound(self.dbus_object_path + ":"
890
+ interface_name + "."
893
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
895
def Get(self, interface_name, property_name):
896
"""Standard D-Bus property Get() method, see D-Bus standard.
898
prop = self._get_dbus_property(interface_name, property_name)
899
if prop._dbus_access == "write":
900
raise DBusPropertyAccessException(property_name)
902
if not hasattr(value, "variant_level"):
904
return type(value)(value, variant_level=value.variant_level+1)
906
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
907
def Set(self, interface_name, property_name, value):
908
"""Standard D-Bus property Set() method, see D-Bus standard.
910
prop = self._get_dbus_property(interface_name, property_name)
911
if prop._dbus_access == "read":
912
raise DBusPropertyAccessException(property_name)
913
if prop._dbus_get_args_options["byte_arrays"]:
914
# The byte_arrays option is not supported yet on
915
# signatures other than "ay".
916
if prop._dbus_signature != "ay":
918
value = dbus.ByteArray(b''.join(chr(byte)
922
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
923
out_signature="a{sv}")
924
def GetAll(self, interface_name):
925
"""Standard D-Bus property GetAll() method, see D-Bus
928
Note: Will not include properties with access="write".
931
for name, prop in self._get_all_dbus_things("property"):
933
and interface_name != prop._dbus_interface):
934
# Interface non-empty but did not match
936
# Ignore write-only properties
937
if prop._dbus_access == "write":
940
if not hasattr(value, "variant_level"):
941
properties[name] = value
943
properties[name] = type(value)(value, variant_level=
944
value.variant_level+1)
945
return dbus.Dictionary(properties, signature="sv")
947
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
949
path_keyword='object_path',
950
connection_keyword='connection')
951
def Introspect(self, object_path, connection):
952
"""Overloading of standard D-Bus method.
954
Inserts property tags and interface annotation tags.
956
xmlstring = dbus.service.Object.Introspect(self, object_path,
959
document = xml.dom.minidom.parseString(xmlstring)
960
def make_tag(document, name, prop):
961
e = document.createElement("property")
962
e.setAttribute("name", name)
963
e.setAttribute("type", prop._dbus_signature)
964
e.setAttribute("access", prop._dbus_access)
966
for if_tag in document.getElementsByTagName("interface"):
968
for tag in (make_tag(document, name, prop)
970
in self._get_all_dbus_things("property")
971
if prop._dbus_interface
972
== if_tag.getAttribute("name")):
973
if_tag.appendChild(tag)
974
# Add annotation tags
975
for typ in ("method", "signal", "property"):
976
for tag in if_tag.getElementsByTagName(typ):
978
for name, prop in (self.
979
_get_all_dbus_things(typ)):
980
if (name == tag.getAttribute("name")
981
and prop._dbus_interface
982
== if_tag.getAttribute("name")):
983
annots.update(getattr
987
for name, value in annots.iteritems():
988
ann_tag = document.createElement(
990
ann_tag.setAttribute("name", name)
991
ann_tag.setAttribute("value", value)
992
tag.appendChild(ann_tag)
993
# Add interface annotation tags
994
for annotation, value in dict(
995
itertools.chain.from_iterable(
996
annotations().iteritems()
997
for name, annotations in
998
self._get_all_dbus_things("interface")
999
if name == if_tag.getAttribute("name")
1001
ann_tag = document.createElement("annotation")
1002
ann_tag.setAttribute("name", annotation)
1003
ann_tag.setAttribute("value", value)
1004
if_tag.appendChild(ann_tag)
1005
# Add the names to the return values for the
1006
# "org.freedesktop.DBus.Properties" methods
1007
if (if_tag.getAttribute("name")
1008
== "org.freedesktop.DBus.Properties"):
1009
for cn in if_tag.getElementsByTagName("method"):
1010
if cn.getAttribute("name") == "Get":
1011
for arg in cn.getElementsByTagName("arg"):
1012
if (arg.getAttribute("direction")
1014
arg.setAttribute("name", "value")
1015
elif cn.getAttribute("name") == "GetAll":
1016
for arg in cn.getElementsByTagName("arg"):
1017
if (arg.getAttribute("direction")
1019
arg.setAttribute("name", "props")
1020
xmlstring = document.toxml("utf-8")
1022
except (AttributeError, xml.dom.DOMException,
1023
xml.parsers.expat.ExpatError) as error:
1024
logger.error("Failed to override Introspection method",
1029
def datetime_to_dbus(dt, variant_level=0):
1030
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1032
return dbus.String("", variant_level = variant_level)
1033
return dbus.String(dt.isoformat(),
1034
variant_level=variant_level)
1037
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1038
"""A class decorator; applied to a subclass of
1039
dbus.service.Object, it will add alternate D-Bus attributes with
1040
interface names according to the "alt_interface_names" mapping.
1043
@alternate_dbus_interfaces({"org.example.Interface":
1044
"net.example.AlternateInterface"})
1045
class SampleDBusObject(dbus.service.Object):
1046
@dbus.service.method("org.example.Interface")
1047
def SampleDBusMethod():
1050
The above "SampleDBusMethod" on "SampleDBusObject" will be
1051
reachable via two interfaces: "org.example.Interface" and
1052
"net.example.AlternateInterface", the latter of which will have
1053
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1054
"true", unless "deprecate" is passed with a False value.
1056
This works for methods and signals, and also for D-Bus properties
1057
(from DBusObjectWithProperties) and interfaces (from the
1058
dbus_interface_annotations decorator).
1061
for orig_interface_name, alt_interface_name in (
1062
alt_interface_names.iteritems()):
1064
interface_names = set()
1065
# Go though all attributes of the class
1066
for attrname, attribute in inspect.getmembers(cls):
1067
# Ignore non-D-Bus attributes, and D-Bus attributes
1068
# with the wrong interface name
1069
if (not hasattr(attribute, "_dbus_interface")
1070
or not attribute._dbus_interface
1071
.startswith(orig_interface_name)):
1073
# Create an alternate D-Bus interface name based on
1075
alt_interface = (attribute._dbus_interface
1076
.replace(orig_interface_name,
1077
alt_interface_name))
1078
interface_names.add(alt_interface)
1079
# Is this a D-Bus signal?
1080
if getattr(attribute, "_dbus_is_signal", False):
1081
# Extract the original non-method undecorated
1082
# function by black magic
1083
nonmethod_func = (dict(
1084
zip(attribute.func_code.co_freevars,
1085
attribute.__closure__))["func"]
1087
# Create a new, but exactly alike, function
1088
# object, and decorate it to be a new D-Bus signal
1089
# with the alternate D-Bus interface name
1090
new_function = (dbus.service.signal
1092
attribute._dbus_signature)
1093
(types.FunctionType(
1094
nonmethod_func.func_code,
1095
nonmethod_func.func_globals,
1096
nonmethod_func.func_name,
1097
nonmethod_func.func_defaults,
1098
nonmethod_func.func_closure)))
1099
# Copy annotations, if any
1101
new_function._dbus_annotations = (
1102
dict(attribute._dbus_annotations))
1103
except AttributeError:
1105
# Define a creator of a function to call both the
1106
# original and alternate functions, so both the
1107
# original and alternate signals gets sent when
1108
# the function is called
1109
def fixscope(func1, func2):
1110
"""This function is a scope container to pass
1111
func1 and func2 to the "call_both" function
1112
outside of its arguments"""
1113
def call_both(*args, **kwargs):
1114
"""This function will emit two D-Bus
1115
signals by calling func1 and func2"""
1116
func1(*args, **kwargs)
1117
func2(*args, **kwargs)
1119
# Create the "call_both" function and add it to
1121
attr[attrname] = fixscope(attribute, new_function)
1122
# Is this a D-Bus method?
1123
elif getattr(attribute, "_dbus_is_method", False):
1124
# Create a new, but exactly alike, function
1125
# object. Decorate it to be a new D-Bus method
1126
# with the alternate D-Bus interface name. Add it
1128
attr[attrname] = (dbus.service.method
1130
attribute._dbus_in_signature,
1131
attribute._dbus_out_signature)
1133
(attribute.func_code,
1134
attribute.func_globals,
1135
attribute.func_name,
1136
attribute.func_defaults,
1137
attribute.func_closure)))
1138
# Copy annotations, if any
1140
attr[attrname]._dbus_annotations = (
1141
dict(attribute._dbus_annotations))
1142
except AttributeError:
1144
# Is this a D-Bus property?
1145
elif getattr(attribute, "_dbus_is_property", False):
1146
# Create a new, but exactly alike, function
1147
# object, and decorate it to be a new D-Bus
1148
# property with the alternate D-Bus interface
1149
# name. Add it to the class.
1150
attr[attrname] = (dbus_service_property
1152
attribute._dbus_signature,
1153
attribute._dbus_access,
1155
._dbus_get_args_options
1158
(attribute.func_code,
1159
attribute.func_globals,
1160
attribute.func_name,
1161
attribute.func_defaults,
1162
attribute.func_closure)))
1163
# Copy annotations, if any
1165
attr[attrname]._dbus_annotations = (
1166
dict(attribute._dbus_annotations))
1167
except AttributeError:
1169
# Is this a D-Bus interface?
1170
elif getattr(attribute, "_dbus_is_interface", False):
1171
# Create a new, but exactly alike, function
1172
# object. Decorate it to be a new D-Bus interface
1173
# with the alternate D-Bus interface name. Add it
1175
attr[attrname] = (dbus_interface_annotations
1178
(attribute.func_code,
1179
attribute.func_globals,
1180
attribute.func_name,
1181
attribute.func_defaults,
1182
attribute.func_closure)))
1184
# Deprecate all alternate interfaces
1185
iname="_AlternateDBusNames_interface_annotation{0}"
1186
for interface_name in interface_names:
1187
@dbus_interface_annotations(interface_name)
1189
return { "org.freedesktop.DBus.Deprecated":
1191
# Find an unused name
1192
for aname in (iname.format(i)
1193
for i in itertools.count()):
1194
if aname not in attr:
1198
# Replace the class with a new subclass of it with
1199
# methods, signals, etc. as created above.
1200
cls = type(b"{0}Alternate".format(cls.__name__),
1206
@alternate_dbus_interfaces({"se.recompile.Mandos":
1207
"se.bsnet.fukt.Mandos"})
1208
class ClientDBus(Client, DBusObjectWithProperties):
1209
"""A Client class using D-Bus
1212
dbus_object_path: dbus.ObjectPath
1213
bus: dbus.SystemBus()
1216
runtime_expansions = (Client.runtime_expansions
1217
+ ("dbus_object_path",))
1219
# dbus.service.Object doesn't use super(), so we can't either.
1221
def __init__(self, bus = None, *args, **kwargs):
1223
Client.__init__(self, *args, **kwargs)
1224
# Only now, when this client is initialized, can it show up on
1226
client_object_name = unicode(self.name).translate(
1227
{ord("."): ord("_"),
1228
ord("-"): ord("_")})
1229
self.dbus_object_path = (dbus.ObjectPath
1230
("/clients/" + client_object_name))
1231
DBusObjectWithProperties.__init__(self, self.bus,
1232
self.dbus_object_path)
1234
def notifychangeproperty(transform_func,
1235
dbus_name, type_func=lambda x: x,
1237
""" Modify a variable so that it's a property which announces
1238
its changes to DBus.
1240
transform_fun: Function that takes a value and a variant_level
1241
and transforms it to a D-Bus type.
1242
dbus_name: D-Bus name of the variable
1243
type_func: Function that transform the value before sending it
1244
to the D-Bus. Default: no transform
1245
variant_level: D-Bus variant level. Default: 1
1247
attrname = "_{0}".format(dbus_name)
1248
def setter(self, value):
1249
if hasattr(self, "dbus_object_path"):
1250
if (not hasattr(self, attrname) or
1251
type_func(getattr(self, attrname, None))
1252
!= type_func(value)):
1253
dbus_value = transform_func(type_func(value),
1256
self.PropertyChanged(dbus.String(dbus_name),
1258
setattr(self, attrname, value)
1260
return property(lambda self: getattr(self, attrname), setter)
1262
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1263
approvals_pending = notifychangeproperty(dbus.Boolean,
1266
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1267
last_enabled = notifychangeproperty(datetime_to_dbus,
1269
checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1270
type_func = lambda checker:
1271
checker is not None)
1272
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1274
last_checker_status = notifychangeproperty(dbus.Int16,
1275
"LastCheckerStatus")
1276
last_approval_request = notifychangeproperty(
1277
datetime_to_dbus, "LastApprovalRequest")
1278
approved_by_default = notifychangeproperty(dbus.Boolean,
1279
"ApprovedByDefault")
1280
approval_delay = notifychangeproperty(dbus.UInt64,
1283
timedelta_to_milliseconds)
1284
approval_duration = notifychangeproperty(
1285
dbus.UInt64, "ApprovalDuration",
1286
type_func = timedelta_to_milliseconds)
1287
host = notifychangeproperty(dbus.String, "Host")
1288
timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1290
timedelta_to_milliseconds)
1291
extended_timeout = notifychangeproperty(
1292
dbus.UInt64, "ExtendedTimeout",
1293
type_func = timedelta_to_milliseconds)
1294
interval = notifychangeproperty(dbus.UInt64,
1297
timedelta_to_milliseconds)
1298
checker_command = notifychangeproperty(dbus.String, "Checker")
1300
del notifychangeproperty
1302
def __del__(self, *args, **kwargs):
1304
self.remove_from_connection()
1307
if hasattr(DBusObjectWithProperties, "__del__"):
1308
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1309
Client.__del__(self, *args, **kwargs)
1311
def checker_callback(self, pid, condition, command,
1313
self.checker_callback_tag = None
1315
if os.WIFEXITED(condition):
1316
exitstatus = os.WEXITSTATUS(condition)
1318
self.CheckerCompleted(dbus.Int16(exitstatus),
1319
dbus.Int64(condition),
1320
dbus.String(command))
1323
self.CheckerCompleted(dbus.Int16(-1),
1324
dbus.Int64(condition),
1325
dbus.String(command))
1327
return Client.checker_callback(self, pid, condition, command,
1330
def start_checker(self, *args, **kwargs):
1331
old_checker = self.checker
1332
if self.checker is not None:
1333
old_checker_pid = self.checker.pid
1335
old_checker_pid = None
1336
r = Client.start_checker(self, *args, **kwargs)
1337
# Only if new checker process was started
1338
if (self.checker is not None
1339
and old_checker_pid != self.checker.pid):
1341
self.CheckerStarted(self.current_checker_command)
1344
def _reset_approved(self):
1345
self.approved = None
1348
def approve(self, value=True):
1349
self.approved = value
1350
gobject.timeout_add(timedelta_to_milliseconds
1351
(self.approval_duration),
1352
self._reset_approved)
1353
self.send_changedstate()
1355
## D-Bus methods, signals & properties
1356
_interface = "se.recompile.Mandos.Client"
1360
@dbus_interface_annotations(_interface)
1362
return { "org.freedesktop.DBus.Property.EmitsChangedSignal":
1367
# CheckerCompleted - signal
1368
@dbus.service.signal(_interface, signature="nxs")
1369
def CheckerCompleted(self, exitcode, waitstatus, command):
1373
# CheckerStarted - signal
1374
@dbus.service.signal(_interface, signature="s")
1375
def CheckerStarted(self, command):
1379
# PropertyChanged - signal
1380
@dbus.service.signal(_interface, signature="sv")
1381
def PropertyChanged(self, property, value):
1385
# GotSecret - signal
1386
@dbus.service.signal(_interface)
1387
def GotSecret(self):
1389
Is sent after a successful transfer of secret from the Mandos
1390
server to mandos-client
1395
@dbus.service.signal(_interface, signature="s")
1396
def Rejected(self, reason):
1400
# NeedApproval - signal
1401
@dbus.service.signal(_interface, signature="tb")
1402
def NeedApproval(self, timeout, default):
1404
return self.need_approval()
1409
@dbus.service.method(_interface, in_signature="b")
1410
def Approve(self, value):
1413
# CheckedOK - method
1414
@dbus.service.method(_interface)
1415
def CheckedOK(self):
1419
@dbus.service.method(_interface)
1424
# StartChecker - method
1425
@dbus.service.method(_interface)
1426
def StartChecker(self):
1428
self.start_checker()
1431
@dbus.service.method(_interface)
1436
# StopChecker - method
1437
@dbus.service.method(_interface)
1438
def StopChecker(self):
1443
# ApprovalPending - property
1444
@dbus_service_property(_interface, signature="b", access="read")
1445
def ApprovalPending_dbus_property(self):
1446
return dbus.Boolean(bool(self.approvals_pending))
1448
# ApprovedByDefault - property
1449
@dbus_service_property(_interface, signature="b",
1451
def ApprovedByDefault_dbus_property(self, value=None):
1452
if value is None: # get
1453
return dbus.Boolean(self.approved_by_default)
1454
self.approved_by_default = bool(value)
1456
# ApprovalDelay - property
1457
@dbus_service_property(_interface, signature="t",
1459
def ApprovalDelay_dbus_property(self, value=None):
1460
if value is None: # get
1461
return dbus.UInt64(self.approval_delay_milliseconds())
1462
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1464
# ApprovalDuration - property
1465
@dbus_service_property(_interface, signature="t",
1467
def ApprovalDuration_dbus_property(self, value=None):
1468
if value is None: # get
1469
return dbus.UInt64(timedelta_to_milliseconds(
1470
self.approval_duration))
1471
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1474
@dbus_service_property(_interface, signature="s", access="read")
1475
def Name_dbus_property(self):
1476
return dbus.String(self.name)
1478
# Fingerprint - property
1479
@dbus_service_property(_interface, signature="s", access="read")
1480
def Fingerprint_dbus_property(self):
1481
return dbus.String(self.fingerprint)
1484
@dbus_service_property(_interface, signature="s",
1486
def Host_dbus_property(self, value=None):
1487
if value is None: # get
1488
return dbus.String(self.host)
1489
self.host = unicode(value)
1491
# Created - property
1492
@dbus_service_property(_interface, signature="s", access="read")
1493
def Created_dbus_property(self):
1494
return datetime_to_dbus(self.created)
1496
# LastEnabled - property
1497
@dbus_service_property(_interface, signature="s", access="read")
1498
def LastEnabled_dbus_property(self):
1499
return datetime_to_dbus(self.last_enabled)
1501
# Enabled - property
1502
@dbus_service_property(_interface, signature="b",
1504
def Enabled_dbus_property(self, value=None):
1505
if value is None: # get
1506
return dbus.Boolean(self.enabled)
1512
# LastCheckedOK - property
1513
@dbus_service_property(_interface, signature="s",
1515
def LastCheckedOK_dbus_property(self, value=None):
1516
if value is not None:
1519
return datetime_to_dbus(self.last_checked_ok)
1521
# LastCheckerStatus - property
1522
@dbus_service_property(_interface, signature="n",
1524
def LastCheckerStatus_dbus_property(self):
1525
return dbus.Int16(self.last_checker_status)
1527
# Expires - property
1528
@dbus_service_property(_interface, signature="s", access="read")
1529
def Expires_dbus_property(self):
1530
return datetime_to_dbus(self.expires)
1532
# LastApprovalRequest - property
1533
@dbus_service_property(_interface, signature="s", access="read")
1534
def LastApprovalRequest_dbus_property(self):
1535
return datetime_to_dbus(self.last_approval_request)
1537
# Timeout - property
1538
@dbus_service_property(_interface, signature="t",
1540
def Timeout_dbus_property(self, value=None):
1541
if value is None: # get
1542
return dbus.UInt64(self.timeout_milliseconds())
1543
old_timeout = self.timeout
1544
self.timeout = datetime.timedelta(0, 0, 0, value)
1545
# Reschedule disabling
1547
now = datetime.datetime.utcnow()
1548
self.expires += self.timeout - old_timeout
1549
if self.expires <= now:
1550
# The timeout has passed
1553
if (getattr(self, "disable_initiator_tag", None)
1556
gobject.source_remove(self.disable_initiator_tag)
1557
self.disable_initiator_tag = (
1558
gobject.timeout_add(
1559
timedelta_to_milliseconds(self.expires - now),
1562
# ExtendedTimeout - property
1563
@dbus_service_property(_interface, signature="t",
1565
def ExtendedTimeout_dbus_property(self, value=None):
1566
if value is None: # get
1567
return dbus.UInt64(self.extended_timeout_milliseconds())
1568
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1570
# Interval - property
1571
@dbus_service_property(_interface, signature="t",
1573
def Interval_dbus_property(self, value=None):
1574
if value is None: # get
1575
return dbus.UInt64(self.interval_milliseconds())
1576
self.interval = datetime.timedelta(0, 0, 0, value)
1577
if getattr(self, "checker_initiator_tag", None) is None:
1580
# Reschedule checker run
1581
gobject.source_remove(self.checker_initiator_tag)
1582
self.checker_initiator_tag = (gobject.timeout_add
1583
(value, self.start_checker))
1584
self.start_checker() # Start one now, too
1586
# Checker - property
1587
@dbus_service_property(_interface, signature="s",
1589
def Checker_dbus_property(self, value=None):
1590
if value is None: # get
1591
return dbus.String(self.checker_command)
1592
self.checker_command = unicode(value)
1594
# CheckerRunning - property
1595
@dbus_service_property(_interface, signature="b",
1597
def CheckerRunning_dbus_property(self, value=None):
1598
if value is None: # get
1599
return dbus.Boolean(self.checker is not None)
1601
self.start_checker()
1605
# ObjectPath - property
1606
@dbus_service_property(_interface, signature="o", access="read")
1607
def ObjectPath_dbus_property(self):
1608
return self.dbus_object_path # is already a dbus.ObjectPath
1611
@dbus_service_property(_interface, signature="ay",
1612
access="write", byte_arrays=True)
1613
def Secret_dbus_property(self, value):
1614
self.secret = str(value)
1619
class ProxyClient(object):
1620
def __init__(self, child_pipe, fpr, address):
1621
self._pipe = child_pipe
1622
self._pipe.send(('init', fpr, address))
1623
if not self._pipe.recv():
1626
def __getattribute__(self, name):
1628
return super(ProxyClient, self).__getattribute__(name)
1629
self._pipe.send(('getattr', name))
1630
data = self._pipe.recv()
1631
if data[0] == 'data':
1633
if data[0] == 'function':
1634
def func(*args, **kwargs):
1635
self._pipe.send(('funcall', name, args, kwargs))
1636
return self._pipe.recv()[1]
1639
def __setattr__(self, name, value):
1641
return super(ProxyClient, self).__setattr__(name, value)
1642
self._pipe.send(('setattr', name, value))
1645
class ClientHandler(socketserver.BaseRequestHandler, object):
1646
"""A class to handle client connections.
1648
Instantiated once for each connection to handle it.
376
def still_valid(self):
377
"""Has the timeout not yet passed for this client?"""
378
now = datetime.datetime.now()
379
if self.last_checked_ok is None:
380
return now < (self.created + self.timeout)
382
return now < (self.last_checked_ok + self.timeout)
385
def peer_certificate(session):
386
"Return the peer's OpenPGP certificate as a bytestring"
387
# If not an OpenPGP certificate...
388
if gnutls.library.functions.gnutls_certificate_type_get\
389
(session._c_object) \
390
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP:
391
# ...do the normal thing
392
return session.peer_certificate
393
list_size = ctypes.c_uint()
394
cert_list = gnutls.library.functions.gnutls_certificate_get_peers\
395
(session._c_object, ctypes.byref(list_size))
396
if list_size.value == 0:
399
return ctypes.string_at(cert.data, cert.size)
402
def fingerprint(openpgp):
403
"Convert an OpenPGP bytestring to a hexdigit fingerprint string"
404
# New GnuTLS "datum" with the OpenPGP public key
405
datum = gnutls.library.types.gnutls_datum_t\
406
(ctypes.cast(ctypes.c_char_p(openpgp),
407
ctypes.POINTER(ctypes.c_ubyte)),
408
ctypes.c_uint(len(openpgp)))
409
# New empty GnuTLS certificate
410
crt = gnutls.library.types.gnutls_openpgp_crt_t()
411
gnutls.library.functions.gnutls_openpgp_crt_init\
413
# Import the OpenPGP public key into the certificate
414
gnutls.library.functions.gnutls_openpgp_crt_import\
415
(crt, ctypes.byref(datum),
416
gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
417
# Verify the self signature in the key
418
crtverify = ctypes.c_uint();
419
gnutls.library.functions.gnutls_openpgp_crt_verify_self\
420
(crt, 0, ctypes.byref(crtverify))
421
if crtverify.value != 0:
422
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
423
raise gnutls.errors.CertificateSecurityError("Verify failed")
424
# New buffer for the fingerprint
425
buffer = ctypes.create_string_buffer(20)
426
buffer_length = ctypes.c_size_t()
427
# Get the fingerprint from the certificate into the buffer
428
gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint\
429
(crt, ctypes.byref(buffer), ctypes.byref(buffer_length))
430
# Deinit the certificate
431
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
432
# Convert the buffer to a Python bytestring
433
fpr = ctypes.string_at(buffer, buffer_length.value)
434
# Convert the bytestring to hexadecimal notation
435
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
439
class tcp_handler(SocketServer.BaseRequestHandler, object):
440
"""A TCP request handler class.
441
Instantiated by IPv6_TCPServer for each request to handle it.
1649
442
Note: This will run in its own forked process."""
1651
444
def handle(self):
1652
with contextlib.closing(self.server.child_pipe) as child_pipe:
1653
logger.info("TCP connection from: %s",
1654
unicode(self.client_address))
1655
logger.debug("Pipe FD: %d",
1656
self.server.child_pipe.fileno())
1658
session = (gnutls.connection
1659
.ClientSession(self.request,
1661
.X509Credentials()))
1663
# Note: gnutls.connection.X509Credentials is really a
1664
# generic GnuTLS certificate credentials object so long as
1665
# no X.509 keys are added to it. Therefore, we can use it
1666
# here despite using OpenPGP certificates.
1668
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1669
# "+AES-256-CBC", "+SHA1",
1670
# "+COMP-NULL", "+CTYPE-OPENPGP",
1672
# Use a fallback default, since this MUST be set.
1673
priority = self.server.gnutls_priority
1674
if priority is None:
1676
(gnutls.library.functions
1677
.gnutls_priority_set_direct(session._c_object,
1680
# Start communication using the Mandos protocol
1681
# Get protocol number
1682
line = self.request.makefile().readline()
1683
logger.debug("Protocol version: %r", line)
1685
if int(line.strip().split()[0]) > 1:
1687
except (ValueError, IndexError, RuntimeError) as error:
1688
logger.error("Unknown protocol version: %s", error)
1691
# Start GnuTLS connection
1694
except gnutls.errors.GNUTLSError as error:
1695
logger.warning("Handshake failed: %s", error)
1696
# Do not run session.bye() here: the session is not
1697
# established. Just abandon the request.
1699
logger.debug("Handshake succeeded")
1701
approval_required = False
1704
fpr = self.fingerprint(self.peer_certificate
1707
gnutls.errors.GNUTLSError) as error:
1708
logger.warning("Bad certificate: %s", error)
1710
logger.debug("Fingerprint: %s", fpr)
1713
client = ProxyClient(child_pipe, fpr,
1714
self.client_address)
1718
if client.approval_delay:
1719
delay = client.approval_delay
1720
client.approvals_pending += 1
1721
approval_required = True
1724
if not client.enabled:
1725
logger.info("Client %s is disabled",
1727
if self.server.use_dbus:
1729
client.Rejected("Disabled")
1732
if client.approved or not client.approval_delay:
1733
#We are approved or approval is disabled
1735
elif client.approved is None:
1736
logger.info("Client %s needs approval",
1738
if self.server.use_dbus:
1740
client.NeedApproval(
1741
client.approval_delay_milliseconds(),
1742
client.approved_by_default)
1744
logger.warning("Client %s was not approved",
1746
if self.server.use_dbus:
1748
client.Rejected("Denied")
1751
#wait until timeout or approved
1752
time = datetime.datetime.now()
1753
client.changedstate.acquire()
1754
client.changedstate.wait(
1755
float(timedelta_to_milliseconds(delay)
1757
client.changedstate.release()
1758
time2 = datetime.datetime.now()
1759
if (time2 - time) >= delay:
1760
if not client.approved_by_default:
1761
logger.warning("Client %s timed out while"
1762
" waiting for approval",
1764
if self.server.use_dbus:
1766
client.Rejected("Approval timed out")
1771
delay -= time2 - time
1774
while sent_size < len(client.secret):
1776
sent = session.send(client.secret[sent_size:])
1777
except gnutls.errors.GNUTLSError as error:
1778
logger.warning("gnutls send failed",
1781
logger.debug("Sent: %d, remaining: %d",
1782
sent, len(client.secret)
1783
- (sent_size + sent))
1786
logger.info("Sending secret to %s", client.name)
1787
# bump the timeout using extended_timeout
1788
client.bump_timeout(client.extended_timeout)
1789
if self.server.use_dbus:
1794
if approval_required:
1795
client.approvals_pending -= 1
1798
except gnutls.errors.GNUTLSError as error:
1799
logger.warning("GnuTLS bye failed",
1803
def peer_certificate(session):
1804
"Return the peer's OpenPGP certificate as a bytestring"
1805
# If not an OpenPGP certificate...
1806
if (gnutls.library.functions
1807
.gnutls_certificate_type_get(session._c_object)
1808
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1809
# ...do the normal thing
1810
return session.peer_certificate
1811
list_size = ctypes.c_uint(1)
1812
cert_list = (gnutls.library.functions
1813
.gnutls_certificate_get_peers
1814
(session._c_object, ctypes.byref(list_size)))
1815
if not bool(cert_list) and list_size.value != 0:
1816
raise gnutls.errors.GNUTLSError("error getting peer"
1818
if list_size.value == 0:
1821
return ctypes.string_at(cert.data, cert.size)
1824
def fingerprint(openpgp):
1825
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
1826
# New GnuTLS "datum" with the OpenPGP public key
1827
datum = (gnutls.library.types
1828
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1831
ctypes.c_uint(len(openpgp))))
1832
# New empty GnuTLS certificate
1833
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1834
(gnutls.library.functions
1835
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
1836
# Import the OpenPGP public key into the certificate
1837
(gnutls.library.functions
1838
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1839
gnutls.library.constants
1840
.GNUTLS_OPENPGP_FMT_RAW))
1841
# Verify the self signature in the key
1842
crtverify = ctypes.c_uint()
1843
(gnutls.library.functions
1844
.gnutls_openpgp_crt_verify_self(crt, 0,
1845
ctypes.byref(crtverify)))
1846
if crtverify.value != 0:
1847
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1848
raise (gnutls.errors.CertificateSecurityError
1850
# New buffer for the fingerprint
1851
buf = ctypes.create_string_buffer(20)
1852
buf_len = ctypes.c_size_t()
1853
# Get the fingerprint from the certificate into the buffer
1854
(gnutls.library.functions
1855
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1856
ctypes.byref(buf_len)))
1857
# Deinit the certificate
1858
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1859
# Convert the buffer to a Python bytestring
1860
fpr = ctypes.string_at(buf, buf_len.value)
1861
# Convert the bytestring to hexadecimal notation
1862
hex_fpr = binascii.hexlify(fpr).upper()
1866
class MultiprocessingMixIn(object):
1867
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
1868
def sub_process_main(self, request, address):
1870
self.finish_request(request, address)
1872
self.handle_error(request, address)
1873
self.close_request(request)
1875
def process_request(self, request, address):
1876
"""Start a new process to process the request."""
1877
proc = multiprocessing.Process(target = self.sub_process_main,
1878
args = (request, address))
1883
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1884
""" adds a pipe to the MixIn """
1885
def process_request(self, request, client_address):
1886
"""Overrides and wraps the original process_request().
1888
This function creates a new pipe in self.pipe
1890
parent_pipe, self.child_pipe = multiprocessing.Pipe()
1892
proc = MultiprocessingMixIn.process_request(self, request,
1894
self.child_pipe.close()
1895
self.add_pipe(parent_pipe, proc)
1897
def add_pipe(self, parent_pipe, proc):
1898
"""Dummy function; override as necessary"""
1899
raise NotImplementedError
1902
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1903
socketserver.TCPServer, object):
1904
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
445
logger.info(u"TCP connection from: %s",
446
unicode(self.client_address))
447
session = gnutls.connection.ClientSession\
448
(self.request, gnutls.connection.X509Credentials())
450
line = self.request.makefile().readline()
451
logger.debug(u"Protocol version: %r", line)
453
if int(line.strip().split()[0]) > 1:
455
except (ValueError, IndexError, RuntimeError), error:
456
logger.error(u"Unknown protocol version: %s", error)
459
# Note: gnutls.connection.X509Credentials is really a generic
460
# GnuTLS certificate credentials object so long as no X.509
461
# keys are added to it. Therefore, we can use it here despite
462
# using OpenPGP certificates.
464
#priority = ':'.join(("NONE", "+VERS-TLS1.1", "+AES-256-CBC",
465
# "+SHA1", "+COMP-NULL", "+CTYPE-OPENPGP",
467
priority = "NORMAL" # Fallback default, since this
469
if self.server.settings["priority"]:
470
priority = self.server.settings["priority"]
471
gnutls.library.functions.gnutls_priority_set_direct\
472
(session._c_object, priority, None);
476
except gnutls.errors.GNUTLSError, error:
477
logger.warning(u"Handshake failed: %s", error)
478
# Do not run session.bye() here: the session is not
479
# established. Just abandon the request.
482
fpr = fingerprint(peer_certificate(session))
483
except (TypeError, gnutls.errors.GNUTLSError), error:
484
logger.warning(u"Bad certificate: %s", error)
487
logger.debug(u"Fingerprint: %s", fpr)
489
for c in self.server.clients:
490
if c.fingerprint == fpr:
494
logger.warning(u"Client not found for fingerprint: %s",
498
# Have to check if client.still_valid(), since it is possible
499
# that the client timed out while establishing the GnuTLS
501
if not client.still_valid():
502
logger.warning(u"Client %(name)s is invalid",
507
while sent_size < len(client.secret):
508
sent = session.send(client.secret[sent_size:])
509
logger.debug(u"Sent: %d, remaining: %d",
510
sent, len(client.secret)
511
- (sent_size + sent))
516
class IPv6_TCPServer(SocketServer.ForkingTCPServer, object):
517
"""IPv6 TCP server. Accepts 'None' as address and/or port.
519
settings: Server settings
520
clients: Set() of Client objects
1907
521
enabled: Boolean; whether this server is activated yet
1908
interface: None or a network interface name (string)
1909
use_ipv6: Boolean; to use IPv6 or not
1911
def __init__(self, server_address, RequestHandlerClass,
1912
interface=None, use_ipv6=True, socketfd=None):
1913
"""If socketfd is set, use that file descriptor instead of
1914
creating a new one with socket.socket().
1916
self.interface = interface
1918
self.address_family = socket.AF_INET6
1919
if socketfd is not None:
1920
# Save the file descriptor
1921
self.socketfd = socketfd
1922
# Save the original socket.socket() function
1923
self.socket_socket = socket.socket
1924
# To implement --socket, we monkey patch socket.socket.
1926
# (When socketserver.TCPServer is a new-style class, we
1927
# could make self.socket into a property instead of monkey
1928
# patching socket.socket.)
1930
# Create a one-time-only replacement for socket.socket()
1931
@functools.wraps(socket.socket)
1932
def socket_wrapper(*args, **kwargs):
1933
# Restore original function so subsequent calls are
1935
socket.socket = self.socket_socket
1936
del self.socket_socket
1937
# This time only, return a new socket object from the
1938
# saved file descriptor.
1939
return socket.fromfd(self.socketfd, *args, **kwargs)
1940
# Replace socket.socket() function with wrapper
1941
socket.socket = socket_wrapper
1942
# The socketserver.TCPServer.__init__ will call
1943
# socket.socket(), which might be our replacement,
1944
# socket_wrapper(), if socketfd was set.
1945
socketserver.TCPServer.__init__(self, server_address,
1946
RequestHandlerClass)
523
address_family = socket.AF_INET6
524
def __init__(self, *args, **kwargs):
525
if "settings" in kwargs:
526
self.settings = kwargs["settings"]
527
del kwargs["settings"]
528
if "clients" in kwargs:
529
self.clients = kwargs["clients"]
530
del kwargs["clients"]
532
return super(type(self), self).__init__(*args, **kwargs)
1948
533
def server_bind(self):
1949
534
"""This overrides the normal server_bind() function
1950
535
to bind to an interface if one was specified, and also NOT to
1951
536
bind to an address or port if they were not specified."""
1952
if self.interface is not None:
1953
if SO_BINDTODEVICE is None:
1954
logger.error("SO_BINDTODEVICE does not exist;"
1955
" cannot bind to interface %s",
1959
self.socket.setsockopt(socket.SOL_SOCKET,
1961
str(self.interface + '\0'))
1962
except socket.error as error:
1963
if error.errno == errno.EPERM:
1964
logger.error("No permission to bind to"
1965
" interface %s", self.interface)
1966
elif error.errno == errno.ENOPROTOOPT:
1967
logger.error("SO_BINDTODEVICE not available;"
1968
" cannot bind to interface %s",
1970
elif error.errno == errno.ENODEV:
1971
logger.error("Interface %s does not exist,"
1972
" cannot bind", self.interface)
537
if self.settings["interface"]:
538
# 25 is from /usr/include/asm-i486/socket.h
539
SO_BINDTODEVICE = getattr(socket, "SO_BINDTODEVICE", 25)
541
self.socket.setsockopt(socket.SOL_SOCKET,
543
self.settings["interface"])
544
except socket.error, error:
545
if error[0] == errno.EPERM:
546
logger.error(u"No permission to"
547
u" bind to interface %s",
548
self.settings["interface"])
1975
551
# Only bind(2) the socket if we really need to.
1976
552
if self.server_address[0] or self.server_address[1]:
1977
553
if not self.server_address[0]:
1978
if self.address_family == socket.AF_INET6:
1979
any_address = "::" # in6addr_any
1981
any_address = socket.INADDR_ANY
1982
self.server_address = (any_address,
555
self.server_address = (in6addr_any,
1983
556
self.server_address[1])
1984
557
elif not self.server_address[1]:
1985
558
self.server_address = (self.server_address[0],
1987
# if self.interface:
560
# if self.settings["interface"]:
1988
561
# self.server_address = (self.server_address[0],
1991
564
# if_nametoindex
1993
return socketserver.TCPServer.server_bind(self)
1996
class MandosServer(IPv6_TCPServer):
2000
clients: set of Client objects
2001
gnutls_priority GnuTLS priority string
2002
use_dbus: Boolean; to emit D-Bus signals or not
2004
Assumes a gobject.MainLoop event loop.
2006
def __init__(self, server_address, RequestHandlerClass,
2007
interface=None, use_ipv6=True, clients=None,
2008
gnutls_priority=None, use_dbus=True, socketfd=None):
2009
self.enabled = False
2010
self.clients = clients
2011
if self.clients is None:
2013
self.use_dbus = use_dbus
2014
self.gnutls_priority = gnutls_priority
2015
IPv6_TCPServer.__init__(self, server_address,
2016
RequestHandlerClass,
2017
interface = interface,
2018
use_ipv6 = use_ipv6,
2019
socketfd = socketfd)
567
return super(type(self), self).server_bind()
2020
568
def server_activate(self):
2021
569
if self.enabled:
2022
return socketserver.TCPServer.server_activate(self)
570
return super(type(self), self).server_activate()
2024
571
def enable(self):
2025
572
self.enabled = True
2027
def add_pipe(self, parent_pipe, proc):
2028
# Call "handle_ipc" for both data and EOF events
2029
gobject.io_add_watch(parent_pipe.fileno(),
2030
gobject.IO_IN | gobject.IO_HUP,
2031
functools.partial(self.handle_ipc,
2036
def handle_ipc(self, source, condition, parent_pipe=None,
2037
proc = None, client_object=None):
2038
# error, or the other end of multiprocessing.Pipe has closed
2039
if condition & (gobject.IO_ERR | gobject.IO_HUP):
2040
# Wait for other process to exit
2044
# Read a request from the child
2045
request = parent_pipe.recv()
2046
command = request[0]
2048
if command == 'init':
2050
address = request[2]
2052
for c in self.clients.itervalues():
2053
if c.fingerprint == fpr:
2057
logger.info("Client not found for fingerprint: %s, ad"
2058
"dress: %s", fpr, address)
2061
mandos_dbus_service.ClientNotFound(fpr,
2063
parent_pipe.send(False)
2066
gobject.io_add_watch(parent_pipe.fileno(),
2067
gobject.IO_IN | gobject.IO_HUP,
2068
functools.partial(self.handle_ipc,
2074
parent_pipe.send(True)
2075
# remove the old hook in favor of the new above hook on
2078
if command == 'funcall':
2079
funcname = request[1]
2083
parent_pipe.send(('data', getattr(client_object,
2087
if command == 'getattr':
2088
attrname = request[1]
2089
if callable(client_object.__getattribute__(attrname)):
2090
parent_pipe.send(('function',))
2092
parent_pipe.send(('data', client_object
2093
.__getattribute__(attrname)))
2095
if command == 'setattr':
2096
attrname = request[1]
2098
setattr(client_object, attrname, value)
2103
def rfc3339_duration_to_delta(duration):
2104
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2106
>>> rfc3339_duration_to_delta("P7D")
2107
datetime.timedelta(7)
2108
>>> rfc3339_duration_to_delta("PT60S")
2109
datetime.timedelta(0, 60)
2110
>>> rfc3339_duration_to_delta("PT60M")
2111
datetime.timedelta(0, 3600)
2112
>>> rfc3339_duration_to_delta("PT24H")
2113
datetime.timedelta(1)
2114
>>> rfc3339_duration_to_delta("P1W")
2115
datetime.timedelta(7)
2116
>>> rfc3339_duration_to_delta("PT5M30S")
2117
datetime.timedelta(0, 330)
2118
>>> rfc3339_duration_to_delta("P1DT3M20S")
2119
datetime.timedelta(1, 200)
2122
# Parsing an RFC 3339 duration with regular expressions is not
2123
# possible - there would have to be multiple places for the same
2124
# values, like seconds. The current code, while more esoteric, is
2125
# cleaner without depending on a parsing library. If Python had a
2126
# built-in library for parsing we would use it, but we'd like to
2127
# avoid excessive use of external libraries.
2129
# New type for defining tokens, syntax, and semantics all-in-one
2130
Token = collections.namedtuple("Token",
2131
("regexp", # To match token; if
2132
# "value" is not None,
2133
# must have a "group"
2135
"value", # datetime.timedelta or
2137
"followers")) # Tokens valid after
2139
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2140
# the "duration" ABNF definition in RFC 3339, Appendix A.
2141
token_end = Token(re.compile(r"$"), None, frozenset())
2142
token_second = Token(re.compile(r"(\d+)S"),
2143
datetime.timedelta(seconds=1),
2144
frozenset((token_end,)))
2145
token_minute = Token(re.compile(r"(\d+)M"),
2146
datetime.timedelta(minutes=1),
2147
frozenset((token_second, token_end)))
2148
token_hour = Token(re.compile(r"(\d+)H"),
2149
datetime.timedelta(hours=1),
2150
frozenset((token_minute, token_end)))
2151
token_time = Token(re.compile(r"T"),
2153
frozenset((token_hour, token_minute,
2155
token_day = Token(re.compile(r"(\d+)D"),
2156
datetime.timedelta(days=1),
2157
frozenset((token_time, token_end)))
2158
token_month = Token(re.compile(r"(\d+)M"),
2159
datetime.timedelta(weeks=4),
2160
frozenset((token_day, token_end)))
2161
token_year = Token(re.compile(r"(\d+)Y"),
2162
datetime.timedelta(weeks=52),
2163
frozenset((token_month, token_end)))
2164
token_week = Token(re.compile(r"(\d+)W"),
2165
datetime.timedelta(weeks=1),
2166
frozenset((token_end,)))
2167
token_duration = Token(re.compile(r"P"), None,
2168
frozenset((token_year, token_month,
2169
token_day, token_time,
2171
# Define starting values
2172
value = datetime.timedelta() # Value so far
2174
followers = frozenset(token_duration,) # Following valid tokens
2175
s = duration # String left to parse
2176
# Loop until end token is found
2177
while found_token is not token_end:
2178
# Search for any currently valid tokens
2179
for token in followers:
2180
match = token.regexp.match(s)
2181
if match is not None:
2183
if token.value is not None:
2184
# Value found, parse digits
2185
factor = int(match.group(1), 10)
2186
# Add to value so far
2187
value += factor * token.value
2188
# Strip token from string
2189
s = token.regexp.sub("", s, 1)
2192
# Set valid next tokens
2193
followers = found_token.followers
2196
# No currently valid tokens were found
2197
raise ValueError("Invalid RFC 3339 duration")
2202
575
def string_to_delta(interval):
2203
576
"""Parse a string and return a datetime.timedelta
2205
578
>>> string_to_delta('7d')
2206
579
datetime.timedelta(7)
2207
580
>>> string_to_delta('60s')
2332
722
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
2333
723
"servicename": "Mandos",
2339
"statedir": "/var/lib/mandos",
2340
"foreground": "False",
2343
726
# Parse config file for server-global settings
2344
server_config = configparser.SafeConfigParser(server_defaults)
727
server_config = ConfigParser.SafeConfigParser(server_defaults)
2345
728
del server_defaults
2346
server_config.read(os.path.join(options.configdir,
729
server_config.read(os.path.join(options.configdir, "mandos.conf"))
2348
730
# Convert the SafeConfigParser object to a dict
2349
731
server_settings = server_config.defaults()
2350
# Use the appropriate methods on the non-string config options
2351
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2352
server_settings[option] = server_config.getboolean("DEFAULT",
2354
if server_settings["port"]:
2355
server_settings["port"] = server_config.getint("DEFAULT",
2357
if server_settings["socket"]:
2358
server_settings["socket"] = server_config.getint("DEFAULT",
2360
# Later, stdin will, and stdout and stderr might, be dup'ed
2361
# over with an opened os.devnull. But we don't want this to
2362
# happen with a supplied network socket.
2363
if 0 <= server_settings["socket"] <= 2:
2364
server_settings["socket"] = os.dup(server_settings
732
# Use getboolean on the boolean config option
733
server_settings["debug"] = server_config.getboolean\
2366
735
del server_config
2368
737
# Override the settings from the config file with command line
2369
738
# options, if set.
2370
739
for option in ("interface", "address", "port", "debug",
2371
"priority", "servicename", "configdir",
2372
"use_dbus", "use_ipv6", "debuglevel", "restore",
2373
"statedir", "socket", "foreground"):
740
"priority", "servicename", "configdir"):
2374
741
value = getattr(options, option)
2375
742
if value is not None:
2376
743
server_settings[option] = value
2378
# Force all strings to be unicode
2379
for option in server_settings.keys():
2380
if type(server_settings[option]) is str:
2381
server_settings[option] = unicode(server_settings[option])
2382
# Debug implies foreground
2383
if server_settings["debug"]:
2384
server_settings["foreground"] = True
2385
745
# Now we have our good server settings in "server_settings"
2387
##################################################################
2390
747
debug = server_settings["debug"]
2391
debuglevel = server_settings["debuglevel"]
2392
use_dbus = server_settings["use_dbus"]
2393
use_ipv6 = server_settings["use_ipv6"]
2394
stored_state_path = os.path.join(server_settings["statedir"],
2396
foreground = server_settings["foreground"]
2399
initlogger(debug, logging.DEBUG)
2404
level = getattr(logging, debuglevel.upper())
2405
initlogger(debug, level)
750
syslogger.setLevel(logging.WARNING)
751
console.setLevel(logging.WARNING)
2407
753
if server_settings["servicename"] != "Mandos":
2408
syslogger.setFormatter(logging.Formatter
2409
('Mandos ({0}) [%(process)d]:'
2410
' %(levelname)s: %(message)s'
2411
.format(server_settings
754
syslogger.setFormatter(logging.Formatter\
755
('Mandos (%s): %%(levelname)s:'
757
% server_settings["servicename"]))
2414
759
# Parse config file with clients
2415
client_config = configparser.SafeConfigParser(Client
760
client_defaults = { "timeout": "1h",
762
"checker": "fping -q -- %(host)s",
765
client_config = ConfigParser.SafeConfigParser(client_defaults)
2417
766
client_config.read(os.path.join(server_settings["configdir"],
2418
767
"clients.conf"))
2420
global mandos_dbus_service
2421
mandos_dbus_service = None
2423
tcp_server = MandosServer((server_settings["address"],
2424
server_settings["port"]),
2426
interface=(server_settings["interface"]
2430
server_settings["priority"],
2432
socketfd=(server_settings["socket"]
2435
pidfilename = "/var/run/mandos.pid"
2438
pidfile = open(pidfilename, "w")
2439
except IOError as e:
2440
logger.error("Could not open file %r", pidfilename,
2443
for name in ("_mandos", "mandos", "nobody"):
2445
uid = pwd.getpwnam(name).pw_uid
2446
gid = pwd.getpwnam(name).pw_gid
770
tcp_server = IPv6_TCPServer((server_settings["address"],
771
server_settings["port"]),
773
settings=server_settings,
775
pidfilename = "/var/run/mandos.pid"
777
pidfile = open(pidfilename, "w")
778
except IOError, error:
779
logger.error("Could not open file %r", pidfilename)
784
uid = pwd.getpwnam("mandos").pw_uid
787
uid = pwd.getpwnam("nobody").pw_uid
791
gid = pwd.getpwnam("mandos").pw_gid
794
gid = pwd.getpwnam("nogroup").pw_gid
2456
except OSError as error:
2457
if error.errno != errno.EPERM:
800
except OSError, error:
801
if error[0] != errno.EPERM:
2461
# Enable all possible GnuTLS debugging
2463
# "Use a log level over 10 to enable all debugging options."
2465
gnutls.library.functions.gnutls_global_set_log_level(11)
2467
@gnutls.library.types.gnutls_log_func
2468
def debug_gnutls(level, string):
2469
logger.debug("GnuTLS: %s", string[:-1])
2471
(gnutls.library.functions
2472
.gnutls_global_set_log_function(debug_gnutls))
2474
# Redirect stdin so all checkers get /dev/null
2475
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2476
os.dup2(null, sys.stdin.fileno())
2480
# Need to fork before connecting to D-Bus
2482
# Close all input and output, do double fork, etc.
2485
# multiprocessing will use threads, so before we use gobject we
2486
# need to inform gobject that threads will be used.
2487
gobject.threads_init()
805
service = AvahiService(name = server_settings["servicename"],
806
type = "_mandos._tcp", );
807
if server_settings["interface"]:
808
service.interface = if_nametoindex\
809
(server_settings["interface"])
2489
811
global main_loop
2490
814
# From the Avahi example code
2491
DBusGMainLoop(set_as_default=True)
815
DBusGMainLoop(set_as_default=True )
2492
816
main_loop = gobject.MainLoop()
2493
817
bus = dbus.SystemBus()
818
server = dbus.Interface(bus.get_object(avahi.DBUS_NAME,
819
avahi.DBUS_PATH_SERVER),
820
avahi.DBUS_INTERFACE_SERVER)
2494
821
# End of Avahi example code
2497
bus_name = dbus.service.BusName("se.recompile.Mandos",
2498
bus, do_not_queue=True)
2499
old_bus_name = (dbus.service.BusName
2500
("se.bsnet.fukt.Mandos", bus,
2502
except dbus.exceptions.NameExistsException as e:
2503
logger.error("Disabling D-Bus:", exc_info=e)
2505
server_settings["use_dbus"] = False
2506
tcp_server.use_dbus = False
2507
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2508
service = AvahiServiceToSyslog(name =
2509
server_settings["servicename"],
2510
servicetype = "_mandos._tcp",
2511
protocol = protocol, bus = bus)
2512
if server_settings["interface"]:
2513
service.interface = (if_nametoindex
2514
(str(server_settings["interface"])))
2516
global multiprocessing_manager
2517
multiprocessing_manager = multiprocessing.Manager()
2519
client_class = Client
2521
client_class = functools.partial(ClientDBus, bus = bus)
2523
client_settings = Client.config_parser(client_config)
2524
old_client_settings = {}
2527
# Get client data and settings from last running state.
2528
if server_settings["restore"]:
2530
with open(stored_state_path, "rb") as stored_state:
2531
clients_data, old_client_settings = (pickle.load
2533
os.remove(stored_state_path)
2534
except IOError as e:
2535
if e.errno == errno.ENOENT:
2536
logger.warning("Could not load persistent state: {0}"
2537
.format(os.strerror(e.errno)))
2539
logger.critical("Could not load persistent state:",
2542
except EOFError as e:
2543
logger.warning("Could not load persistent state: "
2544
"EOFError:", exc_info=e)
2546
with PGPEngine() as pgp:
2547
for client_name, client in clients_data.iteritems():
2548
# Decide which value to use after restoring saved state.
2549
# We have three different values: Old config file,
2550
# new config file, and saved state.
2551
# New config value takes precedence if it differs from old
2552
# config value, otherwise use saved state.
2553
for name, value in client_settings[client_name].items():
2555
# For each value in new config, check if it
2556
# differs from the old config value (Except for
2557
# the "secret" attribute)
2558
if (name != "secret" and
2559
value != old_client_settings[client_name]
2561
client[name] = value
2565
# Clients who has passed its expire date can still be
2566
# enabled if its last checker was successful. Clients
2567
# whose checker succeeded before we stored its state is
2568
# assumed to have successfully run all checkers during
2570
if client["enabled"]:
2571
if datetime.datetime.utcnow() >= client["expires"]:
2572
if not client["last_checked_ok"]:
2574
"disabling client {0} - Client never "
2575
"performed a successful checker"
2576
.format(client_name))
2577
client["enabled"] = False
2578
elif client["last_checker_status"] != 0:
2580
"disabling client {0} - Client "
2581
"last checker failed with error code {1}"
2582
.format(client_name,
2583
client["last_checker_status"]))
2584
client["enabled"] = False
2586
client["expires"] = (datetime.datetime
2588
+ client["timeout"])
2589
logger.debug("Last checker succeeded,"
2590
" keeping {0} enabled"
2591
.format(client_name))
2593
client["secret"] = (
2594
pgp.decrypt(client["encrypted_secret"],
2595
client_settings[client_name]
2598
# If decryption fails, we use secret from new settings
2599
logger.debug("Failed to decrypt {0} old secret"
2600
.format(client_name))
2601
client["secret"] = (
2602
client_settings[client_name]["secret"])
2604
# Add/remove clients based on new changes made to config
2605
for client_name in (set(old_client_settings)
2606
- set(client_settings)):
2607
del clients_data[client_name]
2608
for client_name in (set(client_settings)
2609
- set(old_client_settings)):
2610
clients_data[client_name] = client_settings[client_name]
2612
# Create all client objects
2613
for client_name, client in clients_data.iteritems():
2614
tcp_server.clients[client_name] = client_class(
2615
name = client_name, settings = client)
2617
if not tcp_server.clients:
2618
logger.warning("No clients defined")
2621
if pidfile is not None:
2625
pidfile.write(str(pid) + "\n".encode("utf-8"))
2627
logger.error("Could not write to file %r with PID %d",
823
def remove_from_clients(client):
824
clients.remove(client)
826
logger.critical(u"No clients left, exiting")
829
clients.update(Set(Client(name = section,
830
stop_hook = remove_from_clients,
832
= dict(client_config.items(section)))
833
for section in client_config.sections()))
835
logger.critical(u"No clients defined")
839
# Redirect stdin so all checkers get /dev/null
840
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
841
os.dup2(null, sys.stdin.fileno())
846
logger.removeHandler(console)
847
# Close all input and output, do double fork, etc.
852
pidfile.write(str(pid) + "\n")
2632
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2633
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2636
@alternate_dbus_interfaces({"se.recompile.Mandos":
2637
"se.bsnet.fukt.Mandos"})
2638
class MandosDBusService(DBusObjectWithProperties):
2639
"""A D-Bus proxy object"""
2641
dbus.service.Object.__init__(self, bus, "/")
2642
_interface = "se.recompile.Mandos"
2644
@dbus_interface_annotations(_interface)
2646
return { "org.freedesktop.DBus.Property"
2647
".EmitsChangedSignal":
2650
@dbus.service.signal(_interface, signature="o")
2651
def ClientAdded(self, objpath):
2655
@dbus.service.signal(_interface, signature="ss")
2656
def ClientNotFound(self, fingerprint, address):
2660
@dbus.service.signal(_interface, signature="os")
2661
def ClientRemoved(self, objpath, name):
2665
@dbus.service.method(_interface, out_signature="ao")
2666
def GetAllClients(self):
2668
return dbus.Array(c.dbus_object_path
2670
tcp_server.clients.itervalues())
2672
@dbus.service.method(_interface,
2673
out_signature="a{oa{sv}}")
2674
def GetAllClientsWithProperties(self):
2676
return dbus.Dictionary(
2677
((c.dbus_object_path, c.GetAll(""))
2678
for c in tcp_server.clients.itervalues()),
2681
@dbus.service.method(_interface, in_signature="o")
2682
def RemoveClient(self, object_path):
2684
for c in tcp_server.clients.itervalues():
2685
if c.dbus_object_path == object_path:
2686
del tcp_server.clients[c.name]
2687
c.remove_from_connection()
2688
# Don't signal anything except ClientRemoved
2689
c.disable(quiet=True)
2691
self.ClientRemoved(object_path, c.name)
2693
raise KeyError(object_path)
2697
mandos_dbus_service = MandosDBusService()
856
logger.error(u"Could not write to file %r with PID %d",
859
# "pidfile" was never created
2700
864
"Cleanup function; run on exit"
2703
multiprocessing.active_children()
2704
if not (tcp_server.clients or client_settings):
2707
# Store client before exiting. Secrets are encrypted with key
2708
# based on what config file has. If config file is
2709
# removed/edited, old secret will thus be unrecovable.
2711
with PGPEngine() as pgp:
2712
for client in tcp_server.clients.itervalues():
2713
key = client_settings[client.name]["secret"]
2714
client.encrypted_secret = pgp.encrypt(client.secret,
2718
# A list of attributes that can not be pickled
2720
exclude = set(("bus", "changedstate", "secret",
2722
for name, typ in (inspect.getmembers
2723
(dbus.service.Object)):
2726
client_dict["encrypted_secret"] = (client
2728
for attr in client.client_structure:
2729
if attr not in exclude:
2730
client_dict[attr] = getattr(client, attr)
2732
clients[client.name] = client_dict
2733
del client_settings[client.name]["secret"]
2736
with (tempfile.NamedTemporaryFile
2737
(mode='wb', suffix=".pickle", prefix='clients-',
2738
dir=os.path.dirname(stored_state_path),
2739
delete=False)) as stored_state:
2740
pickle.dump((clients, client_settings), stored_state)
2741
tempname=stored_state.name
2742
os.rename(tempname, stored_state_path)
2743
except (IOError, OSError) as e:
2749
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
2750
logger.warning("Could not save persistent state: {0}"
2751
.format(os.strerror(e.errno)))
2753
logger.warning("Could not save persistent state:",
2757
# Delete all clients, and settings from config
2758
while tcp_server.clients:
2759
name, client = tcp_server.clients.popitem()
2761
client.remove_from_connection()
2762
# Don't signal anything except ClientRemoved
2763
client.disable(quiet=True)
2766
mandos_dbus_service.ClientRemoved(client
2769
client_settings.clear()
866
# From the Avahi example code
867
if not group is None:
870
# End of Avahi example code
873
client = clients.pop()
874
client.stop_hook = None
2771
877
atexit.register(cleanup)
2773
for client in tcp_server.clients.itervalues():
2776
mandos_dbus_service.ClientAdded(client.dbus_object_path)
2777
# Need to initiate checking of clients
2779
client.init_checker()
880
signal.signal(signal.SIGINT, signal.SIG_IGN)
881
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
882
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
884
for client in clients:
2781
887
tcp_server.enable()
2782
888
tcp_server.server_activate()
2784
890
# Find out what port we got
2785
891
service.port = tcp_server.socket.getsockname()[1]
2787
logger.info("Now listening on address %r, port %d,"
2788
" flowinfo %d, scope_id %d",
2789
*tcp_server.socket.getsockname())
2791
logger.info("Now listening on address %r, port %d",
2792
*tcp_server.socket.getsockname())
892
logger.info(u"Now listening on address %r, port %d, flowinfo %d,"
893
u" scope_id %d" % tcp_server.socket.getsockname())
2794
895
#service.interface = tcp_server.socket.getsockname()[3]
2797
898
# From the Avahi example code
899
server.connect_to_signal("StateChanged", server_state_changed)
2800
except dbus.exceptions.DBusException as error:
2801
logger.critical("D-Bus Exception", exc_info=error)
901
server_state_changed(server.GetState())
902
except dbus.exceptions.DBusException, error:
903
logger.critical(u"DBusException: %s", error)
2804
905
# End of Avahi example code
2806
907
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2807
908
lambda *args, **kwargs:
2808
(tcp_server.handle_request
2809
(*args[2:], **kwargs) or True))
909
tcp_server.handle_request\
910
(*args[2:], **kwargs) or True)
2811
logger.debug("Starting main loop")
912
logger.debug(u"Starting main loop")
913
main_loop_started = True
2813
except AvahiError as error:
2814
logger.critical("Avahi Error", exc_info=error)
915
except AvahiError, error:
916
logger.critical(u"AvahiError: %s" + unicode(error))
2817
918
except KeyboardInterrupt:
2819
print("", file=sys.stderr)
2820
logger.debug("Server received KeyboardInterrupt")
2821
logger.debug("Server exiting")
2822
# Must run before the D-Bus bus name gets deregistered
2825
922
if __name__ == '__main__':