/mandos/trunk

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos

  • Committer: teddy at bsnet
  • Date: 2011-03-21 19:34:39 UTC
  • Revision ID: teddy@fukt.bsnet.se-20110321193439-lkj3kwvhmujd8lwv
* plugins.d/mandos-client.c (good_interface): Reject non-ARP
                                              interfaces.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
#!/usr/bin/python2.7
 
1
#!/usr/bin/python
2
2
# -*- mode: python; coding: utf-8 -*-
3
3
4
4
# Mandos server - give out binary blobs to connecting clients.
11
11
# "AvahiService" class, and some lines in "main".
12
12
13
13
# Everything else is
14
 
# Copyright © 2008-2015 Teddy Hogeborn
15
 
# Copyright © 2008-2015 Björn Påhlsson
 
14
# Copyright © 2008-2011 Teddy Hogeborn
 
15
# Copyright © 2008-2011 Björn Påhlsson
16
16
17
17
# This program is free software: you can redistribute it and/or modify
18
18
# it under the terms of the GNU General Public License as published by
28
28
# along with this program.  If not, see
29
29
# <http://www.gnu.org/licenses/>.
30
30
31
 
# Contact the authors at <mandos@recompile.se>.
 
31
# Contact the authors at <mandos@fukt.bsnet.se>.
32
32
33
33
 
34
34
from __future__ import (division, absolute_import, print_function,
35
35
                        unicode_literals)
36
36
 
37
 
from future_builtins import *
38
 
 
39
 
try:
40
 
    import SocketServer as socketserver
41
 
except ImportError:
42
 
    import socketserver
 
37
import SocketServer as socketserver
43
38
import socket
44
39
import argparse
45
40
import datetime
50
45
import gnutls.library.functions
51
46
import gnutls.library.constants
52
47
import gnutls.library.types
53
 
try:
54
 
    import ConfigParser as configparser
55
 
except ImportError:
56
 
    import configparser
 
48
import ConfigParser as configparser
57
49
import sys
58
50
import re
59
51
import os
68
60
import struct
69
61
import fcntl
70
62
import functools
71
 
try:
72
 
    import cPickle as pickle
73
 
except ImportError:
74
 
    import pickle
 
63
import cPickle as pickle
75
64
import multiprocessing
76
 
import types
77
 
import binascii
78
 
import tempfile
79
 
import itertools
80
 
import collections
81
 
import codecs
82
65
 
83
66
import dbus
84
67
import dbus.service
85
 
try:
86
 
    import gobject
87
 
except ImportError:
88
 
    from gi.repository import GObject as gobject
 
68
import gobject
89
69
import avahi
90
70
from dbus.mainloop.glib import DBusGMainLoop
91
71
import ctypes
101
81
    except ImportError:
102
82
        SO_BINDTODEVICE = None
103
83
 
104
 
if sys.version_info.major == 2:
105
 
    str = unicode
106
 
 
107
 
version = "1.6.9"
108
 
stored_state_file = "clients.pickle"
109
 
 
110
 
logger = logging.getLogger()
111
 
syslogger = None
112
 
 
113
 
try:
114
 
    if_nametoindex = ctypes.cdll.LoadLibrary(
115
 
        ctypes.util.find_library("c")).if_nametoindex
116
 
except (OSError, AttributeError):
117
 
    
118
 
    def if_nametoindex(interface):
119
 
        "Get an interface index the hard way, i.e. using fcntl()"
120
 
        SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
121
 
        with contextlib.closing(socket.socket()) as s:
122
 
            ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
123
 
                                struct.pack(b"16s16x", interface))
124
 
        interface_index = struct.unpack("I", ifreq[16:20])[0]
125
 
        return interface_index
126
 
 
127
 
 
128
 
def initlogger(debug, level=logging.WARNING):
129
 
    """init logger and add loglevel"""
130
 
    
131
 
    global syslogger
132
 
    syslogger = (logging.handlers.SysLogHandler(
133
 
        facility = logging.handlers.SysLogHandler.LOG_DAEMON,
134
 
        address = "/dev/log"))
135
 
    syslogger.setFormatter(logging.Formatter
136
 
                           ('Mandos [%(process)d]: %(levelname)s:'
137
 
                            ' %(message)s'))
138
 
    logger.addHandler(syslogger)
139
 
    
140
 
    if debug:
141
 
        console = logging.StreamHandler()
142
 
        console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
143
 
                                               ' [%(process)d]:'
144
 
                                               ' %(levelname)s:'
145
 
                                               ' %(message)s'))
146
 
        logger.addHandler(console)
147
 
    logger.setLevel(level)
148
 
 
149
 
 
150
 
class PGPError(Exception):
151
 
    """Exception if encryption/decryption fails"""
152
 
    pass
153
 
 
154
 
 
155
 
class PGPEngine(object):
156
 
    """A simple class for OpenPGP symmetric encryption & decryption"""
157
 
    
158
 
    def __init__(self):
159
 
        self.tempdir = tempfile.mkdtemp(prefix="mandos-")
160
 
        self.gnupgargs = ['--batch',
161
 
                          '--home', self.tempdir,
162
 
                          '--force-mdc',
163
 
                          '--quiet',
164
 
                          '--no-use-agent']
165
 
    
166
 
    def __enter__(self):
167
 
        return self
168
 
    
169
 
    def __exit__(self, exc_type, exc_value, traceback):
170
 
        self._cleanup()
171
 
        return False
172
 
    
173
 
    def __del__(self):
174
 
        self._cleanup()
175
 
    
176
 
    def _cleanup(self):
177
 
        if self.tempdir is not None:
178
 
            # Delete contents of tempdir
179
 
            for root, dirs, files in os.walk(self.tempdir,
180
 
                                             topdown = False):
181
 
                for filename in files:
182
 
                    os.remove(os.path.join(root, filename))
183
 
                for dirname in dirs:
184
 
                    os.rmdir(os.path.join(root, dirname))
185
 
            # Remove tempdir
186
 
            os.rmdir(self.tempdir)
187
 
            self.tempdir = None
188
 
    
189
 
    def password_encode(self, password):
190
 
        # Passphrase can not be empty and can not contain newlines or
191
 
        # NUL bytes.  So we prefix it and hex encode it.
192
 
        encoded = b"mandos" + binascii.hexlify(password)
193
 
        if len(encoded) > 2048:
194
 
            # GnuPG can't handle long passwords, so encode differently
195
 
            encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
196
 
                       .replace(b"\n", b"\\n")
197
 
                       .replace(b"\0", b"\\x00"))
198
 
        return encoded
199
 
    
200
 
    def encrypt(self, data, password):
201
 
        passphrase = self.password_encode(password)
202
 
        with tempfile.NamedTemporaryFile(
203
 
                dir=self.tempdir) as passfile:
204
 
            passfile.write(passphrase)
205
 
            passfile.flush()
206
 
            proc = subprocess.Popen(['gpg', '--symmetric',
207
 
                                     '--passphrase-file',
208
 
                                     passfile.name]
209
 
                                    + self.gnupgargs,
210
 
                                    stdin = subprocess.PIPE,
211
 
                                    stdout = subprocess.PIPE,
212
 
                                    stderr = subprocess.PIPE)
213
 
            ciphertext, err = proc.communicate(input = data)
214
 
        if proc.returncode != 0:
215
 
            raise PGPError(err)
216
 
        return ciphertext
217
 
    
218
 
    def decrypt(self, data, password):
219
 
        passphrase = self.password_encode(password)
220
 
        with tempfile.NamedTemporaryFile(
221
 
                dir = self.tempdir) as passfile:
222
 
            passfile.write(passphrase)
223
 
            passfile.flush()
224
 
            proc = subprocess.Popen(['gpg', '--decrypt',
225
 
                                     '--passphrase-file',
226
 
                                     passfile.name]
227
 
                                    + self.gnupgargs,
228
 
                                    stdin = subprocess.PIPE,
229
 
                                    stdout = subprocess.PIPE,
230
 
                                    stderr = subprocess.PIPE)
231
 
            decrypted_plaintext, err = proc.communicate(input = data)
232
 
        if proc.returncode != 0:
233
 
            raise PGPError(err)
234
 
        return decrypted_plaintext
235
 
 
 
84
 
 
85
version = "1.3.0"
 
86
 
 
87
#logger = logging.getLogger('mandos')
 
88
logger = logging.Logger('mandos')
 
89
syslogger = (logging.handlers.SysLogHandler
 
90
             (facility = logging.handlers.SysLogHandler.LOG_DAEMON,
 
91
              address = str("/dev/log")))
 
92
syslogger.setFormatter(logging.Formatter
 
93
                       ('Mandos [%(process)d]: %(levelname)s:'
 
94
                        ' %(message)s'))
 
95
logger.addHandler(syslogger)
 
96
 
 
97
console = logging.StreamHandler()
 
98
console.setFormatter(logging.Formatter('%(name)s [%(process)d]:'
 
99
                                       ' %(levelname)s:'
 
100
                                       ' %(message)s'))
 
101
logger.addHandler(console)
236
102
 
237
103
class AvahiError(Exception):
238
104
    def __init__(self, value, *args, **kwargs):
239
105
        self.value = value
240
 
        return super(AvahiError, self).__init__(value, *args,
241
 
                                                **kwargs)
242
 
 
 
106
        super(AvahiError, self).__init__(value, *args, **kwargs)
 
107
    def __unicode__(self):
 
108
        return unicode(repr(self.value))
243
109
 
244
110
class AvahiServiceError(AvahiError):
245
111
    pass
246
112
 
247
 
 
248
113
class AvahiGroupError(AvahiError):
249
114
    pass
250
115
 
257
122
               Used to optionally bind to the specified interface.
258
123
    name: string; Example: 'Mandos'
259
124
    type: string; Example: '_mandos._tcp'.
260
 
     See <https://www.iana.org/assignments/service-names-port-numbers>
 
125
                  See <http://www.dns-sd.org/ServiceTypes.html>
261
126
    port: integer; what port to announce
262
127
    TXT: list of strings; TXT record for the service
263
128
    domain: string; Domain to publish on, default to .local if empty.
269
134
    server: D-Bus Server
270
135
    bus: dbus.SystemBus()
271
136
    """
272
 
    
273
 
    def __init__(self,
274
 
                 interface = avahi.IF_UNSPEC,
275
 
                 name = None,
276
 
                 servicetype = None,
277
 
                 port = None,
278
 
                 TXT = None,
279
 
                 domain = "",
280
 
                 host = "",
281
 
                 max_renames = 32768,
282
 
                 protocol = avahi.PROTO_UNSPEC,
283
 
                 bus = None):
 
137
    def __init__(self, interface = avahi.IF_UNSPEC, name = None,
 
138
                 servicetype = None, port = None, TXT = None,
 
139
                 domain = "", host = "", max_renames = 32768,
 
140
                 protocol = avahi.PROTO_UNSPEC, bus = None):
284
141
        self.interface = interface
285
142
        self.name = name
286
143
        self.type = servicetype
294
151
        self.group = None       # our entry group
295
152
        self.server = None
296
153
        self.bus = bus
297
 
        self.entry_group_state_changed_match = None
298
 
    
299
 
    def rename(self, remove=True):
 
154
    def rename(self):
300
155
        """Derived from the Avahi example code"""
301
156
        if self.rename_count >= self.max_renames:
302
157
            logger.critical("No suitable Zeroconf service name found"
303
158
                            " after %i retries, exiting.",
304
159
                            self.rename_count)
305
160
            raise AvahiServiceError("Too many renames")
306
 
        self.name = str(
307
 
            self.server.GetAlternativeServiceName(self.name))
308
 
        self.rename_count += 1
 
161
        self.name = unicode(self.server.GetAlternativeServiceName(self.name))
309
162
        logger.info("Changing Zeroconf service name to %r ...",
310
163
                    self.name)
311
 
        if remove:
312
 
            self.remove()
 
164
        syslogger.setFormatter(logging.Formatter
 
165
                               ('Mandos (%s) [%%(process)d]:'
 
166
                                ' %%(levelname)s: %%(message)s'
 
167
                                % self.name))
 
168
        self.remove()
313
169
        try:
314
170
            self.add()
315
 
        except dbus.exceptions.DBusException as error:
316
 
            if (error.get_dbus_name()
317
 
                == "org.freedesktop.Avahi.CollisionError"):
318
 
                logger.info("Local Zeroconf service name collision.")
319
 
                return self.rename(remove=False)
320
 
            else:
321
 
                logger.critical("D-Bus Exception", exc_info=error)
322
 
                self.cleanup()
323
 
                os._exit(1)
324
 
    
 
171
        except dbus.exceptions.DBusException, error:
 
172
            logger.critical("DBusException: %s", error)
 
173
            self.cleanup()
 
174
            os._exit(1)
 
175
        self.rename_count += 1
325
176
    def remove(self):
326
177
        """Derived from the Avahi example code"""
327
 
        if self.entry_group_state_changed_match is not None:
328
 
            self.entry_group_state_changed_match.remove()
329
 
            self.entry_group_state_changed_match = None
330
178
        if self.group is not None:
331
179
            self.group.Reset()
332
 
    
333
180
    def add(self):
334
181
        """Derived from the Avahi example code"""
335
 
        self.remove()
336
182
        if self.group is None:
337
183
            self.group = dbus.Interface(
338
184
                self.bus.get_object(avahi.DBUS_NAME,
339
185
                                    self.server.EntryGroupNew()),
340
186
                avahi.DBUS_INTERFACE_ENTRY_GROUP)
341
 
        self.entry_group_state_changed_match = (
342
 
            self.group.connect_to_signal(
343
 
                'StateChanged', self.entry_group_state_changed))
 
187
            self.group.connect_to_signal('StateChanged',
 
188
                                         self
 
189
                                         .entry_group_state_changed)
344
190
        logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
345
191
                     self.name, self.type)
346
192
        self.group.AddService(
352
198
            dbus.UInt16(self.port),
353
199
            avahi.string_array_to_txt_array(self.TXT))
354
200
        self.group.Commit()
355
 
    
356
201
    def entry_group_state_changed(self, state, error):
357
202
        """Derived from the Avahi example code"""
358
203
        logger.debug("Avahi entry group state change: %i", state)
364
209
            self.rename()
365
210
        elif state == avahi.ENTRY_GROUP_FAILURE:
366
211
            logger.critical("Avahi: Error in group state changed %s",
367
 
                            str(error))
368
 
            raise AvahiGroupError("State changed: {!s}".format(error))
369
 
    
 
212
                            unicode(error))
 
213
            raise AvahiGroupError("State changed: %s"
 
214
                                  % unicode(error))
370
215
    def cleanup(self):
371
216
        """Derived from the Avahi example code"""
372
217
        if self.group is not None:
373
 
            try:
374
 
                self.group.Free()
375
 
            except (dbus.exceptions.UnknownMethodException,
376
 
                    dbus.exceptions.DBusException):
377
 
                pass
 
218
            self.group.Free()
378
219
            self.group = None
379
 
        self.remove()
380
 
    
381
 
    def server_state_changed(self, state, error=None):
 
220
    def server_state_changed(self, state):
382
221
        """Derived from the Avahi example code"""
383
222
        logger.debug("Avahi server state change: %i", state)
384
 
        bad_states = {
385
 
            avahi.SERVER_INVALID: "Zeroconf server invalid",
386
 
            avahi.SERVER_REGISTERING: None,
387
 
            avahi.SERVER_COLLISION: "Zeroconf server name collision",
388
 
            avahi.SERVER_FAILURE: "Zeroconf server failure",
389
 
        }
390
 
        if state in bad_states:
391
 
            if bad_states[state] is not None:
392
 
                if error is None:
393
 
                    logger.error(bad_states[state])
394
 
                else:
395
 
                    logger.error(bad_states[state] + ": %r", error)
396
 
            self.cleanup()
 
223
        if state == avahi.SERVER_COLLISION:
 
224
            logger.error("Zeroconf server name collision")
 
225
            self.remove()
397
226
        elif state == avahi.SERVER_RUNNING:
398
227
            self.add()
399
 
        else:
400
 
            if error is None:
401
 
                logger.debug("Unknown state: %r", state)
402
 
            else:
403
 
                logger.debug("Unknown state: %r: %r", state, error)
404
 
    
405
228
    def activate(self):
406
229
        """Derived from the Avahi example code"""
407
230
        if self.server is None:
408
231
            self.server = dbus.Interface(
409
232
                self.bus.get_object(avahi.DBUS_NAME,
410
 
                                    avahi.DBUS_PATH_SERVER,
411
 
                                    follow_name_owner_changes=True),
 
233
                                    avahi.DBUS_PATH_SERVER),
412
234
                avahi.DBUS_INTERFACE_SERVER)
413
235
        self.server.connect_to_signal("StateChanged",
414
 
                                      self.server_state_changed)
 
236
                                 self.server_state_changed)
415
237
        self.server_state_changed(self.server.GetState())
416
238
 
417
239
 
418
 
class AvahiServiceToSyslog(AvahiService):
419
 
    def rename(self, *args, **kwargs):
420
 
        """Add the new name to the syslog messages"""
421
 
        ret = AvahiService.rename(self, *args, **kwargs)
422
 
        syslogger.setFormatter(logging.Formatter(
423
 
            'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
424
 
            .format(self.name)))
425
 
        return ret
426
 
 
427
 
 
428
240
class Client(object):
429
241
    """A representation of a client host served by this server.
430
242
    
431
243
    Attributes:
432
 
    approved:   bool(); 'None' if not yet approved/disapproved
 
244
    _approved:   bool(); 'None' if not yet approved/disapproved
433
245
    approval_delay: datetime.timedelta(); Time to wait for approval
434
246
    approval_duration: datetime.timedelta(); Duration of one approval
435
247
    checker:    subprocess.Popen(); a running checker process used
442
254
                     instance %(name)s can be used in the command.
443
255
    checker_initiator_tag: a gobject event source tag, or None
444
256
    created:    datetime.datetime(); (UTC) object creation
445
 
    client_structure: Object describing what attributes a client has
446
 
                      and is used for storing the client at exit
447
257
    current_checker_command: string; current running checker_command
 
258
    disable_hook:  If set, called by disable() as disable_hook(self)
448
259
    disable_initiator_tag: a gobject event source tag, or None
449
260
    enabled:    bool()
