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
 
 
176
    name:      string; from the config file, used in log messages
 
182
177
    fingerprint: string (40 or 32 hexadecimal digits); used to
 
183
178
                 uniquely identify the client
 
184
 
    secret:     bytestring; sent verbatim (over TLS) to client
 
185
 
    host:       string; available for use by the checker command
 
186
 
    created:    datetime.datetime(); (UTC) object creation
 
187
 
    last_enabled: datetime.datetime(); (UTC)
 
189
 
    last_checked_ok: datetime.datetime(); (UTC) or None
 
190
 
    timeout:    datetime.timedelta(); How long from last_checked_ok
 
191
 
                                      until this client is invalid
 
192
 
    interval:   datetime.timedelta(); How often to start a new checker
 
193
 
    disable_hook:  If set, called by disable() as disable_hook(self)
 
194
 
    checker:    subprocess.Popen(); a running checker process used
 
195
 
                                    to see if the client lives.
 
196
 
                                    '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.
 
197
190
    checker_initiator_tag: a gobject event source tag, or None
 
198
 
    disable_initiator_tag:    - '' -
 
 
191
    stop_initiator_tag:    - '' -
 
199
192
    checker_callback_tag:  - '' -
 
200
193
    checker_command: string; External command which is run to check if
 
201
194
                     client lives.  %() expansions are done at
 
202
195
                     runtime with vars(self) as dict, so that for
 
203
196
                     instance %(name)s can be used in the command.
 
204
 
    use_dbus: bool(); Whether to provide D-Bus interface and signals
 
205
 
    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: - '' -
 
207
 
    def timeout_milliseconds(self):
 
208
 
        "Return the 'timeout' attribute in milliseconds"
 
