/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2013-12-31 16:02:18 UTC
  • mto: (237.7.272 trunk)
  • mto: This revision was merged to the branch mainline in revision 307.
  • Revision ID: teddy@recompile.se-20131231160218-plmmb0o0iifkd5l2
Specify BusName in systemd service file.

* mandos.service (BusName): Uncommented.

Show diffs side-by-side

added added

removed removed

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