252
104
max_renames: integer; maximum number of renames
253
105
rename_count: integer; counter so we only rename after collisions
254
106
a sensible number of times
255
group: D-Bus Entry Group
257
bus: dbus.SystemBus()
261
interface = avahi.IF_UNSPEC,
269
protocol = avahi.PROTO_UNSPEC,
108
def __init__(self, interface = avahi.IF_UNSPEC, name = None,
109
type = None, port = None, TXT = None, domain = "",
110
host = "", max_renames = 32768):
271
111
self.interface = interface
273
self.type = servicetype
275
self.TXT = TXT if TXT is not None else []
276
119
self.domain = domain
278
121
self.rename_count = 0
279
self.max_renames = max_renames
280
self.protocol = protocol
281
self.group = None # our entry group
284
self.entry_group_state_changed_match = None
286
def rename(self, remove=True):
287
123
"""Derived from the Avahi example code"""
288
124
if self.rename_count >= self.max_renames:
289
logger.critical("No suitable Zeroconf service name found"
290
" after %i retries, exiting.",
125
logger.critical(u"No suitable service name found after %i"
126
u" retries, exiting.", rename_count)
292
127
raise AvahiServiceError("Too many renames")
294
self.server.GetAlternativeServiceName(self.name))
128
name = server.GetAlternativeServiceName(name)
129
logger.error(u"Changing name to %r ...", name)
130
syslogger.setFormatter(logging.Formatter\
131
('Mandos (%s): %%(levelname)s:'
132
' %%(message)s' % name))
295
135
self.rename_count += 1
296
logger.info("Changing Zeroconf service name to %r ...",
302
except dbus.exceptions.DBusException as error:
303
if (error.get_dbus_name()
304
== "org.freedesktop.Avahi.CollisionError"):
305
logger.info("Local Zeroconf service name collision.")
306
return self.rename(remove=False)
308
logger.critical("D-Bus Exception", exc_info=error)
312
136
def remove(self):
313
137
"""Derived from the Avahi example code"""
314
if self.entry_group_state_changed_match is not None:
315
self.entry_group_state_changed_match.remove()
316
self.entry_group_state_changed_match = None
317
if self.group is not None:
138
if group is not None:
321
141
"""Derived from the Avahi example code"""
323
if self.group is None:
324
self.group = dbus.Interface(
325
self.bus.get_object(avahi.DBUS_NAME,
326
self.server.EntryGroupNew()),
327
avahi.DBUS_INTERFACE_ENTRY_GROUP)
328
self.entry_group_state_changed_match = (
329
self.group.connect_to_signal(
330
'StateChanged', self.entry_group_state_changed))
331
logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
332
self.name, self.type)
333
self.group.AddService(
336
dbus.UInt32(0), # flags
337
self.name, self.type,
338
self.domain, self.host,
339
dbus.UInt16(self.port),
340
avahi.string_array_to_txt_array(self.TXT))
343
def entry_group_state_changed(self, state, error):
344
"""Derived from the Avahi example code"""
345
logger.debug("Avahi entry group state change: %i", state)
347
if state == avahi.ENTRY_GROUP_ESTABLISHED:
348
logger.debug("Zeroconf service established.")
349
elif state == avahi.ENTRY_GROUP_COLLISION:
350
logger.info("Zeroconf service name collision.")
352
elif state == avahi.ENTRY_GROUP_FAILURE:
353
logger.critical("Avahi: Error in group state changed %s",
355
raise AvahiGroupError("State changed: {!s}".format(error))
358
"""Derived from the Avahi example code"""
359
if self.group is not None:
362
except (dbus.exceptions.UnknownMethodException,
363
dbus.exceptions.DBusException):
368
def server_state_changed(self, state, error=None):
369
"""Derived from the Avahi example code"""
370
logger.debug("Avahi server state change: %i", state)
372
avahi.SERVER_INVALID: "Zeroconf server invalid",
373
avahi.SERVER_REGISTERING: None,
374
avahi.SERVER_COLLISION: "Zeroconf server name collision",
375
avahi.SERVER_FAILURE: "Zeroconf server failure",
377
if state in bad_states:
378
if bad_states[state] is not None:
380
logger.error(bad_states[state])
382
logger.error(bad_states[state] + ": %r", error)
384
elif state == avahi.SERVER_RUNNING:
388
logger.debug("Unknown state: %r", state)
390
logger.debug("Unknown state: %r: %r", state, error)
393
"""Derived from the Avahi example code"""
394
if self.server is None:
395
self.server = dbus.Interface(
396
self.bus.get_object(avahi.DBUS_NAME,
397
avahi.DBUS_PATH_SERVER,
398
follow_name_owner_changes=True),
399
avahi.DBUS_INTERFACE_SERVER)
400
self.server.connect_to_signal("StateChanged",
401
self.server_state_changed)
402
self.server_state_changed(self.server.GetState())
405
class AvahiServiceToSyslog(AvahiService):
406
def rename(self, *args, **kwargs):
407
"""Add the new name to the syslog messages"""
408
ret = AvahiService.rename(self, *args, **kwargs)
409
syslogger.setFormatter(logging.Formatter(
410
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
144
group = dbus.Interface\
145
(bus.get_object(avahi.DBUS_NAME,
146
server.EntryGroupNew()),
147
avahi.DBUS_INTERFACE_ENTRY_GROUP)
148
group.connect_to_signal('StateChanged',
149
entry_group_state_changed)
150
logger.debug(u"Adding service '%s' of type '%s' ...",
151
service.name, service.type)
153
self.interface, # interface
154
avahi.PROTO_INET6, # protocol
155
dbus.UInt32(0), # flags
156
self.name, self.type,
157
self.domain, self.host,
158
dbus.UInt16(self.port),
159
avahi.string_array_to_txt_array(self.TXT))
162
# From the Avahi example code:
163
group = None # our entry group
164
# End of Avahi example code
415
167
class Client(object):
416
168
"""A representation of a client host served by this server.
419
approved: bool(); 'None' if not yet approved/disapproved
420
approval_delay: datetime.timedelta(); Time to wait for approval
421
approval_duration: datetime.timedelta(); Duration of one approval
422
checker: subprocess.Popen(); a running checker process used
423
to see if the client lives.
424
'None' if no process is running.
425
checker_callback_tag: a gobject event source tag, or None
426
checker_command: string; External command which is run to check
427
if client lives. %() expansions are done at
170
name: string; from the config file, used in log messages
171
fingerprint: string (40 or 32 hexadecimal digits); used to
172
uniquely identify the client
173
secret: bytestring; sent verbatim (over TLS) to client
174
host: string; available for use by the checker command
175
created: datetime.datetime(); object creation, not client host
176
last_checked_ok: datetime.datetime() or None if not yet checked OK
177
timeout: datetime.timedelta(); How long from last_checked_ok
178
until this client is invalid
179
interval: datetime.timedelta(); How often to start a new checker
180
stop_hook: If set, called by stop() as stop_hook(self)
181
checker: subprocess.Popen(); a running checker process used
182
to see if the client lives.
183
'None' if no process is running.
184
checker_initiator_tag: a gobject event source tag, or None
185
stop_initiator_tag: - '' -
186
checker_callback_tag: - '' -
187
checker_command: string; External command which is run to check if
188
client lives. %() expansions are done at
428
189
runtime with vars(self) as dict, so that for
429
190
instance %(name)s can be used in the command.
430
checker_initiator_tag: a gobject event source tag, or None
431
created: datetime.datetime(); (UTC) object creation
432
client_structure: Object describing what attributes a client has
433
and is used for storing the client at exit
434
current_checker_command: string; current running checker_command
435
disable_initiator_tag: a gobject event source tag, or None
437
fingerprint: string (40 or 32 hexadecimal digits); used to
438
uniquely identify the client
439
host: string; available for use by the checker command
440
interval: datetime.timedelta(); How often to start a new checker
441
last_approval_request: datetime.datetime(); (UTC) or None
442
last_checked_ok: datetime.datetime(); (UTC) or None
443
last_checker_status: integer between 0 and 255 reflecting exit
444
status of last checker. -1 reflects crashed
445
checker, -2 means no checker completed yet.
446
last_enabled: datetime.datetime(); (UTC) or None
447
name: string; from the config file, used in log messages and
449
secret: bytestring; sent verbatim (over TLS) to client
450
timeout: datetime.timedelta(); How long from last_checked_ok
451
until this client is disabled
452
extended_timeout: extra long timeout when secret has been sent
453
runtime_expansions: Allowed attributes for runtime expansion.
454
expires: datetime.datetime(); time (UTC) when a client will be
456
server_settings: The server_settings dict from main()
192
_timeout: Real variable for 'timeout'
193
_interval: Real variable for 'interval'
194
_timeout_milliseconds: Used when calling gobject.timeout_add()
195
_interval_milliseconds: - '' -
459
runtime_expansions = ("approval_delay", "approval_duration",
460
"created", "enabled", "expires",
461
"fingerprint", "host", "interval",
462
"last_approval_request", "last_checked_ok",
463
"last_enabled", "name", "timeout")
466
"extended_timeout": "PT15M",
468
"checker": "fping -q -- %%(host)s",
470
"approval_delay": "PT0S",
471
"approval_duration": "PT1S",
472
"approved_by_default": "True",
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
# Uppercase and remove spaces from fingerprint for later
497
# comparison purposes with return value from the
498
# fingerprint() function
499
client["fingerprint"] = (section["fingerprint"].upper()
501
if "secret" in section:
502
client["secret"] = section["secret"].decode("base64")
503
elif "secfile" in section:
504
with open(os.path.expanduser(os.path.expandvars
505
(section["secfile"])),
507
client["secret"] = secfile.read()
509
raise TypeError("No secret or secfile for section {}"
511
client["timeout"] = string_to_delta(section["timeout"])
512
client["extended_timeout"] = string_to_delta(
513
section["extended_timeout"])
514
client["interval"] = string_to_delta(section["interval"])
515
client["approval_delay"] = string_to_delta(
516
section["approval_delay"])
517
client["approval_duration"] = string_to_delta(
518
section["approval_duration"])
519
client["checker_command"] = section["checker"]
520
client["last_approval_request"] = None
521
client["last_checked_ok"] = None
522
client["last_checker_status"] = -2
526
def __init__(self, settings, name = None, server_settings=None):
197
def _set_timeout(self, timeout):
198
"Setter function for 'timeout' attribute"
199
self._timeout = timeout
200
self._timeout_milliseconds = ((self.timeout.days
201
* 24 * 60 * 60 * 1000)
202
+ (self.timeout.seconds * 1000)
203
+ (self.timeout.microseconds
205
timeout = property(lambda self: self._timeout,
208
def _set_interval(self, interval):
209
"Setter function for 'interval' attribute"
210
self._interval = interval
211
self._interval_milliseconds = ((self.interval.days
212
* 24 * 60 * 60 * 1000)
213
+ (self.interval.seconds
215
+ (self.interval.microseconds
217
interval = property(lambda self: self._interval,
220
def __init__(self, name = None, stop_hook=None, config={}):
221
"""Note: the 'checker' key in 'config' sets the
222
'checker_command' attribute and *not* the 'checker'
528
if server_settings is None:
530
self.server_settings = server_settings
531
# adding all client settings
532
for setting, value in settings.items():
533
setattr(self, setting, value)
536
if not hasattr(self, "last_enabled"):
537
self.last_enabled = datetime.datetime.utcnow()
538
if not hasattr(self, "expires"):
539
self.expires = (datetime.datetime.utcnow()
225
logger.debug(u"Creating client %r", self.name)
226
# Uppercase and remove spaces from fingerprint for later
227
# comparison purposes with return value from the fingerprint()
229
self.fingerprint = config["fingerprint"].upper()\
231
logger.debug(u" Fingerprint: %s", self.fingerprint)
232
if "secret" in config:
233
self.secret = config["secret"].decode(u"base64")
234
elif "secfile" in config:
235
sf = open(config["secfile"])
236
self.secret = sf.read()
542
self.last_enabled = None
545
logger.debug("Creating client %r", self.name)
546
logger.debug(" Fingerprint: %s", self.fingerprint)
547
self.created = settings.get("created",
548
datetime.datetime.utcnow())
550
# attributes specific for this server instance
239
raise TypeError(u"No secret or secfile for client %s"
241
self.host = config.get("host", "")
242
self.created = datetime.datetime.now()
243
self.last_checked_ok = None
244
self.timeout = string_to_delta(config["timeout"])
245
self.interval = string_to_delta(config["interval"])
246
self.stop_hook = stop_hook
551
247
self.checker = None
552
248
self.checker_initiator_tag = None
553
self.disable_initiator_tag = None
249
self.stop_initiator_tag = None
554
250
self.checker_callback_tag = None
555
self.current_checker_command = None
557
self.approvals_pending = 0
558
self.changedstate = multiprocessing_manager.Condition(
559
multiprocessing_manager.Lock())
560
self.client_structure = [attr
561
for attr in self.__dict__.iterkeys()
562
if not attr.startswith("_")]
563
self.client_structure.append("client_structure")
565
for name, t in inspect.getmembers(
566
type(self), lambda obj: isinstance(obj, property)):
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()
251
self.check_command = config["checker"]
576
253
"""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
254
# Schedule a new checker to be started an 'interval' from now,
611
255
# 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
int(self.interval.total_seconds() * 1000),
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
int(self.timeout.total_seconds() * 1000), self.disable)
256
self.checker_initiator_tag = gobject.timeout_add\
257
(self._interval_milliseconds,
622
259
# Also start a new checker *right now*.
623
260
self.start_checker()
625
def checker_callback(self, pid, condition, command):
261
# Schedule a stop() when 'timeout' has passed
262
self.stop_initiator_tag = gobject.timeout_add\
263
(self._timeout_milliseconds,
267
The possibility that a client might be restarted is left open,
268
but not currently used."""
269
# If this client doesn't have a secret, it is already stopped.
270
if hasattr(self, "secret") and self.secret:
271
logger.info(u"Stopping client %s", self.name)
275
if getattr(self, "stop_initiator_tag", False):
276
gobject.source_remove(self.stop_initiator_tag)
277
self.stop_initiator_tag = None
278
if getattr(self, "checker_initiator_tag", False):
279
gobject.source_remove(self.checker_initiator_tag)
280
self.checker_initiator_tag = None
284
# Do not run this again if called by a gobject.timeout_add
287
self.stop_hook = None
289
def checker_callback(self, pid, condition):
626
290
"""The checker has completed, so take appropriate actions."""
291
now = datetime.datetime.now()
627
292
self.checker_callback_tag = None
628
293
self.checker = None
629
if os.WIFEXITED(condition):
630
self.last_checker_status = os.WEXITSTATUS(condition)
631
if self.last_checker_status == 0:
632
logger.info("Checker for %(name)s succeeded",
636
logger.info("Checker for %(name)s failed", vars(self))
638
self.last_checker_status = -1
639
logger.warning("Checker for %(name)s crashed?",
294
if os.WIFEXITED(condition) \
295
and (os.WEXITSTATUS(condition) == 0):
296
logger.info(u"Checker for %(name)s succeeded",
298
self.last_checked_ok = now
299
gobject.source_remove(self.stop_initiator_tag)
300
self.stop_initiator_tag = gobject.timeout_add\
301
(self._timeout_milliseconds,
303
elif not os.WIFEXITED(condition):
304
logger.warning(u"Checker for %(name)s crashed?",
642
def checked_ok(self):
643
"""Assert that the client has been seen, alive and well."""
644
self.last_checked_ok = datetime.datetime.utcnow()
645
self.last_checker_status = 0
648
def bump_timeout(self, timeout=None):
649
"""Bump up the timeout for this client."""
651
timeout = self.timeout
652
if self.disable_initiator_tag is not None:
653
gobject.source_remove(self.disable_initiator_tag)
654
self.disable_initiator_tag = None
655
if getattr(self, "enabled", False):
656
self.disable_initiator_tag = gobject.timeout_add(
657
int(timeout.total_seconds() * 1000), self.disable)
658
self.expires = datetime.datetime.utcnow() + timeout
660
def need_approval(self):
661
self.last_approval_request = datetime.datetime.utcnow()
307
logger.info(u"Checker for %(name)s failed",
663
309
def start_checker(self):
664
310
"""Start a new checker subprocess if one is not running.
666
311
If a checker already exists, leave it running and do
668
313
# The reason for not killing a running checker is that if we
669
# did that, and if a checker (for some reason) started running
670
# slowly and taking more than 'interval' time, then the client
671
# would inevitably timeout, since no checker would get a
672
# chance to run to completion. If we instead leave running
314
# did that, then if a checker (for some reason) started
315
# running slowly and taking more than 'interval' time, the
316
# client would inevitably timeout, since no checker would get
317
# a chance to run to completion. If we instead leave running
673
318
# checkers alone, the checker would have to take more time
674
# than 'timeout' for the client to be disabled, which is as it
677
# If a checker exists, make sure it is not a zombie
679
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
680
except AttributeError:
682
except OSError as error:
683
if error.errno != errno.ECHILD:
687
logger.warning("Checker was a zombie")
688
gobject.source_remove(self.checker_callback_tag)
689
self.checker_callback(pid, status,
690
self.current_checker_command)
691
# Start a new checker if needed
319
# than 'timeout' for the client to be declared invalid, which
320
# is as it should be.
692
321
if self.checker is None:
693
# Escape attributes for the shell
695
attr: re.escape(str(getattr(self, attr)))
696
for attr in self.runtime_expansions }
698
command = self.checker_command % escaped_attrs
699
except TypeError as error:
700
logger.error('Could not format string "%s"',
701
self.checker_command,
703
return True # Try again later
704
self.current_checker_command = command
706
logger.info("Starting checker %r for %s", command,
708
# We don't need to redirect stdout and stderr, since
709
# in normal mode, that is already done by daemon(),
710
# and in debug mode we don't want to. (Stdin is
711
# always replaced by /dev/null.)
712
# The exception is when not debugging but nevertheless
713
# running in the foreground; use the previously
716
if (not self.server_settings["debug"]
717
and self.server_settings["foreground"]):
718
popen_args.update({"stdout": wnull,
323
# In case check_command has exactly one % operator
324
command = self.check_command % self.host
326
# Escape attributes for the shell
327
escaped_attrs = dict((key, re.escape(str(val)))
329
vars(self).iteritems())
331
command = self.check_command % escaped_attrs
332
except TypeError, error:
333
logger.error(u'Could not format string "%s":'
334
u' %s', self.check_command, error)
335
return True # Try again later
337
logger.info(u"Starting checker %r for %s",
720
339
self.checker = subprocess.Popen(command,
725
except OSError as error:
726
logger.error("Failed to start subprocess",
729
self.checker_callback_tag = gobject.child_watch_add(
730
self.checker.pid, self.checker_callback, data=command)
731
# The checker may have completed before the gobject
732
# watch was added. Check for this.
734
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
735
except OSError as error:
736
if error.errno == errno.ECHILD:
737
# This should never happen
738
logger.error("Child process vanished",
743
gobject.source_remove(self.checker_callback_tag)
744
self.checker_callback(pid, status, command)
342
self.checker_callback_tag = gobject.child_watch_add\
344
self.checker_callback)
345
except subprocess.OSError, error:
346
logger.error(u"Failed to start subprocess: %s",
745
348
# Re-run this periodically if run by gobject.timeout_add
748
350
def stop_checker(self):
749
351
"""Force the checker process, if any, to stop."""
750
352
if self.checker_callback_tag:
752
354
self.checker_callback_tag = None
753
355
if getattr(self, "checker", None) is None:
755
logger.debug("Stopping checker for %(name)s", vars(self))
357
logger.debug(u"Stopping checker for %(name)s", vars(self))
757
self.checker.terminate()
359
os.kill(self.checker.pid, signal.SIGTERM)
759
361
#if self.checker.poll() is None:
760
# self.checker.kill()
761
except OSError as error:
362
# os.kill(self.checker.pid, signal.SIGKILL)
363
except OSError, error:
762
364
if error.errno != errno.ESRCH: # No such process
764
366
self.checker = None
767
def dbus_service_property(dbus_interface,
771
"""Decorators for marking methods of a DBusObjectWithProperties to
772
become properties on the D-Bus.
774
The decorated method will be called with no arguments by "Get"
775
and with one argument by "Set".
777
The parameters, where they are supported, are the same as
778
dbus.service.method, except there is only "signature", since the
779
type from Get() and the type sent to Set() is the same.
781
# Encoding deeply encoded byte arrays is not supported yet by the
782
# "Set" method, so we fail early here:
783
if byte_arrays and signature != "ay":
784
raise ValueError("Byte arrays not supported for non-'ay'"
785
" signature {!r}".format(signature))
788
func._dbus_is_property = True
789
func._dbus_interface = dbus_interface
790
func._dbus_signature = signature
791
func._dbus_access = access
792
func._dbus_name = func.__name__
793
if func._dbus_name.endswith("_dbus_property"):
794
func._dbus_name = func._dbus_name[:-14]
795
func._dbus_get_args_options = {'byte_arrays': byte_arrays }
801
def dbus_interface_annotations(dbus_interface):
802
"""Decorator for marking functions returning interface annotations
806
@dbus_interface_annotations("org.example.Interface")
807
def _foo(self): # Function name does not matter
808
return {"org.freedesktop.DBus.Deprecated": "true",
809
"org.freedesktop.DBus.Property.EmitsChangedSignal":
814
func._dbus_is_interface = True
815
func._dbus_interface = dbus_interface
816
func._dbus_name = dbus_interface
822
def dbus_annotations(annotations):
823
"""Decorator to annotate D-Bus methods, signals or properties
826
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
827
"org.freedesktop.DBus.Property."
828
"EmitsChangedSignal": "false"})
829
@dbus_service_property("org.example.Interface", signature="b",
831
def Property_dbus_property(self):
832
return dbus.Boolean(False)
836
func._dbus_annotations = annotations
842
class DBusPropertyException(dbus.exceptions.DBusException):
843
"""A base class for D-Bus property-related exceptions
848
class DBusPropertyAccessException(DBusPropertyException):
849
"""A property's access permissions disallows an operation.
854
class DBusPropertyNotFound(DBusPropertyException):
855
"""An attempt was made to access a non-existing property.
860
class DBusObjectWithProperties(dbus.service.Object):
861
"""A D-Bus object with properties.
863
Classes inheriting from this can use the dbus_service_property
864
decorator to expose methods as D-Bus properties. It exposes the
865
standard Get(), Set(), and GetAll() methods on the D-Bus.
869
def _is_dbus_thing(thing):
870
"""Returns a function testing if an attribute is a D-Bus thing
872
If called like _is_dbus_thing("method") it returns a function
873
suitable for use as predicate to inspect.getmembers().
875
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
878
def _get_all_dbus_things(self, thing):
879
"""Returns a generator of (name, attribute) pairs
881
return ((getattr(athing.__get__(self), "_dbus_name", name),
882
athing.__get__(self))
883
for cls in self.__class__.__mro__
885
inspect.getmembers(cls, self._is_dbus_thing(thing)))
887
def _get_dbus_property(self, interface_name, property_name):
888
"""Returns a bound method if one exists which is a D-Bus
889
property with the specified name and interface.
891
for cls in self.__class__.__mro__:
892
for name, value in inspect.getmembers(
893
cls, self._is_dbus_thing("property")):
894
if (value._dbus_name == property_name
895
and value._dbus_interface == interface_name):
896
return value.__get__(self)
899
raise DBusPropertyNotFound("{}:{}.{}".format(
900
self.dbus_object_path, interface_name, property_name))
902
@dbus.service.method(dbus.PROPERTIES_IFACE,
905
def Get(self, interface_name, property_name):
906
"""Standard D-Bus property Get() method, see D-Bus standard.
908
prop = self._get_dbus_property(interface_name, property_name)
909
if prop._dbus_access == "write":
910
raise DBusPropertyAccessException(property_name)
912
if not hasattr(value, "variant_level"):
914
return type(value)(value, variant_level=value.variant_level+1)
916
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
917
def Set(self, interface_name, property_name, value):
918
"""Standard D-Bus property Set() method, see D-Bus standard.
920
prop = self._get_dbus_property(interface_name, property_name)
921
if prop._dbus_access == "read":
922
raise DBusPropertyAccessException(property_name)
923
if prop._dbus_get_args_options["byte_arrays"]:
924
# The byte_arrays option is not supported yet on
925
# signatures other than "ay".
926
if prop._dbus_signature != "ay":
927
raise ValueError("Byte arrays not supported for non-"
928
"'ay' signature {!r}"
929
.format(prop._dbus_signature))
930
value = dbus.ByteArray(b''.join(chr(byte)
934
@dbus.service.method(dbus.PROPERTIES_IFACE,
936
out_signature="a{sv}")
937
def GetAll(self, interface_name):
938
"""Standard D-Bus property GetAll() method, see D-Bus
941
Note: Will not include properties with access="write".
944
for name, prop in self._get_all_dbus_things("property"):
946
and interface_name != prop._dbus_interface):
947
# Interface non-empty but did not match
949
# Ignore write-only properties
950
if prop._dbus_access == "write":
953
if not hasattr(value, "variant_level"):
954
properties[name] = value
956
properties[name] = type(value)(
957
value, variant_level = value.variant_level + 1)
958
return dbus.Dictionary(properties, signature="sv")
960
@dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
961
def PropertiesChanged(self, interface_name, changed_properties,
962
invalidated_properties):
963
"""Standard D-Bus PropertiesChanged() signal, see D-Bus
968
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
970
path_keyword='object_path',
971
connection_keyword='connection')
972
def Introspect(self, object_path, connection):
973
"""Overloading of standard D-Bus method.
975
Inserts property tags and interface annotation tags.
977
xmlstring = dbus.service.Object.Introspect(self, object_path,
980
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)
989
for if_tag in document.getElementsByTagName("interface"):
991
for tag in (make_tag(document, name, prop)
993
in self._get_all_dbus_things("property")
994
if prop._dbus_interface
995
== if_tag.getAttribute("name")):
996
if_tag.appendChild(tag)
997
# Add annotation tags
998
for typ in ("method", "signal", "property"):
999
for tag in if_tag.getElementsByTagName(typ):
1001
for name, prop in (self.
1002
_get_all_dbus_things(typ)):
1003
if (name == tag.getAttribute("name")
1004
and prop._dbus_interface
1005
== if_tag.getAttribute("name")):
1006
annots.update(getattr(
1007
prop, "_dbus_annotations", {}))
1008
for name, value in annots.items():
1009
ann_tag = document.createElement(
1011
ann_tag.setAttribute("name", name)
1012
ann_tag.setAttribute("value", value)
1013
tag.appendChild(ann_tag)
1014
# Add interface annotation tags
1015
for annotation, value in dict(
1016
itertools.chain.from_iterable(
1017
annotations().items()
1018
for name, annotations
1019
in self._get_all_dbus_things("interface")
1020
if name == if_tag.getAttribute("name")
1022
ann_tag = document.createElement("annotation")
1023
ann_tag.setAttribute("name", annotation)
1024
ann_tag.setAttribute("value", value)
1025
if_tag.appendChild(ann_tag)
1026
# Add the names to the return values for the
1027
# "org.freedesktop.DBus.Properties" methods
1028
if (if_tag.getAttribute("name")
1029
== "org.freedesktop.DBus.Properties"):
1030
for cn in if_tag.getElementsByTagName("method"):
1031
if cn.getAttribute("name") == "Get":
1032
for arg in cn.getElementsByTagName("arg"):
1033
if (arg.getAttribute("direction")
1035
arg.setAttribute("name", "value")
1036
elif cn.getAttribute("name") == "GetAll":
1037
for arg in cn.getElementsByTagName("arg"):
1038
if (arg.getAttribute("direction")
1040
arg.setAttribute("name", "props")
1041
xmlstring = document.toxml("utf-8")
1043
except (AttributeError, xml.dom.DOMException,
1044
xml.parsers.expat.ExpatError) as error:
1045
logger.error("Failed to override Introspection method",
1050
def datetime_to_dbus(dt, variant_level=0):
1051
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1053
return dbus.String("", variant_level = variant_level)
1054
return dbus.String(dt.isoformat(), variant_level=variant_level)
1057
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1058
"""A class decorator; applied to a subclass of
1059
dbus.service.Object, it will add alternate D-Bus attributes with
1060
interface names according to the "alt_interface_names" mapping.
1063
@alternate_dbus_interfaces({"org.example.Interface":
1064
"net.example.AlternateInterface"})
1065
class SampleDBusObject(dbus.service.Object):
1066
@dbus.service.method("org.example.Interface")
1067
def SampleDBusMethod():
1070
The above "SampleDBusMethod" on "SampleDBusObject" will be
1071
reachable via two interfaces: "org.example.Interface" and
1072
"net.example.AlternateInterface", the latter of which will have
1073
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1074
"true", unless "deprecate" is passed with a False value.
1076
This works for methods and signals, and also for D-Bus properties
1077
(from DBusObjectWithProperties) and interfaces (from the
1078
dbus_interface_annotations decorator).
1082
for orig_interface_name, alt_interface_name in (
1083
alt_interface_names.items()):
1085
interface_names = set()
1086
# Go though all attributes of the class
1087
for attrname, attribute in inspect.getmembers(cls):
1088
# Ignore non-D-Bus attributes, and D-Bus attributes
1089
# with the wrong interface name
1090
if (not hasattr(attribute, "_dbus_interface")
1091
or not attribute._dbus_interface.startswith(
1092
orig_interface_name)):
1094
# Create an alternate D-Bus interface name based on
1096
alt_interface = attribute._dbus_interface.replace(
1097
orig_interface_name, alt_interface_name)
1098
interface_names.add(alt_interface)
1099
# Is this a D-Bus signal?
1100
if getattr(attribute, "_dbus_is_signal", False):
1101
# Extract the original non-method undecorated
1102
# function by black magic
1103
nonmethod_func = (dict(
1104
zip(attribute.func_code.co_freevars,
1105
attribute.__closure__))
1106
["func"].cell_contents)
1107
# Create a new, but exactly alike, function
1108
# object, and decorate it to be a new D-Bus signal
1109
# with the alternate D-Bus interface name
1110
new_function = (dbus.service.signal(
1111
alt_interface, attribute._dbus_signature)
1112
(types.FunctionType(
1113
nonmethod_func.func_code,
1114
nonmethod_func.func_globals,
1115
nonmethod_func.func_name,
1116
nonmethod_func.func_defaults,
1117
nonmethod_func.func_closure)))
1118
# Copy annotations, if any
1120
new_function._dbus_annotations = dict(
1121
attribute._dbus_annotations)
1122
except AttributeError:
1124
# Define a creator of a function to call both the
1125
# original and alternate functions, so both the
1126
# original and alternate signals gets sent when
1127
# the function is called
1128
def fixscope(func1, func2):
1129
"""This function is a scope container to pass
1130
func1 and func2 to the "call_both" function
1131
outside of its arguments"""
1133
def call_both(*args, **kwargs):
1134
"""This function will emit two D-Bus
1135
signals by calling func1 and func2"""
1136
func1(*args, **kwargs)
1137
func2(*args, **kwargs)
1140
# Create the "call_both" function and add it to
1142
attr[attrname] = fixscope(attribute, new_function)
1143
# Is this a D-Bus method?
1144
elif getattr(attribute, "_dbus_is_method", False):
1145
# Create a new, but exactly alike, function
1146
# object. Decorate it to be a new D-Bus method
1147
# with the alternate D-Bus interface name. Add it
1150
dbus.service.method(
1152
attribute._dbus_in_signature,
1153
attribute._dbus_out_signature)
1154
(types.FunctionType(attribute.func_code,
1155
attribute.func_globals,
1156
attribute.func_name,
1157
attribute.func_defaults,
1158
attribute.func_closure)))
1159
# Copy annotations, if any
1161
attr[attrname]._dbus_annotations = dict(
1162
attribute._dbus_annotations)
1163
except AttributeError:
1165
# Is this a D-Bus property?
1166
elif getattr(attribute, "_dbus_is_property", False):
1167
# Create a new, but exactly alike, function
1168
# object, and decorate it to be a new D-Bus
1169
# property with the alternate D-Bus interface
1170
# name. Add it to the class.
1171
attr[attrname] = (dbus_service_property(
1172
alt_interface, attribute._dbus_signature,
1173
attribute._dbus_access,
1174
attribute._dbus_get_args_options
1176
(types.FunctionType(
1177
attribute.func_code,
1178
attribute.func_globals,
1179
attribute.func_name,
1180
attribute.func_defaults,
1181
attribute.func_closure)))
1182
# Copy annotations, if any
1184
attr[attrname]._dbus_annotations = dict(
1185
attribute._dbus_annotations)
1186
except AttributeError:
1188
# Is this a D-Bus interface?
1189
elif getattr(attribute, "_dbus_is_interface", False):
1190
# Create a new, but exactly alike, function
1191
# object. Decorate it to be a new D-Bus interface
1192
# with the alternate D-Bus interface name. Add it
1195
dbus_interface_annotations(alt_interface)
1196
(types.FunctionType(attribute.func_code,
1197
attribute.func_globals,
1198
attribute.func_name,
1199
attribute.func_defaults,
1200
attribute.func_closure)))
1202
# Deprecate all alternate interfaces
1203
iname="_AlternateDBusNames_interface_annotation{}"
1204
for interface_name in interface_names:
1206
@dbus_interface_annotations(interface_name)
1208
return { "org.freedesktop.DBus.Deprecated":
1210
# Find an unused name
1211
for aname in (iname.format(i)
1212
for i in itertools.count()):
1213
if aname not in attr:
1217
# Replace the class with a new subclass of it with
1218
# methods, signals, etc. as created above.
1219
cls = type(b"{}Alternate".format(cls.__name__),
1226
@alternate_dbus_interfaces({"se.recompile.Mandos":
1227
"se.bsnet.fukt.Mandos"})
1228
class ClientDBus(Client, DBusObjectWithProperties):
1229
"""A Client class using D-Bus
1232
dbus_object_path: dbus.ObjectPath
1233
bus: dbus.SystemBus()
1236
runtime_expansions = (Client.runtime_expansions
1237
+ ("dbus_object_path", ))
1239
_interface = "se.recompile.Mandos.Client"
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 = str(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, dbus_name,
1257
type_func=lambda x: x,
1259
invalidate_only=False,
1260
_interface=_interface):
1261
""" Modify a variable so that it's a property which announces
1262
its changes to DBus.
1264
transform_fun: Function that takes a value and a variant_level
1265
and transforms it to a D-Bus type.
1266
dbus_name: D-Bus name of the variable
1267
type_func: Function that transform the value before sending it
1268
to the D-Bus. Default: no transform
1269
variant_level: D-Bus variant level. Default: 1
1271
attrname = "_{}".format(dbus_name)
1273
def setter(self, value):
1274
if hasattr(self, "dbus_object_path"):
1275
if (not hasattr(self, attrname) or
1276
type_func(getattr(self, attrname, None))
1277
!= type_func(value)):
1279
self.PropertiesChanged(
1280
_interface, dbus.Dictionary(),
1281
dbus.Array((dbus_name, )))
1283
dbus_value = transform_func(
1285
variant_level = variant_level)
1286
self.PropertyChanged(dbus.String(dbus_name),
1288
self.PropertiesChanged(
1290
dbus.Dictionary({ dbus.String(dbus_name):
1293
setattr(self, attrname, value)
1295
return property(lambda self: getattr(self, attrname), setter)
1297
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1298
approvals_pending = notifychangeproperty(dbus.Boolean,
1301
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1302
last_enabled = notifychangeproperty(datetime_to_dbus,
1304
checker = notifychangeproperty(
1305
dbus.Boolean, "CheckerRunning",
1306
type_func = lambda checker: checker is not None)
1307
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1309
last_checker_status = notifychangeproperty(dbus.Int16,
1310
"LastCheckerStatus")
1311
last_approval_request = notifychangeproperty(
1312
datetime_to_dbus, "LastApprovalRequest")
1313
approved_by_default = notifychangeproperty(dbus.Boolean,
1314
"ApprovedByDefault")
1315
approval_delay = notifychangeproperty(
1316
dbus.UInt64, "ApprovalDelay",
1317
type_func = lambda td: td.total_seconds() * 1000)
1318
approval_duration = notifychangeproperty(
1319
dbus.UInt64, "ApprovalDuration",
1320
type_func = lambda td: td.total_seconds() * 1000)
1321
host = notifychangeproperty(dbus.String, "Host")
1322
timeout = notifychangeproperty(
1323
dbus.UInt64, "Timeout",
1324
type_func = lambda td: td.total_seconds() * 1000)
1325
extended_timeout = notifychangeproperty(
1326
dbus.UInt64, "ExtendedTimeout",
1327
type_func = lambda td: td.total_seconds() * 1000)
1328
interval = notifychangeproperty(
1329
dbus.UInt64, "Interval",
1330
type_func = lambda td: td.total_seconds() * 1000)
1331
checker_command = notifychangeproperty(dbus.String, "Checker")
1332
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1333
invalidate_only=True)
1335
del notifychangeproperty
1337
def __del__(self, *args, **kwargs):
1339
self.remove_from_connection()
1342
if hasattr(DBusObjectWithProperties, "__del__"):
1343
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1344
Client.__del__(self, *args, **kwargs)
1346
def checker_callback(self, pid, condition, command,
1348
self.checker_callback_tag = None
1350
if os.WIFEXITED(condition):
1351
exitstatus = os.WEXITSTATUS(condition)
1353
self.CheckerCompleted(dbus.Int16(exitstatus),
1354
dbus.Int64(condition),
1355
dbus.String(command))
1358
self.CheckerCompleted(dbus.Int16(-1),
1359
dbus.Int64(condition),
1360
dbus.String(command))
1362
return Client.checker_callback(self, pid, condition, command,
1365
def start_checker(self, *args, **kwargs):
1366
old_checker_pid = getattr(self.checker, "pid", None)
1367
r = Client.start_checker(self, *args, **kwargs)
1368
# Only if new checker process was started
1369
if (self.checker is not None
1370
and old_checker_pid != self.checker.pid):
1372
self.CheckerStarted(self.current_checker_command)
1375
def _reset_approved(self):
1376
self.approved = None
1379
def approve(self, value=True):
1380
self.approved = value
1381
gobject.timeout_add(int(self.approval_duration.total_seconds()
1382
* 1000), self._reset_approved)
1383
self.send_changedstate()
1385
## D-Bus methods, signals & properties
1391
# CheckerCompleted - signal
1392
@dbus.service.signal(_interface, signature="nxs")
1393
def CheckerCompleted(self, exitcode, waitstatus, command):
1397
# CheckerStarted - signal
1398
@dbus.service.signal(_interface, signature="s")
1399
def CheckerStarted(self, command):
1403
# PropertyChanged - signal
1404
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1405
@dbus.service.signal(_interface, signature="sv")
1406
def PropertyChanged(self, property, value):
1410
# GotSecret - signal
1411
@dbus.service.signal(_interface)
1412
def GotSecret(self):
1414
Is sent after a successful transfer of secret from the Mandos
1415
server to mandos-client
1420
@dbus.service.signal(_interface, signature="s")
1421
def Rejected(self, reason):
1425
# NeedApproval - signal
1426
@dbus.service.signal(_interface, signature="tb")
1427
def NeedApproval(self, timeout, default):
1429
return self.need_approval()
1434
@dbus.service.method(_interface, in_signature="b")
1435
def Approve(self, value):
1438
# CheckedOK - method
1439
@dbus.service.method(_interface)
1440
def CheckedOK(self):
1444
@dbus.service.method(_interface)
1449
# StartChecker - method
1450
@dbus.service.method(_interface)
1451
def StartChecker(self):
1453
self.start_checker()
1456
@dbus.service.method(_interface)
1461
# StopChecker - method
1462
@dbus.service.method(_interface)
1463
def StopChecker(self):
1468
# ApprovalPending - property
1469
@dbus_service_property(_interface, signature="b", access="read")
1470
def ApprovalPending_dbus_property(self):
1471
return dbus.Boolean(bool(self.approvals_pending))
1473
# ApprovedByDefault - property
1474
@dbus_service_property(_interface,
1477
def ApprovedByDefault_dbus_property(self, value=None):
1478
if value is None: # get
1479
return dbus.Boolean(self.approved_by_default)
1480
self.approved_by_default = bool(value)
1482
# ApprovalDelay - property
1483
@dbus_service_property(_interface,
1486
def ApprovalDelay_dbus_property(self, value=None):
1487
if value is None: # get
1488
return dbus.UInt64(self.approval_delay.total_seconds()
1490
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1492
# ApprovalDuration - property
1493
@dbus_service_property(_interface,
1496
def ApprovalDuration_dbus_property(self, value=None):
1497
if value is None: # get
1498
return dbus.UInt64(self.approval_duration.total_seconds()
1500
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1503
@dbus_service_property(_interface, signature="s", access="read")
1504
def Name_dbus_property(self):
1505
return dbus.String(self.name)
1507
# Fingerprint - property
1508
@dbus_service_property(_interface, signature="s", access="read")
1509
def Fingerprint_dbus_property(self):
1510
return dbus.String(self.fingerprint)
1513
@dbus_service_property(_interface,
1516
def Host_dbus_property(self, value=None):
1517
if value is None: # get
1518
return dbus.String(self.host)
1519
self.host = str(value)
1521
# Created - property
1522
@dbus_service_property(_interface, signature="s", access="read")
1523
def Created_dbus_property(self):
1524
return datetime_to_dbus(self.created)
1526
# LastEnabled - property
1527
@dbus_service_property(_interface, signature="s", access="read")
1528
def LastEnabled_dbus_property(self):
1529
return datetime_to_dbus(self.last_enabled)
1531
# Enabled - property
1532
@dbus_service_property(_interface,
1535
def Enabled_dbus_property(self, value=None):
1536
if value is None: # get
1537
return dbus.Boolean(self.enabled)
1543
# LastCheckedOK - property
1544
@dbus_service_property(_interface,
1547
def LastCheckedOK_dbus_property(self, value=None):
1548
if value is not None:
1551
return datetime_to_dbus(self.last_checked_ok)
1553
# LastCheckerStatus - property
1554
@dbus_service_property(_interface, signature="n", access="read")
1555
def LastCheckerStatus_dbus_property(self):
1556
return dbus.Int16(self.last_checker_status)
1558
# Expires - property
1559
@dbus_service_property(_interface, signature="s", access="read")
1560
def Expires_dbus_property(self):
1561
return datetime_to_dbus(self.expires)
1563
# LastApprovalRequest - property
1564
@dbus_service_property(_interface, signature="s", access="read")
1565
def LastApprovalRequest_dbus_property(self):
1566
return datetime_to_dbus(self.last_approval_request)
1568
# Timeout - property
1569
@dbus_service_property(_interface,
1572
def Timeout_dbus_property(self, value=None):
1573
if value is None: # get
1574
return dbus.UInt64(self.timeout.total_seconds() * 1000)
1575
old_timeout = self.timeout
1576
self.timeout = datetime.timedelta(0, 0, 0, value)
1577
# Reschedule disabling
1579
now = datetime.datetime.utcnow()
1580
self.expires += self.timeout - old_timeout
1581
if self.expires <= now:
1582
# The timeout has passed
1585
if (getattr(self, "disable_initiator_tag", None)
1588
gobject.source_remove(self.disable_initiator_tag)
1589
self.disable_initiator_tag = gobject.timeout_add(
1590
int((self.expires - now).total_seconds() * 1000),
1593
# ExtendedTimeout - property
1594
@dbus_service_property(_interface,
1597
def ExtendedTimeout_dbus_property(self, value=None):
1598
if value is None: # get
1599
return dbus.UInt64(self.extended_timeout.total_seconds()
1601
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1603
# Interval - property
1604
@dbus_service_property(_interface,
1607
def Interval_dbus_property(self, value=None):
1608
if value is None: # get
1609
return dbus.UInt64(self.interval.total_seconds() * 1000)
1610
self.interval = datetime.timedelta(0, 0, 0, value)
1611
if getattr(self, "checker_initiator_tag", None) is None:
1614
# Reschedule checker run
1615
gobject.source_remove(self.checker_initiator_tag)
1616
self.checker_initiator_tag = gobject.timeout_add(
1617
value, self.start_checker)
1618
self.start_checker() # Start one now, too
1620
# Checker - property
1621
@dbus_service_property(_interface,
1624
def Checker_dbus_property(self, value=None):
1625
if value is None: # get
1626
return dbus.String(self.checker_command)
1627
self.checker_command = str(value)
1629
# CheckerRunning - property
1630
@dbus_service_property(_interface,
1633
def CheckerRunning_dbus_property(self, value=None):
1634
if value is None: # get
1635
return dbus.Boolean(self.checker is not None)
1637
self.start_checker()
1641
# ObjectPath - property
1642
@dbus_service_property(_interface, signature="o", access="read")
1643
def ObjectPath_dbus_property(self):
1644
return self.dbus_object_path # is already a dbus.ObjectPath
1647
@dbus_service_property(_interface,
1651
def Secret_dbus_property(self, value):
1652
self.secret = bytes(value)
1657
class ProxyClient(object):
1658
def __init__(self, child_pipe, fpr, address):
1659
self._pipe = child_pipe
1660
self._pipe.send(('init', fpr, address))
1661
if not self._pipe.recv():
1664
def __getattribute__(self, name):
1666
return super(ProxyClient, self).__getattribute__(name)
1667
self._pipe.send(('getattr', name))
1668
data = self._pipe.recv()
1669
if data[0] == 'data':
1671
if data[0] == 'function':
1673
def func(*args, **kwargs):
1674
self._pipe.send(('funcall', name, args, kwargs))
1675
return self._pipe.recv()[1]
1679
def __setattr__(self, name, value):
1681
return super(ProxyClient, self).__setattr__(name, value)
1682
self._pipe.send(('setattr', name, value))
1685
class ClientHandler(socketserver.BaseRequestHandler, object):
1686
"""A class to handle client connections.
1688
Instantiated once for each connection to handle it.
367
def still_valid(self):
368
"""Has the timeout not yet passed for this client?"""
369
now = datetime.datetime.now()
370
if self.last_checked_ok is None:
371
return now < (self.created + self.timeout)
373
return now < (self.last_checked_ok + self.timeout)
376
def peer_certificate(session):
377
"Return the peer's OpenPGP certificate as a bytestring"
378
# If not an OpenPGP certificate...
379
if gnutls.library.functions.gnutls_certificate_type_get\
380
(session._c_object) \
381
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP:
382
# ...do the normal thing
383
return session.peer_certificate
384
list_size = ctypes.c_uint()
385
cert_list = gnutls.library.functions.gnutls_certificate_get_peers\
386
(session._c_object, ctypes.byref(list_size))
387
if list_size.value == 0:
390
return ctypes.string_at(cert.data, cert.size)
393
def fingerprint(openpgp):
394
"Convert an OpenPGP bytestring to a hexdigit fingerprint string"
395
# New GnuTLS "datum" with the OpenPGP public key
396
datum = gnutls.library.types.gnutls_datum_t\
397
(ctypes.cast(ctypes.c_char_p(openpgp),
398
ctypes.POINTER(ctypes.c_ubyte)),
399
ctypes.c_uint(len(openpgp)))
400
# New empty GnuTLS certificate
401
crt = gnutls.library.types.gnutls_openpgp_crt_t()
402
gnutls.library.functions.gnutls_openpgp_crt_init\
404
# Import the OpenPGP public key into the certificate
405
gnutls.library.functions.gnutls_openpgp_crt_import\
406
(crt, ctypes.byref(datum),
407
gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
408
# New buffer for the fingerprint
409
buffer = ctypes.create_string_buffer(20)
410
buffer_length = ctypes.c_size_t()
411
# Get the fingerprint from the certificate into the buffer
412
gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint\
413
(crt, ctypes.byref(buffer), ctypes.byref(buffer_length))
414
# Deinit the certificate
415
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
416
# Convert the buffer to a Python bytestring
417
fpr = ctypes.string_at(buffer, buffer_length.value)
418
# Convert the bytestring to hexadecimal notation
419
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
423
class tcp_handler(SocketServer.BaseRequestHandler, object):
424
"""A TCP request handler class.
425
Instantiated by IPv6_TCPServer for each request to handle it.
1689
426
Note: This will run in its own forked process."""
1691
428
def handle(self):
1692
with contextlib.closing(self.server.child_pipe) as child_pipe:
1693
logger.info("TCP connection from: %s",
1694
str(self.client_address))
1695
logger.debug("Pipe FD: %d",
1696
self.server.child_pipe.fileno())
1698
session = gnutls.connection.ClientSession(
1699
self.request, gnutls.connection .X509Credentials())
1701
# Note: gnutls.connection.X509Credentials is really a
1702
# generic GnuTLS certificate credentials object so long as
1703
# no X.509 keys are added to it. Therefore, we can use it
1704
# here despite using OpenPGP certificates.
1706
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1707
# "+AES-256-CBC", "+SHA1",
1708
# "+COMP-NULL", "+CTYPE-OPENPGP",
1710
# Use a fallback default, since this MUST be set.
1711
priority = self.server.gnutls_priority
1712
if priority is None:
1714
gnutls.library.functions.gnutls_priority_set_direct(
1715
session._c_object, priority, None)
1717
# Start communication using the Mandos protocol
1718
# Get protocol number
1719
line = self.request.makefile().readline()
1720
logger.debug("Protocol version: %r", line)
1722
if int(line.strip().split()[0]) > 1:
1723
raise RuntimeError(line)
1724
except (ValueError, IndexError, RuntimeError) as error:
1725
logger.error("Unknown protocol version: %s", error)
1728
# Start GnuTLS connection
1731
except gnutls.errors.GNUTLSError as error:
1732
logger.warning("Handshake failed: %s", error)
1733
# Do not run session.bye() here: the session is not
1734
# established. Just abandon the request.
1736
logger.debug("Handshake succeeded")
1738
approval_required = False
1741
fpr = self.fingerprint(
1742
self.peer_certificate(session))
1744
gnutls.errors.GNUTLSError) as error:
1745
logger.warning("Bad certificate: %s", error)
1747
logger.debug("Fingerprint: %s", fpr)
1750
client = ProxyClient(child_pipe, fpr,
1751
self.client_address)
1755
if client.approval_delay:
1756
delay = client.approval_delay
1757
client.approvals_pending += 1
1758
approval_required = True
1761
if not client.enabled:
1762
logger.info("Client %s is disabled",
1764
if self.server.use_dbus:
1766
client.Rejected("Disabled")
1769
if client.approved or not client.approval_delay:
1770
#We are approved or approval is disabled
1772
elif client.approved is None:
1773
logger.info("Client %s needs approval",
1775
if self.server.use_dbus:
1777
client.NeedApproval(
1778
client.approval_delay.total_seconds()
1779
* 1000, client.approved_by_default)
1781
logger.warning("Client %s was not approved",
1783
if self.server.use_dbus:
1785
client.Rejected("Denied")
1788
#wait until timeout or approved
1789
time = datetime.datetime.now()
1790
client.changedstate.acquire()
1791
client.changedstate.wait(delay.total_seconds())
1792
client.changedstate.release()
1793
time2 = datetime.datetime.now()
1794
if (time2 - time) >= delay:
1795
if not client.approved_by_default:
1796
logger.warning("Client %s timed out while"
1797
" waiting for approval",
1799
if self.server.use_dbus:
1801
client.Rejected("Approval timed out")
1806
delay -= time2 - time
1809
while sent_size < len(client.secret):
1811
sent = session.send(client.secret[sent_size:])
1812
except gnutls.errors.GNUTLSError as error:
1813
logger.warning("gnutls send failed",
1816
logger.debug("Sent: %d, remaining: %d", sent,
1817
len(client.secret) - (sent_size
1821
logger.info("Sending secret to %s", client.name)
1822
# bump the timeout using extended_timeout
1823
client.bump_timeout(client.extended_timeout)
1824
if self.server.use_dbus:
1829
if approval_required:
1830
client.approvals_pending -= 1
1833
except gnutls.errors.GNUTLSError as error:
1834
logger.warning("GnuTLS bye failed",
1838
def peer_certificate(session):
1839
"Return the peer's OpenPGP certificate as a bytestring"
1840
# If not an OpenPGP certificate...
1841
if (gnutls.library.functions.gnutls_certificate_type_get(
1843
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1844
# ...do the normal thing
1845
return session.peer_certificate
1846
list_size = ctypes.c_uint(1)
1847
cert_list = (gnutls.library.functions
1848
.gnutls_certificate_get_peers
1849
(session._c_object, ctypes.byref(list_size)))
1850
if not bool(cert_list) and list_size.value != 0:
1851
raise gnutls.errors.GNUTLSError("error getting peer"
1853
if list_size.value == 0:
1856
return ctypes.string_at(cert.data, cert.size)
1859
def fingerprint(openpgp):
1860
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
1861
# New GnuTLS "datum" with the OpenPGP public key
1862
datum = gnutls.library.types.gnutls_datum_t(
1863
ctypes.cast(ctypes.c_char_p(openpgp),
1864
ctypes.POINTER(ctypes.c_ubyte)),
1865
ctypes.c_uint(len(openpgp)))
1866
# New empty GnuTLS certificate
1867
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1868
gnutls.library.functions.gnutls_openpgp_crt_init(
1870
# Import the OpenPGP public key into the certificate
1871
gnutls.library.functions.gnutls_openpgp_crt_import(
1872
crt, ctypes.byref(datum),
1873
gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
1874
# Verify the self signature in the key
1875
crtverify = ctypes.c_uint()
1876
gnutls.library.functions.gnutls_openpgp_crt_verify_self(
1877
crt, 0, ctypes.byref(crtverify))
1878
if crtverify.value != 0:
1879
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1880
raise gnutls.errors.CertificateSecurityError(
1882
# New buffer for the fingerprint
1883
buf = ctypes.create_string_buffer(20)
1884
buf_len = ctypes.c_size_t()
1885
# Get the fingerprint from the certificate into the buffer
1886
gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint(
1887
crt, ctypes.byref(buf), ctypes.byref(buf_len))
1888
# Deinit the certificate
1889
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1890
# Convert the buffer to a Python bytestring
1891
fpr = ctypes.string_at(buf, buf_len.value)
1892
# Convert the bytestring to hexadecimal notation
1893
hex_fpr = binascii.hexlify(fpr).upper()
1897
class MultiprocessingMixIn(object):
1898
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
1900
def sub_process_main(self, request, address):
1902
self.finish_request(request, address)
1904
self.handle_error(request, address)
1905
self.close_request(request)
1907
def process_request(self, request, address):
1908
"""Start a new process to process the request."""
1909
proc = multiprocessing.Process(target = self.sub_process_main,
1910
args = (request, address))
1915
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1916
""" adds a pipe to the MixIn """
1918
def process_request(self, request, client_address):
1919
"""Overrides and wraps the original process_request().
1921
This function creates a new pipe in self.pipe
1923
parent_pipe, self.child_pipe = multiprocessing.Pipe()
1925
proc = MultiprocessingMixIn.process_request(self, request,
1927
self.child_pipe.close()
1928
self.add_pipe(parent_pipe, proc)
1930
def add_pipe(self, parent_pipe, proc):
1931
"""Dummy function; override as necessary"""
1932
raise NotImplementedError()
1935
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1936
socketserver.TCPServer, object):
1937
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
429
logger.info(u"TCP connection from: %s",
430
unicode(self.client_address))
431
session = gnutls.connection.ClientSession\
432
(self.request, gnutls.connection.X509Credentials())
434
line = self.request.makefile().readline()
435
logger.debug(u"Protocol version: %r", line)
437
if int(line.strip().split()[0]) > 1:
439
except (ValueError, IndexError, RuntimeError), error:
440
logger.error(u"Unknown protocol version: %s", error)
443
# Note: gnutls.connection.X509Credentials is really a generic
444
# GnuTLS certificate credentials object so long as no X.509
445
# keys are added to it. Therefore, we can use it here despite
446
# using OpenPGP certificates.
448
#priority = ':'.join(("NONE", "+VERS-TLS1.1", "+AES-256-CBC",
449
# "+SHA1", "+COMP-NULL", "+CTYPE-OPENPGP",
451
priority = "NORMAL" # Fallback default, since this
453
if self.server.settings["priority"]:
454
priority = self.server.settings["priority"]
455
gnutls.library.functions.gnutls_priority_set_direct\
456
(session._c_object, priority, None);
460
except gnutls.errors.GNUTLSError, error:
461
logger.warning(u"Handshake failed: %s", error)
462
# Do not run session.bye() here: the session is not
463
# established. Just abandon the request.
466
fpr = fingerprint(peer_certificate(session))
467
except (TypeError, gnutls.errors.GNUTLSError), error:
468
logger.warning(u"Bad certificate: %s", error)
471
logger.debug(u"Fingerprint: %s", fpr)
473
for c in self.server.clients:
474
if c.fingerprint == fpr:
478
logger.warning(u"Client not found for fingerprint: %s",
482
# Have to check if client.still_valid(), since it is possible
483
# that the client timed out while establishing the GnuTLS
485
if not client.still_valid():
486
logger.warning(u"Client %(name)s is invalid",
491
while sent_size < len(client.secret):
492
sent = session.send(client.secret[sent_size:])
493
logger.debug(u"Sent: %d, remaining: %d",
494
sent, len(client.secret)
495
- (sent_size + sent))
500
class IPv6_TCPServer(SocketServer.ForkingTCPServer, object):
501
"""IPv6 TCP server. Accepts 'None' as address and/or port.
1940
enabled: Boolean; whether this server is activated yet
1941
interface: None or a network interface name (string)
1942
use_ipv6: Boolean; to use IPv6 or not
503
settings: Server settings
504
clients: Set() of Client objects
1945
def __init__(self, server_address, RequestHandlerClass,
1949
"""If socketfd is set, use that file descriptor instead of
1950
creating a new one with socket.socket().
1952
self.interface = interface
1954
self.address_family = socket.AF_INET6
1955
if socketfd is not None:
1956
# Save the file descriptor
1957
self.socketfd = socketfd
1958
# Save the original socket.socket() function
1959
self.socket_socket = socket.socket
1960
# To implement --socket, we monkey patch socket.socket.
1962
# (When socketserver.TCPServer is a new-style class, we
1963
# could make self.socket into a property instead of monkey
1964
# patching socket.socket.)
1966
# Create a one-time-only replacement for socket.socket()
1967
@functools.wraps(socket.socket)
1968
def socket_wrapper(*args, **kwargs):
1969
# Restore original function so subsequent calls are
1971
socket.socket = self.socket_socket
1972
del self.socket_socket
1973
# This time only, return a new socket object from the
1974
# saved file descriptor.
1975
return socket.fromfd(self.socketfd, *args, **kwargs)
1976
# Replace socket.socket() function with wrapper
1977
socket.socket = socket_wrapper
1978
# The socketserver.TCPServer.__init__ will call
1979
# socket.socket(), which might be our replacement,
1980
# socket_wrapper(), if socketfd was set.
1981
socketserver.TCPServer.__init__(self, server_address,
1982
RequestHandlerClass)
506
address_family = socket.AF_INET6
507
def __init__(self, *args, **kwargs):
508
if "settings" in kwargs:
509
self.settings = kwargs["settings"]
510
del kwargs["settings"]
511
if "clients" in kwargs:
512
self.clients = kwargs["clients"]
513
del kwargs["clients"]
514
return super(type(self), self).__init__(*args, **kwargs)
1984
515
def server_bind(self):
1985
516
"""This overrides the normal server_bind() function
1986
517
to bind to an interface if one was specified, and also NOT to
1987
518
bind to an address or port if they were not specified."""
1988
if self.interface is not None:
1989
if SO_BINDTODEVICE is None:
1990
logger.error("SO_BINDTODEVICE does not exist;"
1991
" cannot bind to interface %s",
1995
self.socket.setsockopt(
1996
socket.SOL_SOCKET, SO_BINDTODEVICE,
1997
(self.interface + "\0").encode("utf-8"))
1998
except socket.error as error:
1999
if error.errno == errno.EPERM:
2000
logger.error("No permission to bind to"
2001
" interface %s", self.interface)
2002
elif error.errno == errno.ENOPROTOOPT:
2003
logger.error("SO_BINDTODEVICE not available;"
2004
" cannot bind to interface %s",
2006
elif error.errno == errno.ENODEV:
2007
logger.error("Interface %s does not exist,"
2008
" cannot bind", self.interface)
519
if self.settings["interface"]:
520
# 25 is from /usr/include/asm-i486/socket.h
521
SO_BINDTODEVICE = getattr(socket, "SO_BINDTODEVICE", 25)
523
self.socket.setsockopt(socket.SOL_SOCKET,
525
self.settings["interface"])
526
except socket.error, error:
527
if error[0] == errno.EPERM:
528
logger.error(u"No permission to"
529
u" bind to interface %s",
530
self.settings["interface"])
2011
533
# Only bind(2) the socket if we really need to.
2012
534
if self.server_address[0] or self.server_address[1]:
2013
535
if not self.server_address[0]:
2014
if self.address_family == socket.AF_INET6:
2015
any_address = "::" # in6addr_any
2017
any_address = "0.0.0.0" # INADDR_ANY
2018
self.server_address = (any_address,
537
self.server_address = (in6addr_any,
2019
538
self.server_address[1])
2020
539
elif not self.server_address[1]:
2021
self.server_address = (self.server_address[0], 0)
2022
# if self.interface:
540
self.server_address = (self.server_address[0],
542
# if self.settings["interface"]:
2023
543
# self.server_address = (self.server_address[0],
2026
546
# if_nametoindex
2028
return socketserver.TCPServer.server_bind(self)
2031
class MandosServer(IPv6_TCPServer):
2035
clients: set of Client objects
2036
gnutls_priority GnuTLS priority string
2037
use_dbus: Boolean; to emit D-Bus signals or not
2039
Assumes a gobject.MainLoop event loop.
2042
def __init__(self, server_address, RequestHandlerClass,
2046
gnutls_priority=None,
2049
self.enabled = False
2050
self.clients = clients
2051
if self.clients is None:
2053
self.use_dbus = use_dbus
2054
self.gnutls_priority = gnutls_priority
2055
IPv6_TCPServer.__init__(self, server_address,
2056
RequestHandlerClass,
2057
interface = interface,
2058
use_ipv6 = use_ipv6,
2059
socketfd = socketfd)
2061
def server_activate(self):
2063
return socketserver.TCPServer.server_activate(self)
2068
def add_pipe(self, parent_pipe, proc):
2069
# Call "handle_ipc" for both data and EOF events
2070
gobject.io_add_watch(
2071
parent_pipe.fileno(),
2072
gobject.IO_IN | gobject.IO_HUP,
2073
functools.partial(self.handle_ipc,
2074
parent_pipe = parent_pipe,
2077
def handle_ipc(self, source, condition,
2080
client_object=None):
2081
# error, or the other end of multiprocessing.Pipe has closed
2082
if condition & (gobject.IO_ERR | gobject.IO_HUP):
2083
# Wait for other process to exit
2087
# Read a request from the child
2088
request = parent_pipe.recv()
2089
command = request[0]
2091
if command == 'init':
2093
address = request[2]
2095
for c in self.clients.itervalues():
2096
if c.fingerprint == fpr:
2100
logger.info("Client not found for fingerprint: %s, ad"
2101
"dress: %s", fpr, address)
2104
mandos_dbus_service.ClientNotFound(fpr,
2106
parent_pipe.send(False)
2109
gobject.io_add_watch(
2110
parent_pipe.fileno(),
2111
gobject.IO_IN | gobject.IO_HUP,
2112
functools.partial(self.handle_ipc,
2113
parent_pipe = parent_pipe,
2115
client_object = client))
2116
parent_pipe.send(True)
2117
# remove the old hook in favor of the new above hook on
2120
if command == 'funcall':
2121
funcname = request[1]
2125
parent_pipe.send(('data', getattr(client_object,
2129
if command == 'getattr':
2130
attrname = request[1]
2131
if callable(client_object.__getattribute__(attrname)):
2132
parent_pipe.send(('function', ))
2135
'data', client_object.__getattribute__(attrname)))
2137
if command == 'setattr':
2138
attrname = request[1]
2140
setattr(client_object, attrname, value)
2145
def rfc3339_duration_to_delta(duration):
2146
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2148
>>> rfc3339_duration_to_delta("P7D")
2149
datetime.timedelta(7)
2150
>>> rfc3339_duration_to_delta("PT60S")
2151
datetime.timedelta(0, 60)
2152
>>> rfc3339_duration_to_delta("PT60M")
2153
datetime.timedelta(0, 3600)
2154
>>> rfc3339_duration_to_delta("PT24H")
2155
datetime.timedelta(1)
2156
>>> rfc3339_duration_to_delta("P1W")
2157
datetime.timedelta(7)
2158
>>> rfc3339_duration_to_delta("PT5M30S")
2159
datetime.timedelta(0, 330)
2160
>>> rfc3339_duration_to_delta("P1DT3M20S")
2161
datetime.timedelta(1, 200)
2164
# Parsing an RFC 3339 duration with regular expressions is not
2165
# possible - there would have to be multiple places for the same
2166
# values, like seconds. The current code, while more esoteric, is
2167
# cleaner without depending on a parsing library. If Python had a
2168
# built-in library for parsing we would use it, but we'd like to
2169
# avoid excessive use of external libraries.
2171
# New type for defining tokens, syntax, and semantics all-in-one
2172
Token = collections.namedtuple("Token",
2173
("regexp", # To match token; if
2174
# "value" is not None,
2175
# must have a "group"
2177
"value", # datetime.timedelta or
2179
"followers")) # Tokens valid after
2181
Token = collections.namedtuple("Token", (
2182
"regexp", # To match token; if "value" is not None, must have
2183
# a "group" containing digits
2184
"value", # datetime.timedelta or None
2185
"followers")) # Tokens valid after this token
2186
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2187
# the "duration" ABNF definition in RFC 3339, Appendix A.
2188
token_end = Token(re.compile(r"$"), None, frozenset())
2189
token_second = Token(re.compile(r"(\d+)S"),
2190
datetime.timedelta(seconds=1),
2191
frozenset((token_end, )))
2192
token_minute = Token(re.compile(r"(\d+)M"),
2193
datetime.timedelta(minutes=1),
2194
frozenset((token_second, token_end)))
2195
token_hour = Token(re.compile(r"(\d+)H"),
2196
datetime.timedelta(hours=1),
2197
frozenset((token_minute, token_end)))
2198
token_time = Token(re.compile(r"T"),
2200
frozenset((token_hour, token_minute,
2202
token_day = Token(re.compile(r"(\d+)D"),
2203
datetime.timedelta(days=1),
2204
frozenset((token_time, token_end)))
2205
token_month = Token(re.compile(r"(\d+)M"),
2206
datetime.timedelta(weeks=4),
2207
frozenset((token_day, token_end)))
2208
token_year = Token(re.compile(r"(\d+)Y"),
2209
datetime.timedelta(weeks=52),
2210
frozenset((token_month, token_end)))
2211
token_week = Token(re.compile(r"(\d+)W"),
2212
datetime.timedelta(weeks=1),
2213
frozenset((token_end, )))
2214
token_duration = Token(re.compile(r"P"), None,
2215
frozenset((token_year, token_month,
2216
token_day, token_time,
2218
# Define starting values
2219
value = datetime.timedelta() # Value so far
2221
followers = frozenset((token_duration,)) # Following valid tokens
2222
s = duration # String left to parse
2223
# Loop until end token is found
2224
while found_token is not token_end:
2225
# Search for any currently valid tokens
2226
for token in followers:
2227
match = token.regexp.match(s)
2228
if match is not None:
2230
if token.value is not None:
2231
# Value found, parse digits
2232
factor = int(match.group(1), 10)
2233
# Add to value so far
2234
value += factor * token.value
2235
# Strip token from string
2236
s = token.regexp.sub("", s, 1)
2239
# Set valid next tokens
2240
followers = found_token.followers
2243
# No currently valid tokens were found
2244
raise ValueError("Invalid RFC 3339 duration")
549
return super(type(self), self).server_bind()
2249
552
def string_to_delta(interval):
2250
553
"""Parse a string and return a datetime.timedelta
2252
555
>>> string_to_delta('7d')
2253
556
datetime.timedelta(7)
2254
557
>>> string_to_delta('60s')
2380
692
"debug": "False",
2382
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2383
":+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",
694
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
2384
695
"servicename": "Mandos",
2390
"statedir": "/var/lib/mandos",
2391
"foreground": "False",
2395
698
# Parse config file for server-global settings
2396
server_config = configparser.SafeConfigParser(server_defaults)
699
server_config = ConfigParser.SafeConfigParser(server_defaults)
2397
700
del server_defaults
2398
701
server_config.read(os.path.join(options.configdir, "mandos.conf"))
702
server_section = "server"
2399
703
# Convert the SafeConfigParser object to a dict
2400
server_settings = server_config.defaults()
2401
# Use the appropriate methods on the non-string config options
2402
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2403
server_settings[option] = server_config.getboolean("DEFAULT",
2405
if server_settings["port"]:
2406
server_settings["port"] = server_config.getint("DEFAULT",
2408
if server_settings["socket"]:
2409
server_settings["socket"] = server_config.getint("DEFAULT",
2411
# Later, stdin will, and stdout and stderr might, be dup'ed
2412
# over with an opened os.devnull. But we don't want this to
2413
# happen with a supplied network socket.
2414
if 0 <= server_settings["socket"] <= 2:
2415
server_settings["socket"] = os.dup(server_settings
704
server_settings = dict(server_config.items(server_section))
705
# Use getboolean on the boolean config option
706
server_settings["debug"] = server_config.getboolean\
707
(server_section, "debug")
2417
708
del server_config
2419
710
# Override the settings from the config file with command line
2420
711
# options, if set.
2421
712
for option in ("interface", "address", "port", "debug",
2422
"priority", "servicename", "configdir", "use_dbus",
2423
"use_ipv6", "debuglevel", "restore", "statedir",
2424
"socket", "foreground", "zeroconf"):
713
"priority", "servicename", "configdir"):
2425
714
value = getattr(options, option)
2426
715
if value is not None:
2427
716
server_settings[option] = value
2429
# Force all strings to be unicode
2430
for option in server_settings.keys():
2431
if isinstance(server_settings[option], bytes):
2432
server_settings[option] = (server_settings[option]
2434
# Force all boolean options to be boolean
2435
for option in ("debug", "use_dbus", "use_ipv6", "restore",
2436
"foreground", "zeroconf"):
2437
server_settings[option] = bool(server_settings[option])
2438
# Debug implies foreground
2439
if server_settings["debug"]:
2440
server_settings["foreground"] = True
2441
718
# Now we have our good server settings in "server_settings"
2443
##################################################################
2445
if (not server_settings["zeroconf"]
2446
and not (server_settings["port"]
2447
or server_settings["socket"] != "")):
2448
parser.error("Needs port or socket to work without Zeroconf")
2451
720
debug = server_settings["debug"]
2452
debuglevel = server_settings["debuglevel"]
2453
use_dbus = server_settings["use_dbus"]
2454
use_ipv6 = server_settings["use_ipv6"]
2455
stored_state_path = os.path.join(server_settings["statedir"],
2457
foreground = server_settings["foreground"]
2458
zeroconf = server_settings["zeroconf"]
2461
initlogger(debug, logging.DEBUG)
2466
level = getattr(logging, debuglevel.upper())
2467
initlogger(debug, level)
723
syslogger.setLevel(logging.WARNING)
724
console.setLevel(logging.WARNING)
2469
726
if server_settings["servicename"] != "Mandos":
2470
syslogger.setFormatter(
2471
logging.Formatter('Mandos ({}) [%(process)d]:'
2472
' %(levelname)s: %(message)s'.format(
2473
server_settings["servicename"])))
727
syslogger.setFormatter(logging.Formatter\
728
('Mandos (%s): %%(levelname)s:'
730
% server_settings["servicename"]))
2475
732
# Parse config file with clients
2476
client_config = configparser.SafeConfigParser(Client
733
client_defaults = { "timeout": "1h",
735
"checker": "fping -q -- %%(host)s",
737
client_config = ConfigParser.SafeConfigParser(client_defaults)
2478
738
client_config.read(os.path.join(server_settings["configdir"],
2479
739
"clients.conf"))
2481
global mandos_dbus_service
2482
mandos_dbus_service = None
2485
if server_settings["socket"] != "":
2486
socketfd = server_settings["socket"]
2487
tcp_server = MandosServer(
2488
(server_settings["address"], server_settings["port"]),
2490
interface=(server_settings["interface"] or None),
2492
gnutls_priority=server_settings["priority"],
2496
pidfilename = "/run/mandos.pid"
2497
if not os.path.isdir("/run/."):
2498
pidfilename = "/var/run/mandos.pid"
2501
pidfile = open(pidfilename, "w")
2502
except IOError as e:
2503
logger.error("Could not open file %r", pidfilename,
2506
for name in ("_mandos", "mandos", "nobody"):
2508
uid = pwd.getpwnam(name).pw_uid
2509
gid = pwd.getpwnam(name).pw_gid
2519
except OSError as error:
2520
if error.errno != errno.EPERM:
2524
# Enable all possible GnuTLS debugging
2526
# "Use a log level over 10 to enable all debugging options."
2528
gnutls.library.functions.gnutls_global_set_log_level(11)
2530
@gnutls.library.types.gnutls_log_func
2531
def debug_gnutls(level, string):
2532
logger.debug("GnuTLS: %s", string[:-1])
2534
gnutls.library.functions.gnutls_global_set_log_function(
2537
# Redirect stdin so all checkers get /dev/null
2538
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2539
os.dup2(null, sys.stdin.fileno())
2543
# Need to fork before connecting to D-Bus
2545
# Close all input and output, do double fork, etc.
2548
# multiprocessing will use threads, so before we use gobject we
2549
# need to inform gobject that threads will be used.
2550
gobject.threads_init()
742
service = AvahiService(name = server_settings["servicename"],
743
type = "_mandos._tcp", );
744
if server_settings["interface"]:
745
service.interface = if_nametoindex(server_settings["interface"])
2552
747
global main_loop
2553
750
# From the Avahi example code
2554
DBusGMainLoop(set_as_default=True)
751
DBusGMainLoop(set_as_default=True )
2555
752
main_loop = gobject.MainLoop()
2556
753
bus = dbus.SystemBus()
754
server = dbus.Interface(
755
bus.get_object( avahi.DBUS_NAME, avahi.DBUS_PATH_SERVER ),
756
avahi.DBUS_INTERFACE_SERVER )
2557
757
# End of Avahi example code
2560
bus_name = dbus.service.BusName("se.recompile.Mandos",
2563
old_bus_name = dbus.service.BusName(
2564
"se.bsnet.fukt.Mandos", bus,
2566
except dbus.exceptions.NameExistsException as e:
2567
logger.error("Disabling D-Bus:", exc_info=e)
2569
server_settings["use_dbus"] = False
2570
tcp_server.use_dbus = False
2572
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2573
service = AvahiServiceToSyslog(
2574
name = server_settings["servicename"],
2575
servicetype = "_mandos._tcp",
2576
protocol = protocol,
2578
if server_settings["interface"]:
2579
service.interface = if_nametoindex(
2580
server_settings["interface"].encode("utf-8"))
2582
global multiprocessing_manager
2583
multiprocessing_manager = multiprocessing.Manager()
2585
client_class = Client
2587
client_class = functools.partial(ClientDBus, bus = bus)
2589
client_settings = Client.config_parser(client_config)
2590
old_client_settings = {}
2593
# This is used to redirect stdout and stderr for checker processes
2595
wnull = open(os.devnull, "w") # A writable /dev/null
2596
# Only used if server is running in foreground but not in debug
2598
if debug or not foreground:
2601
# Get client data and settings from last running state.
2602
if server_settings["restore"]:
2604
with open(stored_state_path, "rb") as stored_state:
2605
clients_data, old_client_settings = pickle.load(
2607
os.remove(stored_state_path)
2608
except IOError as e:
2609
if e.errno == errno.ENOENT:
2610
logger.warning("Could not load persistent state:"
2611
" {}".format(os.strerror(e.errno)))
2613
logger.critical("Could not load persistent state:",
2616
except EOFError as e:
2617
logger.warning("Could not load persistent state: "
2621
with PGPEngine() as pgp:
2622
for client_name, client in clients_data.items():
2623
# Skip removed clients
2624
if client_name not in client_settings:
2627
# Decide which value to use after restoring saved state.
2628
# We have three different values: Old config file,
2629
# new config file, and saved state.
2630
# New config value takes precedence if it differs from old
2631
# config value, otherwise use saved state.
2632
for name, value in client_settings[client_name].items():
2634
# For each value in new config, check if it
2635
# differs from the old config value (Except for
2636
# the "secret" attribute)
2637
if (name != "secret"
2639
old_client_settings[client_name][name])):
2640
client[name] = value
2644
# Clients who has passed its expire date can still be
2645
# enabled if its last checker was successful. Clients
2646
# whose checker succeeded before we stored its state is
2647
# assumed to have successfully run all checkers during
2649
if client["enabled"]:
2650
if datetime.datetime.utcnow() >= client["expires"]:
2651
if not client["last_checked_ok"]:
2653
"disabling client {} - Client never "
2654
"performed a successful checker".format(
2656
client["enabled"] = False
2657
elif client["last_checker_status"] != 0:
2659
"disabling client {} - Client last"
2660
" checker failed with error code"
2663
client["last_checker_status"]))
2664
client["enabled"] = False
2666
client["expires"] = (
2667
datetime.datetime.utcnow()
2668
+ client["timeout"])
2669
logger.debug("Last checker succeeded,"
2670
" keeping {} enabled".format(
2673
client["secret"] = pgp.decrypt(
2674
client["encrypted_secret"],
2675
client_settings[client_name]["secret"])
2677
# If decryption fails, we use secret from new settings
2678
logger.debug("Failed to decrypt {} old secret".format(
2680
client["secret"] = (client_settings[client_name]
2683
# Add/remove clients based on new changes made to config
2684
for client_name in (set(old_client_settings)
2685
- set(client_settings)):
2686
del clients_data[client_name]
2687
for client_name in (set(client_settings)
2688
- set(old_client_settings)):
2689
clients_data[client_name] = client_settings[client_name]
2691
# Create all client objects
2692
for client_name, client in clients_data.items():
2693
tcp_server.clients[client_name] = client_class(
2696
server_settings = server_settings)
2698
if not tcp_server.clients:
2699
logger.warning("No clients defined")
2702
if pidfile is not None:
2706
pidfile.write("{}\n".format(pid).encode("utf-8"))
2708
logger.error("Could not write to file %r with PID %d",
760
def remove_from_clients(client):
761
clients.remove(client)
763
logger.critical(u"No clients left, exiting")
766
clients.update(Set(Client(name = section,
767
stop_hook = remove_from_clients,
769
= dict(client_config.items(section)))
770
for section in client_config.sections()))
772
logger.critical(u"No clients defined")
776
logger.removeHandler(console)
779
pidfilename = "/var/run/mandos/mandos.pid"
782
pidfile = open(pidfilename, "w")
783
pidfile.write(str(pid) + "\n")
2713
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2714
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2718
@alternate_dbus_interfaces(
2719
{ "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
2720
class MandosDBusService(DBusObjectWithProperties):
2721
"""A D-Bus proxy object"""
2724
dbus.service.Object.__init__(self, bus, "/")
2726
_interface = "se.recompile.Mandos"
2728
@dbus_interface_annotations(_interface)
2731
"org.freedesktop.DBus.Property.EmitsChangedSignal":
2734
@dbus.service.signal(_interface, signature="o")
2735
def ClientAdded(self, objpath):
2739
@dbus.service.signal(_interface, signature="ss")
2740
def ClientNotFound(self, fingerprint, address):
2744
@dbus.service.signal(_interface, signature="os")
2745
def ClientRemoved(self, objpath, name):
2749
@dbus.service.method(_interface, out_signature="ao")
2750
def GetAllClients(self):
2752
return dbus.Array(c.dbus_object_path for c in
2753
tcp_server.clients.itervalues())
2755
@dbus.service.method(_interface,
2756
out_signature="a{oa{sv}}")
2757
def GetAllClientsWithProperties(self):
2759
return dbus.Dictionary(
2760
{ c.dbus_object_path: c.GetAll("")
2761
for c in tcp_server.clients.itervalues() },
2764
@dbus.service.method(_interface, in_signature="o")
2765
def RemoveClient(self, object_path):
2767
for c in tcp_server.clients.itervalues():
2768
if c.dbus_object_path == object_path:
2769
del tcp_server.clients[c.name]
2770
c.remove_from_connection()
2771
# Don't signal anything except ClientRemoved
2772
c.disable(quiet=True)
2774
self.ClientRemoved(object_path, c.name)
2776
raise KeyError(object_path)
2780
mandos_dbus_service = MandosDBusService()
787
logger.error(u"Could not write %s file with PID %d",
788
pidfilename, os.getpid())
2783
791
"Cleanup function; run on exit"
2787
multiprocessing.active_children()
2789
if not (tcp_server.clients or client_settings):
2792
# Store client before exiting. Secrets are encrypted with key
2793
# based on what config file has. If config file is
2794
# removed/edited, old secret will thus be unrecovable.
2796
with PGPEngine() as pgp:
2797
for client in tcp_server.clients.itervalues():
2798
key = client_settings[client.name]["secret"]
2799
client.encrypted_secret = pgp.encrypt(client.secret,
2803
# A list of attributes that can not be pickled
2805
exclude = { "bus", "changedstate", "secret",
2806
"checker", "server_settings" }
2807
for name, typ in inspect.getmembers(dbus.service
2811
client_dict["encrypted_secret"] = (client
2813
for attr in client.client_structure:
2814
if attr not in exclude:
2815
client_dict[attr] = getattr(client, attr)
2817
clients[client.name] = client_dict
2818
del client_settings[client.name]["secret"]
2821
with tempfile.NamedTemporaryFile(
2825
dir=os.path.dirname(stored_state_path),
2826
delete=False) as stored_state:
2827
pickle.dump((clients, client_settings), stored_state)
2828
tempname = stored_state.name
2829
os.rename(tempname, stored_state_path)
2830
except (IOError, OSError) as e:
2836
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
2837
logger.warning("Could not save persistent state: {}"
2838
.format(os.strerror(e.errno)))
2840
logger.warning("Could not save persistent state:",
2844
# Delete all clients, and settings from config
2845
while tcp_server.clients:
2846
name, client = tcp_server.clients.popitem()
2848
client.remove_from_connection()
2849
# Don't signal anything except ClientRemoved
2850
client.disable(quiet=True)
2853
mandos_dbus_service.ClientRemoved(
2854
client.dbus_object_path, client.name)
2855
client_settings.clear()
793
# From the Avahi example code
794
if not group is None:
797
# End of Avahi example code
800
client = clients.pop()
801
client.stop_hook = None
2857
804
atexit.register(cleanup)
2859
for client in tcp_server.clients.itervalues():
2862
mandos_dbus_service.ClientAdded(client.dbus_object_path)
2863
# Need to initiate checking of clients
2865
client.init_checker()
2868
tcp_server.server_activate()
807
signal.signal(signal.SIGINT, signal.SIG_IGN)
808
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
809
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
811
for client in clients:
814
tcp_server = IPv6_TCPServer((server_settings["address"],
815
server_settings["port"]),
817
settings=server_settings,
2870
819
# Find out what port we got
2872
service.port = tcp_server.socket.getsockname()[1]
2874
logger.info("Now listening on address %r, port %d,"
2875
" flowinfo %d, scope_id %d",
2876
*tcp_server.socket.getsockname())
2878
logger.info("Now listening on address %r, port %d",
2879
*tcp_server.socket.getsockname())
820
service.port = tcp_server.socket.getsockname()[1]
821
logger.info(u"Now listening on address %r, port %d, flowinfo %d,"
822
u" scope_id %d" % tcp_server.socket.getsockname())
2881
824
#service.interface = tcp_server.socket.getsockname()[3]
2885
# From the Avahi example code
2888
except dbus.exceptions.DBusException as error:
2889
logger.critical("D-Bus Exception", exc_info=error)
2892
# End of Avahi example code
827
# From the Avahi example code
828
server.connect_to_signal("StateChanged", server_state_changed)
830
server_state_changed(server.GetState())
831
except dbus.exceptions.DBusException, error:
832
logger.critical(u"DBusException: %s", error)
834
# End of Avahi example code
2894
836
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2895
837
lambda *args, **kwargs:
2896
(tcp_server.handle_request
2897
(*args[2:], **kwargs) or True))
838
tcp_server.handle_request\
839
(*args[2:], **kwargs) or True)
2899
logger.debug("Starting main loop")
841
logger.debug(u"Starting main loop")
842
main_loop_started = True
2901
except AvahiError as error:
2902
logger.critical("Avahi Error", exc_info=error)
844
except AvahiError, error:
845
logger.critical(u"AvahiError: %s" + unicode(error))
2905
847
except KeyboardInterrupt:
2907
print("", file=sys.stderr)
2908
logger.debug("Server received KeyboardInterrupt")
2909
logger.debug("Server exiting")
2910
# Must run before the D-Bus bus name gets deregistered
2914
851
if __name__ == '__main__':