116
98
class AvahiService(object):
117
"""An Avahi (Zeroconf) service.
120
100
interface: integer; avahi.IF_UNSPEC or an interface index.
121
101
Used to optionally bind to the specified interface.
122
name: string; Example: u'Mandos'
123
type: string; Example: u'_mandos._tcp'.
124
See <http://www.dns-sd.org/ServiceTypes.html>
125
port: integer; what port to announce
126
TXT: list of strings; TXT record for the service
127
domain: string; Domain to publish on, default to .local if empty.
128
host: string; Host to publish records for, default is localhost
129
max_renames: integer; maximum number of renames
130
rename_count: integer; counter so we only rename after collisions
131
a sensible number of times
132
group: D-Bus Entry Group
134
bus: dbus.SystemBus()
102
name = string; Example: "Mandos"
103
type = string; Example: "_mandos._tcp".
104
See <http://www.dns-sd.org/ServiceTypes.html>
105
port = integer; what port to announce
106
TXT = list of strings; TXT record for the service
107
domain = string; Domain to publish on, default to .local if empty.
108
host = string; Host to publish records for, default to localhost
110
max_renames = integer; maximum number of renames
111
rename_count = integer; counter so we only rename after collisions
112
a sensible number of times
136
114
def __init__(self, interface = avahi.IF_UNSPEC, name = None,
137
servicetype = None, port = None, TXT = None,
138
domain = u"", host = u"", max_renames = 32768,
139
protocol = avahi.PROTO_UNSPEC, bus = None):
115
type = None, port = None, TXT = None, domain = "",
116
host = "", max_renames = 12):
117
"""An Avahi (Zeroconf) service. """
140
118
self.interface = interface
142
self.type = servicetype
144
self.TXT = TXT if TXT is not None else []
145
126
self.domain = domain
147
128
self.rename_count = 0
148
self.max_renames = max_renames
149
self.protocol = protocol
150
self.group = None # our entry group
153
129
def rename(self):
154
130
"""Derived from the Avahi example code"""
155
131
if self.rename_count >= self.max_renames:
156
logger.critical(u"No suitable Zeroconf service name found"
157
u" after %i retries, exiting.",
159
raise AvahiServiceError(u"Too many renames")
160
self.name = unicode(self.server.GetAlternativeServiceName(self.name))
161
logger.info(u"Changing Zeroconf service name to %r ...",
163
syslogger.setFormatter(logging.Formatter
164
(u'Mandos (%s) [%%(process)d]:'
165
u' %%(levelname)s: %%(message)s'
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)
170
except dbus.exceptions.DBusException, error:
171
logger.critical(u"DBusException: %s", error)
174
139
self.rename_count += 1
175
140
def remove(self):
176
141
"""Derived from the Avahi example code"""
177
if self.group is not None:
142
if group is not None:
180
145
"""Derived from the Avahi example code"""
181
if self.group is None:
182
self.group = dbus.Interface(
183
self.bus.get_object(avahi.DBUS_NAME,
184
self.server.EntryGroupNew()),
185
avahi.DBUS_INTERFACE_ENTRY_GROUP)
186
self.group.connect_to_signal('StateChanged',
188
.entry_group_state_changed)
189
logger.debug(u"Adding Zeroconf service '%s' of type '%s' ...",
190
self.name, self.type)
191
self.group.AddService(
194
dbus.UInt32(0), # flags
195
self.name, self.type,
196
self.domain, self.host,
197
dbus.UInt16(self.port),
198
avahi.string_array_to_txt_array(self.TXT))
200
def entry_group_state_changed(self, state, error):
201
"""Derived from the Avahi example code"""
202
logger.debug(u"Avahi entry group state change: %i", state)
204
if state == avahi.ENTRY_GROUP_ESTABLISHED:
205
logger.debug(u"Zeroconf service established.")
206
elif state == avahi.ENTRY_GROUP_COLLISION:
207
logger.warning(u"Zeroconf service name collision.")
209
elif state == avahi.ENTRY_GROUP_FAILURE:
210
logger.critical(u"Avahi: Error in group state changed %s",
212
raise AvahiGroupError(u"State changed: %s"
215
"""Derived from the Avahi example code"""
216
if self.group is not None:
219
def server_state_changed(self, state):
220
"""Derived from the Avahi example code"""
221
logger.debug(u"Avahi server state change: %i", state)
222
if state == avahi.SERVER_COLLISION:
223
logger.error(u"Zeroconf server name collision")
225
elif state == avahi.SERVER_RUNNING:
228
"""Derived from the Avahi example code"""
229
if self.server is None:
230
self.server = dbus.Interface(
231
self.bus.get_object(avahi.DBUS_NAME,
232
avahi.DBUS_PATH_SERVER),
233
avahi.DBUS_INTERFACE_SERVER)
234
self.server.connect_to_signal(u"StateChanged",
235
self.server_state_changed)
236
self.server_state_changed(self.server.GetState())
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
239
171
class Client(object):
240
172
"""A representation of a client host served by this server.
243
name: string; from the config file, used in log messages and
174
name: string; from the config file, used in log messages
245
175
fingerprint: string (40 or 32 hexadecimal digits); used to
246
176
uniquely identify the client
247
secret: bytestring; sent verbatim (over TLS) to client
248
host: string; available for use by the checker command
249
created: datetime.datetime(); (UTC) object creation
250
last_enabled: datetime.datetime(); (UTC)
252
last_checked_ok: datetime.datetime(); (UTC) or None
253
timeout: datetime.timedelta(); How long from last_checked_ok
254
until this client is disabled
255
interval: datetime.timedelta(); How often to start a new checker
256
disable_hook: If set, called by disable() as disable_hook(self)
257
checker: subprocess.Popen(); a running checker process used
258
to see if the client lives.
259
'None' if no process is running.
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.
260
188
checker_initiator_tag: a gobject event source tag, or None
261
disable_initiator_tag: - '' -
189
stop_initiator_tag: - '' -
262
190
checker_callback_tag: - '' -
263
191
checker_command: string; External command which is run to check if
264
192
client lives. %() expansions are done at
265
193
runtime with vars(self) as dict, so that for
266
194
instance %(name)s can be used in the command.
267
current_checker_command: string; current running checker_command
268
approved_delay: datetime.timedelta(); Time to wait for approval
269
_approved: bool(); 'None' if not yet approved/disapproved
270
approved_duration: datetime.timedelta(); Duration of one approval
196
_timeout: Real variable for 'timeout'
197
_interval: Real variable for 'interval'
198
_timeout_milliseconds: Used when calling gobject.timeout_add()
199
_interval_milliseconds: - '' -
274
def _timedelta_to_milliseconds(td):
275
"Convert a datetime.timedelta() to milliseconds"
276
return ((td.days * 24 * 60 * 60 * 1000)
277
+ (td.seconds * 1000)
278
+ (td.microseconds // 1000))
280
def timeout_milliseconds(self):
281
"Return the 'timeout' attribute in milliseconds"
282
return self._timedelta_to_milliseconds(self.timeout)
284
def interval_milliseconds(self):
285
"Return the 'interval' attribute in milliseconds"
286
return self._timedelta_to_milliseconds(self.interval)
288
def approved_delay_milliseconds(self):
289
return self._timedelta_to_milliseconds(self.approved_delay)
291
def __init__(self, name = None, disable_hook=None, config=None):
292
"""Note: the 'checker' key in 'config' sets the
293
'checker_command' attribute and *not* the 'checker'
201
def _set_timeout(self, timeout):
202
"Setter function for 'timeout' attribute"
203
self._timeout = timeout
204
self._timeout_milliseconds = ((self.timeout.days
205
* 24 * 60 * 60 * 1000)
206
+ (self.timeout.seconds * 1000)
207
+ (self.timeout.microseconds
209
timeout = property(lambda self: self._timeout,
212
def _set_interval(self, interval):
213
"Setter function for 'interval' attribute"
214
self._interval = interval
215
self._interval_milliseconds = ((self.interval.days
216
* 24 * 60 * 60 * 1000)
217
+ (self.interval.seconds
219
+ (self.interval.microseconds
221
interval = property(lambda self: self._interval,
224
def __init__(self, name=None, stop_hook=None, fingerprint=None,
225
secret=None, secfile=None, fqdn=None, timeout=None,
226
interval=-1, checker=None):
227
"""Note: the 'checker' argument sets the 'checker_command'
228
attribute and not the 'checker' attribute.."""
298
230
logger.debug(u"Creating client %r", self.name)
299
# Uppercase and remove spaces from fingerprint for later
300
# comparison purposes with return value from the fingerprint()
302
self.fingerprint = (config[u"fingerprint"].upper()
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"")
304
235
logger.debug(u" Fingerprint: %s", self.fingerprint)
305
if u"secret" in config:
306
self.secret = config[u"secret"].decode(u"base64")
307
elif u"secfile" in config:
308
with open(os.path.expanduser(os.path.expandvars
309
(config[u"secfile"])),
311
self.secret = secfile.read()
237
self.secret = secret.decode(u"base64")
240
self.secret = sf.read()
313
243
raise TypeError(u"No secret or secfile for client %s"
315
self.host = config.get(u"host", u"")
316
self.created = datetime.datetime.utcnow()
318
self.last_enabled = None
246
self.created = datetime.datetime.now()
319
247
self.last_checked_ok = None
320
self.timeout = string_to_delta(config[u"timeout"])
321
self.interval = string_to_delta(config[u"interval"])
322
self.disable_hook = disable_hook
248
self.timeout = string_to_delta(timeout)
249
self.interval = string_to_delta(interval)
250
self.stop_hook = stop_hook
323
251
self.checker = None
324
252
self.checker_initiator_tag = None
325
self.disable_initiator_tag = None
253
self.stop_initiator_tag = None
326
254
self.checker_callback_tag = None
327
self.checker_command = config[u"checker"]
328
self.current_checker_command = None
329
self.last_connect = None
330
self._approved = None
331
self.approved_by_default = config.get(u"approved_by_default",
333
self.approvals_pending = 0
334
self.approved_delay = string_to_delta(
335
config[u"approved_delay"])
336
self.approved_duration = string_to_delta(
337
config[u"approved_duration"])
338
self.changedstate = multiprocessing_manager.Condition(multiprocessing_manager.Lock())
340
def send_changedstate(self):
341
self.changedstate.acquire()
342
self.changedstate.notify_all()
343
self.changedstate.release()
255
self.check_command = checker
346
257
"""Start this client's checker and timeout hooks"""
347
if getattr(self, u"enabled", False):
350
self.send_changedstate()
351
self.last_enabled = datetime.datetime.utcnow()
352
258
# Schedule a new checker to be started an 'interval' from now,
353
259
# and every interval from then on.
354
self.checker_initiator_tag = (gobject.timeout_add
355
(self.interval_milliseconds(),
357
# Schedule a disable() when 'timeout' has passed
358
self.disable_initiator_tag = (gobject.timeout_add
359
(self.timeout_milliseconds(),
260
self.checker_initiator_tag = gobject.timeout_add\
261
(self._interval_milliseconds,
362
263
# Also start a new checker *right now*.
363
264
self.start_checker()
365
def disable(self, quiet=True):
366
"""Disable this client."""
367
if not getattr(self, "enabled", False):
265
# Schedule a stop() when 'timeout' has passed
266
self.stop_initiator_tag = gobject.timeout_add\
267
(self._timeout_milliseconds,
271
The possibility that a client might be restarted is left open,
272
but not currently used."""
273
# If this client doesn't have a secret, it is already stopped.
275
logger.debug(u"Stopping client %s", self.name)
370
self.send_changedstate()
372
logger.info(u"Disabling client %s", self.name)
373
if getattr(self, u"disable_initiator_tag", False):
374
gobject.source_remove(self.disable_initiator_tag)
375
self.disable_initiator_tag = None
376
if getattr(self, u"checker_initiator_tag", 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):
377
283
gobject.source_remove(self.checker_initiator_tag)
378
284
self.checker_initiator_tag = None
379
285
self.stop_checker()
380
if self.disable_hook:
381
self.disable_hook(self)
383
288
# Do not run this again if called by a gobject.timeout_add
386
290
def __del__(self):
387
self.disable_hook = None
390
def checker_callback(self, pid, condition, command):
291
self.stop_hook = None
293
def checker_callback(self, pid, condition):
391
294
"""The checker has completed, so take appropriate actions."""
295
now = datetime.datetime.now()
392
296
self.checker_callback_tag = None
393
297
self.checker = None
394
if os.WIFEXITED(condition):
395
exitstatus = os.WEXITSTATUS(condition)
397
logger.info(u"Checker for %(name)s succeeded",
401
logger.info(u"Checker for %(name)s failed",
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):
404
308
logger.warning(u"Checker for %(name)s crashed?",
407
def checked_ok(self):
408
"""Bump up the timeout for this client.
410
This should only be called when the client has been seen,
413
self.last_checked_ok = datetime.datetime.utcnow()
414
gobject.source_remove(self.disable_initiator_tag)
415
self.disable_initiator_tag = (gobject.timeout_add
416
(self.timeout_milliseconds(),
311
logger.debug(u"Checker for %(name)s failed",
419
313
def start_checker(self):
420
314
"""Start a new checker subprocess if one is not running.
422
315
If a checker already exists, leave it running and do
424
317
# The reason for not killing a running checker is that if we
427
320
# client would inevitably timeout, since no checker would get
428
321
# a chance to run to completion. If we instead leave running
429
322
# checkers alone, the checker would have to take more time
430
# than 'timeout' for the client to be disabled, which is as it
433
# If a checker exists, make sure it is not a zombie
435
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
436
except (AttributeError, OSError), error:
437
if (isinstance(error, OSError)
438
and error.errno != errno.ECHILD):
442
logger.warning(u"Checker was a zombie")
443
gobject.source_remove(self.checker_callback_tag)
444
self.checker_callback(pid, status,
445
self.current_checker_command)
446
# Start a new checker if needed
323
# than 'timeout' for the client to be declared invalid, which
324
# is as it should be.
447
325
if self.checker is None:
449
# In case checker_command has exactly one % operator
450
command = self.checker_command % self.host
327
# In case check_command has exactly one % operator
328
command = self.check_command % self.fqdn
451
329
except TypeError:
452
330
# Escape attributes for the shell
453
escaped_attrs = dict((key,
454
re.escape(unicode(str(val),
331
escaped_attrs = dict((key, re.escape(str(val)))
458
333
vars(self).iteritems())
460
command = self.checker_command % escaped_attrs
335
command = self.check_command % escaped_attrs
461
336
except TypeError, error:
462
337
logger.error(u'Could not format string "%s":'
463
u' %s', self.checker_command, error)
338
u' %s', self.check_command, error)
464
339
return True # Try again later
465
self.current_checker_command = command
467
logger.info(u"Starting checker %r for %s",
469
# We don't need to redirect stdout and stderr, since
470
# in normal mode, that is already done by daemon(),
471
# and in debug mode we don't want to. (Stdin is
472
# always replaced by /dev/null.)
341
logger.debug(u"Starting checker %r for %s",
473
343
self.checker = subprocess.Popen(command,
475
shell=True, cwd=u"/")
476
self.checker_callback_tag = (gobject.child_watch_add
478
self.checker_callback,
480
# The checker may have completed before the gobject
481
# watch was added. Check for this.
482
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
484
gobject.source_remove(self.checker_callback_tag)
485
self.checker_callback(pid, status, command)
486
except OSError, error:
346
self.checker_callback_tag = gobject.child_watch_add\
348
self.checker_callback)
349
except subprocess.OSError, error:
487
350
logger.error(u"Failed to start subprocess: %s",
489
352
# Re-run this periodically if run by gobject.timeout_add
492
354
def stop_checker(self):
493
355
"""Force the checker process, if any, to stop."""
494
356
if self.checker_callback_tag:
495
357
gobject.source_remove(self.checker_callback_tag)
496
358
self.checker_callback_tag = None
497
if getattr(self, u"checker", None) is None:
359
if getattr(self, "checker", None) is None:
499
logger.debug(u"Stopping checker for %(name)s", vars(self))
361
logger.debug("Stopping checker for %(name)s", vars(self))
501
363
os.kill(self.checker.pid, signal.SIGTERM)
503
365
#if self.checker.poll() is None:
504
366
# os.kill(self.checker.pid, signal.SIGKILL)
505
367
except OSError, error:
506
368
if error.errno != errno.ESRCH: # No such process
508
370
self.checker = None
510
def dbus_service_property(dbus_interface, signature=u"v",
511
access=u"readwrite", byte_arrays=False):
512
"""Decorators for marking methods of a DBusObjectWithProperties to
513
become properties on the D-Bus.
515
The decorated method will be called with no arguments by "Get"
516
and with one argument by "Set".
518
The parameters, where they are supported, are the same as
519
dbus.service.method, except there is only "signature", since the
520
type from Get() and the type sent to Set() is the same.
522
# Encoding deeply encoded byte arrays is not supported yet by the
523
# "Set" method, so we fail early here:
524
if byte_arrays and signature != u"ay":
525
raise ValueError(u"Byte arrays not supported for non-'ay'"
526
u" signature %r" % signature)
528
func._dbus_is_property = True
529
func._dbus_interface = dbus_interface
530
func._dbus_signature = signature
531
func._dbus_access = access
532
func._dbus_name = func.__name__
533
if func._dbus_name.endswith(u"_dbus_property"):
534
func._dbus_name = func._dbus_name[:-14]
535
func._dbus_get_args_options = {u'byte_arrays': byte_arrays }
540
class DBusPropertyException(dbus.exceptions.DBusException):
541
"""A base class for D-Bus property-related exceptions
543
def __unicode__(self):
544
return unicode(str(self))
547
class DBusPropertyAccessException(DBusPropertyException):
548
"""A property's access permissions disallows an operation.
553
class DBusPropertyNotFound(DBusPropertyException):
554
"""An attempt was made to access a non-existing property.
559
class DBusObjectWithProperties(dbus.service.Object):
560
"""A D-Bus object with properties.
562
Classes inheriting from this can use the dbus_service_property
563
decorator to expose methods as D-Bus properties. It exposes the
564
standard Get(), Set(), and GetAll() methods on the D-Bus.
568
def _is_dbus_property(obj):
569
return getattr(obj, u"_dbus_is_property", False)
571
def _get_all_dbus_properties(self):
572
"""Returns a generator of (name, attribute) pairs
574
return ((prop._dbus_name, prop)
576
inspect.getmembers(self, self._is_dbus_property))
578
def _get_dbus_property(self, interface_name, property_name):
579
"""Returns a bound method if one exists which is a D-Bus
580
property with the specified name and interface.
582
for name in (property_name,
583
property_name + u"_dbus_property"):
584
prop = getattr(self, name, None)
586
or not self._is_dbus_property(prop)
587
or prop._dbus_name != property_name
588
or (interface_name and prop._dbus_interface
589
and interface_name != prop._dbus_interface)):
593
raise DBusPropertyNotFound(self.dbus_object_path + u":"
594
+ interface_name + u"."
597
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ss",
599
def Get(self, interface_name, property_name):
600
"""Standard D-Bus property Get() method, see D-Bus standard.
602
prop = self._get_dbus_property(interface_name, property_name)
603
if prop._dbus_access == u"write":
604
raise DBusPropertyAccessException(property_name)
606
if not hasattr(value, u"variant_level"):
608
return type(value)(value, variant_level=value.variant_level+1)
610
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ssv")
611
def Set(self, interface_name, property_name, value):
612
"""Standard D-Bus property Set() method, see D-Bus standard.
614
prop = self._get_dbus_property(interface_name, property_name)
615
if prop._dbus_access == u"read":
616
raise DBusPropertyAccessException(property_name)
617
if prop._dbus_get_args_options[u"byte_arrays"]:
618
# The byte_arrays option is not supported yet on
619
# signatures other than "ay".
620
if prop._dbus_signature != u"ay":
622
value = dbus.ByteArray(''.join(unichr(byte)
626
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"s",
627
out_signature=u"a{sv}")
628
def GetAll(self, interface_name):
629
"""Standard D-Bus property GetAll() method, see D-Bus
632
Note: Will not include properties with access="write".
635
for name, prop in self._get_all_dbus_properties():
637
and interface_name != prop._dbus_interface):
638
# Interface non-empty but did not match
640
# Ignore write-only properties
641
if prop._dbus_access == u"write":
644
if not hasattr(value, u"variant_level"):
647
all[name] = type(value)(value, variant_level=
648
value.variant_level+1)
649
return dbus.Dictionary(all, signature=u"sv")
651
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
653
path_keyword='object_path',
654
connection_keyword='connection')
655
def Introspect(self, object_path, connection):
656
"""Standard D-Bus method, overloaded to insert property tags.
658
xmlstring = dbus.service.Object.Introspect(self, object_path,
661
document = xml.dom.minidom.parseString(xmlstring)
662
def make_tag(document, name, prop):
663
e = document.createElement(u"property")
664
e.setAttribute(u"name", name)
665
e.setAttribute(u"type", prop._dbus_signature)
666
e.setAttribute(u"access", prop._dbus_access)
668
for if_tag in document.getElementsByTagName(u"interface"):
669
for tag in (make_tag(document, name, prop)
671
in self._get_all_dbus_properties()
672
if prop._dbus_interface
673
== if_tag.getAttribute(u"name")):
674
if_tag.appendChild(tag)
675
# Add the names to the return values for the
676
# "org.freedesktop.DBus.Properties" methods
677
if (if_tag.getAttribute(u"name")
678
== u"org.freedesktop.DBus.Properties"):
679
for cn in if_tag.getElementsByTagName(u"method"):
680
if cn.getAttribute(u"name") == u"Get":
681
for arg in cn.getElementsByTagName(u"arg"):
682
if (arg.getAttribute(u"direction")
684
arg.setAttribute(u"name", u"value")
685
elif cn.getAttribute(u"name") == u"GetAll":
686
for arg in cn.getElementsByTagName(u"arg"):
687
if (arg.getAttribute(u"direction")
689
arg.setAttribute(u"name", u"props")
690
xmlstring = document.toxml(u"utf-8")
692
except (AttributeError, xml.dom.DOMException,
693
xml.parsers.expat.ExpatError), error:
694
logger.error(u"Failed to override Introspection method",
699
class ClientDBus(Client, DBusObjectWithProperties):
700
"""A Client class using D-Bus
703
dbus_object_path: dbus.ObjectPath
704
bus: dbus.SystemBus()
706
# dbus.service.Object doesn't use super(), so we can't either.
708
def __init__(self, bus = None, *args, **kwargs):
709
self._approvals_pending = 0
711
Client.__init__(self, *args, **kwargs)
712
# Only now, when this client is initialized, can it show up on
714
self.dbus_object_path = (dbus.ObjectPath
716
+ self.name.replace(u".", u"_")))
717
DBusObjectWithProperties.__init__(self, self.bus,
718
self.dbus_object_path)
720
def _get_approvals_pending(self):
721
return self._approvals_pending
722
def _set_approvals_pending(self, value):
723
old_value = self._approvals_pending
724
self._approvals_pending = value
726
if (hasattr(self, "dbus_object_path")
727
and bval is not bool(old_value)):
728
dbus_bool = dbus.Boolean(bval, variant_level=1)
729
self.PropertyChanged(dbus.String(u"approved_pending"),
732
approvals_pending = property(_get_approvals_pending,
733
_set_approvals_pending)
734
del _get_approvals_pending, _set_approvals_pending
737
def _datetime_to_dbus(dt, variant_level=0):
738
"""Convert a UTC datetime.datetime() to a D-Bus type."""
739
return dbus.String(dt.isoformat(),
740
variant_level=variant_level)
743
oldstate = getattr(self, u"enabled", False)
744
r = Client.enable(self)
745
if oldstate != self.enabled:
747
self.PropertyChanged(dbus.String(u"enabled"),
748
dbus.Boolean(True, variant_level=1))
749
self.PropertyChanged(
750
dbus.String(u"last_enabled"),
751
self._datetime_to_dbus(self.last_enabled,
755
def disable(self, quiet = False):
756
oldstate = getattr(self, u"enabled", False)
757
r = Client.disable(self, quiet=quiet)
758
if not quiet and oldstate != self.enabled:
760
self.PropertyChanged(dbus.String(u"enabled"),
761
dbus.Boolean(False, variant_level=1))
764
def __del__(self, *args, **kwargs):
766
self.remove_from_connection()
769
if hasattr(DBusObjectWithProperties, u"__del__"):
770
DBusObjectWithProperties.__del__(self, *args, **kwargs)
771
Client.__del__(self, *args, **kwargs)
773
def checker_callback(self, pid, condition, command,
775
self.checker_callback_tag = None
778
self.PropertyChanged(dbus.String(u"checker_running"),
779
dbus.Boolean(False, variant_level=1))
780
if os.WIFEXITED(condition):
781
exitstatus = os.WEXITSTATUS(condition)
783
self.CheckerCompleted(dbus.Int16(exitstatus),
784
dbus.Int64(condition),
785
dbus.String(command))
788
self.CheckerCompleted(dbus.Int16(-1),
789
dbus.Int64(condition),
790
dbus.String(command))
792
return Client.checker_callback(self, pid, condition, command,
795
def checked_ok(self, *args, **kwargs):
796
r = Client.checked_ok(self, *args, **kwargs)
798
self.PropertyChanged(
799
dbus.String(u"last_checked_ok"),
800
(self._datetime_to_dbus(self.last_checked_ok,
804
def start_checker(self, *args, **kwargs):
805
old_checker = self.checker
806
if self.checker is not None:
807
old_checker_pid = self.checker.pid
809
old_checker_pid = None
810
r = Client.start_checker(self, *args, **kwargs)
811
# Only if new checker process was started
812
if (self.checker is not None
813
and old_checker_pid != self.checker.pid):
815
self.CheckerStarted(self.current_checker_command)
816
self.PropertyChanged(
817
dbus.String(u"checker_running"),
818
dbus.Boolean(True, variant_level=1))
821
def stop_checker(self, *args, **kwargs):
822
old_checker = getattr(self, u"checker", None)
823
r = Client.stop_checker(self, *args, **kwargs)
824
if (old_checker is not None
825
and getattr(self, u"checker", None) is None):
826
self.PropertyChanged(dbus.String(u"checker_running"),
827
dbus.Boolean(False, variant_level=1))
830
def _reset_approved(self):
831
self._approved = None
834
def approve(self, value=True):
835
self.send_changedstate()
836
self._approved = value
837
gobject.timeout_add(self._timedelta_to_milliseconds(self.approved_duration),
838
self._reset_approved)
841
## D-Bus methods, signals & properties
842
_interface = u"se.bsnet.fukt.Mandos.Client"
846
# CheckerCompleted - signal
847
@dbus.service.signal(_interface, signature=u"nxs")
848
def CheckerCompleted(self, exitcode, waitstatus, command):
852
# CheckerStarted - signal
853
@dbus.service.signal(_interface, signature=u"s")
854
def CheckerStarted(self, command):
858
# PropertyChanged - signal
859
@dbus.service.signal(_interface, signature=u"sv")
860
def PropertyChanged(self, property, value):
865
@dbus.service.signal(_interface)
868
Is sent after a successful transfer of secret from the Mandos
869
server to mandos-client
874
@dbus.service.signal(_interface, signature=u"s")
875
def Rejected(self, reason):
879
# NeedApproval - signal
880
@dbus.service.signal(_interface, signature=u"db")
881
def NeedApproval(self, timeout, default):
888
@dbus.service.method(_interface, in_signature=u"b")
889
def Approve(self, value):
893
@dbus.service.method(_interface)
895
return self.checked_ok()
898
@dbus.service.method(_interface)
903
# StartChecker - method
904
@dbus.service.method(_interface)
905
def StartChecker(self):
910
@dbus.service.method(_interface)
915
# StopChecker - method
916
@dbus.service.method(_interface)
917
def StopChecker(self):
922
# approved_pending - property
923
@dbus_service_property(_interface, signature=u"b", access=u"read")
924
def approved_pending_dbus_property(self):
925
return dbus.Boolean(bool(self.approvals_pending))
927
# approved_by_default - property
928
@dbus_service_property(_interface, signature=u"b",
930
def approved_by_default_dbus_property(self):
931
return dbus.Boolean(self.approved_by_default)
933
# approved_delay - property
934
@dbus_service_property(_interface, signature=u"t",
936
def approved_delay_dbus_property(self):
937
return dbus.UInt64(self.approved_delay_milliseconds())
939
# approved_duration - property
940
@dbus_service_property(_interface, signature=u"t",
942
def approved_duration_dbus_property(self):
943
return dbus.UInt64(self._timedelta_to_milliseconds(
944
self.approved_duration))
947
@dbus_service_property(_interface, signature=u"s", access=u"read")
948
def name_dbus_property(self):
949
return dbus.String(self.name)
951
# fingerprint - property
952
@dbus_service_property(_interface, signature=u"s", access=u"read")
953
def fingerprint_dbus_property(self):
954
return dbus.String(self.fingerprint)
957
@dbus_service_property(_interface, signature=u"s",
959
def host_dbus_property(self, value=None):
960
if value is None: # get
961
return dbus.String(self.host)
964
self.PropertyChanged(dbus.String(u"host"),
965
dbus.String(value, variant_level=1))
968
@dbus_service_property(_interface, signature=u"s", access=u"read")
969
def created_dbus_property(self):
970
return dbus.String(self._datetime_to_dbus(self.created))
972
# last_enabled - property
973
@dbus_service_property(_interface, signature=u"s", access=u"read")
974
def last_enabled_dbus_property(self):
975
if self.last_enabled is None:
976
return dbus.String(u"")
977
return dbus.String(self._datetime_to_dbus(self.last_enabled))
980
@dbus_service_property(_interface, signature=u"b",
982
def enabled_dbus_property(self, value=None):
983
if value is None: # get
984
return dbus.Boolean(self.enabled)
990
# last_checked_ok - property
991
@dbus_service_property(_interface, signature=u"s",
993
def last_checked_ok_dbus_property(self, value=None):
994
if value is not None:
371
def still_valid(self):
372
"""Has the timeout not yet passed for this client?"""
373
now = datetime.datetime.now()
997
374
if self.last_checked_ok is None:
998
return dbus.String(u"")
999
return dbus.String(self._datetime_to_dbus(self
1002
# timeout - property
1003
@dbus_service_property(_interface, signature=u"t",
1004
access=u"readwrite")
1005
def timeout_dbus_property(self, value=None):
1006
if value is None: # get
1007
return dbus.UInt64(self.timeout_milliseconds())
1008
self.timeout = datetime.timedelta(0, 0, 0, value)
1010
self.PropertyChanged(dbus.String(u"timeout"),
1011
dbus.UInt64(value, variant_level=1))
1012
if getattr(self, u"disable_initiator_tag", None) is None:
1014
# Reschedule timeout
1015
gobject.source_remove(self.disable_initiator_tag)
1016
self.disable_initiator_tag = None
1017
time_to_die = (self.
1018
_timedelta_to_milliseconds((self
1023
if time_to_die <= 0:
1024
# The timeout has passed
1027
self.disable_initiator_tag = (gobject.timeout_add
1028
(time_to_die, self.disable))
1030
# interval - property
1031
@dbus_service_property(_interface, signature=u"t",
1032
access=u"readwrite")
1033
def interval_dbus_property(self, value=None):
1034
if value is None: # get
1035
return dbus.UInt64(self.interval_milliseconds())
1036
self.interval = datetime.timedelta(0, 0, 0, value)
1038
self.PropertyChanged(dbus.String(u"interval"),
1039
dbus.UInt64(value, variant_level=1))
1040
if getattr(self, u"checker_initiator_tag", None) is None:
1042
# Reschedule checker run
1043
gobject.source_remove(self.checker_initiator_tag)
1044
self.checker_initiator_tag = (gobject.timeout_add
1045
(value, self.start_checker))
1046
self.start_checker() # Start one now, too
1048
# checker - property
1049
@dbus_service_property(_interface, signature=u"s",
1050
access=u"readwrite")
1051
def checker_dbus_property(self, value=None):
1052
if value is None: # get
1053
return dbus.String(self.checker_command)
1054
self.checker_command = value
1056
self.PropertyChanged(dbus.String(u"checker"),
1057
dbus.String(self.checker_command,
1060
# checker_running - property
1061
@dbus_service_property(_interface, signature=u"b",
1062
access=u"readwrite")
1063
def checker_running_dbus_property(self, value=None):
1064
if value is None: # get
1065
return dbus.Boolean(self.checker is not None)
1067
self.start_checker()
1071
# object_path - property
1072
@dbus_service_property(_interface, signature=u"o", access=u"read")
1073
def object_path_dbus_property(self):
1074
return self.dbus_object_path # is already a dbus.ObjectPath
1077
@dbus_service_property(_interface, signature=u"ay",
1078
access=u"write", byte_arrays=True)
1079
def secret_dbus_property(self, value):
1080
self.secret = str(value)
1085
class ProxyClient(object):
1086
def __init__(self, child_pipe, fpr, address):
1087
self._pipe = child_pipe
1088
self._pipe.send(('init', fpr, address))
1089
if not self._pipe.recv():
1092
def __getattribute__(self, name):
1093
if(name == '_pipe'):
1094
return super(ProxyClient, self).__getattribute__(name)
1095
self._pipe.send(('getattr', name))
1096
data = self._pipe.recv()
1097
if data[0] == 'data':
1099
if data[0] == 'function':
1100
def func(*args, **kwargs):
1101
self._pipe.send(('funcall', name, args, kwargs))
1102
return self._pipe.recv()[1]
1105
def __setattr__(self, name, value):
1106
if(name == '_pipe'):
1107
return super(ProxyClient, self).__setattr__(name, value)
1108
self._pipe.send(('setattr', name, value))
1111
class ClientHandler(socketserver.BaseRequestHandler, object):
1112
"""A class to handle client connections.
1114
Instantiated once for each connection to handle it.
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.
1115
431
Note: This will run in its own forked process."""
1117
433
def handle(self):
1118
with contextlib.closing(self.server.child_pipe) as child_pipe:
1119
logger.info(u"TCP connection from: %s",
1120
unicode(self.client_address))
1121
logger.debug(u"Pipe FD: %d",
1122
self.server.child_pipe.fileno())
1124
session = (gnutls.connection
1125
.ClientSession(self.request,
1127
.X509Credentials()))
1129
# Note: gnutls.connection.X509Credentials is really a
1130
# generic GnuTLS certificate credentials object so long as
1131
# no X.509 keys are added to it. Therefore, we can use it
1132
# here despite using OpenPGP certificates.
1134
#priority = u':'.join((u"NONE", u"+VERS-TLS1.1",
1135
# u"+AES-256-CBC", u"+SHA1",
1136
# u"+COMP-NULL", u"+CTYPE-OPENPGP",
1138
# Use a fallback default, since this MUST be set.
1139
priority = self.server.gnutls_priority
1140
if priority is None:
1141
priority = u"NORMAL"
1142
(gnutls.library.functions
1143
.gnutls_priority_set_direct(session._c_object,
1146
# Start communication using the Mandos protocol
1147
# Get protocol number
1148
line = self.request.makefile().readline()
1149
logger.debug(u"Protocol version: %r", line)
1151
if int(line.strip().split()[0]) > 1:
1153
except (ValueError, IndexError, RuntimeError), error:
1154
logger.error(u"Unknown protocol version: %s", error)
1157
# Start GnuTLS connection
1160
except gnutls.errors.GNUTLSError, error:
1161
logger.warning(u"Handshake failed: %s", error)
1162
# Do not run session.bye() here: the session is not
1163
# established. Just abandon the request.
1165
logger.debug(u"Handshake succeeded")
1167
approval_required = False
1170
fpr = self.fingerprint(self.peer_certificate
1172
except (TypeError, gnutls.errors.GNUTLSError), error:
1173
logger.warning(u"Bad certificate: %s", error)
1175
logger.debug(u"Fingerprint: %s", fpr)
1178
client = ProxyClient(child_pipe, fpr,
1179
self.client_address)
1183
if client.approved_delay:
1184
delay = client.approved_delay
1185
client.approvals_pending += 1
1186
approval_required = True
1189
if not client.enabled:
1190
logger.warning(u"Client %s is disabled",
1192
if self.server.use_dbus:
1194
client.Rejected("Disabled")
1197
if client._approved or not client.approved_delay:
1198
#We are approved or approval is disabled
1200
elif client._approved is None:
1201
logger.info(u"Client %s need approval",
1203
if self.server.use_dbus:
1205
client.NeedApproval(
1206
client.approved_delay_milliseconds(),
1207
client.approved_by_default)
1209
logger.warning(u"Client %s was not approved",
1211
if self.server.use_dbus:
1213
client.Rejected("Disapproved")
1216
#wait until timeout or approved
1217
#x = float(client._timedelta_to_milliseconds(delay))
1218
time = datetime.datetime.now()
1219
client.changedstate.acquire()
1220
client.changedstate.wait(float(client._timedelta_to_milliseconds(delay) / 1000))
1221
client.changedstate.release()
1222
time2 = datetime.datetime.now()
1223
if (time2 - time) >= delay:
1224
if not client.approved_by_default:
1225
logger.warning("Client %s timed out while"
1226
" waiting for approval",
1228
if self.server.use_dbus:
1230
client.Rejected("Approval timed out")
1235
delay -= time2 - time
1238
while sent_size < len(client.secret):
1240
sent = session.send(client.secret[sent_size:])
1241
except (gnutls.errors.GNUTLSError), error:
1242
logger.warning("gnutls send failed")
1244
logger.debug(u"Sent: %d, remaining: %d",
1245
sent, len(client.secret)
1246
- (sent_size + sent))
1249
logger.info(u"Sending secret to %s", client.name)
1250
# bump the timeout as if seen
1252
if self.server.use_dbus:
1257
if approval_required:
1258
client.approvals_pending -= 1
1261
except (gnutls.errors.GNUTLSError), error:
1262
logger.warning("gnutls bye failed")
1265
def peer_certificate(session):
1266
"Return the peer's OpenPGP certificate as a bytestring"
1267
# If not an OpenPGP certificate...
1268
if (gnutls.library.functions
1269
.gnutls_certificate_type_get(session._c_object)
1270
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1271
# ...do the normal thing
1272
return session.peer_certificate
1273
list_size = ctypes.c_uint(1)
1274
cert_list = (gnutls.library.functions
1275
.gnutls_certificate_get_peers
1276
(session._c_object, ctypes.byref(list_size)))
1277
if not bool(cert_list) and list_size.value != 0:
1278
raise gnutls.errors.GNUTLSError(u"error getting peer"
1280
if list_size.value == 0:
1283
return ctypes.string_at(cert.data, cert.size)
1286
def fingerprint(openpgp):
1287
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
1288
# New GnuTLS "datum" with the OpenPGP public key
1289
datum = (gnutls.library.types
1290
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1293
ctypes.c_uint(len(openpgp))))
1294
# New empty GnuTLS certificate
1295
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1296
(gnutls.library.functions
1297
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
1298
# Import the OpenPGP public key into the certificate
1299
(gnutls.library.functions
1300
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1301
gnutls.library.constants
1302
.GNUTLS_OPENPGP_FMT_RAW))
1303
# Verify the self signature in the key
1304
crtverify = ctypes.c_uint()
1305
(gnutls.library.functions
1306
.gnutls_openpgp_crt_verify_self(crt, 0,
1307
ctypes.byref(crtverify)))
1308
if crtverify.value != 0:
1309
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1310
raise (gnutls.errors.CertificateSecurityError
1312
# New buffer for the fingerprint
1313
buf = ctypes.create_string_buffer(20)
1314
buf_len = ctypes.c_size_t()
1315
# Get the fingerprint from the certificate into the buffer
1316
(gnutls.library.functions
1317
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1318
ctypes.byref(buf_len)))
1319
# Deinit the certificate
1320
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1321
# Convert the buffer to a Python bytestring
1322
fpr = ctypes.string_at(buf, buf_len.value)
1323
# Convert the bytestring to hexadecimal notation
1324
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
1328
class MultiprocessingMixIn(object):
1329
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
1330
def sub_process_main(self, request, address):
1332
self.finish_request(request, address)
1334
self.handle_error(request, address)
1335
self.close_request(request)
1337
def process_request(self, request, address):
1338
"""Start a new process to process the request."""
1339
multiprocessing.Process(target = self.sub_process_main,
1340
args = (request, address)).start()
1342
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1343
""" adds a pipe to the MixIn """
1344
def process_request(self, request, client_address):
1345
"""Overrides and wraps the original process_request().
1347
This function creates a new pipe in self.pipe
1349
parent_pipe, self.child_pipe = multiprocessing.Pipe()
1351
super(MultiprocessingMixInWithPipe,
1352
self).process_request(request, client_address)
1353
self.child_pipe.close()
1354
self.add_pipe(parent_pipe)
1356
def add_pipe(self, parent_pipe):
1357
"""Dummy function; override as necessary"""
1360
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1361
socketserver.TCPServer, object):
1362
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
434
logger.debug(u"TCP connection from: %s",
435
unicode(self.client_address))
436
session = gnutls.connection.ClientSession\
437
(self.request, gnutls.connection.X509Credentials())
438
# Note: gnutls.connection.X509Credentials is really a generic
439
# GnuTLS certificate credentials object so long as no X.509
440
# keys are added to it. Therefore, we can use it here despite
441
# using OpenPGP certificates.
443
#priority = ':'.join(("NONE", "+VERS-TLS1.1", "+AES-256-CBC",
444
# "+SHA1", "+COMP-NULL", "+CTYPE-OPENPGP",
446
priority = "NORMAL" # Fallback default, since this
448
if self.server.settings["priority"]:
449
priority = self.server.settings["priority"]
450
gnutls.library.functions.gnutls_priority_set_direct\
451
(session._c_object, priority, None);
455
except gnutls.errors.GNUTLSError, error:
456
logger.debug(u"Handshake failed: %s", error)
457
# Do not run session.bye() here: the session is not
458
# established. Just abandon the request.
461
fpr = fingerprint(peer_certificate(session))
462
except (TypeError, gnutls.errors.GNUTLSError), error:
463
logger.debug(u"Bad certificate: %s", error)
466
logger.debug(u"Fingerprint: %s", fpr)
468
for c in self.server.clients:
469
if c.fingerprint == fpr:
473
logger.debug(u"Client not found for fingerprint: %s", fpr)
476
# Have to check if client.still_valid(), since it is possible
477
# that the client timed out while establishing the GnuTLS
479
if not client.still_valid():
480
logger.debug(u"Client %(name)s is invalid", vars(client))
484
while sent_size < len(client.secret):
485
sent = session.send(client.secret[sent_size:])
486
logger.debug(u"Sent: %d, remaining: %d",
487
sent, len(client.secret)
488
- (sent_size + sent))
493
class IPv6_TCPServer(SocketServer.ForkingTCPServer, object):
494
"""IPv6 TCP server. Accepts 'None' as address and/or port.
1365
enabled: Boolean; whether this server is activated yet
1366
interface: None or a network interface name (string)
1367
use_ipv6: Boolean; to use IPv6 or not
496
settings: Server settings
497
clients: Set() of Client objects
1369
def __init__(self, server_address, RequestHandlerClass,
1370
interface=None, use_ipv6=True):
1371
self.interface = interface
1373
self.address_family = socket.AF_INET6
1374
socketserver.TCPServer.__init__(self, server_address,
1375
RequestHandlerClass)
499
address_family = socket.AF_INET6
500
def __init__(self, *args, **kwargs):
501
if "settings" in kwargs:
502
self.settings = kwargs["settings"]
503
del kwargs["settings"]
504
if "clients" in kwargs:
505
self.clients = kwargs["clients"]
506
del kwargs["clients"]
507
return super(type(self), self).__init__(*args, **kwargs)
1376
508
def server_bind(self):
1377
509
"""This overrides the normal server_bind() function
1378
510
to bind to an interface if one was specified, and also NOT to
1379
511
bind to an address or port if they were not specified."""
1380
if self.interface is not None:
1381
if SO_BINDTODEVICE is None:
1382
logger.error(u"SO_BINDTODEVICE does not exist;"
1383
u" cannot bind to interface %s",
1387
self.socket.setsockopt(socket.SOL_SOCKET,
1391
except socket.error, error:
1392
if error[0] == errno.EPERM:
1393
logger.error(u"No permission to"
1394
u" bind to interface %s",
1396
elif error[0] == errno.ENOPROTOOPT:
1397
logger.error(u"SO_BINDTODEVICE not available;"
1398
u" cannot bind to interface %s",
512
if self.settings["interface"]:
513
# 25 is from /usr/include/asm-i486/socket.h
514
SO_BINDTODEVICE = getattr(socket, "SO_BINDTODEVICE", 25)
516
self.socket.setsockopt(socket.SOL_SOCKET,
518
self.settings["interface"])
519
except socket.error, error:
520
if error[0] == errno.EPERM:
521
logger.warning(u"No permission to"
522
u" bind to interface %s",
523
self.settings["interface"])
1402
526
# Only bind(2) the socket if we really need to.
1403
527
if self.server_address[0] or self.server_address[1]:
1404
528
if not self.server_address[0]:
1405
if self.address_family == socket.AF_INET6:
1406
any_address = u"::" # in6addr_any
1408
any_address = socket.INADDR_ANY
1409
self.server_address = (any_address,
530
self.server_address = (in6addr_any,
1410
531
self.server_address[1])
1411
elif not self.server_address[1]:
532
elif self.server_address[1] is None:
1412
533
self.server_address = (self.server_address[0],
1414
# if self.interface:
1415
# self.server_address = (self.server_address[0],
1420
return socketserver.TCPServer.server_bind(self)
1423
class MandosServer(IPv6_TCPServer):
1427
clients: set of Client objects
1428
gnutls_priority GnuTLS priority string
1429
use_dbus: Boolean; to emit D-Bus signals or not
1431
Assumes a gobject.MainLoop event loop.
1433
def __init__(self, server_address, RequestHandlerClass,
1434
interface=None, use_ipv6=True, clients=None,
1435
gnutls_priority=None, use_dbus=True):
1436
self.enabled = False
1437
self.clients = clients
1438
if self.clients is None:
1439
self.clients = set()
1440
self.use_dbus = use_dbus
1441
self.gnutls_priority = gnutls_priority
1442
IPv6_TCPServer.__init__(self, server_address,
1443
RequestHandlerClass,
1444
interface = interface,
1445
use_ipv6 = use_ipv6)
1446
def server_activate(self):
1448
return socketserver.TCPServer.server_activate(self)
1451
def add_pipe(self, parent_pipe):
1452
# Call "handle_ipc" for both data and EOF events
1453
gobject.io_add_watch(parent_pipe.fileno(),
1454
gobject.IO_IN | gobject.IO_HUP,
1455
functools.partial(self.handle_ipc,
1456
parent_pipe = parent_pipe))
1458
def handle_ipc(self, source, condition, parent_pipe=None,
1459
client_object=None):
1461
gobject.IO_IN: u"IN", # There is data to read.
1462
gobject.IO_OUT: u"OUT", # Data can be written (without
1464
gobject.IO_PRI: u"PRI", # There is urgent data to read.
1465
gobject.IO_ERR: u"ERR", # Error condition.
1466
gobject.IO_HUP: u"HUP" # Hung up (the connection has been
1467
# broken, usually for pipes and
1470
conditions_string = ' | '.join(name
1472
condition_names.iteritems()
1473
if cond & condition)
1474
# error or the other end of multiprocessing.Pipe has closed
1475
if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
1478
# Read a request from the child
1479
request = parent_pipe.recv()
1480
command = request[0]
1482
if command == 'init':
1484
address = request[2]
1486
for c in self.clients:
1487
if c.fingerprint == fpr:
1491
logger.warning(u"Client not found for fingerprint: %s, ad"
1492
u"dress: %s", fpr, address)
1495
mandos_dbus_service.ClientNotFound(fpr, address)
1496
parent_pipe.send(False)
1499
gobject.io_add_watch(parent_pipe.fileno(),
1500
gobject.IO_IN | gobject.IO_HUP,
1501
functools.partial(self.handle_ipc,
1502
parent_pipe = parent_pipe,
1503
client_object = client))
1504
parent_pipe.send(True)
1505
# remove the old hook in favor of the new above hook on same fileno
1507
if command == 'funcall':
1508
funcname = request[1]
1512
parent_pipe.send(('data', getattr(client_object, funcname)(*args, **kwargs)))
1514
if command == 'getattr':
1515
attrname = request[1]
1516
if callable(client_object.__getattribute__(attrname)):
1517
parent_pipe.send(('function',))
1519
parent_pipe.send(('data', client_object.__getattribute__(attrname)))
1521
if command == 'setattr':
1522
attrname = request[1]
1524
setattr(client_object, attrname, value)
535
return super(type(self), self).server_bind()
1529
538
def string_to_delta(interval):
1530
539
"""Parse a string and return a datetime.timedelta
1532
>>> string_to_delta(u'7d')
541
>>> string_to_delta('7d')
1533
542
datetime.timedelta(7)
1534
>>> string_to_delta(u'60s')
543
>>> string_to_delta('60s')
1535
544
datetime.timedelta(0, 60)
1536
>>> string_to_delta(u'60m')
545
>>> string_to_delta('60m')
1537
546
datetime.timedelta(0, 3600)
1538
>>> string_to_delta(u'24h')
547
>>> string_to_delta('24h')
1539
548
datetime.timedelta(1)
1540
549
>>> string_to_delta(u'1w')
1541
550
datetime.timedelta(7)
1542
>>> string_to_delta(u'5m 30s')
1543
datetime.timedelta(0, 330)
1545
timevalue = datetime.timedelta(0)
1546
for s in interval.split():
1548
suffix = unicode(s[-1])
1551
delta = datetime.timedelta(value)
1552
elif suffix == u"s":
1553
delta = datetime.timedelta(0, value)
1554
elif suffix == u"m":
1555
delta = datetime.timedelta(0, 0, 0, 0, value)
1556
elif suffix == u"h":
1557
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
1558
elif suffix == u"w":
1559
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
1561
raise ValueError(u"Unknown suffix %r" % suffix)
1562
except (ValueError, IndexError), e:
1563
raise ValueError(e.message)
1568
def if_nametoindex(interface):
1569
"""Call the C function if_nametoindex(), or equivalent
553
suffix=unicode(interval[-1])
554
value=int(interval[:-1])
556
delta = datetime.timedelta(value)
558
delta = datetime.timedelta(0, value)
560
delta = datetime.timedelta(0, 0, 0, 0, value)
562
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
564
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
567
except (ValueError, IndexError):
572
def server_state_changed(state):
573
"""Derived from the Avahi example code"""
574
if state == avahi.SERVER_COLLISION:
575
logger.warning(u"Server name collision")
577
elif state == avahi.SERVER_RUNNING:
581
def entry_group_state_changed(state, error):
582
"""Derived from the Avahi example code"""
583
logger.debug(u"state change: %i", state)
1571
Note: This function cannot accept a unicode string."""
1572
global if_nametoindex
585
if state == avahi.ENTRY_GROUP_ESTABLISHED:
586
logger.debug(u"Service established.")
587
elif state == avahi.ENTRY_GROUP_COLLISION:
588
logger.warning(u"Service name collision.")
590
elif state == avahi.ENTRY_GROUP_FAILURE:
591
logger.critical(u"Error in group state changed %s",
593
raise AvahiGroupError("State changed: %s", str(error))
595
def if_nametoindex(interface, _func=[None]):
596
"""Call the C function if_nametoindex(), or equivalent"""
597
if _func[0] is not None:
598
return _func[0](interface)
1574
if_nametoindex = (ctypes.cdll.LoadLibrary
1575
(ctypes.util.find_library(u"c"))
600
if "ctypes.util" not in sys.modules:
604
libc = ctypes.cdll.LoadLibrary\
605
(ctypes.util.find_library("c"))
606
_func[0] = libc.if_nametoindex
607
return _func[0](interface)
1577
611
except (OSError, AttributeError):
1578
logger.warning(u"Doing if_nametoindex the hard way")
1579
def if_nametoindex(interface):
612
if "struct" not in sys.modules:
614
if "fcntl" not in sys.modules:
616
def the_hard_way(interface):
1580
617
"Get an interface index the hard way, i.e. using fcntl()"
1581
618
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
1582
with contextlib.closing(socket.socket()) as s:
1583
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1584
struct.pack(str(u"16s16x"),
1586
interface_index = struct.unpack(str(u"I"),
620
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
621
struct.pack("16s16x", interface))
623
interface_index = struct.unpack("I", ifreq[16:20])[0]
1588
624
return interface_index
1589
return if_nametoindex(interface)
1592
def daemon(nochdir = False, noclose = False):
625
_func[0] = the_hard_way
626
return _func[0](interface)
629
def daemon(nochdir, noclose):
1593
630
"""See daemon(3). Standard BSD Unix function.
1595
631
This should really exist as os.daemon, but it doesn't (yet)."""
1604
638
# Close all standard open file descriptors
1605
639
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
1606
640
if not stat.S_ISCHR(os.fstat(null).st_mode):
1607
641
raise OSError(errno.ENODEV,
1608
u"%s not a character device"
642
"/dev/null not a character device")
1610
643
os.dup2(null, sys.stdin.fileno())
1611
644
os.dup2(null, sys.stdout.fileno())
1612
645
os.dup2(null, sys.stderr.fileno())
1656
681
# Default values for config file for server-global settings
1657
server_defaults = { u"interface": u"",
1662
u"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1663
u"servicename": u"Mandos",
1664
u"use_dbus": u"True",
1665
u"use_ipv6": u"True",
682
server_defaults = { "interface": "",
687
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
688
"servicename": "Mandos",
1669
691
# Parse config file for server-global settings
1670
server_config = configparser.SafeConfigParser(server_defaults)
692
server_config = ConfigParser.SafeConfigParser(server_defaults)
1671
693
del server_defaults
1672
server_config.read(os.path.join(options.configdir,
694
server_config.read(os.path.join(options.configdir, "server.conf"))
695
server_section = "server"
1674
696
# Convert the SafeConfigParser object to a dict
1675
server_settings = server_config.defaults()
1676
# Use the appropriate methods on the non-string config options
1677
for option in (u"debug", u"use_dbus", u"use_ipv6"):
1678
server_settings[option] = server_config.getboolean(u"DEFAULT",
1680
if server_settings["port"]:
1681
server_settings["port"] = server_config.getint(u"DEFAULT",
697
server_settings = dict(server_config.items(server_section))
698
# Use getboolean on the boolean config option
699
server_settings["debug"] = server_config.getboolean\
700
(server_section, "debug")
1683
701
del server_config
1685
703
# Override the settings from the config file with command line
1686
704
# options, if set.
1687
for option in (u"interface", u"address", u"port", u"debug",
1688
u"priority", u"servicename", u"configdir",
1689
u"use_dbus", u"use_ipv6", u"debuglevel"):
705
for option in ("interface", "address", "port", "debug",
706
"priority", "servicename", "configdir"):
1690
707
value = getattr(options, option)
1691
708
if value is not None:
1692
709
server_settings[option] = value
1694
# Force all strings to be unicode
1695
for option in server_settings.keys():
1696
if type(server_settings[option]) is str:
1697
server_settings[option] = unicode(server_settings[option])
1698
711
# Now we have our good server settings in "server_settings"
1700
##################################################################
1703
debug = server_settings[u"debug"]
1704
debuglevel = server_settings[u"debuglevel"]
1705
use_dbus = server_settings[u"use_dbus"]
1706
use_ipv6 = server_settings[u"use_ipv6"]
1708
if server_settings[u"servicename"] != u"Mandos":
1709
syslogger.setFormatter(logging.Formatter
1710
(u'Mandos (%s) [%%(process)d]:'
1711
u' %%(levelname)s: %%(message)s'
1712
% server_settings[u"servicename"]))
1714
713
# Parse config file with clients
1715
client_defaults = { u"timeout": u"1h",
1717
u"checker": u"fping -q -- %%(host)s",
1719
u"approved_delay": u"0s",
1720
u"approved_duration": u"1s",
714
client_defaults = { "timeout": "1h",
716
"checker": "fping -q -- %%(fqdn)s",
1722
client_config = configparser.SafeConfigParser(client_defaults)
1723
client_config.read(os.path.join(server_settings[u"configdir"],
1726
global mandos_dbus_service
1727
mandos_dbus_service = None
1729
tcp_server = MandosServer((server_settings[u"address"],
1730
server_settings[u"port"]),
1732
interface=(server_settings[u"interface"]
1736
server_settings[u"priority"],
1738
pidfilename = u"/var/run/mandos.pid"
1740
pidfile = open(pidfilename, u"w")
1742
logger.error(u"Could not open file %r", pidfilename)
1745
uid = pwd.getpwnam(u"_mandos").pw_uid
1746
gid = pwd.getpwnam(u"_mandos").pw_gid
1749
uid = pwd.getpwnam(u"mandos").pw_uid
1750
gid = pwd.getpwnam(u"mandos").pw_gid
1753
uid = pwd.getpwnam(u"nobody").pw_uid
1754
gid = pwd.getpwnam(u"nobody").pw_gid
1761
except OSError, error:
1762
if error[0] != errno.EPERM:
1765
# Enable all possible GnuTLS debugging
1768
if not debug and not debuglevel:
1769
syslogger.setLevel(logging.WARNING)
1770
console.setLevel(logging.WARNING)
1772
level = getattr(logging, debuglevel.upper())
1773
syslogger.setLevel(level)
1774
console.setLevel(level)
1777
# "Use a log level over 10 to enable all debugging options."
1779
gnutls.library.functions.gnutls_global_set_log_level(11)
1781
@gnutls.library.types.gnutls_log_func
1782
def debug_gnutls(level, string):
1783
logger.debug(u"GnuTLS: %s", string[:-1])
1785
(gnutls.library.functions
1786
.gnutls_global_set_log_function(debug_gnutls))
1788
# Redirect stdin so all checkers get /dev/null
1789
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
1790
os.dup2(null, sys.stdin.fileno())
1794
# No console logging
1795
logger.removeHandler(console)
718
client_config = ConfigParser.SafeConfigParser(client_defaults)
719
client_config.read(os.path.join(server_settings["configdir"],
723
service = AvahiService(name = server_settings["servicename"],
724
type = "_mandos._tcp", );
725
if server_settings["interface"]:
726
service.interface = if_nametoindex(server_settings["interface"])
1798
728
global main_loop
1799
731
# From the Avahi example code
1800
732
DBusGMainLoop(set_as_default=True )
1801
733
main_loop = gobject.MainLoop()
1802
734
bus = dbus.SystemBus()
735
server = dbus.Interface(
736
bus.get_object( avahi.DBUS_NAME, avahi.DBUS_PATH_SERVER ),
737
avahi.DBUS_INTERFACE_SERVER )
1803
738
# End of Avahi example code
1806
bus_name = dbus.service.BusName(u"se.bsnet.fukt.Mandos",
1807
bus, do_not_queue=True)
1808
except dbus.exceptions.NameExistsException, e:
1809
logger.error(unicode(e) + u", disabling D-Bus")
1811
server_settings[u"use_dbus"] = False
1812
tcp_server.use_dbus = False
1813
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1814
service = AvahiService(name = server_settings[u"servicename"],
1815
servicetype = u"_mandos._tcp",
1816
protocol = protocol, bus = bus)
1817
if server_settings["interface"]:
1818
service.interface = (if_nametoindex
1819
(str(server_settings[u"interface"])))
740
debug = server_settings["debug"]
743
console = logging.StreamHandler()
744
# console.setLevel(logging.DEBUG)
745
console.setFormatter(logging.Formatter\
746
('%(levelname)s: %(message)s'))
747
logger.addHandler(console)
751
def remove_from_clients(client):
752
clients.remove(client)
754
logger.debug(u"No clients left, exiting")
757
clients.update(Set(Client(name=section,
758
stop_hook = remove_from_clients,
759
**(dict(client_config\
761
for section in client_config.sections()))
1822
# Close all input and output, do double fork, etc.
1825
global multiprocessing_manager
1826
multiprocessing_manager = multiprocessing.Manager()
1828
client_class = Client
1830
client_class = functools.partial(ClientDBus, bus = bus)
1831
def client_config_items(config, section):
1832
special_settings = {
1833
"approved_by_default":
1834
lambda: config.getboolean(section,
1835
"approved_by_default"),
1837
for name, value in config.items(section):
1839
yield (name, special_settings[name]())
1843
tcp_server.clients.update(set(
1844
client_class(name = section,
1845
config= dict(client_config_items(
1846
client_config, section)))
1847
for section in client_config.sections()))
1848
if not tcp_server.clients:
1849
logger.warning(u"No clients defined")
1854
pidfile.write(str(pid) + "\n")
1857
logger.error(u"Could not write to file %r with PID %d",
1860
# "pidfile" was never created
767
"Cleanup function; run on exit"
769
# From the Avahi example code
770
if not group is None:
773
# End of Avahi example code
776
client = clients.pop()
777
client.stop_hook = None
780
atexit.register(cleanup)
1865
783
signal.signal(signal.SIGINT, signal.SIG_IGN)
1866
784
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1867
785
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
1870
class MandosDBusService(dbus.service.Object):
1871
"""A D-Bus proxy object"""
1873
dbus.service.Object.__init__(self, bus, u"/")
1874
_interface = u"se.bsnet.fukt.Mandos"
1876
@dbus.service.signal(_interface, signature=u"o")
1877
def ClientAdded(self, objpath):
1881
@dbus.service.signal(_interface, signature=u"ss")
1882
def ClientNotFound(self, fingerprint, address):
1886
@dbus.service.signal(_interface, signature=u"os")
1887
def ClientRemoved(self, objpath, name):
1891
@dbus.service.method(_interface, out_signature=u"ao")
1892
def GetAllClients(self):
1894
return dbus.Array(c.dbus_object_path
1895
for c in tcp_server.clients)
1897
@dbus.service.method(_interface,
1898
out_signature=u"a{oa{sv}}")
1899
def GetAllClientsWithProperties(self):
1901
return dbus.Dictionary(
1902
((c.dbus_object_path, c.GetAll(u""))
1903
for c in tcp_server.clients),
1904
signature=u"oa{sv}")
1906
@dbus.service.method(_interface, in_signature=u"o")
1907
def RemoveClient(self, object_path):
1909
for c in tcp_server.clients:
1910
if c.dbus_object_path == object_path:
1911
tcp_server.clients.remove(c)
1912
c.remove_from_connection()
1913
# Don't signal anything except ClientRemoved
1914
c.disable(quiet=True)
1916
self.ClientRemoved(object_path, c.name)
1918
raise KeyError(object_path)
1922
mandos_dbus_service = MandosDBusService()
1925
"Cleanup function; run on exit"
1928
while tcp_server.clients:
1929
client = tcp_server.clients.pop()
1931
client.remove_from_connection()
1932
client.disable_hook = None
1933
# Don't signal anything except ClientRemoved
1934
client.disable(quiet=True)
1937
mandos_dbus_service.ClientRemoved(client.dbus_object_path,
1940
atexit.register(cleanup)
1942
for client in tcp_server.clients:
1945
mandos_dbus_service.ClientAdded(client.dbus_object_path)
1949
tcp_server.server_activate()
787
for client in clients:
790
tcp_server = IPv6_TCPServer((server_settings["address"],
791
server_settings["port"]),
793
settings=server_settings,
1951
795
# Find out what port we got
1952
796
service.port = tcp_server.socket.getsockname()[1]
1954
logger.info(u"Now listening on address %r, port %d,"
1955
" flowinfo %d, scope_id %d"
1956
% tcp_server.socket.getsockname())
1958
logger.info(u"Now listening on address %r, port %d"
1959
% tcp_server.socket.getsockname())
797
logger.debug(u"Now listening on address %r, port %d, flowinfo %d,"
798
u" scope_id %d" % tcp_server.socket.getsockname())
1961
800
#service.interface = tcp_server.socket.getsockname()[3]
1964
803
# From the Avahi example code
804
server.connect_to_signal("StateChanged", server_state_changed)
806
server_state_changed(server.GetState())
1967
807
except dbus.exceptions.DBusException, error:
1968
808
logger.critical(u"DBusException: %s", error)
1971
810
# End of Avahi example code
1973
812
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
1974
813
lambda *args, **kwargs:
1975
(tcp_server.handle_request
1976
(*args[2:], **kwargs) or True))
814
tcp_server.handle_request\
815
(*args[2:], **kwargs) or True)
1978
logger.debug(u"Starting main loop")
817
logger.debug("Starting main loop")
818
main_loop_started = True
1980
820
except AvahiError, error:
1981
logger.critical(u"AvahiError: %s", error)
821
logger.critical(u"AvahiError: %s" + unicode(error))
1984
823
except KeyboardInterrupt:
1987
logger.debug(u"Server received KeyboardInterrupt")
1988
logger.debug(u"Server exiting")
1989
# Must run before the D-Bus bus name gets deregistered
1992
827
if __name__ == '__main__':