209
 
        return ((self.timeout.days * 24 * 60 * 60 * 1000)
 
210
 
                + (self.timeout.seconds * 1000)
 
211
 
                + (self.timeout.microseconds // 1000))
 
213
 
    def interval_milliseconds(self):
 
214
 
        "Return the 'interval' attribute in milliseconds"
 
215
 
        return ((self.interval.days * 24 * 60 * 60 * 1000)
 
216
 
                + (self.interval.seconds * 1000)
 
217
 
                + (self.interval.microseconds // 1000))
 
219
 
    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):
 
221
227
        """Note: the 'checker' key in 'config' sets the
 
222
228
        'checker_command' attribute and *not* the 'checker'
 
225
230
        if config is None:
 
227
233
        logger.debug(u"Creating client %r", self.name)
 
228
 
        self.use_dbus = use_dbus
 
230
 
            self.dbus_object_path = (dbus.ObjectPath
 
232
 
                                      + self.name.replace(".", "_")))
 
233
 
            dbus.service.Object.__init__(self, bus,
 
234
 
                                         self.dbus_object_path)
 
235
234
        # Uppercase and remove spaces from fingerprint for later
 
236
235
        # comparison purposes with return value from the fingerprint()
 
238
 
        self.fingerprint = (config["fingerprint"].upper()
 
 
237
        self.fingerprint = config["fingerprint"].upper()\
 
240
239
        logger.debug(u"  Fingerprint: %s", self.fingerprint)
 
241
240
        if "secret" in config:
 
242
241
            self.secret = config["secret"].decode(u"base64")
 
243
242
        elif "secfile" in config:
 
244
 
            with closing(open(os.path.expanduser
 
246
 
                               (config["secfile"])))) as secfile:
 
247
 
                self.secret = secfile.read()
 
 
243
            secfile = open(config["secfile"])
 
 
244
            self.secret = secfile.read()
 
249
247
            raise TypeError(u"No secret or secfile for client %s"
 
251
249
        self.host = config.get("host", "")
 
252
 
        self.created = datetime.datetime.utcnow()
 
254
 
        self.last_enabled = None
 
 
250
        self.created = datetime.datetime.now()
 
255
251
        self.last_checked_ok = None
 
256
252
        self.timeout = string_to_delta(config["timeout"])
 
257
253
        self.interval = string_to_delta(config["interval"])
 
258
 
        self.disable_hook = disable_hook
 
 
254
        self.stop_hook = stop_hook
 
259
255
        self.checker = None
 
260
256
        self.checker_initiator_tag = None
 
261
 
        self.disable_initiator_tag = None
 
 
257
        self.stop_initiator_tag = None
 
262
258
        self.checker_callback_tag = None
 
263
 
        self.checker_command = config["checker"]
 
 
259
        self.check_command = config["checker"]
 
266
261
        """Start this client's checker and timeout hooks"""
 
267
 
        self.last_enabled = datetime.datetime.utcnow()
 
268
262
        # Schedule a new checker to be started an 'interval' from now,
 
269
263
        # and every interval from then on.
 
270
 
        self.checker_initiator_tag = (gobject.timeout_add
 
271
 
                                      (self.interval_milliseconds(),
 
 
264
        self.checker_initiator_tag = gobject.timeout_add\
 
 
265
                                     (self._interval_milliseconds,
 
273
267
        # Also start a new checker *right now*.
 
274
268
        self.start_checker()
 
275
 
        # Schedule a disable() when 'timeout' has passed
 
276
 
        self.disable_initiator_tag = (gobject.timeout_add
 
277
 
                                   (self.timeout_milliseconds(),
 
282
 
            self.PropertyChanged(dbus.String(u"enabled"),
 
283
 
                                 dbus.Boolean(True, variant_level=1))
 
284
 
            self.PropertyChanged(dbus.String(u"last_enabled"),
 
285
 
                                 (_datetime_to_dbus(self.last_enabled,
 
289
 
        """Disable this client."""
 
290
 
        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)
 
292
 
        logger.info(u"Disabling client %s", self.name)
 
293
 
        if getattr(self, "disable_initiator_tag", False):
 
294
 
            gobject.source_remove(self.disable_initiator_tag)
 
295
 
            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
 
296
286
        if getattr(self, "checker_initiator_tag", False):
 
297
287
            gobject.source_remove(self.checker_initiator_tag)
 
298
288
            self.checker_initiator_tag = None
 
299
289
        self.stop_checker()
 
300
 
        if self.disable_hook:
 
301
 
            self.disable_hook(self)
 
305
 
            self.PropertyChanged(dbus.String(u"enabled"),
 
306
 
                                 dbus.Boolean(False, variant_level=1))
 
307
292
        # Do not run this again if called by a gobject.timeout_add
 
310
294
    def __del__(self):
 
311
 
        self.disable_hook = None
 
314
 
    def checker_callback(self, pid, condition, command):
 
 
295
        self.stop_hook = None
 
 
297
    def checker_callback(self, pid, condition):
 
315
298
        """The checker has completed, so take appropriate actions."""
 
 
299
        now = datetime.datetime.now()
 
316
300
        self.checker_callback_tag = None
 
317
301
        self.checker = None
 
320
 
            self.PropertyChanged(dbus.String(u"checker_running"),
 
321
 
                                 dbus.Boolean(False, variant_level=1))
 
322
 
        if (os.WIFEXITED(condition)
 
323
 
            and (os.WEXITSTATUS(condition) == 0)):
 
 
302
        if os.WIFEXITED(condition) \
 
 
303
               and (os.WEXITSTATUS(condition) == 0):
 
324
304
            logger.info(u"Checker for %(name)s succeeded",
 
328
 
                self.CheckerCompleted(dbus.Boolean(True),
 
329
 
                                      dbus.UInt16(condition),
 
330
 
                                      dbus.String(command))
 
 
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,
 
332
311
        elif not os.WIFEXITED(condition):
 
333
312
            logger.warning(u"Checker for %(name)s crashed?",
 
337
 
                self.CheckerCompleted(dbus.Boolean(False),
 
338
 
                                      dbus.UInt16(condition),
 
339
 
                                      dbus.String(command))
 
341
315
            logger.info(u"Checker for %(name)s failed",
 
345
 
                self.CheckerCompleted(dbus.Boolean(False),
 
346
 
                                      dbus.UInt16(condition),
 
347
 
                                      dbus.String(command))
 
349
 
    def bump_timeout(self):
 
350
 
        """Bump up the timeout for this client.
 
351
 
        This should only be called when the client has been seen,
 
354
 
        self.last_checked_ok = datetime.datetime.utcnow()
 
355
 
        gobject.source_remove(self.disable_initiator_tag)
 
356
 
        self.disable_initiator_tag = (gobject.timeout_add
 
357
 
                                      (self.timeout_milliseconds(),
 
361
 
            self.PropertyChanged(
 
362
 
                dbus.String(u"last_checked_ok"),
 
363
 
                (_datetime_to_dbus(self.last_checked_ok,
 
366
317
    def start_checker(self):
 
367
318
        """Start a new checker subprocess if one is not running.
 
368
319
        If a checker already exists, leave it running and do
 
 
433
376
            if error.errno != errno.ESRCH: # No such process
 
435
378
        self.checker = None
 
437
 
            self.PropertyChanged(dbus.String(u"checker_running"),
 
438
 
                                 dbus.Boolean(False, variant_level=1))
 
440
379
    def still_valid(self):
 
441
380
        """Has the timeout not yet passed for this client?"""
 
442
 
        if not getattr(self, "enabled", False):
 
444
 
        now = datetime.datetime.utcnow()
 
 
381
        now = datetime.datetime.now()
 
445
382
        if self.last_checked_ok is None:
 
446
383
            return now < (self.created + self.timeout)
 
448
385
            return now < (self.last_checked_ok + self.timeout)
 
450
 
    ## D-Bus methods & signals
 
451
 
    _interface = u"org.mandos_system.Mandos.Client"
 
453
 
    # BumpTimeout - method
 
454
 
    BumpTimeout = dbus.service.method(_interface)(bump_timeout)
 
455
 
    BumpTimeout.__name__ = "BumpTimeout"
 
457
 
    # CheckerCompleted - signal
 
458
 
    @dbus.service.signal(_interface, signature="bqs")
 
459
 
    def CheckerCompleted(self, success, condition, command):
 
463
 
    # CheckerStarted - signal
 
464
 
    @dbus.service.signal(_interface, signature="s")
 
465
 
    def CheckerStarted(self, command):
 
469
 
    # GetAllProperties - method
 
470
 
    @dbus.service.method(_interface, out_signature="a{sv}")
 
471
 
    def GetAllProperties(self):
 
473
 
        return dbus.Dictionary({
 
475
 
                    dbus.String(self.name, variant_level=1),
 
476
 
                dbus.String("fingerprint"):
 
477
 
                    dbus.String(self.fingerprint, variant_level=1),
 
479
 
                    dbus.String(self.host, variant_level=1),
 
480
 
                dbus.String("created"):
 
481
 
                    _datetime_to_dbus(self.created, variant_level=1),
 
482
 
                dbus.String("last_enabled"):
 
483
 
                    (_datetime_to_dbus(self.last_enabled,
 
485
 
                     if self.last_enabled is not None
 
486
 
                     else dbus.Boolean(False, variant_level=1)),
 
487
 
                dbus.String("enabled"):
 
488
 
                    dbus.Boolean(self.enabled, variant_level=1),
 
489
 
                dbus.String("last_checked_ok"):
 
490
 
                    (_datetime_to_dbus(self.last_checked_ok,
 
492
 
                     if self.last_checked_ok is not None
 
493
 
                     else dbus.Boolean (False, variant_level=1)),
 
494
 
                dbus.String("timeout"):
 
495
 
                    dbus.UInt64(self.timeout_milliseconds(),
 
497
 
                dbus.String("interval"):
 
498
 
                    dbus.UInt64(self.interval_milliseconds(),
 
500
 
                dbus.String("checker"):
 
501
 
                    dbus.String(self.checker_command,
 
503
 
                dbus.String("checker_running"):
 
504
 
                    dbus.Boolean(self.checker is not None,
 
508
 
    # IsStillValid - method
 
509
 
    IsStillValid = (dbus.service.method(_interface, out_signature="b")
 
511
 
    IsStillValid.__name__ = "IsStillValid"
 
513
 
    # PropertyChanged - signal
 
514
 
    @dbus.service.signal(_interface, signature="sv")
 
515
 
    def PropertyChanged(self, property, value):
 
519
 
    # SetChecker - method
 
520
 
    @dbus.service.method(_interface, in_signature="s")
 
521
 
    def SetChecker(self, checker):
 
522
 
        "D-Bus setter method"
 
523
 
        self.checker_command = checker
 
525
 
        self.PropertyChanged(dbus.String(u"checker"),
 
526
 
                             dbus.String(self.checker_command,
 
530
 
    @dbus.service.method(_interface, in_signature="s")
 
531
 
    def SetHost(self, host):
 
532
 
        "D-Bus setter method"
 
535
 
        self.PropertyChanged(dbus.String(u"host"),
 
536
 
                             dbus.String(self.host, variant_level=1))
 
538
 
    # SetInterval - method
 
539
 
    @dbus.service.method(_interface, in_signature="t")
 
540
 
    def SetInterval(self, milliseconds):
 
541
 
        self.interval = datetime.timedelta(0, 0, 0, milliseconds)
 
543
 
        self.PropertyChanged(dbus.String(u"interval"),
 
544
 
                             (dbus.UInt64(self.interval_milliseconds(),
 
548
 
    @dbus.service.method(_interface, in_signature="ay",
 
550
 
    def SetSecret(self, secret):
 
551
 
        "D-Bus setter method"
 
552
 
        self.secret = str(secret)
 
554
 
    # SetTimeout - method
 
555
 
    @dbus.service.method(_interface, in_signature="t")
 
556
 
    def SetTimeout(self, milliseconds):
 
557
 
        self.timeout = datetime.timedelta(0, 0, 0, milliseconds)
 
559
 
        self.PropertyChanged(dbus.String(u"timeout"),
 
560
 
                             (dbus.UInt64(self.timeout_milliseconds(),
 
564
 
    Enable = dbus.service.method(_interface)(enable)
 
565
 
    Enable.__name__ = "Enable"
 
567
 
    # StartChecker - method
 
568
 
    @dbus.service.method(_interface)
 
569
 
    def StartChecker(self):
 
574
 
    @dbus.service.method(_interface)
 
579
 
    # StopChecker - method
 
580
 
    StopChecker = dbus.service.method(_interface)(stop_checker)
 
581
 
    StopChecker.__name__ = "StopChecker"
 
586
388
def peer_certificate(session):
 
587
389
    "Return the peer's OpenPGP certificate as a bytestring"
 
588
390
    # If not an OpenPGP certificate...
 
589
 
    if (gnutls.library.functions
 
590
 
        .gnutls_certificate_type_get(session._c_object)
 
591
 
        != 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:
 
592
394
        # ...do the normal thing
 
593
395
        return session.peer_certificate
 
594
396
    list_size = ctypes.c_uint()
 
595
 
    cert_list = (gnutls.library.functions
 
596
 
                 .gnutls_certificate_get_peers
 
597
 
                 (session._c_object, ctypes.byref(list_size)))
 
 
397
    cert_list = gnutls.library.functions.gnutls_certificate_get_peers\
 
 
398
        (session._c_object, ctypes.byref(list_size))
 
598
399
    if list_size.value == 0:
 
600
401
    cert = cert_list[0]