450
261
    fingerprint: string (40 or 32 hexadecimal digits); used to
453
264
    interval:   datetime.timedelta(); How often to start a new checker
454
265
    last_approval_request: datetime.datetime(); (UTC) or None
455
266
    last_checked_ok: datetime.datetime(); (UTC) or None
456
 
    last_checker_status: integer between 0 and 255 reflecting exit
457
 
                         status of last checker. -1 reflects crashed
458
 
                         checker, -2 means no checker completed yet.
459
 
    last_enabled: datetime.datetime(); (UTC) or None
 
267
    last_enabled: datetime.datetime(); (UTC)
460
268
    name:       string; from the config file, used in log messages and
461
269
                        D-Bus identifiers
462
270
    secret:     bytestring; sent verbatim (over TLS) to client
463
271
    timeout:    datetime.timedelta(); How long from last_checked_ok
464
272
                                      until this client is disabled
465
 
    extended_timeout:   extra long timeout when secret has been sent
466
273
    runtime_expansions: Allowed attributes for runtime expansion.
467
 
    expires:    datetime.datetime(); time (UTC) when a client will be
468
 
                disabled, or None
469
 
    server_settings: The server_settings dict from main()
470
274
    """
471
275
    
472
276
    runtime_expansions = ("approval_delay", "approval_duration",
473
 
                          "created", "enabled", "expires",
474
 
                          "fingerprint", "host", "interval",
475
 
                          "last_approval_request", "last_checked_ok",
 
277
                          "created", "enabled", "fingerprint",
 
278
                          "host", "interval", "last_checked_ok",
476
279
                          "last_enabled", "name", "timeout")
477
 
    client_defaults = {
478
 
        "timeout": "PT5M",
479
 
        "extended_timeout": "PT15M",
480
 
        "interval": "PT2M",
481
 
        "checker": "fping -q -- %%(host)s",
482
 
        "host": "",
483
 
        "approval_delay": "PT0S",
484
 
        "approval_duration": "PT1S",
485
 
        "approved_by_default": "True",
486
 
        "enabled": "True",
487
 
    }
488
280
    
489
281
    @staticmethod
490
 
    def config_parser(config):
491
 
        """Construct a new dict of client settings of this form:
492
 
        { client_name: {setting_name: value, ...}, ...}
493
 
        with exceptions for any special settings as defined above.
494
 
        NOTE: Must be a pure function. Must return the same result
495
 
        value given the same arguments.
496
 
        """
497
 
        settings = {}
498
 
        for client_name in config.sections():
499
 
            section = dict(config.items(client_name))
500
 
            client = settings[client_name] = {}
501
 
            
502
 
            client["host"] = section["host"]
503
 
            # Reformat values from string types to Python types
504
 
            client["approved_by_default"] = config.getboolean(
505
 
                client_name, "approved_by_default")
506
 
            client["enabled"] = config.getboolean(client_name,
507
 
                                                  "enabled")
508
 
            
509
 
            # Uppercase and remove spaces from fingerprint for later
510
 
            # comparison purposes with return value from the
511
 
            # fingerprint() function
512
 
            client["fingerprint"] = (section["fingerprint"].upper()
513
 
                                     .replace(" ", ""))
514
 
            if "secret" in section:
515
 
                client["secret"] = section["secret"].decode("base64")
516
 
            elif "secfile" in section:
517
 
                with open(os.path.expanduser(os.path.expandvars
518
 
                                             (section["secfile"])),
519
 
                          "rb") as secfile:
520
 
                    client["secret"] = secfile.read()
521
 
            else:
522
 
                raise TypeError("No secret or secfile for section {}"
523
 
                                .format(section))
524
 
            client["timeout"] = string_to_delta(section["timeout"])
525
 
            client["extended_timeout"] = string_to_delta(
526
 
                section["extended_timeout"])
527
 
            client["interval"] = string_to_delta(section["interval"])
528
 
            client["approval_delay"] = string_to_delta(
529
 
                section["approval_delay"])
530
 
            client["approval_duration"] = string_to_delta(
531
 
                section["approval_duration"])
532
 
            client["checker_command"] = section["checker"]
533
 
            client["last_approval_request"] = None
534
 
            client["last_checked_ok"] = None
535
 
            client["last_checker_status"] = -2
536
 
        
537
 
        return settings
538
 
    
539
 
    def __init__(self, settings, name = None, server_settings=None):
 
282
    def _timedelta_to_milliseconds(td):
 
283
        "Convert a datetime.timedelta() to milliseconds"
 
284
        return ((td.days * 24 * 60 * 60 * 1000)
 
285
                + (td.seconds * 1000)
 
286
                + (td.microseconds // 1000))
 
287
    
 
288
    def timeout_milliseconds(self):
 
289
        "Return the 'timeout' attribute in milliseconds"
 
290
        return self._timedelta_to_milliseconds(self.timeout)
 
291
    
 
292
    def interval_milliseconds(self):
 
293
        "Return the 'interval' attribute in milliseconds"
 
294
        return self._timedelta_to_milliseconds(self.interval)
 
295
 
 
296
    def approval_delay_milliseconds(self):
 
297
        return self._timedelta_to_milliseconds(self.approval_delay)
 
298
    
 
299
    def __init__(self, name = None, disable_hook=None, config=None):
 
300
        """Note: the 'checker' key in 'config' sets the
 
301
        'checker_command' attribute and *not* the 'checker'
 
302
        attribute."""
540
303
        self.name = name
541
 
        if server_settings is None:
542
 
            server_settings = {}
543
 
        self.server_settings = server_settings
544
 
        # adding all client settings
545
 
        for setting, value in settings.items():
546
 
            setattr(self, setting, value)
547
 
        
548
 
        if self.enabled:
549
 
            if not hasattr(self, "last_enabled"):
550
 
                self.last_enabled = datetime.datetime.utcnow()
551
 
            if not hasattr(self, "expires"):
552
 
                self.expires = (datetime.datetime.utcnow()
553
 
                                + self.timeout)
554
 
        else:
555
 
            self.last_enabled = None
556
 
            self.expires = None
557
 
        
 
304
        if config is None:
 
305
            config = {}
558
306
        logger.debug("Creating client %r", self.name)
 
307
        # Uppercase and remove spaces from fingerprint for later
 
308
        # comparison purposes with return value from the fingerprint()
 
309
        # function
 
310
        self.fingerprint = (config["fingerprint"].upper()
 
311
                            .replace(" ", ""))
559
312
        logger.debug("  Fingerprint: %s", self.fingerprint)
560
 
        self.created = settings.get("created",
561
 
                                    datetime.datetime.utcnow())
562
 
        
563
 
        # attributes specific for this server instance
 
313
        if "secret" in config:
 
314
            self.secret = config["secret"].decode("base64")
 
315
        elif "secfile" in config:
 
316
            with open(os.path.expanduser(os.path.expandvars
 
317
                                         (config["secfile"])),
 
318
                      "rb") as secfile:
 
319
                self.secret = secfile.read()
 
320
        else:
 
321
            raise TypeError("No secret or secfile for client %s"
 
322
                            % self.name)
 
323
        self.host = config.get("host", "")
 
324
        self.created = datetime.datetime.utcnow()
 
325
        self.enabled = False
 
326
        self.last_approval_request = None
 
327
        self.last_enabled = None
 
328
        self.last_checked_ok = None
 
329
        self.timeout = string_to_delta(config["timeout"])
 
330
        self.interval = string_to_delta(config["interval"])
 
331
        self.disable_hook = disable_hook
564
332
        self.checker = None
565
333
        self.checker_initiator_tag = None
566
334
        self.disable_initiator_tag = None
567
335
        self.checker_callback_tag = None
 
336
        self.checker_command = config["checker"]
568
337
        self.current_checker_command = None
569
 
        self.approved = None
 
338
        self.last_connect = None
 
339
        self._approved = None
 
340
        self.approved_by_default = config.get("approved_by_default",
 
341
                                              True)
570
342
        self.approvals_pending = 0
571
 
        self.changedstate = multiprocessing_manager.Condition(
572
 
            multiprocessing_manager.Lock())
573
 
        self.client_structure = [attr
574
 
                                 for attr in self.__dict__.iterkeys()
575
 
                                 if not attr.startswith("_")]
576
 
        self.client_structure.append("client_structure")
577
 
        
578
 
        for name, t in inspect.getmembers(
579
 
                type(self), lambda obj: isinstance(obj, property)):
580
 
            if not name.startswith("_"):
581
 
                self.client_structure.append(name)
 
343
        self.approval_delay = string_to_delta(
 
344
            config["approval_delay"])
 
345
        self.approval_duration = string_to_delta(
 
346
            config["approval_duration"])
 
347
        self.changedstate = multiprocessing_manager.Condition(multiprocessing_manager.Lock())
582
348
    
583
 
    # Send notice to process children that client state has changed
584
349
    def send_changedstate(self):
585
 
        with self.changedstate:
586
 
            self.changedstate.notify_all()
587
 
    
 
350
        self.changedstate.acquire()
 
351
        self.changedstate.notify_all()
 
352
        self.changedstate.release()
 
353
        
588
354
    def enable(self):
589
355
        """Start this client's checker and timeout hooks"""
590
356
        if getattr(self, "enabled", False):
591
357
            # Already enabled
592
358
            return
593
 
        self.expires = datetime.datetime.utcnow() + self.timeout
594
 
        self.enabled = True
 
359
        self.send_changedstate()
595
360
        self.last_enabled = datetime.datetime.utcnow()
596
 
        self.init_checker()
597
 
        self.send_changedstate()
 
361
        # Schedule a new checker to be started an 'interval' from now,
 
362
        # and every interval from then on.
 
363
        self.checker_initiator_tag = (gobject.timeout_add
 
364
                                      (self.interval_milliseconds(),
 
365
                                       self.start_checker))
 
366
        # Schedule a disable() when 'timeout' has passed
 
367
        self.disable_initiator_tag = (gobject.timeout_add
 
368
                                   (self.timeout_milliseconds(),
 
369
                                    self.disable))
 
370
        self.enabled = True
 
371
        # Also start a new checker *right now*.
 
372
        self.start_checker()
598
373
    
599
374
    def disable(self, quiet=True):
600
375
        """Disable this client."""
601
376
        if not getattr(self, "enabled", False):
602
377
            return False
603
378
        if not quiet:
 
379
            self.send_changedstate()
 
380
        if not quiet:
604
381
            logger.info("Disabling client %s", self.name)
605
 
        if getattr(self, "disable_initiator_tag", None) is not None:
 
382
        if getattr(self, "disable_initiator_tag", False):
606
383
            gobject.source_remove(self.disable_initiator_tag)
607
384
            self.disable_initiator_tag = None
608
 
        self.expires = None
609
 
        if getattr(self, "checker_initiator_tag", None) is not None:
 
385
        if getattr(self, "checker_initiator_tag", False):
610
386
            gobject.source_remove(self.checker_initiator_tag)
611
387
            self.checker_initiator_tag = None
612
388
        self.stop_checker()
 
389
        if self.disable_hook:
 
390
            self.disable_hook(self)
613
391
        self.enabled = False
614
 
        if not quiet:
615
 
            self.send_changedstate()
616
392
        # Do not run this again if called by a gobject.timeout_add
617
393
        return False
618
394
    
619
395
    def __del__(self):
 
396
        self.disable_hook = None
620
397
        self.disable()
621
398
    
622
 
    def init_checker(self):
623
 
        # Schedule a new checker to be started an 'interval' from now,
624
 
        # and every interval from then on.
625
 
        if self.checker_initiator_tag is not None:
626
 
            gobject.source_remove(self.checker_initiator_tag)
627
 
        self.checker_initiator_tag = gobject.timeout_add(
628
 
            int(self.interval.total_seconds() * 1000),
629
 
            self.start_checker)
630
 
        # Schedule a disable() when 'timeout' has passed
631
 
        if self.disable_initiator_tag is not None:
632
 
            gobject.source_remove(self.disable_initiator_tag)
633
 
        self.disable_initiator_tag = gobject.timeout_add(
634
 
            int(self.timeout.total_seconds() * 1000), self.disable)
635
 
        # Also start a new checker *right now*.
636
 
        self.start_checker()
637
 
    
638
399
    def checker_callback(self, pid, condition, command):
639
400
        """The checker has completed, so take appropriate actions."""
640
401
        self.checker_callback_tag = None
641
402
        self.checker = None
642
403
        if os.WIFEXITED(condition):
643
 
            self.last_checker_status = os.WEXITSTATUS(condition)
644
 
            if self.last_checker_status == 0:
 
404
            exitstatus = os.WEXITSTATUS(condition)
 
405
            if exitstatus == 0:
645
406
                logger.info("Checker for %(name)s succeeded",
646
407
                            vars(self))
647
408
                self.checked_ok()
648
409
            else:
649
 
                logger.info("Checker for %(name)s failed", vars(self))
 
410
                logger.info("Checker for %(name)s failed",
 
411
                            vars(self))
650
412
        else:
651
 
            self.last_checker_status = -1
652
413
            logger.warning("Checker for %(name)s crashed?",
653
414
                           vars(self))
654
415
    
655
416
    def checked_ok(self):
656
 
        """Assert that the client has been seen, alive and well."""
 
417
        """Bump up the timeout for this client.
 
418
        
 
419
        This should only be called when the client has been seen,
 
420
        alive and well.
 
421
        """
657
422
        self.last_checked_ok = datetime.datetime.utcnow()
658
 
        self.last_checker_status = 0
659
 
        self.bump_timeout()
660
 
    
661
 
    def bump_timeout(self, timeout=None):
662
 
        """Bump up the timeout for this client."""
663
 
        if timeout is None:
664
 
            timeout = self.timeout
665
 
        if self.disable_initiator_tag is not None:
666
 
            gobject.source_remove(self.disable_initiator_tag)
667
 
            self.disable_initiator_tag = None
668
 
        if getattr(self, "enabled", False):
669
 
            self.disable_initiator_tag = gobject.timeout_add(
670
 
                int(timeout.total_seconds() * 1000), self.disable)
671
 
            self.expires = datetime.datetime.utcnow() + timeout
 
423
        gobject.source_remove(self.disable_initiator_tag)
 
424
        self.disable_initiator_tag = (gobject.timeout_add
 
425
                                      (self.timeout_milliseconds(),
 
426
                                       self.disable))
672
427
    
673
428
    def need_approval(self):
674
429
        self.last_approval_request = datetime.datetime.utcnow()
679
434
        If a checker already exists, leave it running and do
680
435
        nothing."""
681
436
        # The reason for not killing a running checker is that if we
682
 
        # did that, and if a checker (for some reason) started running
683
 
        # slowly and taking more than 'interval' time, then the client
684
 
        # would inevitably timeout, since no checker would get a
685
 
        # chance to run to completion.  If we instead leave running
 
437
        # did that, then if a checker (for some reason) started
 
438
        # running slowly and taking more than 'interval' time, the
 
439
        # client would inevitably timeout, since no checker would get
 
440
        # a chance to run to completion.  If we instead leave running
686
441
        # checkers alone, the checker would have to take more time
687
442
        # than 'timeout' for the client to be disabled, which is as it
688
443
        # should be.
690
445
        # If a checker exists, make sure it is not a zombie
691
446
        try:
692
447
            pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
693
 
        except AttributeError:
694
 
            pass
695
 
        except OSError as error:
696
 
            if error.errno != errno.ECHILD:
697
 
                raise
 
448
        except (AttributeError, OSError), error:
 
449
            if (isinstance(error, OSError)
 
450
                and error.errno != errno.ECHILD):
 
451
                raise error
698
452
        else:
699
453
            if pid:
700
454
                logger.warning("Checker was a zombie")
703
457
                                      self.current_checker_command)
704
458
        # Start a new checker if needed
705
459
        if self.checker is None:
706
 
            # Escape attributes for the shell
707
 
            escaped_attrs = {
708
 
                attr: re.escape(str(getattr(self, attr)))
709
 
                for attr in self.runtime_expansions }
710
460
            try:
711
 
                command = self.checker_command % escaped_attrs
712
 
            except TypeError as error:
713
 
                logger.error('Could not format string "%s"',
714
 
                             self.checker_command,
715
 
                             exc_info=error)
716
 
                return True     # Try again later
 
461
                # In case checker_command has exactly one % operator
 
462
                command = self.checker_command % self.host
 
463
            except TypeError:
 
464
                # Escape attributes for the shell
 
465
                escaped_attrs = dict(
 
466
                    (attr,
 
467
                     re.escape(unicode(str(getattr(self, attr, "")),
 
468
                                       errors=
 
469
                                       'replace')))
 
470
                    for attr in
 
471
                    self.runtime_expansions)
 
472
 
 
473
                try:
 
474
                    command = self.checker_command % escaped_attrs
 
475
                except TypeError, error:
 
476
                    logger.error('Could not format string "%s":'
 
477
                                 ' %s', self.checker_command, error)
 
478
                    return True # Try again later
717
479
            self.current_checker_command = command
718
480
            try:
719
 
                logger.info("Starting checker %r for %s", command,
720
 
                            self.name)
 
481
                logger.info("Starting checker %r for %s",
 
482
                            command, self.name)
721
483
                # We don't need to redirect stdout and stderr, since
722
484
                # in normal mode, that is already done by daemon(),
723
485
                # and in debug mode we don't want to.  (Stdin is
724
486
                # always replaced by /dev/null.)
725
 
                # The exception is when not debugging but nevertheless
726
 
                # running in the foreground; use the previously
727
 
                # created wnull.
728
 
                popen_args = {}
729
 
                if (not self.server_settings["debug"]
730
 
                    and self.server_settings["foreground"]):
731
 
                    popen_args.update({"stdout": wnull,
732
 
                                       "stderr": wnull })
733
487
                self.checker = subprocess.Popen(command,
734
488
                                                close_fds=True,
735
 
                                                shell=True,
736
 
                                                cwd="/",
737
 
                                                **popen_args)
738
 
            except OSError as error:
739
 
                logger.error("Failed to start subprocess",
740
 
                             exc_info=error)
741
 
                return True
742
 
            self.checker_callback_tag = gobject.child_watch_add(
743
 
                self.checker.pid, self.checker_callback, data=command)
744
 
            # The checker may have completed before the gobject
745
 
            # watch was added.  Check for this.
746
 
            try:
 
489
                                                shell=True, cwd="/")
 
490
                self.checker_callback_tag = (gobject.child_watch_add
 
491
                                             (self.checker.pid,
 
492
                                              self.checker_callback,
 
493
                                              data=command))
 
494
                # The checker may have completed before the gobject
 
495
                # watch was added.  Check for this.
747
496
                pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
748
 
            except OSError as error:
749
 
                if error.errno == errno.ECHILD:
750
 
                    # This should never happen
751
 
                    logger.error("Child process vanished",
752
 
                                 exc_info=error)
753
 
                    return True
754
 
                raise
755
 
            if pid:
756
 
                gobject.source_remove(self.checker_callback_tag)
757
 
                self.checker_callback(pid, status, command)
 
497
                if pid:
 
498
                    gobject.source_remove(self.checker_callback_tag)
 
499
                    self.checker_callback(pid, status, command)
 
500
            except OSError, error:
 
501
                logger.error("Failed to start subprocess: %s",
 
502
                             error)
758
503
        # Re-run this periodically if run by gobject.timeout_add
759
504
        return True
760
505
    
767
512
            return
768
513
        logger.debug("Stopping checker for %(name)s", vars(self))
769
514
        try:
770
 
            self.checker.terminate()
 
515
            os.kill(self.checker.pid, signal.SIGTERM)
771
516
            #time.sleep(0.5)
772
517
            #if self.checker.poll() is None:
773
 
            #    self.checker.kill()
774
 
        except OSError as error:
 
518
            #    os.kill(self.checker.pid, signal.SIGKILL)
 
519
        except OSError, error:
775
520
            if error.errno != errno.ESRCH: # No such process
776
521
                raise
777
522
        self.checker = None
778
523
 
779
 
 
780
 
def dbus_service_property(dbus_interface,
781
 
                          signature="v",
782
 
                          access="readwrite",
783
 
                          byte_arrays=False):
 
524
def dbus_service_property(dbus_interface, signature="v",
 
525
                          access="readwrite", byte_arrays=False):
784
526
    """Decorators for marking methods of a DBusObjectWithProperties to
