/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2013-09-29 15:52:19 UTC
  • mto: (237.7.272 trunk)
  • mto: This revision was merged to the branch mainline in revision 303.
  • Revision ID: teddy@recompile.se-20130929155219-rer4z6583z1qu7kj
* debian/mandos-client.README.Debian: Update Linux documentation link.
* mandos-keygen: Change default key and subkey type to RSA and default
                 key length to 4096 bits.

Show diffs side-by-side

added added

removed removed

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