98
117
class AvahiService(object):
118
"""An Avahi (Zeroconf) service.
100
121
interface: integer; avahi.IF_UNSPEC or an interface index.
101
122
Used to optionally bind to the specified interface.
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
123
name: string; Example: u'Mandos'
124
type: string; Example: u'_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()
114
137
def __init__(self, interface = avahi.IF_UNSPEC, name = None,
115
type = None, port = None, TXT = None, domain = "",
116
host = "", max_renames = 12):
117
"""An Avahi (Zeroconf) service. """
138
servicetype = None, port = None, TXT = None,
139
domain = u"", host = u"", max_renames = 32768,
140
protocol = avahi.PROTO_UNSPEC, bus = None):
118
141
self.interface = interface
143
self.type = servicetype
145
self.TXT = TXT if TXT is not None else []
126
146
self.domain = domain
128
148
self.rename_count = 0
149
self.max_renames = max_renames
150
self.protocol = protocol
151
self.group = None # our entry group
129
154
def rename(self):
130
155
"""Derived from the Avahi example code"""
131
156
if self.rename_count >= self.max_renames:
132
logger.critical(u"No suitable service name found after %i"
133
u" retries, exiting.", rename_count)
134
raise AvahiServiceError("Too many renames")
135
name = server.GetAlternativeServiceName(name)
136
logger.notice(u"Changing name to %r ...", 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'
139
170
self.rename_count += 1
140
171
def remove(self):
141
172
"""Derived from the Avahi example code"""
142
if group is not None:
173
if self.group is not None:
145
176
"""Derived from the Avahi example code"""
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
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())
171
234
class Client(object):
172
235
"""A representation of a client host served by this server.
174
name: string; from the config file, used in log messages
238
name: string; from the config file, used in log messages and
175
240
fingerprint: string (40 or 32 hexadecimal digits); used to
176
241
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.
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.
188
255
checker_initiator_tag: a gobject event source tag, or None
189
stop_initiator_tag: - '' -
256
disable_initiator_tag: - '' -
190
257
checker_callback_tag: - '' -
191
258
checker_command: string; External command which is run to check if
192
259
client lives. %() expansions are done at
193
260
runtime with vars(self) as dict, so that for
194
261
instance %(name)s can be used in the command.
196
_timeout: Real variable for 'timeout'
197
_interval: Real variable for 'interval'
198
_timeout_milliseconds: Used when calling gobject.timeout_add()
199
_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
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.."""
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):
287
"""Note: the 'checker' key in 'config' sets the
288
'checker_command' attribute and *not* the 'checker'
230
293
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"")
294
# Uppercase and remove spaces from fingerprint for later
295
# comparison purposes with return value from the fingerprint()
297
self.fingerprint = (config[u"fingerprint"].upper()
235
299
logger.debug(u" Fingerprint: %s", self.fingerprint)
237
self.secret = secret.decode(u"base64")
240
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!
243
309
raise TypeError(u"No secret or secfile for client %s"
246
self.created = datetime.datetime.now()
311
self.host = config.get(u"host", u"")
312
self.created = datetime.datetime.utcnow()
314
self.last_enabled = None
247
315
self.last_checked_ok = None
248
self.timeout = string_to_delta(timeout)
249
self.interval = string_to_delta(interval)
250
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
251
319
self.checker = None
252
320
self.checker_initiator_tag = None
253
self.stop_initiator_tag = None
321
self.disable_initiator_tag = None
254
322
self.checker_callback_tag = None
255
self.check_command = 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()
257
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()
258
348
# Schedule a new checker to be started an 'interval' from now,
259
349
# and every interval from then on.
260
self.checker_initiator_tag = gobject.timeout_add\
261
(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(),
263
358
# Also start a new checker *right now*.
264
359
self.start_checker()
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)
361
def disable(self, quiet=True):
362
"""Disable this client."""
363
if not getattr(self, "enabled", False):
279
if getattr(self, "stop_initiator_tag", False):
280
gobject.source_remove(self.stop_initiator_tag)
281
self.stop_initiator_tag = None
282
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):
283
373
gobject.source_remove(self.checker_initiator_tag)
284
374
self.checker_initiator_tag = None
285
375
self.stop_checker()
376
if self.disable_hook:
377
self.disable_hook(self)
288
379
# Do not run this again if called by a gobject.timeout_add
290
382
def __del__(self):
291
self.stop_hook = None
293
def checker_callback(self, pid, condition):
383
self.disable_hook = None
386
def checker_callback(self, pid, condition, command):
294
387
"""The checker has completed, so take appropriate actions."""
295
now = datetime.datetime.now()
296
388
self.checker_callback_tag = None
297
389
self.checker = None
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):
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",
308
400
logger.warning(u"Checker for %(name)s crashed?",
311
logger.debug(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(),
313
415
def start_checker(self):
314
416
"""Start a new checker subprocess if one is not running.
315
418
If a checker already exists, leave it running and do
317
420
# The reason for not killing a running checker is that if we
320
423
# client would inevitably timeout, since no checker would get
321
424
# a chance to run to completion. If we instead leave running
322
425
# checkers alone, the checker would have to take more time
323
# than 'timeout' for the client to be declared invalid, which
324
# 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
325
443
if self.checker is None:
327
# In case check_command has exactly one % operator
328
command = self.check_command % self.fqdn
445
# In case checker_command has exactly one % operator
446
command = self.checker_command % self.host
329
447
except TypeError:
330
448
# Escape attributes for the shell
331
escaped_attrs = dict((key, re.escape(str(val)))
449
escaped_attrs = dict((key,
450
re.escape(unicode(str(val),
333
454
vars(self).iteritems())
335
command = self.check_command % escaped_attrs
456
command = self.checker_command % escaped_attrs
336
457
except TypeError, error:
337
458
logger.error(u'Could not format string "%s":'
338
u' %s', self.check_command, error)
459
u' %s', self.checker_command, error)
339
460
return True # Try again later
461
self.current_checker_command = command
341
logger.debug(u"Starting checker %r for %s",
463
logger.info(u"Starting checker %r for %s",
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.)
343
469
self.checker = subprocess.Popen(command,
346
self.checker_callback_tag = gobject.child_watch_add\
348
self.checker_callback)
349
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:
350
483
logger.error(u"Failed to start subprocess: %s",
352
485
# Re-run this periodically if run by gobject.timeout_add
354
488
def stop_checker(self):
355
489
"""Force the checker process, if any, to stop."""
356
490
if self.checker_callback_tag:
357
491
gobject.source_remove(self.checker_callback_tag)
358
492
self.checker_callback_tag = None
359
if getattr(self, "checker", None) is None:
493
if getattr(self, u"checker", None) is None:
361
logger.debug("Stopping checker for %(name)s", vars(self))
495
logger.debug(u"Stopping checker for %(name)s", vars(self))
363
497
os.kill(self.checker.pid, signal.SIGTERM)
365
499
#if self.checker.poll() is None:
366
500
# os.kill(self.checker.pid, signal.SIGKILL)
367
501
except OSError, error:
368
502
if error.errno != errno.ESRCH: # No such process
370
504
self.checker = None
371
def still_valid(self):
372
"""Has the timeout not yet passed for this client?"""
373
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)
848
if self.approved_pending():
849
self.PropertyChanged(dbus.String(u"checker_running"),
850
dbus.Boolean(False, variant_level=1))
853
@dbus.service.signal(_interface, signature=u"s")
854
def Rejected(self, reason):
856
if self.approved_pending():
857
self.PropertyChanged(dbus.String(u"checker_running"),
858
dbus.Boolean(False, variant_level=1))
860
# NeedApproval - signal
861
@dbus.service.signal(_interface, signature=u"db")
862
def NeedApproval(self, timeout, default):
864
if not self.approved_pending():
865
self.PropertyChanged(dbus.String(u"approved_pending"),
866
dbus.Boolean(True, variant_level=1))
871
@dbus.service.method(_interface, in_signature=u"b")
872
def Approve(self, value):
876
@dbus.service.method(_interface)
878
return self.checked_ok()
881
@dbus.service.method(_interface)
886
# StartChecker - method
887
@dbus.service.method(_interface)
888
def StartChecker(self):
893
@dbus.service.method(_interface)
898
# StopChecker - method
899
@dbus.service.method(_interface)
900
def StopChecker(self):
905
# approved_pending - property
906
@dbus_service_property(_interface, signature=u"b", access=u"read")
907
def approved_pending_dbus_property(self):
908
return dbus.Boolean(self.approved_pending())
910
# approved_by_default - property
911
@dbus_service_property(_interface, signature=u"b",
913
def approved_by_default_dbus_property(self):
914
return dbus.Boolean(self.approved_by_default)
916
# approved_delay - property
917
@dbus_service_property(_interface, signature=u"t",
919
def approved_delay_dbus_property(self):
920
return dbus.UInt64(self.approved_delay_milliseconds())
922
# approved_duration - property
923
@dbus_service_property(_interface, signature=u"t",
925
def approved_duration_dbus_property(self):
926
return dbus.UInt64(self._timedelta_to_milliseconds(
927
self.approved_duration))
930
@dbus_service_property(_interface, signature=u"s", access=u"read")
931
def name_dbus_property(self):
932
return dbus.String(self.name)
934
# fingerprint - property
935
@dbus_service_property(_interface, signature=u"s", access=u"read")
936
def fingerprint_dbus_property(self):
937
return dbus.String(self.fingerprint)
940
@dbus_service_property(_interface, signature=u"s",
942
def host_dbus_property(self, value=None):
943
if value is None: # get
944
return dbus.String(self.host)
947
self.PropertyChanged(dbus.String(u"host"),
948
dbus.String(value, variant_level=1))
951
@dbus_service_property(_interface, signature=u"s", access=u"read")
952
def created_dbus_property(self):
953
return dbus.String(self._datetime_to_dbus(self.created))
955
# last_enabled - property
956
@dbus_service_property(_interface, signature=u"s", access=u"read")
957
def last_enabled_dbus_property(self):
958
if self.last_enabled is None:
959
return dbus.String(u"")
960
return dbus.String(self._datetime_to_dbus(self.last_enabled))
963
@dbus_service_property(_interface, signature=u"b",
965
def enabled_dbus_property(self, value=None):
966
if value is None: # get
967
return dbus.Boolean(self.enabled)
973
# last_checked_ok - property
974
@dbus_service_property(_interface, signature=u"s",
976
def last_checked_ok_dbus_property(self, value=None):
977
if value is not None:
374
980
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.
981
return dbus.String(u"")
982
return dbus.String(self._datetime_to_dbus(self
986
@dbus_service_property(_interface, signature=u"t",
988
def timeout_dbus_property(self, value=None):
989
if value is None: # get
990
return dbus.UInt64(self.timeout_milliseconds())
991
self.timeout = datetime.timedelta(0, 0, 0, value)
993
self.PropertyChanged(dbus.String(u"timeout"),
994
dbus.UInt64(value, variant_level=1))
995
if getattr(self, u"disable_initiator_tag", None) is None:
998
gobject.source_remove(self.disable_initiator_tag)
999
self.disable_initiator_tag = None
1000
time_to_die = (self.
1001
_timedelta_to_milliseconds((self
1006
if time_to_die <= 0:
1007
# The timeout has passed
1010
self.disable_initiator_tag = (gobject.timeout_add
1011
(time_to_die, self.disable))
1013
# interval - property
1014
@dbus_service_property(_interface, signature=u"t",
1015
access=u"readwrite")
1016
def interval_dbus_property(self, value=None):
1017
if value is None: # get
1018
return dbus.UInt64(self.interval_milliseconds())
1019
self.interval = datetime.timedelta(0, 0, 0, value)
1021
self.PropertyChanged(dbus.String(u"interval"),
1022
dbus.UInt64(value, variant_level=1))
1023
if getattr(self, u"checker_initiator_tag", None) is None:
1025
# Reschedule checker run
1026
gobject.source_remove(self.checker_initiator_tag)
1027
self.checker_initiator_tag = (gobject.timeout_add
1028
(value, self.start_checker))
1029
self.start_checker() # Start one now, too
1031
# checker - property
1032
@dbus_service_property(_interface, signature=u"s",
1033
access=u"readwrite")
1034
def checker_dbus_property(self, value=None):
1035
if value is None: # get
1036
return dbus.String(self.checker_command)
1037
self.checker_command = value
1039
self.PropertyChanged(dbus.String(u"checker"),
1040
dbus.String(self.checker_command,
1043
# checker_running - property
1044
@dbus_service_property(_interface, signature=u"b",
1045
access=u"readwrite")
1046
def checker_running_dbus_property(self, value=None):
1047
if value is None: # get
1048
return dbus.Boolean(self.checker is not None)
1050
self.start_checker()
1054
# object_path - property
1055
@dbus_service_property(_interface, signature=u"o", access=u"read")
1056
def object_path_dbus_property(self):
1057
return self.dbus_object_path # is already a dbus.ObjectPath
1060
@dbus_service_property(_interface, signature=u"ay",
1061
access=u"write", byte_arrays=True)
1062
def secret_dbus_property(self, value):
1063
self.secret = str(value)
1068
class ProxyClient(object):
1069
def __init__(self, child_pipe, fpr, address):
1070
self._pipe = child_pipe
1071
self._pipe.send(('init', fpr, address))
1072
if not self._pipe.recv():
1075
def __getattribute__(self, name):
1076
if(name == '_pipe'):
1077
return super(ProxyClient, self).__getattribute__(name)
1078
self._pipe.send(('getattr', name))
1079
data = self._pipe.recv()
1080
if data[0] == 'data':
1082
if data[0] == 'function':
1083
def func(*args, **kwargs):
1084
self._pipe.send(('funcall', name, args, kwargs))
1085
return self._pipe.recv()[1]
1088
def __setattr__(self, name, value):
1089
if(name == '_pipe'):
1090
return super(ProxyClient, self).__setattr__(name, value)
1091
self._pipe.send(('setattr', name, value))
1094
class ClientHandler(socketserver.BaseRequestHandler, object):
1095
"""A class to handle client connections.
1097
Instantiated once for each connection to handle it.
431
1098
Note: This will run in its own forked process."""
433
1100
def handle(self):
434
logger.debug(u"TCP connection from: %s",
435
unicode(self.client_address))
437
line = self.socket.makefile().readline()
439
if int(line.strip().split()[0]) > 1:
441
except (ValueError, IndexError, RuntimeError), error:
442
logger.error(u"Unknown protocol version: %s", error)
445
session = gnutls.connection.ClientSession\
446
(self.request, gnutls.connection.X509Credentials())
447
# Note: gnutls.connection.X509Credentials is really a generic
448
# GnuTLS certificate credentials object so long as no X.509
449
# keys are added to it. Therefore, we can use it here despite
450
# using OpenPGP certificates.
452
#priority = ':'.join(("NONE", "+VERS-TLS1.1", "+AES-256-CBC",
453
# "+SHA1", "+COMP-NULL", "+CTYPE-OPENPGP",
455
priority = "NORMAL" # Fallback default, since this
457
if self.server.settings["priority"]:
458
priority = self.server.settings["priority"]
459
gnutls.library.functions.gnutls_priority_set_direct\
460
(session._c_object, priority, None);
464
except gnutls.errors.GNUTLSError, error:
465
logger.debug(u"Handshake failed: %s", error)
466
# Do not run session.bye() here: the session is not
467
# established. Just abandon the request.
470
fpr = fingerprint(peer_certificate(session))
471
except (TypeError, gnutls.errors.GNUTLSError), error:
472
logger.debug(u"Bad certificate: %s", error)
475
logger.debug(u"Fingerprint: %s", fpr)
477
for c in self.server.clients:
478
if c.fingerprint == fpr:
482
logger.debug(u"Client not found for fingerprint: %s", fpr)
485
# Have to check if client.still_valid(), since it is possible
486
# that the client timed out while establishing the GnuTLS
488
if not client.still_valid():
489
logger.debug(u"Client %(name)s is invalid", vars(client))
493
while sent_size < len(client.secret):
494
sent = session.send(client.secret[sent_size:])
495
logger.debug(u"Sent: %d, remaining: %d",
496
sent, len(client.secret)
497
- (sent_size + sent))
502
class IPv6_TCPServer(SocketServer.ForkingTCPServer, object):
503
"""IPv6 TCP server. Accepts 'None' as address and/or port.
1101
with contextlib.closing(self.server.child_pipe) as child_pipe:
1102
logger.info(u"TCP connection from: %s",
1103
unicode(self.client_address))
1104
logger.debug(u"Pipe FD: %d",
1105
self.server.child_pipe.fileno())
1107
session = (gnutls.connection
1108
.ClientSession(self.request,
1110
.X509Credentials()))
1112
# Note: gnutls.connection.X509Credentials is really a
1113
# generic GnuTLS certificate credentials object so long as
1114
# no X.509 keys are added to it. Therefore, we can use it
1115
# here despite using OpenPGP certificates.
1117
#priority = u':'.join((u"NONE", u"+VERS-TLS1.1",
1118
# u"+AES-256-CBC", u"+SHA1",
1119
# u"+COMP-NULL", u"+CTYPE-OPENPGP",
1121
# Use a fallback default, since this MUST be set.
1122
priority = self.server.gnutls_priority
1123
if priority is None:
1124
priority = u"NORMAL"
1125
(gnutls.library.functions
1126
.gnutls_priority_set_direct(session._c_object,
1129
# Start communication using the Mandos protocol
1130
# Get protocol number
1131
line = self.request.makefile().readline()
1132
logger.debug(u"Protocol version: %r", line)
1134
if int(line.strip().split()[0]) > 1:
1136
except (ValueError, IndexError, RuntimeError), error:
1137
logger.error(u"Unknown protocol version: %s", error)
1140
# Start GnuTLS connection
1143
except gnutls.errors.GNUTLSError, error:
1144
logger.warning(u"Handshake failed: %s", error)
1145
# Do not run session.bye() here: the session is not
1146
# established. Just abandon the request.
1148
logger.debug(u"Handshake succeeded")
1150
approval_required = False
1153
fpr = self.fingerprint(self.peer_certificate
1155
except (TypeError, gnutls.errors.GNUTLSError), error:
1156
logger.warning(u"Bad certificate: %s", error)
1158
logger.debug(u"Fingerprint: %s", fpr)
1161
client = ProxyClient(child_pipe, fpr,
1162
self.client_address)
1166
if client.approved_delay:
1167
delay = client.approved_delay
1168
client.approvals_pending += 1
1169
approval_required = True
1172
if not client.enabled:
1173
logger.warning(u"Client %s is disabled",
1175
if self.server.use_dbus:
1177
client.Rejected("Disabled")
1180
if client._approved or not client.approved_delay:
1181
#We are approved or approval is disabled
1183
elif client._approved is None:
1184
logger.info(u"Client %s need approval",
1186
if self.server.use_dbus:
1188
client.NeedApproval(
1189
client.approved_delay_milliseconds(),
1190
client.approved_by_default)
1192
logger.warning(u"Client %s was not approved",
1194
if self.server.use_dbus:
1196
client.Rejected("Disapproved")
1199
#wait until timeout or approved
1200
#x = float(client._timedelta_to_milliseconds(delay))
1201
time = datetime.datetime.now()
1202
client.changedstate.acquire()
1203
client.changedstate.wait(float(client._timedelta_to_milliseconds(delay) / 1000))
1204
client.changedstate.release()
1205
time2 = datetime.datetime.now()
1206
if (time2 - time) >= delay:
1207
if not client.approved_by_default:
1208
logger.warning("Client %s timed out while"
1209
" waiting for approval",
1211
if self.server.use_dbus:
1213
client.Rejected("Time out")
1218
delay -= time2 - time
1221
while sent_size < len(client.secret):
1222
# XXX handle session exception
1223
sent = session.send(client.secret[sent_size:])
1224
logger.debug(u"Sent: %d, remaining: %d",
1225
sent, len(client.secret)
1226
- (sent_size + sent))
1229
logger.info(u"Sending secret to %s", client.name)
1230
# bump the timeout as if seen
1232
if self.server.use_dbus:
1237
if approval_required:
1238
client.approvals_pending -= 1
1242
def peer_certificate(session):
1243
"Return the peer's OpenPGP certificate as a bytestring"
1244
# If not an OpenPGP certificate...
1245
if (gnutls.library.functions
1246
.gnutls_certificate_type_get(session._c_object)
1247
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1248
# ...do the normal thing
1249
return session.peer_certificate
1250
list_size = ctypes.c_uint(1)
1251
cert_list = (gnutls.library.functions
1252
.gnutls_certificate_get_peers
1253
(session._c_object, ctypes.byref(list_size)))
1254
if not bool(cert_list) and list_size.value != 0:
1255
raise gnutls.errors.GNUTLSError(u"error getting peer"
1257
if list_size.value == 0:
1260
return ctypes.string_at(cert.data, cert.size)
1263
def fingerprint(openpgp):
1264
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
1265
# New GnuTLS "datum" with the OpenPGP public key
1266
datum = (gnutls.library.types
1267
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1270
ctypes.c_uint(len(openpgp))))
1271
# New empty GnuTLS certificate
1272
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1273
(gnutls.library.functions
1274
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
1275
# Import the OpenPGP public key into the certificate
1276
(gnutls.library.functions
1277
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1278
gnutls.library.constants
1279
.GNUTLS_OPENPGP_FMT_RAW))
1280
# Verify the self signature in the key
1281
crtverify = ctypes.c_uint()
1282
(gnutls.library.functions
1283
.gnutls_openpgp_crt_verify_self(crt, 0,
1284
ctypes.byref(crtverify)))
1285
if crtverify.value != 0:
1286
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1287
raise (gnutls.errors.CertificateSecurityError
1289
# New buffer for the fingerprint
1290
buf = ctypes.create_string_buffer(20)
1291
buf_len = ctypes.c_size_t()
1292
# Get the fingerprint from the certificate into the buffer
1293
(gnutls.library.functions
1294
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1295
ctypes.byref(buf_len)))
1296
# Deinit the certificate
1297
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1298
# Convert the buffer to a Python bytestring
1299
fpr = ctypes.string_at(buf, buf_len.value)
1300
# Convert the bytestring to hexadecimal notation
1301
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
1305
class MultiprocessingMixIn(object):
1306
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
1307
def sub_process_main(self, request, address):
1309
self.finish_request(request, address)
1311
self.handle_error(request, address)
1312
self.close_request(request)
1314
def process_request(self, request, address):
1315
"""Start a new process to process the request."""
1316
multiprocessing.Process(target = self.sub_process_main,
1317
args = (request, address)).start()
1319
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1320
""" adds a pipe to the MixIn """
1321
def process_request(self, request, client_address):
1322
"""Overrides and wraps the original process_request().
1324
This function creates a new pipe in self.pipe
1326
parent_pipe, self.child_pipe = multiprocessing.Pipe()
1328
super(MultiprocessingMixInWithPipe,
1329
self).process_request(request, client_address)
1330
self.add_pipe(parent_pipe)
1331
def add_pipe(self, parent_pipe):
1332
"""Dummy function; override as necessary"""
1335
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1336
socketserver.TCPServer, object):
1337
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
505
settings: Server settings
506
clients: Set() of Client objects
1340
enabled: Boolean; whether this server is activated yet
1341
interface: None or a network interface name (string)
1342
use_ipv6: Boolean; to use IPv6 or not
508
address_family = socket.AF_INET6
509
def __init__(self, *args, **kwargs):
510
if "settings" in kwargs:
511
self.settings = kwargs["settings"]
512
del kwargs["settings"]
513
if "clients" in kwargs:
514
self.clients = kwargs["clients"]
515
del kwargs["clients"]
516
return super(type(self), self).__init__(*args, **kwargs)
1344
def __init__(self, server_address, RequestHandlerClass,
1345
interface=None, use_ipv6=True):
1346
self.interface = interface
1348
self.address_family = socket.AF_INET6
1349
socketserver.TCPServer.__init__(self, server_address,
1350
RequestHandlerClass)
517
1351
def server_bind(self):
518
1352
"""This overrides the normal server_bind() function
519
1353
to bind to an interface if one was specified, and also NOT to
520
1354
bind to an address or port if they were not specified."""
521
if self.settings["interface"]:
522
# 25 is from /usr/include/asm-i486/socket.h
523
SO_BINDTODEVICE = getattr(socket, "SO_BINDTODEVICE", 25)
525
self.socket.setsockopt(socket.SOL_SOCKET,
527
self.settings["interface"])
528
except socket.error, error:
529
if error[0] == errno.EPERM:
530
logger.warning(u"No permission to"
531
u" bind to interface %s",
532
self.settings["interface"])
1355
if self.interface is not None:
1356
if SO_BINDTODEVICE is None:
1357
logger.error(u"SO_BINDTODEVICE does not exist;"
1358
u" cannot bind to interface %s",
1362
self.socket.setsockopt(socket.SOL_SOCKET,
1366
except socket.error, error:
1367
if error[0] == errno.EPERM:
1368
logger.error(u"No permission to"
1369
u" bind to interface %s",
1371
elif error[0] == errno.ENOPROTOOPT:
1372
logger.error(u"SO_BINDTODEVICE not available;"
1373
u" cannot bind to interface %s",
535
1377
# Only bind(2) the socket if we really need to.
536
1378
if self.server_address[0] or self.server_address[1]:
537
1379
if not self.server_address[0]:
539
self.server_address = (in6addr_any,
1380
if self.address_family == socket.AF_INET6:
1381
any_address = u"::" # in6addr_any
1383
any_address = socket.INADDR_ANY
1384
self.server_address = (any_address,
540
1385
self.server_address[1])
541
elif self.server_address[1] is None:
1386
elif not self.server_address[1]:
542
1387
self.server_address = (self.server_address[0],
544
return super(type(self), self).server_bind()
1389
# if self.interface:
1390
# self.server_address = (self.server_address[0],
1395
return socketserver.TCPServer.server_bind(self)
1398
class MandosServer(IPv6_TCPServer):
1402
clients: set of Client objects
1403
gnutls_priority GnuTLS priority string
1404
use_dbus: Boolean; to emit D-Bus signals or not
1406
Assumes a gobject.MainLoop event loop.
1408
def __init__(self, server_address, RequestHandlerClass,
1409
interface=None, use_ipv6=True, clients=None,
1410
gnutls_priority=None, use_dbus=True):
1411
self.enabled = False
1412
self.clients = clients
1413
if self.clients is None:
1414
self.clients = set()
1415
self.use_dbus = use_dbus
1416
self.gnutls_priority = gnutls_priority
1417
IPv6_TCPServer.__init__(self, server_address,
1418
RequestHandlerClass,
1419
interface = interface,
1420
use_ipv6 = use_ipv6)
1421
def server_activate(self):
1423
return socketserver.TCPServer.server_activate(self)
1426
def add_pipe(self, parent_pipe):
1427
# Call "handle_ipc" for both data and EOF events
1428
gobject.io_add_watch(parent_pipe.fileno(),
1429
gobject.IO_IN | gobject.IO_HUP,
1430
functools.partial(self.handle_ipc,
1431
parent_pipe = parent_pipe))
1433
def handle_ipc(self, source, condition, parent_pipe=None,
1434
client_object=None):
1436
gobject.IO_IN: u"IN", # There is data to read.
1437
gobject.IO_OUT: u"OUT", # Data can be written (without
1439
gobject.IO_PRI: u"PRI", # There is urgent data to read.
1440
gobject.IO_ERR: u"ERR", # Error condition.
1441
gobject.IO_HUP: u"HUP" # Hung up (the connection has been
1442
# broken, usually for pipes and
1445
conditions_string = ' | '.join(name
1447
condition_names.iteritems()
1448
if cond & condition)
1449
logger.debug(u"Handling IPC: FD = %d, condition = %s", source,
1452
# Read a request from the child
1453
request = parent_pipe.recv()
1454
command = request[0]
1456
if command == 'init':
1458
address = request[2]
1460
for c in self.clients:
1461
if c.fingerprint == fpr:
1465
logger.warning(u"Client not found for fingerprint: %s, ad"
1466
u"dress: %s", fpr, address)
1469
mandos_dbus_service.ClientNotFound(fpr, address)
1470
parent_pipe.send(False)
1473
gobject.io_add_watch(parent_pipe.fileno(),
1474
gobject.IO_IN | gobject.IO_HUP,
1475
functools.partial(self.handle_ipc,
1476
parent_pipe = parent_pipe,
1477
client_object = client))
1478
parent_pipe.send(True)
1479
# remove the old hook in favor of the new above hook on same fileno
1481
if command == 'funcall':
1482
funcname = request[1]
1486
parent_pipe.send(('data', getattr(client_object, funcname)(*args, **kwargs)))
1488
if command == 'getattr':
1489
attrname = request[1]
1490
if callable(client_object.__getattribute__(attrname)):
1491
parent_pipe.send(('function',))
1493
parent_pipe.send(('data', client_object.__getattribute__(attrname)))
1495
if command == 'setattr':
1496
attrname = request[1]
1498
setattr(client_object, attrname, value)
547
1503
def string_to_delta(interval):
548
1504
"""Parse a string and return a datetime.timedelta
550
>>> string_to_delta('7d')
1506
>>> string_to_delta(u'7d')
551
1507
datetime.timedelta(7)
552
>>> string_to_delta('60s')
1508
>>> string_to_delta(u'60s')
553
1509
datetime.timedelta(0, 60)
554
>>> string_to_delta('60m')
1510
>>> string_to_delta(u'60m')
555
1511
datetime.timedelta(0, 3600)
556
>>> string_to_delta('24h')
1512
>>> string_to_delta(u'24h')
557
1513
datetime.timedelta(1)
558
1514
>>> string_to_delta(u'1w')
559
1515
datetime.timedelta(7)
1516
>>> string_to_delta(u'5m 30s')
1517
datetime.timedelta(0, 330)
562
suffix=unicode(interval[-1])
563
value=int(interval[:-1])
565
delta = datetime.timedelta(value)
567
delta = datetime.timedelta(0, value)
569
delta = datetime.timedelta(0, 0, 0, 0, value)
571
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
573
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
576
except (ValueError, IndexError):
581
def server_state_changed(state):
582
"""Derived from the Avahi example code"""
583
if state == avahi.SERVER_COLLISION:
584
logger.warning(u"Server name collision")
586
elif state == avahi.SERVER_RUNNING:
590
def entry_group_state_changed(state, error):
591
"""Derived from the Avahi example code"""
592
logger.debug(u"state change: %i", state)
1519
timevalue = datetime.timedelta(0)
1520
for s in interval.split():
1522
suffix = unicode(s[-1])
1525
delta = datetime.timedelta(value)
1526
elif suffix == u"s":
1527
delta = datetime.timedelta(0, value)
1528
elif suffix == u"m":
1529
delta = datetime.timedelta(0, 0, 0, 0, value)
1530
elif suffix == u"h":
1531
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
1532
elif suffix == u"w":
1533
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
1535
raise ValueError(u"Unknown suffix %r" % suffix)
1536
except (ValueError, IndexError), e:
1537
raise ValueError(e.message)
1542
def if_nametoindex(interface):
1543
"""Call the C function if_nametoindex(), or equivalent
594
if state == avahi.ENTRY_GROUP_ESTABLISHED:
595
logger.debug(u"Service established.")
596
elif state == avahi.ENTRY_GROUP_COLLISION:
597
logger.warning(u"Service name collision.")
599
elif state == avahi.ENTRY_GROUP_FAILURE:
600
logger.critical(u"Error in group state changed %s",
602
raise AvahiGroupError("State changed: %s", str(error))
604
def if_nametoindex(interface, _func=[None]):
605
"""Call the C function if_nametoindex(), or equivalent"""
606
if _func[0] is not None:
607
return _func[0](interface)
1545
Note: This function cannot accept a unicode string."""
1546
global if_nametoindex
609
if "ctypes.util" not in sys.modules:
613
libc = ctypes.cdll.LoadLibrary\
614
(ctypes.util.find_library("c"))
615
_func[0] = libc.if_nametoindex
616
return _func[0](interface)
1548
if_nametoindex = (ctypes.cdll.LoadLibrary
1549
(ctypes.util.find_library(u"c"))
620
1551
except (OSError, AttributeError):
621
if "struct" not in sys.modules:
623
if "fcntl" not in sys.modules:
625
def the_hard_way(interface):
1552
logger.warning(u"Doing if_nametoindex the hard way")
1553
def if_nametoindex(interface):
626
1554
"Get an interface index the hard way, i.e. using fcntl()"
627
1555
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
629
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
630
struct.pack("16s16x", interface))
632
interface_index = struct.unpack("I", ifreq[16:20])[0]
1556
with contextlib.closing(socket.socket()) as s:
1557
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1558
struct.pack(str(u"16s16x"),
1560
interface_index = struct.unpack(str(u"I"),
633
1562
return interface_index
634
_func[0] = the_hard_way
635
return _func[0](interface)
638
def daemon(nochdir, noclose):
1563
return if_nametoindex(interface)
1566
def daemon(nochdir = False, noclose = False):
639
1567
"""See daemon(3). Standard BSD Unix function.
640
1569
This should really exist as os.daemon, but it doesn't (yet)."""
647
1578
# Close all standard open file descriptors
648
1579
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
649
1580
if not stat.S_ISCHR(os.fstat(null).st_mode):
650
1581
raise OSError(errno.ENODEV,
651
"/dev/null not a character device")
1582
u"%s not a character device"
652
1584
os.dup2(null, sys.stdin.fileno())
653
1585
os.dup2(null, sys.stdout.fileno())
654
1586
os.dup2(null, sys.stderr.fileno())
690
1628
# Default values for config file for server-global settings
691
server_defaults = { "interface": "",
696
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
697
"servicename": "Mandos",
1629
server_defaults = { u"interface": u"",
1634
u"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1635
u"servicename": u"Mandos",
1636
u"use_dbus": u"True",
1637
u"use_ipv6": u"True",
700
1640
# Parse config file for server-global settings
701
server_config = ConfigParser.SafeConfigParser(server_defaults)
1641
server_config = configparser.SafeConfigParser(server_defaults)
702
1642
del server_defaults
703
server_config.read(os.path.join(options.configdir, "server.conf"))
704
server_section = "server"
1643
server_config.read(os.path.join(options.configdir,
705
1645
# Convert the SafeConfigParser object to a dict
706
server_settings = dict(server_config.items(server_section))
707
# Use getboolean on the boolean config option
708
server_settings["debug"] = server_config.getboolean\
709
(server_section, "debug")
1646
server_settings = server_config.defaults()
1647
# Use the appropriate methods on the non-string config options
1648
for option in (u"debug", u"use_dbus", u"use_ipv6"):
1649
server_settings[option] = server_config.getboolean(u"DEFAULT",
1651
if server_settings["port"]:
1652
server_settings["port"] = server_config.getint(u"DEFAULT",
710
1654
del server_config
712
1656
# Override the settings from the config file with command line
713
1657
# options, if set.
714
for option in ("interface", "address", "port", "debug",
715
"priority", "servicename", "configdir"):
1658
for option in (u"interface", u"address", u"port", u"debug",
1659
u"priority", u"servicename", u"configdir",
1660
u"use_dbus", u"use_ipv6"):
716
1661
value = getattr(options, option)
717
1662
if value is not None:
718
1663
server_settings[option] = value
1665
# Force all strings to be unicode
1666
for option in server_settings.keys():
1667
if type(server_settings[option]) is str:
1668
server_settings[option] = unicode(server_settings[option])
720
1669
# Now we have our good server settings in "server_settings"
1671
##################################################################
1674
debug = server_settings[u"debug"]
1675
use_dbus = server_settings[u"use_dbus"]
1676
use_ipv6 = server_settings[u"use_ipv6"]
1679
syslogger.setLevel(logging.WARNING)
1680
console.setLevel(logging.WARNING)
1682
if server_settings[u"servicename"] != u"Mandos":
1683
syslogger.setFormatter(logging.Formatter
1684
(u'Mandos (%s) [%%(process)d]:'
1685
u' %%(levelname)s: %%(message)s'
1686
% server_settings[u"servicename"]))
722
1688
# Parse config file with clients
723
client_defaults = { "timeout": "1h",
725
"checker": "fping -q -- %%(fqdn)s",
1689
client_defaults = { u"timeout": u"1h",
1691
u"checker": u"fping -q -- %%(host)s",
1693
u"approved_delay": u"0s",
1694
u"approved_duration": u"1s",
727
client_config = ConfigParser.SafeConfigParser(client_defaults)
728
client_config.read(os.path.join(server_settings["configdir"],
732
service = AvahiService(name = server_settings["servicename"],
733
type = "_mandos._tcp", );
734
if server_settings["interface"]:
735
service.interface = if_nametoindex(server_settings["interface"])
1696
client_config = configparser.SafeConfigParser(client_defaults)
1697
client_config.read(os.path.join(server_settings[u"configdir"],
1700
global mandos_dbus_service
1701
mandos_dbus_service = None
1703
tcp_server = MandosServer((server_settings[u"address"],
1704
server_settings[u"port"]),
1706
interface=server_settings[u"interface"],
1709
server_settings[u"priority"],
1711
pidfilename = u"/var/run/mandos.pid"
1713
pidfile = open(pidfilename, u"w")
1715
logger.error(u"Could not open file %r", pidfilename)
1718
uid = pwd.getpwnam(u"_mandos").pw_uid
1719
gid = pwd.getpwnam(u"_mandos").pw_gid
1722
uid = pwd.getpwnam(u"mandos").pw_uid
1723
gid = pwd.getpwnam(u"mandos").pw_gid
1726
uid = pwd.getpwnam(u"nobody").pw_uid
1727
gid = pwd.getpwnam(u"nobody").pw_gid
1734
except OSError, error:
1735
if error[0] != errno.EPERM:
1738
# Enable all possible GnuTLS debugging
1740
# "Use a log level over 10 to enable all debugging options."
1742
gnutls.library.functions.gnutls_global_set_log_level(11)
1744
@gnutls.library.types.gnutls_log_func
1745
def debug_gnutls(level, string):
1746
logger.debug(u"GnuTLS: %s", string[:-1])
1748
(gnutls.library.functions
1749
.gnutls_global_set_log_function(debug_gnutls))
737
1751
global main_loop
740
1752
# From the Avahi example code
741
1753
DBusGMainLoop(set_as_default=True )
742
1754
main_loop = gobject.MainLoop()
743
1755
bus = dbus.SystemBus()
744
server = dbus.Interface(
745
bus.get_object( avahi.DBUS_NAME, avahi.DBUS_PATH_SERVER ),
746
avahi.DBUS_INTERFACE_SERVER )
747
1756
# End of Avahi example code
749
debug = server_settings["debug"]
1759
bus_name = dbus.service.BusName(u"se.bsnet.fukt.Mandos",
1760
bus, do_not_queue=True)
1761
except dbus.exceptions.NameExistsException, e:
1762
logger.error(unicode(e) + u", disabling D-Bus")
1764
server_settings[u"use_dbus"] = False
1765
tcp_server.use_dbus = False
1766
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1767
service = AvahiService(name = server_settings[u"servicename"],
1768
servicetype = u"_mandos._tcp",
1769
protocol = protocol, bus = bus)
1770
if server_settings["interface"]:
1771
service.interface = (if_nametoindex
1772
(str(server_settings[u"interface"])))
1774
client_class = Client
1776
client_class = functools.partial(ClientDBus, bus = bus)
1777
def client_config_items(config, section):
1778
special_settings = {
1779
"approved_by_default":
1780
lambda: config.getboolean(section,
1781
"approved_by_default"),
1783
for name, value in config.items(section):
1785
yield (name, special_settings[name]())
1789
tcp_server.clients.update(set(
1790
client_class(name = section,
1791
config= dict(client_config_items(
1792
client_config, section)))
1793
for section in client_config.sections()))
1794
if not tcp_server.clients:
1795
logger.warning(u"No clients defined")
752
console = logging.StreamHandler()
753
# console.setLevel(logging.DEBUG)
754
console.setFormatter(logging.Formatter\
755
('%(levelname)s: %(message)s'))
756
logger.addHandler(console)
760
def remove_from_clients(client):
761
clients.remove(client)
763
logger.debug(u"No clients left, exiting")
766
clients.update(Set(Client(name=section,
767
stop_hook = remove_from_clients,
768
**(dict(client_config\
770
for section in client_config.sections()))
1798
# Redirect stdin so all checkers get /dev/null
1799
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
1800
os.dup2(null, sys.stdin.fileno())
1804
# No console logging
1805
logger.removeHandler(console)
1806
# Close all input and output, do double fork, etc.
1812
pidfile.write(str(pid) + "\n")
1815
logger.error(u"Could not write to file %r with PID %d",
1818
# "pidfile" was never created
1823
signal.signal(signal.SIGINT, signal.SIG_IGN)
1824
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1825
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
1828
class MandosDBusService(dbus.service.Object):
1829
"""A D-Bus proxy object"""
1831
dbus.service.Object.__init__(self, bus, u"/")
1832
_interface = u"se.bsnet.fukt.Mandos"
1834
@dbus.service.signal(_interface, signature=u"o")
1835
def ClientAdded(self, objpath):
1839
@dbus.service.signal(_interface, signature=u"ss")
1840
def ClientNotFound(self, fingerprint, address):
1844
@dbus.service.signal(_interface, signature=u"os")
1845
def ClientRemoved(self, objpath, name):
1849
@dbus.service.method(_interface, out_signature=u"ao")
1850
def GetAllClients(self):
1852
return dbus.Array(c.dbus_object_path
1853
for c in tcp_server.clients)
1855
@dbus.service.method(_interface,
1856
out_signature=u"a{oa{sv}}")
1857
def GetAllClientsWithProperties(self):
1859
return dbus.Dictionary(
1860
((c.dbus_object_path, c.GetAll(u""))
1861
for c in tcp_server.clients),
1862
signature=u"oa{sv}")
1864
@dbus.service.method(_interface, in_signature=u"o")
1865
def RemoveClient(self, object_path):
1867
for c in tcp_server.clients:
1868
if c.dbus_object_path == object_path:
1869
tcp_server.clients.remove(c)
1870
c.remove_from_connection()
1871
# Don't signal anything except ClientRemoved
1872
c.disable(quiet=True)
1874
self.ClientRemoved(object_path, c.name)
1876
raise KeyError(object_path)
1880
mandos_dbus_service = MandosDBusService()
776
1883
"Cleanup function; run on exit"
778
# From the Avahi example code
779
if not group is None:
782
# End of Avahi example code
785
client = clients.pop()
786
client.stop_hook = None
1886
while tcp_server.clients:
1887
client = tcp_server.clients.pop()
1889
client.remove_from_connection()
1890
client.disable_hook = None
1891
# Don't signal anything except ClientRemoved
1892
client.disable(quiet=True)
1895
mandos_dbus_service.ClientRemoved(client.dbus_object_path,
789
1898
atexit.register(cleanup)
792
signal.signal(signal.SIGINT, signal.SIG_IGN)
793
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
794
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
796
for client in clients:
799
tcp_server = IPv6_TCPServer((server_settings["address"],
800
server_settings["port"]),
802
settings=server_settings,
1900
for client in tcp_server.clients:
1903
mandos_dbus_service.ClientAdded(client.dbus_object_path)
1907
tcp_server.server_activate()
804
1909
# Find out what port we got
805
1910
service.port = tcp_server.socket.getsockname()[1]
806
logger.debug(u"Now listening on address %r, port %d, flowinfo %d,"
807
u" scope_id %d" % tcp_server.socket.getsockname())
1912
logger.info(u"Now listening on address %r, port %d,"
1913
" flowinfo %d, scope_id %d"
1914
% tcp_server.socket.getsockname())
1916
logger.info(u"Now listening on address %r, port %d"
1917
% tcp_server.socket.getsockname())
809
1919
#service.interface = tcp_server.socket.getsockname()[3]
812
1922
# From the Avahi example code
813
server.connect_to_signal("StateChanged", server_state_changed)
815
server_state_changed(server.GetState())
816
1925
except dbus.exceptions.DBusException, error:
817
1926
logger.critical(u"DBusException: %s", error)
819
1929
# End of Avahi example code
821
1931
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
822
1932
lambda *args, **kwargs:
823
tcp_server.handle_request\
824
(*args[2:], **kwargs) or True)
1933
(tcp_server.handle_request
1934
(*args[2:], **kwargs) or True))
826
logger.debug("Starting main loop")
827
main_loop_started = True
1936
logger.debug(u"Starting main loop")
829
1938
except AvahiError, error:
830
logger.critical(u"AvahiError: %s" + unicode(error))
1939
logger.critical(u"AvahiError: %s", error)
832
1942
except KeyboardInterrupt:
1945
logger.debug(u"Server received KeyboardInterrupt")
1946
logger.debug(u"Server exiting")
1947
# Must run before the D-Bus bus name gets deregistered
836
1950
if __name__ == '__main__':