785
527
    become properties on the D-Bus.
786
528
    
795
537
    # "Set" method, so we fail early here:
796
538
    if byte_arrays and signature != "ay":
797
539
        raise ValueError("Byte arrays not supported for non-'ay'"
798
 
                         " signature {!r}".format(signature))
799
 
    
 
540
                         " signature %r" % signature)
800
541
    def decorator(func):
801
542
        func._dbus_is_property = True
802
543
        func._dbus_interface = dbus_interface
807
548
            func._dbus_name = func._dbus_name[:-14]
808
549
        func._dbus_get_args_options = {'byte_arrays': byte_arrays }
809
550
        return func
810
 
    
811
 
    return decorator
812
 
 
813
 
 
814
 
def dbus_interface_annotations(dbus_interface):
815
 
    """Decorator for marking functions returning interface annotations
816
 
    
817
 
    Usage:
818
 
    
819
 
    @dbus_interface_annotations("org.example.Interface")
820
 
    def _foo(self):  # Function name does not matter
821
 
        return {"org.freedesktop.DBus.Deprecated": "true",
822
 
                "org.freedesktop.DBus.Property.EmitsChangedSignal":
823
 
                    "false"}
824
 
    """
825
 
    
826
 
    def decorator(func):
827
 
        func._dbus_is_interface = True
828
 
        func._dbus_interface = dbus_interface
829
 
        func._dbus_name = dbus_interface
830
 
        return func
831
 
    
832
 
    return decorator
833
 
 
834
 
 
835
 
def dbus_annotations(annotations):
836
 
    """Decorator to annotate D-Bus methods, signals or properties
837
 
    Usage:
838
 
    
839
 
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
840
 
                       "org.freedesktop.DBus.Property."
841
 
                       "EmitsChangedSignal": "false"})
842
 
    @dbus_service_property("org.example.Interface", signature="b",
843
 
                           access="r")
844
 
    def Property_dbus_property(self):
845
 
        return dbus.Boolean(False)
846
 
    """
847
 
    
848
 
    def decorator(func):
849
 
        func._dbus_annotations = annotations
850
 
        return func
851
 
    
852
551
    return decorator
853
552
 
854
553
 
855
554
class DBusPropertyException(dbus.exceptions.DBusException):
856
555
    """A base class for D-Bus property-related exceptions
857
556
    """
858
 
    pass
 
557
    def __unicode__(self):
 
558
        return unicode(str(self))
859
559
 
860
560
 
861
561
class DBusPropertyAccessException(DBusPropertyException):
872
572
 
873
573
class DBusObjectWithProperties(dbus.service.Object):
874
574
    """A D-Bus object with properties.
875
 
    
 
575
 
876
576
    Classes inheriting from this can use the dbus_service_property
877
577
    decorator to expose methods as D-Bus properties.  It exposes the
878
578
    standard Get(), Set(), and GetAll() methods on the D-Bus.
879
579
    """
880
580
    
881
581
    @staticmethod
882
 
    def _is_dbus_thing(thing):
883
 
        """Returns a function testing if an attribute is a D-Bus thing
884
 
        
885
 
        If called like _is_dbus_thing("method") it returns a function
886
 
        suitable for use as predicate to inspect.getmembers().
887
 
        """
888
 
        return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
889
 
                                   False)
 
582
    def _is_dbus_property(obj):
 
583
        return getattr(obj, "_dbus_is_property", False)
890
584
    
891
 
    def _get_all_dbus_things(self, thing):
 
585
    def _get_all_dbus_properties(self):
892
586
        """Returns a generator of (name, attribute) pairs
893
587
        """
894
 
        return ((getattr(athing.__get__(self), "_dbus_name", name),
895
 
                 athing.__get__(self))
896
 
                for cls in self.__class__.__mro__
897
 
                for name, athing in
898
 
                inspect.getmembers(cls, self._is_dbus_thing(thing)))
 
588
        return ((prop._dbus_name, prop)
 
589
                for name, prop in
 
590
                inspect.getmembers(self, self._is_dbus_property))
899
591
    
900
592
    def _get_dbus_property(self, interface_name, property_name):
901
593
        """Returns a bound method if one exists which is a D-Bus
902
594
        property with the specified name and interface.
903
595
        """
904
 
        for cls in self.__class__.__mro__:
905
 
            for name, value in inspect.getmembers(
906
 
                    cls, self._is_dbus_thing("property")):
907
 
                if (value._dbus_name == property_name
908
 
                    and value._dbus_interface == interface_name):
909
 
                    return value.__get__(self)
910
 
        
 
596
        for name in (property_name,
 
597
                     property_name + "_dbus_property"):
 
598
            prop = getattr(self, name, None)
 
599
            if (prop is None
 
600
                or not self._is_dbus_property(prop)
 
601
                or prop._dbus_name != property_name
 
602
                or (interface_name and prop._dbus_interface
 
603
                    and interface_name != prop._dbus_interface)):
 
604
                continue
 
605
            return prop
911
606
        # No such property
912
 
        raise DBusPropertyNotFound("{}:{}.{}".format(
913
 
            self.dbus_object_path, interface_name, property_name))
 
607
        raise DBusPropertyNotFound(self.dbus_object_path + ":"
 
608
                                   + interface_name + "."
 
609
                                   + property_name)
914
610
    
915
 
    @dbus.service.method(dbus.PROPERTIES_IFACE,
916
 
                         in_signature="ss",
 
611
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
917
612
                         out_signature="v")
918
613
    def Get(self, interface_name, property_name):
919
614
        """Standard D-Bus property Get() method, see D-Bus standard.
937
632
            # The byte_arrays option is not supported yet on
938
633
            # signatures other than "ay".
939
634
            if prop._dbus_signature != "ay":
940
 
                raise ValueError("Byte arrays not supported for non-"
941
 
                                 "'ay' signature {!r}"
942
 
                                 .format(prop._dbus_signature))
943
 
            value = dbus.ByteArray(b''.join(chr(byte)
944
 
                                            for byte in value))
 
635
                raise ValueError
 
636
            value = dbus.ByteArray(''.join(unichr(byte)
 
637
                                           for byte in value))
945
638
        prop(value)
946
639
    
947
 
    @dbus.service.method(dbus.PROPERTIES_IFACE,
948
 
                         in_signature="s",
 
640
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
949
641
                         out_signature="a{sv}")
950
642
    def GetAll(self, interface_name):
951
643
        """Standard D-Bus property GetAll() method, see D-Bus
952
644
        standard.
953
 
        
 
645
 
954
646
        Note: Will not include properties with access="write".
955
647
        """
956
 
        properties = {}
957
 
        for name, prop in self._get_all_dbus_things("property"):
 
648
        all = {}
 
649
        for name, prop in self._get_all_dbus_properties():
958
650
            if (interface_name
959
651
                and interface_name != prop._dbus_interface):
960
652
                # Interface non-empty but did not match
964
656
                continue
965
657
            value = prop()
966
658
            if not hasattr(value, "variant_level"):
967
 
                properties[name] = value
 
659
                all[name] = value
968
660
                continue
969
 
            properties[name] = type(value)(
970
 
                value, variant_level = value.variant_level + 1)
971
 
        return dbus.Dictionary(properties, signature="sv")
972
 
    
973
 
    @dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
974
 
    def PropertiesChanged(self, interface_name, changed_properties,
975
 
                          invalidated_properties):
976
 
        """Standard D-Bus PropertiesChanged() signal, see D-Bus
977
 
        standard.
978
 
        """
979
 
        pass
 
661
            all[name] = type(value)(value, variant_level=
 
662
                                    value.variant_level+1)
 
663
        return dbus.Dictionary(all, signature="sv")
980
664
    
981
665
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
982
666
                         out_signature="s",
983
667
                         path_keyword='object_path',
984
668
                         connection_keyword='connection')
985
669
    def Introspect(self, object_path, connection):
986
 
        """Overloading of standard D-Bus method.
987
 
        
988
 
        Inserts property tags and interface annotation tags.
 
670
        """Standard D-Bus method, overloaded to insert property tags.
989
671
        """
990
672
        xmlstring = dbus.service.Object.Introspect(self, object_path,
991
673
                                                   connection)
992
674
        try:
993
675
            document = xml.dom.minidom.parseString(xmlstring)
994
 
            
995
676
            def make_tag(document, name, prop):
996
677
                e = document.createElement("property")
997
678
                e.setAttribute("name", name)
998
679
                e.setAttribute("type", prop._dbus_signature)
999
680
                e.setAttribute("access", prop._dbus_access)
1000
681
                return e
1001
 
            
1002
682
            for if_tag in document.getElementsByTagName("interface"):
1003
 
                # Add property tags
1004
683
                for tag in (make_tag(document, name, prop)
1005
684
                            for name, prop
1006
 
                            in self._get_all_dbus_things("property")
 
685
                            in self._get_all_dbus_properties()
1007
686
                            if prop._dbus_interface
1008
687
                            == if_tag.getAttribute("name")):
1009
688
                    if_tag.appendChild(tag)
1010
 
                # Add annotation tags
1011
 
                for typ in ("method", "signal", "property"):
1012
 
                    for tag in if_tag.getElementsByTagName(typ):
1013
 
                        annots = dict()
1014
 
                        for name, prop in (self.
1015
 
                                           _get_all_dbus_things(typ)):
1016
 
                            if (name == tag.getAttribute("name")
1017
 
                                and prop._dbus_interface
1018
 
                                == if_tag.getAttribute("name")):
1019
 
                                annots.update(getattr(
1020
 
                                    prop, "_dbus_annotations", {}))
1021
 
                        for name, value in annots.items():
1022
 
                            ann_tag = document.createElement(
1023
 
                                "annotation")
1024
 
                            ann_tag.setAttribute("name", name)
1025
 
                            ann_tag.setAttribute("value", value)
1026
 
                            tag.appendChild(ann_tag)
1027
 
                # Add interface annotation tags
1028
 
                for annotation, value in dict(
1029
 
                    itertools.chain.from_iterable(
1030
 
                        annotations().items()
1031
 
                        for name, annotations
1032
 
                        in self._get_all_dbus_things("interface")
1033
 
                        if name == if_tag.getAttribute("name")
1034
 
                        )).items():
1035
 
                    ann_tag = document.createElement("annotation")
1036
 
                    ann_tag.setAttribute("name", annotation)
1037
 
                    ann_tag.setAttribute("value", value)
1038
 
                    if_tag.appendChild(ann_tag)
1039
689
                # Add the names to the return values for the
1040
690
                # "org.freedesktop.DBus.Properties" methods
1041
691
                if (if_tag.getAttribute("name")
1054
704
            xmlstring = document.toxml("utf-8")
1055
705
            document.unlink()
1056
706
        except (AttributeError, xml.dom.DOMException,
1057
 
                xml.parsers.expat.ExpatError) as error:
 
707
                xml.parsers.expat.ExpatError), error:
1058
708
            logger.error("Failed to override Introspection method",
1059
 
                         exc_info=error)
 
709
                         error)
1060
710
        return xmlstring
1061
711
 
1062
712
 
1063
 
def datetime_to_dbus(dt, variant_level=0):
1064
 
    """Convert a UTC datetime.datetime() to a D-Bus type."""
1065
 
    if dt is None:
1066
 
        return dbus.String("", variant_level = variant_level)
1067
 
    return dbus.String(dt.isoformat(), variant_level=variant_level)
1068
 
 
1069
 
 
1070
 
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1071
 
    """A class decorator; applied to a subclass of
1072
 
    dbus.service.Object, it will add alternate D-Bus attributes with
1073
 
    interface names according to the "alt_interface_names" mapping.
1074
 
    Usage:
1075
 
    
1076
 
    @alternate_dbus_interfaces({"org.example.Interface":
1077
 
                                    "net.example.AlternateInterface"})
1078
 
    class SampleDBusObject(dbus.service.Object):
1079
 
        @dbus.service.method("org.example.Interface")
1080
 
        def SampleDBusMethod():
1081
 
            pass
1082
 
    
1083
 
    The above "SampleDBusMethod" on "SampleDBusObject" will be
1084
 
    reachable via two interfaces: "org.example.Interface" and
1085
 
    "net.example.AlternateInterface", the latter of which will have
1086
 
    its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1087
 
    "true", unless "deprecate" is passed with a False value.
1088
 
    
1089
 
    This works for methods and signals, and also for D-Bus properties
1090
 
    (from DBusObjectWithProperties) and interfaces (from the
1091
 
    dbus_interface_annotations decorator).
1092
 
    """
1093
 
    
1094
 
    def wrapper(cls):
1095
 
        for orig_interface_name, alt_interface_name in (
1096
 
                alt_interface_names.items()):
1097
 
            attr = {}
1098
 
            interface_names = set()
1099
 
            # Go though all attributes of the class
1100
 
            for attrname, attribute in inspect.getmembers(cls):
1101
 
                # Ignore non-D-Bus attributes, and D-Bus attributes
1102
 
                # with the wrong interface name
1103
 
                if (not hasattr(attribute, "_dbus_interface")
1104
 
                    or not attribute._dbus_interface.startswith(
1105
 
                        orig_interface_name)):
1106
 
                    continue
1107
 
                # Create an alternate D-Bus interface name based on
1108
 
                # the current name
1109
 
                alt_interface = attribute._dbus_interface.replace(
1110
 
                    orig_interface_name, alt_interface_name)
1111
 
                interface_names.add(alt_interface)
1112
 
                # Is this a D-Bus signal?
1113
 
                if getattr(attribute, "_dbus_is_signal", False):
1114
 
                    if sys.version == 2:
1115
 
                        # Extract the original non-method undecorated
1116
 
                        # function by black magic
1117
 
                        nonmethod_func = (dict(
1118
 
                            zip(attribute.func_code.co_freevars,
1119
 
                                attribute.__closure__))
1120
 
                                          ["func"].cell_contents)
1121
 
                    else:
1122
 
                        nonmethod_func = attribute
1123
 
                    # Create a new, but exactly alike, function
1124
 
                    # object, and decorate it to be a new D-Bus signal
1125
 
                    # with the alternate D-Bus interface name
1126
 
                    if sys.version == 2:
1127
 
                        new_function = types.FunctionType(
1128
 
                            nonmethod_func.func_code,
1129
 
                            nonmethod_func.func_globals,
1130
 
                            nonmethod_func.func_name,
1131
 
                            nonmethod_func.func_defaults,
1132
 
                            nonmethod_func.func_closure)
1133
 
                    else:
1134
 
                        new_function = types.FunctionType(
1135
 
                            nonmethod_func.__code__,
1136
 
                            nonmethod_func.__globals__,
1137
 
                            nonmethod_func.__name__,
1138
 
                            nonmethod_func.__defaults__,
1139
 
                            nonmethod_func.__closure__)
1140
 
                    new_function = (dbus.service.signal(
1141
 
                        alt_interface,
1142
 
                        attribute._dbus_signature)(new_function))
1143
 
                    # Copy annotations, if any
1144
 
                    try:
1145
 
                        new_function._dbus_annotations = dict(
1146
 
                            attribute._dbus_annotations)
1147
 
                    except AttributeError:
1148
 
                        pass
1149
 
                    # Define a creator of a function to call both the
1150
 
                    # original and alternate functions, so both the
1151
 
                    # original and alternate signals gets sent when
1152
 
                    # the function is called
1153
 
                    def fixscope(func1, func2):
1154
 
                        """This function is a scope container to pass
1155
 
                        func1 and func2 to the "call_both" function
1156
 
                        outside of its arguments"""
1157
 
                        
1158
 
                        def call_both(*args, **kwargs):
1159
 
                            """This function will emit two D-Bus
1160
 
                            signals by calling func1 and func2"""
1161
 
                            func1(*args, **kwargs)
1162
 
                            func2(*args, **kwargs)
1163
 
                        
1164
 
                        return call_both
1165
 
                    # Create the "call_both" function and add it to
1166
 
                    # the class
1167
 
                    attr[attrname] = fixscope(attribute, new_function)
1168
 
                # Is this a D-Bus method?
1169
 
                elif getattr(attribute, "_dbus_is_method", False):
1170
 
                    # Create a new, but exactly alike, function
1171
 
                    # object.  Decorate it to be a new D-Bus method
