148
125
self.rename_count = 0
149
126
self.max_renames = max_renames
150
self.protocol = protocol
151
self.group = None # our entry group
154
self.entry_group_state_changed_match = None
155
127
def rename(self):
156
128
"""Derived from the Avahi example code"""
157
129
if self.rename_count >= self.max_renames:
158
logger.critical("No suitable Zeroconf service name found"
159
" after %i retries, exiting.",
130
logger.critical(u"No suitable Zeroconf service name found"
131
u" after %i retries, exiting.",
160
132
self.rename_count)
161
raise AvahiServiceError("Too many renames")
162
self.name = unicode(self.server.GetAlternativeServiceName(self.name))
163
logger.info("Changing Zeroconf service name to %r ...",
133
raise AvahiServiceError(u"Too many renames")
134
self.name = server.GetAlternativeServiceName(self.name)
135
logger.info(u"Changing Zeroconf service name to %r ...",
165
137
syslogger.setFormatter(logging.Formatter
166
('Mandos (%s) [%%(process)d]:'
167
' %%(levelname)s: %%(message)s'
138
('Mandos (%s): %%(levelname)s:'
139
' %%(message)s' % self.name))
172
except dbus.exceptions.DBusException as error:
173
logger.critical("DBusException: %s", error)
176
142
self.rename_count += 1
177
143
def remove(self):
178
144
"""Derived from the Avahi example code"""
179
if self.entry_group_state_changed_match is not None:
180
self.entry_group_state_changed_match.remove()
181
self.entry_group_state_changed_match = None
182
if self.group is not None:
145
if group is not None:
185
148
"""Derived from the Avahi example code"""
187
if self.group is None:
188
self.group = dbus.Interface(
189
self.bus.get_object(avahi.DBUS_NAME,
190
self.server.EntryGroupNew()),
191
avahi.DBUS_INTERFACE_ENTRY_GROUP)
192
self.entry_group_state_changed_match = (
193
self.group.connect_to_signal(
194
'StateChanged', self .entry_group_state_changed))
195
logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
196
self.name, self.type)
197
self.group.AddService(
200
dbus.UInt32(0), # flags
201
self.name, self.type,
202
self.domain, self.host,
203
dbus.UInt16(self.port),
204
avahi.string_array_to_txt_array(self.TXT))
206
def entry_group_state_changed(self, state, error):
207
"""Derived from the Avahi example code"""
208
logger.debug("Avahi entry group state change: %i", state)
210
if state == avahi.ENTRY_GROUP_ESTABLISHED:
211
logger.debug("Zeroconf service established.")
212
elif state == avahi.ENTRY_GROUP_COLLISION:
213
logger.info("Zeroconf service name collision.")
215
elif state == avahi.ENTRY_GROUP_FAILURE:
216
logger.critical("Avahi: Error in group state changed %s",
218
raise AvahiGroupError("State changed: %s"
221
"""Derived from the Avahi example code"""
222
if self.group is not None:
225
except (dbus.exceptions.UnknownMethodException,
226
dbus.exceptions.DBusException) as e:
230
def server_state_changed(self, state, error=None):
231
"""Derived from the Avahi example code"""
232
logger.debug("Avahi server state change: %i", state)
233
bad_states = { avahi.SERVER_INVALID:
234
"Zeroconf server invalid",
235
avahi.SERVER_REGISTERING: None,
236
avahi.SERVER_COLLISION:
237
"Zeroconf server name collision",
238
avahi.SERVER_FAILURE:
239
"Zeroconf server failure" }
240
if state in bad_states:
241
if bad_states[state] is not None:
243
logger.error(bad_states[state])
245
logger.error(bad_states[state] + ": %r", error)
247
elif state == avahi.SERVER_RUNNING:
251
logger.debug("Unknown state: %r", state)
253
logger.debug("Unknown state: %r: %r", state, error)
255
"""Derived from the Avahi example code"""
256
if self.server is None:
257
self.server = dbus.Interface(
258
self.bus.get_object(avahi.DBUS_NAME,
259
avahi.DBUS_PATH_SERVER,
260
follow_name_owner_changes=True),
261
avahi.DBUS_INTERFACE_SERVER)
262
self.server.connect_to_signal("StateChanged",
263
self.server_state_changed)
264
self.server_state_changed(self.server.GetState())
267
class Client(object):
151
group = dbus.Interface(bus.get_object
153
server.EntryGroupNew()),
154
avahi.DBUS_INTERFACE_ENTRY_GROUP)
155
group.connect_to_signal('StateChanged',
156
entry_group_state_changed)
157
logger.debug(u"Adding Zeroconf service '%s' of type '%s' ...",
158
service.name, service.type)
160
self.interface, # interface
161
avahi.PROTO_INET6, # protocol
162
dbus.UInt32(0), # flags
163
self.name, self.type,
164
self.domain, self.host,
165
dbus.UInt16(self.port),
166
avahi.string_array_to_txt_array(self.TXT))
169
# From the Avahi example code:
170
group = None # our entry group
171
# End of Avahi example code
174
def _datetime_to_dbus(dt, variant_level=0):
175
"""Convert a UTC datetime.datetime() to a D-Bus type."""
176
return dbus.String(dt.isoformat(), variant_level=variant_level)
179
class Client(dbus.service.Object):
268
180
"""A representation of a client host served by this server.
271
_approved: bool(); 'None' if not yet approved/disapproved
272
approval_delay: datetime.timedelta(); Time to wait for approval
273
approval_duration: datetime.timedelta(); Duration of one approval
182
name: string; from the config file, used in log messages and
184
fingerprint: string (40 or 32 hexadecimal digits); used to
185
uniquely identify the client
186
secret: bytestring; sent verbatim (over TLS) to client
187
host: string; available for use by the checker command
188
created: datetime.datetime(); (UTC) object creation
189
last_enabled: datetime.datetime(); (UTC)
191
last_checked_ok: datetime.datetime(); (UTC) or None
192
timeout: datetime.timedelta(); How long from last_checked_ok
193
until this client is invalid
194
interval: datetime.timedelta(); How often to start a new checker
195
disable_hook: If set, called by disable() as disable_hook(self)
274
196
checker: subprocess.Popen(); a running checker process used
275
197
to see if the client lives.
276
198
'None' if no process is running.
277
checker_callback_tag: a gobject event source tag, or None
278
checker_command: string; External command which is run to check
279
if client lives. %() expansions are done at
199
checker_initiator_tag: a gobject event source tag, or None
200
disable_initiator_tag: - '' -
201
checker_callback_tag: - '' -
202
checker_command: string; External command which is run to check if
203
client lives. %() expansions are done at
280
204
runtime with vars(self) as dict, so that for
281
205
instance %(name)s can be used in the command.
282
checker_initiator_tag: a gobject event source tag, or None
283
created: datetime.datetime(); (UTC) object creation
284
current_checker_command: string; current running checker_command
285
disable_hook: If set, called by disable() as disable_hook(self)
286
disable_initiator_tag: a gobject event source tag, or None
288
fingerprint: string (40 or 32 hexadecimal digits); used to
289
uniquely identify the client
290
host: string; available for use by the checker command
291
interval: datetime.timedelta(); How often to start a new checker
292
last_approval_request: datetime.datetime(); (UTC) or None
293
last_checked_ok: datetime.datetime(); (UTC) or None
294
last_enabled: datetime.datetime(); (UTC)
295
name: string; from the config file, used in log messages and
297
secret: bytestring; sent verbatim (over TLS) to client
298
timeout: datetime.timedelta(); How long from last_checked_ok
299
until this client is disabled
300
runtime_expansions: Allowed attributes for runtime expansion.
206
use_dbus: bool(); Whether to provide D-Bus interface and signals
207
dbus_object_path: dbus.ObjectPath ; only set if self.use_dbus
303
runtime_expansions = ("approval_delay", "approval_duration",
304
"created", "enabled", "fingerprint",
305
"host", "interval", "last_checked_ok",
306
"last_enabled", "name", "timeout")
309
def _timedelta_to_milliseconds(td):
310
"Convert a datetime.timedelta() to milliseconds"
311
return ((td.days * 24 * 60 * 60 * 1000)
312
+ (td.seconds * 1000)
313
+ (td.microseconds // 1000))
315
209
def timeout_milliseconds(self):
316
210
"Return the 'timeout' attribute in milliseconds"
317
return self._timedelta_to_milliseconds(self.timeout)
211
return ((self.timeout.days * 24 * 60 * 60 * 1000)
212
+ (self.timeout.seconds * 1000)
213
+ (self.timeout.microseconds // 1000))
319
215
def interval_milliseconds(self):
320
216
"Return the 'interval' attribute in milliseconds"
321
return self._timedelta_to_milliseconds(self.interval)
323
def approval_delay_milliseconds(self):
324
return self._timedelta_to_milliseconds(self.approval_delay)
217
return ((self.interval.days * 24 * 60 * 60 * 1000)
218
+ (self.interval.seconds * 1000)
219
+ (self.interval.microseconds // 1000))
326
def __init__(self, name = None, disable_hook=None, config=None):
221
def __init__(self, name = None, disable_hook=None, config=None,
327
223
"""Note: the 'checker' key in 'config' sets the
328
224
'checker_command' attribute and *not* the 'checker'
331
227
if config is None:
333
logger.debug("Creating client %r", self.name)
229
logger.debug(u"Creating client %r", self.name)
230
self.use_dbus = False # During __init__
334
231
# Uppercase and remove spaces from fingerprint for later
335
232
# comparison purposes with return value from the fingerprint()
337
234
self.fingerprint = (config["fingerprint"].upper()
339
logger.debug(" Fingerprint: %s", self.fingerprint)
236
logger.debug(u" Fingerprint: %s", self.fingerprint)
340
237
if "secret" in config:
341
self.secret = config["secret"].decode("base64")
238
self.secret = config["secret"].decode(u"base64")
342
239
elif "secfile" in config:
343
with open(os.path.expanduser(os.path.expandvars
344
(config["secfile"])),
240
with closing(open(os.path.expanduser
242
(config["secfile"])))) as secfile:
346
243
self.secret = secfile.read()
348
raise TypeError("No secret or secfile for client %s"
245
raise TypeError(u"No secret or secfile for client %s"
350
247
self.host = config.get("host", "")
351
248
self.created = datetime.datetime.utcnow()
352
249
self.enabled = False
353
self.last_approval_request = None
354
250
self.last_enabled = None
355
251
self.last_checked_ok = None
356
252
self.timeout = string_to_delta(config["timeout"])
537
425
self.checker_callback_tag = None
538
426
if getattr(self, "checker", None) is None:
540
logger.debug("Stopping checker for %(name)s", vars(self))
428
logger.debug(u"Stopping checker for %(name)s", vars(self))
542
430
os.kill(self.checker.pid, signal.SIGTERM)
544
432
#if self.checker.poll() is None:
545
433
# os.kill(self.checker.pid, signal.SIGKILL)
546
except OSError as error:
434
except OSError, error:
547
435
if error.errno != errno.ESRCH: # No such process
549
437
self.checker = None
551
def dbus_service_property(dbus_interface, signature="v",
552
access="readwrite", byte_arrays=False):
553
"""Decorators for marking methods of a DBusObjectWithProperties to
554
become properties on the D-Bus.
556
The decorated method will be called with no arguments by "Get"
557
and with one argument by "Set".
559
The parameters, where they are supported, are the same as
560
dbus.service.method, except there is only "signature", since the
561
type from Get() and the type sent to Set() is the same.
563
# Encoding deeply encoded byte arrays is not supported yet by the
564
# "Set" method, so we fail early here:
565
if byte_arrays and signature != "ay":
566
raise ValueError("Byte arrays not supported for non-'ay'"
567
" signature %r" % signature)
569
func._dbus_is_property = True
570
func._dbus_interface = dbus_interface
571
func._dbus_signature = signature
572
func._dbus_access = access
573
func._dbus_name = func.__name__
574
if func._dbus_name.endswith("_dbus_property"):
575
func._dbus_name = func._dbus_name[:-14]
576
func._dbus_get_args_options = {'byte_arrays': byte_arrays }
581
class DBusPropertyException(dbus.exceptions.DBusException):
582
"""A base class for D-Bus property-related exceptions
584
def __unicode__(self):
585
return unicode(str(self))
588
class DBusPropertyAccessException(DBusPropertyException):
589
"""A property's access permissions disallows an operation.
594
class DBusPropertyNotFound(DBusPropertyException):
595
"""An attempt was made to access a non-existing property.
600
class DBusObjectWithProperties(dbus.service.Object):
601
"""A D-Bus object with properties.
603
Classes inheriting from this can use the dbus_service_property
604
decorator to expose methods as D-Bus properties. It exposes the
605
standard Get(), Set(), and GetAll() methods on the D-Bus.
609
def _is_dbus_property(obj):
610
return getattr(obj, "_dbus_is_property", False)
612
def _get_all_dbus_properties(self):
613
"""Returns a generator of (name, attribute) pairs
615
return ((prop._dbus_name, prop)
617
inspect.getmembers(self, self._is_dbus_property))
619
def _get_dbus_property(self, interface_name, property_name):
620
"""Returns a bound method if one exists which is a D-Bus
621
property with the specified name and interface.
623
for name in (property_name,
624
property_name + "_dbus_property"):
625
prop = getattr(self, name, None)
627
or not self._is_dbus_property(prop)
628
or prop._dbus_name != property_name
629
or (interface_name and prop._dbus_interface
630
and interface_name != prop._dbus_interface)):
634
raise DBusPropertyNotFound(self.dbus_object_path + ":"
635
+ interface_name + "."
638
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
640
def Get(self, interface_name, property_name):
641
"""Standard D-Bus property Get() method, see D-Bus standard.
643
prop = self._get_dbus_property(interface_name, property_name)
644
if prop._dbus_access == "write":
645
raise DBusPropertyAccessException(property_name)
647
if not hasattr(value, "variant_level"):
649
return type(value)(value, variant_level=value.variant_level+1)
651
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
652
def Set(self, interface_name, property_name, value):
653
"""Standard D-Bus property Set() method, see D-Bus standard.
655
prop = self._get_dbus_property(interface_name, property_name)
656
if prop._dbus_access == "read":
657
raise DBusPropertyAccessException(property_name)
658
if prop._dbus_get_args_options["byte_arrays"]:
659
# The byte_arrays option is not supported yet on
660
# signatures other than "ay".
661
if prop._dbus_signature != "ay":
663
value = dbus.ByteArray(''.join(unichr(byte)
667
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
668
out_signature="a{sv}")
669
def GetAll(self, interface_name):
670
"""Standard D-Bus property GetAll() method, see D-Bus
673
Note: Will not include properties with access="write".
676
for name, prop in self._get_all_dbus_properties():
678
and interface_name != prop._dbus_interface):
679
# Interface non-empty but did not match
681
# Ignore write-only properties
682
if prop._dbus_access == "write":
685
if not hasattr(value, "variant_level"):
688
all[name] = type(value)(value, variant_level=
689
value.variant_level+1)
690
return dbus.Dictionary(all, signature="sv")
692
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
694
path_keyword='object_path',
695
connection_keyword='connection')
696
def Introspect(self, object_path, connection):
697
"""Standard D-Bus method, overloaded to insert property tags.
699
xmlstring = dbus.service.Object.Introspect(self, object_path,
702
document = xml.dom.minidom.parseString(xmlstring)
703
def make_tag(document, name, prop):
704
e = document.createElement("property")
705
e.setAttribute("name", name)
706
e.setAttribute("type", prop._dbus_signature)
707
e.setAttribute("access", prop._dbus_access)
709
for if_tag in document.getElementsByTagName("interface"):
710
for tag in (make_tag(document, name, prop)
712
in self._get_all_dbus_properties()
713
if prop._dbus_interface
714
== if_tag.getAttribute("name")):
715
if_tag.appendChild(tag)
716
# Add the names to the return values for the
717
# "org.freedesktop.DBus.Properties" methods
718
if (if_tag.getAttribute("name")
719
== "org.freedesktop.DBus.Properties"):
720
for cn in if_tag.getElementsByTagName("method"):
721
if cn.getAttribute("name") == "Get":
722
for arg in cn.getElementsByTagName("arg"):
723
if (arg.getAttribute("direction")
725
arg.setAttribute("name", "value")
726
elif cn.getAttribute("name") == "GetAll":
727
for arg in cn.getElementsByTagName("arg"):
728
if (arg.getAttribute("direction")
730
arg.setAttribute("name", "props")
731
xmlstring = document.toxml("utf-8")
733
except (AttributeError, xml.dom.DOMException,
734
xml.parsers.expat.ExpatError) as error:
735
logger.error("Failed to override Introspection method",
740
class ClientDBus(Client, DBusObjectWithProperties):
741
"""A Client class using D-Bus
744
dbus_object_path: dbus.ObjectPath
745
bus: dbus.SystemBus()
748
runtime_expansions = (Client.runtime_expansions
749
+ ("dbus_object_path",))
751
# dbus.service.Object doesn't use super(), so we can't either.
753
def __init__(self, bus = None, *args, **kwargs):
754
self._approvals_pending = 0
756
Client.__init__(self, *args, **kwargs)
757
# Only now, when this client is initialized, can it show up on
759
client_object_name = unicode(self.name).translate(
762
self.dbus_object_path = (dbus.ObjectPath
763
("/clients/" + client_object_name))
764
DBusObjectWithProperties.__init__(self, self.bus,
765
self.dbus_object_path)
767
def _get_approvals_pending(self):
768
return self._approvals_pending
769
def _set_approvals_pending(self, value):
770
old_value = self._approvals_pending
771
self._approvals_pending = value
773
if (hasattr(self, "dbus_object_path")
774
and bval is not bool(old_value)):
775
dbus_bool = dbus.Boolean(bval, variant_level=1)
776
self.PropertyChanged(dbus.String("ApprovalPending"),
779
approvals_pending = property(_get_approvals_pending,
780
_set_approvals_pending)
781
del _get_approvals_pending, _set_approvals_pending
784
def _datetime_to_dbus(dt, variant_level=0):
785
"""Convert a UTC datetime.datetime() to a D-Bus type."""
786
return dbus.String(dt.isoformat(),
787
variant_level=variant_level)
790
oldstate = getattr(self, "enabled", False)
791
r = Client.enable(self)
792
if oldstate != self.enabled:
794
self.PropertyChanged(dbus.String("Enabled"),
795
dbus.Boolean(True, variant_level=1))
796
self.PropertyChanged(
797
dbus.String("LastEnabled"),
798
self._datetime_to_dbus(self.last_enabled,
802
def disable(self, quiet = False):
803
oldstate = getattr(self, "enabled", False)
804
r = Client.disable(self, quiet=quiet)
805
if not quiet and oldstate != self.enabled:
807
self.PropertyChanged(dbus.String("Enabled"),
808
dbus.Boolean(False, variant_level=1))
811
def __del__(self, *args, **kwargs):
813
self.remove_from_connection()
816
if hasattr(DBusObjectWithProperties, "__del__"):
817
DBusObjectWithProperties.__del__(self, *args, **kwargs)
818
Client.__del__(self, *args, **kwargs)
820
def checker_callback(self, pid, condition, command,
822
self.checker_callback_tag = None
825
self.PropertyChanged(dbus.String("CheckerRunning"),
826
dbus.Boolean(False, variant_level=1))
827
if os.WIFEXITED(condition):
828
exitstatus = os.WEXITSTATUS(condition)
830
self.CheckerCompleted(dbus.Int16(exitstatus),
831
dbus.Int64(condition),
832
dbus.String(command))
835
self.CheckerCompleted(dbus.Int16(-1),
836
dbus.Int64(condition),
837
dbus.String(command))
839
return Client.checker_callback(self, pid, condition, command,
842
def checked_ok(self, *args, **kwargs):
843
Client.checked_ok(self, *args, **kwargs)
845
self.PropertyChanged(
846
dbus.String("LastCheckedOK"),
847
(self._datetime_to_dbus(self.last_checked_ok,
850
def need_approval(self, *args, **kwargs):
851
r = Client.need_approval(self, *args, **kwargs)
853
self.PropertyChanged(
854
dbus.String("LastApprovalRequest"),
855
(self._datetime_to_dbus(self.last_approval_request,
859
def start_checker(self, *args, **kwargs):
860
old_checker = self.checker
861
if self.checker is not None:
862
old_checker_pid = self.checker.pid
864
old_checker_pid = None
865
r = Client.start_checker(self, *args, **kwargs)
866
# Only if new checker process was started
867
if (self.checker is not None
868
and old_checker_pid != self.checker.pid):
870
self.CheckerStarted(self.current_checker_command)
871
self.PropertyChanged(
872
dbus.String("CheckerRunning"),
873
dbus.Boolean(True, variant_level=1))
876
def stop_checker(self, *args, **kwargs):
877
old_checker = getattr(self, "checker", None)
878
r = Client.stop_checker(self, *args, **kwargs)
879
if (old_checker is not None
880
and getattr(self, "checker", None) is None):
881
self.PropertyChanged(dbus.String("CheckerRunning"),
882
dbus.Boolean(False, variant_level=1))
885
def _reset_approved(self):
886
self._approved = None
889
def approve(self, value=True):
890
self.send_changedstate()
891
self._approved = value
892
gobject.timeout_add(self._timedelta_to_milliseconds
893
(self.approval_duration),
894
self._reset_approved)
897
## D-Bus methods, signals & properties
898
_interface = "se.bsnet.fukt.Mandos.Client"
439
self.PropertyChanged(dbus.String(u"checker_running"),
440
dbus.Boolean(False, variant_level=1))
442
def still_valid(self):
443
"""Has the timeout not yet passed for this client?"""
444
if not getattr(self, "enabled", False):
446
now = datetime.datetime.utcnow()
447
if self.last_checked_ok is None:
448
return now < (self.created + self.timeout)
450
return now < (self.last_checked_ok + self.timeout)
452
## D-Bus methods & signals
453
_interface = u"se.bsnet.fukt.Mandos.Client"
456
CheckedOK = dbus.service.method(_interface)(checked_ok)
457
CheckedOK.__name__ = "CheckedOK"
902
459
# CheckerCompleted - signal
903
460
@dbus.service.signal(_interface, signature="nxs")
971
584
# StopChecker - method
972
@dbus.service.method(_interface)
973
def StopChecker(self):
978
# ApprovalPending - property
979
@dbus_service_property(_interface, signature="b", access="read")
980
def ApprovalPending_dbus_property(self):
981
return dbus.Boolean(bool(self.approvals_pending))
983
# ApprovedByDefault - property
984
@dbus_service_property(_interface, signature="b",
986
def ApprovedByDefault_dbus_property(self, value=None):
987
if value is None: # get
988
return dbus.Boolean(self.approved_by_default)
989
self.approved_by_default = bool(value)
991
self.PropertyChanged(dbus.String("ApprovedByDefault"),
992
dbus.Boolean(value, variant_level=1))
994
# ApprovalDelay - property
995
@dbus_service_property(_interface, signature="t",
997
def ApprovalDelay_dbus_property(self, value=None):
998
if value is None: # get
999
return dbus.UInt64(self.approval_delay_milliseconds())
1000
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1002
self.PropertyChanged(dbus.String("ApprovalDelay"),
1003
dbus.UInt64(value, variant_level=1))
1005
# ApprovalDuration - property
1006
@dbus_service_property(_interface, signature="t",
1008
def ApprovalDuration_dbus_property(self, value=None):
1009
if value is None: # get
1010
return dbus.UInt64(self._timedelta_to_milliseconds(
1011
self.approval_duration))
1012
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1014
self.PropertyChanged(dbus.String("ApprovalDuration"),
1015
dbus.UInt64(value, variant_level=1))
1018
@dbus_service_property(_interface, signature="s", access="read")
1019
def Name_dbus_property(self):
1020
return dbus.String(self.name)
1022
# Fingerprint - property
1023
@dbus_service_property(_interface, signature="s", access="read")
1024
def Fingerprint_dbus_property(self):
1025
return dbus.String(self.fingerprint)
1028
@dbus_service_property(_interface, signature="s",
1030
def Host_dbus_property(self, value=None):
1031
if value is None: # get
1032
return dbus.String(self.host)
1035
self.PropertyChanged(dbus.String("Host"),
1036
dbus.String(value, variant_level=1))
1038
# Created - property
1039
@dbus_service_property(_interface, signature="s", access="read")
1040
def Created_dbus_property(self):
1041
return dbus.String(self._datetime_to_dbus(self.created))
1043
# LastEnabled - property
1044
@dbus_service_property(_interface, signature="s", access="read")
1045
def LastEnabled_dbus_property(self):
1046
if self.last_enabled is None:
1047
return dbus.String("")
1048
return dbus.String(self._datetime_to_dbus(self.last_enabled))
1050
# Enabled - property
1051
@dbus_service_property(_interface, signature="b",
1053
def Enabled_dbus_property(self, value=None):
1054
if value is None: # get
1055
return dbus.Boolean(self.enabled)
1061
# LastCheckedOK - property
1062
@dbus_service_property(_interface, signature="s",
1064
def LastCheckedOK_dbus_property(self, value=None):
1065
if value is not None:
1068
if self.last_checked_ok is None:
1069
return dbus.String("")
1070
return dbus.String(self._datetime_to_dbus(self
1073
# LastApprovalRequest - property
1074
@dbus_service_property(_interface, signature="s", access="read")
1075
def LastApprovalRequest_dbus_property(self):
1076
if self.last_approval_request is None:
1077
return dbus.String("")
1078
return dbus.String(self.
1079
_datetime_to_dbus(self
1080
.last_approval_request))
1082
# Timeout - property
1083
@dbus_service_property(_interface, signature="t",
1085
def Timeout_dbus_property(self, value=None):
1086
if value is None: # get
1087
return dbus.UInt64(self.timeout_milliseconds())
1088
self.timeout = datetime.timedelta(0, 0, 0, value)
1090
self.PropertyChanged(dbus.String("Timeout"),
1091
dbus.UInt64(value, variant_level=1))
1092
if getattr(self, "disable_initiator_tag", None) is None:
1094
# Reschedule timeout
1095
gobject.source_remove(self.disable_initiator_tag)
1096
self.disable_initiator_tag = None
1097
time_to_die = (self.
1098
_timedelta_to_milliseconds((self
1103
if time_to_die <= 0:
1104
# The timeout has passed
1107
self.disable_initiator_tag = (gobject.timeout_add
1108
(time_to_die, self.disable))
1110
# Interval - property
1111
@dbus_service_property(_interface, signature="t",
1113
def Interval_dbus_property(self, value=None):
1114
if value is None: # get
1115
return dbus.UInt64(self.interval_milliseconds())
1116
self.interval = datetime.timedelta(0, 0, 0, value)
1118
self.PropertyChanged(dbus.String("Interval"),
1119
dbus.UInt64(value, variant_level=1))
1120
if getattr(self, "checker_initiator_tag", None) is None:
1122
# Reschedule checker run
1123
gobject.source_remove(self.checker_initiator_tag)
1124
self.checker_initiator_tag = (gobject.timeout_add
1125
(value, self.start_checker))
1126
self.start_checker() # Start one now, too
1128
# Checker - property
1129
@dbus_service_property(_interface, signature="s",
1131
def Checker_dbus_property(self, value=None):
1132
if value is None: # get
1133
return dbus.String(self.checker_command)
1134
self.checker_command = value
1136
self.PropertyChanged(dbus.String("Checker"),
1137
dbus.String(self.checker_command,
1140
# CheckerRunning - property
1141
@dbus_service_property(_interface, signature="b",
1143
def CheckerRunning_dbus_property(self, value=None):
1144
if value is None: # get
1145
return dbus.Boolean(self.checker is not None)
1147
self.start_checker()
1151
# ObjectPath - property
1152
@dbus_service_property(_interface, signature="o", access="read")
1153
def ObjectPath_dbus_property(self):
1154
return self.dbus_object_path # is already a dbus.ObjectPath
1157
@dbus_service_property(_interface, signature="ay",
1158
access="write", byte_arrays=True)
1159
def Secret_dbus_property(self, value):
1160
self.secret = str(value)
585
StopChecker = dbus.service.method(_interface)(stop_checker)
586
StopChecker.__name__ = "StopChecker"
1165
class ProxyClient(object):
1166
def __init__(self, child_pipe, fpr, address):
1167
self._pipe = child_pipe
1168
self._pipe.send(('init', fpr, address))
1169
if not self._pipe.recv():
1172
def __getattribute__(self, name):
1173
if(name == '_pipe'):
1174
return super(ProxyClient, self).__getattribute__(name)
1175
self._pipe.send(('getattr', name))
1176
data = self._pipe.recv()
1177
if data[0] == 'data':
1179
if data[0] == 'function':
1180
def func(*args, **kwargs):
1181
self._pipe.send(('funcall', name, args, kwargs))
1182
return self._pipe.recv()[1]
1185
def __setattr__(self, name, value):
1186
if(name == '_pipe'):
1187
return super(ProxyClient, self).__setattr__(name, value)
1188
self._pipe.send(('setattr', name, value))
1191
class ClientHandler(socketserver.BaseRequestHandler, object):
1192
"""A class to handle client connections.
1194
Instantiated once for each connection to handle it.
591
def peer_certificate(session):
592
"Return the peer's OpenPGP certificate as a bytestring"
593
# If not an OpenPGP certificate...
594
if (gnutls.library.functions
595
.gnutls_certificate_type_get(session._c_object)
596
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
597
# ...do the normal thing
598
return session.peer_certificate
599
list_size = ctypes.c_uint(1)
600
cert_list = (gnutls.library.functions
601
.gnutls_certificate_get_peers
602
(session._c_object, ctypes.byref(list_size)))
603
if not bool(cert_list) and list_size.value != 0:
604
raise gnutls.errors.GNUTLSError("error getting peer"
606
if list_size.value == 0:
609
return ctypes.string_at(cert.data, cert.size)
612
def fingerprint(openpgp):
613
"Convert an OpenPGP bytestring to a hexdigit fingerprint string"
614
# New GnuTLS "datum" with the OpenPGP public key
615
datum = (gnutls.library.types
616
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
619
ctypes.c_uint(len(openpgp))))
620
# New empty GnuTLS certificate
621
crt = gnutls.library.types.gnutls_openpgp_crt_t()
622
(gnutls.library.functions
623
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
624
# Import the OpenPGP public key into the certificate
625
(gnutls.library.functions
626
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
627
gnutls.library.constants
628
.GNUTLS_OPENPGP_FMT_RAW))
629
# Verify the self signature in the key
630
crtverify = ctypes.c_uint()
631
(gnutls.library.functions
632
.gnutls_openpgp_crt_verify_self(crt, 0, ctypes.byref(crtverify)))
633
if crtverify.value != 0:
634
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
635
raise gnutls.errors.CertificateSecurityError("Verify failed")
636
# New buffer for the fingerprint
637
buf = ctypes.create_string_buffer(20)
638
buf_len = ctypes.c_size_t()
639
# Get the fingerprint from the certificate into the buffer
640
(gnutls.library.functions
641
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
642
ctypes.byref(buf_len)))
643
# Deinit the certificate
644
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
645
# Convert the buffer to a Python bytestring
646
fpr = ctypes.string_at(buf, buf_len.value)
647
# Convert the bytestring to hexadecimal notation
648
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
652
class TCP_handler(SocketServer.BaseRequestHandler, object):
653
"""A TCP request handler class.
654
Instantiated by IPv6_TCPServer for each request to handle it.
1195
655
Note: This will run in its own forked process."""
1197
657
def handle(self):
1198
with contextlib.closing(self.server.child_pipe) as child_pipe:
1199
logger.info("TCP connection from: %s",
1200
unicode(self.client_address))
1201
logger.debug("Pipe FD: %d",
1202
self.server.child_pipe.fileno())
1204
session = (gnutls.connection
1205
.ClientSession(self.request,
1207
.X509Credentials()))
1209
# Note: gnutls.connection.X509Credentials is really a
1210
# generic GnuTLS certificate credentials object so long as
1211
# no X.509 keys are added to it. Therefore, we can use it
1212
# here despite using OpenPGP certificates.
1214
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1215
# "+AES-256-CBC", "+SHA1",
1216
# "+COMP-NULL", "+CTYPE-OPENPGP",
1218
# Use a fallback default, since this MUST be set.
1219
priority = self.server.gnutls_priority
1220
if priority is None:
1222
(gnutls.library.functions
1223
.gnutls_priority_set_direct(session._c_object,
1226
# Start communication using the Mandos protocol
1227
# Get protocol number
1228
line = self.request.makefile().readline()
1229
logger.debug("Protocol version: %r", line)
1231
if int(line.strip().split()[0]) > 1:
1233
except (ValueError, IndexError, RuntimeError) as error:
1234
logger.error("Unknown protocol version: %s", error)
1237
# Start GnuTLS connection
1240
except gnutls.errors.GNUTLSError as error:
1241
logger.warning("Handshake failed: %s", error)
1242
# Do not run session.bye() here: the session is not
1243
# established. Just abandon the request.
1245
logger.debug("Handshake succeeded")
1247
approval_required = False
1250
fpr = self.fingerprint(self.peer_certificate
1253
gnutls.errors.GNUTLSError) as error:
1254
logger.warning("Bad certificate: %s", error)
1256
logger.debug("Fingerprint: %s", fpr)
1259
client = ProxyClient(child_pipe, fpr,
1260
self.client_address)
1264
if client.approval_delay:
1265
delay = client.approval_delay
1266
client.approvals_pending += 1
1267
approval_required = True
1270
if not client.enabled:
1271
logger.warning("Client %s is disabled",
1273
if self.server.use_dbus:
1275
client.Rejected("Disabled")
1278
if client._approved or not client.approval_delay:
1279
#We are approved or approval is disabled
1281
elif client._approved is None:
1282
logger.info("Client %s needs approval",
1284
if self.server.use_dbus:
1286
client.NeedApproval(
1287
client.approval_delay_milliseconds(),
1288
client.approved_by_default)
1290
logger.warning("Client %s was not approved",
1292
if self.server.use_dbus:
1294
client.Rejected("Denied")
1297
#wait until timeout or approved
1298
#x = float(client._timedelta_to_milliseconds(delay))
1299
time = datetime.datetime.now()
1300
client.changedstate.acquire()
1301
client.changedstate.wait(float(client._timedelta_to_milliseconds(delay) / 1000))
1302
client.changedstate.release()
1303
time2 = datetime.datetime.now()
1304
if (time2 - time) >= delay:
1305
if not client.approved_by_default:
1306
logger.warning("Client %s timed out while"
1307
" waiting for approval",
1309
if self.server.use_dbus:
1311
client.Rejected("Approval timed out")
1316
delay -= time2 - time
1319
while sent_size < len(client.secret):
1321
sent = session.send(client.secret[sent_size:])
1322
except gnutls.errors.GNUTLSError as error:
1323
logger.warning("gnutls send failed")
1325
logger.debug("Sent: %d, remaining: %d",
1326
sent, len(client.secret)
1327
- (sent_size + sent))
1330
logger.info("Sending secret to %s", client.name)
1331
# bump the timeout as if seen
1333
if self.server.use_dbus:
1338
if approval_required:
1339
client.approvals_pending -= 1
1342
except gnutls.errors.GNUTLSError as error:
1343
logger.warning("GnuTLS bye failed")
1346
def peer_certificate(session):
1347
"Return the peer's OpenPGP certificate as a bytestring"
1348
# If not an OpenPGP certificate...
1349
if (gnutls.library.functions
1350
.gnutls_certificate_type_get(session._c_object)
1351
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1352
# ...do the normal thing
1353
return session.peer_certificate
1354
list_size = ctypes.c_uint(1)
1355
cert_list = (gnutls.library.functions
1356
.gnutls_certificate_get_peers
1357
(session._c_object, ctypes.byref(list_size)))
1358
if not bool(cert_list) and list_size.value != 0:
1359
raise gnutls.errors.GNUTLSError("error getting peer"
1361
if list_size.value == 0:
1364
return ctypes.string_at(cert.data, cert.size)
1367
def fingerprint(openpgp):
1368
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
1369
# New GnuTLS "datum" with the OpenPGP public key
1370
datum = (gnutls.library.types
1371
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1374
ctypes.c_uint(len(openpgp))))
1375
# New empty GnuTLS certificate
1376
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1377
(gnutls.library.functions
1378
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
1379
# Import the OpenPGP public key into the certificate
1380
(gnutls.library.functions
1381
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1382
gnutls.library.constants
1383
.GNUTLS_OPENPGP_FMT_RAW))
1384
# Verify the self signature in the key
1385
crtverify = ctypes.c_uint()
1386
(gnutls.library.functions
1387
.gnutls_openpgp_crt_verify_self(crt, 0,
1388
ctypes.byref(crtverify)))
1389
if crtverify.value != 0:
1390
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1391
raise (gnutls.errors.CertificateSecurityError
1393
# New buffer for the fingerprint
1394
buf = ctypes.create_string_buffer(20)
1395
buf_len = ctypes.c_size_t()
1396
# Get the fingerprint from the certificate into the buffer
1397
(gnutls.library.functions
1398
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1399
ctypes.byref(buf_len)))
1400
# Deinit the certificate
1401
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1402
# Convert the buffer to a Python bytestring
1403
fpr = ctypes.string_at(buf, buf_len.value)
1404
# Convert the bytestring to hexadecimal notation
1405
hex_fpr = ''.join("%02X" % ord(char) for char in fpr)
1409
class MultiprocessingMixIn(object):
1410
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
1411
def sub_process_main(self, request, address):
1413
self.finish_request(request, address)
1415
self.handle_error(request, address)
1416
self.close_request(request)
1418
def process_request(self, request, address):
1419
"""Start a new process to process the request."""
1420
multiprocessing.Process(target = self.sub_process_main,
1421
args = (request, address)).start()
1423
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1424
""" adds a pipe to the MixIn """
1425
def process_request(self, request, client_address):
1426
"""Overrides and wraps the original process_request().
1428
This function creates a new pipe in self.pipe
1430
parent_pipe, self.child_pipe = multiprocessing.Pipe()
1432
super(MultiprocessingMixInWithPipe,
1433
self).process_request(request, client_address)
1434
self.child_pipe.close()
1435
self.add_pipe(parent_pipe)
1437
def add_pipe(self, parent_pipe):
1438
"""Dummy function; override as necessary"""
1439
raise NotImplementedError
1441
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1442
socketserver.TCPServer, object):
1443
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
658
logger.info(u"TCP connection from: %s",
659
unicode(self.client_address))
660
session = (gnutls.connection
661
.ClientSession(self.request,
665
line = self.request.makefile().readline()
666
logger.debug(u"Protocol version: %r", line)
668
if int(line.strip().split()[0]) > 1:
670
except (ValueError, IndexError, RuntimeError), error:
671
logger.error(u"Unknown protocol version: %s", error)
674
# Note: gnutls.connection.X509Credentials is really a generic
675
# GnuTLS certificate credentials object so long as no X.509
676
# keys are added to it. Therefore, we can use it here despite
677
# using OpenPGP certificates.
679
#priority = ':'.join(("NONE", "+VERS-TLS1.1", "+AES-256-CBC",
680
# "+SHA1", "+COMP-NULL", "+CTYPE-OPENPGP",
682
# Use a fallback default, since this MUST be set.
683
priority = self.server.settings.get("priority", "NORMAL")
684
(gnutls.library.functions
685
.gnutls_priority_set_direct(session._c_object,
690
except gnutls.errors.GNUTLSError, error:
691
logger.warning(u"Handshake failed: %s", error)
692
# Do not run session.bye() here: the session is not
693
# established. Just abandon the request.
695
logger.debug(u"Handshake succeeded")
697
fpr = fingerprint(peer_certificate(session))
698
except (TypeError, gnutls.errors.GNUTLSError), error:
699
logger.warning(u"Bad certificate: %s", error)
702
logger.debug(u"Fingerprint: %s", fpr)
704
for c in self.server.clients:
705
if c.fingerprint == fpr:
709
logger.warning(u"Client not found for fingerprint: %s",
713
# Have to check if client.still_valid(), since it is possible
714
# that the client timed out while establishing the GnuTLS
716
if not client.still_valid():
717
logger.warning(u"Client %(name)s is invalid",
721
## This won't work here, since we're in a fork.
722
# client.checked_ok()
724
while sent_size < len(client.secret):
725
sent = session.send(client.secret[sent_size:])
726
logger.debug(u"Sent: %d, remaining: %d",
727
sent, len(client.secret)
728
- (sent_size + sent))
733
class IPv6_TCPServer(SocketServer.ForkingMixIn,
734
SocketServer.TCPServer, object):
735
"""IPv6 TCP server. Accepts 'None' as address and/or port.
737
settings: Server settings
738
clients: Set() of Client objects
1446
739
enabled: Boolean; whether this server is activated yet
1447
interface: None or a network interface name (string)
1448
use_ipv6: Boolean; to use IPv6 or not
1450
def __init__(self, server_address, RequestHandlerClass,
1451
interface=None, use_ipv6=True):
1452
self.interface = interface
1454
self.address_family = socket.AF_INET6
1455
socketserver.TCPServer.__init__(self, server_address,
1456
RequestHandlerClass)
741
address_family = socket.AF_INET6
742
def __init__(self, *args, **kwargs):
743
if "settings" in kwargs:
744
self.settings = kwargs["settings"]
745
del kwargs["settings"]
746
if "clients" in kwargs:
747
self.clients = kwargs["clients"]
748
del kwargs["clients"]
750
super(IPv6_TCPServer, self).__init__(*args, **kwargs)
1457
751
def server_bind(self):
1458
752
"""This overrides the normal server_bind() function
1459
753
to bind to an interface if one was specified, and also NOT to
1460
754
bind to an address or port if they were not specified."""
1461
if self.interface is not None:
1462
if SO_BINDTODEVICE is None:
1463
logger.error("SO_BINDTODEVICE does not exist;"
1464
" cannot bind to interface %s",
1468
self.socket.setsockopt(socket.SOL_SOCKET,
1472
except socket.error as error:
1473
if error[0] == errno.EPERM:
1474
logger.error("No permission to"
1475
" bind to interface %s",
1477
elif error[0] == errno.ENOPROTOOPT:
1478
logger.error("SO_BINDTODEVICE not available;"
1479
" cannot bind to interface %s",
755
if self.settings["interface"]:
756
# 25 is from /usr/include/asm-i486/socket.h
757
SO_BINDTODEVICE = getattr(socket, "SO_BINDTODEVICE", 25)
759
self.socket.setsockopt(socket.SOL_SOCKET,
761
self.settings["interface"])
762
except socket.error, error:
763
if error[0] == errno.EPERM:
764
logger.error(u"No permission to"
765
u" bind to interface %s",
766
self.settings["interface"])
1483
769
# Only bind(2) the socket if we really need to.
1484
770
if self.server_address[0] or self.server_address[1]:
1485
771
if not self.server_address[0]:
1486
if self.address_family == socket.AF_INET6:
1487
any_address = "::" # in6addr_any
1489
any_address = socket.INADDR_ANY
1490
self.server_address = (any_address,
773
self.server_address = (in6addr_any,
1491
774
self.server_address[1])
1492
775
elif not self.server_address[1]:
1493
776
self.server_address = (self.server_address[0],
1495
# if self.interface:
778
# if self.settings["interface"]:
1496
779
# self.server_address = (self.server_address[0],
1499
782
# if_nametoindex
1501
return socketserver.TCPServer.server_bind(self)
1504
class MandosServer(IPv6_TCPServer):
1508
clients: set of Client objects
1509
gnutls_priority GnuTLS priority string
1510
use_dbus: Boolean; to emit D-Bus signals or not
1512
Assumes a gobject.MainLoop event loop.
1514
def __init__(self, server_address, RequestHandlerClass,
1515
interface=None, use_ipv6=True, clients=None,
1516
gnutls_priority=None, use_dbus=True):
1517
self.enabled = False
1518
self.clients = clients
1519
if self.clients is None:
1520
self.clients = set()
1521
self.use_dbus = use_dbus
1522
self.gnutls_priority = gnutls_priority
1523
IPv6_TCPServer.__init__(self, server_address,
1524
RequestHandlerClass,
1525
interface = interface,
1526
use_ipv6 = use_ipv6)
785
return super(IPv6_TCPServer, self).server_bind()
1527
786
def server_activate(self):
1528
787
if self.enabled:
1529
return socketserver.TCPServer.server_activate(self)
788
return super(IPv6_TCPServer, self).server_activate()
1530
789
def enable(self):
1531
790
self.enabled = True
1532
def add_pipe(self, parent_pipe):
1533
# Call "handle_ipc" for both data and EOF events
1534
gobject.io_add_watch(parent_pipe.fileno(),
1535
gobject.IO_IN | gobject.IO_HUP,
1536
functools.partial(self.handle_ipc,
1537
parent_pipe = parent_pipe))
1539
def handle_ipc(self, source, condition, parent_pipe=None,
1540
client_object=None):
1542
gobject.IO_IN: "IN", # There is data to read.
1543
gobject.IO_OUT: "OUT", # Data can be written (without
1545
gobject.IO_PRI: "PRI", # There is urgent data to read.
1546
gobject.IO_ERR: "ERR", # Error condition.
1547
gobject.IO_HUP: "HUP" # Hung up (the connection has been
1548
# broken, usually for pipes and
1551
conditions_string = ' | '.join(name
1553
condition_names.iteritems()
1554
if cond & condition)
1555
# error or the other end of multiprocessing.Pipe has closed
1556
if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
1559
# Read a request from the child
1560
request = parent_pipe.recv()
1561
command = request[0]
1563
if command == 'init':
1565
address = request[2]
1567
for c in self.clients:
1568
if c.fingerprint == fpr:
1572
logger.warning("Client not found for fingerprint: %s, ad"
1573
"dress: %s", fpr, address)
1576
mandos_dbus_service.ClientNotFound(fpr, address[0])
1577
parent_pipe.send(False)
1580
gobject.io_add_watch(parent_pipe.fileno(),
1581
gobject.IO_IN | gobject.IO_HUP,
1582
functools.partial(self.handle_ipc,
1583
parent_pipe = parent_pipe,
1584
client_object = client))
1585
parent_pipe.send(True)
1586
# remove the old hook in favor of the new above hook on same fileno
1588
if command == 'funcall':
1589
funcname = request[1]
1593
parent_pipe.send(('data', getattr(client_object, funcname)(*args, **kwargs)))
1595
if command == 'getattr':
1596
attrname = request[1]
1597
if callable(client_object.__getattribute__(attrname)):
1598
parent_pipe.send(('function',))
1600
parent_pipe.send(('data', client_object.__getattribute__(attrname)))
1602
if command == 'setattr':
1603
attrname = request[1]
1605
setattr(client_object, attrname, value)
1610
793
def string_to_delta(interval):