239
105
    max_renames: integer; maximum number of renames
 
240
106
    rename_count: integer; counter so we only rename after collisions
 
241
107
                  a sensible number of times
 
242
 
    group: D-Bus Entry Group
 
244
 
    bus: dbus.SystemBus()
 
246
109
    def __init__(self, interface = avahi.IF_UNSPEC, name = None,
 
247
 
                 servicetype = None, port = None, TXT = None,
 
248
 
                 domain = "", host = "", max_renames = 32768,
 
249
 
                 protocol = avahi.PROTO_UNSPEC, bus = None):
 
 
110
                 type = None, port = None, TXT = None, domain = "",
 
 
111
                 host = "", max_renames = 32768):
 
250
112
        self.interface = interface
 
252
 
        self.type = servicetype
 
254
 
        self.TXT = TXT if TXT is not None else []
 
255
120
        self.domain = domain
 
257
122
        self.rename_count = 0
 
258
123
        self.max_renames = max_renames
 
259
 
        self.protocol = protocol
 
260
 
        self.group = None       # our entry group
 
263
 
        self.entry_group_state_changed_match = None
 
264
124
    def rename(self):
 
265
125
        """Derived from the Avahi example code"""
 
266
126
        if self.rename_count >= self.max_renames:
 
267
 
            logger.critical("No suitable Zeroconf service name found"
 
268
 
                            " after %i retries, exiting.",
 
 
127
            logger.critical(u"No suitable Zeroconf service name found"
 
 
128
                            u" after %i retries, exiting.",
 
270
130
            raise AvahiServiceError("Too many renames")
 
271
 
        self.name = unicode(self.server
 
272
 
                            .GetAlternativeServiceName(self.name))
 
273
 
        logger.info("Changing Zeroconf service name to %r ...",
 
 
131
        self.name = server.GetAlternativeServiceName(self.name)
 
 
132
        logger.info(u"Changing Zeroconf service name to %r ...",
 
 
134
        syslogger.setFormatter(logging.Formatter\
 
 
135
                               ('Mandos (%s): %%(levelname)s:'
 
 
136
                               ' %%(message)s' % self.name))
 
278
 
        except dbus.exceptions.DBusException as error:
 
279
 
            logger.critical("DBusException: %s", error)
 
282
139
        self.rename_count += 1
 
283
140
    def remove(self):
 
284
141
        """Derived from the Avahi example code"""
 
285
 
        if self.entry_group_state_changed_match is not None:
 
286
 
            self.entry_group_state_changed_match.remove()
 
287
 
            self.entry_group_state_changed_match = None
 
288
 
        if self.group is not None:
 
 
142
        if group is not None:
 
291
145
        """Derived from the Avahi example code"""
 
293
 
        if self.group is None:
 
294
 
            self.group = dbus.Interface(
 
295
 
                self.bus.get_object(avahi.DBUS_NAME,
 
296
 
                                    self.server.EntryGroupNew()),
 
297
 
                avahi.DBUS_INTERFACE_ENTRY_GROUP)
 
298
 
        self.entry_group_state_changed_match = (
 
299
 
            self.group.connect_to_signal(
 
300
 
                'StateChanged', self.entry_group_state_changed))
 
301
 
        logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
 
302
 
                     self.name, self.type)
 
303
 
        self.group.AddService(
 
306
 
            dbus.UInt32(0),     # flags
 
307
 
            self.name, self.type,
 
308
 
            self.domain, self.host,
 
309
 
            dbus.UInt16(self.port),
 
310
 
            avahi.string_array_to_txt_array(self.TXT))
 
312
 
    def entry_group_state_changed(self, state, error):
 
313
 
        """Derived from the Avahi example code"""
 
314
 
        logger.debug("Avahi entry group state change: %i", state)
 
316
 
        if state == avahi.ENTRY_GROUP_ESTABLISHED:
 
317
 
            logger.debug("Zeroconf service established.")
 
318
 
        elif state == avahi.ENTRY_GROUP_COLLISION:
 
319
 
            logger.info("Zeroconf service name collision.")
 
321
 
        elif state == avahi.ENTRY_GROUP_FAILURE:
 
322
 
            logger.critical("Avahi: Error in group state changed %s",
 
324
 
            raise AvahiGroupError("State changed: %s"
 
327
 
        """Derived from the Avahi example code"""
 
328
 
        if self.group is not None:
 
331
 
            except (dbus.exceptions.UnknownMethodException,
 
332
 
                    dbus.exceptions.DBusException):
 
336
 
    def server_state_changed(self, state, error=None):
 
337
 
        """Derived from the Avahi example code"""
 
338
 
        logger.debug("Avahi server state change: %i", state)
 
339
 
        bad_states = { avahi.SERVER_INVALID:
 
340
 
                           "Zeroconf server invalid",
 
341
 
                       avahi.SERVER_REGISTERING: None,
 
342
 
                       avahi.SERVER_COLLISION:
 
343
 
                           "Zeroconf server name collision",
 
344
 
                       avahi.SERVER_FAILURE:
 
345
 
                           "Zeroconf server failure" }
 
346
 
        if state in bad_states:
 
347
 
            if bad_states[state] is not None:
 
349
 
                    logger.error(bad_states[state])
 
351
 
                    logger.error(bad_states[state] + ": %r", error)
 
353
 
        elif state == avahi.SERVER_RUNNING:
 
357
 
                logger.debug("Unknown state: %r", state)
 
359
 
                logger.debug("Unknown state: %r: %r", state, error)
 
361
 
        """Derived from the Avahi example code"""
 
362
 
        if self.server is None:
 
363
 
            self.server = dbus.Interface(
 
364
 
                self.bus.get_object(avahi.DBUS_NAME,
 
365
 
                                    avahi.DBUS_PATH_SERVER,
 
366
 
                                    follow_name_owner_changes=True),
 
367
 
                avahi.DBUS_INTERFACE_SERVER)
 
368
 
        self.server.connect_to_signal("StateChanged",
 
369
 
                                 self.server_state_changed)
 
370
 
        self.server_state_changed(self.server.GetState())
 
372
 
class AvahiServiceToSyslog(AvahiService):
 
374
 
        """Add the new name to the syslog messages"""
 
375
 
        ret = AvahiService.rename(self)
 
376
 
        syslogger.setFormatter(logging.Formatter
 
377
 
                               ('Mandos (%s) [%%(process)d]:'
 
378
 
                                ' %%(levelname)s: %%(message)s'
 
382
 
def timedelta_to_milliseconds(td):
 
383
 
    "Convert a datetime.timedelta() to milliseconds"
 
384
 
    return ((td.days * 24 * 60 * 60 * 1000)
 
385
 
            + (td.seconds * 1000)
 
386
 
            + (td.microseconds // 1000))
 
 
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 Zeroconf 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
 
388
171
class Client(object):
 
389
172
    """A representation of a client host served by this server.
 
392
 
    approved:   bool(); 'None' if not yet approved/disapproved
 
393
 
    approval_delay: datetime.timedelta(); Time to wait for approval
 
394
 
    approval_duration: datetime.timedelta(); Duration of one approval
 
395
 
    checker:    subprocess.Popen(); a running checker process used
 
396
 
                                    to see if the client lives.
 
397
 
                                    'None' if no process is running.
 
398
 
    checker_callback_tag: a gobject event source tag, or None
 
399
 
    checker_command: string; External command which is run to check
 
400
 
                     if client lives.  %() expansions are done at
 
 
174
    name:      string; from the config file, used in log messages
 
 
175
    fingerprint: string (40 or 32 hexadecimal digits); used to
 
 
176
                 uniquely identify the client
 
 
177
    secret:    bytestring; sent verbatim (over TLS) to client
 
 
178
    host:      string; 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.
 
 
188
    checker_initiator_tag: a gobject event source tag, or None
 
 
189
    stop_initiator_tag:    - '' -
 
 
190
    checker_callback_tag:  - '' -
 
 
191
    checker_command: string; External command which is run to check if
 
 
192
                     client lives.  %() expansions are done at
 
401
193
                     runtime with vars(self) as dict, so that for
 
402
194
                     instance %(name)s can be used in the command.
 
403
 
    checker_initiator_tag: a gobject event source tag, or None
 
404
 
    created:    datetime.datetime(); (UTC) object creation
 
405
 
    client_structure: Object describing what attributes a client has
 
406
 
                      and is used for storing the client at exit
 
407
 
    current_checker_command: string; current running checker_command
 
408
 
    disable_initiator_tag: a gobject event source tag, or None
 
410
 
    fingerprint: string (40 or 32 hexadecimal digits); used to
 
411
 
                 uniquely identify the client
 
412
 
    host:       string; available for use by the checker command
 
413
 
    interval:   datetime.timedelta(); How often to start a new checker
 
414
 
    last_approval_request: datetime.datetime(); (UTC) or None
 
415
 
    last_checked_ok: datetime.datetime(); (UTC) or None
 
416
 
    last_checker_status: integer between 0 and 255 reflecting exit
 
417
 
                         status of last checker. -1 reflects crashed
 
419
 
    last_enabled: datetime.datetime(); (UTC) or None
 
420
 
    name:       string; from the config file, used in log messages and
 
422
 
    secret:     bytestring; sent verbatim (over TLS) to client
 
423
 
    timeout:    datetime.timedelta(); How long from last_checked_ok
 
424
 
                                      until this client is disabled
 
425
 
    extended_timeout:   extra long timeout when secret has been sent
 
426
 
    runtime_expansions: Allowed attributes for runtime expansion.
 
427
 
    expires:    datetime.datetime(); time (UTC) when a client will be
 
 
196
    _timeout: Real variable for 'timeout'
 
 
197
    _interval: Real variable for 'interval'
 
 
198
    _timeout_milliseconds: Used when calling gobject.timeout_add()
 
 
199
    _interval_milliseconds: - '' -
 
431
 
    runtime_expansions = ("approval_delay", "approval_duration",
 
432
 
                          "created", "enabled", "fingerprint",
 
433
 
                          "host", "interval", "last_checked_ok",
 
434
 
                          "last_enabled", "name", "timeout")
 
435
 
    client_defaults = { "timeout": "5m",
 
436
 
                        "extended_timeout": "15m",
 
438
 
                        "checker": "fping -q -- %%(host)s",
 
440
 
                        "approval_delay": "0s",
 
441
 
                        "approval_duration": "1s",
 
442
 
                        "approved_by_default": "True",
 
446
 
    def timeout_milliseconds(self):
 
447
 
        "Return the 'timeout' attribute in milliseconds"
 
448
 
        return timedelta_to_milliseconds(self.timeout)
 
450
 
    def extended_timeout_milliseconds(self):
 
451
 
        "Return the 'extended_timeout' attribute in milliseconds"
 
452
 
        return timedelta_to_milliseconds(self.extended_timeout)
 
454
 
    def interval_milliseconds(self):
 
455
 
        "Return the 'interval' attribute in milliseconds"
 
456
 
        return timedelta_to_milliseconds(self.interval)
 
458
 
    def approval_delay_milliseconds(self):
 
459
 
        return timedelta_to_milliseconds(self.approval_delay)
 
462
 
    def config_parser(config):
 
463
 
        """Construct a new dict of client settings of this form:
 
464
 
        { client_name: {setting_name: value, ...}, ...}
 
465
 
        with exceptions for any special settings as defined above.
 
466
 
        NOTE: Must be a pure function. Must return the same result
 
467
 
        value given the same arguments.
 
470
 
        for client_name in config.sections():
 
471
 
            section = dict(config.items(client_name))
 
472
 
            client = settings[client_name] = {}
 
474
 
            client["host"] = section["host"]
 
475
 
            # Reformat values from string types to Python types
 
476
 
            client["approved_by_default"] = config.getboolean(
 
477
 
                client_name, "approved_by_default")
 
478
 
            client["enabled"] = config.getboolean(client_name,
 
481
 
            client["fingerprint"] = (section["fingerprint"].upper()
 
483
 
            if "secret" in section:
 
484
 
                client["secret"] = section["secret"].decode("base64")
 
485
 
            elif "secfile" in section:
 
486
 
                with open(os.path.expanduser(os.path.expandvars
 
487
 
                                             (section["secfile"])),
 
489
 
                    client["secret"] = secfile.read()
 
491
 
                raise TypeError("No secret or secfile for section %s"
 
493
 
            client["timeout"] = string_to_delta(section["timeout"])
 
494
 
            client["extended_timeout"] = string_to_delta(
 
495
 
                section["extended_timeout"])
 
496
 
            client["interval"] = string_to_delta(section["interval"])
 
497
 
            client["approval_delay"] = string_to_delta(
 
498
 
                section["approval_delay"])
 
499
 
            client["approval_duration"] = string_to_delta(
 
500
 
                section["approval_duration"])
 
501
 
            client["checker_command"] = section["checker"]
 
502
 
            client["last_approval_request"] = None
 
503
 
            client["last_checked_ok"] = None
 
504
 
            client["last_checker_status"] = None
 
509
 
    def __init__(self, settings, name = None):
 
 
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, config={}):
 
510
225
        """Note: the 'checker' key in 'config' sets the
 
511
226
        'checker_command' attribute and *not* the 'checker'
 
514
 
        # adding all client settings
 
515
 
        for setting, value in settings.iteritems():
 
516
 
            setattr(self, setting, value)
 
519
 
            if not hasattr(self, "last_enabled"):
 
520
 
                self.last_enabled = datetime.datetime.utcnow()
 
521
 
            if not hasattr(self, "expires"):
 
522
 
                self.expires = (datetime.datetime.utcnow()
 
525
 
            self.last_enabled = None
 
528
 
        logger.debug("Creating client %r", self.name)
 
 
229
        logger.debug(u"Creating client %r", self.name)
 
529
230
        # Uppercase and remove spaces from fingerprint for later
 
530
231
        # comparison purposes with return value from the fingerprint()
 
532
 
        logger.debug("  Fingerprint: %s", self.fingerprint)
 
533
 
        self.created = settings.get("created",
 
534
 
                                    datetime.datetime.utcnow())
 
536
 
        # attributes specific for this server instance
 
 
233
        self.fingerprint = config["fingerprint"].upper()\
 
 
235
        logger.debug(u"  Fingerprint: %s", self.fingerprint)
 
 
236
        if "secret" in config:
 
 
237
            self.secret = config["secret"].decode(u"base64")
 
 
238
        elif "secfile" in config:
 
 
239
            sf = open(config["secfile"])
 
 
240
            self.secret = sf.read()
 
 
243
            raise TypeError(u"No secret or secfile for client %s"
 
 
245
        self.host = config.get("host", "")
 
 
246
        self.created = datetime.datetime.now()
 
 
247
        self.last_checked_ok = None
 
 
248
        self.timeout = string_to_delta(config["timeout"])
 
 
249
        self.interval = string_to_delta(config["interval"])
 
 
250
        self.stop_hook = stop_hook
 
537
251
        self.checker = None
 
538
252
        self.checker_initiator_tag = None
 
539
 
        self.disable_initiator_tag = None
 
 
253
        self.stop_initiator_tag = None
 
540
254
        self.checker_callback_tag = None
 
541
 
        self.current_checker_command = None
 
543
 
        self.approvals_pending = 0
 
544
 
        self.changedstate = (multiprocessing_manager
 
545
 
                             .Condition(multiprocessing_manager
 
547
 
        self.client_structure = [attr for attr in
 
548
 
                                 self.__dict__.iterkeys()
 
549
 
                                 if not attr.startswith("_")]
 
550
 
        self.client_structure.append("client_structure")
 
552
 
        for name, t in inspect.getmembers(type(self),
 
556
 
            if not name.startswith("_"):
 
557
 
                self.client_structure.append(name)
 
559
 
    # Send notice to process children that client state has changed
 
560
 
    def send_changedstate(self):
 
561
 
        with self.changedstate:
 
562
 
            self.changedstate.notify_all()
 
 
255
        self.check_command = config["checker"]
 
565
257
        """Start this client's checker and timeout hooks"""
 
566
 
        if getattr(self, "enabled", False):
 
569
 
        self.send_changedstate()
 
570
 
        self.expires = datetime.datetime.utcnow() + self.timeout
 
572
 
        self.last_enabled = datetime.datetime.utcnow()
 
575
 
    def disable(self, quiet=True):
 
576
 
        """Disable this client."""
 
577
 
        if not getattr(self, "enabled", False):
 
 
258
        # Schedule a new checker to be started an 'interval' from now,
 
 
259
        # and every interval from then on.
 
 
260
        self.checker_initiator_tag = gobject.timeout_add\
 
 
261
                                     (self._interval_milliseconds,
 
 
263
        # Also start a new checker *right now*.
 
 
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.
 
 
274
        if hasattr(self, "secret") and self.secret:
 
 
275
            logger.info(u"Stopping client %s", self.name)
 
580
 
            self.send_changedstate()
 
582
 
            logger.info("Disabling client %s", self.name)
 
583
 
        if getattr(self, "disable_initiator_tag", False):
 
584
 
            gobject.source_remove(self.disable_initiator_tag)
 
585
 
            self.disable_initiator_tag = None
 
 
279
        if getattr(self, "stop_initiator_tag", False):
 
 
280
            gobject.source_remove(self.stop_initiator_tag)
 
 
281
            self.stop_initiator_tag = None
 
587
282
        if getattr(self, "checker_initiator_tag", False):
 
588
283
            gobject.source_remove(self.checker_initiator_tag)
 
589
284
            self.checker_initiator_tag = None
 
590
285
        self.stop_checker()
 
592
288
        # Do not run this again if called by a gobject.timeout_add
 
595
290
    def __del__(self):
 
598
 
    def init_checker(self):
 
599
 
        # Schedule a new checker to be started an 'interval' from now,
 
600
 
        # and every interval from then on.
 
601
 
        self.checker_initiator_tag = (gobject.timeout_add
 
602
 
                                      (self.interval_milliseconds(),
 
604
 
        # Schedule a disable() when 'timeout' has passed
 
605
 
        self.disable_initiator_tag = (gobject.timeout_add
 
606
 
                                   (self.timeout_milliseconds(),
 
608
 
        # Also start a new checker *right now*.
 
611
 
    def checker_callback(self, pid, condition, command):
 
 
291
        self.stop_hook = None
 
 
293
    def checker_callback(self, pid, condition):
 
612
294
        """The checker has completed, so take appropriate actions."""
 
 
295
        now = datetime.datetime.now()
 
613
296
        self.checker_callback_tag = None
 
614
297
        self.checker = None
 
615
 
        if os.WIFEXITED(condition):
 
616
 
            self.last_checker_status = os.WEXITSTATUS(condition)
 
617
 
            if self.last_checker_status == 0:
 
618
 
                logger.info("Checker for %(name)s succeeded",
 
622
 
                logger.info("Checker for %(name)s failed",
 
625
 
            self.last_checker_status = -1
 
626
 
            logger.warning("Checker for %(name)s crashed?",
 
 
298
        if os.WIFEXITED(condition) \
 
 
299
               and (os.WEXITSTATUS(condition) == 0):
 
 
300
            logger.info(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):
 
 
308
            logger.warning(u"Checker for %(name)s crashed?",
 
629
 
    def checked_ok(self, timeout=None):
 
630
 
        """Bump up the timeout for this client.
 
632
 
        This should only be called when the client has been seen,
 
636
 
            timeout = self.timeout
 
637
 
        self.last_checked_ok = datetime.datetime.utcnow()
 
638
 
        if self.disable_initiator_tag is not None:
 
639
 
            gobject.source_remove(self.disable_initiator_tag)
 
640
 
        if getattr(self, "enabled", False):
 
641
 
            self.disable_initiator_tag = (gobject.timeout_add
 
642
 
                                          (timedelta_to_milliseconds
 
643
 
                                           (timeout), self.disable))
 
644
 
            self.expires = datetime.datetime.utcnow() + timeout
 
646
 
    def need_approval(self):
 
647
 
        self.last_approval_request = datetime.datetime.utcnow()
 
 
311
            logger.info(u"Checker for %(name)s failed",
 
649
313
    def start_checker(self):
 
650
314
        """Start a new checker subprocess if one is not running.
 
652
315
        If a checker already exists, leave it running and do
 
654
317
        # The reason for not killing a running checker is that if we
 
 
728
362
            self.checker_callback_tag = None
 
729
363
        if getattr(self, "checker", None) is None:
 
731
 
        logger.debug("Stopping checker for %(name)s", vars(self))
 
 
365
        logger.debug(u"Stopping checker for %(name)s", vars(self))
 
733
367
            os.kill(self.checker.pid, signal.SIGTERM)
 
735
369
            #if self.checker.poll() is None:
 
736
370
            #    os.kill(self.checker.pid, signal.SIGKILL)
 
737
 
        except OSError as error:
 
 
371
        except OSError, error:
 
738
372
            if error.errno != errno.ESRCH: # No such process
 
740
374
        self.checker = None
 
743
 
def dbus_service_property(dbus_interface, signature="v",
 
744
 
                          access="readwrite", byte_arrays=False):
 
745
 
    """Decorators for marking methods of a DBusObjectWithProperties to
 
746
 
    become properties on the D-Bus.
 
748
 
    The decorated method will be called with no arguments by "Get"
 
749
 
    and with one argument by "Set".
 
751
 
    The parameters, where they are supported, are the same as
 
752
 
    dbus.service.method, except there is only "signature", since the
 
753
 
    type from Get() and the type sent to Set() is the same.
 
755
 
    # Encoding deeply encoded byte arrays is not supported yet by the
 
756
 
    # "Set" method, so we fail early here:
 
757
 
    if byte_arrays and signature != "ay":
 
758
 
        raise ValueError("Byte arrays not supported for non-'ay'"
 
759
 
                         " signature %r" % signature)
 
761
 
        func._dbus_is_property = True
 
762
 
        func._dbus_interface = dbus_interface
 
763
 
        func._dbus_signature = signature
 
764
 
        func._dbus_access = access
 
765
 
        func._dbus_name = func.__name__
 
766
 
        if func._dbus_name.endswith("_dbus_property"):
 
767
 
            func._dbus_name = func._dbus_name[:-14]
 
768
 
        func._dbus_get_args_options = {'byte_arrays': byte_arrays }
 
773
 
class DBusPropertyException(dbus.exceptions.DBusException):
 
774
 
    """A base class for D-Bus property-related exceptions
 
776
 
    def __unicode__(self):
 
777
 
        return unicode(str(self))
 
780
 
class DBusPropertyAccessException(DBusPropertyException):
 
781
 
    """A property's access permissions disallows an operation.
 
786
 
class DBusPropertyNotFound(DBusPropertyException):
 
787
 
    """An attempt was made to access a non-existing property.
 
792
 
class DBusObjectWithProperties(dbus.service.Object):
 
793
 
    """A D-Bus object with properties.
 
795
 
    Classes inheriting from this can use the dbus_service_property
 
796
 
    decorator to expose methods as D-Bus properties.  It exposes the
 
797
 
    standard Get(), Set(), and GetAll() methods on the D-Bus.
 
801
 
    def _is_dbus_property(obj):
 
802
 
        return getattr(obj, "_dbus_is_property", False)
 
804
 
    def _get_all_dbus_properties(self):
 
805
 
        """Returns a generator of (name, attribute) pairs
 
807
 
        return ((prop.__get__(self)._dbus_name, prop.__get__(self))
 
808
 
                for cls in self.__class__.__mro__
 
810
 
                inspect.getmembers(cls, self._is_dbus_property))
 
812
 
    def _get_dbus_property(self, interface_name, property_name):
 
813
 
        """Returns a bound method if one exists which is a D-Bus
 
814
 
        property with the specified name and interface.
 
816
 
        for cls in  self.__class__.__mro__:
 
817
 
            for name, value in (inspect.getmembers
 
818
 
                                (cls, self._is_dbus_property)):
 
819
 
                if (value._dbus_name == property_name
 
820
 
                    and value._dbus_interface == interface_name):
 
821
 
                    return value.__get__(self)
 
824
 
        raise DBusPropertyNotFound(self.dbus_object_path + ":"
 
825
 
                                   + interface_name + "."
 
828
 
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
 
830
 
    def Get(self, interface_name, property_name):
 
831
 
        """Standard D-Bus property Get() method, see D-Bus standard.
 
833
 
        prop = self._get_dbus_property(interface_name, property_name)
 
834
 
        if prop._dbus_access == "write":
 
835
 
            raise DBusPropertyAccessException(property_name)
 
837
 
        if not hasattr(value, "variant_level"):
 
839
 
        return type(value)(value, variant_level=value.variant_level+1)
 
841
 
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
 
842
 
    def Set(self, interface_name, property_name, value):
 
843
 
        """Standard D-Bus property Set() method, see D-Bus standard.
 
845
 
        prop = self._get_dbus_property(interface_name, property_name)
 
846
 
        if prop._dbus_access == "read":
 
847
 
            raise DBusPropertyAccessException(property_name)
 
848
 
        if prop._dbus_get_args_options["byte_arrays"]:
 
849
 
            # The byte_arrays option is not supported yet on
 
850
 
            # signatures other than "ay".
 
851
 
            if prop._dbus_signature != "ay":
 
853
 
            value = dbus.ByteArray(b''.join(chr(byte)
 
857
 
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
 
858
 
                         out_signature="a{sv}")
 
859
 
    def GetAll(self, interface_name):
 
860
 
        """Standard D-Bus property GetAll() method, see D-Bus
 
863
 
        Note: Will not include properties with access="write".
 
866
 
        for name, prop in self._get_all_dbus_properties():
 
868
 
                and interface_name != prop._dbus_interface):
 
869
 
                # Interface non-empty but did not match
 
871
 
            # Ignore write-only properties
 
872
 
            if prop._dbus_access == "write":
 
875
 
            if not hasattr(value, "variant_level"):
 
876
 
                properties[name] = value
 
878
 
            properties[name] = type(value)(value, variant_level=
 
879
 
                                           value.variant_level+1)
 
880
 
        return dbus.Dictionary(properties, signature="sv")
 
882
 
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
 
884
 
                         path_keyword='object_path',
 
885
 
                         connection_keyword='connection')
 
886
 
    def Introspect(self, object_path, connection):
 
887
 
        """Standard D-Bus method, overloaded to insert property tags.
 
889
 
        xmlstring = dbus.service.Object.Introspect(self, object_path,
 
892
 
            document = xml.dom.minidom.parseString(xmlstring)
 
893
 
            def make_tag(document, name, prop):
 
894
 
                e = document.createElement("property")
 
895
 
                e.setAttribute("name", name)
 
896
 
                e.setAttribute("type", prop._dbus_signature)
 
897
 
                e.setAttribute("access", prop._dbus_access)
 
899
 
            for if_tag in document.getElementsByTagName("interface"):
 
900
 
                for tag in (make_tag(document, name, prop)
 
902
 
                            in self._get_all_dbus_properties()
 
903
 
                            if prop._dbus_interface
 
904
 
                            == if_tag.getAttribute("name")):
 
905
 
                    if_tag.appendChild(tag)
 
906
 
                # Add the names to the return values for the
 
907
 
                # "org.freedesktop.DBus.Properties" methods
 
908
 
                if (if_tag.getAttribute("name")
 
909
 
                    == "org.freedesktop.DBus.Properties"):
 
910
 
                    for cn in if_tag.getElementsByTagName("method"):
 
911
 
                        if cn.getAttribute("name") == "Get":
 
912
 
                            for arg in cn.getElementsByTagName("arg"):
 
913
 
                                if (arg.getAttribute("direction")
 
915
 
                                    arg.setAttribute("name", "value")
 
916
 
                        elif cn.getAttribute("name") == "GetAll":
 
917
 
                            for arg in cn.getElementsByTagName("arg"):
 
918
 
                                if (arg.getAttribute("direction")
 
920
 
                                    arg.setAttribute("name", "props")
 
921
 
            xmlstring = document.toxml("utf-8")
 
923
 
        except (AttributeError, xml.dom.DOMException,
 
924
 
                xml.parsers.expat.ExpatError) as error:
 
925
 
            logger.error("Failed to override Introspection method",
 
930
 
def datetime_to_dbus (dt, variant_level=0):
 
931
 
    """Convert a UTC datetime.datetime() to a D-Bus type."""
 
933
 
        return dbus.String("", variant_level = variant_level)
 
934
 
    return dbus.String(dt.isoformat(),
 
935
 
                       variant_level=variant_level)
 
938
 
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
 
940
 
    """Applied to an empty subclass of a D-Bus object, this metaclass
 
941
 
    will add additional D-Bus attributes matching a certain pattern.
 
943
 
    def __new__(mcs, name, bases, attr):
 
944
 
        # Go through all the base classes which could have D-Bus
 
945
 
        # methods, signals, or properties in them
 
946
 
        for base in (b for b in bases
 
947
 
                     if issubclass(b, dbus.service.Object)):
 
948
 
            # Go though all attributes of the base class
 
949
 
            for attrname, attribute in inspect.getmembers(base):
 
950
 
                # Ignore non-D-Bus attributes, and D-Bus attributes
 
951
 
                # with the wrong interface name
 
952
 
                if (not hasattr(attribute, "_dbus_interface")
 
953
 
                    or not attribute._dbus_interface
 
954
 
                    .startswith("se.recompile.Mandos")):
 
956
 
                # Create an alternate D-Bus interface name based on
 
958
 
                alt_interface = (attribute._dbus_interface
 
959
 
                                 .replace("se.recompile.Mandos",
 
960
 
                                          "se.bsnet.fukt.Mandos"))
 
961
 
                # Is this a D-Bus signal?
 
962
 
                if getattr(attribute, "_dbus_is_signal", False):
 
963
 
                    # Extract the original non-method function by
 
965
 
                    nonmethod_func = (dict(
 
966
 
                            zip(attribute.func_code.co_freevars,
 
967
 
                                attribute.__closure__))["func"]
 
969
 
                    # Create a new, but exactly alike, function
 
970
 
                    # object, and decorate it to be a new D-Bus signal
 
971
 
                    # with the alternate D-Bus interface name
 
972
 
                    new_function = (dbus.service.signal
 
974
 
                                     attribute._dbus_signature)
 
976
 
                                nonmethod_func.func_code,
 
977
 
                                nonmethod_func.func_globals,
 
978
 
                                nonmethod_func.func_name,
 
979
 
                                nonmethod_func.func_defaults,
 
980
 
                                nonmethod_func.func_closure)))
 
981
 
                    # Define a creator of a function to call both the
 
982
 
                    # old and new functions, so both the old and new
 
983
 
                    # signals gets sent when the function is called
 
984
 
                    def fixscope(func1, func2):
 
985
 
                        """This function is a scope container to pass
 
986
 
                        func1 and func2 to the "call_both" function
 
987
 
                        outside of its arguments"""
 
988
 
                        def call_both(*args, **kwargs):
 
989
 
                            """This function will emit two D-Bus
 
990
 
                            signals by calling func1 and func2"""
 
991
 
                            func1(*args, **kwargs)
 
992
 
                            func2(*args, **kwargs)
 
994
 
                    # Create the "call_both" function and add it to
 
996
 
                    attr[attrname] = fixscope(attribute,
 
998
 
                # Is this a D-Bus method?
 
999
 
                elif getattr(attribute, "_dbus_is_method", False):
 
1000
 
                    # Create a new, but exactly alike, function
 
1001
 
                    # object.  Decorate it to be a new D-Bus method
 
1002
 
                    # with the alternate D-Bus interface name.  Add it
 
1004
 
                    attr[attrname] = (dbus.service.method
 
1006
 
                                       attribute._dbus_in_signature,
 
1007
 
                                       attribute._dbus_out_signature)
 
1009
 
                                       (attribute.func_code,
 
1010
 
                                        attribute.func_globals,
 
1011
 
                                        attribute.func_name,
 
1012
 
                                        attribute.func_defaults,
 
1013
 
                                        attribute.func_closure)))
 
1014
 
                # Is this a D-Bus property?
 
1015
 
                elif getattr(attribute, "_dbus_is_property", False):
 
1016
 
                    # Create a new, but exactly alike, function
 
1017
 
                    # object, and decorate it to be a new D-Bus
 
1018
 
                    # property with the alternate D-Bus interface
 
1019
 
                    # name.  Add it to the class.
 
1020
 
                    attr[attrname] = (dbus_service_property
 
1022
 
                                       attribute._dbus_signature,
 
1023
 
                                       attribute._dbus_access,
 
1025
 
                                       ._dbus_get_args_options
 
1028
 
                                       (attribute.func_code,
 
1029
 
                                        attribute.func_globals,
 
1030
 
                                        attribute.func_name,
 
1031
 
                                        attribute.func_defaults,
 
1032
 
                                        attribute.func_closure)))
 
1033
 
        return type.__new__(mcs, name, bases, attr)
 
1036
 
class ClientDBus(Client, DBusObjectWithProperties):
 
1037
 
    """A Client class using D-Bus
 
1040
 
    dbus_object_path: dbus.ObjectPath
 
1041
 
    bus: dbus.SystemBus()
 
1044
 
    runtime_expansions = (Client.runtime_expansions
 
1045
 
                          + ("dbus_object_path",))
 
1047
 
    # dbus.service.Object doesn't use super(), so we can't either.
 
1049
 
    def __init__(self, bus = None, *args, **kwargs):
 
1051
 
        Client.__init__(self, *args, **kwargs)
 
1052
 
        # Only now, when this client is initialized, can it show up on
 
1054
 
        client_object_name = unicode(self.name).translate(
 
1055
 
            {ord("."): ord("_"),
 
1056
 
             ord("-"): ord("_")})
 
1057
 
        self.dbus_object_path = (dbus.ObjectPath
 
1058
 
                                 ("/clients/" + client_object_name))
 
1059
 
        DBusObjectWithProperties.__init__(self, self.bus,
 
1060
 
                                          self.dbus_object_path)
 
1062
 
    def notifychangeproperty(transform_func,
 
1063
 
                             dbus_name, type_func=lambda x: x,
 
1065
 
        """ Modify a variable so that it's a property which announces
 
1066
 
        its changes to DBus.
 
1068
 
        transform_fun: Function that takes a value and a variant_level
 
1069
 
                       and transforms it to a D-Bus type.
 
1070
 
        dbus_name: D-Bus name of the variable
 
1071
 
        type_func: Function that transform the value before sending it
 
1072
 
                   to the D-Bus.  Default: no transform
 
1073
 
        variant_level: D-Bus variant level.  Default: 1
 
1075
 
        attrname = "_{0}".format(dbus_name)
 
1076
 
        def setter(self, value):
 
1077
 
            if hasattr(self, "dbus_object_path"):
 
1078
 
                if (not hasattr(self, attrname) or
 
1079
 
                    type_func(getattr(self, attrname, None))
 
1080
 
                    != type_func(value)):
 
1081
 
                    dbus_value = transform_func(type_func(value),
 
1084
 
                    self.PropertyChanged(dbus.String(dbus_name),
 
1086
 
            setattr(self, attrname, value)
 
1088
 
        return property(lambda self: getattr(self, attrname), setter)
 
1091
 
    expires = notifychangeproperty(datetime_to_dbus, "Expires")
 
1092
 
    approvals_pending = notifychangeproperty(dbus.Boolean,
 
1095
 
    enabled = notifychangeproperty(dbus.Boolean, "Enabled")
 
1096
 
    last_enabled = notifychangeproperty(datetime_to_dbus,
 
1098
 
    checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
 
1099
 
                                   type_func = lambda checker:
 
1100
 
                                       checker is not None)
 
1101
 
    last_checked_ok = notifychangeproperty(datetime_to_dbus,
 
1103
 
    last_approval_request = notifychangeproperty(
 
1104
 
        datetime_to_dbus, "LastApprovalRequest")
 
1105
 
    approved_by_default = notifychangeproperty(dbus.Boolean,
 
1106
 
                                               "ApprovedByDefault")
 
1107
 
    approval_delay = notifychangeproperty(dbus.UInt64,
 
1110
 
                                          timedelta_to_milliseconds)
 
1111
 
    approval_duration = notifychangeproperty(
 
1112
 
        dbus.UInt64, "ApprovalDuration",
 
1113
 
        type_func = timedelta_to_milliseconds)
 
1114
 
    host = notifychangeproperty(dbus.String, "Host")
 
1115
 
    timeout = notifychangeproperty(dbus.UInt64, "Timeout",
 
1117
 
                                   timedelta_to_milliseconds)
 
1118
 
    extended_timeout = notifychangeproperty(
 
1119
 
        dbus.UInt64, "ExtendedTimeout",
 
1120
 
        type_func = timedelta_to_milliseconds)
 
1121
 
    interval = notifychangeproperty(dbus.UInt64,
 
1124
 
                                    timedelta_to_milliseconds)
 
1125
 
    checker_command = notifychangeproperty(dbus.String, "Checker")
 
1127
 
    del notifychangeproperty
 
1129
 
    def __del__(self, *args, **kwargs):
 
1131
 
            self.remove_from_connection()
 
1134
 
        if hasattr(DBusObjectWithProperties, "__del__"):
 
1135
 
            DBusObjectWithProperties.__del__(self, *args, **kwargs)
 
1136
 
        Client.__del__(self, *args, **kwargs)
 
1138
 
    def checker_callback(self, pid, condition, command,
 
1140
 
        self.checker_callback_tag = None
 
1142
 
        if os.WIFEXITED(condition):
 
1143
 
            exitstatus = os.WEXITSTATUS(condition)
 
1145
 
            self.CheckerCompleted(dbus.Int16(exitstatus),
 
1146
 
                                  dbus.Int64(condition),
 
1147
 
                                  dbus.String(command))
 
1150
 
            self.CheckerCompleted(dbus.Int16(-1),
 
1151
 
                                  dbus.Int64(condition),
 
1152
 
                                  dbus.String(command))
 
1154
 
        return Client.checker_callback(self, pid, condition, command,
 
1157
 
    def start_checker(self, *args, **kwargs):
 
1158
 
        old_checker = self.checker
 
1159
 
        if self.checker is not None:
 
1160
 
            old_checker_pid = self.checker.pid
 
1162
 
            old_checker_pid = None
 
1163
 
        r = Client.start_checker(self, *args, **kwargs)
 
1164
 
        # Only if new checker process was started
 
1165
 
        if (self.checker is not None
 
1166
 
            and old_checker_pid != self.checker.pid):
 
1168
 
            self.CheckerStarted(self.current_checker_command)
 
1171
 
    def _reset_approved(self):
 
1172
 
        self.approved = None
 
1175
 
    def approve(self, value=True):
 
1176
 
        self.send_changedstate()
 
1177
 
        self.approved = value
 
1178
 
        gobject.timeout_add(timedelta_to_milliseconds
 
1179
 
                            (self.approval_duration),
 
1180
 
                            self._reset_approved)
 
1183
 
    ## D-Bus methods, signals & properties
 
1184
 
    _interface = "se.recompile.Mandos.Client"
 
1188
 
    # CheckerCompleted - signal
 
1189
 
    @dbus.service.signal(_interface, signature="nxs")
 
1190
 
    def CheckerCompleted(self, exitcode, waitstatus, command):
 
1194
 
    # CheckerStarted - signal
 
1195
 
    @dbus.service.signal(_interface, signature="s")
 
1196
 
    def CheckerStarted(self, command):
 
1200
 
    # PropertyChanged - signal
 
1201
 
    @dbus.service.signal(_interface, signature="sv")
 
1202
 
    def PropertyChanged(self, property, value):
 
1206
 
    # GotSecret - signal
 
1207
 
    @dbus.service.signal(_interface)
 
1208
 
    def GotSecret(self):
 
1210
 
        Is sent after a successful transfer of secret from the Mandos
 
1211
 
        server to mandos-client
 
1216
 
    @dbus.service.signal(_interface, signature="s")
 
1217
 
    def Rejected(self, reason):
 
1221
 
    # NeedApproval - signal
 
1222
 
    @dbus.service.signal(_interface, signature="tb")
 
1223
 
    def NeedApproval(self, timeout, default):
 
1225
 
        return self.need_approval()
 
1227
 
    # NewRequest - signal
 
1228
 
    @dbus.service.signal(_interface, signature="s")
 
1229
 
    def NewRequest(self, ip):
 
1231
 
        Is sent after a client request a secret.
 
1238
 
    @dbus.service.method(_interface, in_signature="b")
 
1239
 
    def Approve(self, value):
 
1242
 
    # CheckedOK - method
 
1243
 
    @dbus.service.method(_interface)
 
1244
 
    def CheckedOK(self):
 
1248
 
    @dbus.service.method(_interface)
 
1253
 
    # StartChecker - method
 
1254
 
    @dbus.service.method(_interface)
 
1255
 
    def StartChecker(self):
 
1257
 
        self.start_checker()
 
1260
 
    @dbus.service.method(_interface)
 
1265
 
    # StopChecker - method
 
1266
 
    @dbus.service.method(_interface)
 
1267
 
    def StopChecker(self):
 
1272
 
    # ApprovalPending - property
 
1273
 
    @dbus_service_property(_interface, signature="b", access="read")
 
1274
 
    def ApprovalPending_dbus_property(self):
 
1275
 
        return dbus.Boolean(bool(self.approvals_pending))
 
1277
 
    # ApprovedByDefault - property
 
1278
 
    @dbus_service_property(_interface, signature="b",
 
1280
 
    def ApprovedByDefault_dbus_property(self, value=None):
 
1281
 
        if value is None:       # get
 
1282
 
            return dbus.Boolean(self.approved_by_default)
 
1283
 
        self.approved_by_default = bool(value)
 
1285
 
    # ApprovalDelay - property
 
1286
 
    @dbus_service_property(_interface, signature="t",
 
1288
 
    def ApprovalDelay_dbus_property(self, value=None):
 
1289
 
        if value is None:       # get
 
1290
 
            return dbus.UInt64(self.approval_delay_milliseconds())
 
1291
 
        self.approval_delay = datetime.timedelta(0, 0, 0, value)
 
1293
 
    # ApprovalDuration - property
 
1294
 
    @dbus_service_property(_interface, signature="t",
 
1296
 
    def ApprovalDuration_dbus_property(self, value=None):
 
1297
 
        if value is None:       # get
 
1298
 
            return dbus.UInt64(timedelta_to_milliseconds(
 
1299
 
                    self.approval_duration))
 
1300
 
        self.approval_duration = datetime.timedelta(0, 0, 0, value)
 
1303
 
    @dbus_service_property(_interface, signature="s", access="read")
 
1304
 
    def Name_dbus_property(self):
 
1305
 
        return dbus.String(self.name)
 
1307
 
    # Fingerprint - property
 
1308
 
    @dbus_service_property(_interface, signature="s", access="read")
 
1309
 
    def Fingerprint_dbus_property(self):
 
1310
 
        return dbus.String(self.fingerprint)
 
1313
 
    @dbus_service_property(_interface, signature="s",
 
1315
 
    def Host_dbus_property(self, value=None):
 
1316
 
        if value is None:       # get
 
1317
 
            return dbus.String(self.host)
 
1318
 
        self.host = unicode(value)
 
1320
 
    # Created - property
 
1321
 
    @dbus_service_property(_interface, signature="s", access="read")
 
1322
 
    def Created_dbus_property(self):
 
1323
 
        return datetime_to_dbus(self.created)
 
1325
 
    # LastEnabled - property
 
1326
 
    @dbus_service_property(_interface, signature="s", access="read")
 
1327
 
    def LastEnabled_dbus_property(self):
 
1328
 
        return datetime_to_dbus(self.last_enabled)
 
1330
 
    # Enabled - property
 
1331
 
    @dbus_service_property(_interface, signature="b",
 
1333
 
    def Enabled_dbus_property(self, value=None):
 
1334
 
        if value is None:       # get
 
1335
 
            return dbus.Boolean(self.enabled)
 
1341
 
    # LastCheckedOK - property
 
1342
 
    @dbus_service_property(_interface, signature="s",
 
1344
 
    def LastCheckedOK_dbus_property(self, value=None):
 
1345
 
        if value is not None:
 
1348
 
        return datetime_to_dbus(self.last_checked_ok)
 
1350
 
    # Expires - property
 
1351
 
    @dbus_service_property(_interface, signature="s", access="read")
 
1352
 
    def Expires_dbus_property(self):
 
1353
 
        return datetime_to_dbus(self.expires)
 
1355
 
    # LastApprovalRequest - property
 
1356
 
    @dbus_service_property(_interface, signature="s", access="read")
 
1357
 
    def LastApprovalRequest_dbus_property(self):
 
1358
 
        return datetime_to_dbus(self.last_approval_request)
 
1360
 
    # Timeout - property
 
1361
 
    @dbus_service_property(_interface, signature="t",
 
1363
 
    def Timeout_dbus_property(self, value=None):
 
1364
 
        if value is None:       # get
 
1365
 
            return dbus.UInt64(self.timeout_milliseconds())
 
1366
 
        self.timeout = datetime.timedelta(0, 0, 0, value)
 
1367
 
        # Reschedule timeout
 
1369
 
            now = datetime.datetime.utcnow()
 
1370
 
            time_to_die = timedelta_to_milliseconds(
 
1371
 
                (self.last_checked_ok + self.timeout) - now)
 
1372
 
            if time_to_die <= 0:
 
1373
 
                # The timeout has passed
 
1376
 
                self.expires = (now +
 
1377
 
                                datetime.timedelta(milliseconds =
 
1379
 
                if (getattr(self, "disable_initiator_tag", None)
 
1382
 
                gobject.source_remove(self.disable_initiator_tag)
 
1383
 
                self.disable_initiator_tag = (gobject.timeout_add
 
1387
 
    # ExtendedTimeout - property
 
1388
 
    @dbus_service_property(_interface, signature="t",
 
1390
 
    def ExtendedTimeout_dbus_property(self, value=None):
 
1391
 
        if value is None:       # get
 
1392
 
            return dbus.UInt64(self.extended_timeout_milliseconds())
 
1393
 
        self.extended_timeout = datetime.timedelta(0, 0, 0, value)
 
1395
 
    # Interval - property
 
1396
 
    @dbus_service_property(_interface, signature="t",
 
1398
 
    def Interval_dbus_property(self, value=None):
 
1399
 
        if value is None:       # get
 
1400
 
            return dbus.UInt64(self.interval_milliseconds())
 
1401
 
        self.interval = datetime.timedelta(0, 0, 0, value)
 
1402
 
        if getattr(self, "checker_initiator_tag", None) is None:
 
1405
 
            # Reschedule checker run
 
1406
 
            gobject.source_remove(self.checker_initiator_tag)
 
1407
 
            self.checker_initiator_tag = (gobject.timeout_add
 
1408
 
                                          (value, self.start_checker))
 
1409
 
            self.start_checker()    # Start one now, too
 
1411
 
    # Checker - property
 
1412
 
    @dbus_service_property(_interface, signature="s",
 
1414
 
    def Checker_dbus_property(self, value=None):
 
1415
 
        if value is None:       # get
 
1416
 
            return dbus.String(self.checker_command)
 
1417
 
        self.checker_command = unicode(value)
 
1419
 
    # CheckerRunning - property
 
1420
 
    @dbus_service_property(_interface, signature="b",
 
1422
 
    def CheckerRunning_dbus_property(self, value=None):
 
1423
 
        if value is None:       # get
 
1424
 
            return dbus.Boolean(self.checker is not None)
 
1426
 
            self.start_checker()
 
1430
 
    # ObjectPath - property
 
1431
 
    @dbus_service_property(_interface, signature="o", access="read")
 
1432
 
    def ObjectPath_dbus_property(self):
 
1433
 
        return self.dbus_object_path # is already a dbus.ObjectPath
 
1436
 
    @dbus_service_property(_interface, signature="ay",
 
1437
 
                           access="write", byte_arrays=True)
 
1438
 
    def Secret_dbus_property(self, value):
 
1439
 
        self.secret = str(value)
 
1444
 
class ProxyClient(object):
 
1445
 
    def __init__(self, child_pipe, fpr, address):
 
1446
 
        self._pipe = child_pipe
 
1447
 
        self._pipe.send(('init', fpr, address))
 
1448
 
        if not self._pipe.recv():
 
1451
 
    def __getattribute__(self, name):
 
1453
 
            return super(ProxyClient, self).__getattribute__(name)
 
1454
 
        self._pipe.send(('getattr', name))
 
1455
 
        data = self._pipe.recv()
 
1456
 
        if data[0] == 'data':
 
1458
 
        if data[0] == 'function':
 
1459
 
            def func(*args, **kwargs):
 
1460
 
                self._pipe.send(('funcall', name, args, kwargs))
 
1461
 
                return self._pipe.recv()[1]
 
1464
 
    def __setattr__(self, name, value):
 
1466
 
            return super(ProxyClient, self).__setattr__(name, value)
 
1467
 
        self._pipe.send(('setattr', name, value))
 
1470
 
class ClientDBusTransitional(ClientDBus):
 
1471
 
    __metaclass__ = AlternateDBusNamesMetaclass
 
1474
 
class ClientHandler(socketserver.BaseRequestHandler, object):
 
1475
 
    """A class to handle client connections.
 
1477
 
    Instantiated once for each connection to handle it.
 
 
375
    def still_valid(self):
 
 
376
        """Has the timeout not yet passed for this client?"""
 
 
377
        now = datetime.datetime.now()
 
 
378
        if self.last_checked_ok is None:
 
 
379
            return now < (self.created + self.timeout)
 
 
381
            return now < (self.last_checked_ok + self.timeout)
 
 
384
def peer_certificate(session):
 
 
385
    "Return the peer's OpenPGP certificate as a bytestring"
 
 
386
    # If not an OpenPGP certificate...
 
 
387
    if gnutls.library.functions.gnutls_certificate_type_get\
 
 
388
            (session._c_object) \
 
 
389
           != gnutls.library.constants.GNUTLS_CRT_OPENPGP:
 
 
390
        # ...do the normal thing
 
 
391
        return session.peer_certificate
 
 
392
    list_size = ctypes.c_uint()
 
 
393
    cert_list = gnutls.library.functions.gnutls_certificate_get_peers\
 
 
394
        (session._c_object, ctypes.byref(list_size))
 
 
395
    if list_size.value == 0:
 
 
398
    return ctypes.string_at(cert.data, cert.size)
 
 
401
def fingerprint(openpgp):
 
 
402
    "Convert an OpenPGP bytestring to a hexdigit fingerprint string"
 
 
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
    # New empty GnuTLS certificate
 
 
409
    crt = gnutls.library.types.gnutls_openpgp_crt_t()
 
 
410
    gnutls.library.functions.gnutls_openpgp_crt_init\
 
 
412
    # Import the OpenPGP public key into the certificate
 
 
413
    gnutls.library.functions.gnutls_openpgp_crt_import\
 
 
414
                    (crt, ctypes.byref(datum),
 
 
415
                     gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
 
 
416
    # Verify the self signature in the key
 
 
417
    crtverify = ctypes.c_uint();
 
 
418
    gnutls.library.functions.gnutls_openpgp_crt_verify_self\
 
 
419
        (crt, 0, ctypes.byref(crtverify))
 
 
420
    if crtverify.value != 0:
 
 
421
        gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
 
 
422
        raise gnutls.errors.CertificateSecurityError("Verify failed")
 
 
423
    # New buffer for the fingerprint
 
 
424
    buffer = ctypes.create_string_buffer(20)
 
 
425
    buffer_length = ctypes.c_size_t()
 
 
426
    # Get the fingerprint from the certificate into the buffer
 
 
427
    gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint\
 
 
428
        (crt, ctypes.byref(buffer), ctypes.byref(buffer_length))
 
 
429
    # Deinit the certificate
 
 
430
    gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
 
 
431
    # Convert the buffer to a Python bytestring
 
 
432
    fpr = ctypes.string_at(buffer, buffer_length.value)
 
 
433
    # Convert the bytestring to hexadecimal notation
 
 
434
    hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
 
 
438
class tcp_handler(SocketServer.BaseRequestHandler, object):
 
 
439
    """A TCP request handler class.
 
 
440
    Instantiated by IPv6_TCPServer for each request to handle it.
 
1478
441
    Note: This will run in its own forked process."""
 
1480
443
    def handle(self):
 
1481
 
        with contextlib.closing(self.server.child_pipe) as child_pipe:
 
1482
 
            logger.info("TCP connection from: %s",
 
1483
 
                        unicode(self.client_address))
 
1484
 
            logger.debug("Pipe FD: %d",
 
1485
 
                         self.server.child_pipe.fileno())
 
1487
 
            session = (gnutls.connection
 
1488
 
                       .ClientSession(self.request,
 
1490
 
                                      .X509Credentials()))
 
1492
 
            # Note: gnutls.connection.X509Credentials is really a
 
1493
 
            # generic GnuTLS certificate credentials object so long as
 
1494
 
            # no X.509 keys are added to it.  Therefore, we can use it
 
1495
 
            # here despite using OpenPGP certificates.
 
1497
 
            #priority = ':'.join(("NONE", "+VERS-TLS1.1",
 
1498
 
            #                      "+AES-256-CBC", "+SHA1",
 
1499
 
            #                      "+COMP-NULL", "+CTYPE-OPENPGP",
 
1501
 
            # Use a fallback default, since this MUST be set.
 
1502
 
            priority = self.server.gnutls_priority
 
1503
 
            if priority is None:
 
1505
 
            (gnutls.library.functions
 
1506
 
             .gnutls_priority_set_direct(session._c_object,
 
1509
 
            # Start communication using the Mandos protocol
 
1510
 
            # Get protocol number
 
1511
 
            line = self.request.makefile().readline()
 
1512
 
            logger.debug("Protocol version: %r", line)
 
1514
 
                if int(line.strip().split()[0]) > 1:
 
1516
 
            except (ValueError, IndexError, RuntimeError) as error:
 
1517
 
                logger.error("Unknown protocol version: %s", error)
 
1520
 
            # Start GnuTLS connection
 
1523
 
            except gnutls.errors.GNUTLSError as error:
 
1524
 
                logger.warning("Handshake failed: %s", error)
 
1525
 
                # Do not run session.bye() here: the session is not
 
1526
 
                # established.  Just abandon the request.
 
1528
 
            logger.debug("Handshake succeeded")
 
1530
 
            approval_required = False
 
1533
 
                    fpr = self.fingerprint(self.peer_certificate
 
1536
 
                        gnutls.errors.GNUTLSError) as error:
 
1537
 
                    logger.warning("Bad certificate: %s", error)
 
1539
 
                logger.debug("Fingerprint: %s", fpr)
 
1542
 
                    client = ProxyClient(child_pipe, fpr,
 
1543
 
                                         self.client_address)
 
1547
 
                if self.server.use_dbus:
 
1549
 
                    client.NewRequest(unicode(self.client_address)[0])
 
1551
 
                if client.approval_delay:
 
1552
 
                    delay = client.approval_delay
 
1553
 
                    client.approvals_pending += 1
 
1554
 
                    approval_required = True
 
1557
 
                    if not client.enabled:
 
1558
 
                        logger.info("Client %s is disabled",
 
1560
 
                        if self.server.use_dbus:
 
1562
 
                            client.Rejected("Disabled")
 
1565
 
                    if client.approved or not client.approval_delay:
 
1566
 
                        #We are approved or approval is disabled
 
1568
 
                    elif client.approved is None:
 
1569
 
                        logger.info("Client %s needs approval",
 
1571
 
                        if self.server.use_dbus:
 
1573
 
                            client.NeedApproval(
 
1574
 
                                client.approval_delay_milliseconds(),
 
1575
 
                                client.approved_by_default)
 
1577
 
                        logger.warning("Client %s was not approved",
 
1579
 
                        if self.server.use_dbus:
 
1581
 
                            client.Rejected("Denied")
 
1584
 
                    #wait until timeout or approved
 
1585
 
                    time = datetime.datetime.now()
 
1586
 
                    client.changedstate.acquire()
 
1587
 
                    (client.changedstate.wait
 
1588
 
                     (float(client.timedelta_to_milliseconds(delay)
 
1590
 
                    client.changedstate.release()
 
1591
 
                    time2 = datetime.datetime.now()
 
1592
 
                    if (time2 - time) >= delay:
 
1593
 
                        if not client.approved_by_default:
 
1594
 
                            logger.warning("Client %s timed out while"
 
1595
 
                                           " waiting for approval",
 
1597
 
                            if self.server.use_dbus:
 
1599
 
                                client.Rejected("Approval timed out")
 
1604
 
                        delay -= time2 - time
 
1607
 
                while sent_size < len(client.secret):
 
1609
 
                        sent = session.send(client.secret[sent_size:])
 
1610
 
                    except gnutls.errors.GNUTLSError as error:
 
1611
 
                        logger.warning("gnutls send failed")
 
1613
 
                    logger.debug("Sent: %d, remaining: %d",
 
1614
 
                                 sent, len(client.secret)
 
1615
 
                                 - (sent_size + sent))
 
1618
 
                logger.info("Sending secret to %s", client.name)
 
1619
 
                # bump the timeout using extended_timeout
 
1620
 
                client.checked_ok(client.extended_timeout)
 
1621
 
                if self.server.use_dbus:
 
1626
 
                if approval_required:
 
1627
 
                    client.approvals_pending -= 1
 
1630
 
                except gnutls.errors.GNUTLSError as error:
 
1631
 
                    logger.warning("GnuTLS bye failed")
 
1634
 
    def peer_certificate(session):
 
1635
 
        "Return the peer's OpenPGP certificate as a bytestring"
 
1636
 
        # If not an OpenPGP certificate...
 
1637
 
        if (gnutls.library.functions
 
1638
 
            .gnutls_certificate_type_get(session._c_object)
 
1639
 
            != gnutls.library.constants.GNUTLS_CRT_OPENPGP):
 
1640
 
            # ...do the normal thing
 
1641
 
            return session.peer_certificate
 
1642
 
        list_size = ctypes.c_uint(1)
 
1643
 
        cert_list = (gnutls.library.functions
 
1644
 
                     .gnutls_certificate_get_peers
 
1645
 
                     (session._c_object, ctypes.byref(list_size)))
 
1646
 
        if not bool(cert_list) and list_size.value != 0:
 
1647
 
            raise gnutls.errors.GNUTLSError("error getting peer"
 
1649
 
        if list_size.value == 0:
 
1652
 
        return ctypes.string_at(cert.data, cert.size)
 
1655
 
    def fingerprint(openpgp):
 
1656
 
        "Convert an OpenPGP bytestring to a hexdigit fingerprint"
 
1657
 
        # New GnuTLS "datum" with the OpenPGP public key
 
1658
 
        datum = (gnutls.library.types
 
1659
 
                 .gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
 
1662
 
                                 ctypes.c_uint(len(openpgp))))
 
1663
 
        # New empty GnuTLS certificate
 
1664
 
        crt = gnutls.library.types.gnutls_openpgp_crt_t()
 
1665
 
        (gnutls.library.functions
 
1666
 
         .gnutls_openpgp_crt_init(ctypes.byref(crt)))
 
1667
 
        # Import the OpenPGP public key into the certificate
 
1668
 
        (gnutls.library.functions
 
1669
 
         .gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
 
1670
 
                                    gnutls.library.constants
 
1671
 
                                    .GNUTLS_OPENPGP_FMT_RAW))
 
1672
 
        # Verify the self signature in the key
 
1673
 
        crtverify = ctypes.c_uint()
 
1674
 
        (gnutls.library.functions
 
1675
 
         .gnutls_openpgp_crt_verify_self(crt, 0,
 
1676
 
                                         ctypes.byref(crtverify)))
 
1677
 
        if crtverify.value != 0:
 
1678
 
            gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
 
1679
 
            raise (gnutls.errors.CertificateSecurityError
 
1681
 
        # New buffer for the fingerprint
 
1682
 
        buf = ctypes.create_string_buffer(20)
 
1683
 
        buf_len = ctypes.c_size_t()
 
1684
 
        # Get the fingerprint from the certificate into the buffer
 
1685
 
        (gnutls.library.functions
 
1686
 
         .gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
 
1687
 
                                             ctypes.byref(buf_len)))
 
1688
 
        # Deinit the certificate
 
1689
 
        gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
 
1690
 
        # Convert the buffer to a Python bytestring
 
1691
 
        fpr = ctypes.string_at(buf, buf_len.value)
 
1692
 
        # Convert the bytestring to hexadecimal notation
 
1693
 
        hex_fpr = binascii.hexlify(fpr).upper()
 
1697
 
class MultiprocessingMixIn(object):
 
1698
 
    """Like socketserver.ThreadingMixIn, but with multiprocessing"""
 
1699
 
    def sub_process_main(self, request, address):
 
1701
 
            self.finish_request(request, address)
 
1703
 
            self.handle_error(request, address)
 
1704
 
        self.close_request(request)
 
1706
 
    def process_request(self, request, address):
 
1707
 
        """Start a new process to process the request."""
 
1708
 
        proc = multiprocessing.Process(target = self.sub_process_main,
 
1715
 
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
 
1716
 
    """ adds a pipe to the MixIn """
 
1717
 
    def process_request(self, request, client_address):
 
1718
 
        """Overrides and wraps the original process_request().
 
1720
 
        This function creates a new pipe in self.pipe
 
1722
 
        parent_pipe, self.child_pipe = multiprocessing.Pipe()
 
1724
 
        proc = MultiprocessingMixIn.process_request(self, request,
 
1726
 
        self.child_pipe.close()
 
1727
 
        self.add_pipe(parent_pipe, proc)
 
1729
 
    def add_pipe(self, parent_pipe, proc):
 
1730
 
        """Dummy function; override as necessary"""
 
1731
 
        raise NotImplementedError
 
1734
 
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
 
1735
 
                     socketserver.TCPServer, object):
 
1736
 
    """IPv6-capable TCP server.  Accepts 'None' as address and/or port
 
 
444
        logger.info(u"TCP connection from: %s",
 
 
445
                     unicode(self.client_address))
 
 
446
        session = gnutls.connection.ClientSession\
 
 
447
                  (self.request, gnutls.connection.X509Credentials())
 
 
449
        line = self.request.makefile().readline()
 
 
450
        logger.debug(u"Protocol version: %r", line)
 
 
452
            if int(line.strip().split()[0]) > 1:
 
 
454
        except (ValueError, IndexError, RuntimeError), error:
 
 
455
            logger.error(u"Unknown protocol version: %s", error)
 
 
458
        # Note: gnutls.connection.X509Credentials is really a generic
 
 
459
        # GnuTLS certificate credentials object so long as no X.509
 
 
460
        # keys are added to it.  Therefore, we can use it here despite
 
 
461
        # using OpenPGP certificates.
 
 
463
        #priority = ':'.join(("NONE", "+VERS-TLS1.1", "+AES-256-CBC",
 
 
464
        #                "+SHA1", "+COMP-NULL", "+CTYPE-OPENPGP",
 
 
466
        priority = "NORMAL"             # Fallback default, since this
 
 
468
        if self.server.settings["priority"]:
 
 
469
            priority = self.server.settings["priority"]
 
 
470
        gnutls.library.functions.gnutls_priority_set_direct\
 
 
471
            (session._c_object, priority, None);
 
 
475
        except gnutls.errors.GNUTLSError, error:
 
 
476
            logger.warning(u"Handshake failed: %s", error)
 
 
477
            # Do not run session.bye() here: the session is not
 
 
478
            # established.  Just abandon the request.
 
 
481
            fpr = fingerprint(peer_certificate(session))
 
 
482
        except (TypeError, gnutls.errors.GNUTLSError), error:
 
 
483
            logger.warning(u"Bad certificate: %s", error)
 
 
486
        logger.debug(u"Fingerprint: %s", fpr)
 
 
488
        for c in self.server.clients:
 
 
489
            if c.fingerprint == fpr:
 
 
493
            logger.warning(u"Client not found for fingerprint: %s",
 
 
497
        # Have to check if client.still_valid(), since it is possible
 
 
498
        # that the client timed out while establishing the GnuTLS
 
 
500
        if not client.still_valid():
 
 
501
            logger.warning(u"Client %(name)s is invalid",
 
 
506
        while sent_size < len(client.secret):
 
 
507
            sent = session.send(client.secret[sent_size:])
 
 
508
            logger.debug(u"Sent: %d, remaining: %d",
 
 
509
                         sent, len(client.secret)
 
 
510
                         - (sent_size + sent))
 
 
515
class IPv6_TCPServer(SocketServer.ForkingTCPServer, object):
 
 
516
    """IPv6 TCP server.  Accepts 'None' as address and/or port.
 
1739
 
        enabled:        Boolean; whether this server is activated yet
 
1740
 
        interface:      None or a network interface name (string)
 
1741
 
        use_ipv6:       Boolean; to use IPv6 or not
 
 
518
        settings:       Server settings
 
 
519
        clients:        Set() of Client objects
 
1743
 
    def __init__(self, server_address, RequestHandlerClass,
 
1744
 
                 interface=None, use_ipv6=True):
 
1745
 
        self.interface = interface
 
1747
 
            self.address_family = socket.AF_INET6
 
1748
 
        socketserver.TCPServer.__init__(self, server_address,
 
1749
 
                                        RequestHandlerClass)
 
 
521
    address_family = socket.AF_INET6
 
 
522
    def __init__(self, *args, **kwargs):
 
 
523
        if "settings" in kwargs:
 
 
524
            self.settings = kwargs["settings"]
 
 
525
            del kwargs["settings"]
 
 
526
        if "clients" in kwargs:
 
 
527
            self.clients = kwargs["clients"]
 
 
528
            del kwargs["clients"]
 
 
529
        return super(type(self), self).__init__(*args, **kwargs)
 
1750
530
    def server_bind(self):
 
1751
531
        """This overrides the normal server_bind() function
 
1752
532
        to bind to an interface if one was specified, and also NOT to
 
1753
533
        bind to an address or port if they were not specified."""
 
1754
 
        if self.interface is not None:
 
1755
 
            if SO_BINDTODEVICE is None:
 
1756
 
                logger.error("SO_BINDTODEVICE does not exist;"
 
1757
 
                             " cannot bind to interface %s",
 
1761
 
                    self.socket.setsockopt(socket.SOL_SOCKET,
 
1765
 
                except socket.error as error:
 
1766
 
                    if error[0] == errno.EPERM:
 
1767
 
                        logger.error("No permission to"
 
1768
 
                                     " bind to interface %s",
 
1770
 
                    elif error[0] == errno.ENOPROTOOPT:
 
1771
 
                        logger.error("SO_BINDTODEVICE not available;"
 
1772
 
                                     " cannot bind to interface %s",
 
 
534
        if self.settings["interface"]:
 
 
535
            # 25 is from /usr/include/asm-i486/socket.h
 
 
536
            SO_BINDTODEVICE = getattr(socket, "SO_BINDTODEVICE", 25)
 
 
538
                self.socket.setsockopt(socket.SOL_SOCKET,
 
 
540
                                       self.settings["interface"])
 
 
541
            except socket.error, error:
 
 
542
                if error[0] == errno.EPERM:
 
 
543
                    logger.error(u"No permission to"
 
 
544
                                 u" bind to interface %s",
 
 
545
                                 self.settings["interface"])
 
1776
548
        # Only bind(2) the socket if we really need to.
 
1777
549
        if self.server_address[0] or self.server_address[1]:
 
1778
550
            if not self.server_address[0]:
 
1779
 
                if self.address_family == socket.AF_INET6:
 
1780
 
                    any_address = "::" # in6addr_any
 
1782
 
                    any_address = socket.INADDR_ANY
 
1783
 
                self.server_address = (any_address,
 
 
552
                self.server_address = (in6addr_any,
 
1784
553
                                       self.server_address[1])
 
1785
554
            elif not self.server_address[1]:
 
1786
555
                self.server_address = (self.server_address[0],
 
1788
 
#                 if self.interface:
 
 
557
#                 if self.settings["interface"]:
 
1789
558
#                     self.server_address = (self.server_address[0],
 
1792
561
#                                            if_nametoindex
 
1794
 
            return socketserver.TCPServer.server_bind(self)
 
1797
 
class MandosServer(IPv6_TCPServer):
 
1801
 
        clients:        set of Client objects
 
1802
 
        gnutls_priority GnuTLS priority string
 
1803
 
        use_dbus:       Boolean; to emit D-Bus signals or not
 
1805
 
    Assumes a gobject.MainLoop event loop.
 
1807
 
    def __init__(self, server_address, RequestHandlerClass,
 
1808
 
                 interface=None, use_ipv6=True, clients=None,
 
1809
 
                 gnutls_priority=None, use_dbus=True):
 
1810
 
        self.enabled = False
 
1811
 
        self.clients = clients
 
1812
 
        if self.clients is None:
 
1814
 
        self.use_dbus = use_dbus
 
1815
 
        self.gnutls_priority = gnutls_priority
 
1816
 
        IPv6_TCPServer.__init__(self, server_address,
 
1817
 
                                RequestHandlerClass,
 
1818
 
                                interface = interface,
 
1819
 
                                use_ipv6 = use_ipv6)
 
1820
 
    def server_activate(self):
 
1822
 
            return socketserver.TCPServer.server_activate(self)
 
1827
 
    def add_pipe(self, parent_pipe, proc):
 
1828
 
        # Call "handle_ipc" for both data and EOF events
 
1829
 
        gobject.io_add_watch(parent_pipe.fileno(),
 
1830
 
                             gobject.IO_IN | gobject.IO_HUP,
 
1831
 
                             functools.partial(self.handle_ipc,
 
1836
 
    def handle_ipc(self, source, condition, parent_pipe=None,
 
1837
 
                   proc = None, client_object=None):
 
1839
 
            gobject.IO_IN: "IN",   # There is data to read.
 
1840
 
            gobject.IO_OUT: "OUT", # Data can be written (without
 
1842
 
            gobject.IO_PRI: "PRI", # There is urgent data to read.
 
1843
 
            gobject.IO_ERR: "ERR", # Error condition.
 
1844
 
            gobject.IO_HUP: "HUP"  # Hung up (the connection has been
 
1845
 
                                    # broken, usually for pipes and
 
1848
 
        conditions_string = ' | '.join(name
 
1850
 
                                       condition_names.iteritems()
 
1851
 
                                       if cond & condition)
 
1852
 
        # error, or the other end of multiprocessing.Pipe has closed
 
1853
 
        if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
 
1854
 
            # Wait for other process to exit
 
1858
 
        # Read a request from the child
 
1859
 
        request = parent_pipe.recv()
 
1860
 
        command = request[0]
 
1862
 
        if command == 'init':
 
1864
 
            address = request[2]
 
1866
 
            for c in self.clients.itervalues():
 
1867
 
                if c.fingerprint == fpr:
 
1871
 
                logger.info("Client not found for fingerprint: %s, ad"
 
1872
 
                            "dress: %s", fpr, address)
 
1875
 
                    mandos_dbus_service.ClientNotFound(fpr,
 
1877
 
                parent_pipe.send(False)
 
1880
 
            gobject.io_add_watch(parent_pipe.fileno(),
 
1881
 
                                 gobject.IO_IN | gobject.IO_HUP,
 
1882
 
                                 functools.partial(self.handle_ipc,
 
1888
 
            parent_pipe.send(True)
 
1889
 
            # remove the old hook in favor of the new above hook on
 
1892
 
        if command == 'funcall':
 
1893
 
            funcname = request[1]
 
1897
 
            parent_pipe.send(('data', getattr(client_object,
 
1901
 
        if command == 'getattr':
 
1902
 
            attrname = request[1]
 
1903
 
            if callable(client_object.__getattribute__(attrname)):
 
1904
 
                parent_pipe.send(('function',))
 
1906
 
                parent_pipe.send(('data', client_object
 
1907
 
                                  .__getattribute__(attrname)))
 
1909
 
        if command == 'setattr':
 
1910
 
            attrname = request[1]
 
1912
 
            setattr(client_object, attrname, value)
 
 
564
            return super(type(self), self).server_bind()
 
1917
567
def string_to_delta(interval):
 
1918
568
    """Parse a string and return a datetime.timedelta
 
1920
570
    >>> string_to_delta('7d')
 
1921
571
    datetime.timedelta(7)
 
1922
572
    >>> string_to_delta('60s')
 
 
2035
714
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
 
2036
715
                        "servicename": "Mandos",
 
2041
 
                        "statedir": "/var/lib/mandos"
 
2044
718
    # Parse config file for server-global settings
 
2045
 
    server_config = configparser.SafeConfigParser(server_defaults)
 
 
719
    server_config = ConfigParser.SafeConfigParser(server_defaults)
 
2046
720
    del server_defaults
 
2047
 
    server_config.read(os.path.join(options.configdir,
 
 
721
    server_config.read(os.path.join(options.configdir, "mandos.conf"))
 
2049
722
    # Convert the SafeConfigParser object to a dict
 
2050
723
    server_settings = server_config.defaults()
 
2051
 
    # Use the appropriate methods on the non-string config options
 
2052
 
    for option in ("debug", "use_dbus", "use_ipv6"):
 
2053
 
        server_settings[option] = server_config.getboolean("DEFAULT",
 
2055
 
    if server_settings["port"]:
 
2056
 
        server_settings["port"] = server_config.getint("DEFAULT",
 
 
724
    # Use getboolean on the boolean config option
 
 
725
    server_settings["debug"] = server_config.getboolean\
 
2058
727
    del server_config
 
2060
729
    # Override the settings from the config file with command line
 
2061
730
    # options, if set.
 
2062
731
    for option in ("interface", "address", "port", "debug",
 
2063
 
                   "priority", "servicename", "configdir",
 
2064
 
                   "use_dbus", "use_ipv6", "debuglevel", "restore",
 
 
732
                   "priority", "servicename", "configdir"):
 
2066
733
        value = getattr(options, option)
 
2067
734
        if value is not None:
 
2068
735
            server_settings[option] = value
 
2070
 
    # Force all strings to be unicode
 
2071
 
    for option in server_settings.keys():
 
2072
 
        if type(server_settings[option]) is str:
 
2073
 
            server_settings[option] = unicode(server_settings[option])
 
2074
737
    # Now we have our good server settings in "server_settings"
 
2076
 
    ##################################################################
 
2079
739
    debug = server_settings["debug"]
 
2080
 
    debuglevel = server_settings["debuglevel"]
 
2081
 
    use_dbus = server_settings["use_dbus"]
 
2082
 
    use_ipv6 = server_settings["use_ipv6"]
 
2083
 
    stored_state_path = os.path.join(server_settings["statedir"],
 
2087
 
        initlogger(debug, logging.DEBUG)
 
2092
 
            level = getattr(logging, debuglevel.upper())
 
2093
 
            initlogger(debug, level)
 
 
742
        syslogger.setLevel(logging.WARNING)
 
 
743
        console.setLevel(logging.WARNING)
 
2095
745
    if server_settings["servicename"] != "Mandos":
 
2096
 
        syslogger.setFormatter(logging.Formatter
 
2097
 
                               ('Mandos (%s) [%%(process)d]:'
 
2098
 
                                ' %%(levelname)s: %%(message)s'
 
 
746
        syslogger.setFormatter(logging.Formatter\
 
 
747
                               ('Mandos (%s): %%(levelname)s:'
 
2099
749
                                % server_settings["servicename"]))
 
2101
751
    # Parse config file with clients
 
2102
 
    client_config = configparser.SafeConfigParser(Client
 
 
752
    client_defaults = { "timeout": "1h",
 
 
754
                        "checker": "fping -q -- %(host)s",
 
 
757
    client_config = ConfigParser.SafeConfigParser(client_defaults)
 
2104
758
    client_config.read(os.path.join(server_settings["configdir"],
 
2105
759
                                    "clients.conf"))
 
2107
 
    global mandos_dbus_service
 
2108
 
    mandos_dbus_service = None
 
2110
 
    tcp_server = MandosServer((server_settings["address"],
 
2111
 
                               server_settings["port"]),
 
2113
 
                              interface=(server_settings["interface"]
 
2117
 
                              server_settings["priority"],
 
2120
 
        pidfilename = "/var/run/mandos.pid"
 
2122
 
            pidfile = open(pidfilename, "w")
 
2124
 
            logger.error("Could not open file %r", pidfilename)
 
2127
 
        uid = pwd.getpwnam("_mandos").pw_uid
 
2128
 
        gid = pwd.getpwnam("_mandos").pw_gid
 
2131
 
            uid = pwd.getpwnam("mandos").pw_uid
 
2132
 
            gid = pwd.getpwnam("mandos").pw_gid
 
2135
 
                uid = pwd.getpwnam("nobody").pw_uid
 
2136
 
                gid = pwd.getpwnam("nobody").pw_gid
 
2143
 
    except OSError as error:
 
2144
 
        if error[0] != errno.EPERM:
 
2148
 
        # Enable all possible GnuTLS debugging
 
2150
 
        # "Use a log level over 10 to enable all debugging options."
 
2152
 
        gnutls.library.functions.gnutls_global_set_log_level(11)
 
2154
 
        @gnutls.library.types.gnutls_log_func
 
2155
 
        def debug_gnutls(level, string):
 
2156
 
            logger.debug("GnuTLS: %s", string[:-1])
 
2158
 
        (gnutls.library.functions
 
2159
 
         .gnutls_global_set_log_function(debug_gnutls))
 
2161
 
        # Redirect stdin so all checkers get /dev/null
 
2162
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
2163
 
        os.dup2(null, sys.stdin.fileno())
 
2167
 
    # Need to fork before connecting to D-Bus
 
2169
 
        # Close all input and output, do double fork, etc.
 
2172
 
    gobject.threads_init()
 
 
762
    service = AvahiService(name = server_settings["servicename"],
 
 
763
                           type = "_mandos._tcp", );
 
 
764
    if server_settings["interface"]:
 
 
765
        service.interface = if_nametoindex\
 
 
766
                            (server_settings["interface"])
 
2174
768
    global main_loop
 
2175
771
    # From the Avahi example code
 
2176
772
    DBusGMainLoop(set_as_default=True )
 
2177
773
    main_loop = gobject.MainLoop()
 
2178
774
    bus = dbus.SystemBus()
 
 
775
    server = dbus.Interface(bus.get_object(avahi.DBUS_NAME,
 
 
776
                                           avahi.DBUS_PATH_SERVER),
 
 
777
                            avahi.DBUS_INTERFACE_SERVER)
 
2179
778
    # End of Avahi example code
 
2182
 
            bus_name = dbus.service.BusName("se.recompile.Mandos",
 
2183
 
                                            bus, do_not_queue=True)
 
2184
 
            old_bus_name = (dbus.service.BusName
 
2185
 
                            ("se.bsnet.fukt.Mandos", bus,
 
2187
 
        except dbus.exceptions.NameExistsException as e:
 
2188
 
            logger.error(unicode(e) + ", disabling D-Bus")
 
2190
 
            server_settings["use_dbus"] = False
 
2191
 
            tcp_server.use_dbus = False
 
2192
 
    protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
 
2193
 
    service = AvahiServiceToSyslog(name =
 
2194
 
                                   server_settings["servicename"],
 
2195
 
                                   servicetype = "_mandos._tcp",
 
2196
 
                                   protocol = protocol, bus = bus)
 
2197
 
    if server_settings["interface"]:
 
2198
 
        service.interface = (if_nametoindex
 
2199
 
                             (str(server_settings["interface"])))
 
2201
 
    global multiprocessing_manager
 
2202
 
    multiprocessing_manager = multiprocessing.Manager()
 
2204
 
    client_class = Client
 
2206
 
        client_class = functools.partial(ClientDBusTransitional,
 
2209
 
    client_settings = Client.config_parser(client_config)
 
2210
 
    old_client_settings = {}
 
2213
 
    # Get client data and settings from last running state.
 
2214
 
    if server_settings["restore"]:
 
2216
 
            with open(stored_state_path, "rb") as stored_state:
 
2217
 
                clients_data, old_client_settings = (pickle.load
 
2219
 
            os.remove(stored_state_path)
 
2220
 
        except IOError as e:
 
2221
 
            logger.warning("Could not load persistent state: {0}"
 
2223
 
            if e.errno != errno.ENOENT:
 
2225
 
        except EOFError as e:
 
2226
 
            logger.warning("Could not load persistent state: "
 
2227
 
                           "EOFError: {0}".format(e))
 
2229
 
    with PGPEngine() as pgp:
 
2230
 
        for client_name, client in clients_data.iteritems():
 
2231
 
            # Decide which value to use after restoring saved state.
 
2232
 
            # We have three different values: Old config file,
 
2233
 
            # new config file, and saved state.
 
2234
 
            # New config value takes precedence if it differs from old
 
2235
 
            # config value, otherwise use saved state.
 
2236
 
            for name, value in client_settings[client_name].items():
 
2238
 
                    # For each value in new config, check if it
 
2239
 
                    # differs from the old config value (Except for
 
2240
 
                    # the "secret" attribute)
 
2241
 
                    if (name != "secret" and
 
2242
 
                        value != old_client_settings[client_name]
 
2244
 
                        client[name] = value
 
2248
 
            # Clients who has passed its expire date can still be
 
2249
 
            # enabled if its last checker was successful.  Clients
 
2250
 
            # whose checker succeeded before we stored its state is
 
2251
 
            # assumed to have successfully run all checkers during
 
2253
 
            if client["enabled"]:
 
2254
 
                if datetime.datetime.utcnow() >= client["expires"]:
 
2255
 
                    if not client["last_checked_ok"]:
 
2257
 
                            "disabling client {0} - Client never "
 
2258
 
                            "performed a successful checker"
 
2259
 
                            .format(client_name))
 
2260
 
                        client["enabled"] = False
 
2261
 
                    elif client["last_checker_status"] != 0:
 
2263
 
                            "disabling client {0} - Client "
 
2264
 
                            "last checker failed with error code {1}"
 
2265
 
                            .format(client_name,
 
2266
 
                                    client["last_checker_status"]))
 
2267
 
                        client["enabled"] = False
 
2269
 
                        client["expires"] = (datetime.datetime
 
2271
 
                                             + client["timeout"])
 
2272
 
                        logger.debug("Last checker succeeded,"
 
2273
 
                                     " keeping {0} enabled"
 
2274
 
                                     .format(client_name))
 
2276
 
                client["secret"] = (
 
2277
 
                    pgp.decrypt(client["encrypted_secret"],
 
2278
 
                                client_settings[client_name]
 
2281
 
                # If decryption fails, we use secret from new settings
 
2282
 
                logger.debug("Failed to decrypt {0} old secret"
 
2283
 
                             .format(client_name))
 
2284
 
                client["secret"] = (
 
2285
 
                    client_settings[client_name]["secret"])
 
2288
 
    # Add/remove clients based on new changes made to config
 
2289
 
    for client_name in (set(old_client_settings)
 
2290
 
                        - set(client_settings)):
 
2291
 
        del clients_data[client_name]
 
2292
 
    for client_name in (set(client_settings)
 
2293
 
                        - set(old_client_settings)):
 
2294
 
        clients_data[client_name] = client_settings[client_name]
 
2296
 
    # Create all client objects
 
2297
 
    for client_name, client in clients_data.iteritems():
 
2298
 
        tcp_server.clients[client_name] = client_class(
 
2299
 
            name = client_name, settings = client)
 
2301
 
    if not tcp_server.clients:
 
2302
 
        logger.warning("No clients defined")
 
 
781
    def remove_from_clients(client):
 
 
782
        clients.remove(client)
 
 
784
            logger.critical(u"No clients left, exiting")
 
 
787
    clients.update(Set(Client(name = section,
 
 
788
                              stop_hook = remove_from_clients,
 
 
790
                              = dict(client_config.items(section)))
 
 
791
                       for section in client_config.sections()))
 
 
793
        logger.critical(u"No clients defined")
 
 
797
        # Redirect stdin so all checkers get /dev/null
 
 
798
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
 
799
        os.dup2(null, sys.stdin.fileno())
 
 
804
        logger.removeHandler(console)
 
 
805
        # Close all input and output, do double fork, etc.
 
 
808
    pidfilename = "/var/run/mandos/mandos.pid"
 
 
811
        pidfile = open(pidfilename, "w")
 
 
812
        pidfile.write(str(pid) + "\n")
 
 
816
        logger.error(u"Could not write %s file with PID %d",
 
 
817
                     pidfilename, os.getpid())
 
 
820
        "Cleanup function; run on exit"
 
 
822
        # From the Avahi example code
 
 
823
        if not group is None:
 
 
826
        # End of Avahi example code
 
 
829
            client = clients.pop()
 
 
830
            client.stop_hook = None
 
 
833
    atexit.register(cleanup)
 
2308
 
                pidfile.write(str(pid) + "\n".encode("utf-8"))
 
2311
 
            logger.error("Could not write to file %r with PID %d",
 
2314
 
            # "pidfile" was never created
 
2317
836
        signal.signal(signal.SIGINT, signal.SIG_IGN)
 
2319
837
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
 
2320
838
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
 
2323
 
        class MandosDBusService(dbus.service.Object):
 
2324
 
            """A D-Bus proxy object"""
 
2326
 
                dbus.service.Object.__init__(self, bus, "/")
 
2327
 
            _interface = "se.recompile.Mandos"
 
2329
 
            @dbus.service.signal(_interface, signature="o")
 
2330
 
            def ClientAdded(self, objpath):
 
2334
 
            @dbus.service.signal(_interface, signature="ss")
 
2335
 
            def ClientNotFound(self, fingerprint, address):
 
2339
 
            @dbus.service.signal(_interface, signature="os")
 
2340
 
            def ClientRemoved(self, objpath, name):
 
2344
 
            @dbus.service.method(_interface, out_signature="ao")
 
2345
 
            def GetAllClients(self):
 
2347
 
                return dbus.Array(c.dbus_object_path
 
2349
 
                                  tcp_server.clients.itervalues())
 
2351
 
            @dbus.service.method(_interface,
 
2352
 
                                 out_signature="a{oa{sv}}")
 
2353
 
            def GetAllClientsWithProperties(self):
 
2355
 
                return dbus.Dictionary(
 
2356
 
                    ((c.dbus_object_path, c.GetAll(""))
 
2357
 
                     for c in tcp_server.clients.itervalues()),
 
2360
 
            @dbus.service.method(_interface, in_signature="o")
 
2361
 
            def RemoveClient(self, object_path):
 
2363
 
                for c in tcp_server.clients.itervalues():
 
2364
 
                    if c.dbus_object_path == object_path:
 
2365
 
                        del tcp_server.clients[c.name]
 
2366
 
                        c.remove_from_connection()
 
2367
 
                        # Don't signal anything except ClientRemoved
 
2368
 
                        c.disable(quiet=True)
 
2370
 
                        self.ClientRemoved(object_path, c.name)
 
2372
 
                raise KeyError(object_path)
 
2376
 
        class MandosDBusServiceTransitional(MandosDBusService):
 
2377
 
            __metaclass__ = AlternateDBusNamesMetaclass
 
2378
 
        mandos_dbus_service = MandosDBusServiceTransitional()
 
2381
 
        "Cleanup function; run on exit"
 
2384
 
        multiprocessing.active_children()
 
2385
 
        if not (tcp_server.clients or client_settings):
 
2388
 
        # Store client before exiting. Secrets are encrypted with key
 
2389
 
        # based on what config file has. If config file is
 
2390
 
        # removed/edited, old secret will thus be unrecovable.
 
2392
 
        with PGPEngine() as pgp:
 
2393
 
            for client in tcp_server.clients.itervalues():
 
2394
 
                key = client_settings[client.name]["secret"]
 
2395
 
                client.encrypted_secret = pgp.encrypt(client.secret,
 
2399
 
                # A list of attributes that can not be pickled
 
2401
 
                exclude = set(("bus", "changedstate", "secret",
 
2403
 
                for name, typ in (inspect.getmembers
 
2404
 
                                  (dbus.service.Object)):
 
2407
 
                client_dict["encrypted_secret"] = (client
 
2409
 
                for attr in client.client_structure:
 
2410
 
                    if attr not in exclude:
 
2411
 
                        client_dict[attr] = getattr(client, attr)
 
2413
 
                clients[client.name] = client_dict
 
2414
 
                del client_settings[client.name]["secret"]
 
2417
 
            tempfd, tempname = tempfile.mkstemp(suffix=".pickle",
 
2420
 
                                                (stored_state_path))
 
2421
 
            with os.fdopen(tempfd, "wb") as stored_state:
 
2422
 
                pickle.dump((clients, client_settings), stored_state)
 
2423
 
            os.rename(tempname, stored_state_path)
 
2424
 
        except (IOError, OSError) as e:
 
2425
 
            logger.warning("Could not save persistent state: {0}"
 
2432
 
            if e.errno not in set((errno.ENOENT, errno.EACCES,
 
2436
 
        # Delete all clients, and settings from config
 
2437
 
        while tcp_server.clients:
 
2438
 
            name, client = tcp_server.clients.popitem()
 
2440
 
                client.remove_from_connection()
 
2441
 
            # Don't signal anything except ClientRemoved
 
2442
 
            client.disable(quiet=True)
 
2445
 
                mandos_dbus_service.ClientRemoved(client
 
2448
 
        client_settings.clear()
 
2450
 
    atexit.register(cleanup)
 
2452
 
    for client in tcp_server.clients.itervalues():
 
2455
 
            mandos_dbus_service.ClientAdded(client.dbus_object_path)
 
2456
 
        # Need to initiate checking of clients
 
2458
 
            client.init_checker()
 
2461
 
    tcp_server.server_activate()
 
 
840
    for client in clients:
 
 
843
    tcp_server = IPv6_TCPServer((server_settings["address"],
 
 
844
                                 server_settings["port"]),
 
 
846
                                settings=server_settings,
 
2463
848
    # Find out what port we got
 
2464
849
    service.port = tcp_server.socket.getsockname()[1]
 
2466
 
        logger.info("Now listening on address %r, port %d,"
 
2467
 
                    " flowinfo %d, scope_id %d"
 
2468
 
                    % tcp_server.socket.getsockname())
 
2470
 
        logger.info("Now listening on address %r, port %d"
 
2471
 
                    % tcp_server.socket.getsockname())
 
 
850
    logger.info(u"Now listening on address %r, port %d, flowinfo %d,"
 
 
851
                u" scope_id %d" % tcp_server.socket.getsockname())
 
2473
853
    #service.interface = tcp_server.socket.getsockname()[3]
 
2476
856
        # From the Avahi example code
 
 
857
        server.connect_to_signal("StateChanged", server_state_changed)
 
2479
 
        except dbus.exceptions.DBusException as error:
 
2480
 
            logger.critical("DBusException: %s", error)
 
 
859
            server_state_changed(server.GetState())
 
 
860
        except dbus.exceptions.DBusException, error:
 
 
861
            logger.critical(u"DBusException: %s", error)
 
2483
863
        # End of Avahi example code
 
2485
865
        gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
 
2486
866
                             lambda *args, **kwargs:
 
2487
 
                             (tcp_server.handle_request
 
2488
 
                              (*args[2:], **kwargs) or True))
 
 
867
                             tcp_server.handle_request\
 
 
868
                             (*args[2:], **kwargs) or True)
 
2490
 
        logger.debug("Starting main loop")
 
 
870
        logger.debug(u"Starting main loop")
 
 
871
        main_loop_started = True
 
2492
 
    except AvahiError as error:
 
2493
 
        logger.critical("AvahiError: %s", error)
 
 
873
    except AvahiError, error:
 
 
874
        logger.critical(u"AvahiError: %s" + unicode(error))
 
2496
876
    except KeyboardInterrupt:
 
2498
 
            print("", file=sys.stderr)
 
2499
 
        logger.debug("Server received KeyboardInterrupt")
 
2500
 
    logger.debug("Server exiting")
 
2501
 
    # Must run before the D-Bus bus name gets deregistered
 
2504
880
if __name__ == '__main__':