258
125
self.rename_count = 0
259
126
self.max_renames = max_renames
260
self.protocol = protocol
261
self.group = None # our entry group
264
self.entry_group_state_changed_match = None
265
127
def rename(self):
266
128
"""Derived from the Avahi example code"""
267
129
if self.rename_count >= self.max_renames:
268
logger.critical("No suitable Zeroconf service name found"
269
" after %i retries, exiting.",
130
logger.critical(u"No suitable Zeroconf service name found"
131
u" after %i retries, exiting.",
270
132
self.rename_count)
271
raise AvahiServiceError("Too many renames")
272
self.name = unicode(self.server
273
.GetAlternativeServiceName(self.name))
274
logger.info("Changing Zeroconf service name to %r ...",
133
raise AvahiServiceError(u"Too many renames")
134
self.name = server.GetAlternativeServiceName(self.name)
135
logger.info(u"Changing Zeroconf service name to %r ...",
137
syslogger.setFormatter(logging.Formatter
138
('Mandos (%s): %%(levelname)s:'
139
' %%(message)s' % self.name))
279
except dbus.exceptions.DBusException as error:
280
logger.critical("DBusException: %s", error)
283
142
self.rename_count += 1
284
143
def remove(self):
285
144
"""Derived from the Avahi example code"""
286
if self.entry_group_state_changed_match is not None:
287
self.entry_group_state_changed_match.remove()
288
self.entry_group_state_changed_match = None
289
if self.group is not None:
145
if group is not None:
292
148
"""Derived from the Avahi example code"""
294
if self.group is None:
295
self.group = dbus.Interface(
296
self.bus.get_object(avahi.DBUS_NAME,
297
self.server.EntryGroupNew()),
298
avahi.DBUS_INTERFACE_ENTRY_GROUP)
299
self.entry_group_state_changed_match = (
300
self.group.connect_to_signal(
301
'StateChanged', self.entry_group_state_changed))
302
logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
303
self.name, self.type)
304
self.group.AddService(
307
dbus.UInt32(0), # flags
308
self.name, self.type,
309
self.domain, self.host,
310
dbus.UInt16(self.port),
311
avahi.string_array_to_txt_array(self.TXT))
313
def entry_group_state_changed(self, state, error):
314
"""Derived from the Avahi example code"""
315
logger.debug("Avahi entry group state change: %i", state)
317
if state == avahi.ENTRY_GROUP_ESTABLISHED:
318
logger.debug("Zeroconf service established.")
319
elif state == avahi.ENTRY_GROUP_COLLISION:
320
logger.info("Zeroconf service name collision.")
322
elif state == avahi.ENTRY_GROUP_FAILURE:
323
logger.critical("Avahi: Error in group state changed %s",
325
raise AvahiGroupError("State changed: %s"
328
"""Derived from the Avahi example code"""
329
if self.group is not None:
332
except (dbus.exceptions.UnknownMethodException,
333
dbus.exceptions.DBusException):
337
def server_state_changed(self, state, error=None):
338
"""Derived from the Avahi example code"""
339
logger.debug("Avahi server state change: %i", state)
340
bad_states = { avahi.SERVER_INVALID:
341
"Zeroconf server invalid",
342
avahi.SERVER_REGISTERING: None,
343
avahi.SERVER_COLLISION:
344
"Zeroconf server name collision",
345
avahi.SERVER_FAILURE:
346
"Zeroconf server failure" }
347
if state in bad_states:
348
if bad_states[state] is not None:
350
logger.error(bad_states[state])
352
logger.error(bad_states[state] + ": %r", error)
354
elif state == avahi.SERVER_RUNNING:
358
logger.debug("Unknown state: %r", state)
360
logger.debug("Unknown state: %r: %r", state, error)
362
"""Derived from the Avahi example code"""
363
if self.server is None:
364
self.server = dbus.Interface(
365
self.bus.get_object(avahi.DBUS_NAME,
366
avahi.DBUS_PATH_SERVER,
367
follow_name_owner_changes=True),
368
avahi.DBUS_INTERFACE_SERVER)
369
self.server.connect_to_signal("StateChanged",
370
self.server_state_changed)
371
self.server_state_changed(self.server.GetState())
373
class AvahiServiceToSyslog(AvahiService):
375
"""Add the new name to the syslog messages"""
376
ret = AvahiService.rename(self)
377
syslogger.setFormatter(logging.Formatter
378
('Mandos (%s) [%%(process)d]:'
379
' %%(levelname)s: %%(message)s'
383
def timedelta_to_milliseconds(td):
384
"Convert a datetime.timedelta() to milliseconds"
385
return ((td.days * 24 * 60 * 60 * 1000)
386
+ (td.seconds * 1000)
387
+ (td.microseconds // 1000))
389
class Client(object):
151
group = dbus.Interface(bus.get_object
153
server.EntryGroupNew()),
154
avahi.DBUS_INTERFACE_ENTRY_GROUP)
155
group.connect_to_signal('StateChanged',
156
entry_group_state_changed)
157
logger.debug(u"Adding Zeroconf service '%s' of type '%s' ...",
158
service.name, service.type)
160
self.interface, # interface
161
avahi.PROTO_INET6, # protocol
162
dbus.UInt32(0), # flags
163
self.name, self.type,
164
self.domain, self.host,
165
dbus.UInt16(self.port),
166
avahi.string_array_to_txt_array(self.TXT))
169
# From the Avahi example code:
170
group = None # our entry group
171
# End of Avahi example code
174
def _datetime_to_dbus(dt, variant_level=0):
175
"""Convert a UTC datetime.datetime() to a D-Bus type."""
176
return dbus.String(dt.isoformat(), variant_level=variant_level)
179
class Client(dbus.service.Object):
390
180
"""A representation of a client host served by this server.
393
approved: bool(); 'None' if not yet approved/disapproved
394
approval_delay: datetime.timedelta(); Time to wait for approval
395
approval_duration: datetime.timedelta(); Duration of one approval
182
name: string; from the config file, used in log messages and
184
fingerprint: string (40 or 32 hexadecimal digits); used to
185
uniquely identify the client
186
secret: bytestring; sent verbatim (over TLS) to client
187
host: string; available for use by the checker command
188
created: datetime.datetime(); (UTC) object creation
189
last_enabled: datetime.datetime(); (UTC)
191
last_checked_ok: datetime.datetime(); (UTC) or None
192
timeout: datetime.timedelta(); How long from last_checked_ok
193
until this client is invalid
194
interval: datetime.timedelta(); How often to start a new checker
195
disable_hook: If set, called by disable() as disable_hook(self)
396
196
checker: subprocess.Popen(); a running checker process used
397
197
to see if the client lives.
398
198
'None' if no process is running.
399
checker_callback_tag: a gobject event source tag, or None
400
checker_command: string; External command which is run to check
401
if client lives. %() expansions are done at
199
checker_initiator_tag: a gobject event source tag, or None
200
disable_initiator_tag: - '' -
201
checker_callback_tag: - '' -
202
checker_command: string; External command which is run to check if
203
client lives. %() expansions are done at
402
204
runtime with vars(self) as dict, so that for
403
205
instance %(name)s can be used in the command.
404
checker_initiator_tag: a gobject event source tag, or None
405
created: datetime.datetime(); (UTC) object creation
406
client_structure: Object describing what attributes a client has
407
and is used for storing the client at exit
408
current_checker_command: string; current running checker_command
409
disable_initiator_tag: a gobject event source tag, or None
411
fingerprint: string (40 or 32 hexadecimal digits); used to
412
uniquely identify the client
413
host: string; available for use by the checker command
414
interval: datetime.timedelta(); How often to start a new checker
415
last_approval_request: datetime.datetime(); (UTC) or None
416
last_checked_ok: datetime.datetime(); (UTC) or None
417
last_checker_status: integer between 0 and 255 reflecting exit
418
status of last checker. -1 reflects crashed
419
checker, -2 means no checker completed yet.
420
last_enabled: datetime.datetime(); (UTC) or None
421
name: string; from the config file, used in log messages and
423
secret: bytestring; sent verbatim (over TLS) to client
424
timeout: datetime.timedelta(); How long from last_checked_ok
425
until this client is disabled
426
extended_timeout: extra long timeout when secret has been sent
427
runtime_expansions: Allowed attributes for runtime expansion.
428
expires: datetime.datetime(); time (UTC) when a client will be
206
use_dbus: bool(); Whether to provide D-Bus interface and signals
207
dbus_object_path: dbus.ObjectPath ; only set if self.use_dbus
432
runtime_expansions = ("approval_delay", "approval_duration",
433
"created", "enabled", "fingerprint",
434
"host", "interval", "last_checked_ok",
435
"last_enabled", "name", "timeout")
436
client_defaults = { "timeout": "5m",
437
"extended_timeout": "15m",
439
"checker": "fping -q -- %%(host)s",
441
"approval_delay": "0s",
442
"approval_duration": "1s",
443
"approved_by_default": "True",
447
209
def timeout_milliseconds(self):
448
210
"Return the 'timeout' attribute in milliseconds"
449
return timedelta_to_milliseconds(self.timeout)
451
def extended_timeout_milliseconds(self):
452
"Return the 'extended_timeout' attribute in milliseconds"
453
return timedelta_to_milliseconds(self.extended_timeout)
211
return ((self.timeout.days * 24 * 60 * 60 * 1000)
212
+ (self.timeout.seconds * 1000)
213
+ (self.timeout.microseconds // 1000))
455
215
def interval_milliseconds(self):
456
216
"Return the 'interval' attribute in milliseconds"
457
return timedelta_to_milliseconds(self.interval)
217
return ((self.interval.days * 24 * 60 * 60 * 1000)
218
+ (self.interval.seconds * 1000)
219
+ (self.interval.microseconds // 1000))
459
def approval_delay_milliseconds(self):
460
return timedelta_to_milliseconds(self.approval_delay)
463
def config_parser(config):
464
"""Construct a new dict of client settings of this form:
465
{ client_name: {setting_name: value, ...}, ...}
466
with exceptions for any special settings as defined above.
467
NOTE: Must be a pure function. Must return the same result
468
value given the same arguments.
471
for client_name in config.sections():
472
section = dict(config.items(client_name))
473
client = settings[client_name] = {}
475
client["host"] = section["host"]
476
# Reformat values from string types to Python types
477
client["approved_by_default"] = config.getboolean(
478
client_name, "approved_by_default")
479
client["enabled"] = config.getboolean(client_name,
482
client["fingerprint"] = (section["fingerprint"].upper()
484
if "secret" in section:
485
client["secret"] = section["secret"].decode("base64")
486
elif "secfile" in section:
487
with open(os.path.expanduser(os.path.expandvars
488
(section["secfile"])),
490
client["secret"] = secfile.read()
492
raise TypeError("No secret or secfile for section %s"
494
client["timeout"] = string_to_delta(section["timeout"])
495
client["extended_timeout"] = string_to_delta(
496
section["extended_timeout"])
497
client["interval"] = string_to_delta(section["interval"])
498
client["approval_delay"] = string_to_delta(
499
section["approval_delay"])
500
client["approval_duration"] = string_to_delta(
501
section["approval_duration"])
502
client["checker_command"] = section["checker"]
503
client["last_approval_request"] = None
504
client["last_checked_ok"] = None
505
client["last_checker_status"] = -2
510
def __init__(self, settings, name = None):
221
def __init__(self, name = None, disable_hook=None, config=None,
511
223
"""Note: the 'checker' key in 'config' sets the
512
224
'checker_command' attribute and *not* the 'checker'
515
# adding all client settings
516
for setting, value in settings.iteritems():
517
setattr(self, setting, value)
520
if not hasattr(self, "last_enabled"):
521
self.last_enabled = datetime.datetime.utcnow()
522
if not hasattr(self, "expires"):
523
self.expires = (datetime.datetime.utcnow()
526
self.last_enabled = None
529
logger.debug("Creating client %r", self.name)
229
logger.debug(u"Creating client %r", self.name)
230
self.use_dbus = False # During __init__
530
231
# Uppercase and remove spaces from fingerprint for later
531
232
# comparison purposes with return value from the fingerprint()
533
logger.debug(" Fingerprint: %s", self.fingerprint)
534
self.created = settings.get("created",
535
datetime.datetime.utcnow())
537
# attributes specific for this server instance
234
self.fingerprint = (config["fingerprint"].upper()
236
logger.debug(u" Fingerprint: %s", self.fingerprint)
237
if "secret" in config:
238
self.secret = config["secret"].decode(u"base64")
239
elif "secfile" in config:
240
with closing(open(os.path.expanduser
242
(config["secfile"])))) as secfile:
243
self.secret = secfile.read()
245
raise TypeError(u"No secret or secfile for client %s"
247
self.host = config.get("host", "")
248
self.created = datetime.datetime.utcnow()
250
self.last_enabled = None
251
self.last_checked_ok = None
252
self.timeout = string_to_delta(config["timeout"])
253
self.interval = string_to_delta(config["interval"])
254
self.disable_hook = disable_hook
538
255
self.checker = None
539
256
self.checker_initiator_tag = None
540
257
self.disable_initiator_tag = None
541
258
self.checker_callback_tag = None
542
self.current_checker_command = None
544
self.approvals_pending = 0
545
self.changedstate = (multiprocessing_manager
546
.Condition(multiprocessing_manager
548
self.client_structure = [attr for attr in
549
self.__dict__.iterkeys()
550
if not attr.startswith("_")]
551
self.client_structure.append("client_structure")
553
for name, t in inspect.getmembers(type(self),
557
if not name.startswith("_"):
558
self.client_structure.append(name)
560
# Send notice to process children that client state has changed
561
def send_changedstate(self):
562
with self.changedstate:
563
self.changedstate.notify_all()
259
self.checker_command = config["checker"]
260
self.last_connect = None
261
# Only now, when this client is initialized, can it show up on
263
self.use_dbus = use_dbus
265
self.dbus_object_path = (dbus.ObjectPath
267
+ self.name.replace(".", "_")))
268
dbus.service.Object.__init__(self, bus,
269
self.dbus_object_path)
565
271
def enable(self):
566
272
"""Start this client's checker and timeout hooks"""
567
if getattr(self, "enabled", False):
570
self.send_changedstate()
571
self.expires = datetime.datetime.utcnow() + self.timeout
573
273
self.last_enabled = datetime.datetime.utcnow()
576
def disable(self, quiet=True):
577
"""Disable this client."""
578
if not getattr(self, "enabled", False):
581
self.send_changedstate()
583
logger.info("Disabling client %s", self.name)
584
if getattr(self, "disable_initiator_tag", False):
585
gobject.source_remove(self.disable_initiator_tag)
586
self.disable_initiator_tag = None
588
if getattr(self, "checker_initiator_tag", False):
589
gobject.source_remove(self.checker_initiator_tag)
590
self.checker_initiator_tag = None
593
# Do not run this again if called by a gobject.timeout_add
599
def init_checker(self):
600
274
# Schedule a new checker to be started an 'interval' from now,
601
275
# and every interval from then on.
602
276
self.checker_initiator_tag = (gobject.timeout_add
603
277
(self.interval_milliseconds(),
604
278
self.start_checker))
279
# Also start a new checker *right now*.
605
281
# Schedule a disable() when 'timeout' has passed
606
282
self.disable_initiator_tag = (gobject.timeout_add
607
283
(self.timeout_milliseconds(),
609
# Also start a new checker *right now*.
288
self.PropertyChanged(dbus.String(u"enabled"),
289
dbus.Boolean(True, variant_level=1))
290
self.PropertyChanged(dbus.String(u"last_enabled"),
291
(_datetime_to_dbus(self.last_enabled,
295
"""Disable this client."""
296
if not getattr(self, "enabled", False):
298
logger.info(u"Disabling client %s", self.name)
299
if getattr(self, "disable_initiator_tag", False):
300
gobject.source_remove(self.disable_initiator_tag)
301
self.disable_initiator_tag = None
302
if getattr(self, "checker_initiator_tag", False):
303
gobject.source_remove(self.checker_initiator_tag)
304
self.checker_initiator_tag = None
306
if self.disable_hook:
307
self.disable_hook(self)
311
self.PropertyChanged(dbus.String(u"enabled"),
312
dbus.Boolean(False, variant_level=1))
313
# Do not run this again if called by a gobject.timeout_add
317
self.disable_hook = None
612
320
def checker_callback(self, pid, condition, command):
613
321
"""The checker has completed, so take appropriate actions."""
614
322
self.checker_callback_tag = None
615
323
self.checker = None
326
self.PropertyChanged(dbus.String(u"checker_running"),
327
dbus.Boolean(False, variant_level=1))
616
328
if os.WIFEXITED(condition):
617
self.last_checker_status = os.WEXITSTATUS(condition)
618
if self.last_checker_status == 0:
619
logger.info("Checker for %(name)s succeeded",
329
exitstatus = os.WEXITSTATUS(condition)
331
logger.info(u"Checker for %(name)s succeeded",
621
333
self.checked_ok()
623
logger.info("Checker for %(name)s failed",
335
logger.info(u"Checker for %(name)s failed",
339
self.CheckerCompleted(dbus.Int16(exitstatus),
340
dbus.Int64(condition),
341
dbus.String(command))
626
self.last_checker_status = -1
627
logger.warning("Checker for %(name)s crashed?",
343
logger.warning(u"Checker for %(name)s crashed?",
347
self.CheckerCompleted(dbus.Int16(-1),
348
dbus.Int64(condition),
349
dbus.String(command))
630
351
def checked_ok(self):
631
"""Assert that the client has been seen, alive and well."""
352
"""Bump up the timeout for this client.
353
This should only be called when the client has been seen,
632
356
self.last_checked_ok = datetime.datetime.utcnow()
633
self.last_checker_status = 0
636
def bump_timeout(self, timeout=None):
637
"""Bump up the timeout for this client."""
639
timeout = self.timeout
640
if self.disable_initiator_tag is not None:
641
gobject.source_remove(self.disable_initiator_tag)
642
if getattr(self, "enabled", False):
643
self.disable_initiator_tag = (gobject.timeout_add
644
(timedelta_to_milliseconds
645
(timeout), self.disable))
646
self.expires = datetime.datetime.utcnow() + timeout
648
def need_approval(self):
649
self.last_approval_request = datetime.datetime.utcnow()
357
gobject.source_remove(self.disable_initiator_tag)
358
self.disable_initiator_tag = (gobject.timeout_add
359
(self.timeout_milliseconds(),
363
self.PropertyChanged(
364
dbus.String(u"last_checked_ok"),
365
(_datetime_to_dbus(self.last_checked_ok,
651
368
def start_checker(self):
652
369
"""Start a new checker subprocess if one is not running.
654
370
If a checker already exists, leave it running and do
656
372
# The reason for not killing a running checker is that if we
730
425
self.checker_callback_tag = None
731
426
if getattr(self, "checker", None) is None:
733
logger.debug("Stopping checker for %(name)s", vars(self))
428
logger.debug(u"Stopping checker for %(name)s", vars(self))
735
430
os.kill(self.checker.pid, signal.SIGTERM)
737
432
#if self.checker.poll() is None:
738
433
# os.kill(self.checker.pid, signal.SIGKILL)
739
except OSError as error:
434
except OSError, error:
740
435
if error.errno != errno.ESRCH: # No such process
742
437
self.checker = None
745
def dbus_service_property(dbus_interface, signature="v",
746
access="readwrite", byte_arrays=False):
747
"""Decorators for marking methods of a DBusObjectWithProperties to
748
become properties on the D-Bus.
750
The decorated method will be called with no arguments by "Get"
751
and with one argument by "Set".
753
The parameters, where they are supported, are the same as
754
dbus.service.method, except there is only "signature", since the
755
type from Get() and the type sent to Set() is the same.
757
# Encoding deeply encoded byte arrays is not supported yet by the
758
# "Set" method, so we fail early here:
759
if byte_arrays and signature != "ay":
760
raise ValueError("Byte arrays not supported for non-'ay'"
761
" signature %r" % signature)
763
func._dbus_is_property = True
764
func._dbus_interface = dbus_interface
765
func._dbus_signature = signature
766
func._dbus_access = access
767
func._dbus_name = func.__name__
768
if func._dbus_name.endswith("_dbus_property"):
769
func._dbus_name = func._dbus_name[:-14]
770
func._dbus_get_args_options = {'byte_arrays': byte_arrays }
775
def dbus_interface_annotations(dbus_interface):
776
"""Decorator for marking functions returning interface annotations.
780
@dbus_interface_annotations("org.example.Interface")
781
def _foo(self): # Function name does not matter
782
return {"org.freedesktop.DBus.Deprecated": "true",
783
"org.freedesktop.DBus.Property.EmitsChangedSignal":
787
func._dbus_is_interface = True
788
func._dbus_interface = dbus_interface
789
func._dbus_name = dbus_interface
794
class DBusPropertyException(dbus.exceptions.DBusException):
795
"""A base class for D-Bus property-related exceptions
797
def __unicode__(self):
798
return unicode(str(self))
801
class DBusPropertyAccessException(DBusPropertyException):
802
"""A property's access permissions disallows an operation.
807
class DBusPropertyNotFound(DBusPropertyException):
808
"""An attempt was made to access a non-existing property.
813
class DBusObjectWithProperties(dbus.service.Object):
814
"""A D-Bus object with properties.
816
Classes inheriting from this can use the dbus_service_property
817
decorator to expose methods as D-Bus properties. It exposes the
818
standard Get(), Set(), and GetAll() methods on the D-Bus.
822
def _is_dbus_thing(thing):
823
"""Returns a function testing if an attribute is a D-Bus thing
825
If called like _is_dbus_thing("method") it returns a function
826
suitable for use as predicate to inspect.getmembers().
828
return lambda obj: getattr(obj, "_dbus_is_{0}".format(thing),
831
def _get_all_dbus_things(self, thing):
832
"""Returns a generator of (name, attribute) pairs
834
return ((athing.__get__(self)._dbus_name,
835
athing.__get__(self))
836
for cls in self.__class__.__mro__
838
inspect.getmembers(cls,
839
self._is_dbus_thing(thing)))
841
def _get_dbus_property(self, interface_name, property_name):
842
"""Returns a bound method if one exists which is a D-Bus
843
property with the specified name and interface.
845
for cls in self.__class__.__mro__:
846
for name, value in (inspect.getmembers
848
self._is_dbus_thing("property"))):
849
if (value._dbus_name == property_name
850
and value._dbus_interface == interface_name):
851
return value.__get__(self)
854
raise DBusPropertyNotFound(self.dbus_object_path + ":"
855
+ interface_name + "."
858
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
860
def Get(self, interface_name, property_name):
861
"""Standard D-Bus property Get() method, see D-Bus standard.
863
prop = self._get_dbus_property(interface_name, property_name)
864
if prop._dbus_access == "write":
865
raise DBusPropertyAccessException(property_name)
867
if not hasattr(value, "variant_level"):
869
return type(value)(value, variant_level=value.variant_level+1)
871
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
872
def Set(self, interface_name, property_name, value):
873
"""Standard D-Bus property Set() method, see D-Bus standard.
875
prop = self._get_dbus_property(interface_name, property_name)
876
if prop._dbus_access == "read":
877
raise DBusPropertyAccessException(property_name)
878
if prop._dbus_get_args_options["byte_arrays"]:
879
# The byte_arrays option is not supported yet on
880
# signatures other than "ay".
881
if prop._dbus_signature != "ay":
883
value = dbus.ByteArray(b''.join(chr(byte)
887
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
888
out_signature="a{sv}")
889
def GetAll(self, interface_name):
890
"""Standard D-Bus property GetAll() method, see D-Bus
893
Note: Will not include properties with access="write".
896
for name, prop in self._get_all_dbus_things("property"):
898
and interface_name != prop._dbus_interface):
899
# Interface non-empty but did not match
901
# Ignore write-only properties
902
if prop._dbus_access == "write":
905
if not hasattr(value, "variant_level"):
906
properties[name] = value
908
properties[name] = type(value)(value, variant_level=
909
value.variant_level+1)
910
return dbus.Dictionary(properties, signature="sv")
912
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
914
path_keyword='object_path',
915
connection_keyword='connection')
916
def Introspect(self, object_path, connection):
917
"""Overloading of standard D-Bus method.
919
Inserts property tags and interface annotation tags.
921
xmlstring = dbus.service.Object.Introspect(self, object_path,
924
document = xml.dom.minidom.parseString(xmlstring)
925
def make_tag(document, name, prop):
926
e = document.createElement("property")
927
e.setAttribute("name", name)
928
e.setAttribute("type", prop._dbus_signature)
929
e.setAttribute("access", prop._dbus_access)
931
for if_tag in document.getElementsByTagName("interface"):
933
for tag in (make_tag(document, name, prop)
935
in self._get_all_dbus_things("property")
936
if prop._dbus_interface
937
== if_tag.getAttribute("name")):
938
if_tag.appendChild(tag)
939
# Add interface annotation tags
940
for annotation, value in dict(
942
*(annotations().iteritems()
943
for name, annotations in
944
self._get_all_dbus_things("interface")
945
if name == if_tag.getAttribute("name")
947
attr_tag = document.createElement("annotation")
948
attr_tag.setAttribute("name", annotation)
949
attr_tag.setAttribute("value", value)
950
if_tag.appendChild(attr_tag)
951
# Add the names to the return values for the
952
# "org.freedesktop.DBus.Properties" methods
953
if (if_tag.getAttribute("name")
954
== "org.freedesktop.DBus.Properties"):
955
for cn in if_tag.getElementsByTagName("method"):
956
if cn.getAttribute("name") == "Get":
957
for arg in cn.getElementsByTagName("arg"):
958
if (arg.getAttribute("direction")
960
arg.setAttribute("name", "value")
961
elif cn.getAttribute("name") == "GetAll":
962
for arg in cn.getElementsByTagName("arg"):
963
if (arg.getAttribute("direction")
965
arg.setAttribute("name", "props")
966
xmlstring = document.toxml("utf-8")
968
except (AttributeError, xml.dom.DOMException,
969
xml.parsers.expat.ExpatError) as error:
970
logger.error("Failed to override Introspection method",
975
def datetime_to_dbus (dt, variant_level=0):
976
"""Convert a UTC datetime.datetime() to a D-Bus type."""
978
return dbus.String("", variant_level = variant_level)
979
return dbus.String(dt.isoformat(),
980
variant_level=variant_level)
983
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
985
"""Applied to an empty subclass of a D-Bus object, this metaclass
986
will add additional D-Bus attributes matching a certain pattern.
988
def __new__(mcs, name, bases, attr):
989
# Go through all the base classes which could have D-Bus
990
# methods, signals, or properties in them
991
old_interface_names = []
992
for base in (b for b in bases
993
if issubclass(b, dbus.service.Object)):
994
# Go though all attributes of the base class
995
for attrname, attribute in inspect.getmembers(base):
996
# Ignore non-D-Bus attributes, and D-Bus attributes
997
# with the wrong interface name
998
if (not hasattr(attribute, "_dbus_interface")
999
or not attribute._dbus_interface
1000
.startswith("se.recompile.Mandos")):
1002
# Create an alternate D-Bus interface name based on
1004
alt_interface = (attribute._dbus_interface
1005
.replace("se.recompile.Mandos",
1006
"se.bsnet.fukt.Mandos"))
1007
if alt_interface != attribute._dbus_interface:
1008
old_interface_names.append(alt_interface)
1009
# Is this a D-Bus signal?
1010
if getattr(attribute, "_dbus_is_signal", False):
1011
# Extract the original non-method function by
1013
nonmethod_func = (dict(
1014
zip(attribute.func_code.co_freevars,
1015
attribute.__closure__))["func"]
1017
# Create a new, but exactly alike, function
1018
# object, and decorate it to be a new D-Bus signal
1019
# with the alternate D-Bus interface name
1020
new_function = (dbus.service.signal
1022
attribute._dbus_signature)
1023
(types.FunctionType(
1024
nonmethod_func.func_code,
1025
nonmethod_func.func_globals,
1026
nonmethod_func.func_name,
1027
nonmethod_func.func_defaults,
1028
nonmethod_func.func_closure)))
1029
# Define a creator of a function to call both the
1030
# old and new functions, so both the old and new
1031
# signals gets sent when the function is called
1032
def fixscope(func1, func2):
1033
"""This function is a scope container to pass
1034
func1 and func2 to the "call_both" function
1035
outside of its arguments"""
1036
def call_both(*args, **kwargs):
1037
"""This function will emit two D-Bus
1038
signals by calling func1 and func2"""
1039
func1(*args, **kwargs)
1040
func2(*args, **kwargs)
1042
# Create the "call_both" function and add it to
1044
attr[attrname] = fixscope(attribute,
1046
# Is this a D-Bus method?
1047
elif getattr(attribute, "_dbus_is_method", False):
1048
# Create a new, but exactly alike, function
1049
# object. Decorate it to be a new D-Bus method
1050
# with the alternate D-Bus interface name. Add it
1052
attr[attrname] = (dbus.service.method
1054
attribute._dbus_in_signature,
1055
attribute._dbus_out_signature)
1057
(attribute.func_code,
1058
attribute.func_globals,
1059
attribute.func_name,
1060
attribute.func_defaults,
1061
attribute.func_closure)))
1062
# Is this a D-Bus property?
1063
elif getattr(attribute, "_dbus_is_property", False):
1064
# Create a new, but exactly alike, function
1065
# object, and decorate it to be a new D-Bus
1066
# property with the alternate D-Bus interface
1067
# name. Add it to the class.
1068
attr[attrname] = (dbus_service_property
1070
attribute._dbus_signature,
1071
attribute._dbus_access,
1073
._dbus_get_args_options
1076
(attribute.func_code,
1077
attribute.func_globals,
1078
attribute.func_name,
1079
attribute.func_defaults,
1080
attribute.func_closure)))
1081
# Is this a D-Bus interface?
1082
elif getattr(attribute, "_dbus_is_interface", False):
1083
# Create a new, but exactly alike, function
1084
# object. Decorate it to be a new D-Bus interface
1085
# with the alternate D-Bus interface name. Add it
1087
attr[attrname] = (dbus_interface_annotations
1090
(attribute.func_code,
1091
attribute.func_globals,
1092
attribute.func_name,
1093
attribute.func_defaults,
1094
attribute.func_closure)))
1095
# Deprecate all old interfaces
1096
basename="_AlternateDBusNamesMetaclass_interface_annotation{0}"
1097
for old_interface_name in old_interface_names:
1098
@dbus_interface_annotations(old_interface_name)
1100
return { "org.freedesktop.DBus.Deprecated": "true" }
1101
# Find an unused name
1102
for aname in (basename.format(i) for i in
1104
if aname not in attr:
1107
return type.__new__(mcs, name, bases, attr)
1110
class ClientDBus(Client, DBusObjectWithProperties):
1111
"""A Client class using D-Bus
1114
dbus_object_path: dbus.ObjectPath
1115
bus: dbus.SystemBus()
1118
runtime_expansions = (Client.runtime_expansions
1119
+ ("dbus_object_path",))
1121
# dbus.service.Object doesn't use super(), so we can't either.
1123
def __init__(self, bus = None, *args, **kwargs):
1125
Client.__init__(self, *args, **kwargs)
1126
# Only now, when this client is initialized, can it show up on
1128
client_object_name = unicode(self.name).translate(
1129
{ord("."): ord("_"),
1130
ord("-"): ord("_")})
1131
self.dbus_object_path = (dbus.ObjectPath
1132
("/clients/" + client_object_name))
1133
DBusObjectWithProperties.__init__(self, self.bus,
1134
self.dbus_object_path)
1136
def notifychangeproperty(transform_func,
1137
dbus_name, type_func=lambda x: x,
1139
""" Modify a variable so that it's a property which announces
1140
its changes to DBus.
1142
transform_fun: Function that takes a value and a variant_level
1143
and transforms it to a D-Bus type.
1144
dbus_name: D-Bus name of the variable
1145
type_func: Function that transform the value before sending it
1146
to the D-Bus. Default: no transform
1147
variant_level: D-Bus variant level. Default: 1
1149
attrname = "_{0}".format(dbus_name)
1150
def setter(self, value):
1151
if hasattr(self, "dbus_object_path"):
1152
if (not hasattr(self, attrname) or
1153
type_func(getattr(self, attrname, None))
1154
!= type_func(value)):
1155
dbus_value = transform_func(type_func(value),
1158
self.PropertyChanged(dbus.String(dbus_name),
1160
setattr(self, attrname, value)
1162
return property(lambda self: getattr(self, attrname), setter)
1165
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1166
approvals_pending = notifychangeproperty(dbus.Boolean,
1169
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1170
last_enabled = notifychangeproperty(datetime_to_dbus,
1172
checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1173
type_func = lambda checker:
1174
checker is not None)
1175
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1177
last_checker_status = notifychangeproperty(dbus.Int16,
1178
"LastCheckerStatus")
1179
last_approval_request = notifychangeproperty(
1180
datetime_to_dbus, "LastApprovalRequest")
1181
approved_by_default = notifychangeproperty(dbus.Boolean,
1182
"ApprovedByDefault")
1183
approval_delay = notifychangeproperty(dbus.UInt64,
1186
timedelta_to_milliseconds)
1187
approval_duration = notifychangeproperty(
1188
dbus.UInt64, "ApprovalDuration",
1189
type_func = timedelta_to_milliseconds)
1190
host = notifychangeproperty(dbus.String, "Host")
1191
timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1193
timedelta_to_milliseconds)
1194
extended_timeout = notifychangeproperty(
1195
dbus.UInt64, "ExtendedTimeout",
1196
type_func = timedelta_to_milliseconds)
1197
interval = notifychangeproperty(dbus.UInt64,
1200
timedelta_to_milliseconds)
1201
checker_command = notifychangeproperty(dbus.String, "Checker")
1203
del notifychangeproperty
1205
def __del__(self, *args, **kwargs):
1207
self.remove_from_connection()
1210
if hasattr(DBusObjectWithProperties, "__del__"):
1211
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1212
Client.__del__(self, *args, **kwargs)
1214
def checker_callback(self, pid, condition, command,
1216
self.checker_callback_tag = None
1218
if os.WIFEXITED(condition):
1219
exitstatus = os.WEXITSTATUS(condition)
1221
self.CheckerCompleted(dbus.Int16(exitstatus),
1222
dbus.Int64(condition),
1223
dbus.String(command))
1226
self.CheckerCompleted(dbus.Int16(-1),
1227
dbus.Int64(condition),
1228
dbus.String(command))
1230
return Client.checker_callback(self, pid, condition, command,
1233
def start_checker(self, *args, **kwargs):
1234
old_checker = self.checker
1235
if self.checker is not None:
1236
old_checker_pid = self.checker.pid
1238
old_checker_pid = None
1239
r = Client.start_checker(self, *args, **kwargs)
1240
# Only if new checker process was started
1241
if (self.checker is not None
1242
and old_checker_pid != self.checker.pid):
1244
self.CheckerStarted(self.current_checker_command)
1247
def _reset_approved(self):
1248
self.approved = None
1251
def approve(self, value=True):
1252
self.send_changedstate()
1253
self.approved = value
1254
gobject.timeout_add(timedelta_to_milliseconds
1255
(self.approval_duration),
1256
self._reset_approved)
1259
## D-Bus methods, signals & properties
1260
_interface = "se.recompile.Mandos.Client"
1264
@dbus_interface_annotations(_interface)
1266
return { "org.freedesktop.DBus.Property.EmitsChangedSignal":
439
self.PropertyChanged(dbus.String(u"checker_running"),
440
dbus.Boolean(False, variant_level=1))
442
def still_valid(self):
443
"""Has the timeout not yet passed for this client?"""
444
if not getattr(self, "enabled", False):
446
now = datetime.datetime.utcnow()
447
if self.last_checked_ok is None:
448
return now < (self.created + self.timeout)
450
return now < (self.last_checked_ok + self.timeout)
452
## D-Bus methods & signals
453
_interface = u"se.bsnet.fukt.Mandos.Client"
456
CheckedOK = dbus.service.method(_interface)(checked_ok)
457
CheckedOK.__name__ = "CheckedOK"
1271
459
# CheckerCompleted - signal
1272
460
@dbus.service.signal(_interface, signature="nxs")
1340
584
# StopChecker - method
1341
@dbus.service.method(_interface)
1342
def StopChecker(self):
1347
# ApprovalPending - property
1348
@dbus_service_property(_interface, signature="b", access="read")
1349
def ApprovalPending_dbus_property(self):
1350
return dbus.Boolean(bool(self.approvals_pending))
1352
# ApprovedByDefault - property
1353
@dbus_service_property(_interface, signature="b",
1355
def ApprovedByDefault_dbus_property(self, value=None):
1356
if value is None: # get
1357
return dbus.Boolean(self.approved_by_default)
1358
self.approved_by_default = bool(value)
1360
# ApprovalDelay - property
1361
@dbus_service_property(_interface, signature="t",
1363
def ApprovalDelay_dbus_property(self, value=None):
1364
if value is None: # get
1365
return dbus.UInt64(self.approval_delay_milliseconds())
1366
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1368
# ApprovalDuration - property
1369
@dbus_service_property(_interface, signature="t",
1371
def ApprovalDuration_dbus_property(self, value=None):
1372
if value is None: # get
1373
return dbus.UInt64(timedelta_to_milliseconds(
1374
self.approval_duration))
1375
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1378
@dbus_service_property(_interface, signature="s", access="read")
1379
def Name_dbus_property(self):
1380
return dbus.String(self.name)
1382
# Fingerprint - property
1383
@dbus_service_property(_interface, signature="s", access="read")
1384
def Fingerprint_dbus_property(self):
1385
return dbus.String(self.fingerprint)
1388
@dbus_service_property(_interface, signature="s",
1390
def Host_dbus_property(self, value=None):
1391
if value is None: # get
1392
return dbus.String(self.host)
1393
self.host = unicode(value)
1395
# Created - property
1396
@dbus_service_property(_interface, signature="s", access="read")
1397
def Created_dbus_property(self):
1398
return datetime_to_dbus(self.created)
1400
# LastEnabled - property
1401
@dbus_service_property(_interface, signature="s", access="read")
1402
def LastEnabled_dbus_property(self):
1403
return datetime_to_dbus(self.last_enabled)
1405
# Enabled - property
1406
@dbus_service_property(_interface, signature="b",
1408
def Enabled_dbus_property(self, value=None):
1409
if value is None: # get
1410
return dbus.Boolean(self.enabled)
1416
# LastCheckedOK - property
1417
@dbus_service_property(_interface, signature="s",
1419
def LastCheckedOK_dbus_property(self, value=None):
1420
if value is not None:
1423
return datetime_to_dbus(self.last_checked_ok)
1425
# LastCheckerStatus - property
1426
@dbus_service_property(_interface, signature="n",
1428
def LastCheckerStatus_dbus_property(self):
1429
return dbus.Int16(self.last_checker_status)
1431
# Expires - property
1432
@dbus_service_property(_interface, signature="s", access="read")
1433
def Expires_dbus_property(self):
1434
return datetime_to_dbus(self.expires)
1436
# LastApprovalRequest - property
1437
@dbus_service_property(_interface, signature="s", access="read")
1438
def LastApprovalRequest_dbus_property(self):
1439
return datetime_to_dbus(self.last_approval_request)
1441
# Timeout - property
1442
@dbus_service_property(_interface, signature="t",
1444
def Timeout_dbus_property(self, value=None):
1445
if value is None: # get
1446
return dbus.UInt64(self.timeout_milliseconds())
1447
self.timeout = datetime.timedelta(0, 0, 0, value)
1448
# Reschedule timeout
1450
now = datetime.datetime.utcnow()
1451
time_to_die = timedelta_to_milliseconds(
1452
(self.last_checked_ok + self.timeout) - now)
1453
if time_to_die <= 0:
1454
# The timeout has passed
1457
self.expires = (now +
1458
datetime.timedelta(milliseconds =
1460
if (getattr(self, "disable_initiator_tag", None)
1463
gobject.source_remove(self.disable_initiator_tag)
1464
self.disable_initiator_tag = (gobject.timeout_add
1468
# ExtendedTimeout - property
1469
@dbus_service_property(_interface, signature="t",
1471
def ExtendedTimeout_dbus_property(self, value=None):
1472
if value is None: # get
1473
return dbus.UInt64(self.extended_timeout_milliseconds())
1474
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1476
# Interval - property
1477
@dbus_service_property(_interface, signature="t",
1479
def Interval_dbus_property(self, value=None):
1480
if value is None: # get
1481
return dbus.UInt64(self.interval_milliseconds())
1482
self.interval = datetime.timedelta(0, 0, 0, value)
1483
if getattr(self, "checker_initiator_tag", None) is None:
1486
# Reschedule checker run
1487
gobject.source_remove(self.checker_initiator_tag)
1488
self.checker_initiator_tag = (gobject.timeout_add
1489
(value, self.start_checker))
1490
self.start_checker() # Start one now, too
1492
# Checker - property
1493
@dbus_service_property(_interface, signature="s",
1495
def Checker_dbus_property(self, value=None):
1496
if value is None: # get
1497
return dbus.String(self.checker_command)
1498
self.checker_command = unicode(value)
1500
# CheckerRunning - property
1501
@dbus_service_property(_interface, signature="b",
1503
def CheckerRunning_dbus_property(self, value=None):
1504
if value is None: # get
1505
return dbus.Boolean(self.checker is not None)
1507
self.start_checker()
1511
# ObjectPath - property
1512
@dbus_service_property(_interface, signature="o", access="read")
1513
def ObjectPath_dbus_property(self):
1514
return self.dbus_object_path # is already a dbus.ObjectPath
1517
@dbus_service_property(_interface, signature="ay",
1518
access="write", byte_arrays=True)
1519
def Secret_dbus_property(self, value):
1520
self.secret = str(value)
585
StopChecker = dbus.service.method(_interface)(stop_checker)
586
StopChecker.__name__ = "StopChecker"
1525
class ProxyClient(object):
1526
def __init__(self, child_pipe, fpr, address):
1527
self._pipe = child_pipe
1528
self._pipe.send(('init', fpr, address))
1529
if not self._pipe.recv():
1532
def __getattribute__(self, name):
1534
return super(ProxyClient, self).__getattribute__(name)
1535
self._pipe.send(('getattr', name))
1536
data = self._pipe.recv()
1537
if data[0] == 'data':
1539
if data[0] == 'function':
1540
def func(*args, **kwargs):
1541
self._pipe.send(('funcall', name, args, kwargs))
1542
return self._pipe.recv()[1]
1545
def __setattr__(self, name, value):
1547
return super(ProxyClient, self).__setattr__(name, value)
1548
self._pipe.send(('setattr', name, value))
1551
class ClientDBusTransitional(ClientDBus):
1552
__metaclass__ = AlternateDBusNamesMetaclass
1555
class ClientHandler(socketserver.BaseRequestHandler, object):
1556
"""A class to handle client connections.
1558
Instantiated once for each connection to handle it.
591
def peer_certificate(session):
592
"Return the peer's OpenPGP certificate as a bytestring"
593
# If not an OpenPGP certificate...
594
if (gnutls.library.functions
595
.gnutls_certificate_type_get(session._c_object)
596
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
597
# ...do the normal thing
598
return session.peer_certificate
599
list_size = ctypes.c_uint(1)
600
cert_list = (gnutls.library.functions
601
.gnutls_certificate_get_peers
602
(session._c_object, ctypes.byref(list_size)))
603
if not bool(cert_list) and list_size.value != 0:
604
raise gnutls.errors.GNUTLSError("error getting peer"
606
if list_size.value == 0:
609
return ctypes.string_at(cert.data, cert.size)
612
def fingerprint(openpgp):
613
"Convert an OpenPGP bytestring to a hexdigit fingerprint string"
614
# New GnuTLS "datum" with the OpenPGP public key
615
datum = (gnutls.library.types
616
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
619
ctypes.c_uint(len(openpgp))))
620
# New empty GnuTLS certificate
621
crt = gnutls.library.types.gnutls_openpgp_crt_t()
622
(gnutls.library.functions
623
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
624
# Import the OpenPGP public key into the certificate
625
(gnutls.library.functions
626
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
627
gnutls.library.constants
628
.GNUTLS_OPENPGP_FMT_RAW))
629
# Verify the self signature in the key
630
crtverify = ctypes.c_uint()
631
(gnutls.library.functions
632
.gnutls_openpgp_crt_verify_self(crt, 0, ctypes.byref(crtverify)))
633
if crtverify.value != 0:
634
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
635
raise gnutls.errors.CertificateSecurityError("Verify failed")
636
# New buffer for the fingerprint
637
buf = ctypes.create_string_buffer(20)
638
buf_len = ctypes.c_size_t()
639
# Get the fingerprint from the certificate into the buffer
640
(gnutls.library.functions
641
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
642
ctypes.byref(buf_len)))
643
# Deinit the certificate
644
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
645
# Convert the buffer to a Python bytestring
646
fpr = ctypes.string_at(buf, buf_len.value)
647
# Convert the bytestring to hexadecimal notation
648
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
652
class TCP_handler(SocketServer.BaseRequestHandler, object):
653
"""A TCP request handler class.
654
Instantiated by IPv6_TCPServer for each request to handle it.
1559
655
Note: This will run in its own forked process."""
1561
657
def handle(self):
1562
with contextlib.closing(self.server.child_pipe) as child_pipe:
1563
logger.info("TCP connection from: %s",
1564
unicode(self.client_address))
1565
logger.debug("Pipe FD: %d",
1566
self.server.child_pipe.fileno())
1568
session = (gnutls.connection
1569
.ClientSession(self.request,
1571
.X509Credentials()))
1573
# Note: gnutls.connection.X509Credentials is really a
1574
# generic GnuTLS certificate credentials object so long as
1575
# no X.509 keys are added to it. Therefore, we can use it
1576
# here despite using OpenPGP certificates.
1578
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1579
# "+AES-256-CBC", "+SHA1",
1580
# "+COMP-NULL", "+CTYPE-OPENPGP",
1582
# Use a fallback default, since this MUST be set.
1583
priority = self.server.gnutls_priority
1584
if priority is None:
1586
(gnutls.library.functions
1587
.gnutls_priority_set_direct(session._c_object,
1590
# Start communication using the Mandos protocol
1591
# Get protocol number
1592
line = self.request.makefile().readline()
1593
logger.debug("Protocol version: %r", line)
1595
if int(line.strip().split()[0]) > 1:
1597
except (ValueError, IndexError, RuntimeError) as error:
1598
logger.error("Unknown protocol version: %s", error)
1601
# Start GnuTLS connection
1604
except gnutls.errors.GNUTLSError as error:
1605
logger.warning("Handshake failed: %s", error)
1606
# Do not run session.bye() here: the session is not
1607
# established. Just abandon the request.
1609
logger.debug("Handshake succeeded")
1611
approval_required = False
1614
fpr = self.fingerprint(self.peer_certificate
1617
gnutls.errors.GNUTLSError) as error:
1618
logger.warning("Bad certificate: %s", error)
1620
logger.debug("Fingerprint: %s", fpr)
1623
client = ProxyClient(child_pipe, fpr,
1624
self.client_address)
1628
if client.approval_delay:
1629
delay = client.approval_delay
1630
client.approvals_pending += 1
1631
approval_required = True
1634
if not client.enabled:
1635
logger.info("Client %s is disabled",
1637
if self.server.use_dbus:
1639
client.Rejected("Disabled")
1642
if client.approved or not client.approval_delay:
1643
#We are approved or approval is disabled
1645
elif client.approved is None:
1646
logger.info("Client %s needs approval",
1648
if self.server.use_dbus:
1650
client.NeedApproval(
1651
client.approval_delay_milliseconds(),
1652
client.approved_by_default)
1654
logger.warning("Client %s was not approved",
1656
if self.server.use_dbus:
1658
client.Rejected("Denied")
1661
#wait until timeout or approved
1662
time = datetime.datetime.now()
1663
client.changedstate.acquire()
1664
(client.changedstate.wait
1665
(float(client.timedelta_to_milliseconds(delay)
1667
client.changedstate.release()
1668
time2 = datetime.datetime.now()
1669
if (time2 - time) >= delay:
1670
if not client.approved_by_default:
1671
logger.warning("Client %s timed out while"
1672
" waiting for approval",
1674
if self.server.use_dbus:
1676
client.Rejected("Approval timed out")
1681
delay -= time2 - time
1684
while sent_size < len(client.secret):
1686
sent = session.send(client.secret[sent_size:])
1687
except gnutls.errors.GNUTLSError as error:
1688
logger.warning("gnutls send failed")
1690
logger.debug("Sent: %d, remaining: %d",
1691
sent, len(client.secret)
1692
- (sent_size + sent))
1695
logger.info("Sending secret to %s", client.name)
1696
# bump the timeout using extended_timeout
1697
client.bump_timeout(client.extended_timeout)
1698
if self.server.use_dbus:
1703
if approval_required:
1704
client.approvals_pending -= 1
1707
except gnutls.errors.GNUTLSError as error:
1708
logger.warning("GnuTLS bye failed")
1711
def peer_certificate(session):
1712
"Return the peer's OpenPGP certificate as a bytestring"
1713
# If not an OpenPGP certificate...
1714
if (gnutls.library.functions
1715
.gnutls_certificate_type_get(session._c_object)
1716
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1717
# ...do the normal thing
1718
return session.peer_certificate
1719
list_size = ctypes.c_uint(1)
1720
cert_list = (gnutls.library.functions
1721
.gnutls_certificate_get_peers
1722
(session._c_object, ctypes.byref(list_size)))
1723
if not bool(cert_list) and list_size.value != 0:
1724
raise gnutls.errors.GNUTLSError("error getting peer"
1726
if list_size.value == 0:
1729
return ctypes.string_at(cert.data, cert.size)
1732
def fingerprint(openpgp):
1733
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
1734
# New GnuTLS "datum" with the OpenPGP public key
1735
datum = (gnutls.library.types
1736
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1739
ctypes.c_uint(len(openpgp))))
1740
# New empty GnuTLS certificate
1741
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1742
(gnutls.library.functions
1743
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
1744
# Import the OpenPGP public key into the certificate
1745
(gnutls.library.functions
1746
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1747
gnutls.library.constants
1748
.GNUTLS_OPENPGP_FMT_RAW))
1749
# Verify the self signature in the key
1750
crtverify = ctypes.c_uint()
1751
(gnutls.library.functions
1752
.gnutls_openpgp_crt_verify_self(crt, 0,
1753
ctypes.byref(crtverify)))
1754
if crtverify.value != 0:
1755
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1756
raise (gnutls.errors.CertificateSecurityError
1758
# New buffer for the fingerprint
1759
buf = ctypes.create_string_buffer(20)
1760
buf_len = ctypes.c_size_t()
1761
# Get the fingerprint from the certificate into the buffer
1762
(gnutls.library.functions
1763
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1764
ctypes.byref(buf_len)))
1765
# Deinit the certificate
1766
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1767
# Convert the buffer to a Python bytestring
1768
fpr = ctypes.string_at(buf, buf_len.value)
1769
# Convert the bytestring to hexadecimal notation
1770
hex_fpr = binascii.hexlify(fpr).upper()
1774
class MultiprocessingMixIn(object):
1775
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
1776
def sub_process_main(self, request, address):
1778
self.finish_request(request, address)
1780
self.handle_error(request, address)
1781
self.close_request(request)
1783
def process_request(self, request, address):
1784
"""Start a new process to process the request."""
1785
proc = multiprocessing.Process(target = self.sub_process_main,
1792
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1793
""" adds a pipe to the MixIn """
1794
def process_request(self, request, client_address):
1795
"""Overrides and wraps the original process_request().
1797
This function creates a new pipe in self.pipe
1799
parent_pipe, self.child_pipe = multiprocessing.Pipe()
1801
proc = MultiprocessingMixIn.process_request(self, request,
1803
self.child_pipe.close()
1804
self.add_pipe(parent_pipe, proc)
1806
def add_pipe(self, parent_pipe, proc):
1807
"""Dummy function; override as necessary"""
1808
raise NotImplementedError
1811
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1812
socketserver.TCPServer, object):
1813
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
658
logger.info(u"TCP connection from: %s",
659
unicode(self.client_address))
660
session = (gnutls.connection
661
.ClientSession(self.request,
665
line = self.request.makefile().readline()
666
logger.debug(u"Protocol version: %r", line)
668
if int(line.strip().split()[0]) > 1:
670
except (ValueError, IndexError, RuntimeError), error:
671
logger.error(u"Unknown protocol version: %s", error)
674
# Note: gnutls.connection.X509Credentials is really a generic
675
# GnuTLS certificate credentials object so long as no X.509
676
# keys are added to it. Therefore, we can use it here despite
677
# using OpenPGP certificates.
679
#priority = ':'.join(("NONE", "+VERS-TLS1.1", "+AES-256-CBC",
680
# "+SHA1", "+COMP-NULL", "+CTYPE-OPENPGP",
682
# Use a fallback default, since this MUST be set.
683
priority = self.server.settings.get("priority", "NORMAL")
684
(gnutls.library.functions
685
.gnutls_priority_set_direct(session._c_object,
690
except gnutls.errors.GNUTLSError, error:
691
logger.warning(u"Handshake failed: %s", error)
692
# Do not run session.bye() here: the session is not
693
# established. Just abandon the request.
695
logger.debug(u"Handshake succeeded")
697
fpr = fingerprint(peer_certificate(session))
698
except (TypeError, gnutls.errors.GNUTLSError), error:
699
logger.warning(u"Bad certificate: %s", error)
702
logger.debug(u"Fingerprint: %s", fpr)
704
for c in self.server.clients:
705
if c.fingerprint == fpr:
709
logger.warning(u"Client not found for fingerprint: %s",
713
# Have to check if client.still_valid(), since it is possible
714
# that the client timed out while establishing the GnuTLS
716
if not client.still_valid():
717
logger.warning(u"Client %(name)s is invalid",
721
## This won't work here, since we're in a fork.
722
# client.checked_ok()
724
while sent_size < len(client.secret):
725
sent = session.send(client.secret[sent_size:])
726
logger.debug(u"Sent: %d, remaining: %d",
727
sent, len(client.secret)
728
- (sent_size + sent))
733
class IPv6_TCPServer(SocketServer.ForkingMixIn,
734
SocketServer.TCPServer, object):
735
"""IPv6 TCP server. Accepts 'None' as address and/or port.
737
settings: Server settings
738
clients: Set() of Client objects
1816
739
enabled: Boolean; whether this server is activated yet
1817
interface: None or a network interface name (string)
1818
use_ipv6: Boolean; to use IPv6 or not
1820
def __init__(self, server_address, RequestHandlerClass,
1821
interface=None, use_ipv6=True):
1822
self.interface = interface
1824
self.address_family = socket.AF_INET6
1825
socketserver.TCPServer.__init__(self, server_address,
1826
RequestHandlerClass)
741
address_family = socket.AF_INET6
742
def __init__(self, *args, **kwargs):
743
if "settings" in kwargs:
744
self.settings = kwargs["settings"]
745
del kwargs["settings"]
746
if "clients" in kwargs:
747
self.clients = kwargs["clients"]
748
del kwargs["clients"]
750
super(IPv6_TCPServer, self).__init__(*args, **kwargs)
1827
751
def server_bind(self):
1828
752
"""This overrides the normal server_bind() function
1829
753
to bind to an interface if one was specified, and also NOT to
1830
754
bind to an address or port if they were not specified."""
1831
if self.interface is not None:
1832
if SO_BINDTODEVICE is None:
1833
logger.error("SO_BINDTODEVICE does not exist;"
1834
" cannot bind to interface %s",
1838
self.socket.setsockopt(socket.SOL_SOCKET,
1842
except socket.error as error:
1843
if error[0] == errno.EPERM:
1844
logger.error("No permission to"
1845
" bind to interface %s",
1847
elif error[0] == errno.ENOPROTOOPT:
1848
logger.error("SO_BINDTODEVICE not available;"
1849
" cannot bind to interface %s",
755
if self.settings["interface"]:
756
# 25 is from /usr/include/asm-i486/socket.h
757
SO_BINDTODEVICE = getattr(socket, "SO_BINDTODEVICE", 25)
759
self.socket.setsockopt(socket.SOL_SOCKET,
761
self.settings["interface"])
762
except socket.error, error:
763
if error[0] == errno.EPERM:
764
logger.error(u"No permission to"
765
u" bind to interface %s",
766
self.settings["interface"])
1853
769
# Only bind(2) the socket if we really need to.
1854
770
if self.server_address[0] or self.server_address[1]:
1855
771
if not self.server_address[0]:
1856
if self.address_family == socket.AF_INET6:
1857
any_address = "::" # in6addr_any
1859
any_address = socket.INADDR_ANY
1860
self.server_address = (any_address,
773
self.server_address = (in6addr_any,
1861
774
self.server_address[1])
1862
775
elif not self.server_address[1]:
1863
776
self.server_address = (self.server_address[0],
1865
# if self.interface:
778
# if self.settings["interface"]:
1866
779
# self.server_address = (self.server_address[0],
1869
782
# if_nametoindex
1871
return socketserver.TCPServer.server_bind(self)
1874
class MandosServer(IPv6_TCPServer):
1878
clients: set of Client objects
1879
gnutls_priority GnuTLS priority string
1880
use_dbus: Boolean; to emit D-Bus signals or not
1882
Assumes a gobject.MainLoop event loop.
1884
def __init__(self, server_address, RequestHandlerClass,
1885
interface=None, use_ipv6=True, clients=None,
1886
gnutls_priority=None, use_dbus=True):
1887
self.enabled = False
1888
self.clients = clients
1889
if self.clients is None:
1891
self.use_dbus = use_dbus
1892
self.gnutls_priority = gnutls_priority
1893
IPv6_TCPServer.__init__(self, server_address,
1894
RequestHandlerClass,
1895
interface = interface,
1896
use_ipv6 = use_ipv6)
785
return super(IPv6_TCPServer, self).server_bind()
1897
786
def server_activate(self):
1898
787
if self.enabled:
1899
return socketserver.TCPServer.server_activate(self)
788
return super(IPv6_TCPServer, self).server_activate()
1901
789
def enable(self):
1902
790
self.enabled = True
1904
def add_pipe(self, parent_pipe, proc):
1905
# Call "handle_ipc" for both data and EOF events
1906
gobject.io_add_watch(parent_pipe.fileno(),
1907
gobject.IO_IN | gobject.IO_HUP,
1908
functools.partial(self.handle_ipc,
1913
def handle_ipc(self, source, condition, parent_pipe=None,
1914
proc = None, client_object=None):
1916
gobject.IO_IN: "IN", # There is data to read.
1917
gobject.IO_OUT: "OUT", # Data can be written (without
1919
gobject.IO_PRI: "PRI", # There is urgent data to read.
1920
gobject.IO_ERR: "ERR", # Error condition.
1921
gobject.IO_HUP: "HUP" # Hung up (the connection has been
1922
# broken, usually for pipes and
1925
conditions_string = ' | '.join(name
1927
condition_names.iteritems()
1928
if cond & condition)
1929
# error, or the other end of multiprocessing.Pipe has closed
1930
if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
1931
# Wait for other process to exit
1935
# Read a request from the child
1936
request = parent_pipe.recv()
1937
command = request[0]
1939
if command == 'init':
1941
address = request[2]
1943
for c in self.clients.itervalues():
1944
if c.fingerprint == fpr:
1948
logger.info("Client not found for fingerprint: %s, ad"
1949
"dress: %s", fpr, address)
1952
mandos_dbus_service.ClientNotFound(fpr,
1954
parent_pipe.send(False)
1957
gobject.io_add_watch(parent_pipe.fileno(),
1958
gobject.IO_IN | gobject.IO_HUP,
1959
functools.partial(self.handle_ipc,
1965
parent_pipe.send(True)
1966
# remove the old hook in favor of the new above hook on
1969
if command == 'funcall':
1970
funcname = request[1]
1974
parent_pipe.send(('data', getattr(client_object,
1978
if command == 'getattr':
1979
attrname = request[1]
1980
if callable(client_object.__getattribute__(attrname)):
1981
parent_pipe.send(('function',))
1983
parent_pipe.send(('data', client_object
1984
.__getattribute__(attrname)))
1986
if command == 'setattr':
1987
attrname = request[1]
1989
setattr(client_object, attrname, value)
1994
793
def string_to_delta(interval):
2235
1038
(gnutls.library.functions
2236
1039
.gnutls_global_set_log_function(debug_gnutls))
2238
# Redirect stdin so all checkers get /dev/null
2239
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2240
os.dup2(null, sys.stdin.fileno())
2244
# Need to fork before connecting to D-Bus
2246
# Close all input and output, do double fork, etc.
2249
gobject.threads_init()
1042
service = AvahiService(name = server_settings["servicename"],
1043
servicetype = "_mandos._tcp", )
1044
if server_settings["interface"]:
1045
service.interface = (if_nametoindex
1046
(server_settings["interface"]))
2251
1048
global main_loop
2252
1051
# From the Avahi example code
2253
DBusGMainLoop(set_as_default=True)
1052
DBusGMainLoop(set_as_default=True )
2254
1053
main_loop = gobject.MainLoop()
2255
1054
bus = dbus.SystemBus()
1055
server = dbus.Interface(bus.get_object(avahi.DBUS_NAME,
1056
avahi.DBUS_PATH_SERVER),
1057
avahi.DBUS_INTERFACE_SERVER)
2256
1058
# End of Avahi example code
2259
bus_name = dbus.service.BusName("se.recompile.Mandos",
2260
bus, do_not_queue=True)
2261
old_bus_name = (dbus.service.BusName
2262
("se.bsnet.fukt.Mandos", bus,
2264
except dbus.exceptions.NameExistsException as e:
2265
logger.error(unicode(e) + ", disabling D-Bus")
2267
server_settings["use_dbus"] = False
2268
tcp_server.use_dbus = False
2269
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2270
service = AvahiServiceToSyslog(name =
2271
server_settings["servicename"],
2272
servicetype = "_mandos._tcp",
2273
protocol = protocol, bus = bus)
2274
if server_settings["interface"]:
2275
service.interface = (if_nametoindex
2276
(str(server_settings["interface"])))
2278
global multiprocessing_manager
2279
multiprocessing_manager = multiprocessing.Manager()
2281
client_class = Client
2283
client_class = functools.partial(ClientDBusTransitional,
2286
client_settings = Client.config_parser(client_config)
2287
old_client_settings = {}
2290
# Get client data and settings from last running state.
2291
if server_settings["restore"]:
2293
with open(stored_state_path, "rb") as stored_state:
2294
clients_data, old_client_settings = (pickle.load
2296
os.remove(stored_state_path)
2297
except IOError as e:
2298
logger.warning("Could not load persistent state: {0}"
2300
if e.errno != errno.ENOENT:
2302
except EOFError as e:
2303
logger.warning("Could not load persistent state: "
2304
"EOFError: {0}".format(e))
2306
with PGPEngine() as pgp:
2307
for client_name, client in clients_data.iteritems():
2308
# Decide which value to use after restoring saved state.
2309
# We have three different values: Old config file,
2310
# new config file, and saved state.
2311
# New config value takes precedence if it differs from old
2312
# config value, otherwise use saved state.
2313
for name, value in client_settings[client_name].items():
2315
# For each value in new config, check if it
2316
# differs from the old config value (Except for
2317
# the "secret" attribute)
2318
if (name != "secret" and
2319
value != old_client_settings[client_name]
2321
client[name] = value
2325
# Clients who has passed its expire date can still be
2326
# enabled if its last checker was successful. Clients
2327
# whose checker succeeded before we stored its state is
2328
# assumed to have successfully run all checkers during
2330
if client["enabled"]:
2331
if datetime.datetime.utcnow() >= client["expires"]:
2332
if not client["last_checked_ok"]:
2334
"disabling client {0} - Client never "
2335
"performed a successful checker"
2336
.format(client_name))
2337
client["enabled"] = False
2338
elif client["last_checker_status"] != 0:
2340
"disabling client {0} - Client "
2341
"last checker failed with error code {1}"
2342
.format(client_name,
2343
client["last_checker_status"]))
2344
client["enabled"] = False
2346
client["expires"] = (datetime.datetime
2348
+ client["timeout"])
2349
logger.debug("Last checker succeeded,"
2350
" keeping {0} enabled"
2351
.format(client_name))
2353
client["secret"] = (
2354
pgp.decrypt(client["encrypted_secret"],
2355
client_settings[client_name]
2358
# If decryption fails, we use secret from new settings
2359
logger.debug("Failed to decrypt {0} old secret"
2360
.format(client_name))
2361
client["secret"] = (
2362
client_settings[client_name]["secret"])
2365
# Add/remove clients based on new changes made to config
2366
for client_name in (set(old_client_settings)
2367
- set(client_settings)):
2368
del clients_data[client_name]
2369
for client_name in (set(client_settings)
2370
- set(old_client_settings)):
2371
clients_data[client_name] = client_settings[client_name]
2373
# Create all client objects
2374
for client_name, client in clients_data.iteritems():
2375
tcp_server.clients[client_name] = client_class(
2376
name = client_name, settings = client)
2378
if not tcp_server.clients:
2379
logger.warning("No clients defined")
1060
bus_name = dbus.service.BusName(u"se.bsnet.fukt.Mandos", bus)
1062
clients.update(Set(Client(name = section,
1064
= dict(client_config.items(section)),
1065
use_dbus = use_dbus)
1066
for section in client_config.sections()))
1068
logger.warning(u"No clients defined")
1071
# Redirect stdin so all checkers get /dev/null
1072
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
1073
os.dup2(null, sys.stdin.fileno())
1077
# No console logging
1078
logger.removeHandler(console)
1079
# Close all input and output, do double fork, etc.
1084
pidfile.write(str(pid) + "\n")
1088
logger.error(u"Could not write to file %r with PID %d",
1091
# "pidfile" was never created
1096
"Cleanup function; run on exit"
1098
# From the Avahi example code
1099
if not group is None:
1102
# End of Avahi example code
1105
client = clients.pop()
1106
client.disable_hook = None
1109
atexit.register(cleanup)
2385
pidfile.write(str(pid) + "\n".encode("utf-8"))
2388
logger.error("Could not write to file %r with PID %d",
2391
# "pidfile" was never created
2394
1112
signal.signal(signal.SIGINT, signal.SIG_IGN)
2396
1113
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2397
1114
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2400
class MandosDBusService(DBusObjectWithProperties):
1117
class MandosServer(dbus.service.Object):
2401
1118
"""A D-Bus proxy object"""
2402
1119
def __init__(self):
2403
1120
dbus.service.Object.__init__(self, bus, "/")
2404
_interface = "se.recompile.Mandos"
2406
@dbus_interface_annotations(_interface)
2408
return { "org.freedesktop.DBus.Property"
2409
".EmitsChangedSignal":
2412
@dbus.service.signal(_interface, signature="o")
2413
def ClientAdded(self, objpath):
2417
@dbus.service.signal(_interface, signature="ss")
2418
def ClientNotFound(self, fingerprint, address):
1121
_interface = u"se.bsnet.fukt.Mandos"
1123
@dbus.service.signal(_interface, signature="oa{sv}")
1124
def ClientAdded(self, objpath, properties):