124
257
self.rename_count = 0
125
258
self.max_renames = max_renames
259
self.protocol = protocol
260
self.group = None # our entry group
263
self.entry_group_state_changed_match = None
126
264
def rename(self):
127
265
"""Derived from the Avahi example code"""
128
266
if self.rename_count >= self.max_renames:
129
logger.critical(u"No suitable Zeroconf service name found"
130
u" after %i retries, exiting.",
267
logger.critical("No suitable Zeroconf service name found"
268
" after %i retries, exiting.",
131
269
self.rename_count)
132
raise AvahiServiceError(u"Too many renames")
133
self.name = server.GetAlternativeServiceName(self.name)
134
logger.info(u"Changing Zeroconf service name to %r ...",
136
syslogger.setFormatter(logging.Formatter
137
('Mandos (%s): %%(levelname)s:'
138
' %%(message)s' % self.name))
270
raise AvahiServiceError("Too many renames")
271
self.name = unicode(self.server
272
.GetAlternativeServiceName(self.name))
273
logger.info("Changing Zeroconf service name to %r ...",
278
except dbus.exceptions.DBusException as error:
279
logger.critical("DBusException: %s", error)
141
282
self.rename_count += 1
142
283
def remove(self):
143
284
"""Derived from the Avahi example code"""
144
if group is not None:
285
if self.entry_group_state_changed_match is not None:
286
self.entry_group_state_changed_match.remove()
287
self.entry_group_state_changed_match = None
288
if self.group is not None:
147
291
"""Derived from the Avahi example code"""
150
group = dbus.Interface(bus.get_object
152
server.EntryGroupNew()),
153
avahi.DBUS_INTERFACE_ENTRY_GROUP)
154
group.connect_to_signal('StateChanged',
155
entry_group_state_changed)
156
logger.debug(u"Adding Zeroconf service '%s' of type '%s' ...",
157
service.name, service.type)
159
self.interface, # interface
160
avahi.PROTO_INET6, # protocol
161
dbus.UInt32(0), # flags
162
self.name, self.type,
163
self.domain, self.host,
164
dbus.UInt16(self.port),
165
avahi.string_array_to_txt_array(self.TXT))
168
# From the Avahi example code:
169
group = None # our entry group
170
# End of Avahi example code
173
def _datetime_to_dbus(dt, variant_level=0):
174
"""Convert a UTC datetime.datetime() to a D-Bus type."""
175
return dbus.String(dt.isoformat(), variant_level=variant_level)
178
class Client(dbus.service.Object):
293
if self.group is None:
294
self.group = dbus.Interface(
295
self.bus.get_object(avahi.DBUS_NAME,
296
self.server.EntryGroupNew()),
297
avahi.DBUS_INTERFACE_ENTRY_GROUP)
298
self.entry_group_state_changed_match = (
299
self.group.connect_to_signal(
300
'StateChanged', self.entry_group_state_changed))
301
logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
302
self.name, self.type)
303
self.group.AddService(
306
dbus.UInt32(0), # flags
307
self.name, self.type,
308
self.domain, self.host,
309
dbus.UInt16(self.port),
310
avahi.string_array_to_txt_array(self.TXT))
312
def entry_group_state_changed(self, state, error):
313
"""Derived from the Avahi example code"""
314
logger.debug("Avahi entry group state change: %i", state)
316
if state == avahi.ENTRY_GROUP_ESTABLISHED:
317
logger.debug("Zeroconf service established.")
318
elif state == avahi.ENTRY_GROUP_COLLISION:
319
logger.info("Zeroconf service name collision.")
321
elif state == avahi.ENTRY_GROUP_FAILURE:
322
logger.critical("Avahi: Error in group state changed %s",
324
raise AvahiGroupError("State changed: %s"
327
"""Derived from the Avahi example code"""
328
if self.group is not None:
331
except (dbus.exceptions.UnknownMethodException,
332
dbus.exceptions.DBusException):
336
def server_state_changed(self, state, error=None):
337
"""Derived from the Avahi example code"""
338
logger.debug("Avahi server state change: %i", state)
339
bad_states = { avahi.SERVER_INVALID:
340
"Zeroconf server invalid",
341
avahi.SERVER_REGISTERING: None,
342
avahi.SERVER_COLLISION:
343
"Zeroconf server name collision",
344
avahi.SERVER_FAILURE:
345
"Zeroconf server failure" }
346
if state in bad_states:
347
if bad_states[state] is not None:
349
logger.error(bad_states[state])
351
logger.error(bad_states[state] + ": %r", error)
353
elif state == avahi.SERVER_RUNNING:
357
logger.debug("Unknown state: %r", state)
359
logger.debug("Unknown state: %r: %r", state, error)
361
"""Derived from the Avahi example code"""
362
if self.server is None:
363
self.server = dbus.Interface(
364
self.bus.get_object(avahi.DBUS_NAME,
365
avahi.DBUS_PATH_SERVER,
366
follow_name_owner_changes=True),
367
avahi.DBUS_INTERFACE_SERVER)
368
self.server.connect_to_signal("StateChanged",
369
self.server_state_changed)
370
self.server_state_changed(self.server.GetState())
372
class AvahiServiceToSyslog(AvahiService):
374
"""Add the new name to the syslog messages"""
375
ret = AvahiService.rename(self)
376
syslogger.setFormatter(logging.Formatter
377
('Mandos (%s) [%%(process)d]:'
378
' %%(levelname)s: %%(message)s'
382
def timedelta_to_milliseconds(td):
383
"Convert a datetime.timedelta() to milliseconds"
384
return ((td.days * 24 * 60 * 60 * 1000)
385
+ (td.seconds * 1000)
386
+ (td.microseconds // 1000))
388
class Client(object):
179
389
"""A representation of a client host served by this server.
181
name: string; from the config file, used in log messages
392
approved: bool(); 'None' if not yet approved/disapproved
393
approval_delay: datetime.timedelta(); Time to wait for approval
394
approval_duration: datetime.timedelta(); Duration of one approval
395
checker: subprocess.Popen(); a running checker process used
396
to see if the client lives.
397
'None' if no process is running.
398
checker_callback_tag: a gobject event source tag, or None
399
checker_command: string; External command which is run to check
400
if client lives. %() expansions are done at
401
runtime with vars(self) as dict, so that for
402
instance %(name)s can be used in the command.
403
checker_initiator_tag: a gobject event source tag, or None
404
created: datetime.datetime(); (UTC) object creation
405
client_structure: Object describing what attributes a client has
406
and is used for storing the client at exit
407
current_checker_command: string; current running checker_command
408
disable_initiator_tag: a gobject event source tag, or None
182
410
fingerprint: string (40 or 32 hexadecimal digits); used to
183
411
uniquely identify the client
184
secret: bytestring; sent verbatim (over TLS) to client
185
412
host: string; available for use by the checker command
186
created: datetime.datetime(); (UTC) object creation
187
last_enabled: datetime.datetime(); (UTC)
413
interval: datetime.timedelta(); How often to start a new checker
414
last_approval_request: datetime.datetime(); (UTC) or None
189
415
last_checked_ok: datetime.datetime(); (UTC) or None
416
last_checker_status: integer between 0 and 255 reflecting exit
417
status of last checker. -1 reflects crashed
419
last_enabled: datetime.datetime(); (UTC) or None
420
name: string; from the config file, used in log messages and
422
secret: bytestring; sent verbatim (over TLS) to client
190
423
timeout: datetime.timedelta(); How long from last_checked_ok
191
until this client is invalid
192
interval: datetime.timedelta(); How often to start a new checker
193
disable_hook: If set, called by disable() as disable_hook(self)
194
checker: subprocess.Popen(); a running checker process used
195
to see if the client lives.
196
'None' if no process is running.
197
checker_initiator_tag: a gobject event source tag, or None
198
disable_initiator_tag: - '' -
199
checker_callback_tag: - '' -
200
checker_command: string; External command which is run to check if
201
client lives. %() expansions are done at
202
runtime with vars(self) as dict, so that for
203
instance %(name)s can be used in the command.
204
use_dbus: bool(); Whether to provide D-Bus interface and signals
205
dbus_object_path: dbus.ObjectPath ; only set if self.use_dbus
424
until this client is disabled
425
extended_timeout: extra long timeout when password has been sent
426
runtime_expansions: Allowed attributes for runtime expansion.
427
expires: datetime.datetime(); time (UTC) when a client will be
431
runtime_expansions = ("approval_delay", "approval_duration",
432
"created", "enabled", "fingerprint",
433
"host", "interval", "last_checked_ok",
434
"last_enabled", "name", "timeout")
435
client_defaults = { "timeout": "5m",
436
"extended_timeout": "15m",
438
"checker": "fping -q -- %%(host)s",
440
"approval_delay": "0s",
441
"approval_duration": "1s",
442
"approved_by_default": "True",
207
446
def timeout_milliseconds(self):
208
447
"Return the 'timeout' attribute in milliseconds"
209
return ((self.timeout.days * 24 * 60 * 60 * 1000)
210
+ (self.timeout.seconds * 1000)
211
+ (self.timeout.microseconds // 1000))
448
return timedelta_to_milliseconds(self.timeout)
450
def extended_timeout_milliseconds(self):
451
"Return the 'extended_timeout' attribute in milliseconds"
452
return timedelta_to_milliseconds(self.extended_timeout)
213
454
def interval_milliseconds(self):
214
455
"Return the 'interval' attribute in milliseconds"
215
return ((self.interval.days * 24 * 60 * 60 * 1000)
216
+ (self.interval.seconds * 1000)
217
+ (self.interval.microseconds // 1000))
456
return timedelta_to_milliseconds(self.interval)
219
def __init__(self, name = None, disable_hook=None, config=None,
458
def approval_delay_milliseconds(self):
459
return timedelta_to_milliseconds(self.approval_delay)
462
def config_parser(config):
463
"""Construct a new dict of client settings of this form:
464
{ client_name: {setting_name: value, ...}, ...}
465
with exceptions for any special settings as defined above.
466
NOTE: Must be a pure function. Must return the same result
467
value given the same arguments.
470
for client_name in config.sections():
471
section = dict(config.items(client_name))
472
client = settings[client_name] = {}
474
client["host"] = section["host"]
475
# Reformat values from string types to Python types
476
client["approved_by_default"] = config.getboolean(
477
client_name, "approved_by_default")
478
client["enabled"] = config.getboolean(client_name,
481
client["fingerprint"] = (section["fingerprint"].upper()
483
if "secret" in section:
484
client["secret"] = section["secret"].decode("base64")
485
elif "secfile" in section:
486
with open(os.path.expanduser(os.path.expandvars
487
(section["secfile"])),
489
client["secret"] = secfile.read()
491
raise TypeError("No secret or secfile for section %s"
493
client["timeout"] = string_to_delta(section["timeout"])
494
client["extended_timeout"] = string_to_delta(
495
section["extended_timeout"])
496
client["interval"] = string_to_delta(section["interval"])
497
client["approval_delay"] = string_to_delta(
498
section["approval_delay"])
499
client["approval_duration"] = string_to_delta(
500
section["approval_duration"])
501
client["checker_command"] = section["checker"]
502
client["last_approval_request"] = None
503
client["last_checked_ok"] = None
504
client["last_checker_status"] = None
509
def __init__(self, settings, name = None):
221
510
"""Note: the 'checker' key in 'config' sets the
222
511
'checker_command' attribute and *not* the 'checker'
227
logger.debug(u"Creating client %r", self.name)
228
self.use_dbus = use_dbus
230
self.dbus_object_path = (dbus.ObjectPath
232
+ self.name.replace(".", "_")))
233
dbus.service.Object.__init__(self, bus,
234
self.dbus_object_path)
514
# adding all client settings
515
for setting, value in settings.iteritems():
516
setattr(self, setting, value)
519
if not hasattr(self, "last_enabled"):
520
self.last_enabled = datetime.datetime.utcnow()
521
if not hasattr(self, "expires"):
522
self.expires = (datetime.datetime.utcnow()
525
self.last_enabled = None
528
logger.debug("Creating client %r", self.name)
235
529
# Uppercase and remove spaces from fingerprint for later
236
530
# comparison purposes with return value from the fingerprint()
238
self.fingerprint = (config["fingerprint"].upper()
240
logger.debug(u" Fingerprint: %s", self.fingerprint)
241
if "secret" in config:
242
self.secret = config["secret"].decode(u"base64")
243
elif "secfile" in config:
244
with closing(open(os.path.expanduser
246
(config["secfile"])))) as secfile:
247
self.secret = secfile.read()
249
raise TypeError(u"No secret or secfile for client %s"
251
self.host = config.get("host", "")
252
self.created = datetime.datetime.utcnow()
254
self.last_enabled = None
255
self.last_checked_ok = None
256
self.timeout = string_to_delta(config["timeout"])
257
self.interval = string_to_delta(config["interval"])
258
self.disable_hook = disable_hook
532
logger.debug(" Fingerprint: %s", self.fingerprint)
533
self.created = settings.get("created",
534
datetime.datetime.utcnow())
536
# attributes specific for this server instance
259
537
self.checker = None
260
538
self.checker_initiator_tag = None
261
539
self.disable_initiator_tag = None
262
540
self.checker_callback_tag = None
263
self.checker_command = config["checker"]
541
self.current_checker_command = None
543
self.approvals_pending = 0
544
self.changedstate = (multiprocessing_manager
545
.Condition(multiprocessing_manager
547
self.client_structure = [attr for attr in
548
self.__dict__.iterkeys()
549
if not attr.startswith("_")]
550
self.client_structure.append("client_structure")
552
for name, t in inspect.getmembers(type(self),
556
if not name.startswith("_"):
557
self.client_structure.append(name)
559
# Send notice to process children that client state has changed
560
def send_changedstate(self):
561
with self.changedstate:
562
self.changedstate.notify_all()
265
564
def enable(self):
266
565
"""Start this client's checker and timeout hooks"""
566
if getattr(self, "enabled", False):
569
self.send_changedstate()
570
self.expires = datetime.datetime.utcnow() + self.timeout
267
572
self.last_enabled = datetime.datetime.utcnow()
575
def disable(self, quiet=True):
576
"""Disable this client."""
577
if not getattr(self, "enabled", False):
580
self.send_changedstate()
582
logger.info("Disabling client %s", self.name)
583
if getattr(self, "disable_initiator_tag", False):
584
gobject.source_remove(self.disable_initiator_tag)
585
self.disable_initiator_tag = None
587
if getattr(self, "checker_initiator_tag", False):
588
gobject.source_remove(self.checker_initiator_tag)
589
self.checker_initiator_tag = None
592
# Do not run this again if called by a gobject.timeout_add
598
def init_checker(self):
268
599
# Schedule a new checker to be started an 'interval' from now,
269
600
# and every interval from then on.
270
601
self.checker_initiator_tag = (gobject.timeout_add
271
602
(self.interval_milliseconds(),
272
603
self.start_checker))
273
# Also start a new checker *right now*.
275
604
# Schedule a disable() when 'timeout' has passed
276
605
self.disable_initiator_tag = (gobject.timeout_add
277
606
(self.timeout_milliseconds(),
282
self.PropertyChanged(dbus.String(u"enabled"),
283
dbus.Boolean(True, variant_level=1))
284
self.PropertyChanged(dbus.String(u"last_enabled"),
285
(_datetime_to_dbus(self.last_enabled,
289
"""Disable this client."""
290
if not getattr(self, "enabled", False):
292
logger.info(u"Disabling client %s", self.name)
293
if getattr(self, "disable_initiator_tag", False):
294
gobject.source_remove(self.disable_initiator_tag)
295
self.disable_initiator_tag = None
296
if getattr(self, "checker_initiator_tag", False):
297
gobject.source_remove(self.checker_initiator_tag)
298
self.checker_initiator_tag = None
300
if self.disable_hook:
301
self.disable_hook(self)
305
self.PropertyChanged(dbus.String(u"enabled"),
306
dbus.Boolean(False, variant_level=1))
307
# Do not run this again if called by a gobject.timeout_add
311
self.disable_hook = None
608
# Also start a new checker *right now*.
314
611
def checker_callback(self, pid, condition, command):
315
612
"""The checker has completed, so take appropriate actions."""
316
613
self.checker_callback_tag = None
317
614
self.checker = None
320
self.PropertyChanged(dbus.String(u"checker_running"),
321
dbus.Boolean(False, variant_level=1))
322
if (os.WIFEXITED(condition)
323
and (os.WEXITSTATUS(condition) == 0)):
324
logger.info(u"Checker for %(name)s succeeded",
328
self.CheckerCompleted(dbus.Boolean(True),
329
dbus.UInt16(condition),
330
dbus.String(command))
332
elif not os.WIFEXITED(condition):
333
logger.warning(u"Checker for %(name)s crashed?",
615
if os.WIFEXITED(condition):
616
self.last_checker_status = os.WEXITSTATUS(condition)
617
if self.last_checker_status == 0:
618
logger.info("Checker for %(name)s succeeded",
622
logger.info("Checker for %(name)s failed",
625
self.last_checker_status = -1
626
logger.warning("Checker for %(name)s crashed?",
337
self.CheckerCompleted(dbus.Boolean(False),
338
dbus.UInt16(condition),
339
dbus.String(command))
341
logger.info(u"Checker for %(name)s failed",
345
self.CheckerCompleted(dbus.Boolean(False),
346
dbus.UInt16(condition),
347
dbus.String(command))
349
def bump_timeout(self):
629
def checked_ok(self, timeout=None):
350
630
"""Bump up the timeout for this client.
351
632
This should only be called when the client has been seen,
636
timeout = self.timeout
354
637
self.last_checked_ok = datetime.datetime.utcnow()
355
gobject.source_remove(self.disable_initiator_tag)
356
self.disable_initiator_tag = (gobject.timeout_add
357
(self.timeout_milliseconds(),
361
self.PropertyChanged(
362
dbus.String(u"last_checked_ok"),
363
(_datetime_to_dbus(self.last_checked_ok,
638
if self.disable_initiator_tag is not None:
639
gobject.source_remove(self.disable_initiator_tag)
640
if getattr(self, "enabled", False):
641
self.disable_initiator_tag = (gobject.timeout_add
642
(timedelta_to_milliseconds
643
(timeout), self.disable))
644
self.expires = datetime.datetime.utcnow() + timeout
646
def need_approval(self):
647
self.last_approval_request = datetime.datetime.utcnow()
366
649
def start_checker(self):
367
650
"""Start a new checker subprocess if one is not running.
368
652
If a checker already exists, leave it running and do
370
654
# The reason for not killing a running checker is that if we
423
728
self.checker_callback_tag = None
424
729
if getattr(self, "checker", None) is None:
426
logger.debug(u"Stopping checker for %(name)s", vars(self))
731
logger.debug("Stopping checker for %(name)s", vars(self))
428
733
os.kill(self.checker.pid, signal.SIGTERM)
430
735
#if self.checker.poll() is None:
431
736
# os.kill(self.checker.pid, signal.SIGKILL)
432
except OSError, error:
737
except OSError as error:
433
738
if error.errno != errno.ESRCH: # No such process
435
740
self.checker = None
437
self.PropertyChanged(dbus.String(u"checker_running"),
438
dbus.Boolean(False, variant_level=1))
440
def still_valid(self):
441
"""Has the timeout not yet passed for this client?"""
442
if not getattr(self, "enabled", False):
444
now = datetime.datetime.utcnow()
445
if self.last_checked_ok is None:
446
return now < (self.created + self.timeout)
448
return now < (self.last_checked_ok + self.timeout)
450
## D-Bus methods & signals
451
_interface = u"org.mandos_system.Mandos.Client"
453
# BumpTimeout - method
454
BumpTimeout = dbus.service.method(_interface)(bump_timeout)
455
BumpTimeout.__name__ = "BumpTimeout"
743
def dbus_service_property(dbus_interface, signature="v",
744
access="readwrite", byte_arrays=False):
745
"""Decorators for marking methods of a DBusObjectWithProperties to
746
become properties on the D-Bus.
748
The decorated method will be called with no arguments by "Get"
749
and with one argument by "Set".
751
The parameters, where they are supported, are the same as
752
dbus.service.method, except there is only "signature", since the
753
type from Get() and the type sent to Set() is the same.
755
# Encoding deeply encoded byte arrays is not supported yet by the
756
# "Set" method, so we fail early here:
757
if byte_arrays and signature != "ay":
758
raise ValueError("Byte arrays not supported for non-'ay'"
759
" signature %r" % signature)
761
func._dbus_is_property = True
762
func._dbus_interface = dbus_interface
763
func._dbus_signature = signature
764
func._dbus_access = access
765
func._dbus_name = func.__name__
766
if func._dbus_name.endswith("_dbus_property"):
767
func._dbus_name = func._dbus_name[:-14]
768
func._dbus_get_args_options = {'byte_arrays': byte_arrays }
773
class DBusPropertyException(dbus.exceptions.DBusException):
774
"""A base class for D-Bus property-related exceptions
776
def __unicode__(self):
777
return unicode(str(self))
780
class DBusPropertyAccessException(DBusPropertyException):
781
"""A property's access permissions disallows an operation.
786
class DBusPropertyNotFound(DBusPropertyException):
787
"""An attempt was made to access a non-existing property.
792
class DBusObjectWithProperties(dbus.service.Object):
793
"""A D-Bus object with properties.
795
Classes inheriting from this can use the dbus_service_property
796
decorator to expose methods as D-Bus properties. It exposes the
797
standard Get(), Set(), and GetAll() methods on the D-Bus.
801
def _is_dbus_property(obj):
802
return getattr(obj, "_dbus_is_property", False)
804
def _get_all_dbus_properties(self):
805
"""Returns a generator of (name, attribute) pairs
807
return ((prop.__get__(self)._dbus_name, prop.__get__(self))
808
for cls in self.__class__.__mro__
810
inspect.getmembers(cls, self._is_dbus_property))
812
def _get_dbus_property(self, interface_name, property_name):
813
"""Returns a bound method if one exists which is a D-Bus
814
property with the specified name and interface.
816
for cls in self.__class__.__mro__:
817
for name, value in (inspect.getmembers
818
(cls, self._is_dbus_property)):
819
if (value._dbus_name == property_name
820
and value._dbus_interface == interface_name):
821
return value.__get__(self)
824
raise DBusPropertyNotFound(self.dbus_object_path + ":"
825
+ interface_name + "."
828
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
830
def Get(self, interface_name, property_name):
831
"""Standard D-Bus property Get() method, see D-Bus standard.
833
prop = self._get_dbus_property(interface_name, property_name)
834
if prop._dbus_access == "write":
835
raise DBusPropertyAccessException(property_name)
837
if not hasattr(value, "variant_level"):
839
return type(value)(value, variant_level=value.variant_level+1)
841
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
842
def Set(self, interface_name, property_name, value):
843
"""Standard D-Bus property Set() method, see D-Bus standard.
845
prop = self._get_dbus_property(interface_name, property_name)
846
if prop._dbus_access == "read":
847
raise DBusPropertyAccessException(property_name)
848
if prop._dbus_get_args_options["byte_arrays"]:
849
# The byte_arrays option is not supported yet on
850
# signatures other than "ay".
851
if prop._dbus_signature != "ay":
853
value = dbus.ByteArray(b''.join(chr(byte)
857
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
858
out_signature="a{sv}")
859
def GetAll(self, interface_name):
860
"""Standard D-Bus property GetAll() method, see D-Bus
863
Note: Will not include properties with access="write".
866
for name, prop in self._get_all_dbus_properties():
868
and interface_name != prop._dbus_interface):
869
# Interface non-empty but did not match
871
# Ignore write-only properties
872
if prop._dbus_access == "write":
875
if not hasattr(value, "variant_level"):
876
properties[name] = value
878
properties[name] = type(value)(value, variant_level=
879
value.variant_level+1)
880
return dbus.Dictionary(properties, signature="sv")
882
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
884
path_keyword='object_path',
885
connection_keyword='connection')
886
def Introspect(self, object_path, connection):
887
"""Standard D-Bus method, overloaded to insert property tags.
889
xmlstring = dbus.service.Object.Introspect(self, object_path,
892
document = xml.dom.minidom.parseString(xmlstring)
893
def make_tag(document, name, prop):
894
e = document.createElement("property")
895
e.setAttribute("name", name)
896
e.setAttribute("type", prop._dbus_signature)
897
e.setAttribute("access", prop._dbus_access)
899
for if_tag in document.getElementsByTagName("interface"):
900
for tag in (make_tag(document, name, prop)
902
in self._get_all_dbus_properties()
903
if prop._dbus_interface
904
== if_tag.getAttribute("name")):
905
if_tag.appendChild(tag)
906
# Add the names to the return values for the
907
# "org.freedesktop.DBus.Properties" methods
908
if (if_tag.getAttribute("name")
909
== "org.freedesktop.DBus.Properties"):
910
for cn in if_tag.getElementsByTagName("method"):
911
if cn.getAttribute("name") == "Get":
912
for arg in cn.getElementsByTagName("arg"):
913
if (arg.getAttribute("direction")
915
arg.setAttribute("name", "value")
916
elif cn.getAttribute("name") == "GetAll":
917
for arg in cn.getElementsByTagName("arg"):
918
if (arg.getAttribute("direction")
920
arg.setAttribute("name", "props")
921
xmlstring = document.toxml("utf-8")
923
except (AttributeError, xml.dom.DOMException,
924
xml.parsers.expat.ExpatError) as error:
925
logger.error("Failed to override Introspection method",
930
def datetime_to_dbus (dt, variant_level=0):
931
"""Convert a UTC datetime.datetime() to a D-Bus type."""
933
return dbus.String("", variant_level = variant_level)
934
return dbus.String(dt.isoformat(),
935
variant_level=variant_level)
938
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
940
"""Applied to an empty subclass of a D-Bus object, this metaclass
941
will add additional D-Bus attributes matching a certain pattern.
943
def __new__(mcs, name, bases, attr):
944
# Go through all the base classes which could have D-Bus
945
# methods, signals, or properties in them
946
for base in (b for b in bases
947
if issubclass(b, dbus.service.Object)):
948
# Go though all attributes of the base class
949
for attrname, attribute in inspect.getmembers(base):
950
# Ignore non-D-Bus attributes, and D-Bus attributes
951
# with the wrong interface name
952
if (not hasattr(attribute, "_dbus_interface")
953
or not attribute._dbus_interface
954
.startswith("se.recompile.Mandos")):
956
# Create an alternate D-Bus interface name based on
958
alt_interface = (attribute._dbus_interface
959
.replace("se.recompile.Mandos",
960
"se.bsnet.fukt.Mandos"))
961
# Is this a D-Bus signal?
962
if getattr(attribute, "_dbus_is_signal", False):
963
# Extract the original non-method function by
965
nonmethod_func = (dict(
966
zip(attribute.func_code.co_freevars,
967
attribute.__closure__))["func"]
969
# Create a new, but exactly alike, function
970
# object, and decorate it to be a new D-Bus signal
971
# with the alternate D-Bus interface name
972
new_function = (dbus.service.signal
974
attribute._dbus_signature)
976
nonmethod_func.func_code,
977
nonmethod_func.func_globals,
978
nonmethod_func.func_name,
979
nonmethod_func.func_defaults,
980
nonmethod_func.func_closure)))
981
# Define a creator of a function to call both the
982
# old and new functions, so both the old and new
983
# signals gets sent when the function is called
984
def fixscope(func1, func2):
985
"""This function is a scope container to pass
986
func1 and func2 to the "call_both" function
987
outside of its arguments"""
988
def call_both(*args, **kwargs):
989
"""This function will emit two D-Bus
990
signals by calling func1 and func2"""
991
func1(*args, **kwargs)
992
func2(*args, **kwargs)
994
# Create the "call_both" function and add it to
996
attr[attrname] = fixscope(attribute,
998
# Is this a D-Bus method?
999
elif getattr(attribute, "_dbus_is_method", False):
1000
# Create a new, but exactly alike, function
1001
# object. Decorate it to be a new D-Bus method
1002
# with the alternate D-Bus interface name. Add it
1004
attr[attrname] = (dbus.service.method
1006
attribute._dbus_in_signature,
1007
attribute._dbus_out_signature)
1009
(attribute.func_code,
1010
attribute.func_globals,
1011
attribute.func_name,
1012
attribute.func_defaults,
1013
attribute.func_closure)))
1014
# Is this a D-Bus property?
1015
elif getattr(attribute, "_dbus_is_property", False):
1016
# Create a new, but exactly alike, function
1017
# object, and decorate it to be a new D-Bus
1018
# property with the alternate D-Bus interface
1019
# name. Add it to the class.
1020
attr[attrname] = (dbus_service_property
1022
attribute._dbus_signature,
1023
attribute._dbus_access,
1025
._dbus_get_args_options
1028
(attribute.func_code,
1029
attribute.func_globals,
1030
attribute.func_name,
1031
attribute.func_defaults,
1032
attribute.func_closure)))
1033
return type.__new__(mcs, name, bases, attr)
1036
class ClientDBus(Client, DBusObjectWithProperties):
1037
"""A Client class using D-Bus
1040
dbus_object_path: dbus.ObjectPath
1041
bus: dbus.SystemBus()
1044
runtime_expansions = (Client.runtime_expansions
1045
+ ("dbus_object_path",))
1047
# dbus.service.Object doesn't use super(), so we can't either.
1049
def __init__(self, bus = None, *args, **kwargs):
1051
Client.__init__(self, *args, **kwargs)
1052
self._approvals_pending = 0
1054
self._approvals_pending = 0
1055
# Only now, when this client is initialized, can it show up on
1057
client_object_name = unicode(self.name).translate(
1058
{ord("."): ord("_"),
1059
ord("-"): ord("_")})
1060
self.dbus_object_path = (dbus.ObjectPath
1061
("/clients/" + client_object_name))
1062
DBusObjectWithProperties.__init__(self, self.bus,
1063
self.dbus_object_path)
1065
def notifychangeproperty(transform_func,
1066
dbus_name, type_func=lambda x: x,
1068
""" Modify a variable so that it's a property which announces
1069
its changes to DBus.
1071
transform_fun: Function that takes a value and a variant_level
1072
and transforms it to a D-Bus type.
1073
dbus_name: D-Bus name of the variable
1074
type_func: Function that transform the value before sending it
1075
to the D-Bus. Default: no transform
1076
variant_level: D-Bus variant level. Default: 1
1078
attrname = "_{0}".format(dbus_name)
1079
def setter(self, value):
1080
if hasattr(self, "dbus_object_path"):
1081
if (not hasattr(self, attrname) or
1082
type_func(getattr(self, attrname, None))
1083
!= type_func(value)):
1084
dbus_value = transform_func(type_func(value),
1087
self.PropertyChanged(dbus.String(dbus_name),
1089
setattr(self, attrname, value)
1091
return property(lambda self: getattr(self, attrname), setter)
1094
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1095
approvals_pending = notifychangeproperty(dbus.Boolean,
1098
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1099
last_enabled = notifychangeproperty(datetime_to_dbus,
1101
checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1102
type_func = lambda checker:
1103
checker is not None)
1104
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1106
last_approval_request = notifychangeproperty(
1107
datetime_to_dbus, "LastApprovalRequest")
1108
approved_by_default = notifychangeproperty(dbus.Boolean,
1109
"ApprovedByDefault")
1110
approval_delay = notifychangeproperty(dbus.UInt64,
1113
timedelta_to_milliseconds)
1114
approval_duration = notifychangeproperty(
1115
dbus.UInt64, "ApprovalDuration",
1116
type_func = timedelta_to_milliseconds)
1117
host = notifychangeproperty(dbus.String, "Host")
1118
timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1120
timedelta_to_milliseconds)
1121
extended_timeout = notifychangeproperty(
1122
dbus.UInt64, "ExtendedTimeout",
1123
type_func = timedelta_to_milliseconds)
1124
interval = notifychangeproperty(dbus.UInt64,
1127
timedelta_to_milliseconds)
1128
checker_command = notifychangeproperty(dbus.String, "Checker")
1130
del notifychangeproperty
1132
def __del__(self, *args, **kwargs):
1134
self.remove_from_connection()
1137
if hasattr(DBusObjectWithProperties, "__del__"):
1138
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1139
Client.__del__(self, *args, **kwargs)
1141
def checker_callback(self, pid, condition, command,
1143
self.checker_callback_tag = None
1145
if os.WIFEXITED(condition):
1146
exitstatus = os.WEXITSTATUS(condition)
1148
self.CheckerCompleted(dbus.Int16(exitstatus),
1149
dbus.Int64(condition),
1150
dbus.String(command))
1153
self.CheckerCompleted(dbus.Int16(-1),
1154
dbus.Int64(condition),
1155
dbus.String(command))
1157
return Client.checker_callback(self, pid, condition, command,
1160
def start_checker(self, *args, **kwargs):
1161
old_checker = self.checker
1162
if self.checker is not None:
1163
old_checker_pid = self.checker.pid
1165
old_checker_pid = None
1166
r = Client.start_checker(self, *args, **kwargs)
1167
# Only if new checker process was started
1168
if (self.checker is not None
1169
and old_checker_pid != self.checker.pid):
1171
self.CheckerStarted(self.current_checker_command)
1174
def _reset_approved(self):
1175
self.approved = None
1178
def approve(self, value=True):
1179
self.send_changedstate()
1180
self.approved = value
1181
gobject.timeout_add(timedelta_to_milliseconds
1182
(self.approval_duration),
1183
self._reset_approved)
1186
## D-Bus methods, signals & properties
1187
_interface = "se.recompile.Mandos.Client"
457
1191
# CheckerCompleted - signal
458
@dbus.service.signal(_interface, signature="bqs")
459
def CheckerCompleted(self, success, condition, command):
1192
@dbus.service.signal(_interface, signature="nxs")
1193
def CheckerCompleted(self, exitcode, waitstatus, command):
579
1268
# StopChecker - method
580
StopChecker = dbus.service.method(_interface)(stop_checker)
581
StopChecker.__name__ = "StopChecker"
1269
@dbus.service.method(_interface)
1270
def StopChecker(self):
1275
# ApprovalPending - property
1276
@dbus_service_property(_interface, signature="b", access="read")
1277
def ApprovalPending_dbus_property(self):
1278
return dbus.Boolean(bool(self.approvals_pending))
1280
# ApprovedByDefault - property
1281
@dbus_service_property(_interface, signature="b",
1283
def ApprovedByDefault_dbus_property(self, value=None):
1284
if value is None: # get
1285
return dbus.Boolean(self.approved_by_default)
1286
self.approved_by_default = bool(value)
1288
# ApprovalDelay - property
1289
@dbus_service_property(_interface, signature="t",
1291
def ApprovalDelay_dbus_property(self, value=None):
1292
if value is None: # get
1293
return dbus.UInt64(self.approval_delay_milliseconds())
1294
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1296
# ApprovalDuration - property
1297
@dbus_service_property(_interface, signature="t",
1299
def ApprovalDuration_dbus_property(self, value=None):
1300
if value is None: # get
1301
return dbus.UInt64(timedelta_to_milliseconds(
1302
self.approval_duration))
1303
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1306
@dbus_service_property(_interface, signature="s", access="read")
1307
def Name_dbus_property(self):
1308
return dbus.String(self.name)
1310
# Fingerprint - property
1311
@dbus_service_property(_interface, signature="s", access="read")
1312
def Fingerprint_dbus_property(self):
1313
return dbus.String(self.fingerprint)
1316
@dbus_service_property(_interface, signature="s",
1318
def Host_dbus_property(self, value=None):
1319
if value is None: # get
1320
return dbus.String(self.host)
1321
self.host = unicode(value)
1323
# Created - property
1324
@dbus_service_property(_interface, signature="s", access="read")
1325
def Created_dbus_property(self):
1326
return datetime_to_dbus(self.created)
1328
# LastEnabled - property
1329
@dbus_service_property(_interface, signature="s", access="read")
1330
def LastEnabled_dbus_property(self):
1331
return datetime_to_dbus(self.last_enabled)
1333
# Enabled - property
1334
@dbus_service_property(_interface, signature="b",
1336
def Enabled_dbus_property(self, value=None):
1337
if value is None: # get
1338
return dbus.Boolean(self.enabled)
1344
# LastCheckedOK - property
1345
@dbus_service_property(_interface, signature="s",
1347
def LastCheckedOK_dbus_property(self, value=None):
1348
if value is not None:
1351
return datetime_to_dbus(self.last_checked_ok)
1353
# Expires - property
1354
@dbus_service_property(_interface, signature="s", access="read")
1355
def Expires_dbus_property(self):
1356
return datetime_to_dbus(self.expires)
1358
# LastApprovalRequest - property
1359
@dbus_service_property(_interface, signature="s", access="read")
1360
def LastApprovalRequest_dbus_property(self):
1361
return datetime_to_dbus(self.last_approval_request)
1363
# Timeout - property
1364
@dbus_service_property(_interface, signature="t",
1366
def Timeout_dbus_property(self, value=None):
1367
if value is None: # get
1368
return dbus.UInt64(self.timeout_milliseconds())
1369
self.timeout = datetime.timedelta(0, 0, 0, value)
1370
# Reschedule timeout
1372
now = datetime.datetime.utcnow()
1373
time_to_die = timedelta_to_milliseconds(
1374
(self.last_checked_ok + self.timeout) - now)
1375
if time_to_die <= 0:
1376
# The timeout has passed
1379
self.expires = (now +
1380
datetime.timedelta(milliseconds =
1382
if (getattr(self, "disable_initiator_tag", None)
1385
gobject.source_remove(self.disable_initiator_tag)
1386
self.disable_initiator_tag = (gobject.timeout_add
1390
# ExtendedTimeout - property
1391
@dbus_service_property(_interface, signature="t",
1393
def ExtendedTimeout_dbus_property(self, value=None):
1394
if value is None: # get
1395
return dbus.UInt64(self.extended_timeout_milliseconds())
1396
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1398
# Interval - property
1399
@dbus_service_property(_interface, signature="t",
1401
def Interval_dbus_property(self, value=None):
1402
if value is None: # get
1403
return dbus.UInt64(self.interval_milliseconds())
1404
self.interval = datetime.timedelta(0, 0, 0, value)
1405
if getattr(self, "checker_initiator_tag", None) is None:
1408
# Reschedule checker run
1409
gobject.source_remove(self.checker_initiator_tag)
1410
self.checker_initiator_tag = (gobject.timeout_add
1411
(value, self.start_checker))
1412
self.start_checker() # Start one now, too
1414
# Checker - property
1415
@dbus_service_property(_interface, signature="s",
1417
def Checker_dbus_property(self, value=None):
1418
if value is None: # get
1419
return dbus.String(self.checker_command)
1420
self.checker_command = unicode(value)
1422
# CheckerRunning - property
1423
@dbus_service_property(_interface, signature="b",
1425
def CheckerRunning_dbus_property(self, value=None):
1426
if value is None: # get
1427
return dbus.Boolean(self.checker is not None)
1429
self.start_checker()
1433
# ObjectPath - property
1434
@dbus_service_property(_interface, signature="o", access="read")
1435
def ObjectPath_dbus_property(self):
1436
return self.dbus_object_path # is already a dbus.ObjectPath
1439
@dbus_service_property(_interface, signature="ay",
1440
access="write", byte_arrays=True)
1441
def Secret_dbus_property(self, value):
1442
self.secret = str(value)
586
def peer_certificate(session):
587
"Return the peer's OpenPGP certificate as a bytestring"
588
# If not an OpenPGP certificate...
589
if (gnutls.library.functions
590
.gnutls_certificate_type_get(session._c_object)
591
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
592
# ...do the normal thing
593
return session.peer_certificate
594
list_size = ctypes.c_uint()
595
cert_list = (gnutls.library.functions
596
.gnutls_certificate_get_peers
597
(session._c_object, ctypes.byref(list_size)))
598
if list_size.value == 0:
601
return ctypes.string_at(cert.data, cert.size)
604
def fingerprint(openpgp):
605
"Convert an OpenPGP bytestring to a hexdigit fingerprint string"
606
# New GnuTLS "datum" with the OpenPGP public key
607
datum = (gnutls.library.types
608
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
611
ctypes.c_uint(len(openpgp))))
612
# New empty GnuTLS certificate
613
crt = gnutls.library.types.gnutls_openpgp_crt_t()
614
(gnutls.library.functions
615
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
616
# Import the OpenPGP public key into the certificate
617
(gnutls.library.functions
618
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
619
gnutls.library.constants
620
.GNUTLS_OPENPGP_FMT_RAW))
621
# Verify the self signature in the key
622
crtverify = ctypes.c_uint()
623
(gnutls.library.functions
624
.gnutls_openpgp_crt_verify_self(crt, 0, ctypes.byref(crtverify)))
625
if crtverify.value != 0:
626
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
627
raise gnutls.errors.CertificateSecurityError("Verify failed")
628
# New buffer for the fingerprint
629
buf = ctypes.create_string_buffer(20)
630
buf_len = ctypes.c_size_t()
631
# Get the fingerprint from the certificate into the buffer
632
(gnutls.library.functions
633
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
634
ctypes.byref(buf_len)))
635
# Deinit the certificate
636
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
637
# Convert the buffer to a Python bytestring
638
fpr = ctypes.string_at(buf, buf_len.value)
639
# Convert the bytestring to hexadecimal notation
640
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
644
class TCP_handler(SocketServer.BaseRequestHandler, object):
645
"""A TCP request handler class.
646
Instantiated by IPv6_TCPServer for each request to handle it.
1447
class ProxyClient(object):
1448
def __init__(self, child_pipe, fpr, address):
1449
self._pipe = child_pipe
1450
self._pipe.send(('init', fpr, address))
1451
if not self._pipe.recv():
1454
def __getattribute__(self, name):
1456
return super(ProxyClient, self).__getattribute__(name)
1457
self._pipe.send(('getattr', name))
1458
data = self._pipe.recv()
1459
if data[0] == 'data':
1461
if data[0] == 'function':
1462
def func(*args, **kwargs):
1463
self._pipe.send(('funcall', name, args, kwargs))
1464
return self._pipe.recv()[1]
1467
def __setattr__(self, name, value):
1469
return super(ProxyClient, self).__setattr__(name, value)
1470
self._pipe.send(('setattr', name, value))
1473
class ClientDBusTransitional(ClientDBus):
1474
__metaclass__ = AlternateDBusNamesMetaclass
1477
class ClientHandler(socketserver.BaseRequestHandler, object):
1478
"""A class to handle client connections.
1480
Instantiated once for each connection to handle it.
647
1481
Note: This will run in its own forked process."""
649
1483
def handle(self):
650
logger.info(u"TCP connection from: %s",
651
unicode(self.client_address))
652
session = (gnutls.connection
653
.ClientSession(self.request,
657
line = self.request.makefile().readline()
658
logger.debug(u"Protocol version: %r", line)
660
if int(line.strip().split()[0]) > 1:
662
except (ValueError, IndexError, RuntimeError), error:
663
logger.error(u"Unknown protocol version: %s", error)
666
# Note: gnutls.connection.X509Credentials is really a generic
667
# GnuTLS certificate credentials object so long as no X.509
668
# keys are added to it. Therefore, we can use it here despite
669
# using OpenPGP certificates.
671
#priority = ':'.join(("NONE", "+VERS-TLS1.1", "+AES-256-CBC",
672
# "+SHA1", "+COMP-NULL", "+CTYPE-OPENPGP",
674
# Use a fallback default, since this MUST be set.
675
priority = self.server.settings.get("priority", "NORMAL")
676
(gnutls.library.functions
677
.gnutls_priority_set_direct(session._c_object,
682
except gnutls.errors.GNUTLSError, error:
683
logger.warning(u"Handshake failed: %s", error)
684
# Do not run session.bye() here: the session is not
685
# established. Just abandon the request.
688
fpr = fingerprint(peer_certificate(session))
689
except (TypeError, gnutls.errors.GNUTLSError), error:
690
logger.warning(u"Bad certificate: %s", error)
693
logger.debug(u"Fingerprint: %s", fpr)
694
for c in self.server.clients:
695
if c.fingerprint == fpr:
699
logger.warning(u"Client not found for fingerprint: %s",
703
# Have to check if client.still_valid(), since it is possible
704
# that the client timed out while establishing the GnuTLS
706
if not client.still_valid():
707
logger.warning(u"Client %(name)s is invalid",
711
## This won't work here, since we're in a fork.
712
# client.bump_timeout()
714
while sent_size < len(client.secret):
715
sent = session.send(client.secret[sent_size:])
716
logger.debug(u"Sent: %d, remaining: %d",
717
sent, len(client.secret)
718
- (sent_size + sent))
723
class IPv6_TCPServer(SocketServer.ForkingMixIn,
724
SocketServer.TCPServer, object):
725
"""IPv6 TCP server. Accepts 'None' as address and/or port.
1484
with contextlib.closing(self.server.child_pipe) as child_pipe:
1485
logger.info("TCP connection from: %s",
1486
unicode(self.client_address))
1487
logger.debug("Pipe FD: %d",
1488
self.server.child_pipe.fileno())
1490
session = (gnutls.connection
1491
.ClientSession(self.request,
1493
.X509Credentials()))
1495
# Note: gnutls.connection.X509Credentials is really a
1496
# generic GnuTLS certificate credentials object so long as
1497
# no X.509 keys are added to it. Therefore, we can use it
1498
# here despite using OpenPGP certificates.
1500
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1501
# "+AES-256-CBC", "+SHA1",
1502
# "+COMP-NULL", "+CTYPE-OPENPGP",
1504
# Use a fallback default, since this MUST be set.
1505
priority = self.server.gnutls_priority
1506
if priority is None:
1508
(gnutls.library.functions
1509
.gnutls_priority_set_direct(session._c_object,
1512
# Start communication using the Mandos protocol
1513
# Get protocol number
1514
line = self.request.makefile().readline()
1515
logger.debug("Protocol version: %r", line)
1517
if int(line.strip().split()[0]) > 1:
1519
except (ValueError, IndexError, RuntimeError) as error:
1520
logger.error("Unknown protocol version: %s", error)
1523
# Start GnuTLS connection
1526
except gnutls.errors.GNUTLSError as error:
1527
logger.warning("Handshake failed: %s", error)
1528
# Do not run session.bye() here: the session is not
1529
# established. Just abandon the request.
1531
logger.debug("Handshake succeeded")
1533
approval_required = False
1536
fpr = self.fingerprint(self.peer_certificate
1539
gnutls.errors.GNUTLSError) as error:
1540
logger.warning("Bad certificate: %s", error)
1542
logger.debug("Fingerprint: %s", fpr)
1545
client = ProxyClient(child_pipe, fpr,
1546
self.client_address)
1550
if self.server.use_dbus:
1552
client.NewRequest(str(self.client_address))
1554
if client.approval_delay:
1555
delay = client.approval_delay
1556
client.approvals_pending += 1
1557
approval_required = True
1560
if not client.enabled:
1561
logger.info("Client %s is disabled",
1563
if self.server.use_dbus:
1565
client.Rejected("Disabled")
1568
if client.approved or not client.approval_delay:
1569
#We are approved or approval is disabled
1571
elif client.approved is None:
1572
logger.info("Client %s needs approval",
1574
if self.server.use_dbus:
1576
client.NeedApproval(
1577
client.approval_delay_milliseconds(),
1578
client.approved_by_default)
1580
logger.warning("Client %s was not approved",
1582
if self.server.use_dbus:
1584
client.Rejected("Denied")
1587
#wait until timeout or approved
1588
time = datetime.datetime.now()
1589
client.changedstate.acquire()
1590
(client.changedstate.wait
1591
(float(client.timedelta_to_milliseconds(delay)
1593
client.changedstate.release()
1594
time2 = datetime.datetime.now()
1595
if (time2 - time) >= delay:
1596
if not client.approved_by_default:
1597
logger.warning("Client %s timed out while"
1598
" waiting for approval",
1600
if self.server.use_dbus:
1602
client.Rejected("Approval timed out")
1607
delay -= time2 - time
1610
while sent_size < len(client.secret):
1612
sent = session.send(client.secret[sent_size:])
1613
except gnutls.errors.GNUTLSError as error:
1614
logger.warning("gnutls send failed")
1616
logger.debug("Sent: %d, remaining: %d",
1617
sent, len(client.secret)
1618
- (sent_size + sent))
1621
logger.info("Sending secret to %s", client.name)
1622
# bump the timeout using extended_timeout
1623
client.checked_ok(client.extended_timeout)
1624
if self.server.use_dbus:
1629
if approval_required:
1630
client.approvals_pending -= 1
1633
except gnutls.errors.GNUTLSError as error:
1634
logger.warning("GnuTLS bye failed")
1637
def peer_certificate(session):
1638
"Return the peer's OpenPGP certificate as a bytestring"
1639
# If not an OpenPGP certificate...
1640
if (gnutls.library.functions
1641
.gnutls_certificate_type_get(session._c_object)
1642
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1643
# ...do the normal thing
1644
return session.peer_certificate
1645
list_size = ctypes.c_uint(1)
1646
cert_list = (gnutls.library.functions
1647
.gnutls_certificate_get_peers
1648
(session._c_object, ctypes.byref(list_size)))
1649
if not bool(cert_list) and list_size.value != 0:
1650
raise gnutls.errors.GNUTLSError("error getting peer"
1652
if list_size.value == 0:
1655
return ctypes.string_at(cert.data, cert.size)
1658
def fingerprint(openpgp):
1659
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
1660
# New GnuTLS "datum" with the OpenPGP public key
1661
datum = (gnutls.library.types
1662
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1665
ctypes.c_uint(len(openpgp))))
1666
# New empty GnuTLS certificate
1667
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1668
(gnutls.library.functions
1669
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
1670
# Import the OpenPGP public key into the certificate
1671
(gnutls.library.functions
1672
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1673
gnutls.library.constants
1674
.GNUTLS_OPENPGP_FMT_RAW))
1675
# Verify the self signature in the key
1676
crtverify = ctypes.c_uint()
1677
(gnutls.library.functions
1678
.gnutls_openpgp_crt_verify_self(crt, 0,
1679
ctypes.byref(crtverify)))
1680
if crtverify.value != 0:
1681
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1682
raise (gnutls.errors.CertificateSecurityError
1684
# New buffer for the fingerprint
1685
buf = ctypes.create_string_buffer(20)
1686
buf_len = ctypes.c_size_t()
1687
# Get the fingerprint from the certificate into the buffer
1688
(gnutls.library.functions
1689
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1690
ctypes.byref(buf_len)))
1691
# Deinit the certificate
1692
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1693
# Convert the buffer to a Python bytestring
1694
fpr = ctypes.string_at(buf, buf_len.value)
1695
# Convert the bytestring to hexadecimal notation
1696
hex_fpr = binascii.hexlify(fpr).upper()
1700
class MultiprocessingMixIn(object):
1701
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
1702
def sub_process_main(self, request, address):
1704
self.finish_request(request, address)
1706
self.handle_error(request, address)
1707
self.close_request(request)
1709
def process_request(self, request, address):
1710
"""Start a new process to process the request."""
1711
proc = multiprocessing.Process(target = self.sub_process_main,
1718
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1719
""" adds a pipe to the MixIn """
1720
def process_request(self, request, client_address):
1721
"""Overrides and wraps the original process_request().
1723
This function creates a new pipe in self.pipe
1725
parent_pipe, self.child_pipe = multiprocessing.Pipe()
1727
proc = MultiprocessingMixIn.process_request(self, request,
1729
self.child_pipe.close()
1730
self.add_pipe(parent_pipe, proc)
1732
def add_pipe(self, parent_pipe, proc):
1733
"""Dummy function; override as necessary"""
1734
raise NotImplementedError
1737
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1738
socketserver.TCPServer, object):
1739
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
727
settings: Server settings
728
clients: Set() of Client objects
729
1742
enabled: Boolean; whether this server is activated yet
1743
interface: None or a network interface name (string)
1744
use_ipv6: Boolean; to use IPv6 or not
731
address_family = socket.AF_INET6
732
def __init__(self, *args, **kwargs):
733
if "settings" in kwargs:
734
self.settings = kwargs["settings"]
735
del kwargs["settings"]
736
if "clients" in kwargs:
737
self.clients = kwargs["clients"]
738
del kwargs["clients"]
740
super(IPv6_TCPServer, self).__init__(*args, **kwargs)
1746
def __init__(self, server_address, RequestHandlerClass,
1747
interface=None, use_ipv6=True):
1748
self.interface = interface
1750
self.address_family = socket.AF_INET6
1751
socketserver.TCPServer.__init__(self, server_address,
1752
RequestHandlerClass)
741
1753
def server_bind(self):
742
1754
"""This overrides the normal server_bind() function
743
1755
to bind to an interface if one was specified, and also NOT to
744
1756
bind to an address or port if they were not specified."""
745
if self.settings["interface"]:
746
# 25 is from /usr/include/asm-i486/socket.h
747
SO_BINDTODEVICE = getattr(socket, "SO_BINDTODEVICE", 25)
749
self.socket.setsockopt(socket.SOL_SOCKET,
751
self.settings["interface"])
752
except socket.error, error:
753
if error[0] == errno.EPERM:
754
logger.error(u"No permission to"
755
u" bind to interface %s",
756
self.settings["interface"])
1757
if self.interface is not None:
1758
if SO_BINDTODEVICE is None:
1759
logger.error("SO_BINDTODEVICE does not exist;"
1760
" cannot bind to interface %s",
1764
self.socket.setsockopt(socket.SOL_SOCKET,
1768
except socket.error as error:
1769
if error[0] == errno.EPERM:
1770
logger.error("No permission to"
1771
" bind to interface %s",
1773
elif error[0] == errno.ENOPROTOOPT:
1774
logger.error("SO_BINDTODEVICE not available;"
1775
" cannot bind to interface %s",
759
1779
# Only bind(2) the socket if we really need to.
760
1780
if self.server_address[0] or self.server_address[1]:
761
1781
if not self.server_address[0]:
763
self.server_address = (in6addr_any,
1782
if self.address_family == socket.AF_INET6:
1783
any_address = "::" # in6addr_any
1785
any_address = socket.INADDR_ANY
1786
self.server_address = (any_address,
764
1787
self.server_address[1])
765
1788
elif not self.server_address[1]:
766
1789
self.server_address = (self.server_address[0],
768
# if self.settings["interface"]:
1791
# if self.interface:
769
1792
# self.server_address = (self.server_address[0],
772
1795
# if_nametoindex
775
return super(IPv6_TCPServer, self).server_bind()
1797
return socketserver.TCPServer.server_bind(self)
1800
class MandosServer(IPv6_TCPServer):
1804
clients: set of Client objects
1805
gnutls_priority GnuTLS priority string
1806
use_dbus: Boolean; to emit D-Bus signals or not
1808
Assumes a gobject.MainLoop event loop.
1810
def __init__(self, server_address, RequestHandlerClass,
1811
interface=None, use_ipv6=True, clients=None,
1812
gnutls_priority=None, use_dbus=True):
1813
self.enabled = False
1814
self.clients = clients
1815
if self.clients is None:
1817
self.use_dbus = use_dbus
1818
self.gnutls_priority = gnutls_priority
1819
IPv6_TCPServer.__init__(self, server_address,
1820
RequestHandlerClass,
1821
interface = interface,
1822
use_ipv6 = use_ipv6)
776
1823
def server_activate(self):
777
1824
if self.enabled:
778
return super(IPv6_TCPServer, self).server_activate()
1825
return socketserver.TCPServer.server_activate(self)
779
1827
def enable(self):
780
1828
self.enabled = True
1830
def add_pipe(self, parent_pipe, proc):
1831
# Call "handle_ipc" for both data and EOF events
1832
gobject.io_add_watch(parent_pipe.fileno(),
1833
gobject.IO_IN | gobject.IO_HUP,
1834
functools.partial(self.handle_ipc,
1839
def handle_ipc(self, source, condition, parent_pipe=None,
1840
proc = None, client_object=None):
1842
gobject.IO_IN: "IN", # There is data to read.
1843
gobject.IO_OUT: "OUT", # Data can be written (without
1845
gobject.IO_PRI: "PRI", # There is urgent data to read.
1846
gobject.IO_ERR: "ERR", # Error condition.
1847
gobject.IO_HUP: "HUP" # Hung up (the connection has been
1848
# broken, usually for pipes and
1851
conditions_string = ' | '.join(name
1853
condition_names.iteritems()
1854
if cond & condition)
1855
# error, or the other end of multiprocessing.Pipe has closed
1856
if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
1857
# Wait for other process to exit
1861
# Read a request from the child
1862
request = parent_pipe.recv()
1863
command = request[0]
1865
if command == 'init':
1867
address = request[2]
1869
for c in self.clients.itervalues():
1870
if c.fingerprint == fpr:
1874
logger.info("Client not found for fingerprint: %s, ad"
1875
"dress: %s", fpr, address)
1878
mandos_dbus_service.ClientNotFound(fpr,
1880
parent_pipe.send(False)
1883
gobject.io_add_watch(parent_pipe.fileno(),
1884
gobject.IO_IN | gobject.IO_HUP,
1885
functools.partial(self.handle_ipc,
1891
parent_pipe.send(True)
1892
# remove the old hook in favor of the new above hook on
1895
if command == 'funcall':
1896
funcname = request[1]
1900
parent_pipe.send(('data', getattr(client_object,
1904
if command == 'getattr':
1905
attrname = request[1]
1906
if callable(client_object.__getattribute__(attrname)):
1907
parent_pipe.send(('function',))
1909
parent_pipe.send(('data', client_object
1910
.__getattribute__(attrname)))
1912
if command == 'setattr':
1913
attrname = request[1]
1915
setattr(client_object, attrname, value)
783
1920
def string_to_delta(interval):
784
1921
"""Parse a string and return a datetime.timedelta
786
1923
>>> string_to_delta('7d')
787
1924
datetime.timedelta(7)
788
1925
>>> string_to_delta('60s')
1001
2136
except KeyError:
1003
2138
uid = pwd.getpwnam("nobody").pw_uid
1004
gid = pwd.getpwnam("nogroup").pw_gid
2139
gid = pwd.getpwnam("nobody").pw_gid
1005
2140
except KeyError:
1011
except OSError, error:
2146
except OSError as error:
1012
2147
if error[0] != errno.EPERM:
1016
service = AvahiService(name = server_settings["servicename"],
1017
servicetype = "_mandos._tcp", )
1018
if server_settings["interface"]:
1019
service.interface = (if_nametoindex
1020
(server_settings["interface"]))
2151
# Enable all possible GnuTLS debugging
2153
# "Use a log level over 10 to enable all debugging options."
2155
gnutls.library.functions.gnutls_global_set_log_level(11)
2157
@gnutls.library.types.gnutls_log_func
2158
def debug_gnutls(level, string):
2159
logger.debug("GnuTLS: %s", string[:-1])
2161
(gnutls.library.functions
2162
.gnutls_global_set_log_function(debug_gnutls))
2164
# Redirect stdin so all checkers get /dev/null
2165
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2166
os.dup2(null, sys.stdin.fileno())
2170
# Need to fork before connecting to D-Bus
2172
# Close all input and output, do double fork, etc.
2175
gobject.threads_init()
1022
2177
global main_loop
1025
2178
# From the Avahi example code
1026
2179
DBusGMainLoop(set_as_default=True )
1027
2180
main_loop = gobject.MainLoop()
1028
2181
bus = dbus.SystemBus()
1029
server = dbus.Interface(bus.get_object(avahi.DBUS_NAME,
1030
avahi.DBUS_PATH_SERVER),
1031
avahi.DBUS_INTERFACE_SERVER)
1032
2182
# End of Avahi example code
1034
bus_name = dbus.service.BusName(u"org.mandos-system.Mandos",
1037
clients.update(Set(Client(name = section,
1039
= dict(client_config.items(section)),
1040
use_dbus = use_dbus)
1041
for section in client_config.sections()))
1043
logger.warning(u"No clients defined")
1046
# Redirect stdin so all checkers get /dev/null
1047
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
1048
os.dup2(null, sys.stdin.fileno())
1052
# No console logging
1053
logger.removeHandler(console)
1054
# Close all input and output, do double fork, etc.
1059
pidfile.write(str(pid) + "\n")
1063
logger.error(u"Could not write to file %r with PID %d",
1066
# "pidfile" was never created
1071
"Cleanup function; run on exit"
1073
# From the Avahi example code
1074
if not group is None:
1077
# End of Avahi example code
2185
bus_name = dbus.service.BusName("se.recompile.Mandos",
2186
bus, do_not_queue=True)
2187
old_bus_name = (dbus.service.BusName
2188
("se.bsnet.fukt.Mandos", bus,
2190
except dbus.exceptions.NameExistsException as e:
2191
logger.error(unicode(e) + ", disabling D-Bus")
2193
server_settings["use_dbus"] = False
2194
tcp_server.use_dbus = False
2195
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2196
service = AvahiServiceToSyslog(name =
2197
server_settings["servicename"],
2198
servicetype = "_mandos._tcp",
2199
protocol = protocol, bus = bus)
2200
if server_settings["interface"]:
2201
service.interface = (if_nametoindex
2202
(str(server_settings["interface"])))
2204
global multiprocessing_manager
2205
multiprocessing_manager = multiprocessing.Manager()
2207
client_class = Client
2209
client_class = functools.partial(ClientDBusTransitional,
2212
client_settings = Client.config_parser(client_config)
2213
old_client_settings = {}
2216
# Get client data and settings from last running state.
2217
if server_settings["restore"]:
2219
with open(stored_state_path, "rb") as stored_state:
2220
clients_data, old_client_settings = (pickle.load
2222
os.remove(stored_state_path)
2223
except IOError as e:
2224
logger.warning("Could not load persistent state: {0}"
2226
if e.errno != errno.ENOENT:
2228
except EOFError as e:
2229
logger.warning("Could not load persistent state: "
2230
"EOFError: {0}".format(e))
2232
with PGPEngine() as pgp:
2233
for client_name, client in clients_data.iteritems():
2234
# Decide which value to use after restoring saved state.
2235
# We have three different values: Old config file,
2236
# new config file, and saved state.
2237
# New config value takes precedence if it differs from old
2238
# config value, otherwise use saved state.
2239
for name, value in client_settings[client_name].items():
2241
# For each value in new config, check if it
2242
# differs from the old config value (Except for
2243
# the "secret" attribute)
2244
if (name != "secret" and
2245
value != old_client_settings[client_name]
2247
client[name] = value
2251
# Clients who has passed its expire date can still be
2252
# enabled if its last checker was successful. Clients
2253
# whose checker failed before we stored its state is
2254
# assumed to have failed all checkers during downtime.
2255
if client["enabled"]:
2256
if datetime.datetime.utcnow() >= client["expires"]:
2257
if not client["last_checked_ok"]:
2259
"disabling client {0} - Client never "
2260
"performed a successfull checker"
2261
.format(client["name"]))
2262
client["enabled"] = False
2263
elif client["last_checker_status"] != 0:
2265
"disabling client {0} - Client "
2266
"last checker failed with error code {1}"
2267
.format(client["name"],
2268
client["last_checker_status"]))
2269
client["enabled"] = False
2271
client["expires"] = (datetime.datetime
2273
+ client["timeout"])
2274
logger.debug("Last checker succeeded,"
2275
" keeping {0} enabled"
2276
.format(client["name"]))
2278
client["secret"] = (
2279
pgp.decrypt(client["encrypted_secret"],
2280
client_settings[client_name]
2283
# If decryption fails, we use secret from new settings
2284
logger.debug("Failed to decrypt {0} old secret"
2285
.format(client_name))
2286
client["secret"] = (
2287
client_settings[client_name]["secret"])
2290
# Add/remove clients based on new changes made to config
2291
for client_name in (set(old_client_settings)
2292
- set(client_settings)):
2293
del clients_data[client_name]
2294
for client_name in (set(client_settings)
2295
- set(old_client_settings)):
2296
clients_data[client_name] = client_settings[client_name]
2298
# Create clients all clients
2299
for client_name, client in clients_data.iteritems():
2300
tcp_server.clients[client_name] = client_class(
2301
name = client_name, settings = client)
2303
if not tcp_server.clients:
2304
logger.warning("No clients defined")
1080
client = clients.pop()
1081
client.disable_hook = None
1084
atexit.register(cleanup)
2310
pidfile.write(str(pid) + "\n".encode("utf-8"))
2313
logger.error("Could not write to file %r with PID %d",
2316
# "pidfile" was never created
1087
2319
signal.signal(signal.SIGINT, signal.SIG_IGN)
1088
2321
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1089
2322
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
1092
class MandosServer(dbus.service.Object):
2325
class MandosDBusService(dbus.service.Object):
1093
2326
"""A D-Bus proxy object"""
1094
2327
def __init__(self):
1095
dbus.service.Object.__init__(self, bus,
1097
_interface = u"org.mandos_system.Mandos"
1099
@dbus.service.signal(_interface, signature="oa{sv}")
1100
def ClientAdded(self, objpath, properties):
2328
dbus.service.Object.__init__(self, bus, "/")
2329
_interface = "se.recompile.Mandos"
1104
2331
@dbus.service.signal(_interface, signature="o")
1105
def ClientRemoved(self, objpath):
2332
def ClientAdded(self, objpath):
2336
@dbus.service.signal(_interface, signature="ss")
2337
def ClientNotFound(self, fingerprint, address):
2341
@dbus.service.signal(_interface, signature="os")
2342
def ClientRemoved(self, objpath, name):
1109
2346
@dbus.service.method(_interface, out_signature="ao")
1110
2347
def GetAllClients(self):
1111
return dbus.Array(c.dbus_object_path for c in clients)
1113
@dbus.service.method(_interface, out_signature="a{oa{sv}}")
2349
return dbus.Array(c.dbus_object_path
2351
tcp_server.clients.itervalues())
2353
@dbus.service.method(_interface,
2354
out_signature="a{oa{sv}}")
1114
2355
def GetAllClientsWithProperties(self):
1115
2357
return dbus.Dictionary(
1116
((c.dbus_object_path, c.GetAllProperties())
2358
((c.dbus_object_path, c.GetAll(""))
2359
for c in tcp_server.clients.itervalues()),
1118
2360
signature="oa{sv}")
1120
2362
@dbus.service.method(_interface, in_signature="o")
1121
2363
def RemoveClient(self, object_path):
2365
for c in tcp_server.clients.itervalues():
1123
2366
if c.dbus_object_path == object_path:
2367
del tcp_server.clients[c.name]
2368
c.remove_from_connection()
1125
2369
# Don't signal anything except ClientRemoved
2370
c.disable(quiet=True)
1128
2371
# Emit D-Bus signal
1129
self.ClientRemoved(object_path)
2372
self.ClientRemoved(object_path, c.name)
1132
@dbus.service.method(_interface)
2374
raise KeyError(object_path)
1138
mandos_server = MandosServer()
1140
for client in clients:
2378
class MandosDBusServiceTransitional(MandosDBusService):
2379
__metaclass__ = AlternateDBusNamesMetaclass
2380
mandos_dbus_service = MandosDBusServiceTransitional()
2383
"Cleanup function; run on exit"
2386
multiprocessing.active_children()
2387
if not (tcp_server.clients or client_settings):
2390
# Store client before exiting. Secrets are encrypted with key
2391
# based on what config file has. If config file is
2392
# removed/edited, old secret will thus be unrecovable.
2394
with PGPEngine() as pgp:
2395
for client in tcp_server.clients.itervalues():
2396
key = client_settings[client.name]["secret"]
2397
client.encrypted_secret = pgp.encrypt(client.secret,
2401
# A list of attributes that can not be pickled
2403
exclude = set(("bus", "changedstate", "secret",
2405
for name, typ in (inspect.getmembers
2406
(dbus.service.Object)):
2409
client_dict["encrypted_secret"] = (client
2411
for attr in client.client_structure:
2412
if attr not in exclude:
2413
client_dict[attr] = getattr(client, attr)
2415
clients[client.name] = client_dict
2416
del client_settings[client.name]["secret"]
2419
tempfd, tempname = tempfile.mkstemp(suffix=".pickle",
2422
(stored_state_path))
2423
with os.fdopen(tempfd, "wb") as stored_state:
2424
pickle.dump((clients, client_settings), stored_state)
2425
os.rename(tempname, stored_state_path)
2426
except (IOError, OSError) as e:
2427
logger.warning("Could not save persistent state: {0}"
2434
if e.errno not in set((errno.ENOENT, errno.EACCES,
2438
# Delete all clients, and settings from config
2439
while tcp_server.clients:
2440
name, client = tcp_server.clients.popitem()
2442
client.remove_from_connection()
2443
# Don't signal anything except ClientRemoved
2444
client.disable(quiet=True)
2447
mandos_dbus_service.ClientRemoved(client
2450
client_settings.clear()
2452
atexit.register(cleanup)
2454
for client in tcp_server.clients.itervalues():
1142
2456
# Emit D-Bus signal
1143
mandos_server.ClientAdded(client.dbus_object_path,
1144
client.GetAllProperties())
2457
mandos_dbus_service.ClientAdded(client.dbus_object_path)
2458
# Need to initiate checking of clients
2460
client.init_checker()
1147
2462
tcp_server.enable()
1148
2463
tcp_server.server_activate()
1150
2465
# Find out what port we got
1151
2466
service.port = tcp_server.socket.getsockname()[1]
1152
logger.info(u"Now listening on address %r, port %d, flowinfo %d,"
1153
u" scope_id %d" % tcp_server.socket.getsockname())
2468
logger.info("Now listening on address %r, port %d,"
2469
" flowinfo %d, scope_id %d"
2470
% tcp_server.socket.getsockname())
2472
logger.info("Now listening on address %r, port %d"
2473
% tcp_server.socket.getsockname())
1155
2475
#service.interface = tcp_server.socket.getsockname()[3]
1158
2478
# From the Avahi example code
1159
server.connect_to_signal("StateChanged", server_state_changed)
1161
server_state_changed(server.GetState())
1162
except dbus.exceptions.DBusException, error:
1163
logger.critical(u"DBusException: %s", error)
2481
except dbus.exceptions.DBusException as error:
2482
logger.critical("DBusException: %s", error)
1165
2485
# End of Avahi example code