235
98
class AvahiService(object):
236
"""An Avahi (Zeroconf) service.
239
100
interface: integer; avahi.IF_UNSPEC or an interface index.
240
101
Used to optionally bind to the specified interface.
241
name: string; Example: 'Mandos'
242
type: string; Example: '_mandos._tcp'.
243
See <https://www.iana.org/assignments/service-names-port-numbers>
244
port: integer; what port to announce
245
TXT: list of strings; TXT record for the service
246
domain: string; Domain to publish on, default to .local if empty.
247
host: string; Host to publish records for, default is localhost
248
max_renames: integer; maximum number of renames
249
rename_count: integer; counter so we only rename after collisions
250
a sensible number of times
251
group: D-Bus Entry Group
253
bus: dbus.SystemBus()
102
name = string; Example: "Mandos"
103
type = string; Example: "_mandos._tcp".
104
See <http://www.dns-sd.org/ServiceTypes.html>
105
port = integer; what port to announce
106
TXT = list of strings; TXT record for the service
107
domain = string; Domain to publish on, default to .local if empty.
108
host = string; Host to publish records for, default to localhost
110
max_renames = integer; maximum number of renames
111
rename_count = integer; counter so we only rename after collisions
112
a sensible number of times
256
114
def __init__(self, interface = avahi.IF_UNSPEC, name = None,
257
servicetype = None, port = None, TXT = None,
258
domain = "", host = "", max_renames = 32768,
259
protocol = avahi.PROTO_UNSPEC, bus = None):
115
type = None, port = None, TXT = None, domain = "",
116
host = "", max_renames = 12):
117
"""An Avahi (Zeroconf) service. """
260
118
self.interface = interface
262
self.type = servicetype
264
self.TXT = TXT if TXT is not None else []
265
126
self.domain = domain
267
128
self.rename_count = 0
268
self.max_renames = max_renames
269
self.protocol = protocol
270
self.group = None # our entry group
273
self.entry_group_state_changed_match = None
275
129
def rename(self):
276
130
"""Derived from the Avahi example code"""
277
131
if self.rename_count >= self.max_renames:
278
logger.critical("No suitable Zeroconf service name found"
279
" after %i retries, exiting.",
132
logger.critical(u"No suitable service name found after %i"
133
u" retries, exiting.", rename_count)
281
134
raise AvahiServiceError("Too many renames")
282
self.name = unicode(self.server
283
.GetAlternativeServiceName(self.name))
284
logger.info("Changing Zeroconf service name to %r ...",
135
name = server.GetAlternativeServiceName(name)
136
logger.notice(u"Changing name to %r ...", name)
289
except dbus.exceptions.DBusException as error:
290
logger.critical("D-Bus Exception", exc_info=error)
293
139
self.rename_count += 1
295
140
def remove(self):
296
141
"""Derived from the Avahi example code"""
297
if self.entry_group_state_changed_match is not None:
298
self.entry_group_state_changed_match.remove()
299
self.entry_group_state_changed_match = None
300
if self.group is not None:
142
if group is not None:
304
145
"""Derived from the Avahi example code"""
306
if self.group is None:
307
self.group = dbus.Interface(
308
self.bus.get_object(avahi.DBUS_NAME,
309
self.server.EntryGroupNew()),
310
avahi.DBUS_INTERFACE_ENTRY_GROUP)
311
self.entry_group_state_changed_match = (
312
self.group.connect_to_signal(
313
'StateChanged', self.entry_group_state_changed))
314
logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
315
self.name, self.type)
316
self.group.AddService(
319
dbus.UInt32(0), # flags
320
self.name, self.type,
321
self.domain, self.host,
322
dbus.UInt16(self.port),
323
avahi.string_array_to_txt_array(self.TXT))
326
def entry_group_state_changed(self, state, error):
327
"""Derived from the Avahi example code"""
328
logger.debug("Avahi entry group state change: %i", state)
330
if state == avahi.ENTRY_GROUP_ESTABLISHED:
331
logger.debug("Zeroconf service established.")
332
elif state == avahi.ENTRY_GROUP_COLLISION:
333
logger.info("Zeroconf service name collision.")
335
elif state == avahi.ENTRY_GROUP_FAILURE:
336
logger.critical("Avahi: Error in group state changed %s",
338
raise AvahiGroupError("State changed: {0!s}"
342
"""Derived from the Avahi example code"""
343
if self.group is not None:
346
except (dbus.exceptions.UnknownMethodException,
347
dbus.exceptions.DBusException):
352
def server_state_changed(self, state, error=None):
353
"""Derived from the Avahi example code"""
354
logger.debug("Avahi server state change: %i", state)
355
bad_states = { avahi.SERVER_INVALID:
356
"Zeroconf server invalid",
357
avahi.SERVER_REGISTERING: None,
358
avahi.SERVER_COLLISION:
359
"Zeroconf server name collision",
360
avahi.SERVER_FAILURE:
361
"Zeroconf server failure" }
362
if state in bad_states:
363
if bad_states[state] is not None:
365
logger.error(bad_states[state])
367
logger.error(bad_states[state] + ": %r", error)
369
elif state == avahi.SERVER_RUNNING:
373
logger.debug("Unknown state: %r", state)
375
logger.debug("Unknown state: %r: %r", state, error)
378
"""Derived from the Avahi example code"""
379
if self.server is None:
380
self.server = dbus.Interface(
381
self.bus.get_object(avahi.DBUS_NAME,
382
avahi.DBUS_PATH_SERVER,
383
follow_name_owner_changes=True),
384
avahi.DBUS_INTERFACE_SERVER)
385
self.server.connect_to_signal("StateChanged",
386
self.server_state_changed)
387
self.server_state_changed(self.server.GetState())
390
class AvahiServiceToSyslog(AvahiService):
392
"""Add the new name to the syslog messages"""
393
ret = AvahiService.rename(self)
394
syslogger.setFormatter(logging.Formatter
395
('Mandos ({0}) [%(process)d]:'
396
' %(levelname)s: %(message)s'
401
def timedelta_to_milliseconds(td):
402
"Convert a datetime.timedelta() to milliseconds"
403
return ((td.days * 24 * 60 * 60 * 1000)
404
+ (td.seconds * 1000)
405
+ (td.microseconds // 1000))
148
group = dbus.Interface\
149
(bus.get_object(avahi.DBUS_NAME,
150
server.EntryGroupNew()),
151
avahi.DBUS_INTERFACE_ENTRY_GROUP)
152
group.connect_to_signal('StateChanged',
153
entry_group_state_changed)
154
logger.debug(u"Adding service '%s' of type '%s' ...",
155
service.name, service.type)
157
self.interface, # interface
158
avahi.PROTO_INET6, # protocol
159
dbus.UInt32(0), # flags
160
self.name, self.type,
161
self.domain, self.host,
162
dbus.UInt16(self.port),
163
avahi.string_array_to_txt_array(self.TXT))
166
# From the Avahi example code:
167
group = None # our entry group
168
# End of Avahi example code
408
171
class Client(object):
409
172
"""A representation of a client host served by this server.
412
approved: bool(); 'None' if not yet approved/disapproved
413
approval_delay: datetime.timedelta(); Time to wait for approval
414
approval_duration: datetime.timedelta(); Duration of one approval
415
checker: subprocess.Popen(); a running checker process used
416
to see if the client lives.
417
'None' if no process is running.
418
checker_callback_tag: a gobject event source tag, or None
419
checker_command: string; External command which is run to check
420
if client lives. %() expansions are done at
174
name: string; from the config file, used in log messages
175
fingerprint: string (40 or 32 hexadecimal digits); used to
176
uniquely identify the client
177
secret: bytestring; sent verbatim (over TLS) to client
178
fqdn: string (FQDN); available for use by the checker command
179
created: datetime.datetime(); object creation, not client host
180
last_checked_ok: datetime.datetime() or None if not yet checked OK
181
timeout: datetime.timedelta(); How long from last_checked_ok
182
until this client is invalid
183
interval: datetime.timedelta(); How often to start a new checker
184
stop_hook: If set, called by stop() as stop_hook(self)
185
checker: subprocess.Popen(); a running checker process used
186
to see if the client lives.
187
'None' if no process is running.
188
checker_initiator_tag: a gobject event source tag, or None
189
stop_initiator_tag: - '' -
190
checker_callback_tag: - '' -
191
checker_command: string; External command which is run to check if
192
client lives. %() expansions are done at
421
193
runtime with vars(self) as dict, so that for
422
194
instance %(name)s can be used in the command.
423
checker_initiator_tag: a gobject event source tag, or None
424
created: datetime.datetime(); (UTC) object creation
425
client_structure: Object describing what attributes a client has
426
and is used for storing the client at exit
427
current_checker_command: string; current running checker_command
428
disable_initiator_tag: a gobject event source tag, or None
430
fingerprint: string (40 or 32 hexadecimal digits); used to
431
uniquely identify the client
432
host: string; available for use by the checker command
433
interval: datetime.timedelta(); How often to start a new checker
434
last_approval_request: datetime.datetime(); (UTC) or None
435
last_checked_ok: datetime.datetime(); (UTC) or None
436
last_checker_status: integer between 0 and 255 reflecting exit
437
status of last checker. -1 reflects crashed
438
checker, -2 means no checker completed yet.
439
last_enabled: datetime.datetime(); (UTC) or None
440
name: string; from the config file, used in log messages and
442
secret: bytestring; sent verbatim (over TLS) to client
443
timeout: datetime.timedelta(); How long from last_checked_ok
444
until this client is disabled
445
extended_timeout: extra long timeout when secret has been sent
446
runtime_expansions: Allowed attributes for runtime expansion.
447
expires: datetime.datetime(); time (UTC) when a client will be
449
server_settings: The server_settings dict from main()
196
_timeout: Real variable for 'timeout'
197
_interval: Real variable for 'interval'
198
_timeout_milliseconds: Used when calling gobject.timeout_add()
199
_interval_milliseconds: - '' -
452
runtime_expansions = ("approval_delay", "approval_duration",
453
"created", "enabled", "expires",
454
"fingerprint", "host", "interval",
455
"last_approval_request", "last_checked_ok",
456
"last_enabled", "name", "timeout")
457
client_defaults = { "timeout": "PT5M",
458
"extended_timeout": "PT15M",
460
"checker": "fping -q -- %%(host)s",
462
"approval_delay": "PT0S",
463
"approval_duration": "PT1S",
464
"approved_by_default": "True",
468
def timeout_milliseconds(self):
469
"Return the 'timeout' attribute in milliseconds"
470
return timedelta_to_milliseconds(self.timeout)
472
def extended_timeout_milliseconds(self):
473
"Return the 'extended_timeout' attribute in milliseconds"
474
return timedelta_to_milliseconds(self.extended_timeout)
476
def interval_milliseconds(self):
477
"Return the 'interval' attribute in milliseconds"
478
return timedelta_to_milliseconds(self.interval)
480
def approval_delay_milliseconds(self):
481
return timedelta_to_milliseconds(self.approval_delay)
484
def config_parser(config):
485
"""Construct a new dict of client settings of this form:
486
{ client_name: {setting_name: value, ...}, ...}
487
with exceptions for any special settings as defined above.
488
NOTE: Must be a pure function. Must return the same result
489
value given the same arguments.
492
for client_name in config.sections():
493
section = dict(config.items(client_name))
494
client = settings[client_name] = {}
496
client["host"] = section["host"]
497
# Reformat values from string types to Python types
498
client["approved_by_default"] = config.getboolean(
499
client_name, "approved_by_default")
500
client["enabled"] = config.getboolean(client_name,
503
client["fingerprint"] = (section["fingerprint"].upper()
505
if "secret" in section:
506
client["secret"] = section["secret"].decode("base64")
507
elif "secfile" in section:
508
with open(os.path.expanduser(os.path.expandvars
509
(section["secfile"])),
511
client["secret"] = secfile.read()
513
raise TypeError("No secret or secfile for section {0}"
515
client["timeout"] = string_to_delta(section["timeout"])
516
client["extended_timeout"] = string_to_delta(
517
section["extended_timeout"])
518
client["interval"] = string_to_delta(section["interval"])
519
client["approval_delay"] = string_to_delta(
520
section["approval_delay"])
521
client["approval_duration"] = string_to_delta(
522
section["approval_duration"])
523
client["checker_command"] = section["checker"]
524
client["last_approval_request"] = None
525
client["last_checked_ok"] = None
526
client["last_checker_status"] = -2
530
def __init__(self, settings, name = None, server_settings=None):
201
def _set_timeout(self, timeout):
202
"Setter function for 'timeout' attribute"
203
self._timeout = timeout
204
self._timeout_milliseconds = ((self.timeout.days
205
* 24 * 60 * 60 * 1000)
206
+ (self.timeout.seconds * 1000)
207
+ (self.timeout.microseconds
209
timeout = property(lambda self: self._timeout,
212
def _set_interval(self, interval):
213
"Setter function for 'interval' attribute"
214
self._interval = interval
215
self._interval_milliseconds = ((self.interval.days
216
* 24 * 60 * 60 * 1000)
217
+ (self.interval.seconds
219
+ (self.interval.microseconds
221
interval = property(lambda self: self._interval,
224
def __init__(self, name=None, stop_hook=None, fingerprint=None,
225
secret=None, secfile=None, fqdn=None, timeout=None,
226
interval=-1, checker=None):
227
"""Note: the 'checker' argument sets the 'checker_command'
228
attribute and not the 'checker' attribute.."""
532
if server_settings is None:
534
self.server_settings = server_settings
535
# adding all client settings
536
for setting, value in settings.iteritems():
537
setattr(self, setting, value)
540
if not hasattr(self, "last_enabled"):
541
self.last_enabled = datetime.datetime.utcnow()
542
if not hasattr(self, "expires"):
543
self.expires = (datetime.datetime.utcnow()
230
logger.debug(u"Creating client %r", self.name)
231
# Uppercase and remove spaces from fingerprint
232
# for later comparison purposes with return value of
233
# the fingerprint() function
234
self.fingerprint = fingerprint.upper().replace(u" ", u"")
235
logger.debug(u" Fingerprint: %s", self.fingerprint)
237
self.secret = secret.decode(u"base64")
240
self.secret = sf.read()
546
self.last_enabled = None
549
logger.debug("Creating client %r", self.name)
550
# Uppercase and remove spaces from fingerprint for later
551
# comparison purposes with return value from the fingerprint()
553
logger.debug(" Fingerprint: %s", self.fingerprint)
554
self.created = settings.get("created",
555
datetime.datetime.utcnow())
557
# attributes specific for this server instance
243
raise TypeError(u"No secret or secfile for client %s"
246
self.created = datetime.datetime.now()
247
self.last_checked_ok = None
248
self.timeout = string_to_delta(timeout)
249
self.interval = string_to_delta(interval)
250
self.stop_hook = stop_hook
558
251
self.checker = None
559
252
self.checker_initiator_tag = None
560
self.disable_initiator_tag = None
253
self.stop_initiator_tag = None
561
254
self.checker_callback_tag = None
562
self.current_checker_command = None
564
self.approvals_pending = 0
565
self.changedstate = (multiprocessing_manager
566
.Condition(multiprocessing_manager
568
self.client_structure = [attr for attr in
569
self.__dict__.iterkeys()
570
if not attr.startswith("_")]
571
self.client_structure.append("client_structure")
573
for name, t in inspect.getmembers(type(self),
577
if not name.startswith("_"):
578
self.client_structure.append(name)
580
# Send notice to process children that client state has changed
581
def send_changedstate(self):
582
with self.changedstate:
583
self.changedstate.notify_all()
255
self.check_command = checker
586
257
"""Start this client's checker and timeout hooks"""
587
if getattr(self, "enabled", False):
590
self.expires = datetime.datetime.utcnow() + self.timeout
592
self.last_enabled = datetime.datetime.utcnow()
594
self.send_changedstate()
596
def disable(self, quiet=True):
597
"""Disable this client."""
598
if not getattr(self, "enabled", False):
601
logger.info("Disabling client %s", self.name)
602
if getattr(self, "disable_initiator_tag", None) is not None:
603
gobject.source_remove(self.disable_initiator_tag)
604
self.disable_initiator_tag = None
606
if getattr(self, "checker_initiator_tag", None) is not None:
607
gobject.source_remove(self.checker_initiator_tag)
608
self.checker_initiator_tag = None
612
self.send_changedstate()
613
# Do not run this again if called by a gobject.timeout_add
619
def init_checker(self):
620
258
# Schedule a new checker to be started an 'interval' from now,
621
259
# and every interval from then on.
622
if self.checker_initiator_tag is not None:
623
gobject.source_remove(self.checker_initiator_tag)
624
self.checker_initiator_tag = (gobject.timeout_add
625
(self.interval_milliseconds(),
627
# Schedule a disable() when 'timeout' has passed
628
if self.disable_initiator_tag is not None:
629
gobject.source_remove(self.disable_initiator_tag)
630
self.disable_initiator_tag = (gobject.timeout_add
631
(self.timeout_milliseconds(),
260
self.checker_initiator_tag = gobject.timeout_add\
261
(self._interval_milliseconds,
633
263
# Also start a new checker *right now*.
634
264
self.start_checker()
636
def checker_callback(self, pid, condition, command):
265
# Schedule a stop() when 'timeout' has passed
266
self.stop_initiator_tag = gobject.timeout_add\
267
(self._timeout_milliseconds,
271
The possibility that a client might be restarted is left open,
272
but not currently used."""
273
# If this client doesn't have a secret, it is already stopped.
275
logger.debug(u"Stopping client %s", self.name)
279
if getattr(self, "stop_initiator_tag", False):
280
gobject.source_remove(self.stop_initiator_tag)
281
self.stop_initiator_tag = None
282
if getattr(self, "checker_initiator_tag", False):
283
gobject.source_remove(self.checker_initiator_tag)
284
self.checker_initiator_tag = None
288
# Do not run this again if called by a gobject.timeout_add
291
self.stop_hook = None
293
def checker_callback(self, pid, condition):
637
294
"""The checker has completed, so take appropriate actions."""
295
now = datetime.datetime.now()
638
296
self.checker_callback_tag = None
639
297
self.checker = None
640
if os.WIFEXITED(condition):
641
self.last_checker_status = os.WEXITSTATUS(condition)
642
if self.last_checker_status == 0:
643
logger.info("Checker for %(name)s succeeded",
647
logger.info("Checker for %(name)s failed",
650
self.last_checker_status = -1
651
logger.warning("Checker for %(name)s crashed?",
298
if os.WIFEXITED(condition) \
299
and (os.WEXITSTATUS(condition) == 0):
300
logger.debug(u"Checker for %(name)s succeeded",
302
self.last_checked_ok = now
303
gobject.source_remove(self.stop_initiator_tag)
304
self.stop_initiator_tag = gobject.timeout_add\
305
(self._timeout_milliseconds,
307
elif not os.WIFEXITED(condition):
308
logger.warning(u"Checker for %(name)s crashed?",
654
def checked_ok(self):
655
"""Assert that the client has been seen, alive and well."""
656
self.last_checked_ok = datetime.datetime.utcnow()
657
self.last_checker_status = 0
660
def bump_timeout(self, timeout=None):
661
"""Bump up the timeout for this client."""
663
timeout = self.timeout
664
if self.disable_initiator_tag is not None:
665
gobject.source_remove(self.disable_initiator_tag)
666
self.disable_initiator_tag = None
667
if getattr(self, "enabled", False):
668
self.disable_initiator_tag = (gobject.timeout_add
669
(timedelta_to_milliseconds
670
(timeout), self.disable))
671
self.expires = datetime.datetime.utcnow() + timeout
673
def need_approval(self):
674
self.last_approval_request = datetime.datetime.utcnow()
311
logger.debug(u"Checker for %(name)s failed",
676
313
def start_checker(self):
677
314
"""Start a new checker subprocess if one is not running.
679
315
If a checker already exists, leave it running and do
681
317
# The reason for not killing a running checker is that if we
682
# did that, and if a checker (for some reason) started running
683
# slowly and taking more than 'interval' time, then the client
684
# would inevitably timeout, since no checker would get a
685
# chance to run to completion. If we instead leave running
318
# did that, then if a checker (for some reason) started
319
# running slowly and taking more than 'interval' time, the
320
# client would inevitably timeout, since no checker would get
321
# a chance to run to completion. If we instead leave running
686
322
# checkers alone, the checker would have to take more time
687
# than 'timeout' for the client to be disabled, which is as it
690
# If a checker exists, make sure it is not a zombie
692
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
693
except (AttributeError, OSError) as error:
694
if (isinstance(error, OSError)
695
and error.errno != errno.ECHILD):
699
logger.warning("Checker was a zombie")
700
gobject.source_remove(self.checker_callback_tag)
701
self.checker_callback(pid, status,
702
self.current_checker_command)
703
# Start a new checker if needed
323
# than 'timeout' for the client to be declared invalid, which
324
# is as it should be.
704
325
if self.checker is None:
705
# Escape attributes for the shell
706
escaped_attrs = dict(
707
(attr, re.escape(unicode(getattr(self, attr))))
709
self.runtime_expansions)
711
command = self.checker_command % escaped_attrs
712
except TypeError as error:
713
logger.error('Could not format string "%s"',
714
self.checker_command, exc_info=error)
715
return True # Try again later
716
self.current_checker_command = command
718
logger.info("Starting checker %r for %s",
720
# We don't need to redirect stdout and stderr, since
721
# in normal mode, that is already done by daemon(),
722
# and in debug mode we don't want to. (Stdin is
723
# always replaced by /dev/null.)
724
# The exception is when not debugging but nevertheless
725
# running in the foreground; use the previously
728
if (not self.server_settings["debug"]
729
and self.server_settings["foreground"]):
730
popen_args.update({"stdout": wnull,
327
# In case check_command has exactly one % operator
328
command = self.check_command % self.fqdn
330
# Escape attributes for the shell
331
escaped_attrs = dict((key, re.escape(str(val)))
333
vars(self).iteritems())
335
command = self.check_command % escaped_attrs
336
except TypeError, error:
337
logger.error(u'Could not format string "%s":'
338
u' %s', self.check_command, error)
339
return True # Try again later
341
logger.debug(u"Starting checker %r for %s",
732
343
self.checker = subprocess.Popen(command,
736
except OSError as error:
737
logger.error("Failed to start subprocess",
740
self.checker_callback_tag = (gobject.child_watch_add
742
self.checker_callback,
744
# The checker may have completed before the gobject
745
# watch was added. Check for this.
747
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
748
except OSError as error:
749
if error.errno == errno.ECHILD:
750
# This should never happen
751
logger.error("Child process vanished",
756
gobject.source_remove(self.checker_callback_tag)
757
self.checker_callback(pid, status, command)
346
self.checker_callback_tag = gobject.child_watch_add\
348
self.checker_callback)
349
except subprocess.OSError, error:
350
logger.error(u"Failed to start subprocess: %s",
758
352
# Re-run this periodically if run by gobject.timeout_add
761
354
def stop_checker(self):
762
355
"""Force the checker process, if any, to stop."""
763
356
if self.checker_callback_tag:
768
361
logger.debug("Stopping checker for %(name)s", vars(self))
770
self.checker.terminate()
363
os.kill(self.checker.pid, signal.SIGTERM)
772
365
#if self.checker.poll() is None:
773
# self.checker.kill()
774
except OSError as error:
366
# os.kill(self.checker.pid, signal.SIGKILL)
367
except OSError, error:
775
368
if error.errno != errno.ESRCH: # No such process
777
370
self.checker = None
780
def dbus_service_property(dbus_interface, signature="v",
781
access="readwrite", byte_arrays=False):
782
"""Decorators for marking methods of a DBusObjectWithProperties to
783
become properties on the D-Bus.
785
The decorated method will be called with no arguments by "Get"
786
and with one argument by "Set".
788
The parameters, where they are supported, are the same as
789
dbus.service.method, except there is only "signature", since the
790
type from Get() and the type sent to Set() is the same.
792
# Encoding deeply encoded byte arrays is not supported yet by the
793
# "Set" method, so we fail early here:
794
if byte_arrays and signature != "ay":
795
raise ValueError("Byte arrays not supported for non-'ay'"
796
" signature {0!r}".format(signature))
798
func._dbus_is_property = True
799
func._dbus_interface = dbus_interface
800
func._dbus_signature = signature
801
func._dbus_access = access
802
func._dbus_name = func.__name__
803
if func._dbus_name.endswith("_dbus_property"):
804
func._dbus_name = func._dbus_name[:-14]
805
func._dbus_get_args_options = {'byte_arrays': byte_arrays }
810
def dbus_interface_annotations(dbus_interface):
811
"""Decorator for marking functions returning interface annotations
815
@dbus_interface_annotations("org.example.Interface")
816
def _foo(self): # Function name does not matter
817
return {"org.freedesktop.DBus.Deprecated": "true",
818
"org.freedesktop.DBus.Property.EmitsChangedSignal":
822
func._dbus_is_interface = True
823
func._dbus_interface = dbus_interface
824
func._dbus_name = dbus_interface
829
def dbus_annotations(annotations):
830
"""Decorator to annotate D-Bus methods, signals or properties
833
@dbus_service_property("org.example.Interface", signature="b",
835
@dbus_annotations({{"org.freedesktop.DBus.Deprecated": "true",
836
"org.freedesktop.DBus.Property."
837
"EmitsChangedSignal": "false"})
838
def Property_dbus_property(self):
839
return dbus.Boolean(False)
842
func._dbus_annotations = annotations
847
class DBusPropertyException(dbus.exceptions.DBusException):
848
"""A base class for D-Bus property-related exceptions
850
def __unicode__(self):
851
return unicode(str(self))
854
class DBusPropertyAccessException(DBusPropertyException):
855
"""A property's access permissions disallows an operation.
860
class DBusPropertyNotFound(DBusPropertyException):
861
"""An attempt was made to access a non-existing property.
866
class DBusObjectWithProperties(dbus.service.Object):
867
"""A D-Bus object with properties.
869
Classes inheriting from this can use the dbus_service_property
870
decorator to expose methods as D-Bus properties. It exposes the
871
standard Get(), Set(), and GetAll() methods on the D-Bus.
875
def _is_dbus_thing(thing):
876
"""Returns a function testing if an attribute is a D-Bus thing
878
If called like _is_dbus_thing("method") it returns a function
879
suitable for use as predicate to inspect.getmembers().
881
return lambda obj: getattr(obj, "_dbus_is_{0}".format(thing),
884
def _get_all_dbus_things(self, thing):
885
"""Returns a generator of (name, attribute) pairs
887
return ((getattr(athing.__get__(self), "_dbus_name",
889
athing.__get__(self))
890
for cls in self.__class__.__mro__
892
inspect.getmembers(cls,
893
self._is_dbus_thing(thing)))
895
def _get_dbus_property(self, interface_name, property_name):
896
"""Returns a bound method if one exists which is a D-Bus
897
property with the specified name and interface.
899
for cls in self.__class__.__mro__:
900
for name, value in (inspect.getmembers
902
self._is_dbus_thing("property"))):
903
if (value._dbus_name == property_name
904
and value._dbus_interface == interface_name):
905
return value.__get__(self)
908
raise DBusPropertyNotFound(self.dbus_object_path + ":"
909
+ interface_name + "."
912
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
914
def Get(self, interface_name, property_name):
915
"""Standard D-Bus property Get() method, see D-Bus standard.
917
prop = self._get_dbus_property(interface_name, property_name)
918
if prop._dbus_access == "write":
919
raise DBusPropertyAccessException(property_name)
921
if not hasattr(value, "variant_level"):
923
return type(value)(value, variant_level=value.variant_level+1)
925
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
926
def Set(self, interface_name, property_name, value):
927
"""Standard D-Bus property Set() method, see D-Bus standard.
929
prop = self._get_dbus_property(interface_name, property_name)
930
if prop._dbus_access == "read":
931
raise DBusPropertyAccessException(property_name)
932
if prop._dbus_get_args_options["byte_arrays"]:
933
# The byte_arrays option is not supported yet on
934
# signatures other than "ay".
935
if prop._dbus_signature != "ay":
937
value = dbus.ByteArray(b''.join(chr(byte)
941
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
942
out_signature="a{sv}")
943
def GetAll(self, interface_name):
944
"""Standard D-Bus property GetAll() method, see D-Bus
947
Note: Will not include properties with access="write".
950
for name, prop in self._get_all_dbus_things("property"):
952
and interface_name != prop._dbus_interface):
953
# Interface non-empty but did not match
955
# Ignore write-only properties
956
if prop._dbus_access == "write":
959
if not hasattr(value, "variant_level"):
960
properties[name] = value
962
properties[name] = type(value)(value, variant_level=
963
value.variant_level+1)
964
return dbus.Dictionary(properties, signature="sv")
966
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
968
path_keyword='object_path',
969
connection_keyword='connection')
970
def Introspect(self, object_path, connection):
971
"""Overloading of standard D-Bus method.
973
Inserts property tags and interface annotation tags.
975
xmlstring = dbus.service.Object.Introspect(self, object_path,
978
document = xml.dom.minidom.parseString(xmlstring)
979
def make_tag(document, name, prop):
980
e = document.createElement("property")
981
e.setAttribute("name", name)
982
e.setAttribute("type", prop._dbus_signature)
983
e.setAttribute("access", prop._dbus_access)
985
for if_tag in document.getElementsByTagName("interface"):
987
for tag in (make_tag(document, name, prop)
989
in self._get_all_dbus_things("property")
990
if prop._dbus_interface
991
== if_tag.getAttribute("name")):
992
if_tag.appendChild(tag)
993
# Add annotation tags
994
for typ in ("method", "signal", "property"):
995
for tag in if_tag.getElementsByTagName(typ):
997
for name, prop in (self.
998
_get_all_dbus_things(typ)):
999
if (name == tag.getAttribute("name")
1000
and prop._dbus_interface
1001
== if_tag.getAttribute("name")):
1002
annots.update(getattr
1004
"_dbus_annotations",
1006
for name, value in annots.iteritems():
1007
ann_tag = document.createElement(
1009
ann_tag.setAttribute("name", name)
1010
ann_tag.setAttribute("value", value)
1011
tag.appendChild(ann_tag)
1012
# Add interface annotation tags
1013
for annotation, value in dict(
1014
itertools.chain.from_iterable(
1015
annotations().iteritems()
1016
for name, annotations in
1017
self._get_all_dbus_things("interface")
1018
if name == if_tag.getAttribute("name")
1020
ann_tag = document.createElement("annotation")
1021
ann_tag.setAttribute("name", annotation)
1022
ann_tag.setAttribute("value", value)
1023
if_tag.appendChild(ann_tag)
1024
# Add the names to the return values for the
1025
# "org.freedesktop.DBus.Properties" methods
1026
if (if_tag.getAttribute("name")
1027
== "org.freedesktop.DBus.Properties"):
1028
for cn in if_tag.getElementsByTagName("method"):
1029
if cn.getAttribute("name") == "Get":
1030
for arg in cn.getElementsByTagName("arg"):
1031
if (arg.getAttribute("direction")
1033
arg.setAttribute("name", "value")
1034
elif cn.getAttribute("name") == "GetAll":
1035
for arg in cn.getElementsByTagName("arg"):
1036
if (arg.getAttribute("direction")
1038
arg.setAttribute("name", "props")
1039
xmlstring = document.toxml("utf-8")
1041
except (AttributeError, xml.dom.DOMException,
1042
xml.parsers.expat.ExpatError) as error:
1043
logger.error("Failed to override Introspection method",
1048
def datetime_to_dbus(dt, variant_level=0):
1049
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1051
return dbus.String("", variant_level = variant_level)
1052
return dbus.String(dt.isoformat(),
1053
variant_level=variant_level)
1056
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1057
"""A class decorator; applied to a subclass of
1058
dbus.service.Object, it will add alternate D-Bus attributes with
1059
interface names according to the "alt_interface_names" mapping.
1062
@alternate_dbus_interfaces({"org.example.Interface":
1063
"net.example.AlternateInterface"})
1064
class SampleDBusObject(dbus.service.Object):
1065
@dbus.service.method("org.example.Interface")
1066
def SampleDBusMethod():
1069
The above "SampleDBusMethod" on "SampleDBusObject" will be
1070
reachable via two interfaces: "org.example.Interface" and
1071
"net.example.AlternateInterface", the latter of which will have
1072
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1073
"true", unless "deprecate" is passed with a False value.
1075
This works for methods and signals, and also for D-Bus properties
1076
(from DBusObjectWithProperties) and interfaces (from the
1077
dbus_interface_annotations decorator).
1080
for orig_interface_name, alt_interface_name in (
1081
alt_interface_names.iteritems()):
1083
interface_names = set()
1084
# Go though all attributes of the class
1085
for attrname, attribute in inspect.getmembers(cls):
1086
# Ignore non-D-Bus attributes, and D-Bus attributes
1087
# with the wrong interface name
1088
if (not hasattr(attribute, "_dbus_interface")
1089
or not attribute._dbus_interface
1090
.startswith(orig_interface_name)):
1092
# Create an alternate D-Bus interface name based on
1094
alt_interface = (attribute._dbus_interface
1095
.replace(orig_interface_name,
1096
alt_interface_name))
1097
interface_names.add(alt_interface)
1098
# Is this a D-Bus signal?
1099
if getattr(attribute, "_dbus_is_signal", False):
1100
# Extract the original non-method undecorated
1101
# function by black magic
1102
nonmethod_func = (dict(
1103
zip(attribute.func_code.co_freevars,
1104
attribute.__closure__))["func"]
1106
# Create a new, but exactly alike, function
1107
# object, and decorate it to be a new D-Bus signal
1108
# with the alternate D-Bus interface name
1109
new_function = (dbus.service.signal
1111
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 = (
1121
dict(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"""
1132
def call_both(*args, **kwargs):
1133
"""This function will emit two D-Bus
1134
signals by calling func1 and func2"""
1135
func1(*args, **kwargs)
1136
func2(*args, **kwargs)
1138
# Create the "call_both" function and add it to
1140
attr[attrname] = fixscope(attribute, new_function)
1141
# Is this a D-Bus method?
1142
elif getattr(attribute, "_dbus_is_method", False):
1143
# Create a new, but exactly alike, function
1144
# object. Decorate it to be a new D-Bus method
1145
# with the alternate D-Bus interface name. Add it
1147
attr[attrname] = (dbus.service.method
1149
attribute._dbus_in_signature,
1150
attribute._dbus_out_signature)
1152
(attribute.func_code,
1153
attribute.func_globals,
1154
attribute.func_name,
1155
attribute.func_defaults,
1156
attribute.func_closure)))
1157
# Copy annotations, if any
1159
attr[attrname]._dbus_annotations = (
1160
dict(attribute._dbus_annotations))
1161
except AttributeError:
1163
# Is this a D-Bus property?
1164
elif getattr(attribute, "_dbus_is_property", False):
1165
# Create a new, but exactly alike, function
1166
# object, and decorate it to be a new D-Bus
1167
# property with the alternate D-Bus interface
1168
# name. Add it to the class.
1169
attr[attrname] = (dbus_service_property
1171
attribute._dbus_signature,
1172
attribute._dbus_access,
1174
._dbus_get_args_options
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 = (
1185
dict(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
1194
attr[attrname] = (dbus_interface_annotations
1197
(attribute.func_code,
1198
attribute.func_globals,
1199
attribute.func_name,
1200
attribute.func_defaults,
1201
attribute.func_closure)))
1203
# Deprecate all alternate interfaces
1204
iname="_AlternateDBusNames_interface_annotation{0}"
1205
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"{0}Alternate".format(cls.__name__),
1225
@alternate_dbus_interfaces({"se.recompile.Mandos":
1226
"se.bsnet.fukt.Mandos"})
1227
class ClientDBus(Client, DBusObjectWithProperties):
1228
"""A Client class using D-Bus
1231
dbus_object_path: dbus.ObjectPath
1232
bus: dbus.SystemBus()
1235
runtime_expansions = (Client.runtime_expansions
1236
+ ("dbus_object_path",))
1238
# dbus.service.Object doesn't use super(), so we can't either.
1240
def __init__(self, bus = None, *args, **kwargs):
1242
Client.__init__(self, *args, **kwargs)
1243
# Only now, when this client is initialized, can it show up on
1245
client_object_name = unicode(self.name).translate(
1246
{ord("."): ord("_"),
1247
ord("-"): ord("_")})
1248
self.dbus_object_path = (dbus.ObjectPath
1249
("/clients/" + client_object_name))
1250
DBusObjectWithProperties.__init__(self, self.bus,
1251
self.dbus_object_path)
1253
def notifychangeproperty(transform_func,
1254
dbus_name, type_func=lambda x: x,
1256
""" Modify a variable so that it's a property which announces
1257
its changes to DBus.
1259
transform_fun: Function that takes a value and a variant_level
1260
and transforms it to a D-Bus type.
1261
dbus_name: D-Bus name of the variable
1262
type_func: Function that transform the value before sending it
1263
to the D-Bus. Default: no transform
1264
variant_level: D-Bus variant level. Default: 1
1266
attrname = "_{0}".format(dbus_name)
1267
def setter(self, value):
1268
if hasattr(self, "dbus_object_path"):
1269
if (not hasattr(self, attrname) or
1270
type_func(getattr(self, attrname, None))
1271
!= type_func(value)):
1272
dbus_value = transform_func(type_func(value),
1275
self.PropertyChanged(dbus.String(dbus_name),
1277
setattr(self, attrname, value)
1279
return property(lambda self: getattr(self, attrname), setter)
1281
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1282
approvals_pending = notifychangeproperty(dbus.Boolean,
1285
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1286
last_enabled = notifychangeproperty(datetime_to_dbus,
1288
checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1289
type_func = lambda checker:
1290
checker is not None)
1291
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1293
last_checker_status = notifychangeproperty(dbus.Int16,
1294
"LastCheckerStatus")
1295
last_approval_request = notifychangeproperty(
1296
datetime_to_dbus, "LastApprovalRequest")
1297
approved_by_default = notifychangeproperty(dbus.Boolean,
1298
"ApprovedByDefault")
1299
approval_delay = notifychangeproperty(dbus.UInt64,
1302
timedelta_to_milliseconds)
1303
approval_duration = notifychangeproperty(
1304
dbus.UInt64, "ApprovalDuration",
1305
type_func = timedelta_to_milliseconds)
1306
host = notifychangeproperty(dbus.String, "Host")
1307
timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1309
timedelta_to_milliseconds)
1310
extended_timeout = notifychangeproperty(
1311
dbus.UInt64, "ExtendedTimeout",
1312
type_func = timedelta_to_milliseconds)
1313
interval = notifychangeproperty(dbus.UInt64,
1316
timedelta_to_milliseconds)
1317
checker_command = notifychangeproperty(dbus.String, "Checker")
1319
del notifychangeproperty
1321
def __del__(self, *args, **kwargs):
1323
self.remove_from_connection()
1326
if hasattr(DBusObjectWithProperties, "__del__"):
1327
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1328
Client.__del__(self, *args, **kwargs)
1330
def checker_callback(self, pid, condition, command,
1332
self.checker_callback_tag = None
1334
if os.WIFEXITED(condition):
1335
exitstatus = os.WEXITSTATUS(condition)
1337
self.CheckerCompleted(dbus.Int16(exitstatus),
1338
dbus.Int64(condition),
1339
dbus.String(command))
1342
self.CheckerCompleted(dbus.Int16(-1),
1343
dbus.Int64(condition),
1344
dbus.String(command))
1346
return Client.checker_callback(self, pid, condition, command,
1349
def start_checker(self, *args, **kwargs):
1350
old_checker = self.checker
1351
if self.checker is not None:
1352
old_checker_pid = self.checker.pid
1354
old_checker_pid = None
1355
r = Client.start_checker(self, *args, **kwargs)
1356
# Only if new checker process was started
1357
if (self.checker is not None
1358
and old_checker_pid != self.checker.pid):
1360
self.CheckerStarted(self.current_checker_command)
1363
def _reset_approved(self):
1364
self.approved = None
1367
def approve(self, value=True):
1368
self.approved = value
1369
gobject.timeout_add(timedelta_to_milliseconds
1370
(self.approval_duration),
1371
self._reset_approved)
1372
self.send_changedstate()
1374
## D-Bus methods, signals & properties
1375
_interface = "se.recompile.Mandos.Client"
1379
@dbus_interface_annotations(_interface)
1381
return { "org.freedesktop.DBus.Property.EmitsChangedSignal":
1386
# CheckerCompleted - signal
1387
@dbus.service.signal(_interface, signature="nxs")
1388
def CheckerCompleted(self, exitcode, waitstatus, command):
1392
# CheckerStarted - signal
1393
@dbus.service.signal(_interface, signature="s")
1394
def CheckerStarted(self, command):
1398
# PropertyChanged - signal
1399
@dbus.service.signal(_interface, signature="sv")
1400
def PropertyChanged(self, property, value):
1404
# GotSecret - signal
1405
@dbus.service.signal(_interface)
1406
def GotSecret(self):
1408
Is sent after a successful transfer of secret from the Mandos
1409
server to mandos-client
1414
@dbus.service.signal(_interface, signature="s")
1415
def Rejected(self, reason):
1419
# NeedApproval - signal
1420
@dbus.service.signal(_interface, signature="tb")
1421
def NeedApproval(self, timeout, default):
1423
return self.need_approval()
1428
@dbus.service.method(_interface, in_signature="b")
1429
def Approve(self, value):
1432
# CheckedOK - method
1433
@dbus.service.method(_interface)
1434
def CheckedOK(self):
1438
@dbus.service.method(_interface)
1443
# StartChecker - method
1444
@dbus.service.method(_interface)
1445
def StartChecker(self):
1447
self.start_checker()
1450
@dbus.service.method(_interface)
1455
# StopChecker - method
1456
@dbus.service.method(_interface)
1457
def StopChecker(self):
1462
# ApprovalPending - property
1463
@dbus_service_property(_interface, signature="b", access="read")
1464
def ApprovalPending_dbus_property(self):
1465
return dbus.Boolean(bool(self.approvals_pending))
1467
# ApprovedByDefault - property
1468
@dbus_service_property(_interface, signature="b",
1470
def ApprovedByDefault_dbus_property(self, value=None):
1471
if value is None: # get
1472
return dbus.Boolean(self.approved_by_default)
1473
self.approved_by_default = bool(value)
1475
# ApprovalDelay - property
1476
@dbus_service_property(_interface, signature="t",
1478
def ApprovalDelay_dbus_property(self, value=None):
1479
if value is None: # get
1480
return dbus.UInt64(self.approval_delay_milliseconds())
1481
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1483
# ApprovalDuration - property
1484
@dbus_service_property(_interface, signature="t",
1486
def ApprovalDuration_dbus_property(self, value=None):
1487
if value is None: # get
1488
return dbus.UInt64(timedelta_to_milliseconds(
1489
self.approval_duration))
1490
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1493
@dbus_service_property(_interface, signature="s", access="read")
1494
def Name_dbus_property(self):
1495
return dbus.String(self.name)
1497
# Fingerprint - property
1498
@dbus_service_property(_interface, signature="s", access="read")
1499
def Fingerprint_dbus_property(self):
1500
return dbus.String(self.fingerprint)
1503
@dbus_service_property(_interface, signature="s",
1505
def Host_dbus_property(self, value=None):
1506
if value is None: # get
1507
return dbus.String(self.host)
1508
self.host = unicode(value)
1510
# Created - property
1511
@dbus_service_property(_interface, signature="s", access="read")
1512
def Created_dbus_property(self):
1513
return datetime_to_dbus(self.created)
1515
# LastEnabled - property
1516
@dbus_service_property(_interface, signature="s", access="read")
1517
def LastEnabled_dbus_property(self):
1518
return datetime_to_dbus(self.last_enabled)
1520
# Enabled - property
1521
@dbus_service_property(_interface, signature="b",
1523
def Enabled_dbus_property(self, value=None):
1524
if value is None: # get
1525
return dbus.Boolean(self.enabled)
1531
# LastCheckedOK - property
1532
@dbus_service_property(_interface, signature="s",
1534
def LastCheckedOK_dbus_property(self, value=None):
1535
if value is not None:
1538
return datetime_to_dbus(self.last_checked_ok)
1540
# LastCheckerStatus - property
1541
@dbus_service_property(_interface, signature="n",
1543
def LastCheckerStatus_dbus_property(self):
1544
return dbus.Int16(self.last_checker_status)
1546
# Expires - property
1547
@dbus_service_property(_interface, signature="s", access="read")
1548
def Expires_dbus_property(self):
1549
return datetime_to_dbus(self.expires)
1551
# LastApprovalRequest - property
1552
@dbus_service_property(_interface, signature="s", access="read")
1553
def LastApprovalRequest_dbus_property(self):
1554
return datetime_to_dbus(self.last_approval_request)
1556
# Timeout - property
1557
@dbus_service_property(_interface, signature="t",
1559
def Timeout_dbus_property(self, value=None):
1560
if value is None: # get
1561
return dbus.UInt64(self.timeout_milliseconds())
1562
old_timeout = self.timeout
1563
self.timeout = datetime.timedelta(0, 0, 0, value)
1564
# Reschedule disabling
1566
now = datetime.datetime.utcnow()
1567
self.expires += self.timeout - old_timeout
1568
if self.expires <= now:
1569
# The timeout has passed
1572
if (getattr(self, "disable_initiator_tag", None)
1575
gobject.source_remove(self.disable_initiator_tag)
1576
self.disable_initiator_tag = (
1577
gobject.timeout_add(
1578
timedelta_to_milliseconds(self.expires - now),
1581
# ExtendedTimeout - property
1582
@dbus_service_property(_interface, signature="t",
1584
def ExtendedTimeout_dbus_property(self, value=None):
1585
if value is None: # get
1586
return dbus.UInt64(self.extended_timeout_milliseconds())
1587
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1589
# Interval - property
1590
@dbus_service_property(_interface, signature="t",
1592
def Interval_dbus_property(self, value=None):
1593
if value is None: # get
1594
return dbus.UInt64(self.interval_milliseconds())
1595
self.interval = datetime.timedelta(0, 0, 0, value)
1596
if getattr(self, "checker_initiator_tag", None) is None:
1599
# Reschedule checker run
1600
gobject.source_remove(self.checker_initiator_tag)
1601
self.checker_initiator_tag = (gobject.timeout_add
1602
(value, self.start_checker))
1603
self.start_checker() # Start one now, too
1605
# Checker - property
1606
@dbus_service_property(_interface, signature="s",
1608
def Checker_dbus_property(self, value=None):
1609
if value is None: # get
1610
return dbus.String(self.checker_command)
1611
self.checker_command = unicode(value)
1613
# CheckerRunning - property
1614
@dbus_service_property(_interface, signature="b",
1616
def CheckerRunning_dbus_property(self, value=None):
1617
if value is None: # get
1618
return dbus.Boolean(self.checker is not None)
1620
self.start_checker()
1624
# ObjectPath - property
1625
@dbus_service_property(_interface, signature="o", access="read")
1626
def ObjectPath_dbus_property(self):
1627
return self.dbus_object_path # is already a dbus.ObjectPath
1630
@dbus_service_property(_interface, signature="ay",
1631
access="write", byte_arrays=True)
1632
def Secret_dbus_property(self, value):
1633
self.secret = str(value)
1638
class ProxyClient(object):
1639
def __init__(self, child_pipe, fpr, address):
1640
self._pipe = child_pipe
1641
self._pipe.send(('init', fpr, address))
1642
if not self._pipe.recv():
1645
def __getattribute__(self, name):
1647
return super(ProxyClient, self).__getattribute__(name)
1648
self._pipe.send(('getattr', name))
1649
data = self._pipe.recv()
1650
if data[0] == 'data':
1652
if data[0] == 'function':
1653
def func(*args, **kwargs):
1654
self._pipe.send(('funcall', name, args, kwargs))
1655
return self._pipe.recv()[1]
1658
def __setattr__(self, name, value):
1660
return super(ProxyClient, self).__setattr__(name, value)
1661
self._pipe.send(('setattr', name, value))
1664
class ClientHandler(socketserver.BaseRequestHandler, object):
1665
"""A class to handle client connections.
1667
Instantiated once for each connection to handle it.
371
def still_valid(self):
372
"""Has the timeout not yet passed for this client?"""
373
now = datetime.datetime.now()
374
if self.last_checked_ok is None:
375
return now < (self.created + self.timeout)
377
return now < (self.last_checked_ok + self.timeout)
380
def peer_certificate(session):
381
"Return the peer's OpenPGP certificate as a bytestring"
382
# If not an OpenPGP certificate...
383
if gnutls.library.functions.gnutls_certificate_type_get\
384
(session._c_object) \
385
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP:
386
# ...do the normal thing
387
return session.peer_certificate
388
list_size = ctypes.c_uint()
389
cert_list = gnutls.library.functions.gnutls_certificate_get_peers\
390
(session._c_object, ctypes.byref(list_size))
391
if list_size.value == 0:
394
return ctypes.string_at(cert.data, cert.size)
397
def fingerprint(openpgp):
398
"Convert an OpenPGP bytestring to a hexdigit fingerprint string"
399
# New empty GnuTLS certificate
400
crt = gnutls.library.types.gnutls_openpgp_crt_t()
401
gnutls.library.functions.gnutls_openpgp_crt_init\
403
# New GnuTLS "datum" with the OpenPGP public key
404
datum = gnutls.library.types.gnutls_datum_t\
405
(ctypes.cast(ctypes.c_char_p(openpgp),
406
ctypes.POINTER(ctypes.c_ubyte)),
407
ctypes.c_uint(len(openpgp)))
408
# Import the OpenPGP public key into the certificate
409
ret = gnutls.library.functions.gnutls_openpgp_crt_import\
412
gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
413
# New buffer for the fingerprint
414
buffer = ctypes.create_string_buffer(20)
415
buffer_length = ctypes.c_size_t()
416
# Get the fingerprint from the certificate into the buffer
417
gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint\
418
(crt, ctypes.byref(buffer), ctypes.byref(buffer_length))
419
# Deinit the certificate
420
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
421
# Convert the buffer to a Python bytestring
422
fpr = ctypes.string_at(buffer, buffer_length.value)
423
# Convert the bytestring to hexadecimal notation
424
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
428
class tcp_handler(SocketServer.BaseRequestHandler, object):
429
"""A TCP request handler class.
430
Instantiated by IPv6_TCPServer for each request to handle it.
1668
431
Note: This will run in its own forked process."""
1670
433
def handle(self):
1671
with contextlib.closing(self.server.child_pipe) as child_pipe:
1672
logger.info("TCP connection from: %s",
1673
unicode(self.client_address))
1674
logger.debug("Pipe FD: %d",
1675
self.server.child_pipe.fileno())
1677
session = (gnutls.connection
1678
.ClientSession(self.request,
1680
.X509Credentials()))
1682
# Note: gnutls.connection.X509Credentials is really a
1683
# generic GnuTLS certificate credentials object so long as
1684
# no X.509 keys are added to it. Therefore, we can use it
1685
# here despite using OpenPGP certificates.
1687
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1688
# "+AES-256-CBC", "+SHA1",
1689
# "+COMP-NULL", "+CTYPE-OPENPGP",
1691
# Use a fallback default, since this MUST be set.
1692
priority = self.server.gnutls_priority
1693
if priority is None:
1695
(gnutls.library.functions
1696
.gnutls_priority_set_direct(session._c_object,
1699
# Start communication using the Mandos protocol
1700
# Get protocol number
1701
line = self.request.makefile().readline()
1702
logger.debug("Protocol version: %r", line)
1704
if int(line.strip().split()[0]) > 1:
1706
except (ValueError, IndexError, RuntimeError) as error:
1707
logger.error("Unknown protocol version: %s", error)
1710
# Start GnuTLS connection
1713
except gnutls.errors.GNUTLSError as error:
1714
logger.warning("Handshake failed: %s", error)
1715
# Do not run session.bye() here: the session is not
1716
# established. Just abandon the request.
1718
logger.debug("Handshake succeeded")
1720
approval_required = False
1723
fpr = self.fingerprint(self.peer_certificate
1726
gnutls.errors.GNUTLSError) as error:
1727
logger.warning("Bad certificate: %s", error)
1729
logger.debug("Fingerprint: %s", fpr)
1732
client = ProxyClient(child_pipe, fpr,
1733
self.client_address)
1737
if client.approval_delay:
1738
delay = client.approval_delay
1739
client.approvals_pending += 1
1740
approval_required = True
1743
if not client.enabled:
1744
logger.info("Client %s is disabled",
1746
if self.server.use_dbus:
1748
client.Rejected("Disabled")
1751
if client.approved or not client.approval_delay:
1752
#We are approved or approval is disabled
1754
elif client.approved is None:
1755
logger.info("Client %s needs approval",
1757
if self.server.use_dbus:
1759
client.NeedApproval(
1760
client.approval_delay_milliseconds(),
1761
client.approved_by_default)
1763
logger.warning("Client %s was not approved",
1765
if self.server.use_dbus:
1767
client.Rejected("Denied")
1770
#wait until timeout or approved
1771
time = datetime.datetime.now()
1772
client.changedstate.acquire()
1773
client.changedstate.wait(
1774
float(timedelta_to_milliseconds(delay)
1776
client.changedstate.release()
1777
time2 = datetime.datetime.now()
1778
if (time2 - time) >= delay:
1779
if not client.approved_by_default:
1780
logger.warning("Client %s timed out while"
1781
" waiting for approval",
1783
if self.server.use_dbus:
1785
client.Rejected("Approval timed out")
1790
delay -= time2 - time
1793
while sent_size < len(client.secret):
1795
sent = session.send(client.secret[sent_size:])
1796
except gnutls.errors.GNUTLSError as error:
1797
logger.warning("gnutls send failed",
1800
logger.debug("Sent: %d, remaining: %d",
1801
sent, len(client.secret)
1802
- (sent_size + sent))
1805
logger.info("Sending secret to %s", client.name)
1806
# bump the timeout using extended_timeout
1807
client.bump_timeout(client.extended_timeout)
1808
if self.server.use_dbus:
1813
if approval_required:
1814
client.approvals_pending -= 1
1817
except gnutls.errors.GNUTLSError as error:
1818
logger.warning("GnuTLS bye failed",
1822
def peer_certificate(session):
1823
"Return the peer's OpenPGP certificate as a bytestring"
1824
# If not an OpenPGP certificate...
1825
if (gnutls.library.functions
1826
.gnutls_certificate_type_get(session._c_object)
1827
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1828
# ...do the normal thing
1829
return session.peer_certificate
1830
list_size = ctypes.c_uint(1)
1831
cert_list = (gnutls.library.functions
1832
.gnutls_certificate_get_peers
1833
(session._c_object, ctypes.byref(list_size)))
1834
if not bool(cert_list) and list_size.value != 0:
1835
raise gnutls.errors.GNUTLSError("error getting peer"
1837
if list_size.value == 0:
1840
return ctypes.string_at(cert.data, cert.size)
1843
def fingerprint(openpgp):
1844
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
1845
# New GnuTLS "datum" with the OpenPGP public key
1846
datum = (gnutls.library.types
1847
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1850
ctypes.c_uint(len(openpgp))))
1851
# New empty GnuTLS certificate
1852
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1853
(gnutls.library.functions
1854
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
1855
# Import the OpenPGP public key into the certificate
1856
(gnutls.library.functions
1857
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1858
gnutls.library.constants
1859
.GNUTLS_OPENPGP_FMT_RAW))
1860
# Verify the self signature in the key
1861
crtverify = ctypes.c_uint()
1862
(gnutls.library.functions
1863
.gnutls_openpgp_crt_verify_self(crt, 0,
1864
ctypes.byref(crtverify)))
1865
if crtverify.value != 0:
1866
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1867
raise (gnutls.errors.CertificateSecurityError
1869
# New buffer for the fingerprint
1870
buf = ctypes.create_string_buffer(20)
1871
buf_len = ctypes.c_size_t()
1872
# Get the fingerprint from the certificate into the buffer
1873
(gnutls.library.functions
1874
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1875
ctypes.byref(buf_len)))
1876
# Deinit the certificate
1877
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1878
# Convert the buffer to a Python bytestring
1879
fpr = ctypes.string_at(buf, buf_len.value)
1880
# Convert the bytestring to hexadecimal notation
1881
hex_fpr = binascii.hexlify(fpr).upper()
1885
class MultiprocessingMixIn(object):
1886
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
1887
def sub_process_main(self, request, address):
1889
self.finish_request(request, address)
1891
self.handle_error(request, address)
1892
self.close_request(request)
1894
def process_request(self, request, address):
1895
"""Start a new process to process the request."""
1896
proc = multiprocessing.Process(target = self.sub_process_main,
1897
args = (request, address))
1902
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1903
""" adds a pipe to the MixIn """
1904
def process_request(self, request, client_address):
1905
"""Overrides and wraps the original process_request().
1907
This function creates a new pipe in self.pipe
1909
parent_pipe, self.child_pipe = multiprocessing.Pipe()
1911
proc = MultiprocessingMixIn.process_request(self, request,
1913
self.child_pipe.close()
1914
self.add_pipe(parent_pipe, proc)
1916
def add_pipe(self, parent_pipe, proc):
1917
"""Dummy function; override as necessary"""
1918
raise NotImplementedError
1921
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1922
socketserver.TCPServer, object):
1923
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
434
logger.debug(u"TCP connection from: %s",
435
unicode(self.client_address))
437
line = self.request.makefile().readline()
438
logger.debug(u"Protocol version: %r", line)
440
if int(line.strip().split()[0]) > 1:
442
except (ValueError, IndexError, RuntimeError), error:
443
logger.error(u"Unknown protocol version: %s", error)
446
session = gnutls.connection.ClientSession\
447
(self.request, gnutls.connection.X509Credentials())
448
# Note: gnutls.connection.X509Credentials is really a generic
449
# GnuTLS certificate credentials object so long as no X.509
450
# keys are added to it. Therefore, we can use it here despite
451
# using OpenPGP certificates.
453
#priority = ':'.join(("NONE", "+VERS-TLS1.1", "+AES-256-CBC",
454
# "+SHA1", "+COMP-NULL", "+CTYPE-OPENPGP",
456
priority = "NORMAL" # Fallback default, since this
458
if self.server.settings["priority"]:
459
priority = self.server.settings["priority"]
460
gnutls.library.functions.gnutls_priority_set_direct\
461
(session._c_object, priority, None);
465
except gnutls.errors.GNUTLSError, error:
466
logger.debug(u"Handshake failed: %s", error)
467
# Do not run session.bye() here: the session is not
468
# established. Just abandon the request.
471
fpr = fingerprint(peer_certificate(session))
472
except (TypeError, gnutls.errors.GNUTLSError), error:
473
logger.debug(u"Bad certificate: %s", error)
476
logger.debug(u"Fingerprint: %s", fpr)
478
for c in self.server.clients:
479
if c.fingerprint == fpr:
483
logger.debug(u"Client not found for fingerprint: %s", fpr)
486
# Have to check if client.still_valid(), since it is possible
487
# that the client timed out while establishing the GnuTLS
489
if not client.still_valid():
490
logger.debug(u"Client %(name)s is invalid", vars(client))
494
while sent_size < len(client.secret):
495
sent = session.send(client.secret[sent_size:])
496
logger.debug(u"Sent: %d, remaining: %d",
497
sent, len(client.secret)
498
- (sent_size + sent))
503
class IPv6_TCPServer(SocketServer.ForkingTCPServer, object):
504
"""IPv6 TCP server. Accepts 'None' as address and/or port.
1926
enabled: Boolean; whether this server is activated yet
1927
interface: None or a network interface name (string)
1928
use_ipv6: Boolean; to use IPv6 or not
506
settings: Server settings
507
clients: Set() of Client objects
1930
def __init__(self, server_address, RequestHandlerClass,
1931
interface=None, use_ipv6=True, socketfd=None):
1932
"""If socketfd is set, use that file descriptor instead of
1933
creating a new one with socket.socket().
1935
self.interface = interface
1937
self.address_family = socket.AF_INET6
1938
if socketfd is not None:
1939
# Save the file descriptor
1940
self.socketfd = socketfd
1941
# Save the original socket.socket() function
1942
self.socket_socket = socket.socket
1943
# To implement --socket, we monkey patch socket.socket.
1945
# (When socketserver.TCPServer is a new-style class, we
1946
# could make self.socket into a property instead of monkey
1947
# patching socket.socket.)
1949
# Create a one-time-only replacement for socket.socket()
1950
@functools.wraps(socket.socket)
1951
def socket_wrapper(*args, **kwargs):
1952
# Restore original function so subsequent calls are
1954
socket.socket = self.socket_socket
1955
del self.socket_socket
1956
# This time only, return a new socket object from the
1957
# saved file descriptor.
1958
return socket.fromfd(self.socketfd, *args, **kwargs)
1959
# Replace socket.socket() function with wrapper
1960
socket.socket = socket_wrapper
1961
# The socketserver.TCPServer.__init__ will call
1962
# socket.socket(), which might be our replacement,
1963
# socket_wrapper(), if socketfd was set.
1964
socketserver.TCPServer.__init__(self, server_address,
1965
RequestHandlerClass)
509
address_family = socket.AF_INET6
510
def __init__(self, *args, **kwargs):
511
if "settings" in kwargs:
512
self.settings = kwargs["settings"]
513
del kwargs["settings"]
514
if "clients" in kwargs:
515
self.clients = kwargs["clients"]
516
del kwargs["clients"]
517
return super(type(self), self).__init__(*args, **kwargs)
1967
518
def server_bind(self):
1968
519
"""This overrides the normal server_bind() function
1969
520
to bind to an interface if one was specified, and also NOT to
1970
521
bind to an address or port if they were not specified."""
1971
if self.interface is not None:
1972
if SO_BINDTODEVICE is None:
1973
logger.error("SO_BINDTODEVICE does not exist;"
1974
" cannot bind to interface %s",
1978
self.socket.setsockopt(socket.SOL_SOCKET,
1980
str(self.interface + '\0'))
1981
except socket.error as error:
1982
if error.errno == errno.EPERM:
1983
logger.error("No permission to bind to"
1984
" interface %s", self.interface)
1985
elif error.errno == errno.ENOPROTOOPT:
1986
logger.error("SO_BINDTODEVICE not available;"
1987
" cannot bind to interface %s",
1989
elif error.errno == errno.ENODEV:
1990
logger.error("Interface %s does not exist,"
1991
" cannot bind", self.interface)
522
if self.settings["interface"]:
523
# 25 is from /usr/include/asm-i486/socket.h
524
SO_BINDTODEVICE = getattr(socket, "SO_BINDTODEVICE", 25)
526
self.socket.setsockopt(socket.SOL_SOCKET,
528
self.settings["interface"])
529
except socket.error, error:
530
if error[0] == errno.EPERM:
531
logger.warning(u"No permission to"
532
u" bind to interface %s",
533
self.settings["interface"])
1994
536
# Only bind(2) the socket if we really need to.
1995
537
if self.server_address[0] or self.server_address[1]:
1996
538
if not self.server_address[0]:
1997
if self.address_family == socket.AF_INET6:
1998
any_address = "::" # in6addr_any
2000
any_address = "0.0.0.0" # INADDR_ANY
2001
self.server_address = (any_address,
540
self.server_address = (in6addr_any,
2002
541
self.server_address[1])
2003
elif not self.server_address[1]:
542
elif self.server_address[1] is None:
2004
543
self.server_address = (self.server_address[0],
2006
# if self.interface:
2007
# self.server_address = (self.server_address[0],
2012
return socketserver.TCPServer.server_bind(self)
2015
class MandosServer(IPv6_TCPServer):
2019
clients: set of Client objects
2020
gnutls_priority GnuTLS priority string
2021
use_dbus: Boolean; to emit D-Bus signals or not
2023
Assumes a gobject.MainLoop event loop.
2025
def __init__(self, server_address, RequestHandlerClass,
2026
interface=None, use_ipv6=True, clients=None,
2027
gnutls_priority=None, use_dbus=True, socketfd=None):
2028
self.enabled = False
2029
self.clients = clients
2030
if self.clients is None:
2032
self.use_dbus = use_dbus
2033
self.gnutls_priority = gnutls_priority
2034
IPv6_TCPServer.__init__(self, server_address,
2035
RequestHandlerClass,
2036
interface = interface,
2037
use_ipv6 = use_ipv6,
2038
socketfd = socketfd)
2039
def server_activate(self):
2041
return socketserver.TCPServer.server_activate(self)
2046
def add_pipe(self, parent_pipe, proc):
2047
# Call "handle_ipc" for both data and EOF events
2048
gobject.io_add_watch(parent_pipe.fileno(),
2049
gobject.IO_IN | gobject.IO_HUP,
2050
functools.partial(self.handle_ipc,
2055
def handle_ipc(self, source, condition, parent_pipe=None,
2056
proc = None, client_object=None):
2057
# error, or the other end of multiprocessing.Pipe has closed
2058
if condition & (gobject.IO_ERR | gobject.IO_HUP):
2059
# Wait for other process to exit
2063
# Read a request from the child
2064
request = parent_pipe.recv()
2065
command = request[0]
2067
if command == 'init':
2069
address = request[2]
2071
for c in self.clients.itervalues():
2072
if c.fingerprint == fpr:
2076
logger.info("Client not found for fingerprint: %s, ad"
2077
"dress: %s", fpr, address)
2080
mandos_dbus_service.ClientNotFound(fpr,
2082
parent_pipe.send(False)
2085
gobject.io_add_watch(parent_pipe.fileno(),
2086
gobject.IO_IN | gobject.IO_HUP,
2087
functools.partial(self.handle_ipc,
2093
parent_pipe.send(True)
2094
# remove the old hook in favor of the new above hook on
2097
if command == 'funcall':
2098
funcname = request[1]
2102
parent_pipe.send(('data', getattr(client_object,
2106
if command == 'getattr':
2107
attrname = request[1]
2108
if callable(client_object.__getattribute__(attrname)):
2109
parent_pipe.send(('function',))
2111
parent_pipe.send(('data', client_object
2112
.__getattribute__(attrname)))
2114
if command == 'setattr':
2115
attrname = request[1]
2117
setattr(client_object, attrname, value)
2122
def rfc3339_duration_to_delta(duration):
2123
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2125
>>> rfc3339_duration_to_delta("P7D")
2126
datetime.timedelta(7)
2127
>>> rfc3339_duration_to_delta("PT60S")
2128
datetime.timedelta(0, 60)
2129
>>> rfc3339_duration_to_delta("PT60M")
2130
datetime.timedelta(0, 3600)
2131
>>> rfc3339_duration_to_delta("PT24H")
2132
datetime.timedelta(1)
2133
>>> rfc3339_duration_to_delta("P1W")
2134
datetime.timedelta(7)
2135
>>> rfc3339_duration_to_delta("PT5M30S")
2136
datetime.timedelta(0, 330)
2137
>>> rfc3339_duration_to_delta("P1DT3M20S")
2138
datetime.timedelta(1, 200)
2141
# Parsing an RFC 3339 duration with regular expressions is not
2142
# possible - there would have to be multiple places for the same
2143
# values, like seconds. The current code, while more esoteric, is
2144
# cleaner without depending on a parsing library. If Python had a
2145
# built-in library for parsing we would use it, but we'd like to
2146
# avoid excessive use of external libraries.
2148
# New type for defining tokens, syntax, and semantics all-in-one
2149
Token = collections.namedtuple("Token",
2150
("regexp", # To match token; if
2151
# "value" is not None,
2152
# must have a "group"
2154
"value", # datetime.timedelta or
2156
"followers")) # Tokens valid after
2158
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2159
# the "duration" ABNF definition in RFC 3339, Appendix A.
2160
token_end = Token(re.compile(r"$"), None, frozenset())
2161
token_second = Token(re.compile(r"(\d+)S"),
2162
datetime.timedelta(seconds=1),
2163
frozenset((token_end,)))
2164
token_minute = Token(re.compile(r"(\d+)M"),
2165
datetime.timedelta(minutes=1),
2166
frozenset((token_second, token_end)))
2167
token_hour = Token(re.compile(r"(\d+)H"),
2168
datetime.timedelta(hours=1),
2169
frozenset((token_minute, token_end)))
2170
token_time = Token(re.compile(r"T"),
2172
frozenset((token_hour, token_minute,
2174
token_day = Token(re.compile(r"(\d+)D"),
2175
datetime.timedelta(days=1),
2176
frozenset((token_time, token_end)))
2177
token_month = Token(re.compile(r"(\d+)M"),
2178
datetime.timedelta(weeks=4),
2179
frozenset((token_day, token_end)))
2180
token_year = Token(re.compile(r"(\d+)Y"),
2181
datetime.timedelta(weeks=52),
2182
frozenset((token_month, token_end)))
2183
token_week = Token(re.compile(r"(\d+)W"),
2184
datetime.timedelta(weeks=1),
2185
frozenset((token_end,)))
2186
token_duration = Token(re.compile(r"P"), None,
2187
frozenset((token_year, token_month,
2188
token_day, token_time,
2190
# Define starting values
2191
value = datetime.timedelta() # Value so far
2193
followers = frozenset(token_duration,) # Following valid tokens
2194
s = duration # String left to parse
2195
# Loop until end token is found
2196
while found_token is not token_end:
2197
# Search for any currently valid tokens
2198
for token in followers:
2199
match = token.regexp.match(s)
2200
if match is not None:
2202
if token.value is not None:
2203
# Value found, parse digits
2204
factor = int(match.group(1), 10)
2205
# Add to value so far
2206
value += factor * token.value
2207
# Strip token from string
2208
s = token.regexp.sub("", s, 1)
2211
# Set valid next tokens
2212
followers = found_token.followers
2215
# No currently valid tokens were found
2216
raise ValueError("Invalid RFC 3339 duration")
545
return super(type(self), self).server_bind()
2221
548
def string_to_delta(interval):
2222
549
"""Parse a string and return a datetime.timedelta
2224
551
>>> string_to_delta('7d')
2225
552
datetime.timedelta(7)
2226
553
>>> string_to_delta('60s')
2350
695
"debug": "False",
2352
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",
697
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
2353
698
"servicename": "Mandos",
2359
"statedir": "/var/lib/mandos",
2360
"foreground": "False",
2363
701
# Parse config file for server-global settings
2364
server_config = configparser.SafeConfigParser(server_defaults)
702
server_config = ConfigParser.SafeConfigParser(server_defaults)
2365
703
del server_defaults
2366
server_config.read(os.path.join(options.configdir,
704
server_config.read(os.path.join(options.configdir, "server.conf"))
705
server_section = "server"
2368
706
# Convert the SafeConfigParser object to a dict
2369
server_settings = server_config.defaults()
2370
# Use the appropriate methods on the non-string config options
2371
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2372
server_settings[option] = server_config.getboolean("DEFAULT",
2374
if server_settings["port"]:
2375
server_settings["port"] = server_config.getint("DEFAULT",
2377
if server_settings["socket"]:
2378
server_settings["socket"] = server_config.getint("DEFAULT",
2380
# Later, stdin will, and stdout and stderr might, be dup'ed
2381
# over with an opened os.devnull. But we don't want this to
2382
# happen with a supplied network socket.
2383
if 0 <= server_settings["socket"] <= 2:
2384
server_settings["socket"] = os.dup(server_settings
707
server_settings = dict(server_config.items(server_section))
708
# Use getboolean on the boolean config option
709
server_settings["debug"] = server_config.getboolean\
710
(server_section, "debug")
2386
711
del server_config
2388
713
# Override the settings from the config file with command line
2389
714
# options, if set.
2390
715
for option in ("interface", "address", "port", "debug",
2391
"priority", "servicename", "configdir",
2392
"use_dbus", "use_ipv6", "debuglevel", "restore",
2393
"statedir", "socket", "foreground"):
716
"priority", "servicename", "configdir"):
2394
717
value = getattr(options, option)
2395
718
if value is not None:
2396
719
server_settings[option] = value
2398
# Force all strings to be unicode
2399
for option in server_settings.keys():
2400
if type(server_settings[option]) is str:
2401
server_settings[option] = unicode(server_settings[option])
2402
# Force all boolean options to be boolean
2403
for option in ("debug", "use_dbus", "use_ipv6", "restore",
2405
server_settings[option] = bool(server_settings[option])
2406
# Debug implies foreground
2407
if server_settings["debug"]:
2408
server_settings["foreground"] = True
2409
721
# Now we have our good server settings in "server_settings"
2411
##################################################################
2414
debug = server_settings["debug"]
2415
debuglevel = server_settings["debuglevel"]
2416
use_dbus = server_settings["use_dbus"]
2417
use_ipv6 = server_settings["use_ipv6"]
2418
stored_state_path = os.path.join(server_settings["statedir"],
2420
foreground = server_settings["foreground"]
2423
initlogger(debug, logging.DEBUG)
2428
level = getattr(logging, debuglevel.upper())
2429
initlogger(debug, level)
2431
if server_settings["servicename"] != "Mandos":
2432
syslogger.setFormatter(logging.Formatter
2433
('Mandos ({0}) [%(process)d]:'
2434
' %(levelname)s: %(message)s'
2435
.format(server_settings
2438
723
# Parse config file with clients
2439
client_config = configparser.SafeConfigParser(Client
724
client_defaults = { "timeout": "1h",
726
"checker": "fping -q -- %%(fqdn)s",
728
client_config = ConfigParser.SafeConfigParser(client_defaults)
2441
729
client_config.read(os.path.join(server_settings["configdir"],
2442
730
"clients.conf"))
2444
global mandos_dbus_service
2445
mandos_dbus_service = None
2447
tcp_server = MandosServer((server_settings["address"],
2448
server_settings["port"]),
2450
interface=(server_settings["interface"]
2454
server_settings["priority"],
2456
socketfd=(server_settings["socket"]
2459
pidfilename = "/run/mandos.pid"
2460
if not os.path.isdir("/run/."):
2461
pidfilename = "/var/run/mandos.pid"
2464
pidfile = open(pidfilename, "w")
2465
except IOError as e:
2466
logger.error("Could not open file %r", pidfilename,
2469
for name in ("_mandos", "mandos", "nobody"):
2471
uid = pwd.getpwnam(name).pw_uid
2472
gid = pwd.getpwnam(name).pw_gid
2482
except OSError as error:
2483
if error.errno != errno.EPERM:
2487
# Enable all possible GnuTLS debugging
2489
# "Use a log level over 10 to enable all debugging options."
2491
gnutls.library.functions.gnutls_global_set_log_level(11)
2493
@gnutls.library.types.gnutls_log_func
2494
def debug_gnutls(level, string):
2495
logger.debug("GnuTLS: %s", string[:-1])
2497
(gnutls.library.functions
2498
.gnutls_global_set_log_function(debug_gnutls))
2500
# Redirect stdin so all checkers get /dev/null
2501
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2502
os.dup2(null, sys.stdin.fileno())
2506
# Need to fork before connecting to D-Bus
2508
# Close all input and output, do double fork, etc.
2511
# multiprocessing will use threads, so before we use gobject we
2512
# need to inform gobject that threads will be used.
2513
gobject.threads_init()
733
service = AvahiService(name = server_settings["servicename"],
734
type = "_mandos._tcp", );
735
if server_settings["interface"]:
736
service.interface = if_nametoindex(server_settings["interface"])
2515
738
global main_loop
2516
741
# From the Avahi example code
2517
DBusGMainLoop(set_as_default=True)
742
DBusGMainLoop(set_as_default=True )
2518
743
main_loop = gobject.MainLoop()
2519
744
bus = dbus.SystemBus()
745
server = dbus.Interface(
746
bus.get_object( avahi.DBUS_NAME, avahi.DBUS_PATH_SERVER ),
747
avahi.DBUS_INTERFACE_SERVER )
2520
748
# End of Avahi example code
2523
bus_name = dbus.service.BusName("se.recompile.Mandos",
2524
bus, do_not_queue=True)
2525
old_bus_name = (dbus.service.BusName
2526
("se.bsnet.fukt.Mandos", bus,
2528
except dbus.exceptions.NameExistsException as e:
2529
logger.error("Disabling D-Bus:", exc_info=e)
2531
server_settings["use_dbus"] = False
2532
tcp_server.use_dbus = False
2533
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2534
service = AvahiServiceToSyslog(name =
2535
server_settings["servicename"],
2536
servicetype = "_mandos._tcp",
2537
protocol = protocol, bus = bus)
2538
if server_settings["interface"]:
2539
service.interface = (if_nametoindex
2540
(str(server_settings["interface"])))
2542
global multiprocessing_manager
2543
multiprocessing_manager = multiprocessing.Manager()
2545
client_class = Client
2547
client_class = functools.partial(ClientDBus, bus = bus)
2549
client_settings = Client.config_parser(client_config)
2550
old_client_settings = {}
2553
# This is used to redirect stdout and stderr for checker processes
2555
wnull = open(os.devnull, "w") # A writable /dev/null
2556
# Only used if server is running in foreground but not in debug
2558
if debug or not foreground:
2561
# Get client data and settings from last running state.
2562
if server_settings["restore"]:
2564
with open(stored_state_path, "rb") as stored_state:
2565
clients_data, old_client_settings = (pickle.load
2567
os.remove(stored_state_path)
2568
except IOError as e:
2569
if e.errno == errno.ENOENT:
2570
logger.warning("Could not load persistent state: {0}"
2571
.format(os.strerror(e.errno)))
2573
logger.critical("Could not load persistent state:",
2576
except EOFError as e:
2577
logger.warning("Could not load persistent state: "
2578
"EOFError:", exc_info=e)
2580
with PGPEngine() as pgp:
2581
for client_name, client in clients_data.iteritems():
2582
# Skip removed clients
2583
if client_name not in client_settings:
2586
# Decide which value to use after restoring saved state.
2587
# We have three different values: Old config file,
2588
# new config file, and saved state.
2589
# New config value takes precedence if it differs from old
2590
# config value, otherwise use saved state.
2591
for name, value in client_settings[client_name].items():
2593
# For each value in new config, check if it
2594
# differs from the old config value (Except for
2595
# the "secret" attribute)
2596
if (name != "secret" and
2597
value != old_client_settings[client_name]
2599
client[name] = value
2603
# Clients who has passed its expire date can still be
2604
# enabled if its last checker was successful. Clients
2605
# whose checker succeeded before we stored its state is
2606
# assumed to have successfully run all checkers during
2608
if client["enabled"]:
2609
if datetime.datetime.utcnow() >= client["expires"]:
2610
if not client["last_checked_ok"]:
2612
"disabling client {0} - Client never "
2613
"performed a successful checker"
2614
.format(client_name))
2615
client["enabled"] = False
2616
elif client["last_checker_status"] != 0:
2618
"disabling client {0} - Client "
2619
"last checker failed with error code {1}"
2620
.format(client_name,
2621
client["last_checker_status"]))
2622
client["enabled"] = False
2624
client["expires"] = (datetime.datetime
2626
+ client["timeout"])
2627
logger.debug("Last checker succeeded,"
2628
" keeping {0} enabled"
2629
.format(client_name))
2631
client["secret"] = (
2632
pgp.decrypt(client["encrypted_secret"],
2633
client_settings[client_name]
2636
# If decryption fails, we use secret from new settings
2637
logger.debug("Failed to decrypt {0} old secret"
2638
.format(client_name))
2639
client["secret"] = (
2640
client_settings[client_name]["secret"])
2642
# Add/remove clients based on new changes made to config
2643
for client_name in (set(old_client_settings)
2644
- set(client_settings)):
2645
del clients_data[client_name]
2646
for client_name in (set(client_settings)
2647
- set(old_client_settings)):
2648
clients_data[client_name] = client_settings[client_name]
2650
# Create all client objects
2651
for client_name, client in clients_data.iteritems():
2652
tcp_server.clients[client_name] = client_class(
2653
name = client_name, settings = client,
2654
server_settings = server_settings)
2656
if not tcp_server.clients:
2657
logger.warning("No clients defined")
2660
if pidfile is not None:
2664
pidfile.write(str(pid) + "\n".encode("utf-8"))
2666
logger.error("Could not write to file %r with PID %d",
2671
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2672
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2675
@alternate_dbus_interfaces({"se.recompile.Mandos":
2676
"se.bsnet.fukt.Mandos"})
2677
class MandosDBusService(DBusObjectWithProperties):
2678
"""A D-Bus proxy object"""
2680
dbus.service.Object.__init__(self, bus, "/")
2681
_interface = "se.recompile.Mandos"
2683
@dbus_interface_annotations(_interface)
2685
return { "org.freedesktop.DBus.Property"
2686
".EmitsChangedSignal":
2689
@dbus.service.signal(_interface, signature="o")
2690
def ClientAdded(self, objpath):
2694
@dbus.service.signal(_interface, signature="ss")
2695
def ClientNotFound(self, fingerprint, address):
2699
@dbus.service.signal(_interface, signature="os")
2700
def ClientRemoved(self, objpath, name):
2704
@dbus.service.method(_interface, out_signature="ao")
2705
def GetAllClients(self):
2707
return dbus.Array(c.dbus_object_path
2709
tcp_server.clients.itervalues())
2711
@dbus.service.method(_interface,
2712
out_signature="a{oa{sv}}")
2713
def GetAllClientsWithProperties(self):
2715
return dbus.Dictionary(
2716
((c.dbus_object_path, c.GetAll(""))
2717
for c in tcp_server.clients.itervalues()),
2720
@dbus.service.method(_interface, in_signature="o")
2721
def RemoveClient(self, object_path):
2723
for c in tcp_server.clients.itervalues():
2724
if c.dbus_object_path == object_path:
2725
del tcp_server.clients[c.name]
2726
c.remove_from_connection()
2727
# Don't signal anything except ClientRemoved
2728
c.disable(quiet=True)
2730
self.ClientRemoved(object_path, c.name)
2732
raise KeyError(object_path)
2736
mandos_dbus_service = MandosDBusService()
750
debug = server_settings["debug"]
753
console = logging.StreamHandler()
754
# console.setLevel(logging.DEBUG)
755
console.setFormatter(logging.Formatter\
756
('%(levelname)s: %(message)s'))
757
logger.addHandler(console)
761
def remove_from_clients(client):
762
clients.remove(client)
764
logger.debug(u"No clients left, exiting")
767
clients.update(Set(Client(name=section,
768
stop_hook = remove_from_clients,
769
**(dict(client_config\
771
for section in client_config.sections()))
2739
777
"Cleanup function; run on exit"
2742
multiprocessing.active_children()
2744
if not (tcp_server.clients or client_settings):
2747
# Store client before exiting. Secrets are encrypted with key
2748
# based on what config file has. If config file is
2749
# removed/edited, old secret will thus be unrecovable.
2751
with PGPEngine() as pgp:
2752
for client in tcp_server.clients.itervalues():
2753
key = client_settings[client.name]["secret"]
2754
client.encrypted_secret = pgp.encrypt(client.secret,
2758
# A list of attributes that can not be pickled
2760
exclude = set(("bus", "changedstate", "secret",
2761
"checker", "server_settings"))
2762
for name, typ in (inspect.getmembers
2763
(dbus.service.Object)):
2766
client_dict["encrypted_secret"] = (client
2768
for attr in client.client_structure:
2769
if attr not in exclude:
2770
client_dict[attr] = getattr(client, attr)
2772
clients[client.name] = client_dict
2773
del client_settings[client.name]["secret"]
2776
with (tempfile.NamedTemporaryFile
2777
(mode='wb', suffix=".pickle", prefix='clients-',
2778
dir=os.path.dirname(stored_state_path),
2779
delete=False)) as stored_state:
2780
pickle.dump((clients, client_settings), stored_state)
2781
tempname=stored_state.name
2782
os.rename(tempname, stored_state_path)
2783
except (IOError, OSError) as e:
2789
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
2790
logger.warning("Could not save persistent state: {0}"
2791
.format(os.strerror(e.errno)))
2793
logger.warning("Could not save persistent state:",
2797
# Delete all clients, and settings from config
2798
while tcp_server.clients:
2799
name, client = tcp_server.clients.popitem()
2801
client.remove_from_connection()
2802
# Don't signal anything except ClientRemoved
2803
client.disable(quiet=True)
2806
mandos_dbus_service.ClientRemoved(client
2809
client_settings.clear()
779
# From the Avahi example code
780
if not group is None:
783
# End of Avahi example code
786
client = clients.pop()
787
client.stop_hook = None
2811
790
atexit.register(cleanup)
2813
for client in tcp_server.clients.itervalues():
2816
mandos_dbus_service.ClientAdded(client.dbus_object_path)
2817
# Need to initiate checking of clients
2819
client.init_checker()
2822
tcp_server.server_activate()
793
signal.signal(signal.SIGINT, signal.SIG_IGN)
794
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
795
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
797
for client in clients:
800
tcp_server = IPv6_TCPServer((server_settings["address"],
801
server_settings["port"]),
803
settings=server_settings,
2824
805
# Find out what port we got
2825
806
service.port = tcp_server.socket.getsockname()[1]
2827
logger.info("Now listening on address %r, port %d,"
2828
" flowinfo %d, scope_id %d",
2829
*tcp_server.socket.getsockname())
2831
logger.info("Now listening on address %r, port %d",
2832
*tcp_server.socket.getsockname())
807
logger.debug(u"Now listening on address %r, port %d, flowinfo %d,"
808
u" scope_id %d" % tcp_server.socket.getsockname())
2834
810
#service.interface = tcp_server.socket.getsockname()[3]
2837
813
# From the Avahi example code
814
server.connect_to_signal("StateChanged", server_state_changed)
2840
except dbus.exceptions.DBusException as error:
2841
logger.critical("D-Bus Exception", exc_info=error)
816
server_state_changed(server.GetState())
817
except dbus.exceptions.DBusException, error:
818
logger.critical(u"DBusException: %s", error)
2844
820
# End of Avahi example code
2846
822
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2847
823
lambda *args, **kwargs:
2848
(tcp_server.handle_request
2849
(*args[2:], **kwargs) or True))
824
tcp_server.handle_request\
825
(*args[2:], **kwargs) or True)
2851
827
logger.debug("Starting main loop")
828
main_loop_started = True
2853
except AvahiError as error:
2854
logger.critical("Avahi Error", exc_info=error)
830
except AvahiError, error:
831
logger.critical(u"AvahiError: %s" + unicode(error))
2857
833
except KeyboardInterrupt:
2859
print("", file=sys.stderr)
2860
logger.debug("Server received KeyboardInterrupt")
2861
logger.debug("Server exiting")
2862
# Must run before the D-Bus bus name gets deregistered
2865
837
if __name__ == '__main__':