117
98
class AvahiService(object):
118
"""An Avahi (Zeroconf) service.
121
100
interface: integer; avahi.IF_UNSPEC or an interface index.
122
101
Used to optionally bind to the specified interface.
123
name: string; Example: 'Mandos'
124
type: string; Example: '_mandos._tcp'.
125
See <http://www.dns-sd.org/ServiceTypes.html>
126
port: integer; what port to announce
127
TXT: list of strings; TXT record for the service
128
domain: string; Domain to publish on, default to .local if empty.
129
host: string; Host to publish records for, default is localhost
130
max_renames: integer; maximum number of renames
131
rename_count: integer; counter so we only rename after collisions
132
a sensible number of times
133
group: D-Bus Entry Group
135
bus: dbus.SystemBus()
102
name = string; Example: "Mandos"
103
type = string; Example: "_mandos._tcp".
104
See <http://www.dns-sd.org/ServiceTypes.html>
105
port = integer; what port to announce
106
TXT = list of strings; TXT record for the service
107
domain = string; Domain to publish on, default to .local if empty.
108
host = string; Host to publish records for, default to localhost
110
max_renames = integer; maximum number of renames
111
rename_count = integer; counter so we only rename after collisions
112
a sensible number of times
137
114
def __init__(self, interface = avahi.IF_UNSPEC, name = None,
138
servicetype = None, port = None, TXT = None,
139
domain = "", host = "", max_renames = 32768,
140
protocol = avahi.PROTO_UNSPEC, bus = None):
115
type = None, port = None, TXT = None, domain = "",
116
host = "", max_renames = 12):
117
"""An Avahi (Zeroconf) service. """
141
118
self.interface = interface
143
self.type = servicetype
145
self.TXT = TXT if TXT is not None else []
146
126
self.domain = domain
148
128
self.rename_count = 0
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
155
129
def rename(self):
156
130
"""Derived from the Avahi example code"""
157
131
if self.rename_count >= self.max_renames:
158
logger.critical("No suitable Zeroconf service name found"
159
" after %i retries, exiting.",
132
logger.critical(u"No suitable service name found after %i"
133
u" retries, exiting.", rename_count)
161
134
raise AvahiServiceError("Too many renames")
162
self.name = unicode(self.server.GetAlternativeServiceName(self.name))
163
logger.info("Changing Zeroconf service name to %r ...",
165
syslogger.setFormatter(logging.Formatter
166
('Mandos (%s) [%%(process)d]:'
167
' %%(levelname)s: %%(message)s'
135
name = server.GetAlternativeServiceName(name)
136
logger.notice(u"Changing name to %r ...", name)
172
except dbus.exceptions.DBusException as error:
173
logger.critical("DBusException: %s", error)
176
139
self.rename_count += 1
177
140
def remove(self):
178
141
"""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:
142
if group is not None:
185
145
"""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
def _timedelta_to_milliseconds(td):
268
"Convert a datetime.timedelta() to milliseconds"
269
return ((td.days * 24 * 60 * 60 * 1000)
270
+ (td.seconds * 1000)
271
+ (td.microseconds // 1000))
148
group = dbus.Interface\
149
(bus.get_object(avahi.DBUS_NAME,
150
server.EntryGroupNew()),
151
avahi.DBUS_INTERFACE_ENTRY_GROUP)
152
group.connect_to_signal('StateChanged',
153
entry_group_state_changed)
154
logger.debug(u"Adding service '%s' of type '%s' ...",
155
service.name, service.type)
157
self.interface, # interface
158
avahi.PROTO_INET6, # protocol
159
dbus.UInt32(0), # flags
160
self.name, self.type,
161
self.domain, self.host,
162
dbus.UInt16(self.port),
163
avahi.string_array_to_txt_array(self.TXT))
166
# From the Avahi example code:
167
group = None # our entry group
168
# End of Avahi example code
273
171
class Client(object):
274
172
"""A representation of a client host served by this server.
277
_approved: bool(); 'None' if not yet approved/disapproved
278
approval_delay: datetime.timedelta(); Time to wait for approval
279
approval_duration: datetime.timedelta(); Duration of one approval
280
checker: subprocess.Popen(); a running checker process used
281
to see if the client lives.
282
'None' if no process is running.
283
checker_callback_tag: a gobject event source tag, or None
284
checker_command: string; External command which is run to check
285
if client lives. %() expansions are done at
174
name: string; from the config file, used in log messages
175
fingerprint: string (40 or 32 hexadecimal digits); used to
176
uniquely identify the client
177
secret: bytestring; sent verbatim (over TLS) to client
178
fqdn: string (FQDN); available for use by the checker command
179
created: datetime.datetime(); object creation, not client host
180
last_checked_ok: datetime.datetime() or None if not yet checked OK
181
timeout: datetime.timedelta(); How long from last_checked_ok
182
until this client is invalid
183
interval: datetime.timedelta(); How often to start a new checker
184
stop_hook: If set, called by stop() as stop_hook(self)
185
checker: subprocess.Popen(); a running checker process used
186
to see if the client lives.
187
'None' if no process is running.
188
checker_initiator_tag: a gobject event source tag, or None
189
stop_initiator_tag: - '' -
190
checker_callback_tag: - '' -
191
checker_command: string; External command which is run to check if
192
client lives. %() expansions are done at
286
193
runtime with vars(self) as dict, so that for
287
194
instance %(name)s can be used in the command.
288
checker_initiator_tag: a gobject event source tag, or None
289
created: datetime.datetime(); (UTC) object creation
290
current_checker_command: string; current running checker_command
291
disable_hook: If set, called by disable() as disable_hook(self)
292
disable_initiator_tag: a gobject event source tag, or None
294
fingerprint: string (40 or 32 hexadecimal digits); used to
295
uniquely identify the client
296
host: string; available for use by the checker command
297
interval: datetime.timedelta(); How often to start a new checker
298
last_approval_request: datetime.datetime(); (UTC) or None
299
last_checked_ok: datetime.datetime(); (UTC) or None
300
last_enabled: datetime.datetime(); (UTC)
301
name: string; from the config file, used in log messages and
303
secret: bytestring; sent verbatim (over TLS) to client
304
timeout: datetime.timedelta(); How long from last_checked_ok
305
until this client is disabled
306
extended_timeout: extra long timeout when password has been sent
307
runtime_expansions: Allowed attributes for runtime expansion.
308
expires: datetime.datetime(); time (UTC) when a client will be
196
_timeout: Real variable for 'timeout'
197
_interval: Real variable for 'interval'
198
_timeout_milliseconds: Used when calling gobject.timeout_add()
199
_interval_milliseconds: - '' -
312
runtime_expansions = ("approval_delay", "approval_duration",
313
"created", "enabled", "fingerprint",
314
"host", "interval", "last_checked_ok",
315
"last_enabled", "name", "timeout")
317
def timeout_milliseconds(self):
318
"Return the 'timeout' attribute in milliseconds"
319
return _timedelta_to_milliseconds(self.timeout)
321
def extended_timeout_milliseconds(self):
322
"Return the 'extended_timeout' attribute in milliseconds"
323
return _timedelta_to_milliseconds(self.extended_timeout)
325
def interval_milliseconds(self):
326
"Return the 'interval' attribute in milliseconds"
327
return _timedelta_to_milliseconds(self.interval)
329
def approval_delay_milliseconds(self):
330
return _timedelta_to_milliseconds(self.approval_delay)
332
def __init__(self, name = None, disable_hook=None, config=None):
333
"""Note: the 'checker' key in 'config' sets the
334
'checker_command' attribute and *not* the 'checker'
201
def _set_timeout(self, timeout):
202
"Setter function for 'timeout' attribute"
203
self._timeout = timeout
204
self._timeout_milliseconds = ((self.timeout.days
205
* 24 * 60 * 60 * 1000)
206
+ (self.timeout.seconds * 1000)
207
+ (self.timeout.microseconds
209
timeout = property(lambda self: self._timeout,
212
def _set_interval(self, interval):
213
"Setter function for 'interval' attribute"
214
self._interval = interval
215
self._interval_milliseconds = ((self.interval.days
216
* 24 * 60 * 60 * 1000)
217
+ (self.interval.seconds
219
+ (self.interval.microseconds
221
interval = property(lambda self: self._interval,
224
def __init__(self, name=None, stop_hook=None, fingerprint=None,
225
secret=None, secfile=None, fqdn=None, timeout=None,
226
interval=-1, checker=None):
227
"""Note: the 'checker' argument sets the 'checker_command'
228
attribute and not the 'checker' attribute.."""
339
logger.debug("Creating client %r", self.name)
340
# Uppercase and remove spaces from fingerprint for later
341
# comparison purposes with return value from the fingerprint()
343
self.fingerprint = (config["fingerprint"].upper()
345
logger.debug(" Fingerprint: %s", self.fingerprint)
346
if "secret" in config:
347
self.secret = config["secret"].decode("base64")
348
elif "secfile" in config:
349
with open(os.path.expanduser(os.path.expandvars
350
(config["secfile"])),
352
self.secret = secfile.read()
230
logger.debug(u"Creating client %r", self.name)
231
# Uppercase and remove spaces from fingerprint
232
# for later comparison purposes with return value of
233
# the fingerprint() function
234
self.fingerprint = fingerprint.upper().replace(u" ", u"")
235
logger.debug(u" Fingerprint: %s", self.fingerprint)
237
self.secret = secret.decode(u"base64")
240
self.secret = sf.read()
354
raise TypeError("No secret or secfile for client %s"
243
raise TypeError(u"No secret or secfile for client %s"
356
self.host = config.get("host", "")
357
self.created = datetime.datetime.utcnow()
359
self.last_approval_request = None
360
self.last_enabled = None
246
self.created = datetime.datetime.now()
361
247
self.last_checked_ok = None
362
self.timeout = string_to_delta(config["timeout"])
363
self.extended_timeout = string_to_delta(config["extended_timeout"])
364
self.interval = string_to_delta(config["interval"])
365
self.disable_hook = disable_hook
248
self.timeout = string_to_delta(timeout)
249
self.interval = string_to_delta(interval)
250
self.stop_hook = stop_hook
366
251
self.checker = None
367
252
self.checker_initiator_tag = None
368
self.disable_initiator_tag = None
253
self.stop_initiator_tag = None
370
254
self.checker_callback_tag = None
371
self.checker_command = config["checker"]
372
self.current_checker_command = None
373
self.last_connect = None
374
self._approved = None
375
self.approved_by_default = config.get("approved_by_default",
377
self.approvals_pending = 0
378
self.approval_delay = string_to_delta(
379
config["approval_delay"])
380
self.approval_duration = string_to_delta(
381
config["approval_duration"])
382
self.changedstate = multiprocessing_manager.Condition(multiprocessing_manager.Lock())
384
def send_changedstate(self):
385
self.changedstate.acquire()
386
self.changedstate.notify_all()
387
self.changedstate.release()
255
self.check_command = checker
390
257
"""Start this client's checker and timeout hooks"""
391
if getattr(self, "enabled", False):
394
self.send_changedstate()
395
258
# Schedule a new checker to be started an 'interval' from now,
396
259
# and every interval from then on.
397
self.checker_initiator_tag = (gobject.timeout_add
398
(self.interval_milliseconds(),
400
# Schedule a disable() when 'timeout' has passed
401
self.expires = datetime.datetime.utcnow() + self.timeout
402
self.disable_initiator_tag = (gobject.timeout_add
403
(self.timeout_milliseconds(),
406
self.last_enabled = datetime.datetime.utcnow()
260
self.checker_initiator_tag = gobject.timeout_add\
261
(self._interval_milliseconds,
407
263
# Also start a new checker *right now*.
408
264
self.start_checker()
410
def disable(self, quiet=True):
411
"""Disable this client."""
412
if not getattr(self, "enabled", False):
265
# Schedule a stop() when 'timeout' has passed
266
self.stop_initiator_tag = gobject.timeout_add\
267
(self._timeout_milliseconds,
271
The possibility that a client might be restarted is left open,
272
but not currently used."""
273
# If this client doesn't have a secret, it is already stopped.
275
logger.debug(u"Stopping client %s", self.name)
415
self.send_changedstate()
417
logger.info("Disabling client %s", self.name)
418
if getattr(self, "disable_initiator_tag", False):
419
gobject.source_remove(self.disable_initiator_tag)
420
self.disable_initiator_tag = None
279
if getattr(self, "stop_initiator_tag", False):
280
gobject.source_remove(self.stop_initiator_tag)
281
self.stop_initiator_tag = None
422
282
if getattr(self, "checker_initiator_tag", False):
423
283
gobject.source_remove(self.checker_initiator_tag)
424
284
self.checker_initiator_tag = None
425
285
self.stop_checker()
426
if self.disable_hook:
427
self.disable_hook(self)
429
288
# Do not run this again if called by a gobject.timeout_add
432
290
def __del__(self):
433
self.disable_hook = None
436
def checker_callback(self, pid, condition, command):
291
self.stop_hook = None
293
def checker_callback(self, pid, condition):
437
294
"""The checker has completed, so take appropriate actions."""
295
now = datetime.datetime.now()
438
296
self.checker_callback_tag = None
439
297
self.checker = None
440
if os.WIFEXITED(condition):
441
exitstatus = os.WEXITSTATUS(condition)
443
logger.info("Checker for %(name)s succeeded",
447
logger.info("Checker for %(name)s failed",
450
logger.warning("Checker for %(name)s crashed?",
298
if os.WIFEXITED(condition) \
299
and (os.WEXITSTATUS(condition) == 0):
300
logger.debug(u"Checker for %(name)s succeeded",
302
self.last_checked_ok = now
303
gobject.source_remove(self.stop_initiator_tag)
304
self.stop_initiator_tag = gobject.timeout_add\
305
(self._timeout_milliseconds,
307
elif not os.WIFEXITED(condition):
308
logger.warning(u"Checker for %(name)s crashed?",
453
def checked_ok(self, timeout=None):
454
"""Bump up the timeout for this client.
456
This should only be called when the client has been seen,
460
timeout = self.timeout
461
self.last_checked_ok = datetime.datetime.utcnow()
462
gobject.source_remove(self.disable_initiator_tag)
463
self.expires = datetime.datetime.utcnow() + timeout
464
self.disable_initiator_tag = (gobject.timeout_add
465
(_timedelta_to_milliseconds(timeout),
468
def need_approval(self):
469
self.last_approval_request = datetime.datetime.utcnow()
311
logger.debug(u"Checker for %(name)s failed",
471
313
def start_checker(self):
472
314
"""Start a new checker subprocess if one is not running.
474
315
If a checker already exists, leave it running and do
476
317
# The reason for not killing a running checker is that if we
553
361
logger.debug("Stopping checker for %(name)s", vars(self))
555
363
os.kill(self.checker.pid, signal.SIGTERM)
557
365
#if self.checker.poll() is None:
558
366
# os.kill(self.checker.pid, signal.SIGKILL)
559
except OSError as error:
367
except OSError, error:
560
368
if error.errno != errno.ESRCH: # No such process
562
370
self.checker = None
564
def dbus_service_property(dbus_interface, signature="v",
565
access="readwrite", byte_arrays=False):
566
"""Decorators for marking methods of a DBusObjectWithProperties to
567
become properties on the D-Bus.
569
The decorated method will be called with no arguments by "Get"
570
and with one argument by "Set".
572
The parameters, where they are supported, are the same as
573
dbus.service.method, except there is only "signature", since the
574
type from Get() and the type sent to Set() is the same.
576
# Encoding deeply encoded byte arrays is not supported yet by the
577
# "Set" method, so we fail early here:
578
if byte_arrays and signature != "ay":
579
raise ValueError("Byte arrays not supported for non-'ay'"
580
" signature %r" % signature)
582
func._dbus_is_property = True
583
func._dbus_interface = dbus_interface
584
func._dbus_signature = signature
585
func._dbus_access = access
586
func._dbus_name = func.__name__
587
if func._dbus_name.endswith("_dbus_property"):
588
func._dbus_name = func._dbus_name[:-14]
589
func._dbus_get_args_options = {'byte_arrays': byte_arrays }
594
class DBusPropertyException(dbus.exceptions.DBusException):
595
"""A base class for D-Bus property-related exceptions
597
def __unicode__(self):
598
return unicode(str(self))
601
class DBusPropertyAccessException(DBusPropertyException):
602
"""A property's access permissions disallows an operation.
607
class DBusPropertyNotFound(DBusPropertyException):
608
"""An attempt was made to access a non-existing property.
613
class DBusObjectWithProperties(dbus.service.Object):
614
"""A D-Bus object with properties.
616
Classes inheriting from this can use the dbus_service_property
617
decorator to expose methods as D-Bus properties. It exposes the
618
standard Get(), Set(), and GetAll() methods on the D-Bus.
622
def _is_dbus_property(obj):
623
return getattr(obj, "_dbus_is_property", False)
625
def _get_all_dbus_properties(self):
626
"""Returns a generator of (name, attribute) pairs
628
return ((prop._dbus_name, prop)
630
inspect.getmembers(self, self._is_dbus_property))
632
def _get_dbus_property(self, interface_name, property_name):
633
"""Returns a bound method if one exists which is a D-Bus
634
property with the specified name and interface.
636
for name in (property_name,
637
property_name + "_dbus_property"):
638
prop = getattr(self, name, None)
640
or not self._is_dbus_property(prop)
641
or prop._dbus_name != property_name
642
or (interface_name and prop._dbus_interface
643
and interface_name != prop._dbus_interface)):
647
raise DBusPropertyNotFound(self.dbus_object_path + ":"
648
+ interface_name + "."
651
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
653
def Get(self, interface_name, property_name):
654
"""Standard D-Bus property Get() method, see D-Bus standard.
656
prop = self._get_dbus_property(interface_name, property_name)
657
if prop._dbus_access == "write":
658
raise DBusPropertyAccessException(property_name)
660
if not hasattr(value, "variant_level"):
662
return type(value)(value, variant_level=value.variant_level+1)
664
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
665
def Set(self, interface_name, property_name, value):
666
"""Standard D-Bus property Set() method, see D-Bus standard.
668
prop = self._get_dbus_property(interface_name, property_name)
669
if prop._dbus_access == "read":
670
raise DBusPropertyAccessException(property_name)
671
if prop._dbus_get_args_options["byte_arrays"]:
672
# The byte_arrays option is not supported yet on
673
# signatures other than "ay".
674
if prop._dbus_signature != "ay":
676
value = dbus.ByteArray(''.join(unichr(byte)
680
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
681
out_signature="a{sv}")
682
def GetAll(self, interface_name):
683
"""Standard D-Bus property GetAll() method, see D-Bus
686
Note: Will not include properties with access="write".
689
for name, prop in self._get_all_dbus_properties():
691
and interface_name != prop._dbus_interface):
692
# Interface non-empty but did not match
694
# Ignore write-only properties
695
if prop._dbus_access == "write":
698
if not hasattr(value, "variant_level"):
701
all[name] = type(value)(value, variant_level=
702
value.variant_level+1)
703
return dbus.Dictionary(all, signature="sv")
705
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
707
path_keyword='object_path',
708
connection_keyword='connection')
709
def Introspect(self, object_path, connection):
710
"""Standard D-Bus method, overloaded to insert property tags.
712
xmlstring = dbus.service.Object.Introspect(self, object_path,
715
document = xml.dom.minidom.parseString(xmlstring)
716
def make_tag(document, name, prop):
717
e = document.createElement("property")
718
e.setAttribute("name", name)
719
e.setAttribute("type", prop._dbus_signature)
720
e.setAttribute("access", prop._dbus_access)
722
for if_tag in document.getElementsByTagName("interface"):
723
for tag in (make_tag(document, name, prop)
725
in self._get_all_dbus_properties()
726
if prop._dbus_interface
727
== if_tag.getAttribute("name")):
728
if_tag.appendChild(tag)
729
# Add the names to the return values for the
730
# "org.freedesktop.DBus.Properties" methods
731
if (if_tag.getAttribute("name")
732
== "org.freedesktop.DBus.Properties"):
733
for cn in if_tag.getElementsByTagName("method"):
734
if cn.getAttribute("name") == "Get":
735
for arg in cn.getElementsByTagName("arg"):
736
if (arg.getAttribute("direction")
738
arg.setAttribute("name", "value")
739
elif cn.getAttribute("name") == "GetAll":
740
for arg in cn.getElementsByTagName("arg"):
741
if (arg.getAttribute("direction")
743
arg.setAttribute("name", "props")
744
xmlstring = document.toxml("utf-8")
746
except (AttributeError, xml.dom.DOMException,
747
xml.parsers.expat.ExpatError) as error:
748
logger.error("Failed to override Introspection method",
753
def datetime_to_dbus (dt, variant_level=0):
754
"""Convert a UTC datetime.datetime() to a D-Bus type."""
756
return dbus.String("", variant_level = variant_level)
757
return dbus.String(dt.isoformat(),
758
variant_level=variant_level)
760
class ClientDBus(Client, DBusObjectWithProperties):
761
"""A Client class using D-Bus
764
dbus_object_path: dbus.ObjectPath
765
bus: dbus.SystemBus()
768
runtime_expansions = (Client.runtime_expansions
769
+ ("dbus_object_path",))
771
# dbus.service.Object doesn't use super(), so we can't either.
773
def __init__(self, bus = None, *args, **kwargs):
774
self._approvals_pending = 0
776
Client.__init__(self, *args, **kwargs)
777
# Only now, when this client is initialized, can it show up on
779
client_object_name = unicode(self.name).translate(
782
self.dbus_object_path = (dbus.ObjectPath
783
("/clients/" + client_object_name))
784
DBusObjectWithProperties.__init__(self, self.bus,
785
self.dbus_object_path)
787
def notifychangeproperty(transform_func,
788
dbus_name, type_func=lambda x: x,
790
""" Modify a variable so that its a property that announce its
792
transform_fun: Function that takes a value and transform it to
794
dbus_name: DBus name of the variable
795
type_func: Function that transform the value before sending it
797
variant_level: DBus variant level. default: 1
800
def setter(self, value):
801
old_value = real_value[0]
802
real_value[0] = value
803
if hasattr(self, "dbus_object_path"):
804
if type_func(old_value) != type_func(real_value[0]):
805
dbus_value = transform_func(type_func(real_value[0]),
807
self.PropertyChanged(dbus.String(dbus_name),
810
return property(lambda self: real_value[0], setter)
813
expires = notifychangeproperty(datetime_to_dbus, "Expires")
814
approvals_pending = notifychangeproperty(dbus.Boolean,
817
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
818
last_enabled = notifychangeproperty(datetime_to_dbus,
820
checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
821
type_func = lambda checker: checker is not None)
822
last_checked_ok = notifychangeproperty(datetime_to_dbus,
824
last_approval_request = notifychangeproperty(datetime_to_dbus,
825
"LastApprovalRequest")
826
approved_by_default = notifychangeproperty(dbus.Boolean,
828
approval_delay = notifychangeproperty(dbus.UInt16, "ApprovalDelay",
829
type_func = _timedelta_to_milliseconds)
830
approval_duration = notifychangeproperty(dbus.UInt16, "ApprovalDuration",
831
type_func = _timedelta_to_milliseconds)
832
host = notifychangeproperty(dbus.String, "Host")
833
timeout = notifychangeproperty(dbus.UInt16, "Timeout",
834
type_func = _timedelta_to_milliseconds)
835
extended_timeout = notifychangeproperty(dbus.UInt16, "ExtendedTimeout",
836
type_func = _timedelta_to_milliseconds)
837
interval = notifychangeproperty(dbus.UInt16, "Interval",
838
type_func = _timedelta_to_milliseconds)
839
checker_command = notifychangeproperty(dbus.String, "Checker")
841
del notifychangeproperty
843
def __del__(self, *args, **kwargs):
845
self.remove_from_connection()
848
if hasattr(DBusObjectWithProperties, "__del__"):
849
DBusObjectWithProperties.__del__(self, *args, **kwargs)
850
Client.__del__(self, *args, **kwargs)
852
def checker_callback(self, pid, condition, command,
854
self.checker_callback_tag = None
856
if os.WIFEXITED(condition):
857
exitstatus = os.WEXITSTATUS(condition)
859
self.CheckerCompleted(dbus.Int16(exitstatus),
860
dbus.Int64(condition),
861
dbus.String(command))
864
self.CheckerCompleted(dbus.Int16(-1),
865
dbus.Int64(condition),
866
dbus.String(command))
868
return Client.checker_callback(self, pid, condition, command,
871
def start_checker(self, *args, **kwargs):
872
old_checker = self.checker
873
if self.checker is not None:
874
old_checker_pid = self.checker.pid
876
old_checker_pid = None
877
r = Client.start_checker(self, *args, **kwargs)
878
# Only if new checker process was started
879
if (self.checker is not None
880
and old_checker_pid != self.checker.pid):
882
self.CheckerStarted(self.current_checker_command)
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(_timedelta_to_milliseconds
893
(self.approval_duration),
894
self._reset_approved)
897
## D-Bus methods, signals & properties
898
_interface = "se.bsnet.fukt.Mandos.Client"
902
# CheckerCompleted - signal
903
@dbus.service.signal(_interface, signature="nxs")
904
def CheckerCompleted(self, exitcode, waitstatus, command):
908
# CheckerStarted - signal
909
@dbus.service.signal(_interface, signature="s")
910
def CheckerStarted(self, command):
914
# PropertyChanged - signal
915
@dbus.service.signal(_interface, signature="sv")
916
def PropertyChanged(self, property, value):
921
@dbus.service.signal(_interface)
924
Is sent after a successful transfer of secret from the Mandos
925
server to mandos-client
930
@dbus.service.signal(_interface, signature="s")
931
def Rejected(self, reason):
935
# NeedApproval - signal
936
@dbus.service.signal(_interface, signature="tb")
937
def NeedApproval(self, timeout, default):
939
return self.need_approval()
944
@dbus.service.method(_interface, in_signature="b")
945
def Approve(self, value):
949
@dbus.service.method(_interface)
954
@dbus.service.method(_interface)
959
# StartChecker - method
960
@dbus.service.method(_interface)
961
def StartChecker(self):
966
@dbus.service.method(_interface)
971
# 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
# ApprovalDelay - property
992
@dbus_service_property(_interface, signature="t",
994
def ApprovalDelay_dbus_property(self, value=None):
995
if value is None: # get
996
return dbus.UInt64(self.approval_delay_milliseconds())
997
self.approval_delay = datetime.timedelta(0, 0, 0, value)
999
# ApprovalDuration - property
1000
@dbus_service_property(_interface, signature="t",
1002
def ApprovalDuration_dbus_property(self, value=None):
1003
if value is None: # get
1004
return dbus.UInt64(_timedelta_to_milliseconds(
1005
self.approval_duration))
1006
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1009
@dbus_service_property(_interface, signature="s", access="read")
1010
def Name_dbus_property(self):
1011
return dbus.String(self.name)
1013
# Fingerprint - property
1014
@dbus_service_property(_interface, signature="s", access="read")
1015
def Fingerprint_dbus_property(self):
1016
return dbus.String(self.fingerprint)
1019
@dbus_service_property(_interface, signature="s",
1021
def Host_dbus_property(self, value=None):
1022
if value is None: # get
1023
return dbus.String(self.host)
1026
# Created - property
1027
@dbus_service_property(_interface, signature="s", access="read")
1028
def Created_dbus_property(self):
1029
return dbus.String(datetime_to_dbus(self.created))
1031
# LastEnabled - property
1032
@dbus_service_property(_interface, signature="s", access="read")
1033
def LastEnabled_dbus_property(self):
1034
return datetime_to_dbus(self.last_enabled)
1036
# Enabled - property
1037
@dbus_service_property(_interface, signature="b",
1039
def Enabled_dbus_property(self, value=None):
1040
if value is None: # get
1041
return dbus.Boolean(self.enabled)
1047
# LastCheckedOK - property
1048
@dbus_service_property(_interface, signature="s",
1050
def LastCheckedOK_dbus_property(self, value=None):
1051
if value is not None:
1054
return datetime_to_dbus(self.last_checked_ok)
1056
# Expires - property
1057
@dbus_service_property(_interface, signature="s", access="read")
1058
def Expires_dbus_property(self):
1059
return datetime_to_dbus(self.expires)
1061
# LastApprovalRequest - property
1062
@dbus_service_property(_interface, signature="s", access="read")
1063
def LastApprovalRequest_dbus_property(self):
1064
return datetime_to_dbus(self.last_approval_request)
1066
# Timeout - property
1067
@dbus_service_property(_interface, signature="t",
1069
def Timeout_dbus_property(self, value=None):
1070
if value is None: # get
1071
return dbus.UInt64(self.timeout_milliseconds())
1072
self.timeout = datetime.timedelta(0, 0, 0, value)
1073
if getattr(self, "disable_initiator_tag", None) is None:
1075
# Reschedule timeout
1076
gobject.source_remove(self.disable_initiator_tag)
1077
self.disable_initiator_tag = None
1079
time_to_die = (self.
1080
_timedelta_to_milliseconds((self
1085
if time_to_die <= 0:
1086
# The timeout has passed
1089
self.expires = (datetime.datetime.utcnow()
1090
+ datetime.timedelta(milliseconds = time_to_die))
1091
self.disable_initiator_tag = (gobject.timeout_add
1092
(time_to_die, self.disable))
1094
# ExtendedTimeout - property
1095
@dbus_service_property(_interface, signature="t",
1097
def ExtendedTimeout_dbus_property(self, value=None):
1098
if value is None: # get
1099
return dbus.UInt64(self.extended_timeout_milliseconds())
1100
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
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)
1109
if getattr(self, "checker_initiator_tag", None) is None:
1111
# Reschedule checker run
1112
gobject.source_remove(self.checker_initiator_tag)
1113
self.checker_initiator_tag = (gobject.timeout_add
1114
(value, self.start_checker))
1115
self.start_checker() # Start one now, too
1117
# Checker - property
1118
@dbus_service_property(_interface, signature="s",
1120
def Checker_dbus_property(self, value=None):
1121
if value is None: # get
1122
return dbus.String(self.checker_command)
1123
self.checker_command = value
1125
# CheckerRunning - property
1126
@dbus_service_property(_interface, signature="b",
1128
def CheckerRunning_dbus_property(self, value=None):
1129
if value is None: # get
1130
return dbus.Boolean(self.checker is not None)
1132
self.start_checker()
1136
# ObjectPath - property
1137
@dbus_service_property(_interface, signature="o", access="read")
1138
def ObjectPath_dbus_property(self):
1139
return self.dbus_object_path # is already a dbus.ObjectPath
1142
@dbus_service_property(_interface, signature="ay",
1143
access="write", byte_arrays=True)
1144
def Secret_dbus_property(self, value):
1145
self.secret = str(value)
1150
class ProxyClient(object):
1151
def __init__(self, child_pipe, fpr, address):
1152
self._pipe = child_pipe
1153
self._pipe.send(('init', fpr, address))
1154
if not self._pipe.recv():
1157
def __getattribute__(self, name):
1158
if(name == '_pipe'):
1159
return super(ProxyClient, self).__getattribute__(name)
1160
self._pipe.send(('getattr', name))
1161
data = self._pipe.recv()
1162
if data[0] == 'data':
1164
if data[0] == 'function':
1165
def func(*args, **kwargs):
1166
self._pipe.send(('funcall', name, args, kwargs))
1167
return self._pipe.recv()[1]
1170
def __setattr__(self, name, value):
1171
if(name == '_pipe'):
1172
return super(ProxyClient, self).__setattr__(name, value)
1173
self._pipe.send(('setattr', name, value))
1176
class ClientHandler(socketserver.BaseRequestHandler, object):
1177
"""A class to handle client connections.
1179
Instantiated once for each connection to handle it.
371
def still_valid(self):
372
"""Has the timeout not yet passed for this client?"""
373
now = datetime.datetime.now()
374
if self.last_checked_ok is None:
375
return now < (self.created + self.timeout)
377
return now < (self.last_checked_ok + self.timeout)
380
def peer_certificate(session):
381
"Return the peer's OpenPGP certificate as a bytestring"
382
# If not an OpenPGP certificate...
383
if gnutls.library.functions.gnutls_certificate_type_get\
384
(session._c_object) \
385
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP:
386
# ...do the normal thing
387
return session.peer_certificate
388
list_size = ctypes.c_uint()
389
cert_list = gnutls.library.functions.gnutls_certificate_get_peers\
390
(session._c_object, ctypes.byref(list_size))
391
if list_size.value == 0:
394
return ctypes.string_at(cert.data, cert.size)
397
def fingerprint(openpgp):
398
"Convert an OpenPGP bytestring to a hexdigit fingerprint string"
399
# New empty GnuTLS certificate
400
crt = gnutls.library.types.gnutls_openpgp_crt_t()
401
gnutls.library.functions.gnutls_openpgp_crt_init\
403
# New GnuTLS "datum" with the OpenPGP public key
404
datum = gnutls.library.types.gnutls_datum_t\
405
(ctypes.cast(ctypes.c_char_p(openpgp),
406
ctypes.POINTER(ctypes.c_ubyte)),
407
ctypes.c_uint(len(openpgp)))
408
# Import the OpenPGP public key into the certificate
409
ret = gnutls.library.functions.gnutls_openpgp_crt_import\
412
gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
413
# New buffer for the fingerprint
414
buffer = ctypes.create_string_buffer(20)
415
buffer_length = ctypes.c_size_t()
416
# Get the fingerprint from the certificate into the buffer
417
gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint\
418
(crt, ctypes.byref(buffer), ctypes.byref(buffer_length))
419
# Deinit the certificate
420
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
421
# Convert the buffer to a Python bytestring
422
fpr = ctypes.string_at(buffer, buffer_length.value)
423
# Convert the bytestring to hexadecimal notation
424
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
428
class tcp_handler(SocketServer.BaseRequestHandler, object):
429
"""A TCP request handler class.
430
Instantiated by IPv6_TCPServer for each request to handle it.
1180
431
Note: This will run in its own forked process."""
1182
433
def handle(self):
1183
with contextlib.closing(self.server.child_pipe) as child_pipe:
1184
logger.info("TCP connection from: %s",
1185
unicode(self.client_address))
1186
logger.debug("Pipe FD: %d",
1187
self.server.child_pipe.fileno())
1189
session = (gnutls.connection
1190
.ClientSession(self.request,
1192
.X509Credentials()))
1194
# Note: gnutls.connection.X509Credentials is really a
1195
# generic GnuTLS certificate credentials object so long as
1196
# no X.509 keys are added to it. Therefore, we can use it
1197
# here despite using OpenPGP certificates.
1199
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1200
# "+AES-256-CBC", "+SHA1",
1201
# "+COMP-NULL", "+CTYPE-OPENPGP",
1203
# Use a fallback default, since this MUST be set.
1204
priority = self.server.gnutls_priority
1205
if priority is None:
1207
(gnutls.library.functions
1208
.gnutls_priority_set_direct(session._c_object,
1211
# Start communication using the Mandos protocol
1212
# Get protocol number
1213
line = self.request.makefile().readline()
1214
logger.debug("Protocol version: %r", line)
1216
if int(line.strip().split()[0]) > 1:
1218
except (ValueError, IndexError, RuntimeError) as error:
1219
logger.error("Unknown protocol version: %s", error)
1222
# Start GnuTLS connection
1225
except gnutls.errors.GNUTLSError as error:
1226
logger.warning("Handshake failed: %s", error)
1227
# Do not run session.bye() here: the session is not
1228
# established. Just abandon the request.
1230
logger.debug("Handshake succeeded")
1232
approval_required = False
1235
fpr = self.fingerprint(self.peer_certificate
1238
gnutls.errors.GNUTLSError) as error:
1239
logger.warning("Bad certificate: %s", error)
1241
logger.debug("Fingerprint: %s", fpr)
1244
client = ProxyClient(child_pipe, fpr,
1245
self.client_address)
1249
if client.approval_delay:
1250
delay = client.approval_delay
1251
client.approvals_pending += 1
1252
approval_required = True
1255
if not client.enabled:
1256
logger.info("Client %s is disabled",
1258
if self.server.use_dbus:
1260
client.Rejected("Disabled")
1263
if client._approved or not client.approval_delay:
1264
#We are approved or approval is disabled
1266
elif client._approved is None:
1267
logger.info("Client %s needs approval",
1269
if self.server.use_dbus:
1271
client.NeedApproval(
1272
client.approval_delay_milliseconds(),
1273
client.approved_by_default)
1275
logger.warning("Client %s was not approved",
1277
if self.server.use_dbus:
1279
client.Rejected("Denied")
1282
#wait until timeout or approved
1283
#x = float(client._timedelta_to_milliseconds(delay))
1284
time = datetime.datetime.now()
1285
client.changedstate.acquire()
1286
client.changedstate.wait(float(client._timedelta_to_milliseconds(delay) / 1000))
1287
client.changedstate.release()
1288
time2 = datetime.datetime.now()
1289
if (time2 - time) >= delay:
1290
if not client.approved_by_default:
1291
logger.warning("Client %s timed out while"
1292
" waiting for approval",
1294
if self.server.use_dbus:
1296
client.Rejected("Approval timed out")
1301
delay -= time2 - time
1304
while sent_size < len(client.secret):
1306
sent = session.send(client.secret[sent_size:])
1307
except gnutls.errors.GNUTLSError as error:
1308
logger.warning("gnutls send failed")
1310
logger.debug("Sent: %d, remaining: %d",
1311
sent, len(client.secret)
1312
- (sent_size + sent))
1315
logger.info("Sending secret to %s", client.name)
1316
# bump the timeout as if seen
1317
client.checked_ok(client.extended_timeout)
1318
if self.server.use_dbus:
1323
if approval_required:
1324
client.approvals_pending -= 1
1327
except gnutls.errors.GNUTLSError as error:
1328
logger.warning("GnuTLS bye failed")
1331
def peer_certificate(session):
1332
"Return the peer's OpenPGP certificate as a bytestring"
1333
# If not an OpenPGP certificate...
1334
if (gnutls.library.functions
1335
.gnutls_certificate_type_get(session._c_object)
1336
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1337
# ...do the normal thing
1338
return session.peer_certificate
1339
list_size = ctypes.c_uint(1)
1340
cert_list = (gnutls.library.functions
1341
.gnutls_certificate_get_peers
1342
(session._c_object, ctypes.byref(list_size)))
1343
if not bool(cert_list) and list_size.value != 0:
1344
raise gnutls.errors.GNUTLSError("error getting peer"
1346
if list_size.value == 0:
1349
return ctypes.string_at(cert.data, cert.size)
1352
def fingerprint(openpgp):
1353
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
1354
# New GnuTLS "datum" with the OpenPGP public key
1355
datum = (gnutls.library.types
1356
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1359
ctypes.c_uint(len(openpgp))))
1360
# New empty GnuTLS certificate
1361
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1362
(gnutls.library.functions
1363
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
1364
# Import the OpenPGP public key into the certificate
1365
(gnutls.library.functions
1366
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1367
gnutls.library.constants
1368
.GNUTLS_OPENPGP_FMT_RAW))
1369
# Verify the self signature in the key
1370
crtverify = ctypes.c_uint()
1371
(gnutls.library.functions
1372
.gnutls_openpgp_crt_verify_self(crt, 0,
1373
ctypes.byref(crtverify)))
1374
if crtverify.value != 0:
1375
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1376
raise (gnutls.errors.CertificateSecurityError
1378
# New buffer for the fingerprint
1379
buf = ctypes.create_string_buffer(20)
1380
buf_len = ctypes.c_size_t()
1381
# Get the fingerprint from the certificate into the buffer
1382
(gnutls.library.functions
1383
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1384
ctypes.byref(buf_len)))
1385
# Deinit the certificate
1386
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1387
# Convert the buffer to a Python bytestring
1388
fpr = ctypes.string_at(buf, buf_len.value)
1389
# Convert the bytestring to hexadecimal notation
1390
hex_fpr = ''.join("%02X" % ord(char) for char in fpr)
1394
class MultiprocessingMixIn(object):
1395
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
1396
def sub_process_main(self, request, address):
1398
self.finish_request(request, address)
1400
self.handle_error(request, address)
1401
self.close_request(request)
1403
def process_request(self, request, address):
1404
"""Start a new process to process the request."""
1405
multiprocessing.Process(target = self.sub_process_main,
1406
args = (request, address)).start()
1408
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1409
""" adds a pipe to the MixIn """
1410
def process_request(self, request, client_address):
1411
"""Overrides and wraps the original process_request().
1413
This function creates a new pipe in self.pipe
1415
parent_pipe, self.child_pipe = multiprocessing.Pipe()
1417
super(MultiprocessingMixInWithPipe,
1418
self).process_request(request, client_address)
1419
self.child_pipe.close()
1420
self.add_pipe(parent_pipe)
1422
def add_pipe(self, parent_pipe):
1423
"""Dummy function; override as necessary"""
1424
raise NotImplementedError
1426
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1427
socketserver.TCPServer, object):
1428
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
434
logger.debug(u"TCP connection from: %s",
435
unicode(self.client_address))
437
line = self.request.makefile().readline()
438
logger.debug(u"Protocol version: %r", line)
440
if int(line.strip().split()[0]) > 1:
442
except (ValueError, IndexError, RuntimeError), error:
443
logger.error(u"Unknown protocol version: %s", error)
446
session = gnutls.connection.ClientSession\
447
(self.request, gnutls.connection.X509Credentials())
448
# Note: gnutls.connection.X509Credentials is really a generic
449
# GnuTLS certificate credentials object so long as no X.509
450
# keys are added to it. Therefore, we can use it here despite
451
# using OpenPGP certificates.
453
#priority = ':'.join(("NONE", "+VERS-TLS1.1", "+AES-256-CBC",
454
# "+SHA1", "+COMP-NULL", "+CTYPE-OPENPGP",
456
priority = "NORMAL" # Fallback default, since this
458
if self.server.settings["priority"]:
459
priority = self.server.settings["priority"]
460
gnutls.library.functions.gnutls_priority_set_direct\
461
(session._c_object, priority, None);
465
except gnutls.errors.GNUTLSError, error:
466
logger.debug(u"Handshake failed: %s", error)
467
# Do not run session.bye() here: the session is not
468
# established. Just abandon the request.
471
fpr = fingerprint(peer_certificate(session))
472
except (TypeError, gnutls.errors.GNUTLSError), error:
473
logger.debug(u"Bad certificate: %s", error)
476
logger.debug(u"Fingerprint: %s", fpr)
478
for c in self.server.clients:
479
if c.fingerprint == fpr:
483
logger.debug(u"Client not found for fingerprint: %s", fpr)
486
# Have to check if client.still_valid(), since it is possible
487
# that the client timed out while establishing the GnuTLS
489
if not client.still_valid():
490
logger.debug(u"Client %(name)s is invalid", vars(client))
494
while sent_size < len(client.secret):
495
sent = session.send(client.secret[sent_size:])
496
logger.debug(u"Sent: %d, remaining: %d",
497
sent, len(client.secret)
498
- (sent_size + sent))
503
class IPv6_TCPServer(SocketServer.ForkingTCPServer, object):
504
"""IPv6 TCP server. Accepts 'None' as address and/or port.
1431
enabled: Boolean; whether this server is activated yet
1432
interface: None or a network interface name (string)
1433
use_ipv6: Boolean; to use IPv6 or not
506
settings: Server settings
507
clients: Set() of Client objects
1435
def __init__(self, server_address, RequestHandlerClass,
1436
interface=None, use_ipv6=True):
1437
self.interface = interface
1439
self.address_family = socket.AF_INET6
1440
socketserver.TCPServer.__init__(self, server_address,
1441
RequestHandlerClass)
509
address_family = socket.AF_INET6
510
def __init__(self, *args, **kwargs):
511
if "settings" in kwargs:
512
self.settings = kwargs["settings"]
513
del kwargs["settings"]
514
if "clients" in kwargs:
515
self.clients = kwargs["clients"]
516
del kwargs["clients"]
517
return super(type(self), self).__init__(*args, **kwargs)
1442
518
def server_bind(self):
1443
519
"""This overrides the normal server_bind() function
1444
520
to bind to an interface if one was specified, and also NOT to
1445
521
bind to an address or port if they were not specified."""
1446
if self.interface is not None:
1447
if SO_BINDTODEVICE is None:
1448
logger.error("SO_BINDTODEVICE does not exist;"
1449
" cannot bind to interface %s",
1453
self.socket.setsockopt(socket.SOL_SOCKET,
1457
except socket.error as error:
1458
if error[0] == errno.EPERM:
1459
logger.error("No permission to"
1460
" bind to interface %s",
1462
elif error[0] == errno.ENOPROTOOPT:
1463
logger.error("SO_BINDTODEVICE not available;"
1464
" cannot bind to interface %s",
522
if self.settings["interface"]:
523
# 25 is from /usr/include/asm-i486/socket.h
524
SO_BINDTODEVICE = getattr(socket, "SO_BINDTODEVICE", 25)
526
self.socket.setsockopt(socket.SOL_SOCKET,
528
self.settings["interface"])
529
except socket.error, error:
530
if error[0] == errno.EPERM:
531
logger.warning(u"No permission to"
532
u" bind to interface %s",
533
self.settings["interface"])
1468
536
# Only bind(2) the socket if we really need to.
1469
537
if self.server_address[0] or self.server_address[1]:
1470
538
if not self.server_address[0]:
1471
if self.address_family == socket.AF_INET6:
1472
any_address = "::" # in6addr_any
1474
any_address = socket.INADDR_ANY
1475
self.server_address = (any_address,
540
self.server_address = (in6addr_any,
1476
541
self.server_address[1])
1477
elif not self.server_address[1]:
542
elif self.server_address[1] is None:
1478
543
self.server_address = (self.server_address[0],
1480
# if self.interface:
1481
# self.server_address = (self.server_address[0],
1486
return socketserver.TCPServer.server_bind(self)
1489
class MandosServer(IPv6_TCPServer):
1493
clients: set of Client objects
1494
gnutls_priority GnuTLS priority string
1495
use_dbus: Boolean; to emit D-Bus signals or not
1497
Assumes a gobject.MainLoop event loop.
1499
def __init__(self, server_address, RequestHandlerClass,
1500
interface=None, use_ipv6=True, clients=None,
1501
gnutls_priority=None, use_dbus=True):
1502
self.enabled = False
1503
self.clients = clients
1504
if self.clients is None:
1505
self.clients = set()
1506
self.use_dbus = use_dbus
1507
self.gnutls_priority = gnutls_priority
1508
IPv6_TCPServer.__init__(self, server_address,
1509
RequestHandlerClass,
1510
interface = interface,
1511
use_ipv6 = use_ipv6)
1512
def server_activate(self):
1514
return socketserver.TCPServer.server_activate(self)
1517
def add_pipe(self, parent_pipe):
1518
# Call "handle_ipc" for both data and EOF events
1519
gobject.io_add_watch(parent_pipe.fileno(),
1520
gobject.IO_IN | gobject.IO_HUP,
1521
functools.partial(self.handle_ipc,
1522
parent_pipe = parent_pipe))
1524
def handle_ipc(self, source, condition, parent_pipe=None,
1525
client_object=None):
1527
gobject.IO_IN: "IN", # There is data to read.
1528
gobject.IO_OUT: "OUT", # Data can be written (without
1530
gobject.IO_PRI: "PRI", # There is urgent data to read.
1531
gobject.IO_ERR: "ERR", # Error condition.
1532
gobject.IO_HUP: "HUP" # Hung up (the connection has been
1533
# broken, usually for pipes and
1536
conditions_string = ' | '.join(name
1538
condition_names.iteritems()
1539
if cond & condition)
1540
# error or the other end of multiprocessing.Pipe has closed
1541
if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
1544
# Read a request from the child
1545
request = parent_pipe.recv()
1546
command = request[0]
1548
if command == 'init':
1550
address = request[2]
1552
for c in self.clients:
1553
if c.fingerprint == fpr:
1557
logger.info("Client not found for fingerprint: %s, ad"
1558
"dress: %s", fpr, address)
1561
mandos_dbus_service.ClientNotFound(fpr, address[0])
1562
parent_pipe.send(False)
1565
gobject.io_add_watch(parent_pipe.fileno(),
1566
gobject.IO_IN | gobject.IO_HUP,
1567
functools.partial(self.handle_ipc,
1568
parent_pipe = parent_pipe,
1569
client_object = client))
1570
parent_pipe.send(True)
1571
# remove the old hook in favor of the new above hook on same fileno
1573
if command == 'funcall':
1574
funcname = request[1]
1578
parent_pipe.send(('data', getattr(client_object, funcname)(*args, **kwargs)))
1580
if command == 'getattr':
1581
attrname = request[1]
1582
if callable(client_object.__getattribute__(attrname)):
1583
parent_pipe.send(('function',))
1585
parent_pipe.send(('data', client_object.__getattribute__(attrname)))
1587
if command == 'setattr':
1588
attrname = request[1]
1590
setattr(client_object, attrname, value)
545
return super(type(self), self).server_bind()
1595
548
def string_to_delta(interval):
1596
549
"""Parse a string and return a datetime.timedelta
1598
551
>>> string_to_delta('7d')
1599
552
datetime.timedelta(7)
1600
553
>>> string_to_delta('60s')
1731
697
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1732
698
"servicename": "Mandos",
1738
701
# Parse config file for server-global settings
1739
server_config = configparser.SafeConfigParser(server_defaults)
702
server_config = ConfigParser.SafeConfigParser(server_defaults)
1740
703
del server_defaults
1741
server_config.read(os.path.join(options.configdir,
704
server_config.read(os.path.join(options.configdir, "server.conf"))
705
server_section = "server"
1743
706
# Convert the SafeConfigParser object to a dict
1744
server_settings = server_config.defaults()
1745
# Use the appropriate methods on the non-string config options
1746
for option in ("debug", "use_dbus", "use_ipv6"):
1747
server_settings[option] = server_config.getboolean("DEFAULT",
1749
if server_settings["port"]:
1750
server_settings["port"] = server_config.getint("DEFAULT",
707
server_settings = dict(server_config.items(server_section))
708
# Use getboolean on the boolean config option
709
server_settings["debug"] = server_config.getboolean\
710
(server_section, "debug")
1752
711
del server_config
1754
713
# Override the settings from the config file with command line
1755
714
# options, if set.
1756
715
for option in ("interface", "address", "port", "debug",
1757
"priority", "servicename", "configdir",
1758
"use_dbus", "use_ipv6", "debuglevel"):
716
"priority", "servicename", "configdir"):
1759
717
value = getattr(options, option)
1760
718
if value is not None:
1761
719
server_settings[option] = value
1763
# Force all strings to be unicode
1764
for option in server_settings.keys():
1765
if type(server_settings[option]) is str:
1766
server_settings[option] = unicode(server_settings[option])
1767
721
# Now we have our good server settings in "server_settings"
1769
##################################################################
1772
debug = server_settings["debug"]
1773
debuglevel = server_settings["debuglevel"]
1774
use_dbus = server_settings["use_dbus"]
1775
use_ipv6 = server_settings["use_ipv6"]
1777
if server_settings["servicename"] != "Mandos":
1778
syslogger.setFormatter(logging.Formatter
1779
('Mandos (%s) [%%(process)d]:'
1780
' %%(levelname)s: %%(message)s'
1781
% server_settings["servicename"]))
1783
723
# Parse config file with clients
1784
client_defaults = { "timeout": "5m",
1785
"extended_timeout": "15m",
1787
"checker": "fping -q -- %%(host)s",
1789
"approval_delay": "0s",
1790
"approval_duration": "1s",
724
client_defaults = { "timeout": "1h",
726
"checker": "fping -q -- %%(fqdn)s",
1792
client_config = configparser.SafeConfigParser(client_defaults)
728
client_config = ConfigParser.SafeConfigParser(client_defaults)
1793
729
client_config.read(os.path.join(server_settings["configdir"],
1794
730
"clients.conf"))
1796
global mandos_dbus_service
1797
mandos_dbus_service = None
1799
tcp_server = MandosServer((server_settings["address"],
1800
server_settings["port"]),
1802
interface=(server_settings["interface"]
1806
server_settings["priority"],
1809
pidfilename = "/var/run/mandos.pid"
1811
pidfile = open(pidfilename, "w")
1813
logger.error("Could not open file %r", pidfilename)
1816
uid = pwd.getpwnam("_mandos").pw_uid
1817
gid = pwd.getpwnam("_mandos").pw_gid
1820
uid = pwd.getpwnam("mandos").pw_uid
1821
gid = pwd.getpwnam("mandos").pw_gid
1824
uid = pwd.getpwnam("nobody").pw_uid
1825
gid = pwd.getpwnam("nobody").pw_gid
1832
except OSError as error:
1833
if error[0] != errno.EPERM:
1836
if not debug and not debuglevel:
1837
syslogger.setLevel(logging.WARNING)
1838
console.setLevel(logging.WARNING)
1840
level = getattr(logging, debuglevel.upper())
1841
syslogger.setLevel(level)
1842
console.setLevel(level)
1845
# Enable all possible GnuTLS debugging
1847
# "Use a log level over 10 to enable all debugging options."
1849
gnutls.library.functions.gnutls_global_set_log_level(11)
1851
@gnutls.library.types.gnutls_log_func
1852
def debug_gnutls(level, string):
1853
logger.debug("GnuTLS: %s", string[:-1])
1855
(gnutls.library.functions
1856
.gnutls_global_set_log_function(debug_gnutls))
1858
# Redirect stdin so all checkers get /dev/null
1859
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
1860
os.dup2(null, sys.stdin.fileno())
1864
# No console logging
1865
logger.removeHandler(console)
1867
# Need to fork before connecting to D-Bus
1869
# Close all input and output, do double fork, etc.
733
service = AvahiService(name = server_settings["servicename"],
734
type = "_mandos._tcp", );
735
if server_settings["interface"]:
736
service.interface = if_nametoindex(server_settings["interface"])
1872
738
global main_loop
1873
741
# From the Avahi example code
1874
742
DBusGMainLoop(set_as_default=True )
1875
743
main_loop = gobject.MainLoop()
1876
744
bus = dbus.SystemBus()
745
server = dbus.Interface(
746
bus.get_object( avahi.DBUS_NAME, avahi.DBUS_PATH_SERVER ),
747
avahi.DBUS_INTERFACE_SERVER )
1877
748
# End of Avahi example code
1880
bus_name = dbus.service.BusName("se.bsnet.fukt.Mandos",
1881
bus, do_not_queue=True)
1882
except dbus.exceptions.NameExistsException as e:
1883
logger.error(unicode(e) + ", disabling D-Bus")
1885
server_settings["use_dbus"] = False
1886
tcp_server.use_dbus = False
1887
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1888
service = AvahiService(name = server_settings["servicename"],
1889
servicetype = "_mandos._tcp",
1890
protocol = protocol, bus = bus)
1891
if server_settings["interface"]:
1892
service.interface = (if_nametoindex
1893
(str(server_settings["interface"])))
1895
global multiprocessing_manager
1896
multiprocessing_manager = multiprocessing.Manager()
1898
client_class = Client
1900
client_class = functools.partial(ClientDBus, bus = bus)
1901
def client_config_items(config, section):
1902
special_settings = {
1903
"approved_by_default":
1904
lambda: config.getboolean(section,
1905
"approved_by_default"),
1907
for name, value in config.items(section):
1909
yield (name, special_settings[name]())
1913
tcp_server.clients.update(set(
1914
client_class(name = section,
1915
config= dict(client_config_items(
1916
client_config, section)))
1917
for section in client_config.sections()))
1918
if not tcp_server.clients:
1919
logger.warning("No clients defined")
1925
pidfile.write(str(pid) + "\n".encode("utf-8"))
1928
logger.error("Could not write to file %r with PID %d",
1931
# "pidfile" was never created
750
debug = server_settings["debug"]
753
console = logging.StreamHandler()
754
# console.setLevel(logging.DEBUG)
755
console.setFormatter(logging.Formatter\
756
('%(levelname)s: %(message)s'))
757
logger.addHandler(console)
761
def remove_from_clients(client):
762
clients.remove(client)
764
logger.debug(u"No clients left, exiting")
767
clients.update(Set(Client(name=section,
768
stop_hook = remove_from_clients,
769
**(dict(client_config\
771
for section in client_config.sections()))
777
"Cleanup function; run on exit"
779
# From the Avahi example code
780
if not group is None:
783
# End of Avahi example code
786
client = clients.pop()
787
client.stop_hook = None
790
atexit.register(cleanup)
1935
793
signal.signal(signal.SIGINT, signal.SIG_IGN)
1937
794
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1938
795
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
1941
class MandosDBusService(dbus.service.Object):
1942
"""A D-Bus proxy object"""
1944
dbus.service.Object.__init__(self, bus, "/")
1945
_interface = "se.bsnet.fukt.Mandos"
1947
@dbus.service.signal(_interface, signature="o")
1948
def ClientAdded(self, objpath):
1952
@dbus.service.signal(_interface, signature="ss")
1953
def ClientNotFound(self, fingerprint, address):
1957
@dbus.service.signal(_interface, signature="os")
1958
def ClientRemoved(self, objpath, name):
1962
@dbus.service.method(_interface, out_signature="ao")
1963
def GetAllClients(self):
1965
return dbus.Array(c.dbus_object_path
1966
for c in tcp_server.clients)
1968
@dbus.service.method(_interface,
1969
out_signature="a{oa{sv}}")
1970
def GetAllClientsWithProperties(self):
1972
return dbus.Dictionary(
1973
((c.dbus_object_path, c.GetAll(""))
1974
for c in tcp_server.clients),
1977
@dbus.service.method(_interface, in_signature="o")
1978
def RemoveClient(self, object_path):
1980
for c in tcp_server.clients:
1981
if c.dbus_object_path == object_path:
1982
tcp_server.clients.remove(c)
1983
c.remove_from_connection()
1984
# Don't signal anything except ClientRemoved
1985
c.disable(quiet=True)
1987
self.ClientRemoved(object_path, c.name)
1989
raise KeyError(object_path)
1993
mandos_dbus_service = MandosDBusService()
1996
"Cleanup function; run on exit"
1999
while tcp_server.clients:
2000
client = tcp_server.clients.pop()
2002
client.remove_from_connection()
2003
client.disable_hook = None
2004
# Don't signal anything except ClientRemoved
2005
client.disable(quiet=True)
2008
mandos_dbus_service.ClientRemoved(client.dbus_object_path,
2011
atexit.register(cleanup)
2013
for client in tcp_server.clients:
2016
mandos_dbus_service.ClientAdded(client.dbus_object_path)
2020
tcp_server.server_activate()
797
for client in clients:
800
tcp_server = IPv6_TCPServer((server_settings["address"],
801
server_settings["port"]),
803
settings=server_settings,
2022
805
# Find out what port we got
2023
806
service.port = tcp_server.socket.getsockname()[1]
2025
logger.info("Now listening on address %r, port %d,"
2026
" flowinfo %d, scope_id %d"
2027
% tcp_server.socket.getsockname())
2029
logger.info("Now listening on address %r, port %d"
2030
% tcp_server.socket.getsockname())
807
logger.debug(u"Now listening on address %r, port %d, flowinfo %d,"
808
u" scope_id %d" % tcp_server.socket.getsockname())
2032
810
#service.interface = tcp_server.socket.getsockname()[3]
2035
813
# From the Avahi example code
814
server.connect_to_signal("StateChanged", server_state_changed)
2038
except dbus.exceptions.DBusException as error:
2039
logger.critical("DBusException: %s", error)
816
server_state_changed(server.GetState())
817
except dbus.exceptions.DBusException, error:
818
logger.critical(u"DBusException: %s", error)
2042
820
# End of Avahi example code
2044
822
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2045
823
lambda *args, **kwargs:
2046
(tcp_server.handle_request
2047
(*args[2:], **kwargs) or True))
824
tcp_server.handle_request\
825
(*args[2:], **kwargs) or True)
2049
827
logger.debug("Starting main loop")
828
main_loop_started = True
2051
except AvahiError as error:
2052
logger.critical("AvahiError: %s", error)
830
except AvahiError, error:
831
logger.critical(u"AvahiError: %s" + unicode(error))
2055
833
except KeyboardInterrupt:
2057
print("", file=sys.stderr)
2058
logger.debug("Server received KeyboardInterrupt")
2059
logger.debug("Server exiting")
2060
# Must run before the D-Bus bus name gets deregistered
2063
837
if __name__ == '__main__':