/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2014-07-14 21:41:08 UTC
  • Revision ID: teddy@recompile.se-20140714214108-awg7u6gaiy7d40dz
mandos-monitor: New "verbose" mode to see less important log messages.

* mandos-monitor (MandosClientWidget.__init__): Log client creation.
  (MandosClientWidget.checker_completed): Log a successful checker.
  (MandosClientWidget.checker_started): Log starting of a checker.
  (UserInterface.__init__): New optional "log_level" argument.
  (UserInterface.log_message, UserInterface.log_message_raw): Take
                                                              optional
                                                              "level"
                                                              arg.
  (UserInterface.toggle_log_display): Log visibility change.
  (UserInterface.change_log_display): Log wrap mode change.
  (UserInterface.process_input): Show new "v" key in help message and
                                 process "v" key if pressed.
* mandos-monitor.xml (KEYS): Document new "v" key.

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