/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2010-06-19 00:37:04 UTC
  • mto: (24.1.149 mandos)
  • mto: This revision was merged to the branch mainline in revision 417.
  • Revision ID: teddy@fukt.bsnet.se-20100619003704-vpicvssvv1ktg2om
* mandos (ClientHandler.handle): Set up the GnuTLS session object
                                 before reading the protocol number.
 (ClientHandler.handle/ProxyObject): New.

Show diffs side-by-side

added added

removed removed

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