104
130
max_renames: integer; maximum number of renames
105
131
rename_count: integer; counter so we only rename after collisions
106
132
a sensible number of times
133
group: D-Bus Entry Group
135
bus: dbus.SystemBus()
108
137
def __init__(self, interface = avahi.IF_UNSPEC, name = None,
109
type = None, port = None, TXT = None, domain = "",
110
host = "", max_renames = 32768):
138
servicetype = None, port = None, TXT = None,
139
domain = u"", host = u"", max_renames = 32768,
140
protocol = avahi.PROTO_UNSPEC, bus = None):
111
141
self.interface = interface
143
self.type = servicetype
145
self.TXT = TXT if TXT is not None else []
119
146
self.domain = domain
121
148
self.rename_count = 0
149
self.max_renames = max_renames
150
self.protocol = protocol
151
self.group = None # our entry group
122
154
def rename(self):
123
155
"""Derived from the Avahi example code"""
124
156
if self.rename_count >= self.max_renames:
125
logger.critical(u"No suitable service name found after %i"
126
u" retries, exiting.", rename_count)
127
raise AvahiServiceError("Too many renames")
128
name = server.GetAlternativeServiceName(name)
129
logger.error(u"Changing name to %r ...", name)
130
syslogger.setFormatter(logging.Formatter\
131
('Mandos (%s): %%(levelname)s:'
132
' %%(message)s' % name))
157
logger.critical(u"No suitable Zeroconf service name found"
158
u" after %i retries, exiting.",
160
raise AvahiServiceError(u"Too many renames")
161
self.name = self.server.GetAlternativeServiceName(self.name)
162
logger.info(u"Changing Zeroconf service name to %r ...",
164
syslogger.setFormatter(logging.Formatter
165
(u'Mandos (%s) [%%(process)d]:'
166
u' %%(levelname)s: %%(message)s'
135
170
self.rename_count += 1
136
171
def remove(self):
137
172
"""Derived from the Avahi example code"""
138
if group is not None:
173
if self.group is not None:
141
176
"""Derived from the Avahi example code"""
144
group = dbus.Interface\
145
(bus.get_object(avahi.DBUS_NAME,
146
server.EntryGroupNew()),
147
avahi.DBUS_INTERFACE_ENTRY_GROUP)
148
group.connect_to_signal('StateChanged',
149
entry_group_state_changed)
150
logger.debug(u"Adding service '%s' of type '%s' ...",
151
service.name, service.type)
153
self.interface, # interface
154
avahi.PROTO_INET6, # protocol
155
dbus.UInt32(0), # flags
156
self.name, self.type,
157
self.domain, self.host,
158
dbus.UInt16(self.port),
159
avahi.string_array_to_txt_array(self.TXT))
162
# From the Avahi example code:
163
group = None # our entry group
164
# End of Avahi example code
177
if self.group is None:
178
self.group = dbus.Interface(
179
self.bus.get_object(avahi.DBUS_NAME,
180
self.server.EntryGroupNew()),
181
avahi.DBUS_INTERFACE_ENTRY_GROUP)
182
self.group.connect_to_signal('StateChanged',
184
.entry_group_state_changed)
185
logger.debug(u"Adding Zeroconf service '%s' of type '%s' ...",
186
self.name, self.type)
187
self.group.AddService(
190
dbus.UInt32(0), # flags
191
self.name, self.type,
192
self.domain, self.host,
193
dbus.UInt16(self.port),
194
avahi.string_array_to_txt_array(self.TXT))
196
def entry_group_state_changed(self, state, error):
197
"""Derived from the Avahi example code"""
198
logger.debug(u"Avahi state change: %i", state)
200
if state == avahi.ENTRY_GROUP_ESTABLISHED:
201
logger.debug(u"Zeroconf service established.")
202
elif state == avahi.ENTRY_GROUP_COLLISION:
203
logger.warning(u"Zeroconf service name collision.")
205
elif state == avahi.ENTRY_GROUP_FAILURE:
206
logger.critical(u"Avahi: Error in group state changed %s",
208
raise AvahiGroupError(u"State changed: %s"
211
"""Derived from the Avahi example code"""
212
if self.group is not None:
215
def server_state_changed(self, state):
216
"""Derived from the Avahi example code"""
217
if state == avahi.SERVER_COLLISION:
218
logger.error(u"Zeroconf server name collision")
220
elif state == avahi.SERVER_RUNNING:
223
"""Derived from the Avahi example code"""
224
if self.server is None:
225
self.server = dbus.Interface(
226
self.bus.get_object(avahi.DBUS_NAME,
227
avahi.DBUS_PATH_SERVER),
228
avahi.DBUS_INTERFACE_SERVER)
229
self.server.connect_to_signal(u"StateChanged",
230
self.server_state_changed)
231
self.server_state_changed(self.server.GetState())
167
234
class Client(object):
168
235
"""A representation of a client host served by this server.
170
name: string; from the config file, used in log messages
238
name: string; from the config file, used in log messages and
171
240
fingerprint: string (40 or 32 hexadecimal digits); used to
172
241
uniquely identify the client
173
secret: bytestring; sent verbatim (over TLS) to client
174
host: string; available for use by the checker command
175
created: datetime.datetime(); object creation, not client host
176
last_checked_ok: datetime.datetime() or None if not yet checked OK
177
timeout: datetime.timedelta(); How long from last_checked_ok
178
until this client is invalid
179
interval: datetime.timedelta(); How often to start a new checker
180
stop_hook: If set, called by stop() as stop_hook(self)
181
checker: subprocess.Popen(); a running checker process used
182
to see if the client lives.
183
'None' if no process is running.
242
secret: bytestring; sent verbatim (over TLS) to client
243
host: string; available for use by the checker command
244
created: datetime.datetime(); (UTC) object creation
245
last_enabled: datetime.datetime(); (UTC)
247
last_checked_ok: datetime.datetime(); (UTC) or None
248
timeout: datetime.timedelta(); How long from last_checked_ok
249
until this client is disabled
250
interval: datetime.timedelta(); How often to start a new checker
251
disable_hook: If set, called by disable() as disable_hook(self)
252
checker: subprocess.Popen(); a running checker process used
253
to see if the client lives.
254
'None' if no process is running.
184
255
checker_initiator_tag: a gobject event source tag, or None
185
stop_initiator_tag: - '' -
256
disable_initiator_tag: - '' -
186
257
checker_callback_tag: - '' -
187
258
checker_command: string; External command which is run to check if
188
259
client lives. %() expansions are done at
189
260
runtime with vars(self) as dict, so that for
190
261
instance %(name)s can be used in the command.
192
_timeout: Real variable for 'timeout'
193
_interval: Real variable for 'interval'
194
_timeout_milliseconds: Used when calling gobject.timeout_add()
195
_interval_milliseconds: - '' -
262
current_checker_command: string; current running checker_command
263
approved_delay: datetime.timedelta(); Time to wait for approval
264
_approved: bool(); 'None' if not yet approved/disapproved
265
approved_duration: datetime.timedelta(); Duration of one approval
197
def _set_timeout(self, timeout):
198
"Setter function for 'timeout' attribute"
199
self._timeout = timeout
200
self._timeout_milliseconds = ((self.timeout.days
201
* 24 * 60 * 60 * 1000)
202
+ (self.timeout.seconds * 1000)
203
+ (self.timeout.microseconds
205
timeout = property(lambda self: self._timeout,
208
def _set_interval(self, interval):
209
"Setter function for 'interval' attribute"
210
self._interval = interval
211
self._interval_milliseconds = ((self.interval.days
212
* 24 * 60 * 60 * 1000)
213
+ (self.interval.seconds
215
+ (self.interval.microseconds
217
interval = property(lambda self: self._interval,
220
def __init__(self, name = None, stop_hook=None, config={}):
269
def _timedelta_to_milliseconds(td):
270
"Convert a datetime.timedelta() to milliseconds"
271
return ((td.days * 24 * 60 * 60 * 1000)
272
+ (td.seconds * 1000)
273
+ (td.microseconds // 1000))
275
def timeout_milliseconds(self):
276
"Return the 'timeout' attribute in milliseconds"
277
return self._timedelta_to_milliseconds(self.timeout)
279
def interval_milliseconds(self):
280
"Return the 'interval' attribute in milliseconds"
281
return self._timedelta_to_milliseconds(self.interval)
283
def approved_delay_milliseconds(self):
284
return self._timedelta_to_milliseconds(self.approved_delay)
286
def __init__(self, name = None, disable_hook=None, config=None):
221
287
"""Note: the 'checker' key in 'config' sets the
222
288
'checker_command' attribute and *not* the 'checker'
225
293
logger.debug(u"Creating client %r", self.name)
226
294
# Uppercase and remove spaces from fingerprint for later
227
295
# comparison purposes with return value from the fingerprint()
229
self.fingerprint = config["fingerprint"].upper()\
297
self.fingerprint = (config[u"fingerprint"].upper()
231
299
logger.debug(u" Fingerprint: %s", self.fingerprint)
232
if "secret" in config:
233
self.secret = config["secret"].decode(u"base64")
234
elif "secfile" in config:
235
sf = open(config["secfile"])
236
self.secret = sf.read()
300
if u"secret" in config:
301
self.secret = config[u"secret"].decode(u"base64")
302
elif u"secfile" in config:
303
with open(os.path.expanduser(os.path.expandvars
304
(config[u"secfile"])),
306
self.secret = secfile.read()
308
#XXX Need to allow secret on demand!
239
309
raise TypeError(u"No secret or secfile for client %s"
241
self.host = config.get("host", "")
242
self.created = datetime.datetime.now()
311
self.host = config.get(u"host", u"")
312
self.created = datetime.datetime.utcnow()
314
self.last_enabled = None
243
315
self.last_checked_ok = None
244
self.timeout = string_to_delta(config["timeout"])
245
self.interval = string_to_delta(config["interval"])
246
self.stop_hook = stop_hook
316
self.timeout = string_to_delta(config[u"timeout"])
317
self.interval = string_to_delta(config[u"interval"])
318
self.disable_hook = disable_hook
247
319
self.checker = None
248
320
self.checker_initiator_tag = None
249
self.stop_initiator_tag = None
321
self.disable_initiator_tag = None
250
322
self.checker_callback_tag = None
251
self.check_command = config["checker"]
323
self.checker_command = config[u"checker"]
324
self.current_checker_command = None
325
self.last_connect = None
326
self.approvals_pending = 0
327
self._approved = None
328
self.approved_by_default = config.get(u"approved_by_default",
330
self.approved_delay = string_to_delta(
331
config[u"approved_delay"])
332
self.approved_duration = string_to_delta(
333
config[u"approved_duration"])
334
self.changedstate = multiprocessing_manager.Condition(multiprocessing_manager.Lock())
336
def send_changedstate(self):
337
self.changedstate.acquire()
338
self.changedstate.notify_all()
339
self.changedstate.release()
253
342
"""Start this client's checker and timeout hooks"""
343
if getattr(self, u"enabled", False):
346
self.send_changedstate()
347
self.last_enabled = datetime.datetime.utcnow()
254
348
# Schedule a new checker to be started an 'interval' from now,
255
349
# and every interval from then on.
256
self.checker_initiator_tag = gobject.timeout_add\
257
(self._interval_milliseconds,
350
self.checker_initiator_tag = (gobject.timeout_add
351
(self.interval_milliseconds(),
353
# Schedule a disable() when 'timeout' has passed
354
self.disable_initiator_tag = (gobject.timeout_add
355
(self.timeout_milliseconds(),
259
358
# Also start a new checker *right now*.
260
359
self.start_checker()
261
# Schedule a stop() when 'timeout' has passed
262
self.stop_initiator_tag = gobject.timeout_add\
263
(self._timeout_milliseconds,
267
The possibility that a client might be restarted is left open,
268
but not currently used."""
269
# If this client doesn't have a secret, it is already stopped.
270
if hasattr(self, "secret") and self.secret:
271
logger.info(u"Stopping client %s", self.name)
361
def disable(self, quiet=True):
362
"""Disable this client."""
363
if not getattr(self, "enabled", False):
275
if getattr(self, "stop_initiator_tag", False):
276
gobject.source_remove(self.stop_initiator_tag)
277
self.stop_initiator_tag = None
278
if getattr(self, "checker_initiator_tag", False):
366
self.send_changedstate()
368
logger.info(u"Disabling client %s", self.name)
369
if getattr(self, u"disable_initiator_tag", False):
370
gobject.source_remove(self.disable_initiator_tag)
371
self.disable_initiator_tag = None
372
if getattr(self, u"checker_initiator_tag", False):
279
373
gobject.source_remove(self.checker_initiator_tag)
280
374
self.checker_initiator_tag = None
281
375
self.stop_checker()
376
if self.disable_hook:
377
self.disable_hook(self)
284
379
# Do not run this again if called by a gobject.timeout_add
286
382
def __del__(self):
287
self.stop_hook = None
289
def checker_callback(self, pid, condition):
383
self.disable_hook = None
386
def checker_callback(self, pid, condition, command):
290
387
"""The checker has completed, so take appropriate actions."""
291
now = datetime.datetime.now()
292
388
self.checker_callback_tag = None
293
389
self.checker = None
294
if os.WIFEXITED(condition) \
295
and (os.WEXITSTATUS(condition) == 0):
296
logger.info(u"Checker for %(name)s succeeded",
298
self.last_checked_ok = now
299
gobject.source_remove(self.stop_initiator_tag)
300
self.stop_initiator_tag = gobject.timeout_add\
301
(self._timeout_milliseconds,
303
elif not os.WIFEXITED(condition):
390
if os.WIFEXITED(condition):
391
exitstatus = os.WEXITSTATUS(condition)
393
logger.info(u"Checker for %(name)s succeeded",
397
logger.info(u"Checker for %(name)s failed",
304
400
logger.warning(u"Checker for %(name)s crashed?",
307
logger.info(u"Checker for %(name)s failed",
403
def checked_ok(self):
404
"""Bump up the timeout for this client.
406
This should only be called when the client has been seen,
409
self.last_checked_ok = datetime.datetime.utcnow()
410
gobject.source_remove(self.disable_initiator_tag)
411
self.disable_initiator_tag = (gobject.timeout_add
412
(self.timeout_milliseconds(),
309
415
def start_checker(self):
310
416
"""Start a new checker subprocess if one is not running.
311
418
If a checker already exists, leave it running and do
313
420
# The reason for not killing a running checker is that if we
316
423
# client would inevitably timeout, since no checker would get
317
424
# a chance to run to completion. If we instead leave running
318
425
# checkers alone, the checker would have to take more time
319
# than 'timeout' for the client to be declared invalid, which
320
# is as it should be.
426
# than 'timeout' for the client to be disabled, which is as it
429
# If a checker exists, make sure it is not a zombie
431
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
432
except (AttributeError, OSError), error:
433
if (isinstance(error, OSError)
434
and error.errno != errno.ECHILD):
438
logger.warning(u"Checker was a zombie")
439
gobject.source_remove(self.checker_callback_tag)
440
self.checker_callback(pid, status,
441
self.current_checker_command)
442
# Start a new checker if needed
321
443
if self.checker is None:
323
# In case check_command has exactly one % operator
324
command = self.check_command % self.host
445
# In case checker_command has exactly one % operator
446
command = self.checker_command % self.host
325
447
except TypeError:
326
448
# Escape attributes for the shell
327
escaped_attrs = dict((key, re.escape(str(val)))
449
escaped_attrs = dict((key,
450
re.escape(unicode(str(val),
329
454
vars(self).iteritems())
331
command = self.check_command % escaped_attrs
456
command = self.checker_command % escaped_attrs
332
457
except TypeError, error:
333
458
logger.error(u'Could not format string "%s":'
334
u' %s', self.check_command, error)
459
u' %s', self.checker_command, error)
335
460
return True # Try again later
461
self.current_checker_command = command
337
463
logger.info(u"Starting checker %r for %s",
338
464
command, self.name)
465
# We don't need to redirect stdout and stderr, since
466
# in normal mode, that is already done by daemon(),
467
# and in debug mode we don't want to. (Stdin is
468
# always replaced by /dev/null.)
339
469
self.checker = subprocess.Popen(command,
342
self.checker_callback_tag = gobject.child_watch_add\
344
self.checker_callback)
345
except subprocess.OSError, error:
471
shell=True, cwd=u"/")
472
self.checker_callback_tag = (gobject.child_watch_add
474
self.checker_callback,
476
# The checker may have completed before the gobject
477
# watch was added. Check for this.
478
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
480
gobject.source_remove(self.checker_callback_tag)
481
self.checker_callback(pid, status, command)
482
except OSError, error:
346
483
logger.error(u"Failed to start subprocess: %s",
348
485
# Re-run this periodically if run by gobject.timeout_add
350
488
def stop_checker(self):
351
489
"""Force the checker process, if any, to stop."""
352
490
if self.checker_callback_tag:
353
491
gobject.source_remove(self.checker_callback_tag)
354
492
self.checker_callback_tag = None
355
if getattr(self, "checker", None) is None:
493
if getattr(self, u"checker", None) is None:
357
495
logger.debug(u"Stopping checker for %(name)s", vars(self))
359
497
os.kill(self.checker.pid, signal.SIGTERM)
361
499
#if self.checker.poll() is None:
362
500
# os.kill(self.checker.pid, signal.SIGKILL)
363
501
except OSError, error:
364
502
if error.errno != errno.ESRCH: # No such process
366
504
self.checker = None
367
def still_valid(self):
368
"""Has the timeout not yet passed for this client?"""
369
now = datetime.datetime.now()
506
def dbus_service_property(dbus_interface, signature=u"v",
507
access=u"readwrite", byte_arrays=False):
508
"""Decorators for marking methods of a DBusObjectWithProperties to
509
become properties on the D-Bus.
511
The decorated method will be called with no arguments by "Get"
512
and with one argument by "Set".
514
The parameters, where they are supported, are the same as
515
dbus.service.method, except there is only "signature", since the
516
type from Get() and the type sent to Set() is the same.
518
# Encoding deeply encoded byte arrays is not supported yet by the
519
# "Set" method, so we fail early here:
520
if byte_arrays and signature != u"ay":
521
raise ValueError(u"Byte arrays not supported for non-'ay'"
522
u" signature %r" % signature)
524
func._dbus_is_property = True
525
func._dbus_interface = dbus_interface
526
func._dbus_signature = signature
527
func._dbus_access = access
528
func._dbus_name = func.__name__
529
if func._dbus_name.endswith(u"_dbus_property"):
530
func._dbus_name = func._dbus_name[:-14]
531
func._dbus_get_args_options = {u'byte_arrays': byte_arrays }
536
class DBusPropertyException(dbus.exceptions.DBusException):
537
"""A base class for D-Bus property-related exceptions
539
def __unicode__(self):
540
return unicode(str(self))
543
class DBusPropertyAccessException(DBusPropertyException):
544
"""A property's access permissions disallows an operation.
549
class DBusPropertyNotFound(DBusPropertyException):
550
"""An attempt was made to access a non-existing property.
555
class DBusObjectWithProperties(dbus.service.Object):
556
"""A D-Bus object with properties.
558
Classes inheriting from this can use the dbus_service_property
559
decorator to expose methods as D-Bus properties. It exposes the
560
standard Get(), Set(), and GetAll() methods on the D-Bus.
564
def _is_dbus_property(obj):
565
return getattr(obj, u"_dbus_is_property", False)
567
def _get_all_dbus_properties(self):
568
"""Returns a generator of (name, attribute) pairs
570
return ((prop._dbus_name, prop)
572
inspect.getmembers(self, self._is_dbus_property))
574
def _get_dbus_property(self, interface_name, property_name):
575
"""Returns a bound method if one exists which is a D-Bus
576
property with the specified name and interface.
578
for name in (property_name,
579
property_name + u"_dbus_property"):
580
prop = getattr(self, name, None)
582
or not self._is_dbus_property(prop)
583
or prop._dbus_name != property_name
584
or (interface_name and prop._dbus_interface
585
and interface_name != prop._dbus_interface)):
589
raise DBusPropertyNotFound(self.dbus_object_path + u":"
590
+ interface_name + u"."
593
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ss",
595
def Get(self, interface_name, property_name):
596
"""Standard D-Bus property Get() method, see D-Bus standard.
598
prop = self._get_dbus_property(interface_name, property_name)
599
if prop._dbus_access == u"write":
600
raise DBusPropertyAccessException(property_name)
602
if not hasattr(value, u"variant_level"):
604
return type(value)(value, variant_level=value.variant_level+1)
606
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ssv")
607
def Set(self, interface_name, property_name, value):
608
"""Standard D-Bus property Set() method, see D-Bus standard.
610
prop = self._get_dbus_property(interface_name, property_name)
611
if prop._dbus_access == u"read":
612
raise DBusPropertyAccessException(property_name)
613
if prop._dbus_get_args_options[u"byte_arrays"]:
614
# The byte_arrays option is not supported yet on
615
# signatures other than "ay".
616
if prop._dbus_signature != u"ay":
618
value = dbus.ByteArray(''.join(unichr(byte)
622
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"s",
623
out_signature=u"a{sv}")
624
def GetAll(self, interface_name):
625
"""Standard D-Bus property GetAll() method, see D-Bus
628
Note: Will not include properties with access="write".
631
for name, prop in self._get_all_dbus_properties():
633
and interface_name != prop._dbus_interface):
634
# Interface non-empty but did not match
636
# Ignore write-only properties
637
if prop._dbus_access == u"write":
640
if not hasattr(value, u"variant_level"):
643
all[name] = type(value)(value, variant_level=
644
value.variant_level+1)
645
return dbus.Dictionary(all, signature=u"sv")
647
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
649
path_keyword='object_path',
650
connection_keyword='connection')
651
def Introspect(self, object_path, connection):
652
"""Standard D-Bus method, overloaded to insert property tags.
654
xmlstring = dbus.service.Object.Introspect(self, object_path,
657
document = xml.dom.minidom.parseString(xmlstring)
658
def make_tag(document, name, prop):
659
e = document.createElement(u"property")
660
e.setAttribute(u"name", name)
661
e.setAttribute(u"type", prop._dbus_signature)
662
e.setAttribute(u"access", prop._dbus_access)
664
for if_tag in document.getElementsByTagName(u"interface"):
665
for tag in (make_tag(document, name, prop)
667
in self._get_all_dbus_properties()
668
if prop._dbus_interface
669
== if_tag.getAttribute(u"name")):
670
if_tag.appendChild(tag)
671
# Add the names to the return values for the
672
# "org.freedesktop.DBus.Properties" methods
673
if (if_tag.getAttribute(u"name")
674
== u"org.freedesktop.DBus.Properties"):
675
for cn in if_tag.getElementsByTagName(u"method"):
676
if cn.getAttribute(u"name") == u"Get":
677
for arg in cn.getElementsByTagName(u"arg"):
678
if (arg.getAttribute(u"direction")
680
arg.setAttribute(u"name", u"value")
681
elif cn.getAttribute(u"name") == u"GetAll":
682
for arg in cn.getElementsByTagName(u"arg"):
683
if (arg.getAttribute(u"direction")
685
arg.setAttribute(u"name", u"props")
686
xmlstring = document.toxml(u"utf-8")
688
except (AttributeError, xml.dom.DOMException,
689
xml.parsers.expat.ExpatError), error:
690
logger.error(u"Failed to override Introspection method",
695
class ClientDBus(Client, DBusObjectWithProperties):
696
"""A Client class using D-Bus
699
dbus_object_path: dbus.ObjectPath
700
bus: dbus.SystemBus()
702
# dbus.service.Object doesn't use super(), so we can't either.
704
def __init__(self, bus = None, *args, **kwargs):
706
Client.__init__(self, *args, **kwargs)
707
# Only now, when this client is initialized, can it show up on
709
self.dbus_object_path = (dbus.ObjectPath
711
+ self.name.replace(u".", u"_")))
712
DBusObjectWithProperties.__init__(self, self.bus,
713
self.dbus_object_path)
716
def _datetime_to_dbus(dt, variant_level=0):
717
"""Convert a UTC datetime.datetime() to a D-Bus type."""
718
return dbus.String(dt.isoformat(),
719
variant_level=variant_level)
722
oldstate = getattr(self, u"enabled", False)
723
r = Client.enable(self)
724
if oldstate != self.enabled:
726
self.PropertyChanged(dbus.String(u"enabled"),
727
dbus.Boolean(True, variant_level=1))
728
self.PropertyChanged(
729
dbus.String(u"last_enabled"),
730
self._datetime_to_dbus(self.last_enabled,
734
def disable(self, quiet = False):
735
oldstate = getattr(self, u"enabled", False)
736
r = Client.disable(self, quiet=quiet)
737
if not quiet and oldstate != self.enabled:
739
self.PropertyChanged(dbus.String(u"enabled"),
740
dbus.Boolean(False, variant_level=1))
743
def __del__(self, *args, **kwargs):
745
self.remove_from_connection()
748
if hasattr(DBusObjectWithProperties, u"__del__"):
749
DBusObjectWithProperties.__del__(self, *args, **kwargs)
750
Client.__del__(self, *args, **kwargs)
752
def checker_callback(self, pid, condition, command,
754
self.checker_callback_tag = None
757
self.PropertyChanged(dbus.String(u"checker_running"),
758
dbus.Boolean(False, variant_level=1))
759
if os.WIFEXITED(condition):
760
exitstatus = os.WEXITSTATUS(condition)
762
self.CheckerCompleted(dbus.Int16(exitstatus),
763
dbus.Int64(condition),
764
dbus.String(command))
767
self.CheckerCompleted(dbus.Int16(-1),
768
dbus.Int64(condition),
769
dbus.String(command))
771
return Client.checker_callback(self, pid, condition, command,
774
def checked_ok(self, *args, **kwargs):
775
r = Client.checked_ok(self, *args, **kwargs)
777
self.PropertyChanged(
778
dbus.String(u"last_checked_ok"),
779
(self._datetime_to_dbus(self.last_checked_ok,
783
def start_checker(self, *args, **kwargs):
784
old_checker = self.checker
785
if self.checker is not None:
786
old_checker_pid = self.checker.pid
788
old_checker_pid = None
789
r = Client.start_checker(self, *args, **kwargs)
790
# Only if new checker process was started
791
if (self.checker is not None
792
and old_checker_pid != self.checker.pid):
794
self.CheckerStarted(self.current_checker_command)
795
self.PropertyChanged(
796
dbus.String(u"checker_running"),
797
dbus.Boolean(True, variant_level=1))
800
def stop_checker(self, *args, **kwargs):
801
old_checker = getattr(self, u"checker", None)
802
r = Client.stop_checker(self, *args, **kwargs)
803
if (old_checker is not None
804
and getattr(self, u"checker", None) is None):
805
self.PropertyChanged(dbus.String(u"checker_running"),
806
dbus.Boolean(False, variant_level=1))
809
def _reset_approved(self):
810
self._approved = None
813
def approve(self, value=True):
814
self._approved = value
815
gobject.timeout_add(self._timedelta_to_milliseconds(self.approved_duration, self._reset_approved))
817
def approved_pending(self):
818
return self.approvals_pending > 0
821
## D-Bus methods, signals & properties
822
_interface = u"se.bsnet.fukt.Mandos.Client"
826
# CheckerCompleted - signal
827
@dbus.service.signal(_interface, signature=u"nxs")
828
def CheckerCompleted(self, exitcode, waitstatus, command):
832
# CheckerStarted - signal
833
@dbus.service.signal(_interface, signature=u"s")
834
def CheckerStarted(self, command):
838
# PropertyChanged - signal
839
@dbus.service.signal(_interface, signature=u"sv")
840
def PropertyChanged(self, property, value):
845
@dbus.service.signal(_interface)
851
@dbus.service.signal(_interface, signature=u"s")
852
def Rejected(self, reason):
856
# NeedApproval - signal
857
@dbus.service.signal(_interface, signature=u"db")
858
def NeedApproval(self, timeout, default):
865
@dbus.service.method(_interface, in_signature=u"b")
866
def Approve(self, value):
870
@dbus.service.method(_interface)
872
return self.checked_ok()
875
@dbus.service.method(_interface)
880
# StartChecker - method
881
@dbus.service.method(_interface)
882
def StartChecker(self):
887
@dbus.service.method(_interface)
892
# StopChecker - method
893
@dbus.service.method(_interface)
894
def StopChecker(self):
899
# approved_pending - property
900
@dbus_service_property(_interface, signature=u"b", access=u"read")
901
def approved_pending_dbus_property(self):
902
return dbus.Boolean(self.approved_pending())
904
# approved_by_default - property
905
@dbus_service_property(_interface, signature=u"b",
907
def approved_by_default_dbus_property(self):
908
return dbus.Boolean(self.approved_by_default)
910
# approved_delay - property
911
@dbus_service_property(_interface, signature=u"t",
913
def approved_delay_dbus_property(self):
914
return dbus.UInt64(self.approved_delay_milliseconds())
916
# approved_duration - property
917
@dbus_service_property(_interface, signature=u"t",
919
def approved_duration_dbus_property(self):
920
return dbus.UInt64(self._timedelta_to_milliseconds(
921
self.approved_duration))
924
@dbus_service_property(_interface, signature=u"s", access=u"read")
925
def name_dbus_property(self):
926
return dbus.String(self.name)
928
# fingerprint - property
929
@dbus_service_property(_interface, signature=u"s", access=u"read")
930
def fingerprint_dbus_property(self):
931
return dbus.String(self.fingerprint)
934
@dbus_service_property(_interface, signature=u"s",
936
def host_dbus_property(self, value=None):
937
if value is None: # get
938
return dbus.String(self.host)
941
self.PropertyChanged(dbus.String(u"host"),
942
dbus.String(value, variant_level=1))
945
@dbus_service_property(_interface, signature=u"s", access=u"read")
946
def created_dbus_property(self):
947
return dbus.String(self._datetime_to_dbus(self.created))
949
# last_enabled - property
950
@dbus_service_property(_interface, signature=u"s", access=u"read")
951
def last_enabled_dbus_property(self):
952
if self.last_enabled is None:
953
return dbus.String(u"")
954
return dbus.String(self._datetime_to_dbus(self.last_enabled))
957
@dbus_service_property(_interface, signature=u"b",
959
def enabled_dbus_property(self, value=None):
960
if value is None: # get
961
return dbus.Boolean(self.enabled)
967
# last_checked_ok - property
968
@dbus_service_property(_interface, signature=u"s",
970
def last_checked_ok_dbus_property(self, value=None):
971
if value is not None:
370
974
if self.last_checked_ok is None:
371
return now < (self.created + self.timeout)
373
return now < (self.last_checked_ok + self.timeout)
376
def peer_certificate(session):
377
"Return the peer's OpenPGP certificate as a bytestring"
378
# If not an OpenPGP certificate...
379
if gnutls.library.functions.gnutls_certificate_type_get\
380
(session._c_object) \
381
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP:
382
# ...do the normal thing
383
return session.peer_certificate
384
list_size = ctypes.c_uint()
385
cert_list = gnutls.library.functions.gnutls_certificate_get_peers\
386
(session._c_object, ctypes.byref(list_size))
387
if list_size.value == 0:
390
return ctypes.string_at(cert.data, cert.size)
393
def fingerprint(openpgp):
394
"Convert an OpenPGP bytestring to a hexdigit fingerprint string"
395
# New GnuTLS "datum" with the OpenPGP public key
396
datum = gnutls.library.types.gnutls_datum_t\
397
(ctypes.cast(ctypes.c_char_p(openpgp),
398
ctypes.POINTER(ctypes.c_ubyte)),
399
ctypes.c_uint(len(openpgp)))
400
# New empty GnuTLS certificate
401
crt = gnutls.library.types.gnutls_openpgp_crt_t()
402
gnutls.library.functions.gnutls_openpgp_crt_init\
404
# Import the OpenPGP public key into the certificate
405
gnutls.library.functions.gnutls_openpgp_crt_import\
406
(crt, ctypes.byref(datum),
407
gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
408
# New buffer for the fingerprint
409
buffer = ctypes.create_string_buffer(20)
410
buffer_length = ctypes.c_size_t()
411
# Get the fingerprint from the certificate into the buffer
412
gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint\
413
(crt, ctypes.byref(buffer), ctypes.byref(buffer_length))
414
# Deinit the certificate
415
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
416
# Convert the buffer to a Python bytestring
417
fpr = ctypes.string_at(buffer, buffer_length.value)
418
# Convert the bytestring to hexadecimal notation
419
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
423
class tcp_handler(SocketServer.BaseRequestHandler, object):
424
"""A TCP request handler class.
425
Instantiated by IPv6_TCPServer for each request to handle it.
975
return dbus.String(u"")
976
return dbus.String(self._datetime_to_dbus(self
980
@dbus_service_property(_interface, signature=u"t",
982
def timeout_dbus_property(self, value=None):
983
if value is None: # get
984
return dbus.UInt64(self.timeout_milliseconds())
985
self.timeout = datetime.timedelta(0, 0, 0, value)
987
self.PropertyChanged(dbus.String(u"timeout"),
988
dbus.UInt64(value, variant_level=1))
989
if getattr(self, u"disable_initiator_tag", None) is None:
992
gobject.source_remove(self.disable_initiator_tag)
993
self.disable_initiator_tag = None
995
_timedelta_to_milliseconds((self
1000
if time_to_die <= 0:
1001
# The timeout has passed
1004
self.disable_initiator_tag = (gobject.timeout_add
1005
(time_to_die, self.disable))
1007
# interval - property
1008
@dbus_service_property(_interface, signature=u"t",
1009
access=u"readwrite")
1010
def interval_dbus_property(self, value=None):
1011
if value is None: # get
1012
return dbus.UInt64(self.interval_milliseconds())
1013
self.interval = datetime.timedelta(0, 0, 0, value)
1015
self.PropertyChanged(dbus.String(u"interval"),
1016
dbus.UInt64(value, variant_level=1))
1017
if getattr(self, u"checker_initiator_tag", None) is None:
1019
# Reschedule checker run
1020
gobject.source_remove(self.checker_initiator_tag)
1021
self.checker_initiator_tag = (gobject.timeout_add
1022
(value, self.start_checker))
1023
self.start_checker() # Start one now, too
1025
# checker - property
1026
@dbus_service_property(_interface, signature=u"s",
1027
access=u"readwrite")
1028
def checker_dbus_property(self, value=None):
1029
if value is None: # get
1030
return dbus.String(self.checker_command)
1031
self.checker_command = value
1033
self.PropertyChanged(dbus.String(u"checker"),
1034
dbus.String(self.checker_command,
1037
# checker_running - property
1038
@dbus_service_property(_interface, signature=u"b",
1039
access=u"readwrite")
1040
def checker_running_dbus_property(self, value=None):
1041
if value is None: # get
1042
return dbus.Boolean(self.checker is not None)
1044
self.start_checker()
1048
# object_path - property
1049
@dbus_service_property(_interface, signature=u"o", access=u"read")
1050
def object_path_dbus_property(self):
1051
return self.dbus_object_path # is already a dbus.ObjectPath
1054
@dbus_service_property(_interface, signature=u"ay",
1055
access=u"write", byte_arrays=True)
1056
def secret_dbus_property(self, value):
1057
self.secret = str(value)
1062
class ProxyClient(object):
1063
def __init__(self, child_pipe, fpr, address):
1064
self._pipe = child_pipe
1065
self._pipe.send(('init', fpr, address))
1066
if not self._pipe.recv():
1069
def __getattribute__(self, name):
1070
if(name == '_pipe'):
1071
return super(ProxyClient, self).__getattribute__(name)
1072
self._pipe.send(('getattr', name))
1073
data = self._pipe.recv()
1074
if data[0] == 'data':
1076
if data[0] == 'function':
1077
def func(*args, **kwargs):
1078
self._pipe.send(('funcall', name, args, kwargs))
1079
return self._pipe.recv()[1]
1082
def __setattr__(self, name, value):
1083
if(name == '_pipe'):
1084
return super(ProxyClient, self).__setattr__(name, value)
1085
self._pipe.send(('setattr', name, value))
1088
class ClientHandler(socketserver.BaseRequestHandler, object):
1089
"""A class to handle client connections.
1091
Instantiated once for each connection to handle it.
426
1092
Note: This will run in its own forked process."""
428
1094
def handle(self):
429
logger.info(u"TCP connection from: %s",
430
unicode(self.client_address))
431
session = gnutls.connection.ClientSession\
432
(self.request, gnutls.connection.X509Credentials())
434
line = self.request.makefile().readline()
435
logger.debug(u"Protocol version: %r", line)
437
if int(line.strip().split()[0]) > 1:
439
except (ValueError, IndexError, RuntimeError), error:
440
logger.error(u"Unknown protocol version: %s", error)
443
# Note: gnutls.connection.X509Credentials is really a generic
444
# GnuTLS certificate credentials object so long as no X.509
445
# keys are added to it. Therefore, we can use it here despite
446
# using OpenPGP certificates.
448
#priority = ':'.join(("NONE", "+VERS-TLS1.1", "+AES-256-CBC",
449
# "+SHA1", "+COMP-NULL", "+CTYPE-OPENPGP",
451
priority = "NORMAL" # Fallback default, since this
453
if self.server.settings["priority"]:
454
priority = self.server.settings["priority"]
455
gnutls.library.functions.gnutls_priority_set_direct\
456
(session._c_object, priority, None);
460
except gnutls.errors.GNUTLSError, error:
461
logger.warning(u"Handshake failed: %s", error)
462
# Do not run session.bye() here: the session is not
463
# established. Just abandon the request.
466
fpr = fingerprint(peer_certificate(session))
467
except (TypeError, gnutls.errors.GNUTLSError), error:
468
logger.warning(u"Bad certificate: %s", error)
471
logger.debug(u"Fingerprint: %s", fpr)
473
for c in self.server.clients:
474
if c.fingerprint == fpr:
478
logger.warning(u"Client not found for fingerprint: %s",
482
# Have to check if client.still_valid(), since it is possible
483
# that the client timed out while establishing the GnuTLS
485
if not client.still_valid():
486
logger.warning(u"Client %(name)s is invalid",
491
while sent_size < len(client.secret):
492
sent = session.send(client.secret[sent_size:])
493
logger.debug(u"Sent: %d, remaining: %d",
494
sent, len(client.secret)
495
- (sent_size + sent))
500
class IPv6_TCPServer(SocketServer.ForkingTCPServer, object):
501
"""IPv6 TCP server. Accepts 'None' as address and/or port.
1095
with contextlib.closing(self.server.child_pipe) as child_pipe:
1096
logger.info(u"TCP connection from: %s",
1097
unicode(self.client_address))
1098
logger.debug(u"Pipe FD: %d",
1099
self.server.child_pipe.fileno())
1101
session = (gnutls.connection
1102
.ClientSession(self.request,
1104
.X509Credentials()))
1106
# Note: gnutls.connection.X509Credentials is really a
1107
# generic GnuTLS certificate credentials object so long as
1108
# no X.509 keys are added to it. Therefore, we can use it
1109
# here despite using OpenPGP certificates.
1111
#priority = u':'.join((u"NONE", u"+VERS-TLS1.1",
1112
# u"+AES-256-CBC", u"+SHA1",
1113
# u"+COMP-NULL", u"+CTYPE-OPENPGP",
1115
# Use a fallback default, since this MUST be set.
1116
priority = self.server.gnutls_priority
1117
if priority is None:
1118
priority = u"NORMAL"
1119
(gnutls.library.functions
1120
.gnutls_priority_set_direct(session._c_object,
1123
# Start communication using the Mandos protocol
1124
# Get protocol number
1125
line = self.request.makefile().readline()
1126
logger.debug(u"Protocol version: %r", line)
1128
if int(line.strip().split()[0]) > 1:
1130
except (ValueError, IndexError, RuntimeError), error:
1131
logger.error(u"Unknown protocol version: %s", error)
1134
# Start GnuTLS connection
1137
except gnutls.errors.GNUTLSError, error:
1138
logger.warning(u"Handshake failed: %s", error)
1139
# Do not run session.bye() here: the session is not
1140
# established. Just abandon the request.
1142
logger.debug(u"Handshake succeeded")
1144
approval_required = False
1147
fpr = self.fingerprint(self.peer_certificate
1149
except (TypeError, gnutls.errors.GNUTLSError), error:
1150
logger.warning(u"Bad certificate: %s", error)
1152
logger.debug(u"Fingerprint: %s", fpr)
1155
client = ProxyClient(child_pipe, fpr,
1156
self.client_address)
1160
if client.approved_delay:
1161
delay = client.approved_delay
1162
client.approvals_pending += 1
1163
approval_required = True
1166
if not client.enabled:
1167
logger.warning(u"Client %s is disabled",
1169
if self.server.use_dbus:
1171
client.Rejected("Disabled")
1174
if client._approved or not client.approved_delay:
1175
#We are approved or approval is disabled
1177
elif client._approved is None:
1178
logger.info(u"Client %s need approval",
1180
if self.server.use_dbus:
1182
client.NeedApproval(
1183
client.approved_delay_milliseconds(),
1184
client.approved_by_default)
1186
logger.warning(u"Client %s was not approved",
1188
if self.server.use_dbus:
1190
client.Rejected("Disapproved")
1193
#wait until timeout or approved
1194
#x = float(client._timedelta_to_milliseconds(delay))
1195
time = datetime.datetime.now()
1196
client.changedstate.acquire()
1197
client.changedstate.wait(float(client._timedelta_to_milliseconds(delay) / 1000))
1198
client.changedstate.release()
1199
time2 = datetime.datetime.now()
1200
if (time2 - time) >= delay:
1201
if not client.approved_by_default:
1202
logger.warning("Client %s timed out while"
1203
" waiting for approval",
1205
if self.server.use_dbus:
1207
client.Rejected("Time out")
1212
delay -= time2 - time
1215
while sent_size < len(client.secret):
1216
# XXX handle session exception
1217
sent = session.send(client.secret[sent_size:])
1218
logger.debug(u"Sent: %d, remaining: %d",
1219
sent, len(client.secret)
1220
- (sent_size + sent))
1223
logger.info(u"Sending secret to %s", client.name)
1224
# bump the timeout as if seen
1226
if self.server.use_dbus:
1231
if approval_required:
1232
client.approvals_pending -= 1
1236
def peer_certificate(session):
1237
"Return the peer's OpenPGP certificate as a bytestring"
1238
# If not an OpenPGP certificate...
1239
if (gnutls.library.functions
1240
.gnutls_certificate_type_get(session._c_object)
1241
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1242
# ...do the normal thing
1243
return session.peer_certificate
1244
list_size = ctypes.c_uint(1)
1245
cert_list = (gnutls.library.functions
1246
.gnutls_certificate_get_peers
1247
(session._c_object, ctypes.byref(list_size)))
1248
if not bool(cert_list) and list_size.value != 0:
1249
raise gnutls.errors.GNUTLSError(u"error getting peer"
1251
if list_size.value == 0:
1254
return ctypes.string_at(cert.data, cert.size)
1257
def fingerprint(openpgp):
1258
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
1259
# New GnuTLS "datum" with the OpenPGP public key
1260
datum = (gnutls.library.types
1261
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1264
ctypes.c_uint(len(openpgp))))
1265
# New empty GnuTLS certificate
1266
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1267
(gnutls.library.functions
1268
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
1269
# Import the OpenPGP public key into the certificate
1270
(gnutls.library.functions
1271
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1272
gnutls.library.constants
1273
.GNUTLS_OPENPGP_FMT_RAW))
1274
# Verify the self signature in the key
1275
crtverify = ctypes.c_uint()
1276
(gnutls.library.functions
1277
.gnutls_openpgp_crt_verify_self(crt, 0,
1278
ctypes.byref(crtverify)))
1279
if crtverify.value != 0:
1280
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1281
raise (gnutls.errors.CertificateSecurityError
1283
# New buffer for the fingerprint
1284
buf = ctypes.create_string_buffer(20)
1285
buf_len = ctypes.c_size_t()
1286
# Get the fingerprint from the certificate into the buffer
1287
(gnutls.library.functions
1288
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1289
ctypes.byref(buf_len)))
1290
# Deinit the certificate
1291
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1292
# Convert the buffer to a Python bytestring
1293
fpr = ctypes.string_at(buf, buf_len.value)
1294
# Convert the bytestring to hexadecimal notation
1295
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
1299
class MultiprocessingMixIn(object):
1300
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
1301
def sub_process_main(self, request, address):
1303
self.finish_request(request, address)
1305
self.handle_error(request, address)
1306
self.close_request(request)
1308
def process_request(self, request, address):
1309
"""Start a new process to process the request."""
1310
multiprocessing.Process(target = self.sub_process_main,
1311
args = (request, address)).start()
1313
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1314
""" adds a pipe to the MixIn """
1315
def process_request(self, request, client_address):
1316
"""Overrides and wraps the original process_request().
1318
This function creates a new pipe in self.pipe
1320
parent_pipe, self.child_pipe = multiprocessing.Pipe()
1322
super(MultiprocessingMixInWithPipe,
1323
self).process_request(request, client_address)
1324
self.add_pipe(parent_pipe)
1325
def add_pipe(self, parent_pipe):
1326
"""Dummy function; override as necessary"""
1329
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1330
socketserver.TCPServer, object):
1331
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
503
settings: Server settings
504
clients: Set() of Client objects
1334
enabled: Boolean; whether this server is activated yet
1335
interface: None or a network interface name (string)
1336
use_ipv6: Boolean; to use IPv6 or not
506
address_family = socket.AF_INET6
507
def __init__(self, *args, **kwargs):
508
if "settings" in kwargs:
509
self.settings = kwargs["settings"]
510
del kwargs["settings"]
511
if "clients" in kwargs:
512
self.clients = kwargs["clients"]
513
del kwargs["clients"]
514
return super(type(self), self).__init__(*args, **kwargs)
1338
def __init__(self, server_address, RequestHandlerClass,
1339
interface=None, use_ipv6=True):
1340
self.interface = interface
1342
self.address_family = socket.AF_INET6
1343
socketserver.TCPServer.__init__(self, server_address,
1344
RequestHandlerClass)
515
1345
def server_bind(self):
516
1346
"""This overrides the normal server_bind() function
517
1347
to bind to an interface if one was specified, and also NOT to
518
1348
bind to an address or port if they were not specified."""
519
if self.settings["interface"]:
520
# 25 is from /usr/include/asm-i486/socket.h
521
SO_BINDTODEVICE = getattr(socket, "SO_BINDTODEVICE", 25)
523
self.socket.setsockopt(socket.SOL_SOCKET,
525
self.settings["interface"])
526
except socket.error, error:
527
if error[0] == errno.EPERM:
528
logger.error(u"No permission to"
529
u" bind to interface %s",
530
self.settings["interface"])
1349
if self.interface is not None:
1350
if SO_BINDTODEVICE is None:
1351
logger.error(u"SO_BINDTODEVICE does not exist;"
1352
u" cannot bind to interface %s",
1356
self.socket.setsockopt(socket.SOL_SOCKET,
1360
except socket.error, error:
1361
if error[0] == errno.EPERM:
1362
logger.error(u"No permission to"
1363
u" bind to interface %s",
1365
elif error[0] == errno.ENOPROTOOPT:
1366
logger.error(u"SO_BINDTODEVICE not available;"
1367
u" cannot bind to interface %s",
533
1371
# Only bind(2) the socket if we really need to.
534
1372
if self.server_address[0] or self.server_address[1]:
535
1373
if not self.server_address[0]:
537
self.server_address = (in6addr_any,
1374
if self.address_family == socket.AF_INET6:
1375
any_address = u"::" # in6addr_any
1377
any_address = socket.INADDR_ANY
1378
self.server_address = (any_address,
538
1379
self.server_address[1])
539
1380
elif not self.server_address[1]:
540
1381
self.server_address = (self.server_address[0],
542
# if self.settings["interface"]:
1383
# if self.interface:
543
1384
# self.server_address = (self.server_address[0],
546
1387
# if_nametoindex
549
return super(type(self), self).server_bind()
1389
return socketserver.TCPServer.server_bind(self)
1392
class MandosServer(IPv6_TCPServer):
1396
clients: set of Client objects
1397
gnutls_priority GnuTLS priority string
1398
use_dbus: Boolean; to emit D-Bus signals or not
1400
Assumes a gobject.MainLoop event loop.
1402
def __init__(self, server_address, RequestHandlerClass,
1403
interface=None, use_ipv6=True, clients=None,
1404
gnutls_priority=None, use_dbus=True):
1405
self.enabled = False
1406
self.clients = clients
1407
if self.clients is None:
1408
self.clients = set()
1409
self.use_dbus = use_dbus
1410
self.gnutls_priority = gnutls_priority
1411
IPv6_TCPServer.__init__(self, server_address,
1412
RequestHandlerClass,
1413
interface = interface,
1414
use_ipv6 = use_ipv6)
1415
def server_activate(self):
1417
return socketserver.TCPServer.server_activate(self)
1420
def add_pipe(self, parent_pipe):
1421
# Call "handle_ipc" for both data and EOF events
1422
gobject.io_add_watch(parent_pipe.fileno(),
1423
gobject.IO_IN | gobject.IO_HUP,
1424
functools.partial(self.handle_ipc,
1425
parent_pipe = parent_pipe))
1427
def handle_ipc(self, source, condition, parent_pipe=None,
1428
client_object=None):
1430
gobject.IO_IN: u"IN", # There is data to read.
1431
gobject.IO_OUT: u"OUT", # Data can be written (without
1433
gobject.IO_PRI: u"PRI", # There is urgent data to read.
1434
gobject.IO_ERR: u"ERR", # Error condition.
1435
gobject.IO_HUP: u"HUP" # Hung up (the connection has been
1436
# broken, usually for pipes and
1439
conditions_string = ' | '.join(name
1441
condition_names.iteritems()
1442
if cond & condition)
1443
logger.debug(u"Handling IPC: FD = %d, condition = %s", source,
1446
# Read a request from the child
1447
request = parent_pipe.recv()
1448
command = request[0]
1450
if command == 'init':
1452
address = request[2]
1454
for c in self.clients:
1455
if c.fingerprint == fpr:
1459
logger.warning(u"Client not found for fingerprint: %s, ad"
1460
u"dress: %s", fpr, address)
1463
mandos_dbus_service.ClientNotFound(fpr, address)
1464
parent_pipe.send(False)
1467
gobject.io_add_watch(parent_pipe.fileno(),
1468
gobject.IO_IN | gobject.IO_HUP,
1469
functools.partial(self.handle_ipc,
1470
parent_pipe = parent_pipe,
1471
client_object = client))
1472
parent_pipe.send(True)
1473
# remove the old hook in favor of the new above hook on same fileno
1475
if command == 'funcall':
1476
funcname = request[1]
1480
parent_pipe.send(('data', getattr(client_object, funcname)(*args, **kwargs)))
1482
if command == 'getattr':
1483
attrname = request[1]
1484
if callable(client_object.__getattribute__(attrname)):
1485
parent_pipe.send(('function',))
1487
parent_pipe.send(('data', client_object.__getattribute__(attrname)))
1489
if command == 'setattr':
1490
attrname = request[1]
1492
setattr(client_object, attrname, value)
552
1497
def string_to_delta(interval):
553
1498
"""Parse a string and return a datetime.timedelta
555
>>> string_to_delta('7d')
1500
>>> string_to_delta(u'7d')
556
1501
datetime.timedelta(7)
557
>>> string_to_delta('60s')
1502
>>> string_to_delta(u'60s')
558
1503
datetime.timedelta(0, 60)
559
>>> string_to_delta('60m')
1504
>>> string_to_delta(u'60m')
560
1505
datetime.timedelta(0, 3600)
561
>>> string_to_delta('24h')
1506
>>> string_to_delta(u'24h')
562
1507
datetime.timedelta(1)
563
1508
>>> string_to_delta(u'1w')
564
1509
datetime.timedelta(7)
1510
>>> string_to_delta(u'5m 30s')
1511
datetime.timedelta(0, 330)
567
suffix=unicode(interval[-1])
568
value=int(interval[:-1])
570
delta = datetime.timedelta(value)
572
delta = datetime.timedelta(0, value)
574
delta = datetime.timedelta(0, 0, 0, 0, value)
576
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
578
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
581
except (ValueError, IndexError):
586
def server_state_changed(state):
587
"""Derived from the Avahi example code"""
588
if state == avahi.SERVER_COLLISION:
589
logger.error(u"Server name collision")
591
elif state == avahi.SERVER_RUNNING:
595
def entry_group_state_changed(state, error):
596
"""Derived from the Avahi example code"""
597
logger.debug(u"state change: %i", state)
599
if state == avahi.ENTRY_GROUP_ESTABLISHED:
600
logger.debug(u"Service established.")
601
elif state == avahi.ENTRY_GROUP_COLLISION:
602
logger.warning(u"Service name collision.")
604
elif state == avahi.ENTRY_GROUP_FAILURE:
605
logger.critical(u"Error in group state changed %s",
607
raise AvahiGroupError("State changed: %s", str(error))
1513
timevalue = datetime.timedelta(0)
1514
for s in interval.split():
1516
suffix = unicode(s[-1])
1519
delta = datetime.timedelta(value)
1520
elif suffix == u"s":
1521
delta = datetime.timedelta(0, value)
1522
elif suffix == u"m":
1523
delta = datetime.timedelta(0, 0, 0, 0, value)
1524
elif suffix == u"h":
1525
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
1526
elif suffix == u"w":
1527
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
1529
raise ValueError(u"Unknown suffix %r" % suffix)
1530
except (ValueError, IndexError), e:
1531
raise ValueError(e.message)
609
1536
def if_nametoindex(interface):
610
"""Call the C function if_nametoindex(), or equivalent"""
1537
"""Call the C function if_nametoindex(), or equivalent
1539
Note: This function cannot accept a unicode string."""
611
1540
global if_nametoindex
613
if "ctypes.util" not in sys.modules:
615
if_nametoindex = ctypes.cdll.LoadLibrary\
616
(ctypes.util.find_library("c")).if_nametoindex
1542
if_nametoindex = (ctypes.cdll.LoadLibrary
1543
(ctypes.util.find_library(u"c"))
617
1545
except (OSError, AttributeError):
618
if "struct" not in sys.modules:
620
if "fcntl" not in sys.modules:
1546
logger.warning(u"Doing if_nametoindex the hard way")
622
1547
def if_nametoindex(interface):
623
1548
"Get an interface index the hard way, i.e. using fcntl()"
624
1549
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
626
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
627
struct.pack("16s16x", interface))
629
interface_index = struct.unpack("I", ifreq[16:20])[0]
1550
with contextlib.closing(socket.socket()) as s:
1551
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1552
struct.pack(str(u"16s16x"),
1554
interface_index = struct.unpack(str(u"I"),
630
1556
return interface_index
631
1557
return if_nametoindex(interface)
634
1560
def daemon(nochdir = False, noclose = False):
635
1561
"""See daemon(3). Standard BSD Unix function.
636
1563
This should really exist as os.daemon, but it doesn't (yet)."""
688
1622
# Default values for config file for server-global settings
689
server_defaults = { "interface": "",
694
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
695
"servicename": "Mandos",
1623
server_defaults = { u"interface": u"",
1628
u"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1629
u"servicename": u"Mandos",
1630
u"use_dbus": u"True",
1631
u"use_ipv6": u"True",
698
1634
# Parse config file for server-global settings
699
server_config = ConfigParser.SafeConfigParser(server_defaults)
1635
server_config = configparser.SafeConfigParser(server_defaults)
700
1636
del server_defaults
701
server_config.read(os.path.join(options.configdir, "mandos.conf"))
702
server_section = "server"
1637
server_config.read(os.path.join(options.configdir,
703
1639
# Convert the SafeConfigParser object to a dict
704
server_settings = dict(server_config.items(server_section))
705
# Use getboolean on the boolean config option
706
server_settings["debug"] = server_config.getboolean\
707
(server_section, "debug")
1640
server_settings = server_config.defaults()
1641
# Use the appropriate methods on the non-string config options
1642
for option in (u"debug", u"use_dbus", u"use_ipv6"):
1643
server_settings[option] = server_config.getboolean(u"DEFAULT",
1645
if server_settings["port"]:
1646
server_settings["port"] = server_config.getint(u"DEFAULT",
708
1648
del server_config
710
1650
# Override the settings from the config file with command line
711
1651
# options, if set.
712
for option in ("interface", "address", "port", "debug",
713
"priority", "servicename", "configdir"):
1652
for option in (u"interface", u"address", u"port", u"debug",
1653
u"priority", u"servicename", u"configdir",
1654
u"use_dbus", u"use_ipv6"):
714
1655
value = getattr(options, option)
715
1656
if value is not None:
716
1657
server_settings[option] = value
1659
# Force all strings to be unicode
1660
for option in server_settings.keys():
1661
if type(server_settings[option]) is str:
1662
server_settings[option] = unicode(server_settings[option])
718
1663
# Now we have our good server settings in "server_settings"
720
debug = server_settings["debug"]
1665
##################################################################
1668
debug = server_settings[u"debug"]
1669
use_dbus = server_settings[u"use_dbus"]
1670
use_ipv6 = server_settings[u"use_ipv6"]
723
1673
syslogger.setLevel(logging.WARNING)
724
1674
console.setLevel(logging.WARNING)
726
if server_settings["servicename"] != "Mandos":
727
syslogger.setFormatter(logging.Formatter\
728
('Mandos (%s): %%(levelname)s:'
730
% server_settings["servicename"]))
1676
if server_settings[u"servicename"] != u"Mandos":
1677
syslogger.setFormatter(logging.Formatter
1678
(u'Mandos (%s) [%%(process)d]:'
1679
u' %%(levelname)s: %%(message)s'
1680
% server_settings[u"servicename"]))
732
1682
# Parse config file with clients
733
client_defaults = { "timeout": "1h",
735
"checker": "fping -q -- %%(host)s",
1683
client_defaults = { u"timeout": u"1h",
1685
u"checker": u"fping -q -- %%(host)s",
1687
u"approved_delay": u"5m",
1688
u"approved_duration": u"1s",
737
client_config = ConfigParser.SafeConfigParser(client_defaults)
738
client_config.read(os.path.join(server_settings["configdir"],
742
service = AvahiService(name = server_settings["servicename"],
743
type = "_mandos._tcp", );
744
if server_settings["interface"]:
745
service.interface = if_nametoindex(server_settings["interface"])
1690
client_config = configparser.SafeConfigParser(client_defaults)
1691
client_config.read(os.path.join(server_settings[u"configdir"],
1694
global mandos_dbus_service
1695
mandos_dbus_service = None
1697
tcp_server = MandosServer((server_settings[u"address"],
1698
server_settings[u"port"]),
1700
interface=server_settings[u"interface"],
1703
server_settings[u"priority"],
1705
pidfilename = u"/var/run/mandos.pid"
1707
pidfile = open(pidfilename, u"w")
1709
logger.error(u"Could not open file %r", pidfilename)
1712
uid = pwd.getpwnam(u"_mandos").pw_uid
1713
gid = pwd.getpwnam(u"_mandos").pw_gid
1716
uid = pwd.getpwnam(u"mandos").pw_uid
1717
gid = pwd.getpwnam(u"mandos").pw_gid
1720
uid = pwd.getpwnam(u"nobody").pw_uid
1721
gid = pwd.getpwnam(u"nobody").pw_gid
1728
except OSError, error:
1729
if error[0] != errno.EPERM:
1732
# Enable all possible GnuTLS debugging
1734
# "Use a log level over 10 to enable all debugging options."
1736
gnutls.library.functions.gnutls_global_set_log_level(11)
1738
@gnutls.library.types.gnutls_log_func
1739
def debug_gnutls(level, string):
1740
logger.debug(u"GnuTLS: %s", string[:-1])
1742
(gnutls.library.functions
1743
.gnutls_global_set_log_function(debug_gnutls))
747
1745
global main_loop
750
1746
# From the Avahi example code
751
1747
DBusGMainLoop(set_as_default=True )
752
1748
main_loop = gobject.MainLoop()
753
1749
bus = dbus.SystemBus()
754
server = dbus.Interface(
755
bus.get_object( avahi.DBUS_NAME, avahi.DBUS_PATH_SERVER ),
756
avahi.DBUS_INTERFACE_SERVER )
757
1750
# End of Avahi example code
760
def remove_from_clients(client):
761
clients.remove(client)
763
logger.critical(u"No clients left, exiting")
766
clients.update(Set(Client(name = section,
767
stop_hook = remove_from_clients,
769
= dict(client_config.items(section)))
770
for section in client_config.sections()))
772
logger.critical(u"No clients defined")
1753
bus_name = dbus.service.BusName(u"se.bsnet.fukt.Mandos",
1754
bus, do_not_queue=True)
1755
except dbus.exceptions.NameExistsException, e:
1756
logger.error(unicode(e) + u", disabling D-Bus")
1758
server_settings[u"use_dbus"] = False
1759
tcp_server.use_dbus = False
1760
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1761
service = AvahiService(name = server_settings[u"servicename"],
1762
servicetype = u"_mandos._tcp",
1763
protocol = protocol, bus = bus)
1764
if server_settings["interface"]:
1765
service.interface = (if_nametoindex
1766
(str(server_settings[u"interface"])))
1768
client_class = Client
1770
client_class = functools.partial(ClientDBus, bus = bus)
1771
def client_config_items(config, section):
1772
special_settings = {
1773
"approved_by_default":
1774
lambda: config.getboolean(section,
1775
"approved_by_default"),
1777
for name, value in config.items(section):
1779
yield (name, special_settings[name]())
1783
tcp_server.clients.update(set(
1784
client_class(name = section,
1785
config= dict(client_config_items(
1786
client_config, section)))
1787
for section in client_config.sections()))
1788
if not tcp_server.clients:
1789
logger.warning(u"No clients defined")
1792
# Redirect stdin so all checkers get /dev/null
1793
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
1794
os.dup2(null, sys.stdin.fileno())
1798
# No console logging
776
1799
logger.removeHandler(console)
1800
# Close all input and output, do double fork, etc.
779
pidfilename = "/var/run/mandos/mandos.pid"
782
pidfile = open(pidfilename, "w")
783
pidfile.write(str(pid) + "\n")
1806
pidfile.write(str(pid) + "\n")
787
logger.error(u"Could not write %s file with PID %d",
788
pidfilename, os.getpid())
1809
logger.error(u"Could not write to file %r with PID %d",
1812
# "pidfile" was never created
1817
signal.signal(signal.SIGINT, signal.SIG_IGN)
1818
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1819
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
1822
class MandosDBusService(dbus.service.Object):
1823
"""A D-Bus proxy object"""
1825
dbus.service.Object.__init__(self, bus, u"/")
1826
_interface = u"se.bsnet.fukt.Mandos"
1828
@dbus.service.signal(_interface, signature=u"o")
1829
def ClientAdded(self, objpath):
1833
@dbus.service.signal(_interface, signature=u"ss")
1834
def ClientNotFound(self, fingerprint, address):
1838
@dbus.service.signal(_interface, signature=u"os")
1839
def ClientRemoved(self, objpath, name):
1843
@dbus.service.method(_interface, out_signature=u"ao")
1844
def GetAllClients(self):
1846
return dbus.Array(c.dbus_object_path
1847
for c in tcp_server.clients)
1849
@dbus.service.method(_interface,
1850
out_signature=u"a{oa{sv}}")
1851
def GetAllClientsWithProperties(self):
1853
return dbus.Dictionary(
1854
((c.dbus_object_path, c.GetAll(u""))
1855
for c in tcp_server.clients),
1856
signature=u"oa{sv}")
1858
@dbus.service.method(_interface, in_signature=u"o")
1859
def RemoveClient(self, object_path):
1861
for c in tcp_server.clients:
1862
if c.dbus_object_path == object_path:
1863
tcp_server.clients.remove(c)
1864
c.remove_from_connection()
1865
# Don't signal anything except ClientRemoved
1866
c.disable(quiet=True)
1868
self.ClientRemoved(object_path, c.name)
1870
raise KeyError(object_path)
1874
mandos_dbus_service = MandosDBusService()
791
1877
"Cleanup function; run on exit"
793
# From the Avahi example code
794
if not group is None:
797
# End of Avahi example code
800
client = clients.pop()
801
client.stop_hook = None
1880
while tcp_server.clients:
1881
client = tcp_server.clients.pop()
1883
client.remove_from_connection()
1884
client.disable_hook = None
1885
# Don't signal anything except ClientRemoved
1886
client.disable(quiet=True)
1889
mandos_dbus_service.ClientRemoved(client.dbus_object_path,
804
1892
atexit.register(cleanup)
807
signal.signal(signal.SIGINT, signal.SIG_IGN)
808
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
809
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
811
for client in clients:
814
tcp_server = IPv6_TCPServer((server_settings["address"],
815
server_settings["port"]),
817
settings=server_settings,
1894
for client in tcp_server.clients:
1897
mandos_dbus_service.ClientAdded(client.dbus_object_path)
1901
tcp_server.server_activate()
819
1903
# Find out what port we got
820
1904
service.port = tcp_server.socket.getsockname()[1]
821
logger.info(u"Now listening on address %r, port %d, flowinfo %d,"
822
u" scope_id %d" % tcp_server.socket.getsockname())
1906
logger.info(u"Now listening on address %r, port %d,"
1907
" flowinfo %d, scope_id %d"
1908
% tcp_server.socket.getsockname())
1910
logger.info(u"Now listening on address %r, port %d"
1911
% tcp_server.socket.getsockname())
824
1913
#service.interface = tcp_server.socket.getsockname()[3]
827
1916
# From the Avahi example code
828
server.connect_to_signal("StateChanged", server_state_changed)
830
server_state_changed(server.GetState())
831
1919
except dbus.exceptions.DBusException, error:
832
1920
logger.critical(u"DBusException: %s", error)
834
1923
# End of Avahi example code
836
1925
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
837
1926
lambda *args, **kwargs:
838
tcp_server.handle_request\
839
(*args[2:], **kwargs) or True)
1927
(tcp_server.handle_request
1928
(*args[2:], **kwargs) or True))
841
1930
logger.debug(u"Starting main loop")
842
main_loop_started = True
844
1932
except AvahiError, error:
845
logger.critical(u"AvahiError: %s" + unicode(error))
1933
logger.critical(u"AvahiError: %s", error)
847
1936
except KeyboardInterrupt:
1939
logger.debug(u"Server received KeyboardInterrupt")
1940
logger.debug(u"Server exiting")
1941
# Must run before the D-Bus bus name gets deregistered
851
1944
if __name__ == '__main__':