/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: 2012-04-24 06:55:34 UTC
  • Revision ID: teddy@recompile.se-20120424065534-n1jqfth9odw3l1jr
* network-hooks.d/bridge: Move "start" and "stop" commands to separate
                          functions.
* network-hooks.d/openvpn: - '' -
* network-hooks.d/wireless: - '' -

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