238
98
class AvahiService(object):
239
"""An Avahi (Zeroconf) service.
242
100
interface: integer; avahi.IF_UNSPEC or an interface index.
243
101
Used to optionally bind to the specified interface.
244
name: string; Example: 'Mandos'
245
type: string; Example: '_mandos._tcp'.
246
See <https://www.iana.org/assignments/service-names-port-numbers>
247
port: integer; what port to announce
248
TXT: list of strings; TXT record for the service
249
domain: string; Domain to publish on, default to .local if empty.
250
host: string; Host to publish records for, default is localhost
251
max_renames: integer; maximum number of renames
252
rename_count: integer; counter so we only rename after collisions
253
a sensible number of times
254
group: D-Bus Entry Group
256
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
259
114
def __init__(self, interface = avahi.IF_UNSPEC, name = None,
260
servicetype = None, port = None, TXT = None,
261
domain = "", host = "", max_renames = 32768,
262
protocol = avahi.PROTO_UNSPEC, bus = None):
115
type = None, port = None, TXT = None, domain = "",
116
host = "", max_renames = 12):
117
"""An Avahi (Zeroconf) service. """
263
118
self.interface = interface
265
self.type = servicetype
267
self.TXT = TXT if TXT is not None else []
268
126
self.domain = domain
270
128
self.rename_count = 0
271
self.max_renames = max_renames
272
self.protocol = protocol
273
self.group = None # our entry group
276
self.entry_group_state_changed_match = None
278
def rename(self, remove=True):
279
130
"""Derived from the Avahi example code"""
280
131
if self.rename_count >= self.max_renames:
281
logger.critical("No suitable Zeroconf service name found"
282
" after %i retries, exiting.",
132
logger.critical(u"No suitable service name found after %i"
133
u" retries, exiting.", rename_count)
284
134
raise AvahiServiceError("Too many renames")
285
self.name = str(self.server
286
.GetAlternativeServiceName(self.name))
135
name = server.GetAlternativeServiceName(name)
136
logger.notice(u"Changing name to %r ...", name)
287
139
self.rename_count += 1
288
logger.info("Changing Zeroconf service name to %r ...",
294
except dbus.exceptions.DBusException as error:
295
if (error.get_dbus_name()
296
== "org.freedesktop.Avahi.CollisionError"):
297
logger.info("Local Zeroconf service name collision.")
298
return self.rename(remove=False)
300
logger.critical("D-Bus Exception", exc_info=error)
304
140
def remove(self):
305
141
"""Derived from the Avahi example code"""
306
if self.entry_group_state_changed_match is not None:
307
self.entry_group_state_changed_match.remove()
308
self.entry_group_state_changed_match = None
309
if self.group is not None:
142
if group is not None:
313
145
"""Derived from the Avahi example code"""
315
if self.group is None:
316
self.group = dbus.Interface(
317
self.bus.get_object(avahi.DBUS_NAME,
318
self.server.EntryGroupNew()),
319
avahi.DBUS_INTERFACE_ENTRY_GROUP)
320
self.entry_group_state_changed_match = (
321
self.group.connect_to_signal(
322
'StateChanged', self.entry_group_state_changed))
323
logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
324
self.name, self.type)
325
self.group.AddService(
328
dbus.UInt32(0), # flags
329
self.name, self.type,
330
self.domain, self.host,
331
dbus.UInt16(self.port),
332
avahi.string_array_to_txt_array(self.TXT))
335
def entry_group_state_changed(self, state, error):
336
"""Derived from the Avahi example code"""
337
logger.debug("Avahi entry group state change: %i", state)
339
if state == avahi.ENTRY_GROUP_ESTABLISHED:
340
logger.debug("Zeroconf service established.")
341
elif state == avahi.ENTRY_GROUP_COLLISION:
342
logger.info("Zeroconf service name collision.")
344
elif state == avahi.ENTRY_GROUP_FAILURE:
345
logger.critical("Avahi: Error in group state changed %s",
347
raise AvahiGroupError("State changed: {!s}"
351
"""Derived from the Avahi example code"""
352
if self.group is not None:
355
except (dbus.exceptions.UnknownMethodException,
356
dbus.exceptions.DBusException):
361
def server_state_changed(self, state, error=None):
362
"""Derived from the Avahi example code"""
363
logger.debug("Avahi server state change: %i", state)
364
bad_states = { avahi.SERVER_INVALID:
365
"Zeroconf server invalid",
366
avahi.SERVER_REGISTERING: None,
367
avahi.SERVER_COLLISION:
368
"Zeroconf server name collision",
369
avahi.SERVER_FAILURE:
370
"Zeroconf server failure" }
371
if state in bad_states:
372
if bad_states[state] is not None:
374
logger.error(bad_states[state])
376
logger.error(bad_states[state] + ": %r", error)
378
elif state == avahi.SERVER_RUNNING:
382
logger.debug("Unknown state: %r", state)
384
logger.debug("Unknown state: %r: %r", state, error)
387
"""Derived from the Avahi example code"""
388
if self.server is None:
389
self.server = dbus.Interface(
390
self.bus.get_object(avahi.DBUS_NAME,
391
avahi.DBUS_PATH_SERVER,
392
follow_name_owner_changes=True),
393
avahi.DBUS_INTERFACE_SERVER)
394
self.server.connect_to_signal("StateChanged",
395
self.server_state_changed)
396
self.server_state_changed(self.server.GetState())
399
class AvahiServiceToSyslog(AvahiService):
400
def rename(self, *args, **kwargs):
401
"""Add the new name to the syslog messages"""
402
ret = AvahiService.rename(self, *args, **kwargs)
403
syslogger.setFormatter(logging.Formatter
404
('Mandos ({}) [%(process)d]:'
405
' %(levelname)s: %(message)s'
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
410
171
class Client(object):
411
172
"""A representation of a client host served by this server.
414
approved: bool(); 'None' if not yet approved/disapproved
415
approval_delay: datetime.timedelta(); Time to wait for approval
416
approval_duration: datetime.timedelta(); Duration of one approval
417
checker: subprocess.Popen(); a running checker process used
418
to see if the client lives.
419
'None' if no process is running.
420
checker_callback_tag: a gobject event source tag, or None
421
checker_command: string; External command which is run to check
422
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
423
193
runtime with vars(self) as dict, so that for
424
194
instance %(name)s can be used in the command.
425
checker_initiator_tag: a gobject event source tag, or None
426
created: datetime.datetime(); (UTC) object creation
427
client_structure: Object describing what attributes a client has
428
and is used for storing the client at exit
429
current_checker_command: string; current running checker_command
430
disable_initiator_tag: a gobject event source tag, or None
432
fingerprint: string (40 or 32 hexadecimal digits); used to
433
uniquely identify the client
434
host: string; available for use by the checker command
435
interval: datetime.timedelta(); How often to start a new checker
436
last_approval_request: datetime.datetime(); (UTC) or None
437
last_checked_ok: datetime.datetime(); (UTC) or None
438
last_checker_status: integer between 0 and 255 reflecting exit
439
status of last checker. -1 reflects crashed
440
checker, -2 means no checker completed yet.
441
last_enabled: datetime.datetime(); (UTC) or None
442
name: string; from the config file, used in log messages and
444
secret: bytestring; sent verbatim (over TLS) to client
445
timeout: datetime.timedelta(); How long from last_checked_ok
446
until this client is disabled
447
extended_timeout: extra long timeout when secret has been sent
448
runtime_expansions: Allowed attributes for runtime expansion.
449
expires: datetime.datetime(); time (UTC) when a client will be
451
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: - '' -
454
runtime_expansions = ("approval_delay", "approval_duration",
455
"created", "enabled", "expires",
456
"fingerprint", "host", "interval",
457
"last_approval_request", "last_checked_ok",
458
"last_enabled", "name", "timeout")
459
client_defaults = { "timeout": "PT5M",
460
"extended_timeout": "PT15M",
462
"checker": "fping -q -- %%(host)s",
464
"approval_delay": "PT0S",
465
"approval_duration": "PT1S",
466
"approved_by_default": "True",
471
def config_parser(config):
472
"""Construct a new dict of client settings of this form:
473
{ client_name: {setting_name: value, ...}, ...}
474
with exceptions for any special settings as defined above.
475
NOTE: Must be a pure function. Must return the same result
476
value given the same arguments.
479
for client_name in config.sections():
480
section = dict(config.items(client_name))
481
client = settings[client_name] = {}
483
client["host"] = section["host"]
484
# Reformat values from string types to Python types
485
client["approved_by_default"] = config.getboolean(
486
client_name, "approved_by_default")
487
client["enabled"] = config.getboolean(client_name,
490
# Uppercase and remove spaces from fingerprint for later
491
# comparison purposes with return value from the
492
# fingerprint() function
493
client["fingerprint"] = (section["fingerprint"].upper()
495
if "secret" in section:
496
client["secret"] = section["secret"].decode("base64")
497
elif "secfile" in section:
498
with open(os.path.expanduser(os.path.expandvars
499
(section["secfile"])),
501
client["secret"] = secfile.read()
503
raise TypeError("No secret or secfile for section {}"
505
client["timeout"] = string_to_delta(section["timeout"])
506
client["extended_timeout"] = string_to_delta(
507
section["extended_timeout"])
508
client["interval"] = string_to_delta(section["interval"])
509
client["approval_delay"] = string_to_delta(
510
section["approval_delay"])
511
client["approval_duration"] = string_to_delta(
512
section["approval_duration"])
513
client["checker_command"] = section["checker"]
514
client["last_approval_request"] = None
515
client["last_checked_ok"] = None
516
client["last_checker_status"] = -2
520
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.."""
522
if server_settings is None:
524
self.server_settings = server_settings
525
# adding all client settings
526
for setting, value in settings.items():
527
setattr(self, setting, value)
530
if not hasattr(self, "last_enabled"):
531
self.last_enabled = datetime.datetime.utcnow()
532
if not hasattr(self, "expires"):
533
self.expires = (datetime.datetime.utcnow()
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()
536
self.last_enabled = None
539
logger.debug("Creating client %r", self.name)
540
logger.debug(" Fingerprint: %s", self.fingerprint)
541
self.created = settings.get("created",
542
datetime.datetime.utcnow())
544
# 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
545
251
self.checker = None
546
252
self.checker_initiator_tag = None
547
self.disable_initiator_tag = None
253
self.stop_initiator_tag = None
548
254
self.checker_callback_tag = None
549
self.current_checker_command = None
551
self.approvals_pending = 0
552
self.changedstate = (multiprocessing_manager
553
.Condition(multiprocessing_manager
555
self.client_structure = [attr for attr in
556
self.__dict__.iterkeys()
557
if not attr.startswith("_")]
558
self.client_structure.append("client_structure")
560
for name, t in inspect.getmembers(type(self),
564
if not name.startswith("_"):
565
self.client_structure.append(name)
567
# Send notice to process children that client state has changed
568
def send_changedstate(self):
569
with self.changedstate:
570
self.changedstate.notify_all()
255
self.check_command = checker
573
257
"""Start this client's checker and timeout hooks"""
574
if getattr(self, "enabled", False):
577
self.expires = datetime.datetime.utcnow() + self.timeout
579
self.last_enabled = datetime.datetime.utcnow()
581
self.send_changedstate()
583
def disable(self, quiet=True):
584
"""Disable this client."""
585
if not getattr(self, "enabled", False):
588
logger.info("Disabling client %s", self.name)
589
if getattr(self, "disable_initiator_tag", None) is not None:
590
gobject.source_remove(self.disable_initiator_tag)
591
self.disable_initiator_tag = None
593
if getattr(self, "checker_initiator_tag", None) is not None:
594
gobject.source_remove(self.checker_initiator_tag)
595
self.checker_initiator_tag = None
599
self.send_changedstate()
600
# Do not run this again if called by a gobject.timeout_add
606
def init_checker(self):
607
258
# Schedule a new checker to be started an 'interval' from now,
608
259
# and every interval from then on.
609
if self.checker_initiator_tag is not None:
610
gobject.source_remove(self.checker_initiator_tag)
611
self.checker_initiator_tag = (gobject.timeout_add
613
.total_seconds() * 1000),
615
# Schedule a disable() when 'timeout' has passed
616
if self.disable_initiator_tag is not None:
617
gobject.source_remove(self.disable_initiator_tag)
618
self.disable_initiator_tag = (gobject.timeout_add
620
.total_seconds() * 1000),
260
self.checker_initiator_tag = gobject.timeout_add\
261
(self._interval_milliseconds,
622
263
# Also start a new checker *right now*.
623
264
self.start_checker()
625
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):
626
294
"""The checker has completed, so take appropriate actions."""
295
now = datetime.datetime.now()
627
296
self.checker_callback_tag = None
628
297
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",
639
self.last_checker_status = -1
640
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?",
643
def checked_ok(self):
644
"""Assert that the client has been seen, alive and well."""
645
self.last_checked_ok = datetime.datetime.utcnow()
646
self.last_checker_status = 0
649
def bump_timeout(self, timeout=None):
650
"""Bump up the timeout for this client."""
652
timeout = self.timeout
653
if self.disable_initiator_tag is not None:
654
gobject.source_remove(self.disable_initiator_tag)
655
self.disable_initiator_tag = None
656
if getattr(self, "enabled", False):
657
self.disable_initiator_tag = (gobject.timeout_add
658
(int(timeout.total_seconds()
659
* 1000), self.disable))
660
self.expires = datetime.datetime.utcnow() + timeout
662
def need_approval(self):
663
self.last_approval_request = datetime.datetime.utcnow()
311
logger.debug(u"Checker for %(name)s failed",
665
313
def start_checker(self):
666
314
"""Start a new checker subprocess if one is not running.
668
315
If a checker already exists, leave it running and do
670
317
# The reason for not killing a running checker is that if we
671
# did that, and if a checker (for some reason) started running
672
# slowly and taking more than 'interval' time, then the client
673
# would inevitably timeout, since no checker would get a
674
# 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
675
322
# checkers alone, the checker would have to take more time
676
# than 'timeout' for the client to be disabled, which is as it
679
# If a checker exists, make sure it is not a zombie
681
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
682
except AttributeError:
684
except OSError as error:
685
if error.errno != errno.ECHILD:
689
logger.warning("Checker was a zombie")
690
gobject.source_remove(self.checker_callback_tag)
691
self.checker_callback(pid, status,
692
self.current_checker_command)
693
# Start a new checker if needed
323
# than 'timeout' for the client to be declared invalid, which
324
# is as it should be.
694
325
if self.checker is None:
695
# Escape attributes for the shell
696
escaped_attrs = { attr:
697
re.escape(str(getattr(self, attr)))
698
for attr in self.runtime_expansions }
700
command = self.checker_command % escaped_attrs
701
except TypeError as error:
702
logger.error('Could not format string "%s"',
703
self.checker_command, exc_info=error)
704
return True # Try again later
705
self.current_checker_command = command
707
logger.info("Starting checker %r for %s",
709
# We don't need to redirect stdout and stderr, since
710
# in normal mode, that is already done by daemon(),
711
# and in debug mode we don't want to. (Stdin is
712
# always replaced by /dev/null.)
713
# The exception is when not debugging but nevertheless
714
# running in the foreground; use the previously
717
if (not self.server_settings["debug"]
718
and self.server_settings["foreground"]):
719
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",
721
343
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
731
self.checker_callback,
733
# The checker may have completed before the gobject
734
# watch was added. Check for this.
736
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
737
except OSError as error:
738
if error.errno == errno.ECHILD:
739
# This should never happen
740
logger.error("Child process vanished",
745
gobject.source_remove(self.checker_callback_tag)
746
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",
747
352
# Re-run this periodically if run by gobject.timeout_add
750
354
def stop_checker(self):
751
355
"""Force the checker process, if any, to stop."""
752
356
if self.checker_callback_tag:
757
361
logger.debug("Stopping checker for %(name)s", vars(self))
759
self.checker.terminate()
363
os.kill(self.checker.pid, signal.SIGTERM)
761
365
#if self.checker.poll() is None:
762
# self.checker.kill()
763
except OSError as error:
366
# os.kill(self.checker.pid, signal.SIGKILL)
367
except OSError, error:
764
368
if error.errno != errno.ESRCH: # No such process
766
370
self.checker = None
769
def dbus_service_property(dbus_interface, signature="v",
770
access="readwrite", byte_arrays=False):
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))
787
func._dbus_is_property = True
788
func._dbus_interface = dbus_interface
789
func._dbus_signature = signature
790
func._dbus_access = access
791
func._dbus_name = func.__name__
792
if func._dbus_name.endswith("_dbus_property"):
793
func._dbus_name = func._dbus_name[:-14]
794
func._dbus_get_args_options = {'byte_arrays': byte_arrays }
799
def dbus_interface_annotations(dbus_interface):
800
"""Decorator for marking functions returning interface annotations
804
@dbus_interface_annotations("org.example.Interface")
805
def _foo(self): # Function name does not matter
806
return {"org.freedesktop.DBus.Deprecated": "true",
807
"org.freedesktop.DBus.Property.EmitsChangedSignal":
811
func._dbus_is_interface = True
812
func._dbus_interface = dbus_interface
813
func._dbus_name = dbus_interface
818
def dbus_annotations(annotations):
819
"""Decorator to annotate D-Bus methods, signals or properties
822
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
823
"org.freedesktop.DBus.Property."
824
"EmitsChangedSignal": "false"})
825
@dbus_service_property("org.example.Interface", signature="b",
827
def Property_dbus_property(self):
828
return dbus.Boolean(False)
831
func._dbus_annotations = annotations
836
class DBusPropertyException(dbus.exceptions.DBusException):
837
"""A base class for D-Bus property-related exceptions
841
class DBusPropertyAccessException(DBusPropertyException):
842
"""A property's access permissions disallows an operation.
847
class DBusPropertyNotFound(DBusPropertyException):
848
"""An attempt was made to access a non-existing property.
853
class DBusObjectWithProperties(dbus.service.Object):
854
"""A D-Bus object with properties.
856
Classes inheriting from this can use the dbus_service_property
857
decorator to expose methods as D-Bus properties. It exposes the
858
standard Get(), Set(), and GetAll() methods on the D-Bus.
862
def _is_dbus_thing(thing):
863
"""Returns a function testing if an attribute is a D-Bus thing
865
If called like _is_dbus_thing("method") it returns a function
866
suitable for use as predicate to inspect.getmembers().
868
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
871
def _get_all_dbus_things(self, thing):
872
"""Returns a generator of (name, attribute) pairs
874
return ((getattr(athing.__get__(self), "_dbus_name",
876
athing.__get__(self))
877
for cls in self.__class__.__mro__
879
inspect.getmembers(cls,
880
self._is_dbus_thing(thing)))
882
def _get_dbus_property(self, interface_name, property_name):
883
"""Returns a bound method if one exists which is a D-Bus
884
property with the specified name and interface.
886
for cls in self.__class__.__mro__:
887
for name, value in (inspect.getmembers
889
self._is_dbus_thing("property"))):
890
if (value._dbus_name == property_name
891
and value._dbus_interface == interface_name):
892
return value.__get__(self)
895
raise DBusPropertyNotFound(self.dbus_object_path + ":"
896
+ interface_name + "."
899
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
901
def Get(self, interface_name, property_name):
902
"""Standard D-Bus property Get() method, see D-Bus standard.
904
prop = self._get_dbus_property(interface_name, property_name)
905
if prop._dbus_access == "write":
906
raise DBusPropertyAccessException(property_name)
908
if not hasattr(value, "variant_level"):
910
return type(value)(value, variant_level=value.variant_level+1)
912
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
913
def Set(self, interface_name, property_name, value):
914
"""Standard D-Bus property Set() method, see D-Bus standard.
916
prop = self._get_dbus_property(interface_name, property_name)
917
if prop._dbus_access == "read":
918
raise DBusPropertyAccessException(property_name)
919
if prop._dbus_get_args_options["byte_arrays"]:
920
# The byte_arrays option is not supported yet on
921
# signatures other than "ay".
922
if prop._dbus_signature != "ay":
923
raise ValueError("Byte arrays not supported for non-"
924
"'ay' signature {!r}"
925
.format(prop._dbus_signature))
926
value = dbus.ByteArray(b''.join(chr(byte)
930
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
931
out_signature="a{sv}")
932
def GetAll(self, interface_name):
933
"""Standard D-Bus property GetAll() method, see D-Bus
936
Note: Will not include properties with access="write".
939
for name, prop in self._get_all_dbus_things("property"):
941
and interface_name != prop._dbus_interface):
942
# Interface non-empty but did not match
944
# Ignore write-only properties
945
if prop._dbus_access == "write":
948
if not hasattr(value, "variant_level"):
949
properties[name] = value
951
properties[name] = type(value)(value, variant_level=
952
value.variant_level+1)
953
return dbus.Dictionary(properties, signature="sv")
955
@dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
956
def PropertiesChanged(self, interface_name, changed_properties,
957
invalidated_properties):
958
"""Standard D-Bus PropertiesChanged() signal, see D-Bus
963
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
965
path_keyword='object_path',
966
connection_keyword='connection')
967
def Introspect(self, object_path, connection):
968
"""Overloading of standard D-Bus method.
970
Inserts property tags and interface annotation tags.
972
xmlstring = dbus.service.Object.Introspect(self, object_path,
975
document = xml.dom.minidom.parseString(xmlstring)
976
def make_tag(document, name, prop):
977
e = document.createElement("property")
978
e.setAttribute("name", name)
979
e.setAttribute("type", prop._dbus_signature)
980
e.setAttribute("access", prop._dbus_access)
982
for if_tag in document.getElementsByTagName("interface"):
984
for tag in (make_tag(document, name, prop)
986
in self._get_all_dbus_things("property")
987
if prop._dbus_interface
988
== if_tag.getAttribute("name")):
989
if_tag.appendChild(tag)
990
# Add annotation tags
991
for typ in ("method", "signal", "property"):
992
for tag in if_tag.getElementsByTagName(typ):
994
for name, prop in (self.
995
_get_all_dbus_things(typ)):
996
if (name == tag.getAttribute("name")
997
and prop._dbus_interface
998
== if_tag.getAttribute("name")):
999
annots.update(getattr
1001
"_dbus_annotations",
1003
for name, value in annots.items():
1004
ann_tag = document.createElement(
1006
ann_tag.setAttribute("name", name)
1007
ann_tag.setAttribute("value", value)
1008
tag.appendChild(ann_tag)
1009
# Add interface annotation tags
1010
for annotation, value in dict(
1011
itertools.chain.from_iterable(
1012
annotations().items()
1013
for name, annotations in
1014
self._get_all_dbus_things("interface")
1015
if name == if_tag.getAttribute("name")
1017
ann_tag = document.createElement("annotation")
1018
ann_tag.setAttribute("name", annotation)
1019
ann_tag.setAttribute("value", value)
1020
if_tag.appendChild(ann_tag)
1021
# Add the names to the return values for the
1022
# "org.freedesktop.DBus.Properties" methods
1023
if (if_tag.getAttribute("name")
1024
== "org.freedesktop.DBus.Properties"):
1025
for cn in if_tag.getElementsByTagName("method"):
1026
if cn.getAttribute("name") == "Get":
1027
for arg in cn.getElementsByTagName("arg"):
1028
if (arg.getAttribute("direction")
1030
arg.setAttribute("name", "value")
1031
elif cn.getAttribute("name") == "GetAll":
1032
for arg in cn.getElementsByTagName("arg"):
1033
if (arg.getAttribute("direction")
1035
arg.setAttribute("name", "props")
1036
xmlstring = document.toxml("utf-8")
1038
except (AttributeError, xml.dom.DOMException,
1039
xml.parsers.expat.ExpatError) as error:
1040
logger.error("Failed to override Introspection method",
1045
def datetime_to_dbus(dt, variant_level=0):
1046
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1048
return dbus.String("", variant_level = variant_level)
1049
return dbus.String(dt.isoformat(),
1050
variant_level=variant_level)
1053
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1054
"""A class decorator; applied to a subclass of
1055
dbus.service.Object, it will add alternate D-Bus attributes with
1056
interface names according to the "alt_interface_names" mapping.
1059
@alternate_dbus_interfaces({"org.example.Interface":
1060
"net.example.AlternateInterface"})
1061
class SampleDBusObject(dbus.service.Object):
1062
@dbus.service.method("org.example.Interface")
1063
def SampleDBusMethod():
1066
The above "SampleDBusMethod" on "SampleDBusObject" will be
1067
reachable via two interfaces: "org.example.Interface" and
1068
"net.example.AlternateInterface", the latter of which will have
1069
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1070
"true", unless "deprecate" is passed with a False value.
1072
This works for methods and signals, and also for D-Bus properties
1073
(from DBusObjectWithProperties) and interfaces (from the
1074
dbus_interface_annotations decorator).
1077
for orig_interface_name, alt_interface_name in (
1078
alt_interface_names.items()):
1080
interface_names = set()
1081
# Go though all attributes of the class
1082
for attrname, attribute in inspect.getmembers(cls):
1083
# Ignore non-D-Bus attributes, and D-Bus attributes
1084
# with the wrong interface name
1085
if (not hasattr(attribute, "_dbus_interface")
1086
or not attribute._dbus_interface
1087
.startswith(orig_interface_name)):
1089
# Create an alternate D-Bus interface name based on
1091
alt_interface = (attribute._dbus_interface
1092
.replace(orig_interface_name,
1093
alt_interface_name))
1094
interface_names.add(alt_interface)
1095
# Is this a D-Bus signal?
1096
if getattr(attribute, "_dbus_is_signal", False):
1097
# Extract the original non-method undecorated
1098
# function by black magic
1099
nonmethod_func = (dict(
1100
zip(attribute.func_code.co_freevars,
1101
attribute.__closure__))["func"]
1103
# Create a new, but exactly alike, function
1104
# object, and decorate it to be a new D-Bus signal
1105
# with the alternate D-Bus interface name
1106
new_function = (dbus.service.signal
1108
attribute._dbus_signature)
1109
(types.FunctionType(
1110
nonmethod_func.func_code,
1111
nonmethod_func.func_globals,
1112
nonmethod_func.func_name,
1113
nonmethod_func.func_defaults,
1114
nonmethod_func.func_closure)))
1115
# Copy annotations, if any
1117
new_function._dbus_annotations = (
1118
dict(attribute._dbus_annotations))
1119
except AttributeError:
1121
# Define a creator of a function to call both the
1122
# original and alternate functions, so both the
1123
# original and alternate signals gets sent when
1124
# the function is called
1125
def fixscope(func1, func2):
1126
"""This function is a scope container to pass
1127
func1 and func2 to the "call_both" function
1128
outside of its arguments"""
1129
def call_both(*args, **kwargs):
1130
"""This function will emit two D-Bus
1131
signals by calling func1 and func2"""
1132
func1(*args, **kwargs)
1133
func2(*args, **kwargs)
1135
# Create the "call_both" function and add it to
1137
attr[attrname] = fixscope(attribute, new_function)
1138
# Is this a D-Bus method?
1139
elif getattr(attribute, "_dbus_is_method", False):
1140
# Create a new, but exactly alike, function
1141
# object. Decorate it to be a new D-Bus method
1142
# with the alternate D-Bus interface name. Add it
1144
attr[attrname] = (dbus.service.method
1146
attribute._dbus_in_signature,
1147
attribute._dbus_out_signature)
1149
(attribute.func_code,
1150
attribute.func_globals,
1151
attribute.func_name,
1152
attribute.func_defaults,
1153
attribute.func_closure)))
1154
# Copy annotations, if any
1156
attr[attrname]._dbus_annotations = (
1157
dict(attribute._dbus_annotations))
1158
except AttributeError:
1160
# Is this a D-Bus property?
1161
elif getattr(attribute, "_dbus_is_property", False):
1162
# Create a new, but exactly alike, function
1163
# object, and decorate it to be a new D-Bus
1164
# property with the alternate D-Bus interface
1165
# name. Add it to the class.
1166
attr[attrname] = (dbus_service_property
1168
attribute._dbus_signature,
1169
attribute._dbus_access,
1171
._dbus_get_args_options
1174
(attribute.func_code,
1175
attribute.func_globals,
1176
attribute.func_name,
1177
attribute.func_defaults,
1178
attribute.func_closure)))
1179
# Copy annotations, if any
1181
attr[attrname]._dbus_annotations = (
1182
dict(attribute._dbus_annotations))
1183
except AttributeError:
1185
# Is this a D-Bus interface?
1186
elif getattr(attribute, "_dbus_is_interface", False):
1187
# Create a new, but exactly alike, function
1188
# object. Decorate it to be a new D-Bus interface
1189
# with the alternate D-Bus interface name. Add it
1191
attr[attrname] = (dbus_interface_annotations
1194
(attribute.func_code,
1195
attribute.func_globals,
1196
attribute.func_name,
1197
attribute.func_defaults,
1198
attribute.func_closure)))
1200
# Deprecate all alternate interfaces
1201
iname="_AlternateDBusNames_interface_annotation{}"
1202
for interface_name in interface_names:
1203
@dbus_interface_annotations(interface_name)
1205
return { "org.freedesktop.DBus.Deprecated":
1207
# Find an unused name
1208
for aname in (iname.format(i)
1209
for i in itertools.count()):
1210
if aname not in attr:
1214
# Replace the class with a new subclass of it with
1215
# methods, signals, etc. as created above.
1216
cls = type(b"{}Alternate".format(cls.__name__),
1222
@alternate_dbus_interfaces({"se.recompile.Mandos":
1223
"se.bsnet.fukt.Mandos"})
1224
class ClientDBus(Client, DBusObjectWithProperties):
1225
"""A Client class using D-Bus
1228
dbus_object_path: dbus.ObjectPath
1229
bus: dbus.SystemBus()
1232
runtime_expansions = (Client.runtime_expansions
1233
+ ("dbus_object_path",))
1235
_interface = "se.recompile.Mandos.Client"
1237
# dbus.service.Object doesn't use super(), so we can't either.
1239
def __init__(self, bus = None, *args, **kwargs):
1241
Client.__init__(self, *args, **kwargs)
1242
# Only now, when this client is initialized, can it show up on
1244
client_object_name = str(self.name).translate(
1245
{ord("."): ord("_"),
1246
ord("-"): ord("_")})
1247
self.dbus_object_path = (dbus.ObjectPath
1248
("/clients/" + client_object_name))
1249
DBusObjectWithProperties.__init__(self, self.bus,
1250
self.dbus_object_path)
1252
def notifychangeproperty(transform_func,
1253
dbus_name, type_func=lambda x: x,
1254
variant_level=1, invalidate_only=False,
1255
_interface=_interface):
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 = "_{}".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)):
1273
self.PropertiesChanged(_interface,
1278
dbus_value = transform_func(type_func(value),
1281
self.PropertyChanged(dbus.String(dbus_name),
1283
self.PropertiesChanged(_interface,
1285
dbus.String(dbus_name):
1286
dbus_value }), dbus.Array())
1287
setattr(self, attrname, value)
1289
return property(lambda self: getattr(self, attrname), setter)
1291
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1292
approvals_pending = notifychangeproperty(dbus.Boolean,
1295
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1296
last_enabled = notifychangeproperty(datetime_to_dbus,
1298
checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1299
type_func = lambda checker:
1300
checker is not None)
1301
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1303
last_checker_status = notifychangeproperty(dbus.Int16,
1304
"LastCheckerStatus")
1305
last_approval_request = notifychangeproperty(
1306
datetime_to_dbus, "LastApprovalRequest")
1307
approved_by_default = notifychangeproperty(dbus.Boolean,
1308
"ApprovedByDefault")
1309
approval_delay = notifychangeproperty(dbus.UInt64,
1312
lambda td: td.total_seconds()
1314
approval_duration = notifychangeproperty(
1315
dbus.UInt64, "ApprovalDuration",
1316
type_func = lambda td: td.total_seconds() * 1000)
1317
host = notifychangeproperty(dbus.String, "Host")
1318
timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1319
type_func = lambda td:
1320
td.total_seconds() * 1000)
1321
extended_timeout = notifychangeproperty(
1322
dbus.UInt64, "ExtendedTimeout",
1323
type_func = lambda td: td.total_seconds() * 1000)
1324
interval = notifychangeproperty(dbus.UInt64,
1327
lambda td: td.total_seconds()
1329
checker_command = notifychangeproperty(dbus.String, "Checker")
1330
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1331
invalidate_only=True)
1333
del notifychangeproperty
1335
def __del__(self, *args, **kwargs):
1337
self.remove_from_connection()
1340
if hasattr(DBusObjectWithProperties, "__del__"):
1341
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1342
Client.__del__(self, *args, **kwargs)
1344
def checker_callback(self, pid, condition, command,
1346
self.checker_callback_tag = None
1348
if os.WIFEXITED(condition):
1349
exitstatus = os.WEXITSTATUS(condition)
1351
self.CheckerCompleted(dbus.Int16(exitstatus),
1352
dbus.Int64(condition),
1353
dbus.String(command))
1356
self.CheckerCompleted(dbus.Int16(-1),
1357
dbus.Int64(condition),
1358
dbus.String(command))
1360
return Client.checker_callback(self, pid, condition, command,
1363
def start_checker(self, *args, **kwargs):
1364
old_checker_pid = getattr(self.checker, "pid", None)
1365
r = Client.start_checker(self, *args, **kwargs)
1366
# Only if new checker process was started
1367
if (self.checker is not None
1368
and old_checker_pid != self.checker.pid):
1370
self.CheckerStarted(self.current_checker_command)
1373
def _reset_approved(self):
1374
self.approved = None
1377
def approve(self, value=True):
1378
self.approved = value
1379
gobject.timeout_add(int(self.approval_duration.total_seconds()
1380
* 1000), self._reset_approved)
1381
self.send_changedstate()
1383
## D-Bus methods, signals & properties
1389
# CheckerCompleted - signal
1390
@dbus.service.signal(_interface, signature="nxs")
1391
def CheckerCompleted(self, exitcode, waitstatus, command):
1395
# CheckerStarted - signal
1396
@dbus.service.signal(_interface, signature="s")
1397
def CheckerStarted(self, command):
1401
# PropertyChanged - signal
1402
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1403
@dbus.service.signal(_interface, signature="sv")
1404
def PropertyChanged(self, property, value):
1408
# GotSecret - signal
1409
@dbus.service.signal(_interface)
1410
def GotSecret(self):
1412
Is sent after a successful transfer of secret from the Mandos
1413
server to mandos-client
1418
@dbus.service.signal(_interface, signature="s")
1419
def Rejected(self, reason):
1423
# NeedApproval - signal
1424
@dbus.service.signal(_interface, signature="tb")
1425
def NeedApproval(self, timeout, default):
1427
return self.need_approval()
1432
@dbus.service.method(_interface, in_signature="b")
1433
def Approve(self, value):
1436
# CheckedOK - method
1437
@dbus.service.method(_interface)
1438
def CheckedOK(self):
1442
@dbus.service.method(_interface)
1447
# StartChecker - method
1448
@dbus.service.method(_interface)
1449
def StartChecker(self):
1451
self.start_checker()
1454
@dbus.service.method(_interface)
1459
# StopChecker - method
1460
@dbus.service.method(_interface)
1461
def StopChecker(self):
1466
# ApprovalPending - property
1467
@dbus_service_property(_interface, signature="b", access="read")
1468
def ApprovalPending_dbus_property(self):
1469
return dbus.Boolean(bool(self.approvals_pending))
1471
# ApprovedByDefault - property
1472
@dbus_service_property(_interface, signature="b",
1474
def ApprovedByDefault_dbus_property(self, value=None):
1475
if value is None: # get
1476
return dbus.Boolean(self.approved_by_default)
1477
self.approved_by_default = bool(value)
1479
# ApprovalDelay - property
1480
@dbus_service_property(_interface, signature="t",
1482
def ApprovalDelay_dbus_property(self, value=None):
1483
if value is None: # get
1484
return dbus.UInt64(self.approval_delay.total_seconds()
1486
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1488
# ApprovalDuration - property
1489
@dbus_service_property(_interface, signature="t",
1491
def ApprovalDuration_dbus_property(self, value=None):
1492
if value is None: # get
1493
return dbus.UInt64(self.approval_duration.total_seconds()
1495
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1498
@dbus_service_property(_interface, signature="s", access="read")
1499
def Name_dbus_property(self):
1500
return dbus.String(self.name)
1502
# Fingerprint - property
1503
@dbus_service_property(_interface, signature="s", access="read")
1504
def Fingerprint_dbus_property(self):
1505
return dbus.String(self.fingerprint)
1508
@dbus_service_property(_interface, signature="s",
1510
def Host_dbus_property(self, value=None):
1511
if value is None: # get
1512
return dbus.String(self.host)
1513
self.host = str(value)
1515
# Created - property
1516
@dbus_service_property(_interface, signature="s", access="read")
1517
def Created_dbus_property(self):
1518
return datetime_to_dbus(self.created)
1520
# LastEnabled - property
1521
@dbus_service_property(_interface, signature="s", access="read")
1522
def LastEnabled_dbus_property(self):
1523
return datetime_to_dbus(self.last_enabled)
1525
# Enabled - property
1526
@dbus_service_property(_interface, signature="b",
1528
def Enabled_dbus_property(self, value=None):
1529
if value is None: # get
1530
return dbus.Boolean(self.enabled)
1536
# LastCheckedOK - property
1537
@dbus_service_property(_interface, signature="s",
1539
def LastCheckedOK_dbus_property(self, value=None):
1540
if value is not None:
1543
return datetime_to_dbus(self.last_checked_ok)
1545
# LastCheckerStatus - property
1546
@dbus_service_property(_interface, signature="n",
1548
def LastCheckerStatus_dbus_property(self):
1549
return dbus.Int16(self.last_checker_status)
1551
# Expires - property
1552
@dbus_service_property(_interface, signature="s", access="read")
1553
def Expires_dbus_property(self):
1554
return datetime_to_dbus(self.expires)
1556
# LastApprovalRequest - property
1557
@dbus_service_property(_interface, signature="s", access="read")
1558
def LastApprovalRequest_dbus_property(self):
1559
return datetime_to_dbus(self.last_approval_request)
1561
# Timeout - property
1562
@dbus_service_property(_interface, signature="t",
1564
def Timeout_dbus_property(self, value=None):
1565
if value is None: # get
1566
return dbus.UInt64(self.timeout.total_seconds() * 1000)
1567
old_timeout = self.timeout
1568
self.timeout = datetime.timedelta(0, 0, 0, value)
1569
# Reschedule disabling
1571
now = datetime.datetime.utcnow()
1572
self.expires += self.timeout - old_timeout
1573
if self.expires <= now:
1574
# The timeout has passed
1577
if (getattr(self, "disable_initiator_tag", None)
1580
gobject.source_remove(self.disable_initiator_tag)
1581
self.disable_initiator_tag = (
1582
gobject.timeout_add(
1583
int((self.expires - now).total_seconds()
1584
* 1000), self.disable))
1586
# ExtendedTimeout - property
1587
@dbus_service_property(_interface, signature="t",
1589
def ExtendedTimeout_dbus_property(self, value=None):
1590
if value is None: # get
1591
return dbus.UInt64(self.extended_timeout.total_seconds()
1593
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1595
# Interval - property
1596
@dbus_service_property(_interface, signature="t",
1598
def Interval_dbus_property(self, value=None):
1599
if value is None: # get
1600
return dbus.UInt64(self.interval.total_seconds() * 1000)
1601
self.interval = datetime.timedelta(0, 0, 0, value)
1602
if getattr(self, "checker_initiator_tag", None) is None:
1605
# Reschedule checker run
1606
gobject.source_remove(self.checker_initiator_tag)
1607
self.checker_initiator_tag = (gobject.timeout_add
1608
(value, self.start_checker))
1609
self.start_checker() # Start one now, too
1611
# Checker - property
1612
@dbus_service_property(_interface, signature="s",
1614
def Checker_dbus_property(self, value=None):
1615
if value is None: # get
1616
return dbus.String(self.checker_command)
1617
self.checker_command = str(value)
1619
# CheckerRunning - property
1620
@dbus_service_property(_interface, signature="b",
1622
def CheckerRunning_dbus_property(self, value=None):
1623
if value is None: # get
1624
return dbus.Boolean(self.checker is not None)
1626
self.start_checker()
1630
# ObjectPath - property
1631
@dbus_service_property(_interface, signature="o", access="read")
1632
def ObjectPath_dbus_property(self):
1633
return self.dbus_object_path # is already a dbus.ObjectPath
1636
@dbus_service_property(_interface, signature="ay",
1637
access="write", byte_arrays=True)
1638
def Secret_dbus_property(self, value):
1639
self.secret = bytes(value)
1644
class ProxyClient(object):
1645
def __init__(self, child_pipe, fpr, address):
1646
self._pipe = child_pipe
1647
self._pipe.send(('init', fpr, address))
1648
if not self._pipe.recv():
1651
def __getattribute__(self, name):
1653
return super(ProxyClient, self).__getattribute__(name)
1654
self._pipe.send(('getattr', name))
1655
data = self._pipe.recv()
1656
if data[0] == 'data':
1658
if data[0] == 'function':
1659
def func(*args, **kwargs):
1660
self._pipe.send(('funcall', name, args, kwargs))
1661
return self._pipe.recv()[1]
1664
def __setattr__(self, name, value):
1666
return super(ProxyClient, self).__setattr__(name, value)
1667
self._pipe.send(('setattr', name, value))
1670
class ClientHandler(socketserver.BaseRequestHandler, object):
1671
"""A class to handle client connections.
1673
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.
1674
431
Note: This will run in its own forked process."""
1676
433
def handle(self):
1677
with contextlib.closing(self.server.child_pipe) as child_pipe:
1678
logger.info("TCP connection from: %s",
1679
str(self.client_address))
1680
logger.debug("Pipe FD: %d",
1681
self.server.child_pipe.fileno())
1683
session = (gnutls.connection
1684
.ClientSession(self.request,
1686
.X509Credentials()))
1688
# Note: gnutls.connection.X509Credentials is really a
1689
# generic GnuTLS certificate credentials object so long as
1690
# no X.509 keys are added to it. Therefore, we can use it
1691
# here despite using OpenPGP certificates.
1693
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1694
# "+AES-256-CBC", "+SHA1",
1695
# "+COMP-NULL", "+CTYPE-OPENPGP",
1697
# Use a fallback default, since this MUST be set.
1698
priority = self.server.gnutls_priority
1699
if priority is None:
1701
(gnutls.library.functions
1702
.gnutls_priority_set_direct(session._c_object,
1705
# Start communication using the Mandos protocol
1706
# Get protocol number
1707
line = self.request.makefile().readline()
1708
logger.debug("Protocol version: %r", line)
1710
if int(line.strip().split()[0]) > 1:
1711
raise RuntimeError(line)
1712
except (ValueError, IndexError, RuntimeError) as error:
1713
logger.error("Unknown protocol version: %s", error)
1716
# Start GnuTLS connection
1719
except gnutls.errors.GNUTLSError as error:
1720
logger.warning("Handshake failed: %s", error)
1721
# Do not run session.bye() here: the session is not
1722
# established. Just abandon the request.
1724
logger.debug("Handshake succeeded")
1726
approval_required = False
1729
fpr = self.fingerprint(self.peer_certificate
1732
gnutls.errors.GNUTLSError) as error:
1733
logger.warning("Bad certificate: %s", error)
1735
logger.debug("Fingerprint: %s", fpr)
1738
client = ProxyClient(child_pipe, fpr,
1739
self.client_address)
1743
if client.approval_delay:
1744
delay = client.approval_delay
1745
client.approvals_pending += 1
1746
approval_required = True
1749
if not client.enabled:
1750
logger.info("Client %s is disabled",
1752
if self.server.use_dbus:
1754
client.Rejected("Disabled")
1757
if client.approved or not client.approval_delay:
1758
#We are approved or approval is disabled
1760
elif client.approved is None:
1761
logger.info("Client %s needs approval",
1763
if self.server.use_dbus:
1765
client.NeedApproval(
1766
client.approval_delay.total_seconds()
1767
* 1000, client.approved_by_default)
1769
logger.warning("Client %s was not approved",
1771
if self.server.use_dbus:
1773
client.Rejected("Denied")
1776
#wait until timeout or approved
1777
time = datetime.datetime.now()
1778
client.changedstate.acquire()
1779
client.changedstate.wait(delay.total_seconds())
1780
client.changedstate.release()
1781
time2 = datetime.datetime.now()
1782
if (time2 - time) >= delay:
1783
if not client.approved_by_default:
1784
logger.warning("Client %s timed out while"
1785
" waiting for approval",
1787
if self.server.use_dbus:
1789
client.Rejected("Approval timed out")
1794
delay -= time2 - time
1797
while sent_size < len(client.secret):
1799
sent = session.send(client.secret[sent_size:])
1800
except gnutls.errors.GNUTLSError as error:
1801
logger.warning("gnutls send failed",
1804
logger.debug("Sent: %d, remaining: %d",
1805
sent, len(client.secret)
1806
- (sent_size + sent))
1809
logger.info("Sending secret to %s", client.name)
1810
# bump the timeout using extended_timeout
1811
client.bump_timeout(client.extended_timeout)
1812
if self.server.use_dbus:
1817
if approval_required:
1818
client.approvals_pending -= 1
1821
except gnutls.errors.GNUTLSError as error:
1822
logger.warning("GnuTLS bye failed",
1826
def peer_certificate(session):
1827
"Return the peer's OpenPGP certificate as a bytestring"
1828
# If not an OpenPGP certificate...
1829
if (gnutls.library.functions
1830
.gnutls_certificate_type_get(session._c_object)
1831
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1832
# ...do the normal thing
1833
return session.peer_certificate
1834
list_size = ctypes.c_uint(1)
1835
cert_list = (gnutls.library.functions
1836
.gnutls_certificate_get_peers
1837
(session._c_object, ctypes.byref(list_size)))
1838
if not bool(cert_list) and list_size.value != 0:
1839
raise gnutls.errors.GNUTLSError("error getting peer"
1841
if list_size.value == 0:
1844
return ctypes.string_at(cert.data, cert.size)
1847
def fingerprint(openpgp):
1848
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
1849
# New GnuTLS "datum" with the OpenPGP public key
1850
datum = (gnutls.library.types
1851
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1854
ctypes.c_uint(len(openpgp))))
1855
# New empty GnuTLS certificate
1856
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1857
(gnutls.library.functions
1858
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
1859
# Import the OpenPGP public key into the certificate
1860
(gnutls.library.functions
1861
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1862
gnutls.library.constants
1863
.GNUTLS_OPENPGP_FMT_RAW))
1864
# Verify the self signature in the key
1865
crtverify = ctypes.c_uint()
1866
(gnutls.library.functions
1867
.gnutls_openpgp_crt_verify_self(crt, 0,
1868
ctypes.byref(crtverify)))
1869
if crtverify.value != 0:
1870
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1871
raise (gnutls.errors.CertificateSecurityError
1873
# New buffer for the fingerprint
1874
buf = ctypes.create_string_buffer(20)
1875
buf_len = ctypes.c_size_t()
1876
# Get the fingerprint from the certificate into the buffer
1877
(gnutls.library.functions
1878
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1879
ctypes.byref(buf_len)))
1880
# Deinit the certificate
1881
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1882
# Convert the buffer to a Python bytestring
1883
fpr = ctypes.string_at(buf, buf_len.value)
1884
# Convert the bytestring to hexadecimal notation
1885
hex_fpr = binascii.hexlify(fpr).upper()
1889
class MultiprocessingMixIn(object):
1890
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
1891
def sub_process_main(self, request, address):
1893
self.finish_request(request, address)
1895
self.handle_error(request, address)
1896
self.close_request(request)
1898
def process_request(self, request, address):
1899
"""Start a new process to process the request."""
1900
proc = multiprocessing.Process(target = self.sub_process_main,
1901
args = (request, address))
1906
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1907
""" adds a pipe to the MixIn """
1908
def process_request(self, request, client_address):
1909
"""Overrides and wraps the original process_request().
1911
This function creates a new pipe in self.pipe
1913
parent_pipe, self.child_pipe = multiprocessing.Pipe()
1915
proc = MultiprocessingMixIn.process_request(self, request,
1917
self.child_pipe.close()
1918
self.add_pipe(parent_pipe, proc)
1920
def add_pipe(self, parent_pipe, proc):
1921
"""Dummy function; override as necessary"""
1922
raise NotImplementedError()
1925
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1926
socketserver.TCPServer, object):
1927
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
434
logger.debug(u"TCP connection from: %s",
435
unicode(self.client_address))
436
session = gnutls.connection.ClientSession\
437
(self.request, gnutls.connection.X509Credentials())
438
# Note: gnutls.connection.X509Credentials is really a generic
439
# GnuTLS certificate credentials object so long as no X.509
440
# keys are added to it. Therefore, we can use it here despite
441
# using OpenPGP certificates.
443
#priority = ':'.join(("NONE", "+VERS-TLS1.1", "+AES-256-CBC",
444
# "+SHA1", "+COMP-NULL", "+CTYPE-OPENPGP",
446
priority = "NORMAL" # Fallback default, since this
448
if self.server.settings["priority"]:
449
priority = self.server.settings["priority"]
450
gnutls.library.functions.gnutls_priority_set_direct\
451
(session._c_object, priority, None);
455
except gnutls.errors.GNUTLSError, error:
456
logger.debug(u"Handshake failed: %s", error)
457
# Do not run session.bye() here: the session is not
458
# established. Just abandon the request.
461
fpr = fingerprint(peer_certificate(session))
462
except (TypeError, gnutls.errors.GNUTLSError), error:
463
logger.debug(u"Bad certificate: %s", error)
466
logger.debug(u"Fingerprint: %s", fpr)
468
for c in self.server.clients:
469
if c.fingerprint == fpr:
473
logger.debug(u"Client not found for fingerprint: %s", fpr)
476
# Have to check if client.still_valid(), since it is possible
477
# that the client timed out while establishing the GnuTLS
479
if not client.still_valid():
480
logger.debug(u"Client %(name)s is invalid", vars(client))
484
while sent_size < len(client.secret):
485
sent = session.send(client.secret[sent_size:])
486
logger.debug(u"Sent: %d, remaining: %d",
487
sent, len(client.secret)
488
- (sent_size + sent))
493
class IPv6_TCPServer(SocketServer.ForkingTCPServer, object):
494
"""IPv6 TCP server. Accepts 'None' as address and/or port.
1930
enabled: Boolean; whether this server is activated yet
1931
interface: None or a network interface name (string)
1932
use_ipv6: Boolean; to use IPv6 or not
496
settings: Server settings
497
clients: Set() of Client objects
1934
def __init__(self, server_address, RequestHandlerClass,
1935
interface=None, use_ipv6=True, socketfd=None):
1936
"""If socketfd is set, use that file descriptor instead of
1937
creating a new one with socket.socket().
1939
self.interface = interface
1941
self.address_family = socket.AF_INET6
1942
if socketfd is not None:
1943
# Save the file descriptor
1944
self.socketfd = socketfd
1945
# Save the original socket.socket() function
1946
self.socket_socket = socket.socket
1947
# To implement --socket, we monkey patch socket.socket.
1949
# (When socketserver.TCPServer is a new-style class, we
1950
# could make self.socket into a property instead of monkey
1951
# patching socket.socket.)
1953
# Create a one-time-only replacement for socket.socket()
1954
@functools.wraps(socket.socket)
1955
def socket_wrapper(*args, **kwargs):
1956
# Restore original function so subsequent calls are
1958
socket.socket = self.socket_socket
1959
del self.socket_socket
1960
# This time only, return a new socket object from the
1961
# saved file descriptor.
1962
return socket.fromfd(self.socketfd, *args, **kwargs)
1963
# Replace socket.socket() function with wrapper
1964
socket.socket = socket_wrapper
1965
# The socketserver.TCPServer.__init__ will call
1966
# socket.socket(), which might be our replacement,
1967
# socket_wrapper(), if socketfd was set.
1968
socketserver.TCPServer.__init__(self, server_address,
1969
RequestHandlerClass)
499
address_family = socket.AF_INET6
500
def __init__(self, *args, **kwargs):
501
if "settings" in kwargs:
502
self.settings = kwargs["settings"]
503
del kwargs["settings"]
504
if "clients" in kwargs:
505
self.clients = kwargs["clients"]
506
del kwargs["clients"]
507
return super(type(self), self).__init__(*args, **kwargs)
1971
508
def server_bind(self):
1972
509
"""This overrides the normal server_bind() function
1973
510
to bind to an interface if one was specified, and also NOT to
1974
511
bind to an address or port if they were not specified."""
1975
if self.interface is not None:
1976
if SO_BINDTODEVICE is None:
1977
logger.error("SO_BINDTODEVICE does not exist;"
1978
" cannot bind to interface %s",
1982
self.socket.setsockopt(socket.SOL_SOCKET,
1984
(self.interface + "\0")
1986
except socket.error as error:
1987
if error.errno == errno.EPERM:
1988
logger.error("No permission to bind to"
1989
" interface %s", self.interface)
1990
elif error.errno == errno.ENOPROTOOPT:
1991
logger.error("SO_BINDTODEVICE not available;"
1992
" cannot bind to interface %s",
1994
elif error.errno == errno.ENODEV:
1995
logger.error("Interface %s does not exist,"
1996
" cannot bind", self.interface)
512
if self.settings["interface"]:
513
# 25 is from /usr/include/asm-i486/socket.h
514
SO_BINDTODEVICE = getattr(socket, "SO_BINDTODEVICE", 25)
516
self.socket.setsockopt(socket.SOL_SOCKET,
518
self.settings["interface"])
519
except socket.error, error:
520
if error[0] == errno.EPERM:
521
logger.warning(u"No permission to"
522
u" bind to interface %s",
523
self.settings["interface"])
1999
526
# Only bind(2) the socket if we really need to.
2000
527
if self.server_address[0] or self.server_address[1]:
2001
528
if not self.server_address[0]:
2002
if self.address_family == socket.AF_INET6:
2003
any_address = "::" # in6addr_any
2005
any_address = "0.0.0.0" # INADDR_ANY
2006
self.server_address = (any_address,
530
self.server_address = (in6addr_any,
2007
531
self.server_address[1])
2008
elif not self.server_address[1]:
532
elif self.server_address[1] is None:
2009
533
self.server_address = (self.server_address[0],
2011
# if self.interface:
2012
# self.server_address = (self.server_address[0],
2017
return socketserver.TCPServer.server_bind(self)
2020
class MandosServer(IPv6_TCPServer):
2024
clients: set of Client objects
2025
gnutls_priority GnuTLS priority string
2026
use_dbus: Boolean; to emit D-Bus signals or not
2028
Assumes a gobject.MainLoop event loop.
2030
def __init__(self, server_address, RequestHandlerClass,
2031
interface=None, use_ipv6=True, clients=None,
2032
gnutls_priority=None, use_dbus=True, socketfd=None):
2033
self.enabled = False
2034
self.clients = clients
2035
if self.clients is None:
2037
self.use_dbus = use_dbus
2038
self.gnutls_priority = gnutls_priority
2039
IPv6_TCPServer.__init__(self, server_address,
2040
RequestHandlerClass,
2041
interface = interface,
2042
use_ipv6 = use_ipv6,
2043
socketfd = socketfd)
2044
def server_activate(self):
2046
return socketserver.TCPServer.server_activate(self)
2051
def add_pipe(self, parent_pipe, proc):
2052
# Call "handle_ipc" for both data and EOF events
2053
gobject.io_add_watch(parent_pipe.fileno(),
2054
gobject.IO_IN | gobject.IO_HUP,
2055
functools.partial(self.handle_ipc,
2060
def handle_ipc(self, source, condition, parent_pipe=None,
2061
proc = None, client_object=None):
2062
# error, or the other end of multiprocessing.Pipe has closed
2063
if condition & (gobject.IO_ERR | gobject.IO_HUP):
2064
# Wait for other process to exit
2068
# Read a request from the child
2069
request = parent_pipe.recv()
2070
command = request[0]
2072
if command == 'init':
2074
address = request[2]
2076
for c in self.clients.itervalues():
2077
if c.fingerprint == fpr:
2081
logger.info("Client not found for fingerprint: %s, ad"
2082
"dress: %s", fpr, address)
2085
mandos_dbus_service.ClientNotFound(fpr,
2087
parent_pipe.send(False)
2090
gobject.io_add_watch(parent_pipe.fileno(),
2091
gobject.IO_IN | gobject.IO_HUP,
2092
functools.partial(self.handle_ipc,
2098
parent_pipe.send(True)
2099
# remove the old hook in favor of the new above hook on
2102
if command == 'funcall':
2103
funcname = request[1]
2107
parent_pipe.send(('data', getattr(client_object,
2111
if command == 'getattr':
2112
attrname = request[1]
2113
if callable(client_object.__getattribute__(attrname)):
2114
parent_pipe.send(('function',))
2116
parent_pipe.send(('data', client_object
2117
.__getattribute__(attrname)))
2119
if command == 'setattr':
2120
attrname = request[1]
2122
setattr(client_object, attrname, value)
2127
def rfc3339_duration_to_delta(duration):
2128
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2130
>>> rfc3339_duration_to_delta("P7D")
2131
datetime.timedelta(7)
2132
>>> rfc3339_duration_to_delta("PT60S")
2133
datetime.timedelta(0, 60)
2134
>>> rfc3339_duration_to_delta("PT60M")
2135
datetime.timedelta(0, 3600)
2136
>>> rfc3339_duration_to_delta("PT24H")
2137
datetime.timedelta(1)
2138
>>> rfc3339_duration_to_delta("P1W")
2139
datetime.timedelta(7)
2140
>>> rfc3339_duration_to_delta("PT5M30S")
2141
datetime.timedelta(0, 330)
2142
>>> rfc3339_duration_to_delta("P1DT3M20S")
2143
datetime.timedelta(1, 200)
2146
# Parsing an RFC 3339 duration with regular expressions is not
2147
# possible - there would have to be multiple places for the same
2148
# values, like seconds. The current code, while more esoteric, is
2149
# cleaner without depending on a parsing library. If Python had a
2150
# built-in library for parsing we would use it, but we'd like to
2151
# avoid excessive use of external libraries.
2153
# New type for defining tokens, syntax, and semantics all-in-one
2154
Token = collections.namedtuple("Token",
2155
("regexp", # To match token; if
2156
# "value" is not None,
2157
# must have a "group"
2159
"value", # datetime.timedelta or
2161
"followers")) # Tokens valid after
2163
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2164
# the "duration" ABNF definition in RFC 3339, Appendix A.
2165
token_end = Token(re.compile(r"$"), None, frozenset())
2166
token_second = Token(re.compile(r"(\d+)S"),
2167
datetime.timedelta(seconds=1),
2168
frozenset((token_end,)))
2169
token_minute = Token(re.compile(r"(\d+)M"),
2170
datetime.timedelta(minutes=1),
2171
frozenset((token_second, token_end)))
2172
token_hour = Token(re.compile(r"(\d+)H"),
2173
datetime.timedelta(hours=1),
2174
frozenset((token_minute, token_end)))
2175
token_time = Token(re.compile(r"T"),
2177
frozenset((token_hour, token_minute,
2179
token_day = Token(re.compile(r"(\d+)D"),
2180
datetime.timedelta(days=1),
2181
frozenset((token_time, token_end)))
2182
token_month = Token(re.compile(r"(\d+)M"),
2183
datetime.timedelta(weeks=4),
2184
frozenset((token_day, token_end)))
2185
token_year = Token(re.compile(r"(\d+)Y"),
2186
datetime.timedelta(weeks=52),
2187
frozenset((token_month, token_end)))
2188
token_week = Token(re.compile(r"(\d+)W"),
2189
datetime.timedelta(weeks=1),
2190
frozenset((token_end,)))
2191
token_duration = Token(re.compile(r"P"), None,
2192
frozenset((token_year, token_month,
2193
token_day, token_time,
2195
# Define starting values
2196
value = datetime.timedelta() # Value so far
2198
followers = frozenset((token_duration,)) # Following valid tokens
2199
s = duration # String left to parse
2200
# Loop until end token is found
2201
while found_token is not token_end:
2202
# Search for any currently valid tokens
2203
for token in followers:
2204
match = token.regexp.match(s)
2205
if match is not None:
2207
if token.value is not None:
2208
# Value found, parse digits
2209
factor = int(match.group(1), 10)
2210
# Add to value so far
2211
value += factor * token.value
2212
# Strip token from string
2213
s = token.regexp.sub("", s, 1)
2216
# Set valid next tokens
2217
followers = found_token.followers
2220
# No currently valid tokens were found
2221
raise ValueError("Invalid RFC 3339 duration")
535
return super(type(self), self).server_bind()
2226
538
def string_to_delta(interval):
2227
539
"""Parse a string and return a datetime.timedelta
2229
541
>>> string_to_delta('7d')
2230
542
datetime.timedelta(7)
2231
543
>>> string_to_delta('60s')
2357
685
"debug": "False",
2359
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2360
":+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",
687
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
2361
688
"servicename": "Mandos",
2367
"statedir": "/var/lib/mandos",
2368
"foreground": "False",
2372
691
# Parse config file for server-global settings
2373
server_config = configparser.SafeConfigParser(server_defaults)
692
server_config = ConfigParser.SafeConfigParser(server_defaults)
2374
693
del server_defaults
2375
server_config.read(os.path.join(options.configdir,
694
server_config.read(os.path.join(options.configdir, "server.conf"))
695
server_section = "server"
2377
696
# Convert the SafeConfigParser object to a dict
2378
server_settings = server_config.defaults()
2379
# Use the appropriate methods on the non-string config options
2380
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2381
server_settings[option] = server_config.getboolean("DEFAULT",
2383
if server_settings["port"]:
2384
server_settings["port"] = server_config.getint("DEFAULT",
2386
if server_settings["socket"]:
2387
server_settings["socket"] = server_config.getint("DEFAULT",
2389
# Later, stdin will, and stdout and stderr might, be dup'ed
2390
# over with an opened os.devnull. But we don't want this to
2391
# happen with a supplied network socket.
2392
if 0 <= server_settings["socket"] <= 2:
2393
server_settings["socket"] = os.dup(server_settings
697
server_settings = dict(server_config.items(server_section))
698
# Use getboolean on the boolean config option
699
server_settings["debug"] = server_config.getboolean\
700
(server_section, "debug")
2395
701
del server_config
2397
703
# Override the settings from the config file with command line
2398
704
# options, if set.
2399
705
for option in ("interface", "address", "port", "debug",
2400
"priority", "servicename", "configdir",
2401
"use_dbus", "use_ipv6", "debuglevel", "restore",
2402
"statedir", "socket", "foreground", "zeroconf"):
706
"priority", "servicename", "configdir"):
2403
707
value = getattr(options, option)
2404
708
if value is not None:
2405
709
server_settings[option] = value
2407
# Force all strings to be unicode
2408
for option in server_settings.keys():
2409
if isinstance(server_settings[option], bytes):
2410
server_settings[option] = (server_settings[option]
2412
# Force all boolean options to be boolean
2413
for option in ("debug", "use_dbus", "use_ipv6", "restore",
2414
"foreground", "zeroconf"):
2415
server_settings[option] = bool(server_settings[option])
2416
# Debug implies foreground
2417
if server_settings["debug"]:
2418
server_settings["foreground"] = True
2419
711
# Now we have our good server settings in "server_settings"
2421
##################################################################
2423
if (not server_settings["zeroconf"] and
2424
not (server_settings["port"]
2425
or server_settings["socket"] != "")):
2426
parser.error("Needs port or socket to work without"
2430
debug = server_settings["debug"]
2431
debuglevel = server_settings["debuglevel"]
2432
use_dbus = server_settings["use_dbus"]
2433
use_ipv6 = server_settings["use_ipv6"]
2434
stored_state_path = os.path.join(server_settings["statedir"],
2436
foreground = server_settings["foreground"]
2437
zeroconf = server_settings["zeroconf"]
2440
initlogger(debug, logging.DEBUG)
2445
level = getattr(logging, debuglevel.upper())
2446
initlogger(debug, level)
2448
if server_settings["servicename"] != "Mandos":
2449
syslogger.setFormatter(logging.Formatter
2450
('Mandos ({}) [%(process)d]:'
2451
' %(levelname)s: %(message)s'
2452
.format(server_settings
2455
713
# Parse config file with clients
2456
client_config = configparser.SafeConfigParser(Client
714
client_defaults = { "timeout": "1h",
716
"checker": "fping -q -- %%(fqdn)s",
718
client_config = ConfigParser.SafeConfigParser(client_defaults)
2458
719
client_config.read(os.path.join(server_settings["configdir"],
2459
720
"clients.conf"))
2461
global mandos_dbus_service
2462
mandos_dbus_service = None
2465
if server_settings["socket"] != "":
2466
socketfd = server_settings["socket"]
2467
tcp_server = MandosServer((server_settings["address"],
2468
server_settings["port"]),
2470
interface=(server_settings["interface"]
2474
server_settings["priority"],
2478
pidfilename = "/run/mandos.pid"
2479
if not os.path.isdir("/run/."):
2480
pidfilename = "/var/run/mandos.pid"
2483
pidfile = open(pidfilename, "w")
2484
except IOError as e:
2485
logger.error("Could not open file %r", pidfilename,
2488
for name in ("_mandos", "mandos", "nobody"):
2490
uid = pwd.getpwnam(name).pw_uid
2491
gid = pwd.getpwnam(name).pw_gid
2501
except OSError as error:
2502
if error.errno != errno.EPERM:
2506
# Enable all possible GnuTLS debugging
2508
# "Use a log level over 10 to enable all debugging options."
2510
gnutls.library.functions.gnutls_global_set_log_level(11)
2512
@gnutls.library.types.gnutls_log_func
2513
def debug_gnutls(level, string):
2514
logger.debug("GnuTLS: %s", string[:-1])
2516
(gnutls.library.functions
2517
.gnutls_global_set_log_function(debug_gnutls))
2519
# Redirect stdin so all checkers get /dev/null
2520
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2521
os.dup2(null, sys.stdin.fileno())
2525
# Need to fork before connecting to D-Bus
2527
# Close all input and output, do double fork, etc.
2530
# multiprocessing will use threads, so before we use gobject we
2531
# need to inform gobject that threads will be used.
2532
gobject.threads_init()
723
service = AvahiService(name = server_settings["servicename"],
724
type = "_mandos._tcp", );
725
if server_settings["interface"]:
726
service.interface = if_nametoindex(server_settings["interface"])
2534
728
global main_loop
2535
731
# From the Avahi example code
2536
DBusGMainLoop(set_as_default=True)
732
DBusGMainLoop(set_as_default=True )
2537
733
main_loop = gobject.MainLoop()
2538
734
bus = dbus.SystemBus()
735
server = dbus.Interface(
736
bus.get_object( avahi.DBUS_NAME, avahi.DBUS_PATH_SERVER ),
737
avahi.DBUS_INTERFACE_SERVER )
2539
738
# End of Avahi example code
2542
bus_name = dbus.service.BusName("se.recompile.Mandos",
2543
bus, do_not_queue=True)
2544
old_bus_name = (dbus.service.BusName
2545
("se.bsnet.fukt.Mandos", bus,
2547
except dbus.exceptions.NameExistsException as e:
2548
logger.error("Disabling D-Bus:", exc_info=e)
2550
server_settings["use_dbus"] = False
2551
tcp_server.use_dbus = False
2553
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2554
service = AvahiServiceToSyslog(name =
2555
server_settings["servicename"],
2556
servicetype = "_mandos._tcp",
2557
protocol = protocol, bus = bus)
2558
if server_settings["interface"]:
2559
service.interface = (if_nametoindex
2560
(server_settings["interface"]
2563
global multiprocessing_manager
2564
multiprocessing_manager = multiprocessing.Manager()
2566
client_class = Client
2568
client_class = functools.partial(ClientDBus, bus = bus)
2570
client_settings = Client.config_parser(client_config)
2571
old_client_settings = {}
2574
# This is used to redirect stdout and stderr for checker processes
2576
wnull = open(os.devnull, "w") # A writable /dev/null
2577
# Only used if server is running in foreground but not in debug
2579
if debug or not foreground:
2582
# Get client data and settings from last running state.
2583
if server_settings["restore"]:
2585
with open(stored_state_path, "rb") as stored_state:
2586
clients_data, old_client_settings = (pickle.load
2588
os.remove(stored_state_path)
2589
except IOError as e:
2590
if e.errno == errno.ENOENT:
2591
logger.warning("Could not load persistent state: {}"
2592
.format(os.strerror(e.errno)))
2594
logger.critical("Could not load persistent state:",
2597
except EOFError as e:
2598
logger.warning("Could not load persistent state: "
2599
"EOFError:", exc_info=e)
2601
with PGPEngine() as pgp:
2602
for client_name, client in clients_data.items():
2603
# Skip removed clients
2604
if client_name not in client_settings:
2607
# Decide which value to use after restoring saved state.
2608
# We have three different values: Old config file,
2609
# new config file, and saved state.
2610
# New config value takes precedence if it differs from old
2611
# config value, otherwise use saved state.
2612
for name, value in client_settings[client_name].items():
2614
# For each value in new config, check if it
2615
# differs from the old config value (Except for
2616
# the "secret" attribute)
2617
if (name != "secret" and
2618
value != old_client_settings[client_name]
2620
client[name] = value
2624
# Clients who has passed its expire date can still be
2625
# enabled if its last checker was successful. Clients
2626
# whose checker succeeded before we stored its state is
2627
# assumed to have successfully run all checkers during
2629
if client["enabled"]:
2630
if datetime.datetime.utcnow() >= client["expires"]:
2631
if not client["last_checked_ok"]:
2633
"disabling client {} - Client never "
2634
"performed a successful checker"
2635
.format(client_name))
2636
client["enabled"] = False
2637
elif client["last_checker_status"] != 0:
2639
"disabling client {} - Client last"
2640
" checker failed with error code {}"
2641
.format(client_name,
2642
client["last_checker_status"]))
2643
client["enabled"] = False
2645
client["expires"] = (datetime.datetime
2647
+ client["timeout"])
2648
logger.debug("Last checker succeeded,"
2649
" keeping {} enabled"
2650
.format(client_name))
2652
client["secret"] = (
2653
pgp.decrypt(client["encrypted_secret"],
2654
client_settings[client_name]
2657
# If decryption fails, we use secret from new settings
2658
logger.debug("Failed to decrypt {} old secret"
2659
.format(client_name))
2660
client["secret"] = (
2661
client_settings[client_name]["secret"])
2663
# Add/remove clients based on new changes made to config
2664
for client_name in (set(old_client_settings)
2665
- set(client_settings)):
2666
del clients_data[client_name]
2667
for client_name in (set(client_settings)
2668
- set(old_client_settings)):
2669
clients_data[client_name] = client_settings[client_name]
2671
# Create all client objects
2672
for client_name, client in clients_data.items():
2673
tcp_server.clients[client_name] = client_class(
2674
name = client_name, settings = client,
2675
server_settings = server_settings)
2677
if not tcp_server.clients:
2678
logger.warning("No clients defined")
2681
if pidfile is not None:
2685
pidfile.write("{}\n".format(pid).encode("utf-8"))
2687
logger.error("Could not write to file %r with PID %d",
2692
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2693
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2696
@alternate_dbus_interfaces({"se.recompile.Mandos":
2697
"se.bsnet.fukt.Mandos"})
2698
class MandosDBusService(DBusObjectWithProperties):
2699
"""A D-Bus proxy object"""
2701
dbus.service.Object.__init__(self, bus, "/")
2702
_interface = "se.recompile.Mandos"
2704
@dbus_interface_annotations(_interface)
2706
return { "org.freedesktop.DBus.Property"
2707
".EmitsChangedSignal":
2710
@dbus.service.signal(_interface, signature="o")
2711
def ClientAdded(self, objpath):
2715
@dbus.service.signal(_interface, signature="ss")
2716
def ClientNotFound(self, fingerprint, address):
2720
@dbus.service.signal(_interface, signature="os")
2721
def ClientRemoved(self, objpath, name):
2725
@dbus.service.method(_interface, out_signature="ao")
2726
def GetAllClients(self):
2728
return dbus.Array(c.dbus_object_path
2730
tcp_server.clients.itervalues())
2732
@dbus.service.method(_interface,
2733
out_signature="a{oa{sv}}")
2734
def GetAllClientsWithProperties(self):
2736
return dbus.Dictionary(
2737
{ c.dbus_object_path: c.GetAll("")
2738
for c in tcp_server.clients.itervalues() },
2741
@dbus.service.method(_interface, in_signature="o")
2742
def RemoveClient(self, object_path):
2744
for c in tcp_server.clients.itervalues():
2745
if c.dbus_object_path == object_path:
2746
del tcp_server.clients[c.name]
2747
c.remove_from_connection()
2748
# Don't signal anything except ClientRemoved
2749
c.disable(quiet=True)
2751
self.ClientRemoved(object_path, c.name)
2753
raise KeyError(object_path)
2757
mandos_dbus_service = MandosDBusService()
740
debug = server_settings["debug"]
743
console = logging.StreamHandler()
744
# console.setLevel(logging.DEBUG)
745
console.setFormatter(logging.Formatter\
746
('%(levelname)s: %(message)s'))
747
logger.addHandler(console)
751
def remove_from_clients(client):
752
clients.remove(client)
754
logger.debug(u"No clients left, exiting")
757
clients.update(Set(Client(name=section,
758
stop_hook = remove_from_clients,
759
**(dict(client_config\
761
for section in client_config.sections()))
2760
767
"Cleanup function; run on exit"
2764
multiprocessing.active_children()
2766
if not (tcp_server.clients or client_settings):
2769
# Store client before exiting. Secrets are encrypted with key
2770
# based on what config file has. If config file is
2771
# removed/edited, old secret will thus be unrecovable.
2773
with PGPEngine() as pgp:
2774
for client in tcp_server.clients.itervalues():
2775
key = client_settings[client.name]["secret"]
2776
client.encrypted_secret = pgp.encrypt(client.secret,
2780
# A list of attributes that can not be pickled
2782
exclude = { "bus", "changedstate", "secret",
2783
"checker", "server_settings" }
2784
for name, typ in (inspect.getmembers
2785
(dbus.service.Object)):
2788
client_dict["encrypted_secret"] = (client
2790
for attr in client.client_structure:
2791
if attr not in exclude:
2792
client_dict[attr] = getattr(client, attr)
2794
clients[client.name] = client_dict
2795
del client_settings[client.name]["secret"]
2798
with (tempfile.NamedTemporaryFile
2799
(mode='wb', suffix=".pickle", prefix='clients-',
2800
dir=os.path.dirname(stored_state_path),
2801
delete=False)) as stored_state:
2802
pickle.dump((clients, client_settings), stored_state)
2803
tempname=stored_state.name
2804
os.rename(tempname, stored_state_path)
2805
except (IOError, OSError) as e:
2811
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
2812
logger.warning("Could not save persistent state: {}"
2813
.format(os.strerror(e.errno)))
2815
logger.warning("Could not save persistent state:",
2819
# Delete all clients, and settings from config
2820
while tcp_server.clients:
2821
name, client = tcp_server.clients.popitem()
2823
client.remove_from_connection()
2824
# Don't signal anything except ClientRemoved
2825
client.disable(quiet=True)
2828
mandos_dbus_service.ClientRemoved(client
2831
client_settings.clear()
769
# From the Avahi example code
770
if not group is None:
773
# End of Avahi example code
776
client = clients.pop()
777
client.stop_hook = None
2833
780
atexit.register(cleanup)
2835
for client in tcp_server.clients.itervalues():
2838
mandos_dbus_service.ClientAdded(client.dbus_object_path)
2839
# Need to initiate checking of clients
2841
client.init_checker()
2844
tcp_server.server_activate()
783
signal.signal(signal.SIGINT, signal.SIG_IGN)
784
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
785
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
787
for client in clients:
790
tcp_server = IPv6_TCPServer((server_settings["address"],
791
server_settings["port"]),
793
settings=server_settings,
2846
795
# Find out what port we got
2848
service.port = tcp_server.socket.getsockname()[1]
2850
logger.info("Now listening on address %r, port %d,"
2851
" flowinfo %d, scope_id %d",
2852
*tcp_server.socket.getsockname())
2854
logger.info("Now listening on address %r, port %d",
2855
*tcp_server.socket.getsockname())
796
service.port = tcp_server.socket.getsockname()[1]
797
logger.debug(u"Now listening on address %r, port %d, flowinfo %d,"
798
u" scope_id %d" % tcp_server.socket.getsockname())
2857
800
#service.interface = tcp_server.socket.getsockname()[3]
2861
# From the Avahi example code
2864
except dbus.exceptions.DBusException as error:
2865
logger.critical("D-Bus Exception", exc_info=error)
2868
# End of Avahi example code
803
# From the Avahi example code
804
server.connect_to_signal("StateChanged", server_state_changed)
806
server_state_changed(server.GetState())
807
except dbus.exceptions.DBusException, error:
808
logger.critical(u"DBusException: %s", error)
810
# End of Avahi example code
2870
812
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2871
813
lambda *args, **kwargs:
2872
(tcp_server.handle_request
2873
(*args[2:], **kwargs) or True))
814
tcp_server.handle_request\
815
(*args[2:], **kwargs) or True)
2875
817
logger.debug("Starting main loop")
818
main_loop_started = True
2877
except AvahiError as error:
2878
logger.critical("Avahi Error", exc_info=error)
820
except AvahiError, error:
821
logger.critical(u"AvahiError: %s" + unicode(error))
2881
823
except KeyboardInterrupt:
2883
print("", file=sys.stderr)
2884
logger.debug("Server received KeyboardInterrupt")
2885
logger.debug("Server exiting")
2886
# Must run before the D-Bus bus name gets deregistered
2889
827
if __name__ == '__main__':