258
126
self.rename_count = 0
259
127
self.max_renames = max_renames
260
128
self.protocol = protocol
261
self.group = None # our entry group
264
self.entry_group_state_changed_match = None
266
129
def rename(self):
267
130
"""Derived from the Avahi example code"""
268
131
if self.rename_count >= self.max_renames:
269
logger.critical("No suitable Zeroconf service name found"
270
" after %i retries, exiting.",
132
logger.critical(u"No suitable Zeroconf service name found"
133
u" after %i retries, exiting.",
271
134
self.rename_count)
272
raise AvahiServiceError("Too many renames")
273
self.name = unicode(self.server
274
.GetAlternativeServiceName(self.name))
275
logger.info("Changing Zeroconf service name to %r ...",
135
raise AvahiServiceError(u"Too many renames")
136
self.name = server.GetAlternativeServiceName(self.name)
137
logger.info(u"Changing Zeroconf service name to %r ...",
139
syslogger.setFormatter(logging.Formatter
140
('Mandos (%s): %%(levelname)s:'
141
' %%(message)s' % self.name))
280
except dbus.exceptions.DBusException as error:
281
logger.critical("D-Bus Exception", exc_info=error)
284
144
self.rename_count += 1
286
145
def remove(self):
287
146
"""Derived from the Avahi example code"""
288
if self.entry_group_state_changed_match is not None:
289
self.entry_group_state_changed_match.remove()
290
self.entry_group_state_changed_match = None
291
if self.group is not None:
147
if group is not None:
295
150
"""Derived from the Avahi example code"""
297
if self.group is None:
298
self.group = dbus.Interface(
299
self.bus.get_object(avahi.DBUS_NAME,
300
self.server.EntryGroupNew()),
301
avahi.DBUS_INTERFACE_ENTRY_GROUP)
302
self.entry_group_state_changed_match = (
303
self.group.connect_to_signal(
304
'StateChanged', self.entry_group_state_changed))
305
logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
306
self.name, self.type)
307
self.group.AddService(
310
dbus.UInt32(0), # flags
311
self.name, self.type,
312
self.domain, self.host,
313
dbus.UInt16(self.port),
314
avahi.string_array_to_txt_array(self.TXT))
317
def entry_group_state_changed(self, state, error):
318
"""Derived from the Avahi example code"""
319
logger.debug("Avahi entry group state change: %i", state)
321
if state == avahi.ENTRY_GROUP_ESTABLISHED:
322
logger.debug("Zeroconf service established.")
323
elif state == avahi.ENTRY_GROUP_COLLISION:
324
logger.info("Zeroconf service name collision.")
326
elif state == avahi.ENTRY_GROUP_FAILURE:
327
logger.critical("Avahi: Error in group state changed %s",
329
raise AvahiGroupError("State changed: {0!s}"
333
"""Derived from the Avahi example code"""
334
if self.group is not None:
337
except (dbus.exceptions.UnknownMethodException,
338
dbus.exceptions.DBusException):
343
def server_state_changed(self, state, error=None):
344
"""Derived from the Avahi example code"""
345
logger.debug("Avahi server state change: %i", state)
346
bad_states = { avahi.SERVER_INVALID:
347
"Zeroconf server invalid",
348
avahi.SERVER_REGISTERING: None,
349
avahi.SERVER_COLLISION:
350
"Zeroconf server name collision",
351
avahi.SERVER_FAILURE:
352
"Zeroconf server failure" }
353
if state in bad_states:
354
if bad_states[state] is not None:
356
logger.error(bad_states[state])
358
logger.error(bad_states[state] + ": %r", error)
360
elif state == avahi.SERVER_RUNNING:
364
logger.debug("Unknown state: %r", state)
366
logger.debug("Unknown state: %r: %r", state, error)
369
"""Derived from the Avahi example code"""
370
if self.server is None:
371
self.server = dbus.Interface(
372
self.bus.get_object(avahi.DBUS_NAME,
373
avahi.DBUS_PATH_SERVER,
374
follow_name_owner_changes=True),
375
avahi.DBUS_INTERFACE_SERVER)
376
self.server.connect_to_signal("StateChanged",
377
self.server_state_changed)
378
self.server_state_changed(self.server.GetState())
380
class AvahiServiceToSyslog(AvahiService):
382
"""Add the new name to the syslog messages"""
383
ret = AvahiService.rename(self)
384
syslogger.setFormatter(logging.Formatter
385
('Mandos ({0}) [%(process)d]:'
386
' %(levelname)s: %(message)s'
390
def timedelta_to_milliseconds(td):
391
"Convert a datetime.timedelta() to milliseconds"
392
return ((td.days * 24 * 60 * 60 * 1000)
393
+ (td.seconds * 1000)
394
+ (td.microseconds // 1000))
396
class Client(object):
153
group = dbus.Interface(bus.get_object
155
server.EntryGroupNew()),
156
avahi.DBUS_INTERFACE_ENTRY_GROUP)
157
group.connect_to_signal('StateChanged',
158
entry_group_state_changed)
159
logger.debug(u"Adding Zeroconf service '%s' of type '%s' ...",
160
service.name, service.type)
162
self.interface, # interface
163
self.protocol, # protocol
164
dbus.UInt32(0), # flags
165
self.name, self.type,
166
self.domain, self.host,
167
dbus.UInt16(self.port),
168
avahi.string_array_to_txt_array(self.TXT))
171
# From the Avahi example code:
172
group = None # our entry group
173
# End of Avahi example code
176
def _datetime_to_dbus(dt, variant_level=0):
177
"""Convert a UTC datetime.datetime() to a D-Bus type."""
178
return dbus.String(dt.isoformat(), variant_level=variant_level)
181
class Client(dbus.service.Object):
397
182
"""A representation of a client host served by this server.
400
approved: bool(); 'None' if not yet approved/disapproved
401
approval_delay: datetime.timedelta(); Time to wait for approval
402
approval_duration: datetime.timedelta(); Duration of one approval
184
name: string; from the config file, used in log messages and
186
fingerprint: string (40 or 32 hexadecimal digits); used to
187
uniquely identify the client
188
secret: bytestring; sent verbatim (over TLS) to client
189
host: string; available for use by the checker command
190
created: datetime.datetime(); (UTC) object creation
191
last_enabled: datetime.datetime(); (UTC)
193
last_checked_ok: datetime.datetime(); (UTC) or None
194
timeout: datetime.timedelta(); How long from last_checked_ok
195
until this client is invalid
196
interval: datetime.timedelta(); How often to start a new checker
197
disable_hook: If set, called by disable() as disable_hook(self)
403
198
checker: subprocess.Popen(); a running checker process used
404
199
to see if the client lives.
405
200
'None' if no process is running.
406
checker_callback_tag: a gobject event source tag, or None
407
checker_command: string; External command which is run to check
408
if client lives. %() expansions are done at
201
checker_initiator_tag: a gobject event source tag, or None
202
disable_initiator_tag: - '' -
203
checker_callback_tag: - '' -
204
checker_command: string; External command which is run to check if
205
client lives. %() expansions are done at
409
206
runtime with vars(self) as dict, so that for
410
207
instance %(name)s can be used in the command.
411
checker_initiator_tag: a gobject event source tag, or None
412
created: datetime.datetime(); (UTC) object creation
413
client_structure: Object describing what attributes a client has
414
and is used for storing the client at exit
415
208
current_checker_command: string; current running checker_command
416
disable_initiator_tag: a gobject event source tag, or None
418
fingerprint: string (40 or 32 hexadecimal digits); used to
419
uniquely identify the client
420
host: string; available for use by the checker command
421
interval: datetime.timedelta(); How often to start a new checker
422
last_approval_request: datetime.datetime(); (UTC) or None
423
last_checked_ok: datetime.datetime(); (UTC) or None
424
last_checker_status: integer between 0 and 255 reflecting exit
425
status of last checker. -1 reflects crashed
426
checker, -2 means no checker completed yet.
427
last_enabled: datetime.datetime(); (UTC) or None
428
name: string; from the config file, used in log messages and
430
secret: bytestring; sent verbatim (over TLS) to client
431
timeout: datetime.timedelta(); How long from last_checked_ok
432
until this client is disabled
433
extended_timeout: extra long timeout when secret has been sent
434
runtime_expansions: Allowed attributes for runtime expansion.
435
expires: datetime.datetime(); time (UTC) when a client will be
209
use_dbus: bool(); Whether to provide D-Bus interface and signals
210
dbus_object_path: dbus.ObjectPath ; only set if self.use_dbus
439
runtime_expansions = ("approval_delay", "approval_duration",
440
"created", "enabled", "fingerprint",
441
"host", "interval", "last_checked_ok",
442
"last_enabled", "name", "timeout")
443
client_defaults = { "timeout": "5m",
444
"extended_timeout": "15m",
446
"checker": "fping -q -- %%(host)s",
448
"approval_delay": "0s",
449
"approval_duration": "1s",
450
"approved_by_default": "True",
454
212
def timeout_milliseconds(self):
455
213
"Return the 'timeout' attribute in milliseconds"
456
return timedelta_to_milliseconds(self.timeout)
458
def extended_timeout_milliseconds(self):
459
"Return the 'extended_timeout' attribute in milliseconds"
460
return timedelta_to_milliseconds(self.extended_timeout)
214
return ((self.timeout.days * 24 * 60 * 60 * 1000)
215
+ (self.timeout.seconds * 1000)
216
+ (self.timeout.microseconds // 1000))
462
218
def interval_milliseconds(self):
463
219
"Return the 'interval' attribute in milliseconds"
464
return timedelta_to_milliseconds(self.interval)
466
def approval_delay_milliseconds(self):
467
return timedelta_to_milliseconds(self.approval_delay)
470
def config_parser(config):
471
"""Construct a new dict of client settings of this form:
472
{ client_name: {setting_name: value, ...}, ...}
473
with exceptions for any special settings as defined above.
474
NOTE: Must be a pure function. Must return the same result
475
value given the same arguments.
478
for client_name in config.sections():
479
section = dict(config.items(client_name))
480
client = settings[client_name] = {}
482
client["host"] = section["host"]
483
# Reformat values from string types to Python types
484
client["approved_by_default"] = config.getboolean(
485
client_name, "approved_by_default")
486
client["enabled"] = config.getboolean(client_name,
489
client["fingerprint"] = (section["fingerprint"].upper()
491
if "secret" in section:
492
client["secret"] = section["secret"].decode("base64")
493
elif "secfile" in section:
494
with open(os.path.expanduser(os.path.expandvars
495
(section["secfile"])),
497
client["secret"] = secfile.read()
499
raise TypeError("No secret or secfile for section {0}"
501
client["timeout"] = string_to_delta(section["timeout"])
502
client["extended_timeout"] = string_to_delta(
503
section["extended_timeout"])
504
client["interval"] = string_to_delta(section["interval"])
505
client["approval_delay"] = string_to_delta(
506
section["approval_delay"])
507
client["approval_duration"] = string_to_delta(
508
section["approval_duration"])
509
client["checker_command"] = section["checker"]
510
client["last_approval_request"] = None
511
client["last_checked_ok"] = None
512
client["last_checker_status"] = -2
516
def __init__(self, settings, name = None):
220
return ((self.interval.days * 24 * 60 * 60 * 1000)
221
+ (self.interval.seconds * 1000)
222
+ (self.interval.microseconds // 1000))
224
def __init__(self, name = None, disable_hook=None, config=None,
226
"""Note: the 'checker' key in 'config' sets the
227
'checker_command' attribute and *not* the 'checker'
518
# adding all client settings
519
for setting, value in settings.iteritems():
520
setattr(self, setting, value)
523
if not hasattr(self, "last_enabled"):
524
self.last_enabled = datetime.datetime.utcnow()
525
if not hasattr(self, "expires"):
526
self.expires = (datetime.datetime.utcnow()
529
self.last_enabled = None
532
logger.debug("Creating client %r", self.name)
232
logger.debug(u"Creating client %r", self.name)
233
self.use_dbus = False # During __init__
533
234
# Uppercase and remove spaces from fingerprint for later
534
235
# comparison purposes with return value from the fingerprint()
536
logger.debug(" Fingerprint: %s", self.fingerprint)
537
self.created = settings.get("created",
538
datetime.datetime.utcnow())
540
# attributes specific for this server instance
237
self.fingerprint = (config["fingerprint"].upper()
239
logger.debug(u" Fingerprint: %s", self.fingerprint)
240
if "secret" in config:
241
self.secret = config["secret"].decode(u"base64")
242
elif "secfile" in config:
243
with closing(open(os.path.expanduser
245
(config["secfile"])))) as secfile:
246
self.secret = secfile.read()
248
raise TypeError(u"No secret or secfile for client %s"
250
self.host = config.get("host", "")
251
self.created = datetime.datetime.utcnow()
253
self.last_enabled = None
254
self.last_checked_ok = None
255
self.timeout = string_to_delta(config["timeout"])
256
self.interval = string_to_delta(config["interval"])
257
self.disable_hook = disable_hook
541
258
self.checker = None
542
259
self.checker_initiator_tag = None
543
260
self.disable_initiator_tag = None
544
261
self.checker_callback_tag = None
262
self.checker_command = config["checker"]
545
263
self.current_checker_command = None
547
self.approvals_pending = 0
548
self.changedstate = (multiprocessing_manager
549
.Condition(multiprocessing_manager
551
self.client_structure = [attr for attr in
552
self.__dict__.iterkeys()
553
if not attr.startswith("_")]
554
self.client_structure.append("client_structure")
556
for name, t in inspect.getmembers(type(self),
560
if not name.startswith("_"):
561
self.client_structure.append(name)
563
# Send notice to process children that client state has changed
564
def send_changedstate(self):
565
with self.changedstate:
566
self.changedstate.notify_all()
264
self.last_connect = None
265
# Only now, when this client is initialized, can it show up on
267
self.use_dbus = use_dbus
269
self.dbus_object_path = (dbus.ObjectPath
271
+ self.name.replace(".", "_")))
272
dbus.service.Object.__init__(self, bus,
273
self.dbus_object_path)
568
275
def enable(self):
569
276
"""Start this client's checker and timeout hooks"""
570
if getattr(self, "enabled", False):
573
self.send_changedstate()
574
self.expires = datetime.datetime.utcnow() + self.timeout
576
277
self.last_enabled = datetime.datetime.utcnow()
579
def disable(self, quiet=True):
580
"""Disable this client."""
581
if not getattr(self, "enabled", False):
584
self.send_changedstate()
586
logger.info("Disabling client %s", self.name)
587
if getattr(self, "disable_initiator_tag", False):
588
gobject.source_remove(self.disable_initiator_tag)
589
self.disable_initiator_tag = None
591
if getattr(self, "checker_initiator_tag", False):
592
gobject.source_remove(self.checker_initiator_tag)
593
self.checker_initiator_tag = None
596
# Do not run this again if called by a gobject.timeout_add
602
def init_checker(self):
603
278
# Schedule a new checker to be started an 'interval' from now,
604
279
# and every interval from then on.
605
280
self.checker_initiator_tag = (gobject.timeout_add
606
281
(self.interval_milliseconds(),
607
282
self.start_checker))
283
# Also start a new checker *right now*.
608
285
# Schedule a disable() when 'timeout' has passed
609
286
self.disable_initiator_tag = (gobject.timeout_add
610
287
(self.timeout_milliseconds(),
612
# Also start a new checker *right now*.
292
self.PropertyChanged(dbus.String(u"enabled"),
293
dbus.Boolean(True, variant_level=1))
294
self.PropertyChanged(dbus.String(u"last_enabled"),
295
(_datetime_to_dbus(self.last_enabled,
299
"""Disable this client."""
300
if not getattr(self, "enabled", False):
302
logger.info(u"Disabling client %s", self.name)
303
if getattr(self, "disable_initiator_tag", False):
304
gobject.source_remove(self.disable_initiator_tag)
305
self.disable_initiator_tag = None
306
if getattr(self, "checker_initiator_tag", False):
307
gobject.source_remove(self.checker_initiator_tag)
308
self.checker_initiator_tag = None
310
if self.disable_hook:
311
self.disable_hook(self)
315
self.PropertyChanged(dbus.String(u"enabled"),
316
dbus.Boolean(False, variant_level=1))
317
# Do not run this again if called by a gobject.timeout_add
321
self.disable_hook = None
615
324
def checker_callback(self, pid, condition, command):
616
325
"""The checker has completed, so take appropriate actions."""
617
326
self.checker_callback_tag = None
618
327
self.checker = None
330
self.PropertyChanged(dbus.String(u"checker_running"),
331
dbus.Boolean(False, variant_level=1))
619
332
if os.WIFEXITED(condition):
620
self.last_checker_status = os.WEXITSTATUS(condition)
621
if self.last_checker_status == 0:
622
logger.info("Checker for %(name)s succeeded",
333
exitstatus = os.WEXITSTATUS(condition)
335
logger.info(u"Checker for %(name)s succeeded",
624
337
self.checked_ok()
626
logger.info("Checker for %(name)s failed",
339
logger.info(u"Checker for %(name)s failed",
343
self.CheckerCompleted(dbus.Int16(exitstatus),
344
dbus.Int64(condition),
345
dbus.String(command))
629
self.last_checker_status = -1
630
logger.warning("Checker for %(name)s crashed?",
347
logger.warning(u"Checker for %(name)s crashed?",
351
self.CheckerCompleted(dbus.Int16(-1),
352
dbus.Int64(condition),
353
dbus.String(command))
633
355
def checked_ok(self):
634
"""Assert that the client has been seen, alive and well."""
356
"""Bump up the timeout for this client.
357
This should only be called when the client has been seen,
635
360
self.last_checked_ok = datetime.datetime.utcnow()
636
self.last_checker_status = 0
639
def bump_timeout(self, timeout=None):
640
"""Bump up the timeout for this client."""
642
timeout = self.timeout
643
if self.disable_initiator_tag is not None:
644
gobject.source_remove(self.disable_initiator_tag)
645
if getattr(self, "enabled", False):
646
self.disable_initiator_tag = (gobject.timeout_add
647
(timedelta_to_milliseconds
648
(timeout), self.disable))
649
self.expires = datetime.datetime.utcnow() + timeout
651
def need_approval(self):
652
self.last_approval_request = datetime.datetime.utcnow()
361
gobject.source_remove(self.disable_initiator_tag)
362
self.disable_initiator_tag = (gobject.timeout_add
363
(self.timeout_milliseconds(),
367
self.PropertyChanged(
368
dbus.String(u"last_checked_ok"),
369
(_datetime_to_dbus(self.last_checked_ok,
654
372
def start_checker(self):
655
373
"""Start a new checker subprocess if one is not running.
657
374
If a checker already exists, leave it running and do
659
376
# The reason for not killing a running checker is that if we
733
446
self.checker_callback_tag = None
734
447
if getattr(self, "checker", None) is None:
736
logger.debug("Stopping checker for %(name)s", vars(self))
449
logger.debug(u"Stopping checker for %(name)s", vars(self))
738
self.checker.terminate()
451
os.kill(self.checker.pid, signal.SIGTERM)
740
453
#if self.checker.poll() is None:
741
# self.checker.kill()
742
except OSError as error:
454
# os.kill(self.checker.pid, signal.SIGKILL)
455
except OSError, error:
743
456
if error.errno != errno.ESRCH: # No such process
745
458
self.checker = None
748
def dbus_service_property(dbus_interface, signature="v",
749
access="readwrite", byte_arrays=False):
750
"""Decorators for marking methods of a DBusObjectWithProperties to
751
become properties on the D-Bus.
753
The decorated method will be called with no arguments by "Get"
754
and with one argument by "Set".
756
The parameters, where they are supported, are the same as
757
dbus.service.method, except there is only "signature", since the
758
type from Get() and the type sent to Set() is the same.
760
# Encoding deeply encoded byte arrays is not supported yet by the
761
# "Set" method, so we fail early here:
762
if byte_arrays and signature != "ay":
763
raise ValueError("Byte arrays not supported for non-'ay'"
764
" signature {0!r}".format(signature))
766
func._dbus_is_property = True
767
func._dbus_interface = dbus_interface
768
func._dbus_signature = signature
769
func._dbus_access = access
770
func._dbus_name = func.__name__
771
if func._dbus_name.endswith("_dbus_property"):
772
func._dbus_name = func._dbus_name[:-14]
773
func._dbus_get_args_options = {'byte_arrays': byte_arrays }
778
def dbus_interface_annotations(dbus_interface):
779
"""Decorator for marking functions returning interface annotations
783
@dbus_interface_annotations("org.example.Interface")
784
def _foo(self): # Function name does not matter
785
return {"org.freedesktop.DBus.Deprecated": "true",
786
"org.freedesktop.DBus.Property.EmitsChangedSignal":
790
func._dbus_is_interface = True
791
func._dbus_interface = dbus_interface
792
func._dbus_name = dbus_interface
797
def dbus_annotations(annotations):
798
"""Decorator to annotate D-Bus methods, signals or properties
801
@dbus_service_property("org.example.Interface", signature="b",
803
@dbus_annotations({{"org.freedesktop.DBus.Deprecated": "true",
804
"org.freedesktop.DBus.Property."
805
"EmitsChangedSignal": "false"})
806
def Property_dbus_property(self):
807
return dbus.Boolean(False)
810
func._dbus_annotations = annotations
815
class DBusPropertyException(dbus.exceptions.DBusException):
816
"""A base class for D-Bus property-related exceptions
818
def __unicode__(self):
819
return unicode(str(self))
822
class DBusPropertyAccessException(DBusPropertyException):
823
"""A property's access permissions disallows an operation.
828
class DBusPropertyNotFound(DBusPropertyException):
829
"""An attempt was made to access a non-existing property.
834
class DBusObjectWithProperties(dbus.service.Object):
835
"""A D-Bus object with properties.
837
Classes inheriting from this can use the dbus_service_property
838
decorator to expose methods as D-Bus properties. It exposes the
839
standard Get(), Set(), and GetAll() methods on the D-Bus.
843
def _is_dbus_thing(thing):
844
"""Returns a function testing if an attribute is a D-Bus thing
846
If called like _is_dbus_thing("method") it returns a function
847
suitable for use as predicate to inspect.getmembers().
849
return lambda obj: getattr(obj, "_dbus_is_{0}".format(thing),
852
def _get_all_dbus_things(self, thing):
853
"""Returns a generator of (name, attribute) pairs
855
return ((getattr(athing.__get__(self), "_dbus_name",
857
athing.__get__(self))
858
for cls in self.__class__.__mro__
860
inspect.getmembers(cls,
861
self._is_dbus_thing(thing)))
863
def _get_dbus_property(self, interface_name, property_name):
864
"""Returns a bound method if one exists which is a D-Bus
865
property with the specified name and interface.
867
for cls in self.__class__.__mro__:
868
for name, value in (inspect.getmembers
870
self._is_dbus_thing("property"))):
871
if (value._dbus_name == property_name
872
and value._dbus_interface == interface_name):
873
return value.__get__(self)
876
raise DBusPropertyNotFound(self.dbus_object_path + ":"
877
+ interface_name + "."
880
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
882
def Get(self, interface_name, property_name):
883
"""Standard D-Bus property Get() method, see D-Bus standard.
885
prop = self._get_dbus_property(interface_name, property_name)
886
if prop._dbus_access == "write":
887
raise DBusPropertyAccessException(property_name)
889
if not hasattr(value, "variant_level"):
891
return type(value)(value, variant_level=value.variant_level+1)
893
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
894
def Set(self, interface_name, property_name, value):
895
"""Standard D-Bus property Set() method, see D-Bus standard.
897
prop = self._get_dbus_property(interface_name, property_name)
898
if prop._dbus_access == "read":
899
raise DBusPropertyAccessException(property_name)
900
if prop._dbus_get_args_options["byte_arrays"]:
901
# The byte_arrays option is not supported yet on
902
# signatures other than "ay".
903
if prop._dbus_signature != "ay":
905
value = dbus.ByteArray(b''.join(chr(byte)
909
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
910
out_signature="a{sv}")
911
def GetAll(self, interface_name):
912
"""Standard D-Bus property GetAll() method, see D-Bus
915
Note: Will not include properties with access="write".
918
for name, prop in self._get_all_dbus_things("property"):
920
and interface_name != prop._dbus_interface):
921
# Interface non-empty but did not match
923
# Ignore write-only properties
924
if prop._dbus_access == "write":
927
if not hasattr(value, "variant_level"):
928
properties[name] = value
930
properties[name] = type(value)(value, variant_level=
931
value.variant_level+1)
932
return dbus.Dictionary(properties, signature="sv")
934
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
936
path_keyword='object_path',
937
connection_keyword='connection')
938
def Introspect(self, object_path, connection):
939
"""Overloading of standard D-Bus method.
941
Inserts property tags and interface annotation tags.
943
xmlstring = dbus.service.Object.Introspect(self, object_path,
946
document = xml.dom.minidom.parseString(xmlstring)
947
def make_tag(document, name, prop):
948
e = document.createElement("property")
949
e.setAttribute("name", name)
950
e.setAttribute("type", prop._dbus_signature)
951
e.setAttribute("access", prop._dbus_access)
953
for if_tag in document.getElementsByTagName("interface"):
955
for tag in (make_tag(document, name, prop)
957
in self._get_all_dbus_things("property")
958
if prop._dbus_interface
959
== if_tag.getAttribute("name")):
960
if_tag.appendChild(tag)
961
# Add annotation tags
962
for typ in ("method", "signal", "property"):
963
for tag in if_tag.getElementsByTagName(typ):
965
for name, prop in (self.
966
_get_all_dbus_things(typ)):
967
if (name == tag.getAttribute("name")
968
and prop._dbus_interface
969
== if_tag.getAttribute("name")):
970
annots.update(getattr
974
for name, value in annots.iteritems():
975
ann_tag = document.createElement(
977
ann_tag.setAttribute("name", name)
978
ann_tag.setAttribute("value", value)
979
tag.appendChild(ann_tag)
980
# Add interface annotation tags
981
for annotation, value in dict(
982
itertools.chain.from_iterable(
983
annotations().iteritems()
984
for name, annotations in
985
self._get_all_dbus_things("interface")
986
if name == if_tag.getAttribute("name")
988
ann_tag = document.createElement("annotation")
989
ann_tag.setAttribute("name", annotation)
990
ann_tag.setAttribute("value", value)
991
if_tag.appendChild(ann_tag)
992
# Add the names to the return values for the
993
# "org.freedesktop.DBus.Properties" methods
994
if (if_tag.getAttribute("name")
995
== "org.freedesktop.DBus.Properties"):
996
for cn in if_tag.getElementsByTagName("method"):
997
if cn.getAttribute("name") == "Get":
998
for arg in cn.getElementsByTagName("arg"):
999
if (arg.getAttribute("direction")
1001
arg.setAttribute("name", "value")
1002
elif cn.getAttribute("name") == "GetAll":
1003
for arg in cn.getElementsByTagName("arg"):
1004
if (arg.getAttribute("direction")
1006
arg.setAttribute("name", "props")
1007
xmlstring = document.toxml("utf-8")
1009
except (AttributeError, xml.dom.DOMException,
1010
xml.parsers.expat.ExpatError) as error:
1011
logger.error("Failed to override Introspection method",
1016
def datetime_to_dbus (dt, variant_level=0):
1017
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1019
return dbus.String("", variant_level = variant_level)
1020
return dbus.String(dt.isoformat(),
1021
variant_level=variant_level)
1024
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1025
"""A class decorator; applied to a subclass of
1026
dbus.service.Object, it will add alternate D-Bus attributes with
1027
interface names according to the "alt_interface_names" mapping.
1030
@alternate_dbus_names({"org.example.Interface":
1031
"net.example.AlternateInterface"})
1032
class SampleDBusObject(dbus.service.Object):
1033
@dbus.service.method("org.example.Interface")
1034
def SampleDBusMethod():
1037
The above "SampleDBusMethod" on "SampleDBusObject" will be
1038
reachable via two interfaces: "org.example.Interface" and
1039
"net.example.AlternateInterface", the latter of which will have
1040
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1041
"true", unless "deprecate" is passed with a False value.
1043
This works for methods and signals, and also for D-Bus properties
1044
(from DBusObjectWithProperties) and interfaces (from the
1045
dbus_interface_annotations decorator).
1048
for orig_interface_name, alt_interface_name in (
1049
alt_interface_names.iteritems()):
1051
interface_names = set()
1052
# Go though all attributes of the class
1053
for attrname, attribute in inspect.getmembers(cls):
1054
# Ignore non-D-Bus attributes, and D-Bus attributes
1055
# with the wrong interface name
1056
if (not hasattr(attribute, "_dbus_interface")
1057
or not attribute._dbus_interface
1058
.startswith(orig_interface_name)):
1060
# Create an alternate D-Bus interface name based on
1062
alt_interface = (attribute._dbus_interface
1063
.replace(orig_interface_name,
1064
alt_interface_name))
1065
interface_names.add(alt_interface)
1066
# Is this a D-Bus signal?
1067
if getattr(attribute, "_dbus_is_signal", False):
1068
# Extract the original non-method function by
1070
nonmethod_func = (dict(
1071
zip(attribute.func_code.co_freevars,
1072
attribute.__closure__))["func"]
1074
# Create a new, but exactly alike, function
1075
# object, and decorate it to be a new D-Bus signal
1076
# with the alternate D-Bus interface name
1077
new_function = (dbus.service.signal
1079
attribute._dbus_signature)
1080
(types.FunctionType(
1081
nonmethod_func.func_code,
1082
nonmethod_func.func_globals,
1083
nonmethod_func.func_name,
1084
nonmethod_func.func_defaults,
1085
nonmethod_func.func_closure)))
1086
# Copy annotations, if any
1088
new_function._dbus_annotations = (
1089
dict(attribute._dbus_annotations))
1090
except AttributeError:
1092
# Define a creator of a function to call both the
1093
# original and alternate functions, so both the
1094
# original and alternate signals gets sent when
1095
# the function is called
1096
def fixscope(func1, func2):
1097
"""This function is a scope container to pass
1098
func1 and func2 to the "call_both" function
1099
outside of its arguments"""
1100
def call_both(*args, **kwargs):
1101
"""This function will emit two D-Bus
1102
signals by calling func1 and func2"""
1103
func1(*args, **kwargs)
1104
func2(*args, **kwargs)
1106
# Create the "call_both" function and add it to
1108
attr[attrname] = fixscope(attribute, new_function)
1109
# Is this a D-Bus method?
1110
elif getattr(attribute, "_dbus_is_method", False):
1111
# Create a new, but exactly alike, function
1112
# object. Decorate it to be a new D-Bus method
1113
# with the alternate D-Bus interface name. Add it
1115
attr[attrname] = (dbus.service.method
1117
attribute._dbus_in_signature,
1118
attribute._dbus_out_signature)
1120
(attribute.func_code,
1121
attribute.func_globals,
1122
attribute.func_name,
1123
attribute.func_defaults,
1124
attribute.func_closure)))
1125
# Copy annotations, if any
1127
attr[attrname]._dbus_annotations = (
1128
dict(attribute._dbus_annotations))
1129
except AttributeError:
1131
# Is this a D-Bus property?
1132
elif getattr(attribute, "_dbus_is_property", False):
1133
# Create a new, but exactly alike, function
1134
# object, and decorate it to be a new D-Bus
1135
# property with the alternate D-Bus interface
1136
# name. Add it to the class.
1137
attr[attrname] = (dbus_service_property
1139
attribute._dbus_signature,
1140
attribute._dbus_access,
1142
._dbus_get_args_options
1145
(attribute.func_code,
1146
attribute.func_globals,
1147
attribute.func_name,
1148
attribute.func_defaults,
1149
attribute.func_closure)))
1150
# Copy annotations, if any
1152
attr[attrname]._dbus_annotations = (
1153
dict(attribute._dbus_annotations))
1154
except AttributeError:
1156
# Is this a D-Bus interface?
1157
elif getattr(attribute, "_dbus_is_interface", False):
1158
# Create a new, but exactly alike, function
1159
# object. Decorate it to be a new D-Bus interface
1160
# with the alternate D-Bus interface name. Add it
1162
attr[attrname] = (dbus_interface_annotations
1165
(attribute.func_code,
1166
attribute.func_globals,
1167
attribute.func_name,
1168
attribute.func_defaults,
1169
attribute.func_closure)))
1171
# Deprecate all alternate interfaces
1172
iname="_AlternateDBusNames_interface_annotation{0}"
1173
for interface_name in interface_names:
1174
@dbus_interface_annotations(interface_name)
1176
return { "org.freedesktop.DBus.Deprecated":
1178
# Find an unused name
1179
for aname in (iname.format(i)
1180
for i in itertools.count()):
1181
if aname not in attr:
1185
# Replace the class with a new subclass of it with
1186
# methods, signals, etc. as created above.
1187
cls = type(b"{0}Alternate".format(cls.__name__),
1193
@alternate_dbus_interfaces({"se.recompile.Mandos":
1194
"se.bsnet.fukt.Mandos"})
1195
class ClientDBus(Client, DBusObjectWithProperties):
1196
"""A Client class using D-Bus
1199
dbus_object_path: dbus.ObjectPath
1200
bus: dbus.SystemBus()
1203
runtime_expansions = (Client.runtime_expansions
1204
+ ("dbus_object_path",))
1206
# dbus.service.Object doesn't use super(), so we can't either.
1208
def __init__(self, bus = None, *args, **kwargs):
1210
Client.__init__(self, *args, **kwargs)
1211
# Only now, when this client is initialized, can it show up on
1213
client_object_name = unicode(self.name).translate(
1214
{ord("."): ord("_"),
1215
ord("-"): ord("_")})
1216
self.dbus_object_path = (dbus.ObjectPath
1217
("/clients/" + client_object_name))
1218
DBusObjectWithProperties.__init__(self, self.bus,
1219
self.dbus_object_path)
1221
def notifychangeproperty(transform_func,
1222
dbus_name, type_func=lambda x: x,
1224
""" Modify a variable so that it's a property which announces
1225
its changes to DBus.
1227
transform_fun: Function that takes a value and a variant_level
1228
and transforms it to a D-Bus type.
1229
dbus_name: D-Bus name of the variable
1230
type_func: Function that transform the value before sending it
1231
to the D-Bus. Default: no transform
1232
variant_level: D-Bus variant level. Default: 1
1234
attrname = "_{0}".format(dbus_name)
1235
def setter(self, value):
1236
if hasattr(self, "dbus_object_path"):
1237
if (not hasattr(self, attrname) or
1238
type_func(getattr(self, attrname, None))
1239
!= type_func(value)):
1240
dbus_value = transform_func(type_func(value),
1243
self.PropertyChanged(dbus.String(dbus_name),
1245
setattr(self, attrname, value)
1247
return property(lambda self: getattr(self, attrname), setter)
1249
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1250
approvals_pending = notifychangeproperty(dbus.Boolean,
1253
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1254
last_enabled = notifychangeproperty(datetime_to_dbus,
1256
checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1257
type_func = lambda checker:
1258
checker is not None)
1259
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1261
last_checker_status = notifychangeproperty(dbus.Int16,
1262
"LastCheckerStatus")
1263
last_approval_request = notifychangeproperty(
1264
datetime_to_dbus, "LastApprovalRequest")
1265
approved_by_default = notifychangeproperty(dbus.Boolean,
1266
"ApprovedByDefault")
1267
approval_delay = notifychangeproperty(dbus.UInt64,
1270
timedelta_to_milliseconds)
1271
approval_duration = notifychangeproperty(
1272
dbus.UInt64, "ApprovalDuration",
1273
type_func = timedelta_to_milliseconds)
1274
host = notifychangeproperty(dbus.String, "Host")
1275
timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1277
timedelta_to_milliseconds)
1278
extended_timeout = notifychangeproperty(
1279
dbus.UInt64, "ExtendedTimeout",
1280
type_func = timedelta_to_milliseconds)
1281
interval = notifychangeproperty(dbus.UInt64,
1284
timedelta_to_milliseconds)
1285
checker_command = notifychangeproperty(dbus.String, "Checker")
1287
del notifychangeproperty
1289
def __del__(self, *args, **kwargs):
1291
self.remove_from_connection()
1294
if hasattr(DBusObjectWithProperties, "__del__"):
1295
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1296
Client.__del__(self, *args, **kwargs)
1298
def checker_callback(self, pid, condition, command,
1300
self.checker_callback_tag = None
1302
if os.WIFEXITED(condition):
1303
exitstatus = os.WEXITSTATUS(condition)
1305
self.CheckerCompleted(dbus.Int16(exitstatus),
1306
dbus.Int64(condition),
1307
dbus.String(command))
1310
self.CheckerCompleted(dbus.Int16(-1),
1311
dbus.Int64(condition),
1312
dbus.String(command))
1314
return Client.checker_callback(self, pid, condition, command,
1317
def start_checker(self, *args, **kwargs):
1318
old_checker = self.checker
1319
if self.checker is not None:
1320
old_checker_pid = self.checker.pid
1322
old_checker_pid = None
1323
r = Client.start_checker(self, *args, **kwargs)
1324
# Only if new checker process was started
1325
if (self.checker is not None
1326
and old_checker_pid != self.checker.pid):
1328
self.CheckerStarted(self.current_checker_command)
1331
def _reset_approved(self):
1332
self.approved = None
1335
def approve(self, value=True):
1336
self.send_changedstate()
1337
self.approved = value
1338
gobject.timeout_add(timedelta_to_milliseconds
1339
(self.approval_duration),
1340
self._reset_approved)
1342
## D-Bus methods, signals & properties
1343
_interface = "se.recompile.Mandos.Client"
1347
@dbus_interface_annotations(_interface)
1349
return { "org.freedesktop.DBus.Property.EmitsChangedSignal":
460
self.PropertyChanged(dbus.String(u"checker_running"),
461
dbus.Boolean(False, variant_level=1))
463
def still_valid(self):
464
"""Has the timeout not yet passed for this client?"""
465
if not getattr(self, "enabled", False):
467
now = datetime.datetime.utcnow()
468
if self.last_checked_ok is None:
469
return now < (self.created + self.timeout)
471
return now < (self.last_checked_ok + self.timeout)
473
## D-Bus methods & signals
474
_interface = u"se.bsnet.fukt.Mandos.Client"
477
CheckedOK = dbus.service.method(_interface)(checked_ok)
478
CheckedOK.__name__ = "CheckedOK"
1354
480
# CheckerCompleted - signal
1355
481
@dbus.service.signal(_interface, signature="nxs")
1423
605
# StopChecker - method
1424
@dbus.service.method(_interface)
1425
def StopChecker(self):
1430
# ApprovalPending - property
1431
@dbus_service_property(_interface, signature="b", access="read")
1432
def ApprovalPending_dbus_property(self):
1433
return dbus.Boolean(bool(self.approvals_pending))
1435
# ApprovedByDefault - property
1436
@dbus_service_property(_interface, signature="b",
1438
def ApprovedByDefault_dbus_property(self, value=None):
1439
if value is None: # get
1440
return dbus.Boolean(self.approved_by_default)
1441
self.approved_by_default = bool(value)
1443
# ApprovalDelay - property
1444
@dbus_service_property(_interface, signature="t",
1446
def ApprovalDelay_dbus_property(self, value=None):
1447
if value is None: # get
1448
return dbus.UInt64(self.approval_delay_milliseconds())
1449
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1451
# ApprovalDuration - property
1452
@dbus_service_property(_interface, signature="t",
1454
def ApprovalDuration_dbus_property(self, value=None):
1455
if value is None: # get
1456
return dbus.UInt64(timedelta_to_milliseconds(
1457
self.approval_duration))
1458
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1461
@dbus_service_property(_interface, signature="s", access="read")
1462
def Name_dbus_property(self):
1463
return dbus.String(self.name)
1465
# Fingerprint - property
1466
@dbus_service_property(_interface, signature="s", access="read")
1467
def Fingerprint_dbus_property(self):
1468
return dbus.String(self.fingerprint)
1471
@dbus_service_property(_interface, signature="s",
1473
def Host_dbus_property(self, value=None):
1474
if value is None: # get
1475
return dbus.String(self.host)
1476
self.host = unicode(value)
1478
# Created - property
1479
@dbus_service_property(_interface, signature="s", access="read")
1480
def Created_dbus_property(self):
1481
return datetime_to_dbus(self.created)
1483
# LastEnabled - property
1484
@dbus_service_property(_interface, signature="s", access="read")
1485
def LastEnabled_dbus_property(self):
1486
return datetime_to_dbus(self.last_enabled)
1488
# Enabled - property
1489
@dbus_service_property(_interface, signature="b",
1491
def Enabled_dbus_property(self, value=None):
1492
if value is None: # get
1493
return dbus.Boolean(self.enabled)
1499
# LastCheckedOK - property
1500
@dbus_service_property(_interface, signature="s",
1502
def LastCheckedOK_dbus_property(self, value=None):
1503
if value is not None:
1506
return datetime_to_dbus(self.last_checked_ok)
1508
# LastCheckerStatus - property
1509
@dbus_service_property(_interface, signature="n",
1511
def LastCheckerStatus_dbus_property(self):
1512
return dbus.Int16(self.last_checker_status)
1514
# Expires - property
1515
@dbus_service_property(_interface, signature="s", access="read")
1516
def Expires_dbus_property(self):
1517
return datetime_to_dbus(self.expires)
1519
# LastApprovalRequest - property
1520
@dbus_service_property(_interface, signature="s", access="read")
1521
def LastApprovalRequest_dbus_property(self):
1522
return datetime_to_dbus(self.last_approval_request)
1524
# Timeout - property
1525
@dbus_service_property(_interface, signature="t",
1527
def Timeout_dbus_property(self, value=None):
1528
if value is None: # get
1529
return dbus.UInt64(self.timeout_milliseconds())
1530
self.timeout = datetime.timedelta(0, 0, 0, value)
1531
# Reschedule timeout
1533
now = datetime.datetime.utcnow()
1534
time_to_die = timedelta_to_milliseconds(
1535
(self.last_checked_ok + self.timeout) - now)
1536
if time_to_die <= 0:
1537
# The timeout has passed
1540
self.expires = (now +
1541
datetime.timedelta(milliseconds =
1543
if (getattr(self, "disable_initiator_tag", None)
1546
gobject.source_remove(self.disable_initiator_tag)
1547
self.disable_initiator_tag = (gobject.timeout_add
1551
# ExtendedTimeout - property
1552
@dbus_service_property(_interface, signature="t",
1554
def ExtendedTimeout_dbus_property(self, value=None):
1555
if value is None: # get
1556
return dbus.UInt64(self.extended_timeout_milliseconds())
1557
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1559
# Interval - property
1560
@dbus_service_property(_interface, signature="t",
1562
def Interval_dbus_property(self, value=None):
1563
if value is None: # get
1564
return dbus.UInt64(self.interval_milliseconds())
1565
self.interval = datetime.timedelta(0, 0, 0, value)
1566
if getattr(self, "checker_initiator_tag", None) is None:
1569
# Reschedule checker run
1570
gobject.source_remove(self.checker_initiator_tag)
1571
self.checker_initiator_tag = (gobject.timeout_add
1572
(value, self.start_checker))
1573
self.start_checker() # Start one now, too
1575
# Checker - property
1576
@dbus_service_property(_interface, signature="s",
1578
def Checker_dbus_property(self, value=None):
1579
if value is None: # get
1580
return dbus.String(self.checker_command)
1581
self.checker_command = unicode(value)
1583
# CheckerRunning - property
1584
@dbus_service_property(_interface, signature="b",
1586
def CheckerRunning_dbus_property(self, value=None):
1587
if value is None: # get
1588
return dbus.Boolean(self.checker is not None)
1590
self.start_checker()
1594
# ObjectPath - property
1595
@dbus_service_property(_interface, signature="o", access="read")
1596
def ObjectPath_dbus_property(self):
1597
return self.dbus_object_path # is already a dbus.ObjectPath
1600
@dbus_service_property(_interface, signature="ay",
1601
access="write", byte_arrays=True)
1602
def Secret_dbus_property(self, value):
1603
self.secret = str(value)
606
StopChecker = dbus.service.method(_interface)(stop_checker)
607
StopChecker.__name__ = "StopChecker"
1608
class ProxyClient(object):
1609
def __init__(self, child_pipe, fpr, address):
1610
self._pipe = child_pipe
1611
self._pipe.send(('init', fpr, address))
1612
if not self._pipe.recv():
1615
def __getattribute__(self, name):
1617
return super(ProxyClient, self).__getattribute__(name)
1618
self._pipe.send(('getattr', name))
1619
data = self._pipe.recv()
1620
if data[0] == 'data':
1622
if data[0] == 'function':
1623
def func(*args, **kwargs):
1624
self._pipe.send(('funcall', name, args, kwargs))
1625
return self._pipe.recv()[1]
1628
def __setattr__(self, name, value):
1630
return super(ProxyClient, self).__setattr__(name, value)
1631
self._pipe.send(('setattr', name, value))
1634
class ClientHandler(socketserver.BaseRequestHandler, object):
1635
"""A class to handle client connections.
1637
Instantiated once for each connection to handle it.
612
def peer_certificate(session):
613
"Return the peer's OpenPGP certificate as a bytestring"
614
# If not an OpenPGP certificate...
615
if (gnutls.library.functions
616
.gnutls_certificate_type_get(session._c_object)
617
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
618
# ...do the normal thing
619
return session.peer_certificate
620
list_size = ctypes.c_uint(1)
621
cert_list = (gnutls.library.functions
622
.gnutls_certificate_get_peers
623
(session._c_object, ctypes.byref(list_size)))
624
if not bool(cert_list) and list_size.value != 0:
625
raise gnutls.errors.GNUTLSError("error getting peer"
627
if list_size.value == 0:
630
return ctypes.string_at(cert.data, cert.size)
633
def fingerprint(openpgp):
634
"Convert an OpenPGP bytestring to a hexdigit fingerprint string"
635
# New GnuTLS "datum" with the OpenPGP public key
636
datum = (gnutls.library.types
637
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
640
ctypes.c_uint(len(openpgp))))
641
# New empty GnuTLS certificate
642
crt = gnutls.library.types.gnutls_openpgp_crt_t()
643
(gnutls.library.functions
644
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
645
# Import the OpenPGP public key into the certificate
646
(gnutls.library.functions
647
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
648
gnutls.library.constants
649
.GNUTLS_OPENPGP_FMT_RAW))
650
# Verify the self signature in the key
651
crtverify = ctypes.c_uint()
652
(gnutls.library.functions
653
.gnutls_openpgp_crt_verify_self(crt, 0, ctypes.byref(crtverify)))
654
if crtverify.value != 0:
655
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
656
raise gnutls.errors.CertificateSecurityError("Verify failed")
657
# New buffer for the fingerprint
658
buf = ctypes.create_string_buffer(20)
659
buf_len = ctypes.c_size_t()
660
# Get the fingerprint from the certificate into the buffer
661
(gnutls.library.functions
662
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
663
ctypes.byref(buf_len)))
664
# Deinit the certificate
665
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
666
# Convert the buffer to a Python bytestring
667
fpr = ctypes.string_at(buf, buf_len.value)
668
# Convert the bytestring to hexadecimal notation
669
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
673
class TCP_handler(SocketServer.BaseRequestHandler, object):
674
"""A TCP request handler class.
675
Instantiated by IPv6_TCPServer for each request to handle it.
1638
676
Note: This will run in its own forked process."""
1640
678
def handle(self):
1641
with contextlib.closing(self.server.child_pipe) as child_pipe:
1642
logger.info("TCP connection from: %s",
1643
unicode(self.client_address))
1644
logger.debug("Pipe FD: %d",
1645
self.server.child_pipe.fileno())
1647
session = (gnutls.connection
1648
.ClientSession(self.request,
1650
.X509Credentials()))
1652
# Note: gnutls.connection.X509Credentials is really a
1653
# generic GnuTLS certificate credentials object so long as
1654
# no X.509 keys are added to it. Therefore, we can use it
1655
# here despite using OpenPGP certificates.
1657
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1658
# "+AES-256-CBC", "+SHA1",
1659
# "+COMP-NULL", "+CTYPE-OPENPGP",
1661
# Use a fallback default, since this MUST be set.
1662
priority = self.server.gnutls_priority
1663
if priority is None:
1665
(gnutls.library.functions
1666
.gnutls_priority_set_direct(session._c_object,
1669
# Start communication using the Mandos protocol
1670
# Get protocol number
1671
line = self.request.makefile().readline()
1672
logger.debug("Protocol version: %r", line)
1674
if int(line.strip().split()[0]) > 1:
1676
except (ValueError, IndexError, RuntimeError) as error:
1677
logger.error("Unknown protocol version: %s", error)
1680
# Start GnuTLS connection
1683
except gnutls.errors.GNUTLSError as error:
1684
logger.warning("Handshake failed: %s", error)
1685
# Do not run session.bye() here: the session is not
1686
# established. Just abandon the request.
1688
logger.debug("Handshake succeeded")
1690
approval_required = False
1693
fpr = self.fingerprint(self.peer_certificate
1696
gnutls.errors.GNUTLSError) as error:
1697
logger.warning("Bad certificate: %s", error)
1699
logger.debug("Fingerprint: %s", fpr)
1702
client = ProxyClient(child_pipe, fpr,
1703
self.client_address)
1707
if client.approval_delay:
1708
delay = client.approval_delay
1709
client.approvals_pending += 1
1710
approval_required = True
1713
if not client.enabled:
1714
logger.info("Client %s is disabled",
1716
if self.server.use_dbus:
1718
client.Rejected("Disabled")
1721
if client.approved or not client.approval_delay:
1722
#We are approved or approval is disabled
1724
elif client.approved is None:
1725
logger.info("Client %s needs approval",
1727
if self.server.use_dbus:
1729
client.NeedApproval(
1730
client.approval_delay_milliseconds(),
1731
client.approved_by_default)
1733
logger.warning("Client %s was not approved",
1735
if self.server.use_dbus:
1737
client.Rejected("Denied")
1740
#wait until timeout or approved
1741
time = datetime.datetime.now()
1742
client.changedstate.acquire()
1743
(client.changedstate.wait
1744
(float(client.timedelta_to_milliseconds(delay)
1746
client.changedstate.release()
1747
time2 = datetime.datetime.now()
1748
if (time2 - time) >= delay:
1749
if not client.approved_by_default:
1750
logger.warning("Client %s timed out while"
1751
" waiting for approval",
1753
if self.server.use_dbus:
1755
client.Rejected("Approval timed out")
1760
delay -= time2 - time
1763
while sent_size < len(client.secret):
1765
sent = session.send(client.secret[sent_size:])
1766
except gnutls.errors.GNUTLSError as error:
1767
logger.warning("gnutls send failed",
1770
logger.debug("Sent: %d, remaining: %d",
1771
sent, len(client.secret)
1772
- (sent_size + sent))
1775
logger.info("Sending secret to %s", client.name)
1776
# bump the timeout using extended_timeout
1777
client.bump_timeout(client.extended_timeout)
1778
if self.server.use_dbus:
1783
if approval_required:
1784
client.approvals_pending -= 1
1787
except gnutls.errors.GNUTLSError as error:
1788
logger.warning("GnuTLS bye failed",
1792
def peer_certificate(session):
1793
"Return the peer's OpenPGP certificate as a bytestring"
1794
# If not an OpenPGP certificate...
1795
if (gnutls.library.functions
1796
.gnutls_certificate_type_get(session._c_object)
1797
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1798
# ...do the normal thing
1799
return session.peer_certificate
1800
list_size = ctypes.c_uint(1)
1801
cert_list = (gnutls.library.functions
1802
.gnutls_certificate_get_peers
1803
(session._c_object, ctypes.byref(list_size)))
1804
if not bool(cert_list) and list_size.value != 0:
1805
raise gnutls.errors.GNUTLSError("error getting peer"
1807
if list_size.value == 0:
1810
return ctypes.string_at(cert.data, cert.size)
1813
def fingerprint(openpgp):
1814
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
1815
# New GnuTLS "datum" with the OpenPGP public key
1816
datum = (gnutls.library.types
1817
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1820
ctypes.c_uint(len(openpgp))))
1821
# New empty GnuTLS certificate
1822
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1823
(gnutls.library.functions
1824
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
1825
# Import the OpenPGP public key into the certificate
1826
(gnutls.library.functions
1827
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1828
gnutls.library.constants
1829
.GNUTLS_OPENPGP_FMT_RAW))
1830
# Verify the self signature in the key
1831
crtverify = ctypes.c_uint()
1832
(gnutls.library.functions
1833
.gnutls_openpgp_crt_verify_self(crt, 0,
1834
ctypes.byref(crtverify)))
1835
if crtverify.value != 0:
1836
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1837
raise (gnutls.errors.CertificateSecurityError
1839
# New buffer for the fingerprint
1840
buf = ctypes.create_string_buffer(20)
1841
buf_len = ctypes.c_size_t()
1842
# Get the fingerprint from the certificate into the buffer
1843
(gnutls.library.functions
1844
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1845
ctypes.byref(buf_len)))
1846
# Deinit the certificate
1847
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1848
# Convert the buffer to a Python bytestring
1849
fpr = ctypes.string_at(buf, buf_len.value)
1850
# Convert the bytestring to hexadecimal notation
1851
hex_fpr = binascii.hexlify(fpr).upper()
1855
class MultiprocessingMixIn(object):
1856
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
1857
def sub_process_main(self, request, address):
1859
self.finish_request(request, address)
1861
self.handle_error(request, address)
1862
self.close_request(request)
1864
def process_request(self, request, address):
1865
"""Start a new process to process the request."""
1866
proc = multiprocessing.Process(target = self.sub_process_main,
1873
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1874
""" adds a pipe to the MixIn """
1875
def process_request(self, request, client_address):
1876
"""Overrides and wraps the original process_request().
1878
This function creates a new pipe in self.pipe
1880
parent_pipe, self.child_pipe = multiprocessing.Pipe()
1882
proc = MultiprocessingMixIn.process_request(self, request,
1884
self.child_pipe.close()
1885
self.add_pipe(parent_pipe, proc)
1887
def add_pipe(self, parent_pipe, proc):
1888
"""Dummy function; override as necessary"""
1889
raise NotImplementedError
1892
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1893
socketserver.TCPServer, object):
679
logger.info(u"TCP connection from: %s",
680
unicode(self.client_address))
681
session = (gnutls.connection
682
.ClientSession(self.request,
686
line = self.request.makefile().readline()
687
logger.debug(u"Protocol version: %r", line)
689
if int(line.strip().split()[0]) > 1:
691
except (ValueError, IndexError, RuntimeError), error:
692
logger.error(u"Unknown protocol version: %s", error)
695
# Note: gnutls.connection.X509Credentials is really a generic
696
# GnuTLS certificate credentials object so long as no X.509
697
# keys are added to it. Therefore, we can use it here despite
698
# using OpenPGP certificates.
700
#priority = ':'.join(("NONE", "+VERS-TLS1.1", "+AES-256-CBC",
701
# "+SHA1", "+COMP-NULL", "+CTYPE-OPENPGP",
703
# Use a fallback default, since this MUST be set.
704
priority = self.server.settings.get("priority", "NORMAL")
705
(gnutls.library.functions
706
.gnutls_priority_set_direct(session._c_object,
711
except gnutls.errors.GNUTLSError, error:
712
logger.warning(u"Handshake failed: %s", error)
713
# Do not run session.bye() here: the session is not
714
# established. Just abandon the request.
716
logger.debug(u"Handshake succeeded")
718
fpr = fingerprint(peer_certificate(session))
719
except (TypeError, gnutls.errors.GNUTLSError), error:
720
logger.warning(u"Bad certificate: %s", error)
723
logger.debug(u"Fingerprint: %s", fpr)
725
for c in self.server.clients:
726
if c.fingerprint == fpr:
730
logger.warning(u"Client not found for fingerprint: %s",
734
# Have to check if client.still_valid(), since it is possible
735
# that the client timed out while establishing the GnuTLS
737
if not client.still_valid():
738
logger.warning(u"Client %(name)s is invalid",
742
## This won't work here, since we're in a fork.
743
# client.checked_ok()
745
while sent_size < len(client.secret):
746
sent = session.send(client.secret[sent_size:])
747
logger.debug(u"Sent: %d, remaining: %d",
748
sent, len(client.secret)
749
- (sent_size + sent))
754
class IPv6_TCPServer(SocketServer.ForkingMixIn,
755
SocketServer.TCPServer, object):
1894
756
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
758
settings: Server settings
759
clients: Set() of Client objects
1897
760
enabled: Boolean; whether this server is activated yet
1898
interface: None or a network interface name (string)
1899
use_ipv6: Boolean; to use IPv6 or not
1901
def __init__(self, server_address, RequestHandlerClass,
1902
interface=None, use_ipv6=True):
1903
self.interface = interface
1905
self.address_family = socket.AF_INET6
1906
socketserver.TCPServer.__init__(self, server_address,
1907
RequestHandlerClass)
762
address_family = socket.AF_INET6
763
def __init__(self, *args, **kwargs):
764
if "settings" in kwargs:
765
self.settings = kwargs["settings"]
766
del kwargs["settings"]
767
if "clients" in kwargs:
768
self.clients = kwargs["clients"]
769
del kwargs["clients"]
770
if "use_ipv6" in kwargs:
771
if not kwargs["use_ipv6"]:
772
self.address_family = socket.AF_INET
773
del kwargs["use_ipv6"]
775
super(IPv6_TCPServer, self).__init__(*args, **kwargs)
1908
776
def server_bind(self):
1909
777
"""This overrides the normal server_bind() function
1910
778
to bind to an interface if one was specified, and also NOT to
1911
779
bind to an address or port if they were not specified."""
1912
if self.interface is not None:
1913
if SO_BINDTODEVICE is None:
1914
logger.error("SO_BINDTODEVICE does not exist;"
1915
" cannot bind to interface %s",
1919
self.socket.setsockopt(socket.SOL_SOCKET,
1923
except socket.error as error:
1924
if error[0] == errno.EPERM:
1925
logger.error("No permission to"
1926
" bind to interface %s",
1928
elif error[0] == errno.ENOPROTOOPT:
1929
logger.error("SO_BINDTODEVICE not available;"
1930
" cannot bind to interface %s",
780
if self.settings["interface"]:
781
# 25 is from /usr/include/asm-i486/socket.h
782
SO_BINDTODEVICE = getattr(socket, "SO_BINDTODEVICE", 25)
784
self.socket.setsockopt(socket.SOL_SOCKET,
786
self.settings["interface"])
787
except socket.error, error:
788
if error[0] == errno.EPERM:
789
logger.error(u"No permission to"
790
u" bind to interface %s",
791
self.settings["interface"])
1934
794
# Only bind(2) the socket if we really need to.
1935
795
if self.server_address[0] or self.server_address[1]:
1936
796
if not self.server_address[0]:
2315
1072
(gnutls.library.functions
2316
1073
.gnutls_global_set_log_function(debug_gnutls))
2318
# Redirect stdin so all checkers get /dev/null
2319
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2320
os.dup2(null, sys.stdin.fileno())
2324
# Need to fork before connecting to D-Bus
2326
# Close all input and output, do double fork, etc.
2329
gobject.threads_init()
1076
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1077
service = AvahiService(name = server_settings["servicename"],
1078
servicetype = "_mandos._tcp",
1079
protocol = protocol)
1080
if server_settings["interface"]:
1081
service.interface = (if_nametoindex
1082
(server_settings["interface"]))
2331
1084
global main_loop
2332
1087
# From the Avahi example code
2333
DBusGMainLoop(set_as_default=True)
1088
DBusGMainLoop(set_as_default=True )
2334
1089
main_loop = gobject.MainLoop()
2335
1090
bus = dbus.SystemBus()
1091
server = dbus.Interface(bus.get_object(avahi.DBUS_NAME,
1092
avahi.DBUS_PATH_SERVER),
1093
avahi.DBUS_INTERFACE_SERVER)
2336
1094
# End of Avahi example code
2339
bus_name = dbus.service.BusName("se.recompile.Mandos",
2340
bus, do_not_queue=True)
2341
old_bus_name = (dbus.service.BusName
2342
("se.bsnet.fukt.Mandos", bus,
2344
except dbus.exceptions.NameExistsException as e:
2345
logger.error("Disabling D-Bus:", exc_info=e)
2347
server_settings["use_dbus"] = False
2348
tcp_server.use_dbus = False
2349
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2350
service = AvahiServiceToSyslog(name =
2351
server_settings["servicename"],
2352
servicetype = "_mandos._tcp",
2353
protocol = protocol, bus = bus)
2354
if server_settings["interface"]:
2355
service.interface = (if_nametoindex
2356
(str(server_settings["interface"])))
2358
global multiprocessing_manager
2359
multiprocessing_manager = multiprocessing.Manager()
2361
client_class = Client
2363
client_class = functools.partial(ClientDBus, bus = bus)
2365
client_settings = Client.config_parser(client_config)
2366
old_client_settings = {}
2369
# Get client data and settings from last running state.
2370
if server_settings["restore"]:
2372
with open(stored_state_path, "rb") as stored_state:
2373
clients_data, old_client_settings = (pickle.load
2375
os.remove(stored_state_path)
2376
except IOError as e:
2377
if e.errno == errno.ENOENT:
2378
logger.warning("Could not load persistent state: {0}"
2379
.format(os.strerror(e.errno)))
2381
logger.critical("Could not load persistent state:",
2384
except EOFError as e:
2385
logger.warning("Could not load persistent state: "
2386
"EOFError:", exc_info=e)
2388
with PGPEngine() as pgp:
2389
for client_name, client in clients_data.iteritems():
2390
# Decide which value to use after restoring saved state.
2391
# We have three different values: Old config file,
2392
# new config file, and saved state.
2393
# New config value takes precedence if it differs from old
2394
# config value, otherwise use saved state.
2395
for name, value in client_settings[client_name].items():
2397
# For each value in new config, check if it
2398
# differs from the old config value (Except for
2399
# the "secret" attribute)
2400
if (name != "secret" and
2401
value != old_client_settings[client_name]
2403
client[name] = value
2407
# Clients who has passed its expire date can still be
2408
# enabled if its last checker was successful. Clients
2409
# whose checker succeeded before we stored its state is
2410
# assumed to have successfully run all checkers during
2412
if client["enabled"]:
2413
if datetime.datetime.utcnow() >= client["expires"]:
2414
if not client["last_checked_ok"]:
2416
"disabling client {0} - Client never "
2417
"performed a successful checker"
2418
.format(client_name))
2419
client["enabled"] = False
2420
elif client["last_checker_status"] != 0:
2422
"disabling client {0} - Client "
2423
"last checker failed with error code {1}"
2424
.format(client_name,
2425
client["last_checker_status"]))
2426
client["enabled"] = False
2428
client["expires"] = (datetime.datetime
2430
+ client["timeout"])
2431
logger.debug("Last checker succeeded,"
2432
" keeping {0} enabled"
2433
.format(client_name))
2435
client["secret"] = (
2436
pgp.decrypt(client["encrypted_secret"],
2437
client_settings[client_name]
2440
# If decryption fails, we use secret from new settings
2441
logger.debug("Failed to decrypt {0} old secret"
2442
.format(client_name))
2443
client["secret"] = (
2444
client_settings[client_name]["secret"])
2446
# Add/remove clients based on new changes made to config
2447
for client_name in (set(old_client_settings)
2448
- set(client_settings)):
2449
del clients_data[client_name]
2450
for client_name in (set(client_settings)
2451
- set(old_client_settings)):
2452
clients_data[client_name] = client_settings[client_name]
2454
# Create all client objects
2455
for client_name, client in clients_data.iteritems():
2456
tcp_server.clients[client_name] = client_class(
2457
name = client_name, settings = client)
2459
if not tcp_server.clients:
2460
logger.warning("No clients defined")
1096
bus_name = dbus.service.BusName(u"se.bsnet.fukt.Mandos", bus)
1098
clients.update(Set(Client(name = section,
1100
= dict(client_config.items(section)),
1101
use_dbus = use_dbus)
1102
for section in client_config.sections()))
1104
logger.warning(u"No clients defined")
1107
# Redirect stdin so all checkers get /dev/null
1108
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
1109
os.dup2(null, sys.stdin.fileno())
1113
# No console logging
1114
logger.removeHandler(console)
1115
# Close all input and output, do double fork, etc.
1120
pidfile.write(str(pid) + "\n")
1124
logger.error(u"Could not write to file %r with PID %d",
1127
# "pidfile" was never created
1132
"Cleanup function; run on exit"
1134
# From the Avahi example code
1135
if not group is None:
1138
# End of Avahi example code
1141
client = clients.pop()
1142
client.disable_hook = None
1145
atexit.register(cleanup)
2466
pidfile.write(str(pid) + "\n".encode("utf-8"))
2469
logger.error("Could not write to file %r with PID %d",
2472
# "pidfile" was never created
2475
1148
signal.signal(signal.SIGINT, signal.SIG_IGN)
2477
1149
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2478
1150
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2481
@alternate_dbus_interfaces({"se.recompile.Mandos":
2482
"se.bsnet.fukt.Mandos"})
2483
class MandosDBusService(DBusObjectWithProperties):
1153
class MandosServer(dbus.service.Object):
2484
1154
"""A D-Bus proxy object"""
2485
1155
def __init__(self):
2486
1156
dbus.service.Object.__init__(self, bus, "/")
2487
_interface = "se.recompile.Mandos"
2489
@dbus_interface_annotations(_interface)
2491
return { "org.freedesktop.DBus.Property"
2492
".EmitsChangedSignal":
2495
@dbus.service.signal(_interface, signature="o")
2496
def ClientAdded(self, objpath):
2500
@dbus.service.signal(_interface, signature="ss")
2501
def ClientNotFound(self, fingerprint, address):
1157
_interface = u"se.bsnet.fukt.Mandos"
1159
@dbus.service.signal(_interface, signature="oa{sv}")
1160
def ClientAdded(self, objpath, properties):