124
148
self.rename_count = 0
125
149
self.max_renames = max_renames
150
self.protocol = protocol
151
self.group = None # our entry group
154
self.entry_group_state_changed_match = None
126
155
def rename(self):
127
156
"""Derived from the Avahi example code"""
128
157
if self.rename_count >= self.max_renames:
129
logger.critical(u"No suitable Zeroconf service name found"
130
u" after %i retries, exiting.",
158
logger.critical("No suitable Zeroconf service name found"
159
" after %i retries, exiting.",
131
160
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 ...",
161
raise AvahiServiceError("Too many renames")
162
self.name = unicode(self.server.GetAlternativeServiceName(self.name))
163
logger.info("Changing Zeroconf service name to %r ...",
136
165
syslogger.setFormatter(logging.Formatter
137
('Mandos (%s): %%(levelname)s:'
138
' %%(message)s' % self.name))
166
('Mandos (%s) [%%(process)d]:'
167
' %%(levelname)s: %%(message)s'
172
except dbus.exceptions.DBusException as error:
173
logger.critical("DBusException: %s", error)
141
176
self.rename_count += 1
142
177
def remove(self):
143
178
"""Derived from the Avahi example code"""
144
if group is not None:
179
if self.group is not None:
182
except (dbus.exceptions.UnknownMethodException,
183
dbus.exceptions.DBusException) as e:
186
if self.entry_group_state_changed_match is not None:
187
self.entry_group_state_changed_match.remove()
188
self.entry_group_state_changed_match = None
147
190
"""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):
192
self.group = dbus.Interface(
193
self.bus.get_object(avahi.DBUS_NAME,
194
self.server.EntryGroupNew(),
195
follow_name_owner_changes=True),
196
avahi.DBUS_INTERFACE_ENTRY_GROUP)
197
self.entry_group_state_changed_match = (
198
self.group.connect_to_signal(
199
'StateChanged', self .entry_group_state_changed))
200
logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
201
self.name, self.type)
202
self.group.AddService(
205
dbus.UInt32(0), # flags
206
self.name, self.type,
207
self.domain, self.host,
208
dbus.UInt16(self.port),
209
avahi.string_array_to_txt_array(self.TXT))
211
def entry_group_state_changed(self, state, error):
212
"""Derived from the Avahi example code"""
213
logger.debug("Avahi entry group state change: %i", state)
215
if state == avahi.ENTRY_GROUP_ESTABLISHED:
216
logger.debug("Zeroconf service established.")
217
elif state == avahi.ENTRY_GROUP_COLLISION:
218
logger.info("Zeroconf service name collision.")
220
elif state == avahi.ENTRY_GROUP_FAILURE:
221
logger.critical("Avahi: Error in group state changed %s",
223
raise AvahiGroupError("State changed: %s"
226
"""Derived from the Avahi example code"""
228
def server_state_changed(self, state, error=None):
229
"""Derived from the Avahi example code"""
230
logger.debug("Avahi server state change: %i", state)
231
bad_states = { avahi.SERVER_INVALID:
232
"Zeroconf server invalid",
233
avahi.SERVER_REGISTERING: None,
234
avahi.SERVER_COLLISION:
235
"Zeroconf server name collision",
236
avahi.SERVER_FAILURE:
237
"Zeroconf server failure" }
238
if state in bad_states:
239
if bad_states[state]:
240
logger.error(bad_states[state])
242
elif state == avahi.SERVER_RUNNING:
245
logger.debug("Unknown state: %r", state)
247
"""Derived from the Avahi example code"""
248
if self.server is None:
249
self.server = dbus.Interface(
250
self.bus.get_object(avahi.DBUS_NAME,
251
avahi.DBUS_PATH_SERVER,
252
follow_name_owner_changes=True),
253
avahi.DBUS_INTERFACE_SERVER)
254
self.server.connect_to_signal("StateChanged",
255
self.server_state_changed)
256
self.server_state_changed(self.server.GetState())
259
class Client(object):
179
260
"""A representation of a client host served by this server.
181
name: string; from the config file, used in log messages and
263
_approved: bool(); 'None' if not yet approved/disapproved
264
approval_delay: datetime.timedelta(); Time to wait for approval
265
approval_duration: datetime.timedelta(); Duration of one approval
266
checker: subprocess.Popen(); a running checker process used
267
to see if the client lives.
268
'None' if no process is running.
269
checker_callback_tag: a gobject event source tag, or None
270
checker_command: string; External command which is run to check
271
if client lives. %() expansions are done at
272
runtime with vars(self) as dict, so that for
273
instance %(name)s can be used in the command.
274
checker_initiator_tag: a gobject event source tag, or None
275
created: datetime.datetime(); (UTC) object creation
276
current_checker_command: string; current running checker_command
277
disable_hook: If set, called by disable() as disable_hook(self)
278
disable_initiator_tag: a gobject event source tag, or None
183
280
fingerprint: string (40 or 32 hexadecimal digits); used to
184
281
uniquely identify the client
185
secret: bytestring; sent verbatim (over TLS) to client
186
282
host: string; available for use by the checker command
187
created: datetime.datetime(); (UTC) object creation
283
interval: datetime.timedelta(); How often to start a new checker
284
last_approval_request: datetime.datetime(); (UTC) or None
285
last_checked_ok: datetime.datetime(); (UTC) or None
188
286
last_enabled: datetime.datetime(); (UTC)
190
last_checked_ok: datetime.datetime(); (UTC) or None
287
name: string; from the config file, used in log messages and
289
secret: bytestring; sent verbatim (over TLS) to client
191
290
timeout: datetime.timedelta(); How long from last_checked_ok
192
until this client is invalid
193
interval: datetime.timedelta(); How often to start a new checker
194
disable_hook: If set, called by disable() as disable_hook(self)
195
checker: subprocess.Popen(); a running checker process used
196
to see if the client lives.
197
'None' if no process is running.
198
checker_initiator_tag: a gobject event source tag, or None
199
disable_initiator_tag: - '' -
200
checker_callback_tag: - '' -
201
checker_command: string; External command which is run to check if
202
client lives. %() expansions are done at
203
runtime with vars(self) as dict, so that for
204
instance %(name)s can be used in the command.
205
use_dbus: bool(); Whether to provide D-Bus interface and signals
206
dbus_object_path: dbus.ObjectPath ; only set if self.use_dbus
291
until this client is disabled
292
runtime_expansions: Allowed attributes for runtime expansion.
295
runtime_expansions = ("approval_delay", "approval_duration",
296
"created", "enabled", "fingerprint",
297
"host", "interval", "last_checked_ok",
298
"last_enabled", "name", "timeout")
301
def _timedelta_to_milliseconds(td):
302
"Convert a datetime.timedelta() to milliseconds"
303
return ((td.days * 24 * 60 * 60 * 1000)
304
+ (td.seconds * 1000)
305
+ (td.microseconds // 1000))
208
307
def timeout_milliseconds(self):
209
308
"Return the 'timeout' attribute in milliseconds"
210
return ((self.timeout.days * 24 * 60 * 60 * 1000)
211
+ (self.timeout.seconds * 1000)
212
+ (self.timeout.microseconds // 1000))
309
return self._timedelta_to_milliseconds(self.timeout)
214
311
def interval_milliseconds(self):
215
312
"Return the 'interval' attribute in milliseconds"
216
return ((self.interval.days * 24 * 60 * 60 * 1000)
217
+ (self.interval.seconds * 1000)
218
+ (self.interval.microseconds // 1000))
313
return self._timedelta_to_milliseconds(self.interval)
315
def approval_delay_milliseconds(self):
316
return self._timedelta_to_milliseconds(self.approval_delay)
220
def __init__(self, name = None, disable_hook=None, config=None,
318
def __init__(self, name = None, disable_hook=None, config=None):
222
319
"""Note: the 'checker' key in 'config' sets the
223
320
'checker_command' attribute and *not* the 'checker'
226
323
if config is None:
228
logger.debug(u"Creating client %r", self.name)
229
self.use_dbus = False # During __init__
325
logger.debug("Creating client %r", self.name)
230
326
# Uppercase and remove spaces from fingerprint for later
231
327
# comparison purposes with return value from the fingerprint()
233
329
self.fingerprint = (config["fingerprint"].upper()
235
logger.debug(u" Fingerprint: %s", self.fingerprint)
331
logger.debug(" Fingerprint: %s", self.fingerprint)
236
332
if "secret" in config:
237
self.secret = config["secret"].decode(u"base64")
333
self.secret = config["secret"].decode("base64")
238
334
elif "secfile" in config:
239
with closing(open(os.path.expanduser
241
(config["secfile"])))) as secfile:
335
with open(os.path.expanduser(os.path.expandvars
336
(config["secfile"])),
242
338
self.secret = secfile.read()
244
raise TypeError(u"No secret or secfile for client %s"
340
raise TypeError("No secret or secfile for client %s"
246
342
self.host = config.get("host", "")
247
343
self.created = datetime.datetime.utcnow()
248
344
self.enabled = False
345
self.last_approval_request = None
249
346
self.last_enabled = None
250
347
self.last_checked_ok = None
251
348
self.timeout = string_to_delta(config["timeout"])
424
529
self.checker_callback_tag = None
425
530
if getattr(self, "checker", None) is None:
427
logger.debug(u"Stopping checker for %(name)s", vars(self))
532
logger.debug("Stopping checker for %(name)s", vars(self))
429
534
os.kill(self.checker.pid, signal.SIGTERM)
431
536
#if self.checker.poll() is None:
432
537
# os.kill(self.checker.pid, signal.SIGKILL)
433
except OSError, error:
538
except OSError as error:
434
539
if error.errno != errno.ESRCH: # No such process
436
541
self.checker = None
438
self.PropertyChanged(dbus.String(u"checker_running"),
439
dbus.Boolean(False, variant_level=1))
441
def still_valid(self):
442
"""Has the timeout not yet passed for this client?"""
443
if not getattr(self, "enabled", False):
445
now = datetime.datetime.utcnow()
446
if self.last_checked_ok is None:
447
return now < (self.created + self.timeout)
449
return now < (self.last_checked_ok + self.timeout)
451
## D-Bus methods & signals
452
_interface = u"se.bsnet.fukt.Mandos.Client"
455
CheckedOK = dbus.service.method(_interface)(checked_ok)
456
CheckedOK.__name__ = "CheckedOK"
543
def dbus_service_property(dbus_interface, signature="v",
544
access="readwrite", byte_arrays=False):
545
"""Decorators for marking methods of a DBusObjectWithProperties to
546
become properties on the D-Bus.
548
The decorated method will be called with no arguments by "Get"
549
and with one argument by "Set".
551
The parameters, where they are supported, are the same as
552
dbus.service.method, except there is only "signature", since the
553
type from Get() and the type sent to Set() is the same.
555
# Encoding deeply encoded byte arrays is not supported yet by the
556
# "Set" method, so we fail early here:
557
if byte_arrays and signature != "ay":
558
raise ValueError("Byte arrays not supported for non-'ay'"
559
" signature %r" % signature)
561
func._dbus_is_property = True
562
func._dbus_interface = dbus_interface
563
func._dbus_signature = signature
564
func._dbus_access = access
565
func._dbus_name = func.__name__
566
if func._dbus_name.endswith("_dbus_property"):
567
func._dbus_name = func._dbus_name[:-14]
568
func._dbus_get_args_options = {'byte_arrays': byte_arrays }
573
class DBusPropertyException(dbus.exceptions.DBusException):
574
"""A base class for D-Bus property-related exceptions
576
def __unicode__(self):
577
return unicode(str(self))
580
class DBusPropertyAccessException(DBusPropertyException):
581
"""A property's access permissions disallows an operation.
586
class DBusPropertyNotFound(DBusPropertyException):
587
"""An attempt was made to access a non-existing property.
592
class DBusObjectWithProperties(dbus.service.Object):
593
"""A D-Bus object with properties.
595
Classes inheriting from this can use the dbus_service_property
596
decorator to expose methods as D-Bus properties. It exposes the
597
standard Get(), Set(), and GetAll() methods on the D-Bus.
601
def _is_dbus_property(obj):
602
return getattr(obj, "_dbus_is_property", False)
604
def _get_all_dbus_properties(self):
605
"""Returns a generator of (name, attribute) pairs
607
return ((prop._dbus_name, prop)
609
inspect.getmembers(self, self._is_dbus_property))
611
def _get_dbus_property(self, interface_name, property_name):
612
"""Returns a bound method if one exists which is a D-Bus
613
property with the specified name and interface.
615
for name in (property_name,
616
property_name + "_dbus_property"):
617
prop = getattr(self, name, None)
619
or not self._is_dbus_property(prop)
620
or prop._dbus_name != property_name
621
or (interface_name and prop._dbus_interface
622
and interface_name != prop._dbus_interface)):
626
raise DBusPropertyNotFound(self.dbus_object_path + ":"
627
+ interface_name + "."
630
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
632
def Get(self, interface_name, property_name):
633
"""Standard D-Bus property Get() method, see D-Bus standard.
635
prop = self._get_dbus_property(interface_name, property_name)
636
if prop._dbus_access == "write":
637
raise DBusPropertyAccessException(property_name)
639
if not hasattr(value, "variant_level"):
641
return type(value)(value, variant_level=value.variant_level+1)
643
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
644
def Set(self, interface_name, property_name, value):
645
"""Standard D-Bus property Set() method, see D-Bus standard.
647
prop = self._get_dbus_property(interface_name, property_name)
648
if prop._dbus_access == "read":
649
raise DBusPropertyAccessException(property_name)
650
if prop._dbus_get_args_options["byte_arrays"]:
651
# The byte_arrays option is not supported yet on
652
# signatures other than "ay".
653
if prop._dbus_signature != "ay":
655
value = dbus.ByteArray(''.join(unichr(byte)
659
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
660
out_signature="a{sv}")
661
def GetAll(self, interface_name):
662
"""Standard D-Bus property GetAll() method, see D-Bus
665
Note: Will not include properties with access="write".
668
for name, prop in self._get_all_dbus_properties():
670
and interface_name != prop._dbus_interface):
671
# Interface non-empty but did not match
673
# Ignore write-only properties
674
if prop._dbus_access == "write":
677
if not hasattr(value, "variant_level"):
680
all[name] = type(value)(value, variant_level=
681
value.variant_level+1)
682
return dbus.Dictionary(all, signature="sv")
684
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
686
path_keyword='object_path',
687
connection_keyword='connection')
688
def Introspect(self, object_path, connection):
689
"""Standard D-Bus method, overloaded to insert property tags.
691
xmlstring = dbus.service.Object.Introspect(self, object_path,
694
document = xml.dom.minidom.parseString(xmlstring)
695
def make_tag(document, name, prop):
696
e = document.createElement("property")
697
e.setAttribute("name", name)
698
e.setAttribute("type", prop._dbus_signature)
699
e.setAttribute("access", prop._dbus_access)
701
for if_tag in document.getElementsByTagName("interface"):
702
for tag in (make_tag(document, name, prop)
704
in self._get_all_dbus_properties()
705
if prop._dbus_interface
706
== if_tag.getAttribute("name")):
707
if_tag.appendChild(tag)
708
# Add the names to the return values for the
709
# "org.freedesktop.DBus.Properties" methods
710
if (if_tag.getAttribute("name")
711
== "org.freedesktop.DBus.Properties"):
712
for cn in if_tag.getElementsByTagName("method"):
713
if cn.getAttribute("name") == "Get":
714
for arg in cn.getElementsByTagName("arg"):
715
if (arg.getAttribute("direction")
717
arg.setAttribute("name", "value")
718
elif cn.getAttribute("name") == "GetAll":
719
for arg in cn.getElementsByTagName("arg"):
720
if (arg.getAttribute("direction")
722
arg.setAttribute("name", "props")
723
xmlstring = document.toxml("utf-8")
725
except (AttributeError, xml.dom.DOMException,
726
xml.parsers.expat.ExpatError) as error:
727
logger.error("Failed to override Introspection method",
732
class ClientDBus(Client, DBusObjectWithProperties):
733
"""A Client class using D-Bus
736
dbus_object_path: dbus.ObjectPath
737
bus: dbus.SystemBus()
740
runtime_expansions = (Client.runtime_expansions
741
+ ("dbus_object_path",))
743
# dbus.service.Object doesn't use super(), so we can't either.
745
def __init__(self, bus = None, *args, **kwargs):
746
self._approvals_pending = 0
748
Client.__init__(self, *args, **kwargs)
749
# Only now, when this client is initialized, can it show up on
751
client_object_name = unicode(self.name).translate(
754
self.dbus_object_path = (dbus.ObjectPath
755
("/clients/" + client_object_name))
756
DBusObjectWithProperties.__init__(self, self.bus,
757
self.dbus_object_path)
759
def _get_approvals_pending(self):
760
return self._approvals_pending
761
def _set_approvals_pending(self, value):
762
old_value = self._approvals_pending
763
self._approvals_pending = value
765
if (hasattr(self, "dbus_object_path")
766
and bval is not bool(old_value)):
767
dbus_bool = dbus.Boolean(bval, variant_level=1)
768
self.PropertyChanged(dbus.String("ApprovalPending"),
771
approvals_pending = property(_get_approvals_pending,
772
_set_approvals_pending)
773
del _get_approvals_pending, _set_approvals_pending
776
def _datetime_to_dbus(dt, variant_level=0):
777
"""Convert a UTC datetime.datetime() to a D-Bus type."""
778
return dbus.String(dt.isoformat(),
779
variant_level=variant_level)
782
oldstate = getattr(self, "enabled", False)
783
r = Client.enable(self)
784
if oldstate != self.enabled:
786
self.PropertyChanged(dbus.String("Enabled"),
787
dbus.Boolean(True, variant_level=1))
788
self.PropertyChanged(
789
dbus.String("LastEnabled"),
790
self._datetime_to_dbus(self.last_enabled,
794
def disable(self, quiet = False):
795
oldstate = getattr(self, "enabled", False)
796
r = Client.disable(self, quiet=quiet)
797
if not quiet and oldstate != self.enabled:
799
self.PropertyChanged(dbus.String("Enabled"),
800
dbus.Boolean(False, variant_level=1))
803
def __del__(self, *args, **kwargs):
805
self.remove_from_connection()
808
if hasattr(DBusObjectWithProperties, "__del__"):
809
DBusObjectWithProperties.__del__(self, *args, **kwargs)
810
Client.__del__(self, *args, **kwargs)
812
def checker_callback(self, pid, condition, command,
814
self.checker_callback_tag = None
817
self.PropertyChanged(dbus.String("CheckerRunning"),
818
dbus.Boolean(False, variant_level=1))
819
if os.WIFEXITED(condition):
820
exitstatus = os.WEXITSTATUS(condition)
822
self.CheckerCompleted(dbus.Int16(exitstatus),
823
dbus.Int64(condition),
824
dbus.String(command))
827
self.CheckerCompleted(dbus.Int16(-1),
828
dbus.Int64(condition),
829
dbus.String(command))
831
return Client.checker_callback(self, pid, condition, command,
834
def checked_ok(self, *args, **kwargs):
835
Client.checked_ok(self, *args, **kwargs)
837
self.PropertyChanged(
838
dbus.String("LastCheckedOK"),
839
(self._datetime_to_dbus(self.last_checked_ok,
842
def need_approval(self, *args, **kwargs):
843
r = Client.need_approval(self, *args, **kwargs)
845
self.PropertyChanged(
846
dbus.String("LastApprovalRequest"),
847
(self._datetime_to_dbus(self.last_approval_request,
851
def start_checker(self, *args, **kwargs):
852
old_checker = self.checker
853
if self.checker is not None:
854
old_checker_pid = self.checker.pid
856
old_checker_pid = None
857
r = Client.start_checker(self, *args, **kwargs)
858
# Only if new checker process was started
859
if (self.checker is not None
860
and old_checker_pid != self.checker.pid):
862
self.CheckerStarted(self.current_checker_command)
863
self.PropertyChanged(
864
dbus.String("CheckerRunning"),
865
dbus.Boolean(True, variant_level=1))
868
def stop_checker(self, *args, **kwargs):
869
old_checker = getattr(self, "checker", None)
870
r = Client.stop_checker(self, *args, **kwargs)
871
if (old_checker is not None
872
and getattr(self, "checker", None) is None):
873
self.PropertyChanged(dbus.String("CheckerRunning"),
874
dbus.Boolean(False, variant_level=1))
877
def _reset_approved(self):
878
self._approved = None
881
def approve(self, value=True):
882
self.send_changedstate()
883
self._approved = value
884
gobject.timeout_add(self._timedelta_to_milliseconds
885
(self.approval_duration),
886
self._reset_approved)
889
## D-Bus methods, signals & properties
890
_interface = "se.bsnet.fukt.Mandos.Client"
458
894
# CheckerCompleted - signal
459
895
@dbus.service.signal(_interface, signature="nxs")
583
963
# StopChecker - method
584
StopChecker = dbus.service.method(_interface)(stop_checker)
585
StopChecker.__name__ = "StopChecker"
964
@dbus.service.method(_interface)
965
def StopChecker(self):
970
# ApprovalPending - property
971
@dbus_service_property(_interface, signature="b", access="read")
972
def ApprovalPending_dbus_property(self):
973
return dbus.Boolean(bool(self.approvals_pending))
975
# ApprovedByDefault - property
976
@dbus_service_property(_interface, signature="b",
978
def ApprovedByDefault_dbus_property(self, value=None):
979
if value is None: # get
980
return dbus.Boolean(self.approved_by_default)
981
self.approved_by_default = bool(value)
983
self.PropertyChanged(dbus.String("ApprovedByDefault"),
984
dbus.Boolean(value, variant_level=1))
986
# ApprovalDelay - property
987
@dbus_service_property(_interface, signature="t",
989
def ApprovalDelay_dbus_property(self, value=None):
990
if value is None: # get
991
return dbus.UInt64(self.approval_delay_milliseconds())
992
self.approval_delay = datetime.timedelta(0, 0, 0, value)
994
self.PropertyChanged(dbus.String("ApprovalDelay"),
995
dbus.UInt64(value, variant_level=1))
997
# ApprovalDuration - property
998
@dbus_service_property(_interface, signature="t",
1000
def ApprovalDuration_dbus_property(self, value=None):
1001
if value is None: # get
1002
return dbus.UInt64(self._timedelta_to_milliseconds(
1003
self.approval_duration))
1004
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1006
self.PropertyChanged(dbus.String("ApprovalDuration"),
1007
dbus.UInt64(value, variant_level=1))
1010
@dbus_service_property(_interface, signature="s", access="read")
1011
def Name_dbus_property(self):
1012
return dbus.String(self.name)
1014
# Fingerprint - property
1015
@dbus_service_property(_interface, signature="s", access="read")
1016
def Fingerprint_dbus_property(self):
1017
return dbus.String(self.fingerprint)
1020
@dbus_service_property(_interface, signature="s",
1022
def Host_dbus_property(self, value=None):
1023
if value is None: # get
1024
return dbus.String(self.host)
1027
self.PropertyChanged(dbus.String("Host"),
1028
dbus.String(value, variant_level=1))
1030
# Created - property
1031
@dbus_service_property(_interface, signature="s", access="read")
1032
def Created_dbus_property(self):
1033
return dbus.String(self._datetime_to_dbus(self.created))
1035
# LastEnabled - property
1036
@dbus_service_property(_interface, signature="s", access="read")
1037
def LastEnabled_dbus_property(self):
1038
if self.last_enabled is None:
1039
return dbus.String("")
1040
return dbus.String(self._datetime_to_dbus(self.last_enabled))
1042
# Enabled - property
1043
@dbus_service_property(_interface, signature="b",
1045
def Enabled_dbus_property(self, value=None):
1046
if value is None: # get
1047
return dbus.Boolean(self.enabled)
1053
# LastCheckedOK - property
1054
@dbus_service_property(_interface, signature="s",
1056
def LastCheckedOK_dbus_property(self, value=None):
1057
if value is not None:
1060
if self.last_checked_ok is None:
1061
return dbus.String("")
1062
return dbus.String(self._datetime_to_dbus(self
1065
# LastApprovalRequest - property
1066
@dbus_service_property(_interface, signature="s", access="read")
1067
def LastApprovalRequest_dbus_property(self):
1068
if self.last_approval_request is None:
1069
return dbus.String("")
1070
return dbus.String(self.
1071
_datetime_to_dbus(self
1072
.last_approval_request))
1074
# Timeout - property
1075
@dbus_service_property(_interface, signature="t",
1077
def Timeout_dbus_property(self, value=None):
1078
if value is None: # get
1079
return dbus.UInt64(self.timeout_milliseconds())
1080
self.timeout = datetime.timedelta(0, 0, 0, value)
1082
self.PropertyChanged(dbus.String("Timeout"),
1083
dbus.UInt64(value, variant_level=1))
1084
if getattr(self, "disable_initiator_tag", None) is None:
1086
# Reschedule timeout
1087
gobject.source_remove(self.disable_initiator_tag)
1088
self.disable_initiator_tag = None
1089
time_to_die = (self.
1090
_timedelta_to_milliseconds((self
1095
if time_to_die <= 0:
1096
# The timeout has passed
1099
self.disable_initiator_tag = (gobject.timeout_add
1100
(time_to_die, self.disable))
1102
# Interval - property
1103
@dbus_service_property(_interface, signature="t",
1105
def Interval_dbus_property(self, value=None):
1106
if value is None: # get
1107
return dbus.UInt64(self.interval_milliseconds())
1108
self.interval = datetime.timedelta(0, 0, 0, value)
1110
self.PropertyChanged(dbus.String("Interval"),
1111
dbus.UInt64(value, variant_level=1))
1112
if getattr(self, "checker_initiator_tag", None) is None:
1114
# Reschedule checker run
1115
gobject.source_remove(self.checker_initiator_tag)
1116
self.checker_initiator_tag = (gobject.timeout_add
1117
(value, self.start_checker))
1118
self.start_checker() # Start one now, too
1120
# Checker - property
1121
@dbus_service_property(_interface, signature="s",
1123
def Checker_dbus_property(self, value=None):
1124
if value is None: # get
1125
return dbus.String(self.checker_command)
1126
self.checker_command = value
1128
self.PropertyChanged(dbus.String("Checker"),
1129
dbus.String(self.checker_command,
1132
# CheckerRunning - property
1133
@dbus_service_property(_interface, signature="b",
1135
def CheckerRunning_dbus_property(self, value=None):
1136
if value is None: # get
1137
return dbus.Boolean(self.checker is not None)
1139
self.start_checker()
1143
# ObjectPath - property
1144
@dbus_service_property(_interface, signature="o", access="read")
1145
def ObjectPath_dbus_property(self):
1146
return self.dbus_object_path # is already a dbus.ObjectPath
1149
@dbus_service_property(_interface, signature="ay",
1150
access="write", byte_arrays=True)
1151
def Secret_dbus_property(self, value):
1152
self.secret = str(value)
590
def peer_certificate(session):
591
"Return the peer's OpenPGP certificate as a bytestring"
592
# If not an OpenPGP certificate...
593
if (gnutls.library.functions
594
.gnutls_certificate_type_get(session._c_object)
595
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
596
# ...do the normal thing
597
return session.peer_certificate
598
list_size = ctypes.c_uint(1)
599
cert_list = (gnutls.library.functions
600
.gnutls_certificate_get_peers
601
(session._c_object, ctypes.byref(list_size)))
602
if not bool(cert_list) and list_size.value != 0:
603
raise gnutls.errors.GNUTLSError("error getting peer"
605
if list_size.value == 0:
608
return ctypes.string_at(cert.data, cert.size)
611
def fingerprint(openpgp):
612
"Convert an OpenPGP bytestring to a hexdigit fingerprint string"
613
# New GnuTLS "datum" with the OpenPGP public key
614
datum = (gnutls.library.types
615
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
618
ctypes.c_uint(len(openpgp))))
619
# New empty GnuTLS certificate
620
crt = gnutls.library.types.gnutls_openpgp_crt_t()
621
(gnutls.library.functions
622
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
623
# Import the OpenPGP public key into the certificate
624
(gnutls.library.functions
625
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
626
gnutls.library.constants
627
.GNUTLS_OPENPGP_FMT_RAW))
628
# Verify the self signature in the key
629
crtverify = ctypes.c_uint()
630
(gnutls.library.functions
631
.gnutls_openpgp_crt_verify_self(crt, 0, ctypes.byref(crtverify)))
632
if crtverify.value != 0:
633
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
634
raise gnutls.errors.CertificateSecurityError("Verify failed")
635
# New buffer for the fingerprint
636
buf = ctypes.create_string_buffer(20)
637
buf_len = ctypes.c_size_t()
638
# Get the fingerprint from the certificate into the buffer
639
(gnutls.library.functions
640
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
641
ctypes.byref(buf_len)))
642
# Deinit the certificate
643
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
644
# Convert the buffer to a Python bytestring
645
fpr = ctypes.string_at(buf, buf_len.value)
646
# Convert the bytestring to hexadecimal notation
647
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
651
class TCP_handler(SocketServer.BaseRequestHandler, object):
652
"""A TCP request handler class.
653
Instantiated by IPv6_TCPServer for each request to handle it.
1157
class ProxyClient(object):
1158
def __init__(self, child_pipe, fpr, address):
1159
self._pipe = child_pipe
1160
self._pipe.send(('init', fpr, address))
1161
if not self._pipe.recv():
1164
def __getattribute__(self, name):
1165
if(name == '_pipe'):
1166
return super(ProxyClient, self).__getattribute__(name)
1167
self._pipe.send(('getattr', name))
1168
data = self._pipe.recv()
1169
if data[0] == 'data':
1171
if data[0] == 'function':
1172
def func(*args, **kwargs):
1173
self._pipe.send(('funcall', name, args, kwargs))
1174
return self._pipe.recv()[1]
1177
def __setattr__(self, name, value):
1178
if(name == '_pipe'):
1179
return super(ProxyClient, self).__setattr__(name, value)
1180
self._pipe.send(('setattr', name, value))
1183
class ClientHandler(socketserver.BaseRequestHandler, object):
1184
"""A class to handle client connections.
1186
Instantiated once for each connection to handle it.
654
1187
Note: This will run in its own forked process."""
656
1189
def handle(self):
657
logger.info(u"TCP connection from: %s",
658
unicode(self.client_address))
659
session = (gnutls.connection
660
.ClientSession(self.request,
664
line = self.request.makefile().readline()
665
logger.debug(u"Protocol version: %r", line)
667
if int(line.strip().split()[0]) > 1:
669
except (ValueError, IndexError, RuntimeError), error:
670
logger.error(u"Unknown protocol version: %s", error)
673
# Note: gnutls.connection.X509Credentials is really a generic
674
# GnuTLS certificate credentials object so long as no X.509
675
# keys are added to it. Therefore, we can use it here despite
676
# using OpenPGP certificates.
678
#priority = ':'.join(("NONE", "+VERS-TLS1.1", "+AES-256-CBC",
679
# "+SHA1", "+COMP-NULL", "+CTYPE-OPENPGP",
681
# Use a fallback default, since this MUST be set.
682
priority = self.server.settings.get("priority", "NORMAL")
683
(gnutls.library.functions
684
.gnutls_priority_set_direct(session._c_object,
689
except gnutls.errors.GNUTLSError, error:
690
logger.warning(u"Handshake failed: %s", error)
691
# Do not run session.bye() here: the session is not
692
# established. Just abandon the request.
694
logger.debug(u"Handshake succeeded")
696
fpr = fingerprint(peer_certificate(session))
697
except (TypeError, gnutls.errors.GNUTLSError), error:
698
logger.warning(u"Bad certificate: %s", error)
701
logger.debug(u"Fingerprint: %s", fpr)
702
for c in self.server.clients:
703
if c.fingerprint == fpr:
707
logger.warning(u"Client not found for fingerprint: %s",
711
# Have to check if client.still_valid(), since it is possible
712
# that the client timed out while establishing the GnuTLS
714
if not client.still_valid():
715
logger.warning(u"Client %(name)s is invalid",
719
## This won't work here, since we're in a fork.
720
# client.checked_ok()
722
while sent_size < len(client.secret):
723
sent = session.send(client.secret[sent_size:])
724
logger.debug(u"Sent: %d, remaining: %d",
725
sent, len(client.secret)
726
- (sent_size + sent))
731
class IPv6_TCPServer(SocketServer.ForkingMixIn,
732
SocketServer.TCPServer, object):
733
"""IPv6 TCP server. Accepts 'None' as address and/or port.
1190
with contextlib.closing(self.server.child_pipe) as child_pipe:
1191
logger.info("TCP connection from: %s",
1192
unicode(self.client_address))
1193
logger.debug("Pipe FD: %d",
1194
self.server.child_pipe.fileno())
1196
session = (gnutls.connection
1197
.ClientSession(self.request,
1199
.X509Credentials()))
1201
# Note: gnutls.connection.X509Credentials is really a
1202
# generic GnuTLS certificate credentials object so long as
1203
# no X.509 keys are added to it. Therefore, we can use it
1204
# here despite using OpenPGP certificates.
1206
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1207
# "+AES-256-CBC", "+SHA1",
1208
# "+COMP-NULL", "+CTYPE-OPENPGP",
1210
# Use a fallback default, since this MUST be set.
1211
priority = self.server.gnutls_priority
1212
if priority is None:
1214
(gnutls.library.functions
1215
.gnutls_priority_set_direct(session._c_object,
1218
# Start communication using the Mandos protocol
1219
# Get protocol number
1220
line = self.request.makefile().readline()
1221
logger.debug("Protocol version: %r", line)
1223
if int(line.strip().split()[0]) > 1:
1225
except (ValueError, IndexError, RuntimeError) as error:
1226
logger.error("Unknown protocol version: %s", error)
1229
# Start GnuTLS connection
1232
except gnutls.errors.GNUTLSError as error:
1233
logger.warning("Handshake failed: %s", error)
1234
# Do not run session.bye() here: the session is not
1235
# established. Just abandon the request.
1237
logger.debug("Handshake succeeded")
1239
approval_required = False
1242
fpr = self.fingerprint(self.peer_certificate
1245
gnutls.errors.GNUTLSError) as error:
1246
logger.warning("Bad certificate: %s", error)
1248
logger.debug("Fingerprint: %s", fpr)
1251
client = ProxyClient(child_pipe, fpr,
1252
self.client_address)
1256
if client.approval_delay:
1257
delay = client.approval_delay
1258
client.approvals_pending += 1
1259
approval_required = True
1262
if not client.enabled:
1263
logger.warning("Client %s is disabled",
1265
if self.server.use_dbus:
1267
client.Rejected("Disabled")
1270
if client._approved or not client.approval_delay:
1271
#We are approved or approval is disabled
1273
elif client._approved is None:
1274
logger.info("Client %s needs approval",
1276
if self.server.use_dbus:
1278
client.NeedApproval(
1279
client.approval_delay_milliseconds(),
1280
client.approved_by_default)
1282
logger.warning("Client %s was not approved",
1284
if self.server.use_dbus:
1286
client.Rejected("Denied")
1289
#wait until timeout or approved
1290
#x = float(client._timedelta_to_milliseconds(delay))
1291
time = datetime.datetime.now()
1292
client.changedstate.acquire()
1293
client.changedstate.wait(float(client._timedelta_to_milliseconds(delay) / 1000))
1294
client.changedstate.release()
1295
time2 = datetime.datetime.now()
1296
if (time2 - time) >= delay:
1297
if not client.approved_by_default:
1298
logger.warning("Client %s timed out while"
1299
" waiting for approval",
1301
if self.server.use_dbus:
1303
client.Rejected("Approval timed out")
1308
delay -= time2 - time
1311
while sent_size < len(client.secret):
1313
sent = session.send(client.secret[sent_size:])
1314
except gnutls.errors.GNUTLSError as error:
1315
logger.warning("gnutls send failed")
1317
logger.debug("Sent: %d, remaining: %d",
1318
sent, len(client.secret)
1319
- (sent_size + sent))
1322
logger.info("Sending secret to %s", client.name)
1323
# bump the timeout as if seen
1325
if self.server.use_dbus:
1330
if approval_required:
1331
client.approvals_pending -= 1
1334
except gnutls.errors.GNUTLSError as error:
1335
logger.warning("GnuTLS bye failed")
1338
def peer_certificate(session):
1339
"Return the peer's OpenPGP certificate as a bytestring"
1340
# If not an OpenPGP certificate...
1341
if (gnutls.library.functions
1342
.gnutls_certificate_type_get(session._c_object)
1343
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1344
# ...do the normal thing
1345
return session.peer_certificate
1346
list_size = ctypes.c_uint(1)
1347
cert_list = (gnutls.library.functions
1348
.gnutls_certificate_get_peers
1349
(session._c_object, ctypes.byref(list_size)))
1350
if not bool(cert_list) and list_size.value != 0:
1351
raise gnutls.errors.GNUTLSError("error getting peer"
1353
if list_size.value == 0:
1356
return ctypes.string_at(cert.data, cert.size)
1359
def fingerprint(openpgp):
1360
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
1361
# New GnuTLS "datum" with the OpenPGP public key
1362
datum = (gnutls.library.types
1363
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1366
ctypes.c_uint(len(openpgp))))
1367
# New empty GnuTLS certificate
1368
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1369
(gnutls.library.functions
1370
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
1371
# Import the OpenPGP public key into the certificate
1372
(gnutls.library.functions
1373
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1374
gnutls.library.constants
1375
.GNUTLS_OPENPGP_FMT_RAW))
1376
# Verify the self signature in the key
1377
crtverify = ctypes.c_uint()
1378
(gnutls.library.functions
1379
.gnutls_openpgp_crt_verify_self(crt, 0,
1380
ctypes.byref(crtverify)))
1381
if crtverify.value != 0:
1382
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1383
raise (gnutls.errors.CertificateSecurityError
1385
# New buffer for the fingerprint
1386
buf = ctypes.create_string_buffer(20)
1387
buf_len = ctypes.c_size_t()
1388
# Get the fingerprint from the certificate into the buffer
1389
(gnutls.library.functions
1390
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1391
ctypes.byref(buf_len)))
1392
# Deinit the certificate
1393
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1394
# Convert the buffer to a Python bytestring
1395
fpr = ctypes.string_at(buf, buf_len.value)
1396
# Convert the bytestring to hexadecimal notation
1397
hex_fpr = ''.join("%02X" % ord(char) for char in fpr)
1401
class MultiprocessingMixIn(object):
1402
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
1403
def sub_process_main(self, request, address):
1405
self.finish_request(request, address)
1407
self.handle_error(request, address)
1408
self.close_request(request)
1410
def process_request(self, request, address):
1411
"""Start a new process to process the request."""
1412
multiprocessing.Process(target = self.sub_process_main,
1413
args = (request, address)).start()
1415
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1416
""" adds a pipe to the MixIn """
1417
def process_request(self, request, client_address):
1418
"""Overrides and wraps the original process_request().
1420
This function creates a new pipe in self.pipe
1422
parent_pipe, self.child_pipe = multiprocessing.Pipe()
1424
super(MultiprocessingMixInWithPipe,
1425
self).process_request(request, client_address)
1426
self.child_pipe.close()
1427
self.add_pipe(parent_pipe)
1429
def add_pipe(self, parent_pipe):
1430
"""Dummy function; override as necessary"""
1431
raise NotImplementedError
1433
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1434
socketserver.TCPServer, object):
1435
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
735
settings: Server settings
736
clients: Set() of Client objects
737
1438
enabled: Boolean; whether this server is activated yet
1439
interface: None or a network interface name (string)
1440
use_ipv6: Boolean; to use IPv6 or not
739
address_family = socket.AF_INET6
740
def __init__(self, *args, **kwargs):
741
if "settings" in kwargs:
742
self.settings = kwargs["settings"]
743
del kwargs["settings"]
744
if "clients" in kwargs:
745
self.clients = kwargs["clients"]
746
del kwargs["clients"]
748
super(IPv6_TCPServer, self).__init__(*args, **kwargs)
1442
def __init__(self, server_address, RequestHandlerClass,
1443
interface=None, use_ipv6=True):
1444
self.interface = interface
1446
self.address_family = socket.AF_INET6
1447
socketserver.TCPServer.__init__(self, server_address,
1448
RequestHandlerClass)
749
1449
def server_bind(self):
750
1450
"""This overrides the normal server_bind() function
751
1451
to bind to an interface if one was specified, and also NOT to
752
1452
bind to an address or port if they were not specified."""
753
if self.settings["interface"]:
754
# 25 is from /usr/include/asm-i486/socket.h
755
SO_BINDTODEVICE = getattr(socket, "SO_BINDTODEVICE", 25)
757
self.socket.setsockopt(socket.SOL_SOCKET,
759
self.settings["interface"])
760
except socket.error, error:
761
if error[0] == errno.EPERM:
762
logger.error(u"No permission to"
763
u" bind to interface %s",
764
self.settings["interface"])
1453
if self.interface is not None:
1454
if SO_BINDTODEVICE is None:
1455
logger.error("SO_BINDTODEVICE does not exist;"
1456
" cannot bind to interface %s",
1460
self.socket.setsockopt(socket.SOL_SOCKET,
1464
except socket.error as error:
1465
if error[0] == errno.EPERM:
1466
logger.error("No permission to"
1467
" bind to interface %s",
1469
elif error[0] == errno.ENOPROTOOPT:
1470
logger.error("SO_BINDTODEVICE not available;"
1471
" cannot bind to interface %s",
767
1475
# Only bind(2) the socket if we really need to.
768
1476
if self.server_address[0] or self.server_address[1]:
769
1477
if not self.server_address[0]:
771
self.server_address = (in6addr_any,
1478
if self.address_family == socket.AF_INET6:
1479
any_address = "::" # in6addr_any
1481
any_address = socket.INADDR_ANY
1482
self.server_address = (any_address,
772
1483
self.server_address[1])
773
1484
elif not self.server_address[1]:
774
1485
self.server_address = (self.server_address[0],
776
# if self.settings["interface"]:
1487
# if self.interface:
777
1488
# self.server_address = (self.server_address[0],
780
1491
# if_nametoindex
783
return super(IPv6_TCPServer, self).server_bind()
1493
return socketserver.TCPServer.server_bind(self)
1496
class MandosServer(IPv6_TCPServer):
1500
clients: set of Client objects
1501
gnutls_priority GnuTLS priority string
1502
use_dbus: Boolean; to emit D-Bus signals or not
1504
Assumes a gobject.MainLoop event loop.
1506
def __init__(self, server_address, RequestHandlerClass,
1507
interface=None, use_ipv6=True, clients=None,
1508
gnutls_priority=None, use_dbus=True):
1509
self.enabled = False
1510
self.clients = clients
1511
if self.clients is None:
1512
self.clients = set()
1513
self.use_dbus = use_dbus
1514
self.gnutls_priority = gnutls_priority
1515
IPv6_TCPServer.__init__(self, server_address,
1516
RequestHandlerClass,
1517
interface = interface,
1518
use_ipv6 = use_ipv6)
784
1519
def server_activate(self):
785
1520
if self.enabled:
786
return super(IPv6_TCPServer, self).server_activate()
1521
return socketserver.TCPServer.server_activate(self)
787
1522
def enable(self):
788
1523
self.enabled = True
1524
def add_pipe(self, parent_pipe):
1525
# Call "handle_ipc" for both data and EOF events
1526
gobject.io_add_watch(parent_pipe.fileno(),
1527
gobject.IO_IN | gobject.IO_HUP,
1528
functools.partial(self.handle_ipc,
1529
parent_pipe = parent_pipe))
1531
def handle_ipc(self, source, condition, parent_pipe=None,
1532
client_object=None):
1534
gobject.IO_IN: "IN", # There is data to read.
1535
gobject.IO_OUT: "OUT", # Data can be written (without
1537
gobject.IO_PRI: "PRI", # There is urgent data to read.
1538
gobject.IO_ERR: "ERR", # Error condition.
1539
gobject.IO_HUP: "HUP" # Hung up (the connection has been
1540
# broken, usually for pipes and
1543
conditions_string = ' | '.join(name
1545
condition_names.iteritems()
1546
if cond & condition)
1547
# error or the other end of multiprocessing.Pipe has closed
1548
if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
1551
# Read a request from the child
1552
request = parent_pipe.recv()
1553
command = request[0]
1555
if command == 'init':
1557
address = request[2]
1559
for c in self.clients:
1560
if c.fingerprint == fpr:
1564
logger.warning("Client not found for fingerprint: %s, ad"
1565
"dress: %s", fpr, address)
1568
mandos_dbus_service.ClientNotFound(fpr, address[0])
1569
parent_pipe.send(False)
1572
gobject.io_add_watch(parent_pipe.fileno(),
1573
gobject.IO_IN | gobject.IO_HUP,
1574
functools.partial(self.handle_ipc,
1575
parent_pipe = parent_pipe,
1576
client_object = client))
1577
parent_pipe.send(True)
1578
# remove the old hook in favor of the new above hook on same fileno
1580
if command == 'funcall':
1581
funcname = request[1]
1585
parent_pipe.send(('data', getattr(client_object, funcname)(*args, **kwargs)))
1587
if command == 'getattr':
1588
attrname = request[1]
1589
if callable(client_object.__getattribute__(attrname)):
1590
parent_pipe.send(('function',))
1592
parent_pipe.send(('data', client_object.__getattribute__(attrname)))
1594
if command == 'setattr':
1595
attrname = request[1]
1597
setattr(client_object, attrname, value)
791
1602
def string_to_delta(interval):
792
1603
"""Parse a string and return a datetime.timedelta
794
1605
>>> string_to_delta('7d')
795
1606
datetime.timedelta(7)
796
1607
>>> string_to_delta('60s')