1172
 
                    # with the alternate D-Bus interface name.  Add it
1173
 
                    # to the class.
1174
 
                    attr[attrname] = (
1175
 
                        dbus.service.method(
1176
 
                            alt_interface,
1177
 
                            attribute._dbus_in_signature,
1178
 
                            attribute._dbus_out_signature)
1179
 
                        (types.FunctionType(attribute.func_code,
1180
 
                                            attribute.func_globals,
1181
 
                                            attribute.func_name,
1182
 
                                            attribute.func_defaults,
1183
 
                                            attribute.func_closure)))
1184
 
                    # Copy annotations, if any
1185
 
                    try:
1186
 
                        attr[attrname]._dbus_annotations = dict(
1187
 
                            attribute._dbus_annotations)
1188
 
                    except AttributeError:
1189
 
                        pass
1190
 
                # Is this a D-Bus property?
1191
 
                elif getattr(attribute, "_dbus_is_property", False):
1192
 
                    # Create a new, but exactly alike, function
1193
 
                    # object, and decorate it to be a new D-Bus
1194
 
                    # property with the alternate D-Bus interface
1195
 
                    # name.  Add it to the class.
1196
 
                    attr[attrname] = (dbus_service_property(
1197
 
                        alt_interface, attribute._dbus_signature,
1198
 
                        attribute._dbus_access,
1199
 
                        attribute._dbus_get_args_options
1200
 
                        ["byte_arrays"])
1201
 
                                      (types.FunctionType(
1202
 
                                          attribute.func_code,
1203
 
                                          attribute.func_globals,
1204
 
                                          attribute.func_name,
1205
 
                                          attribute.func_defaults,
1206
 
                                          attribute.func_closure)))
1207
 
                    # Copy annotations, if any
1208
 
                    try:
1209
 
                        attr[attrname]._dbus_annotations = dict(
1210
 
                            attribute._dbus_annotations)
1211
 
                    except AttributeError:
1212
 
                        pass
1213
 
                # Is this a D-Bus interface?
1214
 
                elif getattr(attribute, "_dbus_is_interface", False):
1215
 
                    # Create a new, but exactly alike, function
1216
 
                    # object.  Decorate it to be a new D-Bus interface
1217
 
                    # with the alternate D-Bus interface name.  Add it
1218
 
                    # to the class.
1219
 
                    attr[attrname] = (
1220
 
                        dbus_interface_annotations(alt_interface)
1221
 
                        (types.FunctionType(attribute.func_code,
1222
 
                                            attribute.func_globals,
1223
 
                                            attribute.func_name,
1224
 
                                            attribute.func_defaults,
1225
 
                                            attribute.func_closure)))
1226
 
            if deprecate:
1227
 
                # Deprecate all alternate interfaces
1228
 
                iname="_AlternateDBusNames_interface_annotation{}"
1229
 
                for interface_name in interface_names:
1230
 
                    
1231
 
                    @dbus_interface_annotations(interface_name)
1232
 
                    def func(self):
1233
 
                        return { "org.freedesktop.DBus.Deprecated":
1234
 
                                 "true" }
1235
 
                    # Find an unused name
1236
 
                    for aname in (iname.format(i)
1237
 
                                  for i in itertools.count()):
1238
 
                        if aname not in attr:
1239
 
                            attr[aname] = func
1240
 
                            break
1241
 
            if interface_names:
1242
 
                # Replace the class with a new subclass of it with
1243
 
                # methods, signals, etc. as created above.
1244
 
                cls = type(b"{}Alternate".format(cls.__name__),
1245
 
                           (cls, ), attr)
1246
 
        return cls
1247
 
    
1248
 
    return wrapper
1249
 
 
1250
 
 
1251
 
@alternate_dbus_interfaces({"se.recompile.Mandos":
1252
 
                            "se.bsnet.fukt.Mandos"})
1253
713
class ClientDBus(Client, DBusObjectWithProperties):
1254
714
    """A Client class using D-Bus
1255
715
    
1259
719
    """
1260
720
    
1261
721
    runtime_expansions = (Client.runtime_expansions
1262
 
                          + ("dbus_object_path", ))
1263
 
    
1264
 
    _interface = "se.recompile.Mandos.Client"
 
722
                          + ("dbus_object_path",))
1265
723
    
1266
724
    # dbus.service.Object doesn't use super(), so we can't either.
1267
725
    
1268
726
    def __init__(self, bus = None, *args, **kwargs):
 
727
        self._approvals_pending = 0
1269
728
        self.bus = bus
1270
729
        Client.__init__(self, *args, **kwargs)
1271
730
        # Only now, when this client is initialized, can it show up on
1272
731
        # the D-Bus
1273
 
        client_object_name = str(self.name).translate(
 
732
        client_object_name = unicode(self.name).translate(
1274
733
            {ord("."): ord("_"),
1275
734
             ord("-"): ord("_")})
1276
 
        self.dbus_object_path = dbus.ObjectPath(
1277
 
            "/clients/" + client_object_name)
 
735
        self.dbus_object_path = (dbus.ObjectPath
 
736
                                 ("/clients/" + client_object_name))
1278
737
        DBusObjectWithProperties.__init__(self, self.bus,
1279
738
                                          self.dbus_object_path)
1280
 
    
1281
 
    def notifychangeproperty(transform_func, dbus_name,
1282
 
                             type_func=lambda x: x,
1283
 
                             variant_level=1,
1284
 
                             invalidate_only=False,
1285
 
                             _interface=_interface):
1286
 
        """ Modify a variable so that it's a property which announces
1287
 
        its changes to DBus.
1288
 
        
1289
 
        transform_fun: Function that takes a value and a variant_level
1290
 
                       and transforms it to a D-Bus type.
1291
 
        dbus_name: D-Bus name of the variable
1292
 
        type_func: Function that transform the value before sending it
1293
 
                   to the D-Bus.  Default: no transform
1294
 
        variant_level: D-Bus variant level.  Default: 1
1295
 
        """
1296
 
        attrname = "_{}".format(dbus_name)
1297
 
        
1298
 
        def setter(self, value):
1299
 
            if hasattr(self, "dbus_object_path"):
1300
 
                if (not hasattr(self, attrname) or
1301
 
                    type_func(getattr(self, attrname, None))
1302
 
                    != type_func(value)):
1303
 
                    if invalidate_only:
1304
 
                        self.PropertiesChanged(
1305
 
                            _interface, dbus.Dictionary(),
1306
 
                            dbus.Array((dbus_name, )))
1307
 
                    else:
1308
 
                        dbus_value = transform_func(
1309
 
                            type_func(value),
1310
 
                            variant_level = variant_level)
1311
 
                        self.PropertyChanged(dbus.String(dbus_name),
1312
 
                                             dbus_value)
1313
 
                        self.PropertiesChanged(
1314
 
                            _interface,
1315
 
                            dbus.Dictionary({ dbus.String(dbus_name):
1316
 
                                              dbus_value }),
1317
 
                            dbus.Array())
1318
 
            setattr(self, attrname, value)
1319
 
        
1320
 
        return property(lambda self: getattr(self, attrname), setter)
1321
 
    
1322
 
    expires = notifychangeproperty(datetime_to_dbus, "Expires")
1323
 
    approvals_pending = notifychangeproperty(dbus.Boolean,
1324
 
                                             "ApprovalPending",
1325
 
                                             type_func = bool)
1326
 
    enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1327
 
    last_enabled = notifychangeproperty(datetime_to_dbus,
1328
 
                                        "LastEnabled")
1329
 
    checker = notifychangeproperty(
1330
 
        dbus.Boolean, "CheckerRunning",
1331
 
        type_func = lambda checker: checker is not None)
1332
 
    last_checked_ok = notifychangeproperty(datetime_to_dbus,
1333
 
                                           "LastCheckedOK")
1334
 
    last_checker_status = notifychangeproperty(dbus.Int16,
1335
 
                                               "LastCheckerStatus")
1336
 
    last_approval_request = notifychangeproperty(
1337
 
        datetime_to_dbus, "LastApprovalRequest")
1338
 
    approved_by_default = notifychangeproperty(dbus.Boolean,
1339
 
                                               "ApprovedByDefault")
1340
 
    approval_delay = notifychangeproperty(
1341
 
        dbus.UInt64, "ApprovalDelay",
1342
 
        type_func = lambda td: td.total_seconds() * 1000)
1343
 
    approval_duration = notifychangeproperty(
1344
 
        dbus.UInt64, "ApprovalDuration",
1345
 
        type_func = lambda td: td.total_seconds() * 1000)
1346
 
    host = notifychangeproperty(dbus.String, "Host")
1347
 
    timeout = notifychangeproperty(
1348
 
        dbus.UInt64, "Timeout",
1349
 
        type_func = lambda td: td.total_seconds() * 1000)
1350
 
    extended_timeout = notifychangeproperty(
1351
 
        dbus.UInt64, "ExtendedTimeout",
1352
 
        type_func = lambda td: td.total_seconds() * 1000)
1353
 
    interval = notifychangeproperty(
1354
 
        dbus.UInt64, "Interval",
1355
 
        type_func = lambda td: td.total_seconds() * 1000)
1356
 
    checker_command = notifychangeproperty(dbus.String, "Checker")
1357
 
    secret = notifychangeproperty(dbus.ByteArray, "Secret",
1358
 
                                  invalidate_only=True)
1359
 
    
1360
 
    del notifychangeproperty
 
739
        
 
740
    def _get_approvals_pending(self):
 
741
        return self._approvals_pending
 
742
    def _set_approvals_pending(self, value):
 
743
        old_value = self._approvals_pending
 
744
        self._approvals_pending = value
 
745
        bval = bool(value)
 
746
        if (hasattr(self, "dbus_object_path")
 
747
            and bval is not bool(old_value)):
 
748
            dbus_bool = dbus.Boolean(bval, variant_level=1)
 
749
            self.PropertyChanged(dbus.String("ApprovalPending"),
 
750
                                 dbus_bool)
 
751
 
 
752
    approvals_pending = property(_get_approvals_pending,
 
753
                                 _set_approvals_pending)
 
754
    del _get_approvals_pending, _set_approvals_pending
 
755
    
 
756
    @staticmethod
 
757
    def _datetime_to_dbus(dt, variant_level=0):
 
758
        """Convert a UTC datetime.datetime() to a D-Bus type."""
 
759
        return dbus.String(dt.isoformat(),
 
760
                           variant_level=variant_level)
 
761
    
 
762
    def enable(self):
 
763
        oldstate = getattr(self, "enabled", False)
 
764
        r = Client.enable(self)
 
765
        if oldstate != self.enabled:
 
766
            # Emit D-Bus signals
 
767
            self.PropertyChanged(dbus.String("Enabled"),
 
768
                                 dbus.Boolean(True, variant_level=1))
 
769
            self.PropertyChanged(
 
770
                dbus.String("LastEnabled"),
 
771
                self._datetime_to_dbus(self.last_enabled,
 
772
                                       variant_level=1))
 
773
        return r
 
774
    
 
775
    def disable(self, quiet = False):
 
776
        oldstate = getattr(self, "enabled", False)
 
777
        r = Client.disable(self, quiet=quiet)
 
778
        if not quiet and oldstate != self.enabled:
 
779
            # Emit D-Bus signal
 
780
            self.PropertyChanged(dbus.String("Enabled"),
 
781
                                 dbus.Boolean(False, variant_level=1))
 
782
        return r
1361
783
    
1362
784
    def __del__(self, *args, **kwargs):
1363
785
        try:
1372
794
                         *args, **kwargs):
1373
795
        self.checker_callback_tag = None
1374
796
        self.checker = None
 
797
        # Emit D-Bus signal
 
798
        self.PropertyChanged(dbus.String("CheckerRunning"),
 
799
                             dbus.Boolean(False, variant_level=1))
1375
800
        if os.WIFEXITED(condition):
1376
801
            exitstatus = os.WEXITSTATUS(condition)
1377
802
            # Emit D-Bus signal
1387
812
        return Client.checker_callback(self, pid, condition, command,
1388
813
                                       *args, **kwargs)
1389
814
    
 
815
    def checked_ok(self, *args, **kwargs):
 
816
        r = Client.checked_ok(self, *args, **kwargs)
 
817
        # Emit D-Bus signal
 
818
        self.PropertyChanged(
 
819
            dbus.String("LastCheckedOK"),
 
820
            (self._datetime_to_dbus(self.last_checked_ok,
 
821
                                    variant_level=1)))
 
822
        return r
 
823
    
 
824
    def need_approval(self, *args, **kwargs):
 
825
        r = Client.need_approval(self, *args, **kwargs)
 
826
        # Emit D-Bus signal
 
827
        self.PropertyChanged(
 
828
            dbus.String("LastApprovalRequest"),
 
829
            (self._datetime_to_dbus(self.last_approval_request,
 
830
                                    variant_level=1)))
 
831
        return r
 
832
    
1390
833
    def start_checker(self, *args, **kwargs):
1391
 
        old_checker_pid = getattr(self.checker, "pid", None)
 
834
        old_checker = self.checker
 
835
        if self.checker is not None:
 
836
            old_checker_pid = self.checker.pid
 
837
        else:
 
838
            old_checker_pid = None
1392
839
        r = Client.start_checker(self, *args, **kwargs)
1393
840
        # Only if new checker process was started
1394
841
        if (self.checker is not None
1395
842
            and old_checker_pid != self.checker.pid):
1396
843
            # Emit D-Bus signal
1397
844
            self.CheckerStarted(self.current_checker_command)
 
845
            self.PropertyChanged(
 
846
                dbus.String("CheckerRunning"),
 
847
                dbus.Boolean(True, variant_level=1))
1398
848
        return r
1399
849
    
 
850
    def stop_checker(self, *args, **kwargs):
 
851
        old_checker = getattr(self, "checker", None)
 
852
        r = Client.stop_checker(self, *args, **kwargs)
 
853
        if (old_checker is not None
 
854
            and getattr(self, "checker", None) is None):
 
855
            self.PropertyChanged(dbus.String("CheckerRunning"),
 
856
                                 dbus.Boolean(False, variant_level=1))
 
857
        return r
 
858
 
1400
859
    def _reset_approved(self):
1401
 
        self.approved = None
 
860
        self._approved = None
1402
861
        return False
1403
862
    
1404
863
    def approve(self, value=True):
1405
 
        self.approved = value
1406
 
        gobject.timeout_add(int(self.approval_duration.total_seconds()
1407
 
                                * 1000), self._reset_approved)
1408
864
        self.send_changedstate()
 
865
        self._approved = value
 
866
        gobject.timeout_add(self._timedelta_to_milliseconds
 
867
                            (self.approval_duration),
 
868
                            self._reset_approved)
 
869
    
1409
870
    
1410
871
    ## D-Bus methods, signals & properties
1411
 
    
1412
 
    ## Interfaces
 
872
    _interface = "se.bsnet.fukt.Mandos.Client"
1413
873
    
1414
874
    ## Signals
1415
875
    
1426
886
        pass
1427
887
    
1428
888
    # PropertyChanged - signal
1429
 
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1430
889
    @dbus.service.signal(_interface, signature="sv")
1431
890
    def PropertyChanged(self, property, value):
1432
891
        "D-Bus signal"
1463
922
    # CheckedOK - method
1464
923
    @dbus.service.method(_interface)
1465
924
    def CheckedOK(self):
1466
 
        self.checked_ok()
 
925
        return self.checked_ok()
1467
926
    
1468
927
    # Enable - method
1469
928
    @dbus.service.method(_interface)
1496
955
        return dbus.Boolean(bool(self.approvals_pending))
1497
956
    
1498
957
    # ApprovedByDefault - property
