171
170
# End of Avahi example code
174
def _datetime_to_dbus(dt, variant_level=0):
175
"""Convert a UTC datetime.datetime() to a D-Bus type."""
176
return dbus.String(dt.isoformat(), variant_level=variant_level)
179
class Client(dbus.service.Object):
173
class Client(object):
180
174
"""A representation of a client host served by this server.
182
name: string; from the config file, used in log messages and
176
name: string; from the config file, used in log messages
184
177
fingerprint: string (40 or 32 hexadecimal digits); used to
185
178
uniquely identify the client
186
secret: bytestring; sent verbatim (over TLS) to client
187
host: string; available for use by the checker command
188
created: datetime.datetime(); (UTC) object creation
189
last_enabled: datetime.datetime(); (UTC)
191
last_checked_ok: datetime.datetime(); (UTC) or None
192
timeout: datetime.timedelta(); How long from last_checked_ok
193
until this client is invalid
194
interval: datetime.timedelta(); How often to start a new checker
195
disable_hook: If set, called by disable() as disable_hook(self)
196
checker: subprocess.Popen(); a running checker process used
197
to see if the client lives.
198
'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.
199
190
checker_initiator_tag: a gobject event source tag, or None
200
disable_initiator_tag: - '' -
191
stop_initiator_tag: - '' -
201
192
checker_callback_tag: - '' -
202
193
checker_command: string; External command which is run to check if
203
194
client lives. %() expansions are done at
204
195
runtime with vars(self) as dict, so that for
205
196
instance %(name)s can be used in the command.
206
use_dbus: bool(); Whether to provide D-Bus interface and signals
207
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: - '' -
209
def timeout_milliseconds(self):
210
"Return the 'timeout' attribute in milliseconds"
211
return ((self.timeout.days * 24 * 60 * 60 * 1000)
212
+ (self.timeout.seconds * 1000)
213
+ (self.timeout.microseconds // 1000))
215
def interval_milliseconds(self):
216
"Return the 'interval' attribute in milliseconds"
217
return ((self.interval.days * 24 * 60 * 60 * 1000)
218
+ (self.interval.seconds * 1000)
219
+ (self.interval.microseconds // 1000))
221
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):
223
227
"""Note: the 'checker' key in 'config' sets the
224
228
'checker_command' attribute and *not* the 'checker'
227
230
if config is None:
229
233
logger.debug(u"Creating client %r", self.name)
230
self.use_dbus = False # During __init__
231
234
# Uppercase and remove spaces from fingerprint for later
232
235
# comparison purposes with return value from the fingerprint()
234
self.fingerprint = (config["fingerprint"].upper()
237
self.fingerprint = config["fingerprint"].upper()\
236
239
logger.debug(u" Fingerprint: %s", self.fingerprint)
237
240
if "secret" in config:
238
241
self.secret = config["secret"].decode(u"base64")
239
242
elif "secfile" in config:
240
with closing(open(os.path.expanduser
242
(config["secfile"])))) as secfile:
243
self.secret = secfile.read()
243
secfile = open(config["secfile"])
244
self.secret = secfile.read()
245
247
raise TypeError(u"No secret or secfile for client %s"
247
249
self.host = config.get("host", "")
248
self.created = datetime.datetime.utcnow()
250
self.last_enabled = None
250
self.created = datetime.datetime.now()
251
251
self.last_checked_ok = None
252
252
self.timeout = string_to_delta(config["timeout"])
253
253
self.interval = string_to_delta(config["interval"])
254
self.disable_hook = disable_hook
254
self.stop_hook = stop_hook
255
255
self.checker = None
256
256
self.checker_initiator_tag = None
257
self.disable_initiator_tag = None
257
self.stop_initiator_tag = None
258
258
self.checker_callback_tag = None
259
self.checker_command = config["checker"]
260
self.last_connect = None
261
# Only now, when this client is initialized, can it show up on
263
self.use_dbus = use_dbus
265
self.dbus_object_path = (dbus.ObjectPath
267
+ self.name.replace(".", "_")))
268
dbus.service.Object.__init__(self, bus,
269
self.dbus_object_path)
259
self.check_command = config["checker"]
272
261
"""Start this client's checker and timeout hooks"""
273
self.last_enabled = datetime.datetime.utcnow()
274
262
# Schedule a new checker to be started an 'interval' from now,
275
263
# and every interval from then on.
276
self.checker_initiator_tag = (gobject.timeout_add
277
(self.interval_milliseconds(),
264
self.checker_initiator_tag = gobject.timeout_add\
265
(self._interval_milliseconds,
279
267
# Also start a new checker *right now*.
280
268
self.start_checker()
281
# Schedule a disable() when 'timeout' has passed
282
self.disable_initiator_tag = (gobject.timeout_add
283
(self.timeout_milliseconds(),
288
self.PropertyChanged(dbus.String(u"enabled"),
289
dbus.Boolean(True, variant_level=1))
290
self.PropertyChanged(dbus.String(u"last_enabled"),
291
(_datetime_to_dbus(self.last_enabled,
295
"""Disable this client."""
296
if not getattr(self, "enabled", False):
269
# Schedule a stop() when 'timeout' has passed
270
self.stop_initiator_tag = gobject.timeout_add\
271
(self._timeout_milliseconds,
275
The possibility that a client might be restarted is left open,
276
but not currently used."""
277
# If this client doesn't have a secret, it is already stopped.
278
if hasattr(self, "secret") and self.secret:
279
logger.info(u"Stopping client %s", self.name)
298
logger.info(u"Disabling client %s", self.name)
299
if getattr(self, "disable_initiator_tag", False):
300
gobject.source_remove(self.disable_initiator_tag)
301
self.disable_initiator_tag = None
283
if getattr(self, "stop_initiator_tag", False):
284
gobject.source_remove(self.stop_initiator_tag)
285
self.stop_initiator_tag = None
302
286
if getattr(self, "checker_initiator_tag", False):
303
287
gobject.source_remove(self.checker_initiator_tag)
304
288
self.checker_initiator_tag = None
305
289
self.stop_checker()
306
if self.disable_hook:
307
self.disable_hook(self)
311
self.PropertyChanged(dbus.String(u"enabled"),
312
dbus.Boolean(False, variant_level=1))
313
292
# Do not run this again if called by a gobject.timeout_add
316
294
def __del__(self):
317
self.disable_hook = None
320
def checker_callback(self, pid, condition, command):
295
self.stop_hook = None
297
def checker_callback(self, pid, condition):
321
298
"""The checker has completed, so take appropriate actions."""
299
now = datetime.datetime.now()
322
300
self.checker_callback_tag = None
323
301
self.checker = None
326
self.PropertyChanged(dbus.String(u"checker_running"),
327
dbus.Boolean(False, variant_level=1))
328
if os.WIFEXITED(condition):
329
exitstatus = os.WEXITSTATUS(condition)
331
logger.info(u"Checker for %(name)s succeeded",
335
logger.info(u"Checker for %(name)s failed",
339
self.CheckerCompleted(dbus.Int16(exitstatus),
340
dbus.Int64(condition),
341
dbus.String(command))
302
if os.WIFEXITED(condition) \
303
and (os.WEXITSTATUS(condition) == 0):
304
logger.info(u"Checker for %(name)s succeeded",
306
self.last_checked_ok = now
307
gobject.source_remove(self.stop_initiator_tag)
308
self.stop_initiator_tag = gobject.timeout_add\
309
(self._timeout_milliseconds,
311
elif not os.WIFEXITED(condition):
343
312
logger.warning(u"Checker for %(name)s crashed?",
347
self.CheckerCompleted(dbus.Int16(-1),
348
dbus.Int64(condition),
349
dbus.String(command))
351
def checked_ok(self):
352
"""Bump up the timeout for this client.
353
This should only be called when the client has been seen,
356
self.last_checked_ok = datetime.datetime.utcnow()
357
gobject.source_remove(self.disable_initiator_tag)
358
self.disable_initiator_tag = (gobject.timeout_add
359
(self.timeout_milliseconds(),
363
self.PropertyChanged(
364
dbus.String(u"last_checked_ok"),
365
(_datetime_to_dbus(self.last_checked_ok,
315
logger.info(u"Checker for %(name)s failed",
368
317
def start_checker(self):
369
318
"""Start a new checker subprocess if one is not running.
370
319
If a checker already exists, leave it running and do
441
376
if error.errno != errno.ESRCH: # No such process
443
378
self.checker = None
445
self.PropertyChanged(dbus.String(u"checker_running"),
446
dbus.Boolean(False, variant_level=1))
448
379
def still_valid(self):
449
380
"""Has the timeout not yet passed for this client?"""
450
if not getattr(self, "enabled", False):
452
now = datetime.datetime.utcnow()
381
now = datetime.datetime.now()
453
382
if self.last_checked_ok is None:
454
383
return now < (self.created + self.timeout)
456
385
return now < (self.last_checked_ok + self.timeout)
458
## D-Bus methods & signals
459
_interface = u"se.bsnet.fukt.Mandos.Client"
462
CheckedOK = dbus.service.method(_interface)(checked_ok)
463
CheckedOK.__name__ = "CheckedOK"
465
# CheckerCompleted - signal
466
@dbus.service.signal(_interface, signature="nxs")
467
def CheckerCompleted(self, exitcode, waitstatus, command):
471
# CheckerStarted - signal
472
@dbus.service.signal(_interface, signature="s")
473
def CheckerStarted(self, command):
477
# GetAllProperties - method
478
@dbus.service.method(_interface, out_signature="a{sv}")
479
def GetAllProperties(self):
481
return dbus.Dictionary({
483
dbus.String(self.name, variant_level=1),
484
dbus.String("fingerprint"):
485
dbus.String(self.fingerprint, variant_level=1),
487
dbus.String(self.host, variant_level=1),
488
dbus.String("created"):
489
_datetime_to_dbus(self.created, variant_level=1),
490
dbus.String("last_enabled"):
491
(_datetime_to_dbus(self.last_enabled,
493
if self.last_enabled is not None
494
else dbus.Boolean(False, variant_level=1)),
495
dbus.String("enabled"):
496
dbus.Boolean(self.enabled, variant_level=1),
497
dbus.String("last_checked_ok"):
498
(_datetime_to_dbus(self.last_checked_ok,
500
if self.last_checked_ok is not None
501
else dbus.Boolean (False, variant_level=1)),
502
dbus.String("timeout"):
503
dbus.UInt64(self.timeout_milliseconds(),
505
dbus.String("interval"):
506
dbus.UInt64(self.interval_milliseconds(),
508
dbus.String("checker"):
509
dbus.String(self.checker_command,
511
dbus.String("checker_running"):
512
dbus.Boolean(self.checker is not None,
514
dbus.String("object_path"):
515
dbus.ObjectPath(self.dbus_object_path,
519
# IsStillValid - method
520
IsStillValid = (dbus.service.method(_interface, out_signature="b")
522
IsStillValid.__name__ = "IsStillValid"
524
# PropertyChanged - signal
525
@dbus.service.signal(_interface, signature="sv")
526
def PropertyChanged(self, property, value):
530
# SetChecker - method
531
@dbus.service.method(_interface, in_signature="s")
532
def SetChecker(self, checker):
533
"D-Bus setter method"
534
self.checker_command = checker
536
self.PropertyChanged(dbus.String(u"checker"),
537
dbus.String(self.checker_command,
541
@dbus.service.method(_interface, in_signature="s")
542
def SetHost(self, host):
543
"D-Bus setter method"
546
self.PropertyChanged(dbus.String(u"host"),
547
dbus.String(self.host, variant_level=1))
549
# SetInterval - method
550
@dbus.service.method(_interface, in_signature="t")
551
def SetInterval(self, milliseconds):
552
self.interval = datetime.timedelta(0, 0, 0, milliseconds)
554
self.PropertyChanged(dbus.String(u"interval"),
555
(dbus.UInt64(self.interval_milliseconds(),
559
@dbus.service.method(_interface, in_signature="ay",
561
def SetSecret(self, secret):
562
"D-Bus setter method"
563
self.secret = str(secret)
565
# SetTimeout - method
566
@dbus.service.method(_interface, in_signature="t")
567
def SetTimeout(self, milliseconds):
568
self.timeout = datetime.timedelta(0, 0, 0, milliseconds)
570
self.PropertyChanged(dbus.String(u"timeout"),
571
(dbus.UInt64(self.timeout_milliseconds(),
575
Enable = dbus.service.method(_interface)(enable)
576
Enable.__name__ = "Enable"
578
# StartChecker - method
579
@dbus.service.method(_interface)
580
def StartChecker(self):
585
@dbus.service.method(_interface)
590
# StopChecker - method
591
StopChecker = dbus.service.method(_interface)(stop_checker)
592
StopChecker.__name__ = "StopChecker"
597
388
def peer_certificate(session):
598
389
"Return the peer's OpenPGP certificate as a bytestring"
599
390
# If not an OpenPGP certificate...
600
if (gnutls.library.functions
601
.gnutls_certificate_type_get(session._c_object)
602
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
391
if gnutls.library.functions.gnutls_certificate_type_get\
392
(session._c_object) \
393
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP:
603
394
# ...do the normal thing
604
395
return session.peer_certificate
605
list_size = ctypes.c_uint(1)
606
cert_list = (gnutls.library.functions
607
.gnutls_certificate_get_peers
608
(session._c_object, ctypes.byref(list_size)))
609
if not bool(cert_list) and list_size.value != 0:
610
raise gnutls.errors.GNUTLSError("error getting peer"
396
list_size = ctypes.c_uint()
397
cert_list = gnutls.library.functions.gnutls_certificate_get_peers\
398
(session._c_object, ctypes.byref(list_size))
612
399
if list_size.value == 0:
614
401
cert = cert_list[0]