170
170
# End of Avahi example code
173
def _datetime_to_dbus(dt, variant_level=0):
174
"""Convert a UTC datetime.datetime() to a D-Bus type."""
175
return dbus.String(dt.isoformat(), variant_level=variant_level)
178
class Client(dbus.service.Object):
173
class Client(object):
179
174
"""A representation of a client host served by this server.
181
name: string; from the config file, used in log messages and
176
name: string; from the config file, used in log messages
183
177
fingerprint: string (40 or 32 hexadecimal digits); used to
184
178
uniquely identify the client
185
secret: bytestring; sent verbatim (over TLS) to client
186
host: string; available for use by the checker command
187
created: datetime.datetime(); (UTC) object creation
188
last_enabled: datetime.datetime(); (UTC)
190
last_checked_ok: datetime.datetime(); (UTC) or None
191
timeout: datetime.timedelta(); How long from last_checked_ok
192
until this client is invalid
193
interval: datetime.timedelta(); How often to start a new checker
194
disable_hook: If set, called by disable() as disable_hook(self)
195
checker: subprocess.Popen(); a running checker process used
196
to see if the client lives.
197
'None' if no process is running.
179
secret: bytestring; sent verbatim (over TLS) to client
180
host: string; available for use by the checker command
181
created: datetime.datetime(); object creation, not client host
182
last_checked_ok: datetime.datetime() or None if not yet checked OK
183
timeout: datetime.timedelta(); How long from last_checked_ok
184
until this client is invalid
185
interval: datetime.timedelta(); How often to start a new checker
186
stop_hook: If set, called by stop() as stop_hook(self)
187
checker: subprocess.Popen(); a running checker process used
188
to see if the client lives.
189
'None' if no process is running.
198
190
checker_initiator_tag: a gobject event source tag, or None
199
disable_initiator_tag: - '' -
191
stop_initiator_tag: - '' -
200
192
checker_callback_tag: - '' -
201
193
checker_command: string; External command which is run to check if
202
194
client lives. %() expansions are done at
203
195
runtime with vars(self) as dict, so that for
204
196
instance %(name)s can be used in the command.
205
use_dbus: bool(); Whether to provide D-Bus interface and signals
206
dbus_object_path: dbus.ObjectPath ; only set if self.use_dbus
198
_timeout: Real variable for 'timeout'
199
_interval: Real variable for 'interval'
200
_timeout_milliseconds: Used when calling gobject.timeout_add()
201
_interval_milliseconds: - '' -
208
def timeout_milliseconds(self):
209
"Return the 'timeout' attribute in milliseconds"
210
return ((self.timeout.days * 24 * 60 * 60 * 1000)
211
+ (self.timeout.seconds * 1000)
212
+ (self.timeout.microseconds // 1000))
214
def interval_milliseconds(self):
215
"Return the 'interval' attribute in milliseconds"
216
return ((self.interval.days * 24 * 60 * 60 * 1000)
217
+ (self.interval.seconds * 1000)
218
+ (self.interval.microseconds // 1000))
220
def __init__(self, name = None, disable_hook=None, config=None,
203
def _set_timeout(self, timeout):
204
"Setter function for 'timeout' attribute"
205
self._timeout = timeout
206
self._timeout_milliseconds = ((self.timeout.days
207
* 24 * 60 * 60 * 1000)
208
+ (self.timeout.seconds * 1000)
209
+ (self.timeout.microseconds
211
timeout = property(lambda self: self._timeout,
214
def _set_interval(self, interval):
215
"Setter function for 'interval' attribute"
216
self._interval = interval
217
self._interval_milliseconds = ((self.interval.days
218
* 24 * 60 * 60 * 1000)
219
+ (self.interval.seconds
221
+ (self.interval.microseconds
223
interval = property(lambda self: self._interval,
226
def __init__(self, name = None, stop_hook=None, config=None):
222
227
"""Note: the 'checker' key in 'config' sets the
223
228
'checker_command' attribute and *not* the 'checker'
226
230
if config is None:
228
233
logger.debug(u"Creating client %r", self.name)
229
self.use_dbus = False # During __init__
230
234
# Uppercase and remove spaces from fingerprint for later
231
235
# comparison purposes with return value from the fingerprint()
233
self.fingerprint = (config["fingerprint"].upper()
237
self.fingerprint = config["fingerprint"].upper()\
235
239
logger.debug(u" Fingerprint: %s", self.fingerprint)
236
240
if "secret" in config:
237
241
self.secret = config["secret"].decode(u"base64")
238
242
elif "secfile" in config:
239
with closing(open(os.path.expanduser
241
(config["secfile"])))) as secfile:
242
self.secret = secfile.read()
243
secfile = open(os.path.expanduser(os.path.expandvars
244
(config["secfile"])))
245
self.secret = secfile.read()
244
248
raise TypeError(u"No secret or secfile for client %s"
246
250
self.host = config.get("host", "")
247
self.created = datetime.datetime.utcnow()
249
self.last_enabled = None
251
self.created = datetime.datetime.now()
250
252
self.last_checked_ok = None
251
253
self.timeout = string_to_delta(config["timeout"])
252
254
self.interval = string_to_delta(config["interval"])
253
self.disable_hook = disable_hook
255
self.stop_hook = stop_hook
254
256
self.checker = None
255
257
self.checker_initiator_tag = None
256
self.disable_initiator_tag = None
258
self.stop_initiator_tag = None
257
259
self.checker_callback_tag = None
258
self.checker_command = config["checker"]
259
self.last_connect = None
260
# Only now, when this client is initialized, can it show up on
262
self.use_dbus = use_dbus
264
self.dbus_object_path = (dbus.ObjectPath
266
+ self.name.replace(".", "_")))
267
dbus.service.Object.__init__(self, bus,
268
self.dbus_object_path)
260
self.check_command = config["checker"]
271
262
"""Start this client's checker and timeout hooks"""
272
self.last_enabled = datetime.datetime.utcnow()
273
263
# Schedule a new checker to be started an 'interval' from now,
274
264
# and every interval from then on.
275
self.checker_initiator_tag = (gobject.timeout_add
276
(self.interval_milliseconds(),
265
self.checker_initiator_tag = gobject.timeout_add\
266
(self._interval_milliseconds,
278
268
# Also start a new checker *right now*.
279
269
self.start_checker()
280
# Schedule a disable() when 'timeout' has passed
281
self.disable_initiator_tag = (gobject.timeout_add
282
(self.timeout_milliseconds(),
287
self.PropertyChanged(dbus.String(u"enabled"),
288
dbus.Boolean(True, variant_level=1))
289
self.PropertyChanged(dbus.String(u"last_enabled"),
290
(_datetime_to_dbus(self.last_enabled,
294
"""Disable this client."""
295
if not getattr(self, "enabled", False):
270
# Schedule a stop() when 'timeout' has passed
271
self.stop_initiator_tag = gobject.timeout_add\
272
(self._timeout_milliseconds,
276
The possibility that a client might be restarted is left open,
277
but not currently used."""
278
# If this client doesn't have a secret, it is already stopped.
279
if hasattr(self, "secret") and self.secret:
280
logger.info(u"Stopping client %s", self.name)
297
logger.info(u"Disabling client %s", self.name)
298
if getattr(self, "disable_initiator_tag", False):
299
gobject.source_remove(self.disable_initiator_tag)
300
self.disable_initiator_tag = None
284
if getattr(self, "stop_initiator_tag", False):
285
gobject.source_remove(self.stop_initiator_tag)
286
self.stop_initiator_tag = None
301
287
if getattr(self, "checker_initiator_tag", False):
302
288
gobject.source_remove(self.checker_initiator_tag)
303
289
self.checker_initiator_tag = None
304
290
self.stop_checker()
305
if self.disable_hook:
306
self.disable_hook(self)
310
self.PropertyChanged(dbus.String(u"enabled"),
311
dbus.Boolean(False, variant_level=1))
312
293
# Do not run this again if called by a gobject.timeout_add
315
295
def __del__(self):
316
self.disable_hook = None
319
def checker_callback(self, pid, condition, command):
296
self.stop_hook = None
298
def checker_callback(self, pid, condition):
320
299
"""The checker has completed, so take appropriate actions."""
300
now = datetime.datetime.now()
321
301
self.checker_callback_tag = None
322
302
self.checker = None
325
self.PropertyChanged(dbus.String(u"checker_running"),
326
dbus.Boolean(False, variant_level=1))
327
if (os.WIFEXITED(condition)
328
and (os.WEXITSTATUS(condition) == 0)):
303
if os.WIFEXITED(condition) \
304
and (os.WEXITSTATUS(condition) == 0):
329
305
logger.info(u"Checker for %(name)s succeeded",
333
self.CheckerCompleted(dbus.Boolean(True),
334
dbus.UInt16(condition),
335
dbus.String(command))
307
self.last_checked_ok = now
308
gobject.source_remove(self.stop_initiator_tag)
309
self.stop_initiator_tag = gobject.timeout_add\
310
(self._timeout_milliseconds,
337
312
elif not os.WIFEXITED(condition):
338
313
logger.warning(u"Checker for %(name)s crashed?",
342
self.CheckerCompleted(dbus.Boolean(False),
343
dbus.UInt16(condition),
344
dbus.String(command))
346
316
logger.info(u"Checker for %(name)s failed",
350
self.CheckerCompleted(dbus.Boolean(False),
351
dbus.UInt16(condition),
352
dbus.String(command))
354
def bump_timeout(self):
355
"""Bump up the timeout for this client.
356
This should only be called when the client has been seen,
359
self.last_checked_ok = datetime.datetime.utcnow()
360
gobject.source_remove(self.disable_initiator_tag)
361
self.disable_initiator_tag = (gobject.timeout_add
362
(self.timeout_milliseconds(),
366
self.PropertyChanged(
367
dbus.String(u"last_checked_ok"),
368
(_datetime_to_dbus(self.last_checked_ok,
371
318
def start_checker(self):
372
319
"""Start a new checker subprocess if one is not running.
373
320
If a checker already exists, leave it running and do
438
377
if error.errno != errno.ESRCH: # No such process
440
379
self.checker = None
442
self.PropertyChanged(dbus.String(u"checker_running"),
443
dbus.Boolean(False, variant_level=1))
445
380
def still_valid(self):
446
381
"""Has the timeout not yet passed for this client?"""
447
if not getattr(self, "enabled", False):
449
now = datetime.datetime.utcnow()
382
now = datetime.datetime.now()
450
383
if self.last_checked_ok is None:
451
384
return now < (self.created + self.timeout)
453
386
return now < (self.last_checked_ok + self.timeout)
455
## D-Bus methods & signals
456
_interface = u"se.bsnet.fukt.Mandos.Client"
458
# BumpTimeout - method
459
BumpTimeout = dbus.service.method(_interface)(bump_timeout)
460
BumpTimeout.__name__ = "BumpTimeout"
462
# CheckerCompleted - signal
463
@dbus.service.signal(_interface, signature="bqs")
464
def CheckerCompleted(self, success, condition, command):
468
# CheckerStarted - signal
469
@dbus.service.signal(_interface, signature="s")
470
def CheckerStarted(self, command):
474
# GetAllProperties - method
475
@dbus.service.method(_interface, out_signature="a{sv}")
476
def GetAllProperties(self):
478
return dbus.Dictionary({
480
dbus.String(self.name, variant_level=1),
481
dbus.String("fingerprint"):
482
dbus.String(self.fingerprint, variant_level=1),
484
dbus.String(self.host, variant_level=1),
485
dbus.String("created"):
486
_datetime_to_dbus(self.created, variant_level=1),
487
dbus.String("last_enabled"):
488
(_datetime_to_dbus(self.last_enabled,
490
if self.last_enabled is not None
491
else dbus.Boolean(False, variant_level=1)),
492
dbus.String("enabled"):
493
dbus.Boolean(self.enabled, variant_level=1),
494
dbus.String("last_checked_ok"):
495
(_datetime_to_dbus(self.last_checked_ok,
497
if self.last_checked_ok is not None
498
else dbus.Boolean (False, variant_level=1)),
499
dbus.String("timeout"):
500
dbus.UInt64(self.timeout_milliseconds(),
502
dbus.String("interval"):
503
dbus.UInt64(self.interval_milliseconds(),
505
dbus.String("checker"):
506
dbus.String(self.checker_command,
508
dbus.String("checker_running"):
509
dbus.Boolean(self.checker is not None,
511
dbus.String("object_path"):
512
dbus.ObjectPath(self.dbus_object_path,
516
# IsStillValid - method
517
IsStillValid = (dbus.service.method(_interface, out_signature="b")
519
IsStillValid.__name__ = "IsStillValid"
521
# PropertyChanged - signal
522
@dbus.service.signal(_interface, signature="sv")
523
def PropertyChanged(self, property, value):
527
# SetChecker - method
528
@dbus.service.method(_interface, in_signature="s")
529
def SetChecker(self, checker):
530
"D-Bus setter method"
531
self.checker_command = checker
533
self.PropertyChanged(dbus.String(u"checker"),
534
dbus.String(self.checker_command,
538
@dbus.service.method(_interface, in_signature="s")
539
def SetHost(self, host):
540
"D-Bus setter method"
543
self.PropertyChanged(dbus.String(u"host"),
544
dbus.String(self.host, variant_level=1))
546
# SetInterval - method
547
@dbus.service.method(_interface, in_signature="t")
548
def SetInterval(self, milliseconds):
549
self.interval = datetime.timedelta(0, 0, 0, milliseconds)
551
self.PropertyChanged(dbus.String(u"interval"),
552
(dbus.UInt64(self.interval_milliseconds(),
556
@dbus.service.method(_interface, in_signature="ay",
558
def SetSecret(self, secret):
559
"D-Bus setter method"
560
self.secret = str(secret)
562
# SetTimeout - method
563
@dbus.service.method(_interface, in_signature="t")
564
def SetTimeout(self, milliseconds):
565
self.timeout = datetime.timedelta(0, 0, 0, milliseconds)
567
self.PropertyChanged(dbus.String(u"timeout"),
568
(dbus.UInt64(self.timeout_milliseconds(),
572
Enable = dbus.service.method(_interface)(enable)
573
Enable.__name__ = "Enable"
575
# StartChecker - method
576
@dbus.service.method(_interface)
577
def StartChecker(self):
582
@dbus.service.method(_interface)
587
# StopChecker - method
588
StopChecker = dbus.service.method(_interface)(stop_checker)
589
StopChecker.__name__ = "StopChecker"
594
389
def peer_certificate(session):
595
390
"Return the peer's OpenPGP certificate as a bytestring"
596
391
# If not an OpenPGP certificate...
597
if (gnutls.library.functions
598
.gnutls_certificate_type_get(session._c_object)
599
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
392
if gnutls.library.functions.gnutls_certificate_type_get\
393
(session._c_object) \
394
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP:
600
395
# ...do the normal thing
601
396
return session.peer_certificate
602
397
list_size = ctypes.c_uint()
603
cert_list = (gnutls.library.functions
604
.gnutls_certificate_get_peers
605
(session._c_object, ctypes.byref(list_size)))
398
cert_list = gnutls.library.functions.gnutls_certificate_get_peers\
399
(session._c_object, ctypes.byref(list_size))
606
400
if list_size.value == 0:
608
402
cert = cert_list[0]