1499
 
    @dbus_service_property(_interface,
1500
 
                           signature="b",
 
958
    @dbus_service_property(_interface, signature="b",
1501
959
                           access="readwrite")
1502
960
    def ApprovedByDefault_dbus_property(self, value=None):
1503
961
        if value is None:       # get
1504
962
            return dbus.Boolean(self.approved_by_default)
1505
963
        self.approved_by_default = bool(value)
 
964
        # Emit D-Bus signal
 
965
        self.PropertyChanged(dbus.String("ApprovedByDefault"),
 
966
                             dbus.Boolean(value, variant_level=1))
1506
967
    
1507
968
    # ApprovalDelay - property
1508
 
    @dbus_service_property(_interface,
1509
 
                           signature="t",
 
969
    @dbus_service_property(_interface, signature="t",
1510
970
                           access="readwrite")
1511
971
    def ApprovalDelay_dbus_property(self, value=None):
1512
972
        if value is None:       # get
1513
 
            return dbus.UInt64(self.approval_delay.total_seconds()
1514
 
                               * 1000)
 
973
            return dbus.UInt64(self.approval_delay_milliseconds())
1515
974
        self.approval_delay = datetime.timedelta(0, 0, 0, value)
 
975
        # Emit D-Bus signal
 
976
        self.PropertyChanged(dbus.String("ApprovalDelay"),
 
977
                             dbus.UInt64(value, variant_level=1))
1516
978
    
1517
979
    # ApprovalDuration - property
1518
 
    @dbus_service_property(_interface,
1519
 
                           signature="t",
 
980
    @dbus_service_property(_interface, signature="t",
1520
981
                           access="readwrite")
1521
982
    def ApprovalDuration_dbus_property(self, value=None):
1522
983
        if value is None:       # get
1523
 
            return dbus.UInt64(self.approval_duration.total_seconds()
1524
 
                               * 1000)
 
984
            return dbus.UInt64(self._timedelta_to_milliseconds(
 
985
                    self.approval_duration))
1525
986
        self.approval_duration = datetime.timedelta(0, 0, 0, value)
 
987
        # Emit D-Bus signal
 
988
        self.PropertyChanged(dbus.String("ApprovalDuration"),
 
989
                             dbus.UInt64(value, variant_level=1))
1526
990
    
1527
991
    # Name - property
1528
992
    @dbus_service_property(_interface, signature="s", access="read")
1535
999
        return dbus.String(self.fingerprint)
1536
1000
    
1537
1001
    # Host - property
1538
 
    @dbus_service_property(_interface,
1539
 
                           signature="s",
 
1002
    @dbus_service_property(_interface, signature="s",
1540
1003
                           access="readwrite")
1541
1004
    def Host_dbus_property(self, value=None):
1542
1005
        if value is None:       # get
1543
1006
            return dbus.String(self.host)
1544
 
        self.host = str(value)
 
1007
        self.host = value
 
1008
        # Emit D-Bus signal
 
1009
        self.PropertyChanged(dbus.String("Host"),
 
1010
                             dbus.String(value, variant_level=1))
1545
1011
    
1546
1012
    # Created - property
1547
1013
    @dbus_service_property(_interface, signature="s", access="read")
1548
1014
    def Created_dbus_property(self):
1549
 
        return datetime_to_dbus(self.created)
 
1015
        return dbus.String(self._datetime_to_dbus(self.created))
1550
1016
    
1551
1017
    # LastEnabled - property
1552
1018
    @dbus_service_property(_interface, signature="s", access="read")
1553
1019
    def LastEnabled_dbus_property(self):
1554
 
        return datetime_to_dbus(self.last_enabled)
 
1020
        if self.last_enabled is None:
 
1021
            return dbus.String("")
 
1022
        return dbus.String(self._datetime_to_dbus(self.last_enabled))
1555
1023
    
1556
1024
    # Enabled - property
1557
 
    @dbus_service_property(_interface,
1558
 
                           signature="b",
 
1025
    @dbus_service_property(_interface, signature="b",
1559
1026
                           access="readwrite")
1560
1027
    def Enabled_dbus_property(self, value=None):
1561
1028
        if value is None:       # get
1566
1033
            self.disable()
1567
1034
    
1568
1035
    # LastCheckedOK - property
1569
 
    @dbus_service_property(_interface,
1570
 
                           signature="s",
 
1036
    @dbus_service_property(_interface, signature="s",
1571
1037
                           access="readwrite")
1572
1038
    def LastCheckedOK_dbus_property(self, value=None):
1573
1039
        if value is not None:
1574
1040
            self.checked_ok()
1575
1041
            return
1576
 
        return datetime_to_dbus(self.last_checked_ok)
1577
 
    
1578
 
    # LastCheckerStatus - property
1579
 
    @dbus_service_property(_interface, signature="n", access="read")
1580
 
    def LastCheckerStatus_dbus_property(self):
1581
 
        return dbus.Int16(self.last_checker_status)
1582
 
    
1583
 
    # Expires - property
1584
 
    @dbus_service_property(_interface, signature="s", access="read")
1585
 
    def Expires_dbus_property(self):
1586
 
        return datetime_to_dbus(self.expires)
 
1042
        if self.last_checked_ok is None:
 
1043
            return dbus.String("")
 
1044
        return dbus.String(self._datetime_to_dbus(self
 
1045
                                                  .last_checked_ok))
1587
1046
    
1588
1047
    # LastApprovalRequest - property
1589
1048
    @dbus_service_property(_interface, signature="s", access="read")
1590
1049
    def LastApprovalRequest_dbus_property(self):
1591
 
        return datetime_to_dbus(self.last_approval_request)
 
1050
        if self.last_approval_request is None:
 
1051
            return dbus.String("")
 
1052
        return dbus.String(self.
 
1053
                           _datetime_to_dbus(self
 
1054
                                             .last_approval_request))
1592
1055
    
1593
1056
    # Timeout - property
1594
 
    @dbus_service_property(_interface,
1595
 
                           signature="t",
 
1057
    @dbus_service_property(_interface, signature="t",
1596
1058
                           access="readwrite")
1597
1059
    def Timeout_dbus_property(self, value=None):
1598
1060
        if value is None:       # get
1599
 
            return dbus.UInt64(self.timeout.total_seconds() * 1000)
1600
 
        old_timeout = self.timeout
 
1061
            return dbus.UInt64(self.timeout_milliseconds())
1601
1062
        self.timeout = datetime.timedelta(0, 0, 0, value)
1602
 
        # Reschedule disabling
1603
 
        if self.enabled:
1604
 
            now = datetime.datetime.utcnow()
1605
 
            self.expires += self.timeout - old_timeout
1606
 
            if self.expires <= now:
1607
 
                # The timeout has passed
1608
 
                self.disable()
1609
 
            else:
1610
 
                if (getattr(self, "disable_initiator_tag", None)
1611
 
                    is None):
1612
 
                    return
1613
 
                gobject.source_remove(self.disable_initiator_tag)
1614
 
                self.disable_initiator_tag = gobject.timeout_add(
1615
 
                    int((self.expires - now).total_seconds() * 1000),
1616
 
                    self.disable)
1617
 
    
1618
 
    # ExtendedTimeout - property
1619
 
    @dbus_service_property(_interface,
1620
 
                           signature="t",
1621
 
                           access="readwrite")
1622
 
    def ExtendedTimeout_dbus_property(self, value=None):
1623
 
        if value is None:       # get
1624
 
            return dbus.UInt64(self.extended_timeout.total_seconds()
1625
 
                               * 1000)
1626
 
        self.extended_timeout = datetime.timedelta(0, 0, 0, value)
 
1063
        # Emit D-Bus signal
 
1064
        self.PropertyChanged(dbus.String("Timeout"),
 
1065
                             dbus.UInt64(value, variant_level=1))
 
1066
        if getattr(self, "disable_initiator_tag", None) is None:
 
1067
            return
 
1068
        # Reschedule timeout
 
1069
        gobject.source_remove(self.disable_initiator_tag)
 
1070
        self.disable_initiator_tag = None
 
1071
        time_to_die = (self.
 
1072
                       _timedelta_to_milliseconds((self
 
1073
                                                   .last_checked_ok
 
1074
                                                   + self.timeout)
 
1075
                                                  - datetime.datetime
 
1076
                                                  .utcnow()))
 
1077
        if time_to_die <= 0:
 
1078
            # The timeout has passed
 
1079
            self.disable()
 
1080
        else:
 
1081
            self.disable_initiator_tag = (gobject.timeout_add
 
1082
                                          (time_to_die, self.disable))
1627
1083
    
1628
1084
    # Interval - property
1629
 
    @dbus_service_property(_interface,
1630
 
                           signature="t",
 
1085
    @dbus_service_property(_interface, signature="t",
1631
1086
                           access="readwrite")
1632
1087
    def Interval_dbus_property(self, value=None):
1633
1088
        if value is None:       # get
1634
 
            return dbus.UInt64(self.interval.total_seconds() * 1000)
 
1089
            return dbus.UInt64(self.interval_milliseconds())
1635
1090
        self.interval = datetime.timedelta(0, 0, 0, value)
 
1091
        # Emit D-Bus signal
 
1092
        self.PropertyChanged(dbus.String("Interval"),
 
1093
                             dbus.UInt64(value, variant_level=1))
1636
1094
        if getattr(self, "checker_initiator_tag", None) is None:
1637
1095
            return
1638
 
        if self.enabled:
1639
 
            # Reschedule checker run
1640
 
            gobject.source_remove(self.checker_initiator_tag)
1641
 
            self.checker_initiator_tag = gobject.timeout_add(
1642
 
                value, self.start_checker)
1643
 
            self.start_checker() # Start one now, too
1644
 
    
 
1096
        # Reschedule checker run
 
1097
        gobject.source_remove(self.checker_initiator_tag)
 
1098
        self.checker_initiator_tag = (gobject.timeout_add
 
1099
                                      (value, self.start_checker))
 
1100
        self.start_checker()    # Start one now, too
 
1101
 
1645
1102
    # Checker - property
1646
 
    @dbus_service_property(_interface,
1647
 
                           signature="s",
 
1103
    @dbus_service_property(_interface, signature="s",
1648
1104
                           access="readwrite")
1649
1105
    def Checker_dbus_property(self, value=None):
1650
1106
        if value is None:       # get
1651
1107
            return dbus.String(self.checker_command)
1652
 
        self.checker_command = str(value)
 
1108
        self.checker_command = value
 
1109
        # Emit D-Bus signal
 
1110
        self.PropertyChanged(dbus.String("Checker"),
 
1111
                             dbus.String(self.checker_command,
 
1112
                                         variant_level=1))
1653
1113
    
1654
1114
    # CheckerRunning - property
1655
 
    @dbus_service_property(_interface,
1656
 
                           signature="b",
 
1115
    @dbus_service_property(_interface, signature="b",
1657
1116
                           access="readwrite")
1658
1117
    def CheckerRunning_dbus_property(self, value=None):
1659
1118
        if value is None:       # get
1669
1128
        return self.dbus_object_path # is already a dbus.ObjectPath
1670
1129
    
1671
1130
    # Secret = property
1672
 
    @dbus_service_property(_interface,
1673
 
                           signature="ay",
1674
 
                           access="write",
1675
 
                           byte_arrays=True)
 
1131
    @dbus_service_property(_interface, signature="ay",
 
1132
                           access="write", byte_arrays=True)
1676
1133
    def Secret_dbus_property(self, value):
1677
 
        self.secret = bytes(value)
 
1134
        self.secret = str(value)
1678
1135
    
1679
1136
    del _interface
1680
1137
 
1684
1141
        self._pipe = child_pipe
1685
1142
        self._pipe.send(('init', fpr, address))
1686
1143
        if not self._pipe.recv():
1687
 
            raise KeyError(fpr)
1688
 
    
 
1144
            raise KeyError()
 
1145
 
1689
1146
    def __getattribute__(self, name):
1690
 
        if name == '_pipe':
 
1147
        if(name == '_pipe'):
1691
1148
            return super(ProxyClient, self).__getattribute__(name)
1692
1149
        self._pipe.send(('getattr', name))
1693
1150
        data = self._pipe.recv()
1694
1151
        if data[0] == 'data':
1695
1152
            return data[1]
1696
1153
        if data[0] == 'function':
1697
 
            
1698
1154
            def func(*args, **kwargs):
1699
1155
                self._pipe.send(('funcall', name, args, kwargs))
1700
1156
                return self._pipe.recv()[1]
1701
 
            
1702
1157
            return func
1703
 
    
 
1158
 
1704
1159
    def __setattr__(self, name, value):
1705
 
        if name == '_pipe':
 
1160
        if(name == '_pipe'):
1706
1161
            return super(ProxyClient, self).__setattr__(name, value)
1707
1162
        self._pipe.send(('setattr', name, value))
1708
1163
 
1716
1171
    def handle(self):
1717
1172
        with contextlib.closing(self.server.child_pipe) as child_pipe:
1718
1173
            logger.info("TCP connection from: %s",
1719
 
                        str(self.client_address))
 
1174
                        unicode(self.client_address))
1720
1175
            logger.debug("Pipe FD: %d",
1721
1176
                         self.server.child_pipe.fileno())
1722
 
            
1723
 
            session = gnutls.connection.ClientSession(
1724
 
                self.request, gnutls.connection .X509Credentials())
1725
 
            
 
1177
 
 
1178
            session = (gnutls.connection
 
1179
                       .ClientSession(self.request,
 
1180
                                      gnutls.connection
 
1181
                                      .X509Credentials()))
 
1182
 
1726
1183
            # Note: gnutls.connection.X509Credentials is really a
1727
1184
            # generic GnuTLS certificate credentials object so long as
1728
1185
            # no X.509 keys are added to it.  Therefore, we can use it
1729
1186
            # here despite using OpenPGP certificates.
1730
 
            
 
1187
 
1731
1188
            #priority = ':'.join(("NONE", "+VERS-TLS1.1",
1732
1189
            #                      "+AES-256-CBC", "+SHA1",
1733
1190
            #                      "+COMP-NULL", "+CTYPE-OPENPGP",
1736
1193
            priority = self.server.gnutls_priority
1737
1194
            if priority is None:
1738
1195
                priority = "NORMAL"
1739
 
            gnutls.library.functions.gnutls_priority_set_direct(
1740
 
                session._c_object, priority, None)
1741
 
            
 
1196
            (gnutls.library.functions
 
1197
             .gnutls_priority_set_direct(session._c_object,
 
1198
                                         priority, None))
 
1199
 
1742
1200
            # Start communication using the Mandos protocol
1743
1201
            # Get protocol number
1744
1202
            line = self.request.makefile().readline()
1745
1203
            logger.debug("Protocol version: %r", line)
1746
1204
            try:
1747
1205
                if int(line.strip().split()[0]) > 1:
1748
 
                    raise RuntimeError(line)
1749
 
            except (ValueError, IndexError, RuntimeError) as error:
 
1206
                    raise RuntimeError
 
1207
            except (ValueError, IndexError, RuntimeError), error:
1750
1208
                logger.error("Unknown protocol version: %s", error)
1751
1209
                return
1752
 
            
 
1210
 
1753
1211
            # Start GnuTLS connection
1754
1212
            try:
1755
1213
                session.handshake()
1756
 
            except gnutls.errors.GNUTLSError as error:
 
1214
            except gnutls.errors.GNUTLSError, error:
1757
1215
                logger.warning("Handshake failed: %s", error)
1758
1216
                # Do not run session.bye() here: the session is not
1759
1217
                # established.  Just abandon the request.
1760
1218
                return
1761
1219
            logger.debug("Handshake succeeded")
1762
 
            
 
1220
 
1763
1221
            approval_required = False
1764
1222
            try:
1765
1223
                try:
1766
 
                    fpr = self.fingerprint(
1767
 
                        self.peer_certificate(session))
1768
 
                except (TypeError,
1769
 
                        gnutls.errors.GNUTLSError) as error:
 
1224
                    fpr = self.fingerprint(self.peer_certificate
 
1225
                                           (session))
 
1226
                except (TypeError, gnutls.errors.GNUTLSError), error:
1770
1227
                    logger.warning("Bad certificate: %s", error)
1771
1228
                    return
1772
1229
                logger.debug("Fingerprint: %s", fpr)
1773
 
                
 
1230
 
1774
1231
                try:
1775
1232
                    client = ProxyClient(child_pipe, fpr,
1776
1233
                                         self.client_address)
1784
1241
                
1785
1242
                while True:
1786
1243
                    if not client.enabled:
1787
 
                        logger.info("Client %s is disabled",
1788
 
                                    client.name)
 
1244
                        logger.warning("Client %s is disabled",
 
1245
                                       client.name)
1789
1246
                        if self.server.use_dbus:
1790
1247
                            # Emit D-Bus signal
1791
 
                            client.Rejected("Disabled")
 
1248
                            client.Rejected("Disabled")                    
1792
1249
                        return
1793
1250
                    
1794
 
                    if client.approved or not client.approval_delay:
 
1251
                    if client._approved or not client.approval_delay:
1795
1252
                        #We are approved or approval is disabled
1796
1253
                        break
1797
 
                    elif client.approved is None:
 
1254
                    elif client._approved is None:
1798
1255
                        logger.info("Client %s needs approval",
1799
1256
                                    client.name)
1800
1257
                        if self.server.use_dbus:
1801
1258
                            # Emit D-Bus signal
1802
1259
                            client.NeedApproval(
1803
 
                                client.approval_delay.total_seconds()
1804
 
                                * 1000, client.approved_by_default)
 
1260
                                client.approval_delay_milliseconds(),
 
1261
                                client.approved_by_default)
1805
1262
                    else:
1806
1263
                        logger.warning("Client %s was not approved",
1807
1264
                                       client.name)
1811
1268
                        return
1812
1269
                    
1813
1270
                    #wait until timeout or approved
 
1271
                    #x = float(client._timedelta_to_milliseconds(delay))
1814
1272
                    time = datetime.datetime.now()
1815
1273
                    client.changedstate.acquire()
1816
 
                    client.changedstate.wait(delay.total_seconds())
 
1274
                    client.changedstate.wait(float(client._timedelta_to_milliseconds(delay) / 1000))
1817
1275
                    client.changedstate.release()
1818
1276
                    time2 = datetime.datetime.now()
1819
1277
                    if (time2 - time) >= delay:
1834
1292
                while sent_size < len(client.secret):
1835
1293
                    try:
1836
1294
                        sent = session.send(client.secret[sent_size:])
1837
 
                    except gnutls.errors.GNUTLSError as error:
1838
 
                        logger.warning("gnutls send failed",
1839
 
                                       exc_info=error)
 
1295
                    except (gnutls.errors.GNUTLSError), error:
 
1296
                        logger.warning("gnutls send failed")
1840
1297
                        return
1841
 
                    logger.debug("Sent: %d, remaining: %d", sent,
1842
 
                                 len(client.secret) - (sent_size
1843
 
                                                       + sent))
 
1298
                    logger.debug("Sent: %d, remaining: %d",
 
1299
                                 sent, len(client.secret)
 
1300
                                 - (sent_size + sent))
1844
1301
                    sent_size += sent
1845
 
                
 
1302
 
1846
1303
                logger.info("Sending secret to %s", client.name)
1847
 
                # bump the timeout using extended_timeout
1848
 
                client.bump_timeout(client.extended_timeout)
 
1304
                # bump the timeout as if seen
 
1305
                client.checked_ok()
1849
1306
                if self.server.use_dbus:
1850
1307
                    # Emit D-Bus signal
1851
1308
                    client.GotSecret()
1855
1312
                    client.approvals_pending -= 1
1856
1313
                try:
1857
1314
                    session.bye()
1858
 
                except gnutls.errors.GNUTLSError as error:
1859
 
                    logger.warning("GnuTLS bye failed",
1860
 
                                   exc_info=error)
 
1315
                except (gnutls.errors.GNUTLSError), error:
 
1316
                    logger.warning("GnuTLS bye failed")
1861
1317
    
1862
1318
    @staticmethod
1863
1319
    def peer_certificate(session):
1864
1320
        "Return the peer's OpenPGP certificate as a bytestring"
1865
1321
        # If not an OpenPGP certificate...
1866
 
        if (gnutls.library.functions.gnutls_certificate_type_get(
1867
 
                session._c_object)
 
1322
        if (gnutls.library.functions
 
1323
            .gnutls_certificate_type_get(session._c_object)
1868
1324
            != gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1869
1325
            # ...do the normal thing
1870
1326
            return session.peer_certificate
1884
1340
    def fingerprint(openpgp):
1885
1341
        "Convert an OpenPGP bytestring to a hexdigit fingerprint"
1886
1342
        # New GnuTLS "datum" with the OpenPGP public key
1887
 
        datum = gnutls.library.types.gnutls_datum_t(
1888
 
            ctypes.cast(ctypes.c_char_p(openpgp),
1889
 
                        ctypes.POINTER(ctypes.c_ubyte)),
1890
 
            ctypes.c_uint(len(openpgp)))
 
1343
        datum = (gnutls.library.types
 
1344
                 .gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
 
1345
                                             ctypes.POINTER
 
1346
                                             (ctypes.c_ubyte)),
 
1347
                                 ctypes.c_uint(len(openpgp))))
1891
1348
        # New empty GnuTLS certificate
1892
1349
        crt = gnutls.library.types.gnutls_openpgp_crt_t()
1893
 
        gnutls.library.functions.gnutls_openpgp_crt_init(
1894
 
            ctypes.byref(crt))
 
1350
        (gnutls.library.functions
 
1351
         .gnutls_openpgp_crt_init(ctypes.byref(crt)))
1895
1352
        # Import the OpenPGP public key into the certificate
1896
 
        gnutls.library.functions.gnutls_openpgp_crt_import(
1897
 
            crt, ctypes.byref(datum),
1898
 
            gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
 
1353
        (gnutls.library.functions
 
1354
         .gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
 
1355
                                    gnutls.library.constants
 
1356
                                    .GNUTLS_OPENPGP_FMT_RAW))
1899
1357
        # Verify the self signature in the key
1900
1358
        crtverify = ctypes.c_uint()
1901
 
        gnutls.library.functions.gnutls_openpgp_crt_verify_self(
1902
 
            crt, 0, ctypes.byref(crtverify))
 
1359
        (gnutls.library.functions
 
1360
         .gnutls_openpgp_crt_verify_self(crt, 0,
 
1361
                                         ctypes.byref(crtverify)))
1903
1362
        if crtverify.value != 0:
1904
1363
            gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1905
 
            raise gnutls.errors.CertificateSecurityError(
1906
 
                "Verify failed")
 
1364
            raise (gnutls.errors.CertificateSecurityError
 
1365
                   ("Verify failed"))
1907
1366
        # New buffer for the fingerprint
1908
1367
        buf = ctypes.create_string_buffer(20)
1909
1368
        buf_len = ctypes.c_size_t()
1910
1369
        # Get the fingerprint from the certificate into the buffer
1911
 
        gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint(
1912
 
            crt, ctypes.byref(buf), ctypes.byref(buf_len))
 
1370
        (gnutls.library.functions
 
1371
         .gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
 
1372
                                             ctypes.byref(buf_len)))
1913
1373
        # Deinit the certificate
1914
1374
        gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1915
1375
        # Convert the buffer to a Python bytestring
1916
1376
        fpr = ctypes.string_at(buf, buf_len.value)
1917
1377
        # Convert the bytestring to hexadecimal notation
1918
 
        hex_fpr = binascii.hexlify(fpr).upper()
 
1378
        hex_fpr = ''.join("%02X" % ord(char) for char in fpr)
1919
1379
        return hex_fpr
1920
1380
 
1921
1381
 
1922
1382
class MultiprocessingMixIn(object):
1923
1383
    """Like socketserver.ThreadingMixIn, but with multiprocessing"""
1924
 
    
1925
1384
    def sub_process_main(self, request, address):
1926
1385
        try:
1927
1386
            self.finish_request(request, address)
1928
 
        except Exception:
 
1387
        except:
1929
1388
            self.handle_error(request, address)
1930
1389
        self.close_request(request)
1931
 
    
 
1390
            
1932
1391
    def process_request(self, request, address):
1933
1392
        """Start a new process to process the request."""
1934
 
        proc = multiprocessing.Process(target = self.sub_process_main,
1935
 
                                       args = (request, address))
1936
 
        proc.start()
1937
 
        return proc
1938
 
 
 
1393
        multiprocessing.Process(target = self.sub_process_main,
 
1394
                                args = (request, address)).start()
1939
1395
 
1940
1396
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1941
1397
    """ adds a pipe to the MixIn """
1942
 
    
1943
1398
    def process_request(self, request, client_address):
1944
1399
        """Overrides and wraps the original process_request().
1945
1400
        
1946
1401
        This function creates a new pipe in self.pipe
1947
1402
        """
1948
1403
        parent_pipe, self.child_pipe = multiprocessing.Pipe()
1949
 
        
1950
 
        proc = MultiprocessingMixIn.process_request(self, request,
1951
 
                                                    client_address)
 
1404
 
 
1405
        super(MultiprocessingMixInWithPipe,
 
1406
              self).process_request(request, client_address)
1952
1407
        self.child_pipe.close()
1953
 
        self.add_pipe(parent_pipe, proc)
1954
 
    
1955
 
    def add_pipe(self, parent_pipe, proc):
 
1408
        self.add_pipe(parent_pipe)
 
1409
 
 
1410
    def add_pipe(self, parent_pipe):
1956
1411
        """Dummy function; override as necessary"""
1957
 
        raise NotImplementedError()
1958
 
 
 
1412
        raise NotImplementedError
1959
1413
 
1960
1414
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1961
1415
                     socketserver.TCPServer, object):
1966
1420
        interface:      None or a network interface name (string)
1967
1421
        use_ipv6:       Boolean; to use IPv6 or not
1968
1422
    """
1969
 
    
1970
1423
    def __init__(self, server_address, RequestHandlerClass,
1971
 
                 interface=None,
1972
 
                 use_ipv6=True,
1973
 
                 socketfd=None):
1974
 
        """If socketfd is set, use that file descriptor instead of
1975
 
        creating a new one with socket.socket().
1976
 
        """
 
1424
                 interface=None, use_ipv6=True):
1977
1425
        self.interface = interface
1978
1426
        if use_ipv6:
1979
1427
            self.address_family = socket.AF_INET6
1980
 
        if socketfd is not None:
1981
 
            # Save the file descriptor
1982
 
            self.socketfd = socketfd
1983
 
            # Save the original socket.socket() function
1984
 
            self.socket_socket = socket.socket
1985
 
            # To implement --socket, we monkey patch socket.socket.
1986
 
            # 
1987
 
            # (When socketserver.TCPServer is a new-style class, we
1988
 
            # could make self.socket into a property instead of monkey
1989
 
            # patching socket.socket.)
1990
 
            # 
1991
 
            # Create a one-time-only replacement for socket.socket()
1992
 
            @functools.wraps(socket.socket)
1993
 
            def socket_wrapper(*args, **kwargs):
1994
 
                # Restore original function so subsequent calls are
1995
 
                # not affected.
1996
 
                socket.socket = self.socket_socket
1997
 
                del self.socket_socket
1998
 
                # This time only, return a new socket object from the
1999
 
                # saved file descriptor.
2000
 
                return socket.fromfd(self.socketfd, *args, **kwargs)
2001
 
            # Replace socket.socket() function with wrapper
2002
 
            socket.socket = socket_wrapper
2003
 
        # The socketserver.TCPServer.__init__ will call
2004
 
        # socket.socket(), which might be our replacement,
2005
 
        # socket_wrapper(), if socketfd was set.
2006
1428
        socketserver.TCPServer.__init__(self, server_address,
2007
1429
                                        RequestHandlerClass)
2008
 
    
2009
1430
    def server_bind(self):
2010
1431
        """This overrides the normal server_bind() function
2011
1432
        to bind to an interface if one was specified, and also NOT to
2017
1438
                             self.interface)
2018
1439
            else:
2019
1440
                try:
2020
 
                    self.socket.setsockopt(
2021
 
                        socket.SOL_SOCKET, SO_BINDTODEVICE,
2022
 
                        (self.interface + "\0").encode("utf-8"))
2023
 
                except socket.error as error:
2024
 
                    if error.errno == errno.EPERM:
2025
 
                        logger.error("No permission to bind to"
2026
 
                                     " interface %s", self.interface)
2027
 
                    elif error.errno == errno.ENOPROTOOPT:
 
1441
                    self.socket.setsockopt(socket.SOL_SOCKET,
 
1442
                                           SO_BINDTODEVICE,
 
1443
                                           str(self.interface
 
1444
                                               + '\0'))
 
1445
                except socket.error, error:
 
1446
                    if error[0] == errno.EPERM:
 
1447
                        logger.error("No permission to"
 
1448
                                     " bind to interface %s",
 
1449
                                     self.interface)
 
1450
                    elif error[0] == errno.ENOPROTOOPT:
2028
1451
                        logger.error("SO_BINDTODEVICE not available;"
2029
1452
                                     " cannot bind to interface %s",
2030
1453
                                     self.interface)
2031
 
                    elif error.errno == errno.ENODEV:
2032
 
                        logger.error("Interface %s does not exist,"
2033
 
                                     " cannot bind", self.interface)
2034
1454
                    else:
2035
1455
                        raise
2036
1456
        # Only bind(2) the socket if we really need to.
2039
1459
                if self.address_family == socket.AF_INET6:
2040
1460
                    any_address = "::" # in6addr_any
2041
1461
                else:
2042
 
                    any_address = "0.0.0.0" # INADDR_ANY
 
1462
                    any_address = socket.INADDR_ANY
2043
1463
                self.server_address = (any_address,
2044
1464
                                       self.server_address[1])
2045
1465
            elif not self.server_address[1]:
2046
 
                self.server_address = (self.server_address[0], 0)
 
1466
                self.server_address = (self.server_address[0],
 
1467
                                       0)
2047
1468
#                 if self.interface:
2048
1469
#                     self.server_address = (self.server_address[0],
2049
1470
#                                            0, # port
2063
1484
    
2064
1485
    Assumes a gobject.MainLoop event loop.
2065
1486
    """
2066
 
    
2067
1487
    def __init__(self, server_address, RequestHandlerClass,
2068
 
                 interface=None,
2069
 
                 use_ipv6=True,
2070
 
                 clients=None,
2071
 
                 gnutls_priority=None,
2072
 
                 use_dbus=True,
2073
 
                 socketfd=None):
 
1488
                 interface=None, use_ipv6=True, clients=None,
 
1489
                 gnutls_priority=None, use_dbus=True):
2074
1490
        self.enabled = False
2075
1491
        self.clients = clients
2076
1492
        if self.clients is None:
2077
 
            self.clients = {}
 
1493
            self.clients = set()
2078
1494
        self.use_dbus = use_dbus
2079
1495
        self.gnutls_priority = gnutls_priority
2080
1496
        IPv6_TCPServer.__init__(self, server_address,
2081
1497
                                RequestHandlerClass,
2082
1498
                                interface = interface,
2083
 
                                use_ipv6 = use_ipv6,
2084
 
                                socketfd = socketfd)
2085
 
    
 
1499
                                use_ipv6 = use_ipv6)
2086
1500
    def server_activate(self):
2087
1501
        if self.enabled:
2088
1502
            return socketserver.TCPServer.server_activate(self)
2089
 
    
2090
1503
    def enable(self):
2091
1504
        self.enabled = True
2092
 
    
2093
 
    def add_pipe(self, parent_pipe, proc):
 
1505
    def add_pipe(self, parent_pipe):
2094
1506
        # Call "handle_ipc" for both data and EOF events
2095
 
        gobject.io_add_watch(
2096
 
            parent_pipe.fileno(),
2097
 
            gobject.IO_IN | gobject.IO_HUP,
2098
 
            functools.partial(self.handle_ipc,
2099
 
                              parent_pipe = parent_pipe,
2100
 
                              proc = proc))
2101
 
    
2102
 
    def handle_ipc(self, source, condition,
2103
 
                   parent_pipe=None,
2104
 
                   proc = None,
 
1507
        gobject.io_add_watch(parent_pipe.fileno(),
 
1508
                             gobject.IO_IN | gobject.IO_HUP,
 
1509
                             functools.partial(self.handle_ipc,
 
1510
                                               parent_pipe = parent_pipe))
 
1511
        
 
1512
    def handle_ipc(self, source, condition, parent_pipe=None,
2105
1513
                   client_object=None):
2106
 
        # error, or the other end of multiprocessing.Pipe has closed
2107
 
        if condition & (gobject.IO_ERR | gobject.IO_HUP):
2108
 
            # Wait for other process to exit
2109
 
            proc.join()
 
1514
        condition_names = {
 
1515
            gobject.IO_IN: "IN",   # There is data to read.
 
1516
            gobject.IO_OUT: "OUT", # Data can be written (without
 
1517
                                    # blocking).
 
1518
            gobject.IO_PRI: "PRI", # There is urgent data to read.
 
1519
            gobject.IO_ERR: "ERR", # Error condition.
 
1520
            gobject.IO_HUP: "HUP"  # Hung up (the connection has been
 
1521
                                    # broken, usually for pipes and
 
1522
                                    # sockets).
 
1523
            }
 
1524
        conditions_string = ' | '.join(name
 
1525
                                       for cond, name in
 
1526
                                       condition_names.iteritems()
 
1527
                                       if cond & condition)
 
1528
        # error or the other end of multiprocessing.Pipe has closed
 
1529
        if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
2110
1530
            return False
2111
1531
        
2112
1532
        # Read a request from the child
2117
1537
            fpr = request[1]
2118
1538
            address = request[2]
2119
1539
            
2120
 
            for c in self.clients.itervalues():
 
1540
            for c in self.clients:
2121
1541
                if c.fingerprint == fpr:
2122
1542
                    client = c
2123
1543
                    break
2124
1544
            else:
2125
 
                logger.info("Client not found for fingerprint: %s, ad"
2126
 
                            "dress: %s", fpr, address)
 
1545
                logger.warning("Client not found for fingerprint: %s, ad"
 
1546
                               "dress: %s", fpr, address)
2127
1547
                if self.use_dbus:
2128
1548
                    # Emit D-Bus signal
2129
 
                    mandos_dbus_service.ClientNotFound(fpr,
2130
 
                                                       address[0])
 
1549
                    mandos_dbus_service.ClientNotFound(fpr, address[0])
2131
1550
                parent_pipe.send(False)
2132
1551
                return False
2133
1552
            
2134
 
            gobject.io_add_watch(
2135
 
                parent_pipe.fileno(),
2136
 
                gobject.IO_IN | gobject.IO_HUP,
2137
 
                functools.partial(self.handle_ipc,
2138
 
                                  parent_pipe = parent_pipe,
2139
 
                                  proc = proc,
2140
 
                                  client_object = client))
 
1553
            gobject.io_add_watch(parent_pipe.fileno(),
 
1554
                                 gobject.IO_IN | gobject.IO_HUP,
 
1555
                                 functools.partial(self.handle_ipc,
 
1556
                                                   parent_pipe = parent_pipe,
 
1557
                                                   client_object = client))
2141
1558
            parent_pipe.send(True)
2142
 
            # remove the old hook in favor of the new above hook on
2143
 
            # same fileno
 
1559
            # remove the old hook in favor of the new above hook on same fileno
2144
1560
            return False
2145
1561
        if command == 'funcall':
2146
1562
            funcname = request[1]
2147
1563
            args = request[2]
2148
1564
            kwargs = request[3]
2149
1565
            
2150
 
            parent_pipe.send(('data', getattr(client_object,
2151
 
                                              funcname)(*args,
2152
 
                                                        **kwargs)))
2153
 
        
 
1566
            parent_pipe.send(('data', getattr(client_object, funcname)(*args, **kwargs)))
 
1567
 
2154
1568
        if command == 'getattr':
2155
1569
            attrname = request[1]
2156
 
            if isinstance(client_object.__getattribute__(attrname),
2157
 
                          collections.Callable):
2158
 
                parent_pipe.send(('function', ))
 
1570
            if callable(client_object.__getattribute__(attrname)):
 
1571
                parent_pipe.send(('function',))
2159
1572
            else:
2160
 
                parent_pipe.send((
2161
 
                    'data', client_object.__getattribute__(attrname)))
 
1573
                parent_pipe.send(('data', client_object.__getattribute__(attrname)))
2162
1574
        
2163
1575
        if command == 'setattr':
2164
1576
            attrname = request[1]
2165
1577
            value = request[2]
2166
1578
            setattr(client_object, attrname, value)
2167
 
        
 
1579
 
2168
1580
        return True
2169
1581
 
2170
1582
 
2171
 
def rfc3339_duration_to_delta(duration):
2172
 
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
2173
 
    
2174
 
    >>> rfc3339_duration_to_delta("P7D")
2175
 
    datetime.timedelta(7)
2176
 
    >>> rfc3339_duration_to_delta("PT60S")
2177
 
    datetime.timedelta(0, 60)
2178
 
    >>> rfc3339_duration_to_delta("PT60M")
2179
 
    datetime.timedelta(0, 3600)
2180
 
    >>> rfc3339_duration_to_delta("PT24H")
2181
 
    datetime.timedelta(1)
2182
 
    >>> rfc3339_duration_to_delta("P1W")
2183
 
    datetime.timedelta(7)
2184
 
    >>> rfc3339_duration_to_delta("PT5M30S")
2185
 
    datetime.timedelta(0, 330)
2186
 
    >>> rfc3339_duration_to_delta("P1DT3M20S")
2187
 
    datetime.timedelta(1, 200)
2188
 
    """
2189
 
    
2190
 
    # Parsing an RFC 3339 duration with regular expressions is not
2191
 
    # possible - there would have to be multiple places for the same
2192
 
    # values, like seconds.  The current code, while more esoteric, is
2193
 
    # cleaner without depending on a parsing library.  If Python had a
2194
 
    # built-in library for parsing we would use it, but we'd like to
2195
 
    # avoid excessive use of external libraries.
2196
 
    
2197
 
    # New type for defining tokens, syntax, and semantics all-in-one
2198
 
    Token = collections.namedtuple("Token", (
2199
 
        "regexp",  # To match token; if "value" is not None, must have
2200
 
                   # a "group" containing digits
2201
 
        "value",   # datetime.timedelta or None
2202
 
        "followers"))           # Tokens valid after this token
2203
 
    # RFC 3339 "duration" tokens, syntax, and semantics; taken from
2204
 
    # the "duration" ABNF definition in RFC 3339, Appendix A.
2205
 
    token_end = Token(re.compile(r"$"), None, frozenset())
2206
 
    token_second = Token(re.compile(r"(\d+)S"),
2207
 
                         datetime.timedelta(seconds=1),
2208
 
                         frozenset((token_end, )))
2209
 
    token_minute = Token(re.compile(r"(\d+)M"),
2210
 
                         datetime.timedelta(minutes=1),
2211
 
                         frozenset((token_second, token_end)))
2212
 
    token_hour = Token(re.compile(r"(\d+)H"),
2213
 
                       datetime.timedelta(hours=1),
2214
 
                       frozenset((token_minute, token_end)))
2215
 
    token_time = Token(re.compile(r"T"),
2216
 
                       None,
2217
 
                       frozenset((token_hour, token_minute,
2218
 
                                  token_second)))
2219
 
    token_day = Token(re.compile(r"(\d+)D"),
2220
 
                      datetime.timedelta(days=1),
2221
 
                      frozenset((token_time, token_end)))
2222
 
    token_month = Token(re.compile(r"(\d+)M"),
2223
 
                        datetime.timedelta(weeks=4),
2224
 
                        frozenset((token_day, token_end)))
2225
 
    token_year = Token(re.compile(r"(\d+)Y"),
2226
 
                       datetime.timedelta(weeks=52),
2227
 
                       frozenset((token_month, token_end)))
2228
 
    token_week = Token(re.compile(r"(\d+)W"),
2229
 
                       datetime.timedelta(weeks=1),
2230
 
                       frozenset((token_end, )))
2231
 
    token_duration = Token(re.compile(r"P"), None,
2232
 
                           frozenset((token_year, token_month,
2233
 
                                      token_day, token_time,
2234
 
                                      token_week)))
2235
 
    # Define starting values
2236
 
    value = datetime.timedelta() # Value so far
2237
 
    found_token = None
2238
 
    followers = frozenset((token_duration, )) # Following valid tokens
2239
 
    s = duration                # String left to parse
2240
 
    # Loop until end token is found
2241
 
    while found_token is not token_end:
2242
 
        # Search for any currently valid tokens
2243
 
        for token in followers:
2244
 
            match = token.regexp.match(s)
2245
 
            if match is not None:
2246
 
                # Token found
2247
 
                if token.value is not None:
2248
 
                    # Value found, parse digits
2249
 
                    factor = int(match.group(1), 10)
2250
 
                    # Add to value so far
2251
 
                    value += factor * token.value
2252
 
                # Strip token from string
2253
 
                s = token.regexp.sub("", s, 1)
2254
 
                # Go to found token
2255
 
                found_token = token
2256
 
                # Set valid next tokens
2257
 
                followers = found_token.followers
2258
 
                break
2259
 
        else:
2260
 
            # No currently valid tokens were found
2261
 
            raise ValueError("Invalid RFC 3339 duration: {!r}"
2262
 
                             .format(duration))
2263
 
    # End token found
2264
 
    return value
2265
 
 
2266
 
 
2267
1583
def string_to_delta(interval):
2268
1584
    """Parse a string and return a datetime.timedelta
2269
1585
    
2280
1596
    >>> string_to_delta('5m 30s')
2281
1597
    datetime.timedelta(0, 330)
2282
1598
    """
2283
 
    
2284
 
    try:
2285
 
        return rfc3339_duration_to_delta(interval)
2286
 
    except ValueError:
2287
 
        pass
2288
 
    
2289
1599
    timevalue = datetime.timedelta(0)
2290
1600
    for s in interval.split():
2291
1601
        try:
2292
 
            suffix = s[-1]
 
1602
            suffix = unicode(s[-1])
2293
1603
            value = int(s[:-1])
2294
1604
            if suffix == "d":
2295
1605
                delta = datetime.timedelta(value)
2302
1612
            elif suffix == "w":
2303
1613
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2304
1614
            else:
2305
 
                raise ValueError("Unknown suffix {!r}".format(suffix))
2306
 
        except IndexError as e:
 
1615
                raise ValueError("Unknown suffix %r" % suffix)
 
1616
        except (ValueError, IndexError), e:
2307
1617
            raise ValueError(*(e.args))
2308
1618
        timevalue += delta
2309
1619
    return timevalue
2310
1620
 
2311
1621
 
 
1622
def if_nametoindex(interface):
 
1623
    """Call the C function if_nametoindex(), or equivalent
 
1624
    
 
1625
    Note: This function cannot accept a unicode string."""
 
1626
    global if_nametoindex
 
1627
    try:
 
1628
        if_nametoindex = (ctypes.cdll.LoadLibrary
 
1629
                          (ctypes.util.find_library("c"))
 
1630
                          .if_nametoindex)
 
1631
    except (OSError, AttributeError):
 
1632
        logger.warning("Doing if_nametoindex the hard way")
 
1633
        def if_nametoindex(interface):
 
1634
            "Get an interface index the hard way, i.e. using fcntl()"
 
1635
            SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
 
1636
            with contextlib.closing(socket.socket()) as s:
 
1637
                ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
 
1638
                                    struct.pack(str("16s16x"),
 
1639
                                                interface))
 
1640
            interface_index = struct.unpack(str("I"),
 
1641
                                            ifreq[16:20])[0]
 
1642
            return interface_index
 
1643
    return if_nametoindex(interface)
 
1644
 
 
1645
 
2312
1646
def daemon(nochdir = False, noclose = False):
2313
1647
    """See daemon(3).  Standard BSD Unix function.
2314
1648
    
2322
1656
        sys.exit()
2323
1657
    if not noclose:
2324
1658
        # Close all standard open file descriptors
2325
 
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
 
1659
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2326
1660
        if not stat.S_ISCHR(os.fstat(null).st_mode):
2327
1661
            raise OSError(errno.ENODEV,
2328
 
                          "{} not a character device"
2329
 
                          .format(os.devnull))
 
1662
                          "%s not a character device"
 
1663
                          % os.path.devnull)
2330
1664
        os.dup2(null, sys.stdin.fileno())
2331
1665
        os.dup2(null, sys.stdout.fileno())
2332
1666
        os.dup2(null, sys.stderr.fileno())
2341
1675
    
2342
1676
    parser = argparse.ArgumentParser()
2343
1677
    parser.add_argument("-v", "--version", action="version",
2344
 
                        version = "%(prog)s {}".format(version),
 
1678
                        version = "%%(prog)s %s" % version,
2345
1679
                        help="show version number and exit")
2346
1680
    parser.add_argument("-i", "--interface", metavar="IF",
2347
1681
                        help="Bind to interface IF")
2353
1687
                        help="Run self-test")
2354
1688
    parser.add_argument("--debug", action="store_true",
2355
1689
                        help="Debug mode; run in foreground and log"
2356
 
                        " to terminal", default=None)
 
1690
                        " to terminal")
2357
1691
    parser.add_argument("--debuglevel", metavar="LEVEL",
2358
1692
                        help="Debug level for stdout output")
2359
1693
    parser.add_argument("--priority", help="GnuTLS"
2366
1700
                        " files")
2367
1701
    parser.add_argument("--no-dbus", action="store_false",
2368
1702
                        dest="use_dbus", help="Do not provide D-Bus"
2369
 
                        " system bus interface", default=None)
 
1703
                        " system bus interface")
2370
1704
    parser.add_argument("--no-ipv6", action="store_false",
2371
 
                        dest="use_ipv6", help="Do not use IPv6",
2372
 
                        default=None)
2373
 
    parser.add_argument("--no-restore", action="store_false",
2374
 
                        dest="restore", help="Do not restore stored"
2375
 
                        " state", default=None)
2376
 
    parser.add_argument("--socket", type=int,
2377
 
                        help="Specify a file descriptor to a network"
2378
 
                        " socket to use instead of creating one")
2379
 
    parser.add_argument("--statedir", metavar="DIR",
2380
 
                        help="Directory to save/restore state in")
2381
 
    parser.add_argument("--foreground", action="store_true",
2382
 
                        help="Run in foreground", default=None)
2383
 
    parser.add_argument("--no-zeroconf", action="store_false",
2384
 
                        dest="zeroconf", help="Do not use Zeroconf",
2385
 
                        default=None)
2386
 
    
 
1705
                        dest="use_ipv6", help="Do not use IPv6")
2387
1706
    options = parser.parse_args()
2388
1707
    
2389
1708
    if options.check:
2390
1709
        import doctest
2391
 
        fail_count, test_count = doctest.testmod()
2392
 
        sys.exit(os.EX_OK if fail_count == 0 else 1)
 
1710
        doctest.testmod()
 
1711
        sys.exit()
2393
1712
    
2394
1713
    # Default values for config file for server-global settings
2395
1714
    server_defaults = { "interface": "",
2397
1716
                        "port": "",
2398
1717
                        "debug": "False",
2399
1718
                        "priority":
2400
 
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2401
 
                        ":+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",
 
1719
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
2402
1720
                        "servicename": "Mandos",
2403
1721
                        "use_dbus": "True",
2404
1722
                        "use_ipv6": "True",
2405
1723
                        "debuglevel": "",
2406
 
                        "restore": "True",
2407
 
                        "socket": "",
2408
 
                        "statedir": "/var/lib/mandos",
2409
 
                        "foreground": "False",
2410
 
                        "zeroconf": "True",
2411
 
                    }
 
1724
                        }
2412
1725
    
2413
1726
    # Parse config file for server-global settings
2414
1727
    server_config = configparser.SafeConfigParser(server_defaults)
2415
1728
    del server_defaults
2416
 
    server_config.read(os.path.join(options.configdir, "mandos.conf"))
 
1729
    server_config.read(os.path.join(options.configdir,
 
1730
                                    "mandos.conf"))
2417
1731
    # Convert the SafeConfigParser object to a dict
2418
1732
    server_settings = server_config.defaults()
2419
1733
    # Use the appropriate methods on the non-string config options
2420
 
    for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
 
1734
    for option in ("debug", "use_dbus", "use_ipv6"):
2421
1735
        server_settings[option] = server_config.getboolean("DEFAULT",
2422
1736
                                                           option)
2423
1737
    if server_settings["port"]:
2424
1738
        server_settings["port"] = server_config.getint("DEFAULT",
2425
1739
                                                       "port")
2426
 
    if server_settings["socket"]:
2427
 
        server_settings["socket"] = server_config.getint("DEFAULT",
2428
 
                                                         "socket")
2429
 
        # Later, stdin will, and stdout and stderr might, be dup'ed
2430
 
        # over with an opened os.devnull.  But we don't want this to
2431
 
        # happen with a supplied network socket.
2432
 
        if 0 <= server_settings["socket"] <= 2:
2433
 
            server_settings["socket"] = os.dup(server_settings
2434
 
                                               ["socket"])
2435
1740
    del server_config
2436
1741
    
2437
1742
    # Override the settings from the config file with command line
2438
1743
    # options, if set.
2439
1744
    for option in ("interface", "address", "port", "debug",
2440
 
                   "priority", "servicename", "configdir", "use_dbus",
2441
 
                   "use_ipv6", "debuglevel", "restore", "statedir",
2442
 
                   "socket", "foreground", "zeroconf"):
 
1745
                   "priority", "servicename", "configdir",
 
1746
                   "use_dbus", "use_ipv6", "debuglevel"):
2443
1747
        value = getattr(options, option)
2444
1748
        if value is not None:
2445
1749
            server_settings[option] = value
2446
1750
    del options
2447
1751
    # Force all strings to be unicode
2448
1752
    for option in server_settings.keys():
2449
 
        if isinstance(server_settings[option], bytes):
2450
 
            server_settings[option] = (server_settings[option]
2451
 
                                       .decode("utf-8"))
2452
 
    # Force all boolean options to be boolean
2453
 
    for option in ("debug", "use_dbus", "use_ipv6", "restore",
2454
 
                   "foreground", "zeroconf"):
2455
 
        server_settings[option] = bool(server_settings[option])
2456
 
    # Debug implies foreground
2457
 
    if server_settings["debug"]:
2458
 
        server_settings["foreground"] = True
 
1753
        if type(server_settings[option]) is str:
 
1754
            server_settings[option] = unicode(server_settings[option])
2459
1755
    # Now we have our good server settings in "server_settings"
2460
1756
    
2461
1757
    ##################################################################
2462
1758
    
2463
 
    if (not server_settings["zeroconf"]
2464
 
        and not (server_settings["port"]
2465
 
                 or server_settings["socket"] != "")):
2466
 
        parser.error("Needs port or socket to work without Zeroconf")
2467
 
    
2468
1759
    # For convenience
2469
1760
    debug = server_settings["debug"]
2470
1761
    debuglevel = server_settings["debuglevel"]
2471
1762
    use_dbus = server_settings["use_dbus"]
2472
1763
    use_ipv6 = server_settings["use_ipv6"]
2473
 
    stored_state_path = os.path.join(server_settings["statedir"],
2474
 
                                     stored_state_file)
2475
 
    foreground = server_settings["foreground"]
2476
 
    zeroconf = server_settings["zeroconf"]
2477
 
    
2478
 
    if debug:
2479
 
        initlogger(debug, logging.DEBUG)
2480
 
    else:
2481
 
        if not debuglevel:
2482
 
            initlogger(debug)
2483
 
        else:
2484
 
            level = getattr(logging, debuglevel.upper())
2485
 
            initlogger(debug, level)
2486
 
    
 
1764
 
2487
1765
    if server_settings["servicename"] != "Mandos":
2488
 
        syslogger.setFormatter(
2489
 
            logging.Formatter('Mandos ({}) [%(process)d]:'
2490
 
                              ' %(levelname)s: %(message)s'.format(
2491
 
                                  server_settings["servicename"])))
 
1766
        syslogger.setFormatter(logging.Formatter
 
1767
                               ('Mandos (%s) [%%(process)d]:'
 
1768
                                ' %%(levelname)s: %%(message)s'
 
1769
                                % server_settings["servicename"]))
2492
1770
    
2493
1771
    # Parse config file with clients
2494
 
    client_config = configparser.SafeConfigParser(Client
2495
 
                                                  .client_defaults)
 
1772
    client_defaults = { "timeout": "1h",
 
1773
                        "interval": "5m",
 
1774
                        "checker": "fping -q -- %%(host)s",
 
1775
                        "host": "",
 
1776
                        "approval_delay": "0s",
 
1777
                        "approval_duration": "1s",
 
1778
                        }
 
1779
    client_config = configparser.SafeConfigParser(client_defaults)
2496
1780
    client_config.read(os.path.join(server_settings["configdir"],
2497
1781
                                    "clients.conf"))
2498
1782
    
2499
1783
    global mandos_dbus_service
2500
1784
    mandos_dbus_service = None
2501
1785
    
2502
 
    socketfd = None
2503
 
    if server_settings["socket"] != "":
2504
 
        socketfd = server_settings["socket"]
2505
 
    tcp_server = MandosServer(
2506
 
        (server_settings["address"], server_settings["port"]),
2507
 
        ClientHandler,
2508
 
        interface=(server_settings["interface"] or None),
2509
 
        use_ipv6=use_ipv6,
2510
 
        gnutls_priority=server_settings["priority"],
2511
 
        use_dbus=use_dbus,
2512
 
        socketfd=socketfd)
2513
 
    if not foreground:
2514
 
        pidfilename = "/run/mandos.pid"
2515
 
        if not os.path.isdir("/run/."):
2516
 
            pidfilename = "/var/run/mandos.pid"
2517
 
        pidfile = None
 
1786
    tcp_server = MandosServer((server_settings["address"],
 
1787
                               server_settings["port"]),
 
1788
                              ClientHandler,
 
1789
                              interface=(server_settings["interface"]
 
1790
                                         or None),
 
1791
                              use_ipv6=use_ipv6,
 
1792
                              gnutls_priority=
 
1793
                              server_settings["priority"],
 
1794
                              use_dbus=use_dbus)
 
1795
    if not debug:
 
1796
        pidfilename = "/var/run/mandos.pid"
2518
1797
        try:
2519
 
            pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
2520
 
        except IOError as e:
2521
 
            logger.error("Could not open file %r", pidfilename,
2522
 
                         exc_info=e)
 
1798
            pidfile = open(pidfilename, "w")
 
1799
        except IOError:
 
1800
            logger.error("Could not open file %r", pidfilename)
2523
1801
    
2524
 
    for name in ("_mandos", "mandos", "nobody"):
 
1802
    try:
 
1803
        uid = pwd.getpwnam("_mandos").pw_uid
 
1804
        gid = pwd.getpwnam("_mandos").pw_gid
 
1805
    except KeyError:
2525
1806
        try:
2526
 
            uid = pwd.getpwnam(name).pw_uid
2527
 
            gid = pwd.getpwnam(name).pw_gid
2528
 
            break
 
1807
            uid = pwd.getpwnam("mandos").pw_uid
 
1808
            gid = pwd.getpwnam("mandos").pw_gid
2529
1809
        except KeyError:
2530
 
            continue
2531
 
    else:
2532
 
        uid = 65534
2533
 
        gid = 65534
 
1810
            try:
 
1811
                uid = pwd.getpwnam("nobody").pw_uid
 
1812
                gid = pwd.getpwnam("nobody").pw_gid
 
1813
            except KeyError:
 
1814
                uid = 65534
 
1815
                gid = 65534
2534
1816
    try:
2535
1817
        os.setgid(gid)
2536
1818
        os.setuid(uid)
2537
 
    except OSError as error:
2538
 
        if error.errno != errno.EPERM:
2539
 
            raise
 
1819
    except OSError, error:
 
1820
        if error[0] != errno.EPERM:
 
1821
            raise error
2540
1822
    
 
1823
    if not debug and not debuglevel:
 
1824
        syslogger.setLevel(logging.WARNING)
 
1825
        console.setLevel(logging.WARNING)
 
1826
    if debuglevel:
 
1827
        level = getattr(logging, debuglevel.upper())
 
1828
        syslogger.setLevel(level)
 
1829
        console.setLevel(level)
 
1830
 
2541
1831
    if debug:
2542
1832
        # Enable all possible GnuTLS debugging
2543
1833
        
2549
1839
        def debug_gnutls(level, string):
2550
1840
            logger.debug("GnuTLS: %s", string[:-1])
2551
1841
        
2552
 
        gnutls.library.functions.gnutls_global_set_log_function(
2553
 
            debug_gnutls)
 
1842
        (gnutls.library.functions
 
1843
         .gnutls_global_set_log_function(debug_gnutls))
2554
1844
        
2555
1845
        # Redirect stdin so all checkers get /dev/null
2556
 
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
 
1846
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2557
1847
        os.dup2(null, sys.stdin.fileno())
2558
1848
        if null > 2:
2559
1849
            os.close(null)
 
1850
    else:
 
1851
        # No console logging
 
1852
        logger.removeHandler(console)
2560
1853
    
2561
1854
    # Need to fork before connecting to D-Bus
2562
 
    if not foreground:
 
1855
    if not debug:
2563
1856
        # Close all input and output, do double fork, etc.
2564
1857
        daemon()
2565
1858
    
2566
 
    # multiprocessing will use threads, so before we use gobject we
2567
 
    # need to inform gobject that threads will be used.
2568
 
    gobject.threads_init()
2569
 
    
2570
1859
    global main_loop
2571
1860
    # From the Avahi example code
2572
 
    DBusGMainLoop(set_as_default=True)
 
1861
    DBusGMainLoop(set_as_default=True )
2573
1862
    main_loop = gobject.MainLoop()
2574
1863
    bus = dbus.SystemBus()
2575
1864
    # End of Avahi example code
2576
1865
    if use_dbus:
2577
1866
        try:
2578
 
            bus_name = dbus.service.BusName("se.recompile.Mandos",
2579
 
                                            bus,
2580
 
                                            do_not_queue=True)
2581
 
            old_bus_name = dbus.service.BusName(
2582
 
                "se.bsnet.fukt.Mandos", bus,
2583
 
                do_not_queue=True)
2584
 
        except dbus.exceptions.DBusException as e:
2585
 
            logger.error("Disabling D-Bus:", exc_info=e)
 
1867
            bus_name = dbus.service.BusName("se.bsnet.fukt.Mandos",
 
1868
                                            bus, do_not_queue=True)
 
1869
        except dbus.exceptions.NameExistsException, e:
 
1870
            logger.error(unicode(e) + ", disabling D-Bus")
2586
1871
            use_dbus = False
2587
1872
            server_settings["use_dbus"] = False
2588
1873
            tcp_server.use_dbus = False
2589
 
    if zeroconf:
2590
 
        protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2591
 
        service = AvahiServiceToSyslog(
2592
 
            name = server_settings["servicename"],
2593
 
            servicetype = "_mandos._tcp",
2594
 
            protocol = protocol,
2595
 
            bus = bus)
2596
 
        if server_settings["interface"]:
2597
 
            service.interface = if_nametoindex(
2598
 
                server_settings["interface"].encode("utf-8"))
 
1874
    protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
 
1875
    service = AvahiService(name = server_settings["servicename"],
 
1876
                           servicetype = "_mandos._tcp",
 
1877
                           protocol = protocol, bus = bus)
 
1878
    if server_settings["interface"]:
 
1879
        service.interface = (if_nametoindex
 
1880
                             (str(server_settings["interface"])))
2599
1881
    
2600
1882
    global multiprocessing_manager
2601
1883
    multiprocessing_manager = multiprocessing.Manager()
2603
1885
    client_class = Client
2604
1886
    if use_dbus:
2605
1887
        client_class = functools.partial(ClientDBus, bus = bus)
2606
 
    
2607
 
    client_settings = Client.config_parser(client_config)
2608
 
    old_client_settings = {}
2609
 
    clients_data = {}
2610
 
    
2611
 
    # This is used to redirect stdout and stderr for checker processes
2612
 
    global wnull
2613
 
    wnull = open(os.devnull, "w") # A writable /dev/null
2614
 
    # Only used if server is running in foreground but not in debug
2615
 
    # mode
2616
 
    if debug or not foreground:
2617
 
        wnull.close()
2618
 
    
2619
 
    # Get client data and settings from last running state.
2620
 
    if server_settings["restore"]:
2621
 
        try:
2622
 
            with open(stored_state_path, "rb") as stored_state:
2623
 
                clients_data, old_client_settings = pickle.load(
2624
 
                    stored_state)
2625
 
            os.remove(stored_state_path)
2626
 
        except IOError as e:
2627
 
            if e.errno == errno.ENOENT:
2628
 
                logger.warning("Could not load persistent state:"
2629
 
                               " {}".format(os.strerror(e.errno)))
2630
 
            else:
2631
 
                logger.critical("Could not load persistent state:",
2632
 
                                exc_info=e)
2633
 
                raise
2634
 
        except EOFError as e:
2635
 
            logger.warning("Could not load persistent state: "
2636
 
                           "EOFError:",
2637
 
                           exc_info=e)
2638
 
    
2639
 
    with PGPEngine() as pgp:
2640
 
        for client_name, client in clients_data.items():
2641
 
            # Skip removed clients
2642
 
            if client_name not in client_settings:
2643
 
                continue
2644
 
            
2645
 
            # Decide which value to use after restoring saved state.
2646
 
            # We have three different values: Old config file,
2647
 
            # new config file, and saved state.
2648
 
            # New config value takes precedence if it differs from old
2649
 
            # config value, otherwise use saved state.
2650
 
            for name, value in client_settings[client_name].items():
2651
 
                try:
2652
 
                    # For each value in new config, check if it
2653
 
                    # differs from the old config value (Except for
2654
 
                    # the "secret" attribute)
2655
 
                    if (name != "secret"
2656
 
                        and (value !=
2657
 
                             old_client_settings[client_name][name])):
2658
 
                        client[name] = value
2659
 
                except KeyError:
2660
 
                    pass
2661
 
            
2662
 
            # Clients who has passed its expire date can still be
2663
 
            # enabled if its last checker was successful.  Clients
2664
 
            # whose checker succeeded before we stored its state is
2665
 
            # assumed to have successfully run all checkers during
2666
 
            # downtime.
2667
 
            if client["enabled"]:
2668
 
                if datetime.datetime.utcnow() >= client["expires"]:
2669
 
                    if not client["last_checked_ok"]:
2670
 
                        logger.warning(
2671
 
                            "disabling client {} - Client never "
2672
 
                            "performed a successful checker".format(
2673
 
                                client_name))
2674
 
                        client["enabled"] = False
2675
 
                    elif client["last_checker_status"] != 0:
2676
 
                        logger.warning(
2677
 
                            "disabling client {} - Client last"
2678
 
                            " checker failed with error code"
2679
 
                            " {}".format(
2680
 
                                client_name,
2681
 
                                client["last_checker_status"]))
2682
 
                        client["enabled"] = False
2683
 
                    else:
2684
 
                        client["expires"] = (
2685
 
                            datetime.datetime.utcnow()
2686
 
                            + client["timeout"])
2687
 
                        logger.debug("Last checker succeeded,"
2688
 
                                     " keeping {} enabled".format(
2689
 
                                         client_name))
 
1888
    def client_config_items(config, section):
 
1889
        special_settings = {
 
1890
            "approved_by_default":
 
1891
                lambda: config.getboolean(section,
 
1892
                                          "approved_by_default"),
 
1893
            }
 
1894
        for name, value in config.items(section):
2690
1895
            try:
2691
 
                client["secret"] = pgp.decrypt(
2692
 
                    client["encrypted_secret"],
2693
 
                    client_settings[client_name]["secret"])
2694
 
            except PGPError:
2695
 
                # If decryption fails, we use secret from new settings
2696
 
                logger.debug("Failed to decrypt {} old secret".format(
2697
 
                    client_name))
2698
 
                client["secret"] = (client_settings[client_name]
2699
 
                                    ["secret"])
2700
 
    
2701
 
    # Add/remove clients based on new changes made to config
2702
 
    for client_name in (set(old_client_settings)
2703
 
                        - set(client_settings)):
2704
 
        del clients_data[client_name]
2705
 
    for client_name in (set(client_settings)
2706
 
                        - set(old_client_settings)):
2707
 
        clients_data[client_name] = client_settings[client_name]
2708
 
    
2709
 
    # Create all client objects
2710
 
    for client_name, client in clients_data.items():
2711
 
        tcp_server.clients[client_name] = client_class(
2712
 
            name = client_name,
2713
 
            settings = client,
2714
 
            server_settings = server_settings)
2715
 
    
 
1896
                yield (name, special_settings[name]())
 
1897
            except KeyError:
 
1898
                yield (name, value)
 
1899
    
 
1900
    tcp_server.clients.update(set(
 
1901
            client_class(name = section,
 
1902
                         config= dict(client_config_items(
 
1903
                        client_config, section)))
 
1904
            for section in client_config.sections()))
2716
1905
    if not tcp_server.clients:
2717
1906
        logger.warning("No clients defined")
2718
 
    
2719
 
    if not foreground:
2720
 
        if pidfile is not None:
2721
 
            pid = os.getpid()
2722
 
            try:
2723
 
                with pidfile:
2724
 
                    print(pid, file=pidfile)
2725
 
            except IOError:
2726
 
                logger.error("Could not write to file %r with PID %d",
2727
 
                             pidfilename, pid)
2728
 
        del pidfile
 
1907
        
 
1908
    if not debug:
 
1909
        try:
 
1910
            with pidfile:
 
1911
                pid = os.getpid()
 
1912
                pidfile.write(str(pid) + "\n".encode("utf-8"))
 
1913
            del pidfile
 
1914
        except IOError:
 
1915
            logger.error("Could not write to file %r with PID %d",
 
1916
                         pidfilename, pid)
 
1917
        except NameError:
 
1918
            # "pidfile" was never created
 
1919
            pass
2729
1920
        del pidfilename
2730
 
    
 
1921
        
 
1922
        signal.signal(signal.SIGINT, signal.SIG_IGN)
 
1923
 
2731
1924
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2732
1925
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2733
1926
    
2734
1927
    if use_dbus:
2735
 
        
2736
 
        @alternate_dbus_interfaces(
2737
 
            { "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
2738
 
        class MandosDBusService(DBusObjectWithProperties):
 
1928
        class MandosDBusService(dbus.service.Object):
2739
1929
            """A D-Bus proxy object"""
2740
 
            
2741
1930
            def __init__(self):
2742
1931
                dbus.service.Object.__init__(self, bus, "/")
2743
 
            
2744
 
            _interface = "se.recompile.Mandos"
2745
 
            
2746
 
            @dbus_interface_annotations(_interface)
2747
 
            def _foo(self):
2748
 
                return {
2749
 
                    "org.freedesktop.DBus.Property.EmitsChangedSignal":
2750
 
                    "false" }
 
1932
            _interface = "se.bsnet.fukt.Mandos"
2751
1933
            
2752
1934
            @dbus.service.signal(_interface, signature="o")
2753
1935
            def ClientAdded(self, objpath):
2767
1949
            @dbus.service.method(_interface, out_signature="ao")
2768
1950
            def GetAllClients(self):
2769
1951
                "D-Bus method"
2770
 
                return dbus.Array(c.dbus_object_path for c in
2771
 
                                  tcp_server.clients.itervalues())
 
1952
                return dbus.Array(c.dbus_object_path
 
1953
                                  for c in tcp_server.clients)
2772
1954
            
2773
1955
            @dbus.service.method(_interface,
2774
1956
                                 out_signature="a{oa{sv}}")
2775
1957
            def GetAllClientsWithProperties(self):
2776
1958
                "D-Bus method"
2777
1959
                return dbus.Dictionary(
2778
 
                    { c.dbus_object_path: c.GetAll("")
2779
 
                      for c in tcp_server.clients.itervalues() },
 
1960
                    ((c.dbus_object_path, c.GetAll(""))
 
1961
                     for c in tcp_server.clients),
2780
1962
                    signature="oa{sv}")
2781
1963
            
2782
1964
            @dbus.service.method(_interface, in_signature="o")
2783
1965
            def RemoveClient(self, object_path):
2784
1966
                "D-Bus method"
2785
 
                for c in tcp_server.clients.itervalues():
 
1967
                for c in tcp_server.clients:
2786
1968
                    if c.dbus_object_path == object_path:
2787
 
                        del tcp_server.clients[c.name]
 
1969
                        tcp_server.clients.remove(c)
2788
1970
                        c.remove_from_connection()
2789
1971
                        # Don't signal anything except ClientRemoved
2790
1972
                        c.disable(quiet=True)
2799
1981
    
2800
1982
    def cleanup():
2801
1983
        "Cleanup function; run on exit"
2802
 
        if zeroconf:
2803
 
            service.cleanup()
2804
 
        
2805
 
        multiprocessing.active_children()
2806
 
        wnull.close()
2807
 
        if not (tcp_server.clients or client_settings):
2808
 
            return
2809
 
        
2810
 
        # Store client before exiting. Secrets are encrypted with key
2811
 
        # based on what config file has. If config file is
2812
 
        # removed/edited, old secret will thus be unrecovable.
2813
 
        clients = {}
2814
 
        with PGPEngine() as pgp:
2815
 
            for client in tcp_server.clients.itervalues():
2816
 
                key = client_settings[client.name]["secret"]
2817
 
                client.encrypted_secret = pgp.encrypt(client.secret,
2818
 
                                                      key)
2819
 
                client_dict = {}
2820
 
                
2821
 
                # A list of attributes that can not be pickled
2822
 
                # + secret.
2823
 
                exclude = { "bus", "changedstate", "secret",
2824
 
                            "checker", "server_settings" }
2825
 
                for name, typ in inspect.getmembers(dbus.service
2826
 
                                                    .Object):
2827
 
                    exclude.add(name)
2828
 
                
2829
 
                client_dict["encrypted_secret"] = (client
2830
 
                                                   .encrypted_secret)
2831
 
                for attr in client.client_structure:
2832
 
                    if attr not in exclude:
2833
 
                        client_dict[attr] = getattr(client, attr)
2834
 
                
2835
 
                clients[client.name] = client_dict
2836
 
                del client_settings[client.name]["secret"]
2837
 
        
2838
 
        try:
2839
 
            with tempfile.NamedTemporaryFile(
2840
 
                    mode='wb',
2841
 
                    suffix=".pickle",
2842
 
                    prefix='clients-',
2843
 
                    dir=os.path.dirname(stored_state_path),
2844
 
                    delete=False) as stored_state:
2845
 
                pickle.dump((clients, client_settings), stored_state)
2846
 
                tempname = stored_state.name
2847
 
            os.rename(tempname, stored_state_path)
2848
 
        except (IOError, OSError) as e:
2849
 
            if not debug:
2850
 
                try:
2851
 
                    os.remove(tempname)
2852
 
                except NameError:
2853
 
                    pass
2854
 
            if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
2855
 
                logger.warning("Could not save persistent state: {}"
2856
 
                               .format(os.strerror(e.errno)))
2857
 
            else:
2858
 
                logger.warning("Could not save persistent state:",
2859
 
                               exc_info=e)
2860
 
                raise
2861
 
        
2862
 
        # Delete all clients, and settings from config
 
1984
        service.cleanup()
 
1985
        
2863
1986
        while tcp_server.clients:
2864
 
            name, client = tcp_server.clients.popitem()
 
1987
            client = tcp_server.clients.pop()
2865
1988
            if use_dbus:
2866
1989
                client.remove_from_connection()
 
1990
            client.disable_hook = None
2867
1991
            # Don't signal anything except ClientRemoved
2868
1992
            client.disable(quiet=True)
2869
1993
            if use_dbus:
2870
1994
                # Emit D-Bus signal
2871
 
                mandos_dbus_service.ClientRemoved(
2872
 
                    client.dbus_object_path, client.name)
2873
 
        client_settings.clear()
 
1995
                mandos_dbus_service.ClientRemoved(client.dbus_object_path,
 
1996
                                                  client.name)
2874
1997
    
2875
1998
    atexit.register(cleanup)
2876
1999
    
2877
 
    for client in tcp_server.clients.itervalues():
 
2000
    for client in tcp_server.clients:
2878
2001
        if use_dbus:
2879
2002
            # Emit D-Bus signal
2880
2003
            mandos_dbus_service.ClientAdded(client.dbus_object_path)
2881
 
        # Need to initiate checking of clients
2882
 
        if client.enabled:
2883
 
            client.init_checker()
 
2004
        client.enable()
2884
2005
    
2885
2006
    tcp_server.enable()
2886
2007
    tcp_server.server_activate()
2887
2008
    
2888
2009
    # Find out what port we got
2889
 
    if zeroconf:
2890
 
        service.port = tcp_server.socket.getsockname()[1]
 
2010
    service.port = tcp_server.socket.getsockname()[1]
2891
2011
    if use_ipv6:
2892
2012
        logger.info("Now listening on address %r, port %d,"
2893
 
                    " flowinfo %d, scope_id %d",
2894
 
                    *tcp_server.socket.getsockname())
 
2013
                    " flowinfo %d, scope_id %d"
 
2014
                    % tcp_server.socket.getsockname())
2895
2015
    else:                       # IPv4
2896
 
        logger.info("Now listening on address %r, port %d",
2897
 
                    *tcp_server.socket.getsockname())
 
2016
        logger.info("Now listening on address %r, port %d"
 
2017
                    % tcp_server.socket.getsockname())
2898
2018
    
2899
2019
    #service.interface = tcp_server.socket.getsockname()[3]
2900
2020
    
2901
2021
    try:
2902
 
        if zeroconf:
2903
 
            # From the Avahi example code
2904
 
            try:
2905
 
                service.activate()
2906
 
            except dbus.exceptions.DBusException as error:
2907
 
                logger.critical("D-Bus Exception", exc_info=error)
2908
 
                cleanup()
2909
 
                sys.exit(1)
2910
 
            # End of Avahi example code
 
2022
        # From the Avahi example code
 
2023
        try:
 
2024
            service.activate()
 
2025
        except dbus.exceptions.DBusException, error:
 
2026
            logger.critical("DBusException: %s", error)
 
2027
            cleanup()
 
2028
            sys.exit(1)
 
2029
        # End of Avahi example code
2911
2030
        
2912
2031
        gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2913
2032
                             lambda *args, **kwargs:
2916
2035
        
2917
2036
        logger.debug("Starting main loop")
2918
2037
        main_loop.run()
2919
 
    except AvahiError as error:
2920
 
        logger.critical("Avahi Error", exc_info=error)
 
2038
    except AvahiError, error:
 
2039
        logger.critical("AvahiError: %s", error)
2921
2040
        cleanup()
2922
2041
        sys.exit(1)
2923
2042
    except KeyboardInterrupt:
2928
2047
    # Must run before the D-Bus bus name gets deregistered
2929
2048
    cleanup()
2930
2049
 
2931
 
 
2932
2050
if __name__ == '__main__':
2933
2051
    main()