/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-25 23:32:04 UTC
  • mto: This revision was merged to the branch mainline in revision 724.
  • Revision ID: teddy@recompile.se-20140725233204-arvlsqrpfkfcwo10
Use the new auto-numbered "{}" syntax for the .format() string method.

* mandos (AvahiService.entry_group_state_changed): Use auto-numbering
                                                   for .format().
  (AvahiServiceToSyslog.rename): - '' -
  (Client.config_parser): - '' -
  (dbus_service_property): - '' -
  (DBusObjectWithProperties._is_dbus_thing): - '' -
  (DBusObjectWithProperties.Set): - '' -
  (alternate_dbus_interfaces/wrapper): - '' -
  (ClientDBus.notifychangeproperty): - '' -
  (string_to_delta): - '' -
  (daemon): - '' -
  (main): - '' -
  (main/cleanup): - '' -
* mandos-ctl (milliseconds_to_string): - '' -
  (main): - '' -
* mandos-monitor (MandosClientWidget.__init__): - '' -
  (MandosClientWidget.checker_completed): - '' -
  (MandosClientWidget.update): - '' -
  (UserInterface.client_not_found): - '' -
  (UserInterface.log_message): - '' -
  (UserInterface.toggle_log_display): - '' -
  (UserInterface.change_log_display): - '' -
  (UserInterface.find_and_remove_client): - '' -

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
#!/usr/bin/python
 
1
#!/usr/bin/python2.7
2
2
# -*- mode: python; coding: utf-8 -*-
3
3
4
4
# Mandos server - give out binary blobs to connecting clients.
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.7"
 
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 = self.server.GetAlternativeServiceName(self.name)
161
 
        logger.info(u"Changing Zeroconf service name to %r ...",
162
 
                    unicode(self.name))
163
 
        syslogger.setFormatter(logging.Formatter
164
 
                               (u'Mandos (%s) [%%(process)d]:'
165
 
                                u' %%(levelname)s: %%(message)s'
166
 
                                % self.name))
 
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 ...",
 
288
                    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: {!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 ({}) [%(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 {}"
 
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.items():
 
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
 
            #XXX Need to allow secret on demand!
308
 
            raise TypeError(u"No secret or secfile for client %s"
309
 
                            % self.name)
310
 
        self.host = config.get(u"host", u"")
311
 
        self.created = datetime.datetime.utcnow()
312
 
        self.enabled = False
313
 
        self.last_enabled = None
314
 
        self.last_checked_ok = None
315
 
        self.timeout = string_to_delta(config[u"timeout"])
316
 
        self.interval = string_to_delta(config[u"interval"])
317
 
        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
318
561
        self.checker = None
319
562
        self.checker_initiator_tag = None
320
563
        self.disable_initiator_tag = None
321
564
        self.checker_callback_tag = None
322
 
        self.checker_command = config[u"checker"]
323
565
        self.current_checker_command = None
324
 
        self.last_connect = None
325
 
        self._approved = None
326
 
        self.approved_by_default = config.get(u"approved_by_default",
327
 
                                              True)
 
566
        self.approved = None
328
567
        self.approvals_pending = 0
329
 
        self.approved_delay = string_to_delta(
330
 
            config[u"approved_delay"])
331
 
        self.approved_duration = string_to_delta(
332
 
            config[u"approved_duration"])
333
 
        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)
334
582
    
 
583
    # Send notice to process children that client state has changed
335
584
    def send_changedstate(self):
336
 
        self.changedstate.acquire()
337
 
        self.changedstate.notify_all()
338
 
        self.changedstate.release()
339
 
        
 
585
        with self.changedstate:
 
586
            self.changedstate.notify_all()
 
587
    
340
588
    def enable(self):
341
589
        """Start this client's checker and timeout hooks"""
342
 
        if getattr(self, u"enabled", False):
 
590
        if getattr(self, "enabled", False):
343
591
            # Already enabled
344
592
            return
345
 
        self.send_changedstate()
 
593
        self.expires = datetime.datetime.utcnow() + self.timeout
 
594
        self.enabled = True
346
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):
347
623
        # Schedule a new checker to be started an 'interval' from now,
348
624
        # and every interval from then on.
 
625
        if self.checker_initiator_tag is not None:
 
626
            gobject.source_remove(self.checker_initiator_tag)
349
627
        self.checker_initiator_tag = (gobject.timeout_add
350
628
                                      (self.interval_milliseconds(),
351
629
                                       self.start_checker))
352
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)
353
633
        self.disable_initiator_tag = (gobject.timeout_add
354
634
                                   (self.timeout_milliseconds(),
355
635
                                    self.disable))
356
 
        self.enabled = True
357
636
        # Also start a new checker *right now*.
358
637
        self.start_checker()
359
638
    
360
 
    def disable(self, quiet=True):
361
 
        """Disable this client."""
362
 
        if not getattr(self, "enabled", False):
363
 
            return False
364
 
        if not quiet:
365
 
            self.send_changedstate()
366
 
        if not quiet:
367
 
            logger.info(u"Disabling client %s", self.name)
368
 
        if getattr(self, u"disable_initiator_tag", False):
369
 
            gobject.source_remove(self.disable_initiator_tag)
370
 
            self.disable_initiator_tag = None
371
 
        if getattr(self, u"checker_initiator_tag", False):
372
 
            gobject.source_remove(self.checker_initiator_tag)
373
 
            self.checker_initiator_tag = None
374
 
        self.stop_checker()
375
 
        if self.disable_hook:
376
 
            self.disable_hook(self)
377
 
        self.enabled = False
378
 
        # Do not run this again if called by a gobject.timeout_add
379
 
        return False
380
 
    
381
 
    def __del__(self):
382
 
        self.disable_hook = None
383
 
        self.disable()
384
 
    
385
639
    def checker_callback(self, pid, condition, command):
386
640
        """The checker has completed, so take appropriate actions."""
387
641
        self.checker_callback_tag = None
388
642
        self.checker = None
389
643
        if os.WIFEXITED(condition):
390
 
            exitstatus = os.WEXITSTATUS(condition)
391
 
            if exitstatus == 0:
392
 
                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",
393
647
                            vars(self))
394
648
                self.checked_ok()
395
649
            else:
396
 
                logger.info(u"Checker for %(name)s failed",
 
650
                logger.info("Checker for %(name)s failed",
397
651
                            vars(self))
398
652
        else:
399
 
            logger.warning(u"Checker for %(name)s crashed?",
 
653
            self.last_checker_status = -1
 
654
            logger.warning("Checker for %(name)s crashed?",
400
655
                           vars(self))
401
656
    
402
657
    def checked_ok(self):
403
 
        """Bump up the timeout for this client.
404
 
        
405
 
        This should only be called when the client has been seen,
406
 
        alive and well.
407
 
        """
 
658
        """Assert that the client has been seen, alive and well."""
408
659
        self.last_checked_ok = datetime.datetime.utcnow()
409
 
        gobject.source_remove(self.disable_initiator_tag)
410
 
        self.disable_initiator_tag = (gobject.timeout_add
411
 
                                      (self.timeout_milliseconds(),
412
 
                                       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()
413
678
    
414
679
    def start_checker(self):
415
680
        """Start a new checker subprocess if one is not running.
417
682
        If a checker already exists, leave it running and do
418
683
        nothing."""
419
684
        # The reason for not killing a running checker is that if we
420
 
        # did that, then if a checker (for some reason) started
421
 
        # running slowly and taking more than 'interval' time, the
422
 
        # client would inevitably timeout, since no checker would get
423
 
        # 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
424
689
        # checkers alone, the checker would have to take more time
425
690
        # than 'timeout' for the client to be disabled, which is as it
426
691
        # should be.
428
693
        # If a checker exists, make sure it is not a zombie
429
694
        try:
430
695
            pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
431
 
        except (AttributeError, OSError), error:
432
 
            if (isinstance(error, OSError)
433
 
                and error.errno != errno.ECHILD):
434
 
                raise error
 
696
        except AttributeError:
 
697
            pass
 
698
        except OSError as error:
 
699
            if error.errno != errno.ECHILD:
 
700
                raise
435
701
        else:
436
702
            if pid:
437
 
                logger.warning(u"Checker was a zombie")
 
703
                logger.warning("Checker was a zombie")
438
704
                gobject.source_remove(self.checker_callback_tag)
439
705
                self.checker_callback(pid, status,
440
706
                                      self.current_checker_command)
441
707
        # Start a new checker if needed
442
708
        if self.checker is None:
 
709
            # Escape attributes for the shell
 
710
            escaped_attrs = { attr:
 
711
                                  re.escape(unicode(getattr(self,
 
712
                                                            attr)))
 
713
                              for attr in self.runtime_expansions }
443
714
            try:
444
 
                # In case checker_command has exactly one % operator
445
 
                command = self.checker_command % self.host
446
 
            except TypeError:
447
 
                # Escape attributes for the shell
448
 
                escaped_attrs = dict((key,
449
 
                                      re.escape(unicode(str(val),
450
 
                                                        errors=
451
 
                                                        u'replace')))
452
 
                                     for key, val in
453
 
                                     vars(self).iteritems())
454
 
                try:
455
 
                    command = self.checker_command % escaped_attrs
456
 
                except TypeError, error:
457
 
                    logger.error(u'Could not format string "%s":'
458
 
                                 u' %s', self.checker_command, error)
459
 
                    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
460
720
            self.current_checker_command = command
461
721
            try:
462
 
                logger.info(u"Starting checker %r for %s",
 
722
                logger.info("Starting checker %r for %s",
463
723
                            command, self.name)
464
724
                # We don't need to redirect stdout and stderr, since
465
725
                # in normal mode, that is already done by daemon(),
466
726
                # and in debug mode we don't want to.  (Stdin is
467
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 })
468
736
                self.checker = subprocess.Popen(command,
469
737
                                                close_fds=True,
470
 
                                                shell=True, cwd=u"/")
471
 
                self.checker_callback_tag = (gobject.child_watch_add
472
 
                                             (self.checker.pid,
473
 
                                              self.checker_callback,
474
 
                                              data=command))
475
 
                # The checker may have completed before the gobject
476
 
                # 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:
477
751
                pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
478
 
                if pid:
479
 
                    gobject.source_remove(self.checker_callback_tag)
480
 
                    self.checker_callback(pid, status, command)
481
 
            except OSError, error:
482
 
                logger.error(u"Failed to start subprocess: %s",
483
 
                             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)
484
762
        # Re-run this periodically if run by gobject.timeout_add
485
763
        return True
486
764
    
489
767
        if self.checker_callback_tag:
490
768
            gobject.source_remove(self.checker_callback_tag)
491
769
            self.checker_callback_tag = None
492
 
        if getattr(self, u"checker", None) is None:
 
770
        if getattr(self, "checker", None) is None:
493
771
            return
494
 
        logger.debug(u"Stopping checker for %(name)s", vars(self))
 
772
        logger.debug("Stopping checker for %(name)s", vars(self))
495
773
        try:
496
 
            os.kill(self.checker.pid, signal.SIGTERM)
 
774
            self.checker.terminate()
497
775
            #time.sleep(0.5)
498
776
            #if self.checker.poll() is None:
499
 
            #    os.kill(self.checker.pid, signal.SIGKILL)
500
 
        except OSError, error:
 
777
            #    self.checker.kill()
 
778
        except OSError as error:
501
779
            if error.errno != errno.ESRCH: # No such process
502
780
                raise
503
781
        self.checker = None
504
782
 
505
 
def dbus_service_property(dbus_interface, signature=u"v",
506
 
                          access=u"readwrite", byte_arrays=False):
 
783
 
 
784
def dbus_service_property(dbus_interface, signature="v",
 
785
                          access="readwrite", byte_arrays=False):
507
786
    """Decorators for marking methods of a DBusObjectWithProperties to
508
787
    become properties on the D-Bus.
509
788
    
516
795
    """
517
796
    # Encoding deeply encoded byte arrays is not supported yet by the
518
797
    # "Set" method, so we fail early here:
519
 
    if byte_arrays and signature != u"ay":
520
 
        raise ValueError(u"Byte arrays not supported for non-'ay'"
521
 
                         u" signature %r" % signature)
 
798
    if byte_arrays and signature != "ay":
 
799
        raise ValueError("Byte arrays not supported for non-'ay'"
 
800
                         " signature {!r}".format(signature))
522
801
    def decorator(func):
523
802
        func._dbus_is_property = True
524
803
        func._dbus_interface = dbus_interface
525
804
        func._dbus_signature = signature
526
805
        func._dbus_access = access
527
806
        func._dbus_name = func.__name__
528
 
        if func._dbus_name.endswith(u"_dbus_property"):
 
807
        if func._dbus_name.endswith("_dbus_property"):
529
808
            func._dbus_name = func._dbus_name[:-14]
530
 
        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
531
847
        return func
532
848
    return decorator
533
849
 
553
869
 
554
870
class DBusObjectWithProperties(dbus.service.Object):
555
871
    """A D-Bus object with properties.
556
 
 
 
872
    
557
873
    Classes inheriting from this can use the dbus_service_property
558
874
    decorator to expose methods as D-Bus properties.  It exposes the
559
875
    standard Get(), Set(), and GetAll() methods on the D-Bus.
560
876
    """
561
877
    
562
878
    @staticmethod
563
 
    def _is_dbus_property(obj):
564
 
        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_{}".format(thing),
 
886
                                   False)
565
887
    
566
 
    def _get_all_dbus_properties(self):
 
888
    def _get_all_dbus_things(self, thing):
567
889
        """Returns a generator of (name, attribute) pairs
568
890
        """
569
 
        return ((prop._dbus_name, prop)
570
 
                for name, prop in
571
 
                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)))
572
898
    
573
899
    def _get_dbus_property(self, interface_name, property_name):
574
900
        """Returns a bound method if one exists which is a D-Bus
575
901
        property with the specified name and interface.
576
902
        """
577
 
        for name in (property_name,
578
 
                     property_name + u"_dbus_property"):
579
 
            prop = getattr(self, name, None)
580
 
            if (prop is None
581
 
                or not self._is_dbus_property(prop)
582
 
                or prop._dbus_name != property_name
583
 
                or (interface_name and prop._dbus_interface
584
 
                    and interface_name != prop._dbus_interface)):
585
 
                continue
586
 
            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
        
587
911
        # No such property
588
 
        raise DBusPropertyNotFound(self.dbus_object_path + u":"
589
 
                                   + interface_name + u"."
 
912
        raise DBusPropertyNotFound(self.dbus_object_path + ":"
 
913
                                   + interface_name + "."
590
914
                                   + property_name)
591
915
    
592
 
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ss",
593
 
                         out_signature=u"v")
 
916
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
 
917
                         out_signature="v")
594
918
    def Get(self, interface_name, property_name):
595
919
        """Standard D-Bus property Get() method, see D-Bus standard.
596
920
        """
597
921
        prop = self._get_dbus_property(interface_name, property_name)
598
 
        if prop._dbus_access == u"write":
 
922
        if prop._dbus_access == "write":
599
923
            raise DBusPropertyAccessException(property_name)
600
924
        value = prop()
601
 
        if not hasattr(value, u"variant_level"):
 
925
        if not hasattr(value, "variant_level"):
602
926
            return value
603
927
        return type(value)(value, variant_level=value.variant_level+1)
604
928
    
605
 
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ssv")
 
929
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
606
930
    def Set(self, interface_name, property_name, value):
607
931
        """Standard D-Bus property Set() method, see D-Bus standard.
608
932
        """
609
933
        prop = self._get_dbus_property(interface_name, property_name)
610
 
        if prop._dbus_access == u"read":
 
934
        if prop._dbus_access == "read":
611
935
            raise DBusPropertyAccessException(property_name)
612
 
        if prop._dbus_get_args_options[u"byte_arrays"]:
 
936
        if prop._dbus_get_args_options["byte_arrays"]:
613
937
            # The byte_arrays option is not supported yet on
614
938
            # signatures other than "ay".
615
 
            if prop._dbus_signature != u"ay":
616
 
                raise ValueError
617
 
            value = dbus.ByteArray(''.join(unichr(byte)
618
 
                                           for byte in value))
 
939
            if prop._dbus_signature != "ay":
 
940
                raise ValueError("Byte arrays not supported for non-"
 
941
                                 "'ay' signature {!r}"
 
942
                                 .format(prop._dbus_signature))
 
943
            value = dbus.ByteArray(b''.join(chr(byte)
 
944
                                            for byte in value))
619
945
        prop(value)
620
946
    
621
 
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"s",
622
 
                         out_signature=u"a{sv}")
 
947
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
 
948
                         out_signature="a{sv}")
623
949
    def GetAll(self, interface_name):
624
950
        """Standard D-Bus property GetAll() method, see D-Bus
625
951
        standard.
626
 
 
 
952
        
627
953
        Note: Will not include properties with access="write".
628
954
        """
629
 
        all = {}
630
 
        for name, prop in self._get_all_dbus_properties():
 
955
        properties = {}
 
956
        for name, prop in self._get_all_dbus_things("property"):
631
957
            if (interface_name
632
958
                and interface_name != prop._dbus_interface):
633
959
                # Interface non-empty but did not match
634
960
                continue
635
961
            # Ignore write-only properties
636
 
            if prop._dbus_access == u"write":
 
962
            if prop._dbus_access == "write":
637
963
                continue
638
964
            value = prop()
639
 
            if not hasattr(value, u"variant_level"):
640
 
                all[name] = value
 
965
            if not hasattr(value, "variant_level"):
 
966
                properties[name] = value
641
967
                continue
642
 
            all[name] = type(value)(value, variant_level=
643
 
                                    value.variant_level+1)
644
 
        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")
645
971
    
646
972
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
647
 
                         out_signature=u"s",
 
973
                         out_signature="s",
648
974
                         path_keyword='object_path',
649
975
                         connection_keyword='connection')
650
976
    def Introspect(self, object_path, connection):
651
 
        """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.
652
980
        """
653
981
        xmlstring = dbus.service.Object.Introspect(self, object_path,
654
982
                                                   connection)
655
983
        try:
656
984
            document = xml.dom.minidom.parseString(xmlstring)
657
985
            def make_tag(document, name, prop):
658
 
                e = document.createElement(u"property")
659
 
                e.setAttribute(u"name", name)
660
 
                e.setAttribute(u"type", prop._dbus_signature)
661
 
                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)
662
990
                return e
663
 
            for if_tag in document.getElementsByTagName(u"interface"):
 
991
            for if_tag in document.getElementsByTagName("interface"):
 
992
                # Add property tags
664
993
                for tag in (make_tag(document, name, prop)
665
994
                            for name, prop
666
 
                            in self._get_all_dbus_properties()
 
995
                            in self._get_all_dbus_things("property")
667
996
                            if prop._dbus_interface
668
 
                            == if_tag.getAttribute(u"name")):
 
997
                            == if_tag.getAttribute("name")):
669
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.items():
 
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().items()
 
1022
                        for name, annotations in
 
1023
                        self._get_all_dbus_things("interface")
 
1024
                        if name == if_tag.getAttribute("name")
 
1025
                        )).items():
 
1026
                    ann_tag = document.createElement("annotation")
 
1027
                    ann_tag.setAttribute("name", annotation)
 
1028
                    ann_tag.setAttribute("value", value)
 
1029
                    if_tag.appendChild(ann_tag)
670
1030
                # Add the names to the return values for the
671
1031
                # "org.freedesktop.DBus.Properties" methods
672
 
                if (if_tag.getAttribute(u"name")
673
 
                    == u"org.freedesktop.DBus.Properties"):
674
 
                    for cn in if_tag.getElementsByTagName(u"method"):
675
 
                        if cn.getAttribute(u"name") == u"Get":
676
 
                            for arg in cn.getElementsByTagName(u"arg"):
677
 
                                if (arg.getAttribute(u"direction")
678
 
                                    == u"out"):
679
 
                                    arg.setAttribute(u"name", u"value")
680
 
                        elif cn.getAttribute(u"name") == u"GetAll":
681
 
                            for arg in cn.getElementsByTagName(u"arg"):
682
 
                                if (arg.getAttribute(u"direction")
683
 
                                    == u"out"):
684
 
                                    arg.setAttribute(u"name", u"props")
685
 
            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")
686
1046
            document.unlink()
687
1047
        except (AttributeError, xml.dom.DOMException,
688
 
                xml.parsers.expat.ExpatError), error:
689
 
            logger.error(u"Failed to override Introspection method",
690
 
                         error)
 
1048
                xml.parsers.expat.ExpatError) as error:
 
1049
            logger.error("Failed to override Introspection method",
 
1050
                         exc_info=error)
691
1051
        return xmlstring
692
1052
 
693
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.items()):
 
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{}"
 
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"{}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"})
694
1233
class ClientDBus(Client, DBusObjectWithProperties):
695
1234
    """A Client class using D-Bus
696
1235
    
698
1237
    dbus_object_path: dbus.ObjectPath
699
1238
    bus: dbus.SystemBus()
700
1239
    """
 
1240
    
 
1241
    runtime_expansions = (Client.runtime_expansions
 
1242
                          + ("dbus_object_path",))
 
1243
    
701
1244
    # dbus.service.Object doesn't use super(), so we can't either.
702
1245
    
703
1246
    def __init__(self, bus = None, *args, **kwargs):
704
 
        self._approvals_pending = 0
705
1247
        self.bus = bus
706
1248
        Client.__init__(self, *args, **kwargs)
707
1249
        # Only now, when this client is initialized, can it show up on
708
1250
        # the D-Bus
 
1251
        client_object_name = unicode(self.name).translate(
 
1252
            {ord("."): ord("_"),
 
1253
             ord("-"): ord("_")})
709
1254
        self.dbus_object_path = (dbus.ObjectPath
710
 
                                 (u"/clients/"
711
 
                                  + self.name.replace(u".", u"_")))
 
1255
                                 ("/clients/" + client_object_name))
712
1256
        DBusObjectWithProperties.__init__(self, self.bus,
713
1257
                                          self.dbus_object_path)
714
 
 
715
 
    #Could possible return a bool(self._approvals_pending),
716
 
    #but this could mess up approvals_pending += 1 XXX 
717
 
    def _get_approvals_pending(self):
718
 
        return self._approvals_pending
719
 
    def _set_approvals_pending(self, value):
720
 
        old_value = self._approvals_pending
721
 
        self._approvals_pending = value
722
 
        bval = bool(value)
723
 
        if (hasattr(self, "dbus_object_path")
724
 
            and bval is not bool(old_value)):
725
 
            dbus_bool = dbus.Boolean(bval, variant_level=1)
726
 
            self.PropertyChanged(dbus.String(u"approved_pending"),
727
 
                                 dbus_bool)
728
 
 
729
 
    approvals_pending = property(_get_approvals_pending,
730
 
                                 _set_approvals_pending)
731
 
    del _get_approvals_pending, _set_approvals_pending
732
 
    
733
 
    @staticmethod
734
 
    def _datetime_to_dbus(dt, variant_level=0):
735
 
        """Convert a UTC datetime.datetime() to a D-Bus type."""
736
 
        return dbus.String(dt.isoformat(),
737
 
                           variant_level=variant_level)
738
 
    
739
 
    def enable(self):
740
 
        oldstate = getattr(self, u"enabled", False)
741
 
        r = Client.enable(self)
742
 
        if oldstate != self.enabled:
743
 
            # Emit D-Bus signals
744
 
            self.PropertyChanged(dbus.String(u"enabled"),
745
 
                                 dbus.Boolean(True, variant_level=1))
746
 
            self.PropertyChanged(
747
 
                dbus.String(u"last_enabled"),
748
 
                self._datetime_to_dbus(self.last_enabled,
749
 
                                       variant_level=1))
750
 
        return r
751
 
    
752
 
    def disable(self, quiet = False):
753
 
        oldstate = getattr(self, u"enabled", False)
754
 
        r = Client.disable(self, quiet=quiet)
755
 
        if not quiet and oldstate != self.enabled:
756
 
            # Emit D-Bus signal
757
 
            self.PropertyChanged(dbus.String(u"enabled"),
758
 
                                 dbus.Boolean(False, variant_level=1))
759
 
        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 = "_{}".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
760
1326
    
761
1327
    def __del__(self, *args, **kwargs):
762
1328
        try:
763
1329
            self.remove_from_connection()
764
1330
        except LookupError:
765
1331
            pass
766
 
        if hasattr(DBusObjectWithProperties, u"__del__"):
 
1332
        if hasattr(DBusObjectWithProperties, "__del__"):
767
1333
            DBusObjectWithProperties.__del__(self, *args, **kwargs)
768
1334
        Client.__del__(self, *args, **kwargs)
769
1335
    
771
1337
                         *args, **kwargs):
772
1338
        self.checker_callback_tag = None
773
1339
        self.checker = None
774
 
        # Emit D-Bus signal
775
 
        self.PropertyChanged(dbus.String(u"checker_running"),
776
 
                             dbus.Boolean(False, variant_level=1))
777
1340
        if os.WIFEXITED(condition):
778
1341
            exitstatus = os.WEXITSTATUS(condition)
779
1342
            # Emit D-Bus signal
789
1352
        return Client.checker_callback(self, pid, condition, command,
790
1353
                                       *args, **kwargs)
791
1354
    
792
 
    def checked_ok(self, *args, **kwargs):
793
 
        r = Client.checked_ok(self, *args, **kwargs)
794
 
        # Emit D-Bus signal
795
 
        self.PropertyChanged(
796
 
            dbus.String(u"last_checked_ok"),
797
 
            (self._datetime_to_dbus(self.last_checked_ok,
798
 
                                    variant_level=1)))
799
 
        return r
800
 
    
801
1355
    def start_checker(self, *args, **kwargs):
802
 
        old_checker = self.checker
803
 
        if self.checker is not None:
804
 
            old_checker_pid = self.checker.pid
805
 
        else:
806
 
            old_checker_pid = None
 
1356
        old_checker_pid = getattr(self.checker, "pid", None)
807
1357
        r = Client.start_checker(self, *args, **kwargs)
808
1358
        # Only if new checker process was started
809
1359
        if (self.checker is not None
810
1360
            and old_checker_pid != self.checker.pid):
811
1361
            # Emit D-Bus signal
812
1362
            self.CheckerStarted(self.current_checker_command)
813
 
            self.PropertyChanged(
814
 
                dbus.String(u"checker_running"),
815
 
                dbus.Boolean(True, variant_level=1))
816
1363
        return r
817
1364
    
818
 
    def stop_checker(self, *args, **kwargs):
819
 
        old_checker = getattr(self, u"checker", None)
820
 
        r = Client.stop_checker(self, *args, **kwargs)
821
 
        if (old_checker is not None
822
 
            and getattr(self, u"checker", None) is None):
823
 
            self.PropertyChanged(dbus.String(u"checker_running"),
824
 
                                 dbus.Boolean(False, variant_level=1))
825
 
        return r
826
 
 
827
1365
    def _reset_approved(self):
828
 
        self._approved = None
 
1366
        self.approved = None
829
1367
        return False
830
1368
    
831
1369
    def approve(self, value=True):
832
 
        self.send_changedstate()
833
 
        self._approved = value
834
 
        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),
835
1373
                            self._reset_approved)
836
 
    
 
1374
        self.send_changedstate()
837
1375
    
838
1376
    ## D-Bus methods, signals & properties
839
 
    _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"}
840
1385
    
841
1386
    ## Signals
842
1387
    
843
1388
    # CheckerCompleted - signal
844
 
    @dbus.service.signal(_interface, signature=u"nxs")
 
1389
    @dbus.service.signal(_interface, signature="nxs")
845
1390
    def CheckerCompleted(self, exitcode, waitstatus, command):
846
1391
        "D-Bus signal"
847
1392
        pass
848
1393
    
849
1394
    # CheckerStarted - signal
850
 
    @dbus.service.signal(_interface, signature=u"s")
 
1395
    @dbus.service.signal(_interface, signature="s")
851
1396
    def CheckerStarted(self, command):
852
1397
        "D-Bus signal"
853
1398
        pass
854
1399
    
855
1400
    # PropertyChanged - signal
856
 
    @dbus.service.signal(_interface, signature=u"sv")
 
1401
    @dbus.service.signal(_interface, signature="sv")
857
1402
    def PropertyChanged(self, property, value):
858
1403
        "D-Bus signal"
859
1404
        pass
860
1405
    
861
1406
    # GotSecret - signal
862
 
    # XXXTEDDY Is sent after succesfull transfer of secret from mandos-server to mandos-client
863
1407
    @dbus.service.signal(_interface)
864
1408
    def GotSecret(self):
865
 
        "D-Bus signal"
 
1409
        """D-Bus signal
 
1410
        Is sent after a successful transfer of secret from the Mandos
 
1411
        server to mandos-client
 
1412
        """
866
1413
        pass
867
1414
    
868
1415
    # Rejected - signal
869
 
    @dbus.service.signal(_interface, signature=u"s")
 
1416
    @dbus.service.signal(_interface, signature="s")
870
1417
    def Rejected(self, reason):
871
1418
        "D-Bus signal"
872
1419
        pass
873
1420
    
874
1421
    # NeedApproval - signal
875
 
    @dbus.service.signal(_interface, signature=u"db")
 
1422
    @dbus.service.signal(_interface, signature="tb")
876
1423
    def NeedApproval(self, timeout, default):
877
1424
        "D-Bus signal"
878
 
        pass
 
1425
        return self.need_approval()
879
1426
    
880
1427
    ## Methods
881
 
 
 
1428
    
882
1429
    # Approve - method
883
 
    @dbus.service.method(_interface, in_signature=u"b")
 
1430
    @dbus.service.method(_interface, in_signature="b")
884
1431
    def Approve(self, value):
885
1432
        self.approve(value)
886
 
 
 
1433
    
887
1434
    # CheckedOK - method
888
1435
    @dbus.service.method(_interface)
889
1436
    def CheckedOK(self):
890
 
        return self.checked_ok()
 
1437
        self.checked_ok()
891
1438
    
892
1439
    # Enable - method
893
1440
    @dbus.service.method(_interface)
914
1461
    
915
1462
    ## Properties
916
1463
    
917
 
    # approved_pending - property
918
 
    @dbus_service_property(_interface, signature=u"b", access=u"read")
919
 
    def approved_pending_dbus_property(self):
 
1464
    # ApprovalPending - property
 
1465
    @dbus_service_property(_interface, signature="b", access="read")
 
1466
    def ApprovalPending_dbus_property(self):
920
1467
        return dbus.Boolean(bool(self.approvals_pending))
921
1468
    
922
 
    # approved_by_default - property
923
 
    @dbus_service_property(_interface, signature=u"b",
924
 
                           access=u"readwrite")
925
 
    def approved_by_default_dbus_property(self):
926
 
        return dbus.Boolean(self.approved_by_default)
927
 
    
928
 
    # approved_delay - property
929
 
    @dbus_service_property(_interface, signature=u"t",
930
 
                           access=u"readwrite")
931
 
    def approved_delay_dbus_property(self):
932
 
        return dbus.UInt64(self.approved_delay_milliseconds())
933
 
    
934
 
    # approved_duration - property
935
 
    @dbus_service_property(_interface, signature=u"t",
936
 
                           access=u"readwrite")
937
 
    def approved_duration_dbus_property(self):
938
 
        return dbus.UInt64(self._timedelta_to_milliseconds(
939
 
                self.approved_duration))
940
 
    
941
 
    # name - property
942
 
    @dbus_service_property(_interface, signature=u"s", access=u"read")
943
 
    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):
944
1497
        return dbus.String(self.name)
945
1498
    
946
 
    # fingerprint - property
947
 
    @dbus_service_property(_interface, signature=u"s", access=u"read")
948
 
    def fingerprint_dbus_property(self):
 
1499
    # Fingerprint - property
 
1500
    @dbus_service_property(_interface, signature="s", access="read")
 
1501
    def Fingerprint_dbus_property(self):
949
1502
        return dbus.String(self.fingerprint)
950
1503
    
951
 
    # host - property
952
 
    @dbus_service_property(_interface, signature=u"s",
953
 
                           access=u"readwrite")
954
 
    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):
955
1508
        if value is None:       # get
956
1509
            return dbus.String(self.host)
957
 
        self.host = value
958
 
        # Emit D-Bus signal
959
 
        self.PropertyChanged(dbus.String(u"host"),
960
 
                             dbus.String(value, variant_level=1))
961
 
    
962
 
    # created - property
963
 
    @dbus_service_property(_interface, signature=u"s", access=u"read")
964
 
    def created_dbus_property(self):
965
 
        return dbus.String(self._datetime_to_dbus(self.created))
966
 
    
967
 
    # last_enabled - property
968
 
    @dbus_service_property(_interface, signature=u"s", access=u"read")
969
 
    def last_enabled_dbus_property(self):
970
 
        if self.last_enabled is None:
971
 
            return dbus.String(u"")
972
 
        return dbus.String(self._datetime_to_dbus(self.last_enabled))
973
 
    
974
 
    # enabled - property
975
 
    @dbus_service_property(_interface, signature=u"b",
976
 
                           access=u"readwrite")
977
 
    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):
978
1526
        if value is None:       # get
979
1527
            return dbus.Boolean(self.enabled)
980
1528
        if value:
982
1530
        else:
983
1531
            self.disable()
984
1532
    
985
 
    # last_checked_ok - property
986
 
    @dbus_service_property(_interface, signature=u"s",
987
 
                           access=u"readwrite")
988
 
    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):
989
1537
        if value is not None:
990
1538
            self.checked_ok()
991
1539
            return
992
 
        if self.last_checked_ok is None:
993
 
            return dbus.String(u"")
994
 
        return dbus.String(self._datetime_to_dbus(self
995
 
                                                  .last_checked_ok))
996
 
    
997
 
    # timeout - property
998
 
    @dbus_service_property(_interface, signature=u"t",
999
 
                           access=u"readwrite")
1000
 
    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):
1001
1562
        if value is None:       # get
1002
1563
            return dbus.UInt64(self.timeout_milliseconds())
 
1564
        old_timeout = self.timeout
1003
1565
        self.timeout = datetime.timedelta(0, 0, 0, value)
1004
 
        # Emit D-Bus signal
1005
 
        self.PropertyChanged(dbus.String(u"timeout"),
1006
 
                             dbus.UInt64(value, variant_level=1))
1007
 
        if getattr(self, u"disable_initiator_tag", None) is None:
1008
 
            return
1009
 
        # Reschedule timeout
1010
 
        gobject.source_remove(self.disable_initiator_tag)
1011
 
        self.disable_initiator_tag = None
1012
 
        time_to_die = (self.
1013
 
                       _timedelta_to_milliseconds((self
1014
 
                                                   .last_checked_ok
1015
 
                                                   + self.timeout)
1016
 
                                                  - datetime.datetime
1017
 
                                                  .utcnow()))
1018
 
        if time_to_die <= 0:
1019
 
            # The timeout has passed
1020
 
            self.disable()
1021
 
        else:
1022
 
            self.disable_initiator_tag = (gobject.timeout_add
1023
 
                                          (time_to_die, self.disable))
1024
 
    
1025
 
    # interval - property
1026
 
    @dbus_service_property(_interface, signature=u"t",
1027
 
                           access=u"readwrite")
1028
 
    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):
1029
1595
        if value is None:       # get
1030
1596
            return dbus.UInt64(self.interval_milliseconds())
1031
1597
        self.interval = datetime.timedelta(0, 0, 0, value)
1032
 
        # Emit D-Bus signal
1033
 
        self.PropertyChanged(dbus.String(u"interval"),
1034
 
                             dbus.UInt64(value, variant_level=1))
1035
 
        if getattr(self, u"checker_initiator_tag", None) is None:
 
1598
        if getattr(self, "checker_initiator_tag", None) is None:
1036
1599
            return
1037
 
        # Reschedule checker run
1038
 
        gobject.source_remove(self.checker_initiator_tag)
1039
 
        self.checker_initiator_tag = (gobject.timeout_add
1040
 
                                      (value, self.start_checker))
1041
 
        self.start_checker()    # Start one now, too
1042
 
 
1043
 
    # checker - property
1044
 
    @dbus_service_property(_interface, signature=u"s",
1045
 
                           access=u"readwrite")
1046
 
    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):
1047
1611
        if value is None:       # get
1048
1612
            return dbus.String(self.checker_command)
1049
 
        self.checker_command = value
1050
 
        # Emit D-Bus signal
1051
 
        self.PropertyChanged(dbus.String(u"checker"),
1052
 
                             dbus.String(self.checker_command,
1053
 
                                         variant_level=1))
 
1613
        self.checker_command = unicode(value)
1054
1614
    
1055
 
    # checker_running - property
1056
 
    @dbus_service_property(_interface, signature=u"b",
1057
 
                           access=u"readwrite")
1058
 
    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):
1059
1619
        if value is None:       # get
1060
1620
            return dbus.Boolean(self.checker is not None)
1061
1621
        if value:
1063
1623
        else:
1064
1624
            self.stop_checker()
1065
1625
    
1066
 
    # object_path - property
1067
 
    @dbus_service_property(_interface, signature=u"o", access=u"read")
1068
 
    def object_path_dbus_property(self):
 
1626
    # ObjectPath - property
 
1627
    @dbus_service_property(_interface, signature="o", access="read")
 
1628
    def ObjectPath_dbus_property(self):
1069
1629
        return self.dbus_object_path # is already a dbus.ObjectPath
1070
1630
    
1071
 
    # secret = property
1072
 
    @dbus_service_property(_interface, signature=u"ay",
1073
 
                           access=u"write", byte_arrays=True)
1074
 
    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):
1075
1635
        self.secret = str(value)
1076
1636
    
1077
1637
    del _interface
1083
1643
        self._pipe.send(('init', fpr, address))
1084
1644
        if not self._pipe.recv():
1085
1645
            raise KeyError()
1086
 
 
 
1646
    
1087
1647
    def __getattribute__(self, name):
1088
 
        if(name == '_pipe'):
 
1648
        if name == '_pipe':
1089
1649
            return super(ProxyClient, self).__getattribute__(name)
1090
1650
        self._pipe.send(('getattr', name))
1091
1651
        data = self._pipe.recv()
1096
1656
                self._pipe.send(('funcall', name, args, kwargs))
1097
1657
                return self._pipe.recv()[1]
1098
1658
            return func
1099
 
 
 
1659
    
1100
1660
    def __setattr__(self, name, value):
1101
 
        if(name == '_pipe'):
 
1661
        if name == '_pipe':
1102
1662
            return super(ProxyClient, self).__setattr__(name, value)
1103
1663
        self._pipe.send(('setattr', name, value))
1104
1664
 
1111
1671
    
1112
1672
    def handle(self):
1113
1673
        with contextlib.closing(self.server.child_pipe) as child_pipe:
1114
 
            logger.info(u"TCP connection from: %s",
 
1674
            logger.info("TCP connection from: %s",
1115
1675
                        unicode(self.client_address))
1116
 
            logger.debug(u"Pipe FD: %d",
 
1676
            logger.debug("Pipe FD: %d",
1117
1677
                         self.server.child_pipe.fileno())
1118
 
 
 
1678
            
1119
1679
            session = (gnutls.connection
1120
1680
                       .ClientSession(self.request,
1121
1681
                                      gnutls.connection
1122
1682
                                      .X509Credentials()))
1123
 
 
 
1683
            
1124
1684
            # Note: gnutls.connection.X509Credentials is really a
1125
1685
            # generic GnuTLS certificate credentials object so long as
1126
1686
            # no X.509 keys are added to it.  Therefore, we can use it
1127
1687
            # here despite using OpenPGP certificates.
1128
 
 
1129
 
            #priority = u':'.join((u"NONE", u"+VERS-TLS1.1",
1130
 
            #                      u"+AES-256-CBC", u"+SHA1",
1131
 
            #                      u"+COMP-NULL", u"+CTYPE-OPENPGP",
1132
 
            #                      u"+DHE-DSS"))
 
1688
            
 
1689
            #priority = ':'.join(("NONE", "+VERS-TLS1.1",
 
1690
            #                      "+AES-256-CBC", "+SHA1",
 
1691
            #                      "+COMP-NULL", "+CTYPE-OPENPGP",
 
1692
            #                      "+DHE-DSS"))
1133
1693
            # Use a fallback default, since this MUST be set.
1134
1694
            priority = self.server.gnutls_priority
1135
1695
            if priority is None:
1136
 
                priority = u"NORMAL"
 
1696
                priority = "NORMAL"
1137
1697
            (gnutls.library.functions
1138
1698
             .gnutls_priority_set_direct(session._c_object,
1139
1699
                                         priority, None))
1140
 
 
 
1700
            
1141
1701
            # Start communication using the Mandos protocol
1142
1702
            # Get protocol number
1143
1703
            line = self.request.makefile().readline()
1144
 
            logger.debug(u"Protocol version: %r", line)
 
1704
            logger.debug("Protocol version: %r", line)
1145
1705
            try:
1146
1706
                if int(line.strip().split()[0]) > 1:
1147
 
                    raise RuntimeError
1148
 
            except (ValueError, IndexError, RuntimeError), error:
1149
 
                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)
1150
1710
                return
1151
 
 
 
1711
            
1152
1712
            # Start GnuTLS connection
1153
1713
            try:
1154
1714
                session.handshake()
1155
 
            except gnutls.errors.GNUTLSError, error:
1156
 
                logger.warning(u"Handshake failed: %s", error)
 
1715
            except gnutls.errors.GNUTLSError as error:
 
1716
                logger.warning("Handshake failed: %s", error)
1157
1717
                # Do not run session.bye() here: the session is not
1158
1718
                # established.  Just abandon the request.
1159
1719
                return
1160
 
            logger.debug(u"Handshake succeeded")
1161
 
 
 
1720
            logger.debug("Handshake succeeded")
 
1721
            
1162
1722
            approval_required = False
1163
1723
            try:
1164
1724
                try:
1165
1725
                    fpr = self.fingerprint(self.peer_certificate
1166
1726
                                           (session))
1167
 
                except (TypeError, gnutls.errors.GNUTLSError), error:
1168
 
                    logger.warning(u"Bad certificate: %s", error)
 
1727
                except (TypeError,
 
1728
                        gnutls.errors.GNUTLSError) as error:
 
1729
                    logger.warning("Bad certificate: %s", error)
1169
1730
                    return
1170
 
                logger.debug(u"Fingerprint: %s", fpr)
1171
 
 
 
1731
                logger.debug("Fingerprint: %s", fpr)
 
1732
                
1172
1733
                try:
1173
1734
                    client = ProxyClient(child_pipe, fpr,
1174
1735
                                         self.client_address)
1175
1736
                except KeyError:
1176
1737
                    return
1177
1738
                
1178
 
                if client.approved_delay:
1179
 
                    delay = client.approved_delay
 
1739
                if client.approval_delay:
 
1740
                    delay = client.approval_delay
1180
1741
                    client.approvals_pending += 1
1181
1742
                    approval_required = True
1182
1743
                
1183
1744
                while True:
1184
1745
                    if not client.enabled:
1185
 
                        logger.warning(u"Client %s is disabled",
 
1746
                        logger.info("Client %s is disabled",
1186
1747
                                       client.name)
1187
1748
                        if self.server.use_dbus:
1188
1749
                            # Emit D-Bus signal
1189
 
                            client.Rejected("Disabled")                    
 
1750
                            client.Rejected("Disabled")
1190
1751
                        return
1191
1752
                    
1192
 
                    if client._approved or not client.approved_delay:
 
1753
                    if client.approved or not client.approval_delay:
1193
1754
                        #We are approved or approval is disabled
1194
1755
                        break
1195
 
                    elif client._approved is None:
1196
 
                        logger.info(u"Client %s need approval",
 
1756
                    elif client.approved is None:
 
1757
                        logger.info("Client %s needs approval",
1197
1758
                                    client.name)
1198
1759
                        if self.server.use_dbus:
1199
1760
                            # Emit D-Bus signal
1200
1761
                            client.NeedApproval(
1201
 
                                client.approved_delay_milliseconds(),
 
1762
                                client.approval_delay_milliseconds(),
1202
1763
                                client.approved_by_default)
1203
1764
                    else:
1204
 
                        logger.warning(u"Client %s was not approved",
 
1765
                        logger.warning("Client %s was not approved",
1205
1766
                                       client.name)
1206
1767
                        if self.server.use_dbus:
1207
1768
                            # Emit D-Bus signal
1208
 
                            client.Rejected("Disapproved")
 
1769
                            client.Rejected("Denied")
1209
1770
                        return
1210
1771
                    
1211
1772
                    #wait until timeout or approved
1212
 
                    #x = float(client._timedelta_to_milliseconds(delay))
1213
1773
                    time = datetime.datetime.now()
1214
1774
                    client.changedstate.acquire()
1215
 
                    client.changedstate.wait(float(client._timedelta_to_milliseconds(delay) / 1000))
 
1775
                    client.changedstate.wait(
 
1776
                        float(timedelta_to_milliseconds(delay)
 
1777
                              / 1000))
1216
1778
                    client.changedstate.release()
1217
1779
                    time2 = datetime.datetime.now()
1218
1780
                    if (time2 - time) >= delay:
1222
1784
                                           client.name)
1223
1785
                            if self.server.use_dbus:
1224
1786
                                # Emit D-Bus signal
1225
 
                                client.Rejected("Time out")
 
1787
                                client.Rejected("Approval timed out")
1226
1788
                            return
1227
1789
                        else:
1228
1790
                            break
1231
1793
                
1232
1794
                sent_size = 0
1233
1795
                while sent_size < len(client.secret):
1234
 
                    # XXX handle session exception
1235
 
                    sent = session.send(client.secret[sent_size:])
1236
 
                    logger.debug(u"Sent: %d, remaining: %d",
 
1796
                    try:
 
1797
                        sent = session.send(client.secret[sent_size:])
 
1798
                    except gnutls.errors.GNUTLSError as error:
 
1799
                        logger.warning("gnutls send failed",
 
1800
                                       exc_info=error)
 
1801
                        return
 
1802
                    logger.debug("Sent: %d, remaining: %d",
1237
1803
                                 sent, len(client.secret)
1238
1804
                                 - (sent_size + sent))
1239
1805
                    sent_size += sent
1240
 
 
1241
 
                logger.info(u"Sending secret to %s", client.name)
1242
 
                # bump the timeout as if seen
1243
 
                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)
1244
1810
                if self.server.use_dbus:
1245
1811
                    # Emit D-Bus signal
1246
1812
                    client.GotSecret()
1248
1814
            finally:
1249
1815
                if approval_required:
1250
1816
                    client.approvals_pending -= 1
1251
 
                session.bye()
 
1817
                try:
 
1818
                    session.bye()
 
1819
                except gnutls.errors.GNUTLSError as error:
 
1820
                    logger.warning("GnuTLS bye failed",
 
1821
                                   exc_info=error)
1252
1822
    
1253
1823
    @staticmethod
1254
1824
    def peer_certificate(session):
1264
1834
                     .gnutls_certificate_get_peers
1265
1835
                     (session._c_object, ctypes.byref(list_size)))
1266
1836
        if not bool(cert_list) and list_size.value != 0:
1267
 
            raise gnutls.errors.GNUTLSError(u"error getting peer"
1268
 
                                            u" certificate")
 
1837
            raise gnutls.errors.GNUTLSError("error getting peer"
 
1838
                                            " certificate")
1269
1839
        if list_size.value == 0:
1270
1840
            return None
1271
1841
        cert = cert_list[0]
1297
1867
        if crtverify.value != 0:
1298
1868
            gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1299
1869
            raise (gnutls.errors.CertificateSecurityError
1300
 
                   (u"Verify failed"))
 
1870
                   ("Verify failed"))
1301
1871
        # New buffer for the fingerprint
1302
1872
        buf = ctypes.create_string_buffer(20)
1303
1873
        buf_len = ctypes.c_size_t()
1310
1880
        # Convert the buffer to a Python bytestring
1311
1881
        fpr = ctypes.string_at(buf, buf_len.value)
1312
1882
        # Convert the bytestring to hexadecimal notation
1313
 
        hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
 
1883
        hex_fpr = binascii.hexlify(fpr).upper()
1314
1884
        return hex_fpr
1315
1885
 
1316
1886
 
1319
1889
    def sub_process_main(self, request, address):
1320
1890
        try:
1321
1891
            self.finish_request(request, address)
1322
 
        except:
 
1892
        except Exception:
1323
1893
            self.handle_error(request, address)
1324
1894
        self.close_request(request)
1325
 
            
 
1895
    
1326
1896
    def process_request(self, request, address):
1327
1897
        """Start a new process to process the request."""
1328
 
        multiprocessing.Process(target = self.sub_process_main,
1329
 
                                args = (request, address)).start()
 
1898
        proc = multiprocessing.Process(target = self.sub_process_main,
 
1899
                                       args = (request, address))
 
1900
        proc.start()
 
1901
        return proc
 
1902
 
1330
1903
 
1331
1904
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1332
1905
    """ adds a pipe to the MixIn """
1336
1909
        This function creates a new pipe in self.pipe
1337
1910
        """
1338
1911
        parent_pipe, self.child_pipe = multiprocessing.Pipe()
1339
 
 
1340
 
        super(MultiprocessingMixInWithPipe,
1341
 
              self).process_request(request, client_address)
 
1912
        
 
1913
        proc = MultiprocessingMixIn.process_request(self, request,
 
1914
                                                    client_address)
1342
1915
        self.child_pipe.close()
1343
 
        self.add_pipe(parent_pipe)
1344
 
 
1345
 
    def add_pipe(self, parent_pipe):
 
1916
        self.add_pipe(parent_pipe, proc)
 
1917
    
 
1918
    def add_pipe(self, parent_pipe, proc):
1346
1919
        """Dummy function; override as necessary"""
1347
 
        pass
 
1920
        raise NotImplementedError()
 
1921
 
1348
1922
 
1349
1923
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1350
1924
                     socketserver.TCPServer, object):
1356
1930
        use_ipv6:       Boolean; to use IPv6 or not
1357
1931
    """
1358
1932
    def __init__(self, server_address, RequestHandlerClass,
1359
 
                 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
        """
1360
1937
        self.interface = interface
1361
1938
        if use_ipv6:
1362
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.
1363
1966
        socketserver.TCPServer.__init__(self, server_address,
1364
1967
                                        RequestHandlerClass)
 
1968
    
1365
1969
    def server_bind(self):
1366
1970
        """This overrides the normal server_bind() function
1367
1971
        to bind to an interface if one was specified, and also NOT to
1368
1972
        bind to an address or port if they were not specified."""
1369
1973
        if self.interface is not None:
1370
1974
            if SO_BINDTODEVICE is None:
1371
 
                logger.error(u"SO_BINDTODEVICE does not exist;"
1372
 
                             u" cannot bind to interface %s",
 
1975
                logger.error("SO_BINDTODEVICE does not exist;"
 
1976
                             " cannot bind to interface %s",
1373
1977
                             self.interface)
1374
1978
            else:
1375
1979
                try:
1376
1980
                    self.socket.setsockopt(socket.SOL_SOCKET,
1377
1981
                                           SO_BINDTODEVICE,
1378
 
                                           str(self.interface
1379
 
                                               + u'\0'))
1380
 
                except socket.error, error:
1381
 
                    if error[0] == errno.EPERM:
1382
 
                        logger.error(u"No permission to"
1383
 
                                     u" bind to interface %s",
1384
 
                                     self.interface)
1385
 
                    elif error[0] == errno.ENOPROTOOPT:
1386
 
                        logger.error(u"SO_BINDTODEVICE not available;"
1387
 
                                     u" cannot bind to interface %s",
1388
 
                                     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)
1389
1994
                    else:
1390
1995
                        raise
1391
1996
        # Only bind(2) the socket if we really need to.
1392
1997
        if self.server_address[0] or self.server_address[1]:
1393
1998
            if not self.server_address[0]:
1394
1999
                if self.address_family == socket.AF_INET6:
1395
 
                    any_address = u"::" # in6addr_any
 
2000
                    any_address = "::" # in6addr_any
1396
2001
                else:
1397
 
                    any_address = socket.INADDR_ANY
 
2002
                    any_address = "0.0.0.0" # INADDR_ANY
1398
2003
                self.server_address = (any_address,
1399
2004
                                       self.server_address[1])
1400
2005
            elif not self.server_address[1]:
1421
2026
    """
1422
2027
    def __init__(self, server_address, RequestHandlerClass,
1423
2028
                 interface=None, use_ipv6=True, clients=None,
1424
 
                 gnutls_priority=None, use_dbus=True):
 
2029
                 gnutls_priority=None, use_dbus=True, socketfd=None):
1425
2030
        self.enabled = False
1426
2031
        self.clients = clients
1427
2032
        if self.clients is None:
1428
 
            self.clients = set()
 
2033
            self.clients = {}
1429
2034
        self.use_dbus = use_dbus
1430
2035
        self.gnutls_priority = gnutls_priority
1431
2036
        IPv6_TCPServer.__init__(self, server_address,
1432
2037
                                RequestHandlerClass,
1433
2038
                                interface = interface,
1434
 
                                use_ipv6 = use_ipv6)
 
2039
                                use_ipv6 = use_ipv6,
 
2040
                                socketfd = socketfd)
1435
2041
    def server_activate(self):
1436
2042
        if self.enabled:
1437
2043
            return socketserver.TCPServer.server_activate(self)
 
2044
    
1438
2045
    def enable(self):
1439
2046
        self.enabled = True
1440
 
    def add_pipe(self, parent_pipe):
 
2047
    
 
2048
    def add_pipe(self, parent_pipe, proc):
1441
2049
        # Call "handle_ipc" for both data and EOF events
1442
2050
        gobject.io_add_watch(parent_pipe.fileno(),
1443
2051
                             gobject.IO_IN | gobject.IO_HUP,
1444
2052
                             functools.partial(self.handle_ipc,
1445
 
                                               parent_pipe = parent_pipe))
1446
 
        
 
2053
                                               parent_pipe =
 
2054
                                               parent_pipe,
 
2055
                                               proc = proc))
 
2056
    
1447
2057
    def handle_ipc(self, source, condition, parent_pipe=None,
1448
 
                   client_object=None):
1449
 
        condition_names = {
1450
 
            gobject.IO_IN: u"IN",   # There is data to read.
1451
 
            gobject.IO_OUT: u"OUT", # Data can be written (without
1452
 
                                    # blocking).
1453
 
            gobject.IO_PRI: u"PRI", # There is urgent data to read.
1454
 
            gobject.IO_ERR: u"ERR", # Error condition.
1455
 
            gobject.IO_HUP: u"HUP"  # Hung up (the connection has been
1456
 
                                    # broken, usually for pipes and
1457
 
                                    # sockets).
1458
 
            }
1459
 
        conditions_string = ' | '.join(name
1460
 
                                       for cond, name in
1461
 
                                       condition_names.iteritems()
1462
 
                                       if cond & condition)
1463
 
        logger.debug(u"Handling IPC: FD = %d, condition = %s", source,
1464
 
                     conditions_string)
1465
 
 
1466
 
        # XXXTEDDY error or the other end of multiprocessing.Pipe has closed
1467
 
        if condition & gobject.IO_HUP or condition & gobject.IO_ERR:
 
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()
1468
2063
            return False
1469
2064
        
1470
2065
        # Read a request from the child
1471
2066
        request = parent_pipe.recv()
1472
 
        logger.debug(u"IPC request: %s", repr(request))
1473
2067
        command = request[0]
1474
2068
        
1475
2069
        if command == 'init':
1476
2070
            fpr = request[1]
1477
2071
            address = request[2]
1478
2072
            
1479
 
            for c in self.clients:
 
2073
            for c in self.clients.itervalues():
1480
2074
                if c.fingerprint == fpr:
1481
2075
                    client = c
1482
2076
                    break
1483
2077
            else:
1484
 
                logger.warning(u"Client not found for fingerprint: %s, ad"
1485
 
                               u"dress: %s", fpr, address)
 
2078
                logger.info("Client not found for fingerprint: %s, ad"
 
2079
                            "dress: %s", fpr, address)
1486
2080
                if self.use_dbus:
1487
2081
                    # Emit D-Bus signal
1488
 
                    mandos_dbus_service.ClientNotFound(fpr, address)
 
2082
                    mandos_dbus_service.ClientNotFound(fpr,
 
2083
                                                       address[0])
1489
2084
                parent_pipe.send(False)
1490
2085
                return False
1491
2086
            
1492
2087
            gobject.io_add_watch(parent_pipe.fileno(),
1493
2088
                                 gobject.IO_IN | gobject.IO_HUP,
1494
2089
                                 functools.partial(self.handle_ipc,
1495
 
                                                   parent_pipe = parent_pipe,
1496
 
                                                   client_object = client))
 
2090
                                                   parent_pipe =
 
2091
                                                   parent_pipe,
 
2092
                                                   proc = proc,
 
2093
                                                   client_object =
 
2094
                                                   client))
1497
2095
            parent_pipe.send(True)
1498
 
            # 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
1499
2098
            return False
1500
2099
        if command == 'funcall':
1501
2100
            funcname = request[1]
1502
2101
            args = request[2]
1503
2102
            kwargs = request[3]
1504
2103
            
1505
 
            parent_pipe.send(('data', getattr(client_object, funcname)(*args, **kwargs)))
1506
 
 
 
2104
            parent_pipe.send(('data', getattr(client_object,
 
2105
                                              funcname)(*args,
 
2106
                                                         **kwargs)))
 
2107
        
1507
2108
        if command == 'getattr':
1508
2109
            attrname = request[1]
1509
2110
            if callable(client_object.__getattribute__(attrname)):
1510
2111
                parent_pipe.send(('function',))
1511
2112
            else:
1512
 
                parent_pipe.send(('data', client_object.__getattribute__(attrname)))
 
2113
                parent_pipe.send(('data', client_object
 
2114
                                  .__getattribute__(attrname)))
1513
2115
        
1514
2116
        if command == 'setattr':
1515
2117
            attrname = request[1]
1516
2118
            value = request[2]
1517
2119
            setattr(client_object, attrname, value)
1518
 
 
 
2120
        
1519
2121
        return True
1520
2122
 
1521
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
 
1522
2223
def string_to_delta(interval):
1523
2224
    """Parse a string and return a datetime.timedelta
1524
2225
    
1525
 
    >>> string_to_delta(u'7d')
 
2226
    >>> string_to_delta('7d')
1526
2227
    datetime.timedelta(7)
1527
 
    >>> string_to_delta(u'60s')
 
2228
    >>> string_to_delta('60s')
1528
2229
    datetime.timedelta(0, 60)
1529
 
    >>> string_to_delta(u'60m')
 
2230
    >>> string_to_delta('60m')
1530
2231
    datetime.timedelta(0, 3600)
1531
 
    >>> string_to_delta(u'24h')
 
2232
    >>> string_to_delta('24h')
1532
2233
    datetime.timedelta(1)
1533
 
    >>> string_to_delta(u'1w')
 
2234
    >>> string_to_delta('1w')
1534
2235
    datetime.timedelta(7)
1535
 
    >>> string_to_delta(u'5m 30s')
 
2236
    >>> string_to_delta('5m 30s')
1536
2237
    datetime.timedelta(0, 330)
1537
2238
    """
 
2239
    
 
2240
    try:
 
2241
        return rfc3339_duration_to_delta(interval)
 
2242
    except ValueError:
 
2243
        pass
 
2244
    
1538
2245
    timevalue = datetime.timedelta(0)
1539
2246
    for s in interval.split():
1540
2247
        try:
1541
2248
            suffix = unicode(s[-1])
1542
2249
            value = int(s[:-1])
1543
 
            if suffix == u"d":
 
2250
            if suffix == "d":
1544
2251
                delta = datetime.timedelta(value)
1545
 
            elif suffix == u"s":
 
2252
            elif suffix == "s":
1546
2253
                delta = datetime.timedelta(0, value)
1547
 
            elif suffix == u"m":
 
2254
            elif suffix == "m":
1548
2255
                delta = datetime.timedelta(0, 0, 0, 0, value)
1549
 
            elif suffix == u"h":
 
2256
            elif suffix == "h":
1550
2257
                delta = datetime.timedelta(0, 0, 0, 0, 0, value)
1551
 
            elif suffix == u"w":
 
2258
            elif suffix == "w":
1552
2259
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
1553
2260
            else:
1554
 
                raise ValueError(u"Unknown suffix %r" % suffix)
1555
 
        except (ValueError, IndexError), e:
1556
 
            raise ValueError(e.message)
 
2261
                raise ValueError("Unknown suffix {!r}"
 
2262
                                 .format(suffix))
 
2263
        except IndexError as e:
 
2264
            raise ValueError(*(e.args))
1557
2265
        timevalue += delta
1558
2266
    return timevalue
1559
2267
 
1560
2268
 
1561
 
def if_nametoindex(interface):
1562
 
    """Call the C function if_nametoindex(), or equivalent
1563
 
    
1564
 
    Note: This function cannot accept a unicode string."""
1565
 
    global if_nametoindex
1566
 
    try:
1567
 
        if_nametoindex = (ctypes.cdll.LoadLibrary
1568
 
                          (ctypes.util.find_library(u"c"))
1569
 
                          .if_nametoindex)
1570
 
    except (OSError, AttributeError):
1571
 
        logger.warning(u"Doing if_nametoindex the hard way")
1572
 
        def if_nametoindex(interface):
1573
 
            "Get an interface index the hard way, i.e. using fcntl()"
1574
 
            SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
1575
 
            with contextlib.closing(socket.socket()) as s:
1576
 
                ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1577
 
                                    struct.pack(str(u"16s16x"),
1578
 
                                                interface))
1579
 
            interface_index = struct.unpack(str(u"I"),
1580
 
                                            ifreq[16:20])[0]
1581
 
            return interface_index
1582
 
    return if_nametoindex(interface)
1583
 
 
1584
 
 
1585
2269
def daemon(nochdir = False, noclose = False):
1586
2270
    """See daemon(3).  Standard BSD Unix function.
1587
2271
    
1590
2274
        sys.exit()
1591
2275
    os.setsid()
1592
2276
    if not nochdir:
1593
 
        os.chdir(u"/")
 
2277
        os.chdir("/")
1594
2278
    if os.fork():
1595
2279
        sys.exit()
1596
2280
    if not noclose:
1597
2281
        # Close all standard open file descriptors
1598
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
2282
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1599
2283
        if not stat.S_ISCHR(os.fstat(null).st_mode):
1600
 
            raise OSError(errno.ENODEV,
1601
 
                          u"%s not a character device"
1602
 
                          % os.path.devnull)
 
2284
            raise OSError(errno.ENODEV, "{} not a character device"
 
2285
                          .format(os.devnull))
1603
2286
        os.dup2(null, sys.stdin.fileno())
1604
2287
        os.dup2(null, sys.stdout.fileno())
1605
2288
        os.dup2(null, sys.stderr.fileno())
1612
2295
    ##################################################################
1613
2296
    # Parsing of options, both command line and config file
1614
2297
    
1615
 
    parser = optparse.OptionParser(version = "%%prog %s" % version)
1616
 
    parser.add_option("-i", u"--interface", type=u"string",
1617
 
                      metavar="IF", help=u"Bind to interface IF")
1618
 
    parser.add_option("-a", u"--address", type=u"string",
1619
 
                      help=u"Address to listen for requests on")
1620
 
    parser.add_option("-p", u"--port", type=u"int",
1621
 
                      help=u"Port number to receive requests on")
1622
 
    parser.add_option("--check", action=u"store_true",
1623
 
                      help=u"Run self-test")
1624
 
    parser.add_option("--debug", action=u"store_true",
1625
 
                      help=u"Debug mode; run in foreground and log to"
1626
 
                      u" terminal")
1627
 
    parser.add_option("--priority", type=u"string", help=u"GnuTLS"
1628
 
                      u" priority string (see GnuTLS documentation)")
1629
 
    parser.add_option("--servicename", type=u"string",
1630
 
                      metavar=u"NAME", help=u"Zeroconf service name")
1631
 
    parser.add_option("--configdir", type=u"string",
1632
 
                      default=u"/etc/mandos", metavar=u"DIR",
1633
 
                      help=u"Directory to search for configuration"
1634
 
                      u" files")
1635
 
    parser.add_option("--no-dbus", action=u"store_false",
1636
 
                      dest=u"use_dbus", help=u"Do not provide D-Bus"
1637
 
                      u" system bus interface")
1638
 
    parser.add_option("--no-ipv6", action=u"store_false",
1639
 
                      dest=u"use_ipv6", help=u"Do not use IPv6")
1640
 
    options = parser.parse_args()[0]
 
2298
    parser = argparse.ArgumentParser()
 
2299
    parser.add_argument("-v", "--version", action="version",
 
2300
                        version = "%(prog)s {}".format(version),
 
2301
                        help="show version number and exit")
 
2302
    parser.add_argument("-i", "--interface", metavar="IF",
 
2303
                        help="Bind to interface IF")
 
2304
    parser.add_argument("-a", "--address",
 
2305
                        help="Address to listen for requests on")
 
2306
    parser.add_argument("-p", "--port", type=int,
 
2307
                        help="Port number to receive requests on")
 
2308
    parser.add_argument("--check", action="store_true",
 
2309
                        help="Run self-test")
 
2310
    parser.add_argument("--debug", action="store_true",
 
2311
                        help="Debug mode; run in foreground and log"
 
2312
                        " to terminal", default=None)
 
2313
    parser.add_argument("--debuglevel", metavar="LEVEL",
 
2314
                        help="Debug level for stdout output")
 
2315
    parser.add_argument("--priority", help="GnuTLS"
 
2316
                        " priority string (see GnuTLS documentation)")
 
2317
    parser.add_argument("--servicename",
 
2318
                        metavar="NAME", help="Zeroconf service name")
 
2319
    parser.add_argument("--configdir",
 
2320
                        default="/etc/mandos", metavar="DIR",
 
2321
                        help="Directory to search for configuration"
 
2322
                        " files")
 
2323
    parser.add_argument("--no-dbus", action="store_false",
 
2324
                        dest="use_dbus", help="Do not provide D-Bus"
 
2325
                        " system bus interface", default=None)
 
2326
    parser.add_argument("--no-ipv6", action="store_false",
 
2327
                        dest="use_ipv6", help="Do not use IPv6",
 
2328
                        default=None)
 
2329
    parser.add_argument("--no-restore", action="store_false",
 
2330
                        dest="restore", help="Do not restore stored"
 
2331
                        " state", default=None)
 
2332
    parser.add_argument("--socket", type=int,
 
2333
                        help="Specify a file descriptor to a network"
 
2334
                        " socket to use instead of creating one")
 
2335
    parser.add_argument("--statedir", metavar="DIR",
 
2336
                        help="Directory to save/restore state in")
 
2337
    parser.add_argument("--foreground", action="store_true",
 
2338
                        help="Run in foreground", default=None)
 
2339
    parser.add_argument("--no-zeroconf", action="store_false",
 
2340
                        dest="zeroconf", help="Do not use Zeroconf",
 
2341
                        default=None)
 
2342
    
 
2343
    options = parser.parse_args()
1641
2344
    
1642
2345
    if options.check:
1643
2346
        import doctest
1644
 
        doctest.testmod()
1645
 
        sys.exit()
 
2347
        fail_count, test_count = doctest.testmod()
 
2348
        sys.exit(os.EX_OK if fail_count == 0 else 1)
1646
2349
    
1647
2350
    # Default values for config file for server-global settings
1648
 
    server_defaults = { u"interface": u"",
1649
 
                        u"address": u"",
1650
 
                        u"port": u"",
1651
 
                        u"debug": u"False",
1652
 
                        u"priority":
1653
 
                        u"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1654
 
                        u"servicename": u"Mandos",
1655
 
                        u"use_dbus": u"True",
1656
 
                        u"use_ipv6": u"True",
 
2351
    server_defaults = { "interface": "",
 
2352
                        "address": "",
 
2353
                        "port": "",
 
2354
                        "debug": "False",
 
2355
                        "priority":
 
2356
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",
 
2357
                        "servicename": "Mandos",
 
2358
                        "use_dbus": "True",
 
2359
                        "use_ipv6": "True",
 
2360
                        "debuglevel": "",
 
2361
                        "restore": "True",
 
2362
                        "socket": "",
 
2363
                        "statedir": "/var/lib/mandos",
 
2364
                        "foreground": "False",
 
2365
                        "zeroconf": "True",
1657
2366
                        }
1658
2367
    
1659
2368
    # Parse config file for server-global settings
1660
2369
    server_config = configparser.SafeConfigParser(server_defaults)
1661
2370
    del server_defaults
1662
2371
    server_config.read(os.path.join(options.configdir,
1663
 
                                    u"mandos.conf"))
 
2372
                                    "mandos.conf"))
1664
2373
    # Convert the SafeConfigParser object to a dict
1665
2374
    server_settings = server_config.defaults()
1666
2375
    # Use the appropriate methods on the non-string config options
1667
 
    for option in (u"debug", u"use_dbus", u"use_ipv6"):
1668
 
        server_settings[option] = server_config.getboolean(u"DEFAULT",
 
2376
    for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
 
2377
        server_settings[option] = server_config.getboolean("DEFAULT",
1669
2378
                                                           option)
1670
2379
    if server_settings["port"]:
1671
 
        server_settings["port"] = server_config.getint(u"DEFAULT",
1672
 
                                                       u"port")
 
2380
        server_settings["port"] = server_config.getint("DEFAULT",
 
2381
                                                       "port")
 
2382
    if server_settings["socket"]:
 
2383
        server_settings["socket"] = server_config.getint("DEFAULT",
 
2384
                                                         "socket")
 
2385
        # Later, stdin will, and stdout and stderr might, be dup'ed
 
2386
        # over with an opened os.devnull.  But we don't want this to
 
2387
        # happen with a supplied network socket.
 
2388
        if 0 <= server_settings["socket"] <= 2:
 
2389
            server_settings["socket"] = os.dup(server_settings
 
2390
                                               ["socket"])
1673
2391
    del server_config
1674
2392
    
1675
2393
    # Override the settings from the config file with command line
1676
2394
    # options, if set.
1677
 
    for option in (u"interface", u"address", u"port", u"debug",
1678
 
                   u"priority", u"servicename", u"configdir",
1679
 
                   u"use_dbus", u"use_ipv6"):
 
2395
    for option in ("interface", "address", "port", "debug",
 
2396
                   "priority", "servicename", "configdir",
 
2397
                   "use_dbus", "use_ipv6", "debuglevel", "restore",
 
2398
                   "statedir", "socket", "foreground", "zeroconf"):
1680
2399
        value = getattr(options, option)
1681
2400
        if value is not None:
1682
2401
            server_settings[option] = value
1685
2404
    for option in server_settings.keys():
1686
2405
        if type(server_settings[option]) is str:
1687
2406
            server_settings[option] = unicode(server_settings[option])
 
2407
    # Force all boolean options to be boolean
 
2408
    for option in ("debug", "use_dbus", "use_ipv6", "restore",
 
2409
                   "foreground", "zeroconf"):
 
2410
        server_settings[option] = bool(server_settings[option])
 
2411
    # Debug implies foreground
 
2412
    if server_settings["debug"]:
 
2413
        server_settings["foreground"] = True
1688
2414
    # Now we have our good server settings in "server_settings"
1689
2415
    
1690
2416
    ##################################################################
1691
2417
    
 
2418
    if (not server_settings["zeroconf"] and
 
2419
        not (server_settings["port"]
 
2420
             or server_settings["socket"] != "")):
 
2421
            parser.error("Needs port or socket to work without"
 
2422
                         " Zeroconf")
 
2423
    
1692
2424
    # For convenience
1693
 
    debug = server_settings[u"debug"]
1694
 
    use_dbus = server_settings[u"use_dbus"]
1695
 
    use_ipv6 = server_settings[u"use_ipv6"]
1696
 
    
1697
 
    if not debug:
1698
 
        syslogger.setLevel(logging.WARNING)
1699
 
        console.setLevel(logging.WARNING)
1700
 
    
1701
 
    if server_settings[u"servicename"] != u"Mandos":
 
2425
    debug = server_settings["debug"]
 
2426
    debuglevel = server_settings["debuglevel"]
 
2427
    use_dbus = server_settings["use_dbus"]
 
2428
    use_ipv6 = server_settings["use_ipv6"]
 
2429
    stored_state_path = os.path.join(server_settings["statedir"],
 
2430
                                     stored_state_file)
 
2431
    foreground = server_settings["foreground"]
 
2432
    zeroconf = server_settings["zeroconf"]
 
2433
    
 
2434
    if debug:
 
2435
        initlogger(debug, logging.DEBUG)
 
2436
    else:
 
2437
        if not debuglevel:
 
2438
            initlogger(debug)
 
2439
        else:
 
2440
            level = getattr(logging, debuglevel.upper())
 
2441
            initlogger(debug, level)
 
2442
    
 
2443
    if server_settings["servicename"] != "Mandos":
1702
2444
        syslogger.setFormatter(logging.Formatter
1703
 
                               (u'Mandos (%s) [%%(process)d]:'
1704
 
                                u' %%(levelname)s: %%(message)s'
1705
 
                                % server_settings[u"servicename"]))
 
2445
                               ('Mandos ({}) [%(process)d]:'
 
2446
                                ' %(levelname)s: %(message)s'
 
2447
                                .format(server_settings
 
2448
                                        ["servicename"])))
1706
2449
    
1707
2450
    # Parse config file with clients
1708
 
    client_defaults = { u"timeout": u"1h",
1709
 
                        u"interval": u"5m",
1710
 
                        u"checker": u"fping -q -- %%(host)s",
1711
 
                        u"host": u"",
1712
 
                        u"approved_delay": u"0s",
1713
 
                        u"approved_duration": u"1s",
1714
 
                        }
1715
 
    client_config = configparser.SafeConfigParser(client_defaults)
1716
 
    client_config.read(os.path.join(server_settings[u"configdir"],
1717
 
                                    u"clients.conf"))
 
2451
    client_config = configparser.SafeConfigParser(Client
 
2452
                                                  .client_defaults)
 
2453
    client_config.read(os.path.join(server_settings["configdir"],
 
2454
                                    "clients.conf"))
1718
2455
    
1719
2456
    global mandos_dbus_service
1720
2457
    mandos_dbus_service = None
1721
2458
    
1722
 
    tcp_server = MandosServer((server_settings[u"address"],
1723
 
                               server_settings[u"port"]),
 
2459
    socketfd = None
 
2460
    if server_settings["socket"] != "":
 
2461
        socketfd = server_settings["socket"]
 
2462
    tcp_server = MandosServer((server_settings["address"],
 
2463
                               server_settings["port"]),
1724
2464
                              ClientHandler,
1725
 
                              interface=server_settings[u"interface"],
 
2465
                              interface=(server_settings["interface"]
 
2466
                                         or None),
1726
2467
                              use_ipv6=use_ipv6,
1727
2468
                              gnutls_priority=
1728
 
                              server_settings[u"priority"],
1729
 
                              use_dbus=use_dbus)
1730
 
    pidfilename = u"/var/run/mandos.pid"
1731
 
    try:
1732
 
        pidfile = open(pidfilename, u"w")
1733
 
    except IOError:
1734
 
        logger.error(u"Could not open file %r", pidfilename)
 
2469
                              server_settings["priority"],
 
2470
                              use_dbus=use_dbus,
 
2471
                              socketfd=socketfd)
 
2472
    if not foreground:
 
2473
        pidfilename = "/run/mandos.pid"
 
2474
        if not os.path.isdir("/run/."):
 
2475
            pidfilename = "/var/run/mandos.pid"
 
2476
        pidfile = None
 
2477
        try:
 
2478
            pidfile = open(pidfilename, "w")
 
2479
        except IOError as e:
 
2480
            logger.error("Could not open file %r", pidfilename,
 
2481
                         exc_info=e)
1735
2482
    
1736
 
    try:
1737
 
        uid = pwd.getpwnam(u"_mandos").pw_uid
1738
 
        gid = pwd.getpwnam(u"_mandos").pw_gid
1739
 
    except KeyError:
 
2483
    for name in ("_mandos", "mandos", "nobody"):
1740
2484
        try:
1741
 
            uid = pwd.getpwnam(u"mandos").pw_uid
1742
 
            gid = pwd.getpwnam(u"mandos").pw_gid
 
2485
            uid = pwd.getpwnam(name).pw_uid
 
2486
            gid = pwd.getpwnam(name).pw_gid
 
2487
            break
1743
2488
        except KeyError:
1744
 
            try:
1745
 
                uid = pwd.getpwnam(u"nobody").pw_uid
1746
 
                gid = pwd.getpwnam(u"nobody").pw_gid
1747
 
            except KeyError:
1748
 
                uid = 65534
1749
 
                gid = 65534
 
2489
            continue
 
2490
    else:
 
2491
        uid = 65534
 
2492
        gid = 65534
1750
2493
    try:
1751
2494
        os.setgid(gid)
1752
2495
        os.setuid(uid)
1753
 
    except OSError, error:
1754
 
        if error[0] != errno.EPERM:
1755
 
            raise error
 
2496
    except OSError as error:
 
2497
        if error.errno != errno.EPERM:
 
2498
            raise
1756
2499
    
1757
 
    # Enable all possible GnuTLS debugging
1758
2500
    if debug:
 
2501
        # Enable all possible GnuTLS debugging
 
2502
        
1759
2503
        # "Use a log level over 10 to enable all debugging options."
1760
2504
        # - GnuTLS manual
1761
2505
        gnutls.library.functions.gnutls_global_set_log_level(11)
1762
2506
        
1763
2507
        @gnutls.library.types.gnutls_log_func
1764
2508
        def debug_gnutls(level, string):
1765
 
            logger.debug(u"GnuTLS: %s", string[:-1])
 
2509
            logger.debug("GnuTLS: %s", string[:-1])
1766
2510
        
1767
2511
        (gnutls.library.functions
1768
2512
         .gnutls_global_set_log_function(debug_gnutls))
 
2513
        
 
2514
        # Redirect stdin so all checkers get /dev/null
 
2515
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
 
2516
        os.dup2(null, sys.stdin.fileno())
 
2517
        if null > 2:
 
2518
            os.close(null)
 
2519
    
 
2520
    # Need to fork before connecting to D-Bus
 
2521
    if not foreground:
 
2522
        # Close all input and output, do double fork, etc.
 
2523
        daemon()
 
2524
    
 
2525
    # multiprocessing will use threads, so before we use gobject we
 
2526
    # need to inform gobject that threads will be used.
 
2527
    gobject.threads_init()
1769
2528
    
1770
2529
    global main_loop
1771
2530
    # From the Avahi example code
1772
 
    DBusGMainLoop(set_as_default=True )
 
2531
    DBusGMainLoop(set_as_default=True)
1773
2532
    main_loop = gobject.MainLoop()
1774
2533
    bus = dbus.SystemBus()
1775
2534
    # End of Avahi example code
1776
2535
    if use_dbus:
1777
2536
        try:
1778
 
            bus_name = dbus.service.BusName(u"se.bsnet.fukt.Mandos",
 
2537
            bus_name = dbus.service.BusName("se.recompile.Mandos",
1779
2538
                                            bus, do_not_queue=True)
1780
 
        except dbus.exceptions.NameExistsException, e:
1781
 
            logger.error(unicode(e) + u", disabling D-Bus")
 
2539
            old_bus_name = (dbus.service.BusName
 
2540
                            ("se.bsnet.fukt.Mandos", bus,
 
2541
                             do_not_queue=True))
 
2542
        except dbus.exceptions.NameExistsException as e:
 
2543
            logger.error("Disabling D-Bus:", exc_info=e)
1782
2544
            use_dbus = False
1783
 
            server_settings[u"use_dbus"] = False
 
2545
            server_settings["use_dbus"] = False
1784
2546
            tcp_server.use_dbus = False
1785
 
    protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1786
 
    service = AvahiService(name = server_settings[u"servicename"],
1787
 
                           servicetype = u"_mandos._tcp",
1788
 
                           protocol = protocol, bus = bus)
1789
 
    if server_settings["interface"]:
1790
 
        service.interface = (if_nametoindex
1791
 
                             (str(server_settings[u"interface"])))
1792
 
 
 
2547
    if zeroconf:
 
2548
        protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
 
2549
        service = AvahiServiceToSyslog(name =
 
2550
                                       server_settings["servicename"],
 
2551
                                       servicetype = "_mandos._tcp",
 
2552
                                       protocol = protocol, bus = bus)
 
2553
        if server_settings["interface"]:
 
2554
            service.interface = (if_nametoindex
 
2555
                                 (str(server_settings["interface"])))
 
2556
    
1793
2557
    global multiprocessing_manager
1794
2558
    multiprocessing_manager = multiprocessing.Manager()
1795
2559
    
1796
2560
    client_class = Client
1797
2561
    if use_dbus:
1798
2562
        client_class = functools.partial(ClientDBus, bus = bus)
1799
 
    def client_config_items(config, section):
1800
 
        special_settings = {
1801
 
            "approved_by_default":
1802
 
                lambda: config.getboolean(section,
1803
 
                                          "approved_by_default"),
1804
 
            }
1805
 
        for name, value in config.items(section):
 
2563
    
 
2564
    client_settings = Client.config_parser(client_config)
 
2565
    old_client_settings = {}
 
2566
    clients_data = {}
 
2567
    
 
2568
    # This is used to redirect stdout and stderr for checker processes
 
2569
    global wnull
 
2570
    wnull = open(os.devnull, "w") # A writable /dev/null
 
2571
    # Only used if server is running in foreground but not in debug
 
2572
    # mode
 
2573
    if debug or not foreground:
 
2574
        wnull.close()
 
2575
    
 
2576
    # Get client data and settings from last running state.
 
2577
    if server_settings["restore"]:
 
2578
        try:
 
2579
            with open(stored_state_path, "rb") as stored_state:
 
2580
                clients_data, old_client_settings = (pickle.load
 
2581
                                                     (stored_state))
 
2582
            os.remove(stored_state_path)
 
2583
        except IOError as e:
 
2584
            if e.errno == errno.ENOENT:
 
2585
                logger.warning("Could not load persistent state: {}"
 
2586
                                .format(os.strerror(e.errno)))
 
2587
            else:
 
2588
                logger.critical("Could not load persistent state:",
 
2589
                                exc_info=e)
 
2590
                raise
 
2591
        except EOFError as e:
 
2592
            logger.warning("Could not load persistent state: "
 
2593
                           "EOFError:", exc_info=e)
 
2594
    
 
2595
    with PGPEngine() as pgp:
 
2596
        for client_name, client in clients_data.items():
 
2597
            # Skip removed clients
 
2598
            if client_name not in client_settings:
 
2599
                continue
 
2600
            
 
2601
            # Decide which value to use after restoring saved state.
 
2602
            # We have three different values: Old config file,
 
2603
            # new config file, and saved state.
 
2604
            # New config value takes precedence if it differs from old
 
2605
            # config value, otherwise use saved state.
 
2606
            for name, value in client_settings[client_name].items():
 
2607
                try:
 
2608
                    # For each value in new config, check if it
 
2609
                    # differs from the old config value (Except for
 
2610
                    # the "secret" attribute)
 
2611
                    if (name != "secret" and
 
2612
                        value != old_client_settings[client_name]
 
2613
                        [name]):
 
2614
                        client[name] = value
 
2615
                except KeyError:
 
2616
                    pass
 
2617
            
 
2618
            # Clients who has passed its expire date can still be
 
2619
            # enabled if its last checker was successful.  Clients
 
2620
            # whose checker succeeded before we stored its state is
 
2621
            # assumed to have successfully run all checkers during
 
2622
            # downtime.
 
2623
            if client["enabled"]:
 
2624
                if datetime.datetime.utcnow() >= client["expires"]:
 
2625
                    if not client["last_checked_ok"]:
 
2626
                        logger.warning(
 
2627
                            "disabling client {} - Client never "
 
2628
                            "performed a successful checker"
 
2629
                            .format(client_name))
 
2630
                        client["enabled"] = False
 
2631
                    elif client["last_checker_status"] != 0:
 
2632
                        logger.warning(
 
2633
                            "disabling client {} - Client last"
 
2634
                            " checker failed with error code {}"
 
2635
                            .format(client_name,
 
2636
                                    client["last_checker_status"]))
 
2637
                        client["enabled"] = False
 
2638
                    else:
 
2639
                        client["expires"] = (datetime.datetime
 
2640
                                             .utcnow()
 
2641
                                             + client["timeout"])
 
2642
                        logger.debug("Last checker succeeded,"
 
2643
                                     " keeping {} enabled"
 
2644
                                     .format(client_name))
1806
2645
            try:
1807
 
                yield (name, special_settings[name]())
1808
 
            except KeyError:
1809
 
                yield (name, value)
1810
 
    
1811
 
    tcp_server.clients.update(set(
1812
 
            client_class(name = section,
1813
 
                         config= dict(client_config_items(
1814
 
                        client_config, section)))
1815
 
            for section in client_config.sections()))
 
2646
                client["secret"] = (
 
2647
                    pgp.decrypt(client["encrypted_secret"],
 
2648
                                client_settings[client_name]
 
2649
                                ["secret"]))
 
2650
            except PGPError:
 
2651
                # If decryption fails, we use secret from new settings
 
2652
                logger.debug("Failed to decrypt {} old secret"
 
2653
                             .format(client_name))
 
2654
                client["secret"] = (
 
2655
                    client_settings[client_name]["secret"])
 
2656
    
 
2657
    # Add/remove clients based on new changes made to config
 
2658
    for client_name in (set(old_client_settings)
 
2659
                        - set(client_settings)):
 
2660
        del clients_data[client_name]
 
2661
    for client_name in (set(client_settings)
 
2662
                        - set(old_client_settings)):
 
2663
        clients_data[client_name] = client_settings[client_name]
 
2664
    
 
2665
    # Create all client objects
 
2666
    for client_name, client in clients_data.items():
 
2667
        tcp_server.clients[client_name] = client_class(
 
2668
            name = client_name, settings = client,
 
2669
            server_settings = server_settings)
 
2670
    
1816
2671
    if not tcp_server.clients:
1817
 
        logger.warning(u"No clients defined")
1818
 
    
1819
 
    if debug:
1820
 
        # Redirect stdin so all checkers get /dev/null
1821
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
1822
 
        os.dup2(null, sys.stdin.fileno())
1823
 
        if null > 2:
1824
 
            os.close(null)
1825
 
    else:
1826
 
        # No console logging
1827
 
        logger.removeHandler(console)
1828
 
        # Close all input and output, do double fork, etc.
1829
 
        daemon()
1830
 
    
1831
 
    try:
1832
 
        with pidfile:
1833
 
            pid = os.getpid()
1834
 
            pidfile.write(str(pid) + "\n")
 
2672
        logger.warning("No clients defined")
 
2673
    
 
2674
    if not foreground:
 
2675
        if pidfile is not None:
 
2676
            try:
 
2677
                with pidfile:
 
2678
                    pid = os.getpid()
 
2679
                    pidfile.write(str(pid) + "\n".encode("utf-8"))
 
2680
            except IOError:
 
2681
                logger.error("Could not write to file %r with PID %d",
 
2682
                             pidfilename, pid)
1835
2683
        del pidfile
1836
 
    except IOError:
1837
 
        logger.error(u"Could not write to file %r with PID %d",
1838
 
                     pidfilename, pid)
1839
 
    except NameError:
1840
 
        # "pidfile" was never created
1841
 
        pass
1842
 
    del pidfilename
 
2684
        del pidfilename
1843
2685
    
1844
 
    if not debug:
1845
 
        signal.signal(signal.SIGINT, signal.SIG_IGN)
1846
2686
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1847
2687
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
1848
2688
    
1849
2689
    if use_dbus:
1850
 
        class MandosDBusService(dbus.service.Object):
 
2690
        @alternate_dbus_interfaces({"se.recompile.Mandos":
 
2691
                                        "se.bsnet.fukt.Mandos"})
 
2692
        class MandosDBusService(DBusObjectWithProperties):
1851
2693
            """A D-Bus proxy object"""
1852
2694
            def __init__(self):
1853
 
                dbus.service.Object.__init__(self, bus, u"/")
1854
 
            _interface = u"se.bsnet.fukt.Mandos"
1855
 
            
1856
 
            @dbus.service.signal(_interface, signature=u"o")
 
2695
                dbus.service.Object.__init__(self, bus, "/")
 
2696
            _interface = "se.recompile.Mandos"
 
2697
            
 
2698
            @dbus_interface_annotations(_interface)
 
2699
            def _foo(self):
 
2700
                return { "org.freedesktop.DBus.Property"
 
2701
                         ".EmitsChangedSignal":
 
2702
                             "false"}
 
2703
            
 
2704
            @dbus.service.signal(_interface, signature="o")
1857
2705
            def ClientAdded(self, objpath):
1858
2706
                "D-Bus signal"
1859
2707
                pass
1860
2708
            
1861
 
            @dbus.service.signal(_interface, signature=u"ss")
 
2709
            @dbus.service.signal(_interface, signature="ss")
1862
2710
            def ClientNotFound(self, fingerprint, address):
1863
2711
                "D-Bus signal"
1864
2712
                pass
1865
2713
            
1866
 
            @dbus.service.signal(_interface, signature=u"os")
 
2714
            @dbus.service.signal(_interface, signature="os")
1867
2715
            def ClientRemoved(self, objpath, name):
1868
2716
                "D-Bus signal"
1869
2717
                pass
1870
2718
            
1871
 
            @dbus.service.method(_interface, out_signature=u"ao")
 
2719
            @dbus.service.method(_interface, out_signature="ao")
1872
2720
            def GetAllClients(self):
1873
2721
                "D-Bus method"
1874
2722
                return dbus.Array(c.dbus_object_path
1875
 
                                  for c in tcp_server.clients)
 
2723
                                  for c in
 
2724
                                  tcp_server.clients.itervalues())
1876
2725
            
1877
2726
            @dbus.service.method(_interface,
1878
 
                                 out_signature=u"a{oa{sv}}")
 
2727
                                 out_signature="a{oa{sv}}")
1879
2728
            def GetAllClientsWithProperties(self):
1880
2729
                "D-Bus method"
1881
2730
                return dbus.Dictionary(
1882
 
                    ((c.dbus_object_path, c.GetAll(u""))
1883
 
                     for c in tcp_server.clients),
1884
 
                    signature=u"oa{sv}")
 
2731
                    ((c.dbus_object_path, c.GetAll(""))
 
2732
                     for c in tcp_server.clients.itervalues()),
 
2733
                    signature="oa{sv}")
1885
2734
            
1886
 
            @dbus.service.method(_interface, in_signature=u"o")
 
2735
            @dbus.service.method(_interface, in_signature="o")
1887
2736
            def RemoveClient(self, object_path):
1888
2737
                "D-Bus method"
1889
 
                for c in tcp_server.clients:
 
2738
                for c in tcp_server.clients.itervalues():
1890
2739
                    if c.dbus_object_path == object_path:
1891
 
                        tcp_server.clients.remove(c)
 
2740
                        del tcp_server.clients[c.name]
1892
2741
                        c.remove_from_connection()
1893
2742
                        # Don't signal anything except ClientRemoved
1894
2743
                        c.disable(quiet=True)
1903
2752
    
1904
2753
    def cleanup():
1905
2754
        "Cleanup function; run on exit"
1906
 
        service.cleanup()
1907
 
        
 
2755
        if zeroconf:
 
2756
            service.cleanup()
 
2757
        
 
2758
        multiprocessing.active_children()
 
2759
        wnull.close()
 
2760
        if not (tcp_server.clients or client_settings):
 
2761
            return
 
2762
        
 
2763
        # Store client before exiting. Secrets are encrypted with key
 
2764
        # based on what config file has. If config file is
 
2765
        # removed/edited, old secret will thus be unrecovable.
 
2766
        clients = {}
 
2767
        with PGPEngine() as pgp:
 
2768
            for client in tcp_server.clients.itervalues():
 
2769
                key = client_settings[client.name]["secret"]
 
2770
                client.encrypted_secret = pgp.encrypt(client.secret,
 
2771
                                                      key)
 
2772
                client_dict = {}
 
2773
                
 
2774
                # A list of attributes that can not be pickled
 
2775
                # + secret.
 
2776
                exclude = { "bus", "changedstate", "secret",
 
2777
                            "checker", "server_settings" }
 
2778
                for name, typ in (inspect.getmembers
 
2779
                                  (dbus.service.Object)):
 
2780
                    exclude.add(name)
 
2781
                
 
2782
                client_dict["encrypted_secret"] = (client
 
2783
                                                   .encrypted_secret)
 
2784
                for attr in client.client_structure:
 
2785
                    if attr not in exclude:
 
2786
                        client_dict[attr] = getattr(client, attr)
 
2787
                
 
2788
                clients[client.name] = client_dict
 
2789
                del client_settings[client.name]["secret"]
 
2790
        
 
2791
        try:
 
2792
            with (tempfile.NamedTemporaryFile
 
2793
                  (mode='wb', suffix=".pickle", prefix='clients-',
 
2794
                   dir=os.path.dirname(stored_state_path),
 
2795
                   delete=False)) as stored_state:
 
2796
                pickle.dump((clients, client_settings), stored_state)
 
2797
                tempname=stored_state.name
 
2798
            os.rename(tempname, stored_state_path)
 
2799
        except (IOError, OSError) as e:
 
2800
            if not debug:
 
2801
                try:
 
2802
                    os.remove(tempname)
 
2803
                except NameError:
 
2804
                    pass
 
2805
            if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
 
2806
                logger.warning("Could not save persistent state: {}"
 
2807
                               .format(os.strerror(e.errno)))
 
2808
            else:
 
2809
                logger.warning("Could not save persistent state:",
 
2810
                               exc_info=e)
 
2811
                raise
 
2812
        
 
2813
        # Delete all clients, and settings from config
1908
2814
        while tcp_server.clients:
1909
 
            client = tcp_server.clients.pop()
 
2815
            name, client = tcp_server.clients.popitem()
1910
2816
            if use_dbus:
1911
2817
                client.remove_from_connection()
1912
 
            client.disable_hook = None
1913
2818
            # Don't signal anything except ClientRemoved
1914
2819
            client.disable(quiet=True)
1915
2820
            if use_dbus:
1916
2821
                # Emit D-Bus signal
1917
 
                mandos_dbus_service.ClientRemoved(client.dbus_object_path,
 
2822
                mandos_dbus_service.ClientRemoved(client
 
2823
                                                  .dbus_object_path,
1918
2824
                                                  client.name)
 
2825
        client_settings.clear()
1919
2826
    
1920
2827
    atexit.register(cleanup)
1921
2828
    
1922
 
    for client in tcp_server.clients:
 
2829
    for client in tcp_server.clients.itervalues():
1923
2830
        if use_dbus:
1924
2831
            # Emit D-Bus signal
1925
2832
            mandos_dbus_service.ClientAdded(client.dbus_object_path)
1926
 
        client.enable()
 
2833
        # Need to initiate checking of clients
 
2834
        if client.enabled:
 
2835
            client.init_checker()
1927
2836
    
1928
2837
    tcp_server.enable()
1929
2838
    tcp_server.server_activate()
1930
2839
    
1931
2840
    # Find out what port we got
1932
 
    service.port = tcp_server.socket.getsockname()[1]
 
2841
    if zeroconf:
 
2842
        service.port = tcp_server.socket.getsockname()[1]
1933
2843
    if use_ipv6:
1934
 
        logger.info(u"Now listening on address %r, port %d,"
1935
 
                    " flowinfo %d, scope_id %d"
1936
 
                    % tcp_server.socket.getsockname())
 
2844
        logger.info("Now listening on address %r, port %d,"
 
2845
                    " flowinfo %d, scope_id %d",
 
2846
                    *tcp_server.socket.getsockname())
1937
2847
    else:                       # IPv4
1938
 
        logger.info(u"Now listening on address %r, port %d"
1939
 
                    % tcp_server.socket.getsockname())
 
2848
        logger.info("Now listening on address %r, port %d",
 
2849
                    *tcp_server.socket.getsockname())
1940
2850
    
1941
2851
    #service.interface = tcp_server.socket.getsockname()[3]
1942
2852
    
1943
2853
    try:
1944
 
        # From the Avahi example code
1945
 
        try:
1946
 
            service.activate()
1947
 
        except dbus.exceptions.DBusException, error:
1948
 
            logger.critical(u"DBusException: %s", error)
1949
 
            cleanup()
1950
 
            sys.exit(1)
1951
 
        # End of Avahi example code
 
2854
        if zeroconf:
 
2855
            # From the Avahi example code
 
2856
            try:
 
2857
                service.activate()
 
2858
            except dbus.exceptions.DBusException as error:
 
2859
                logger.critical("D-Bus Exception", exc_info=error)
 
2860
                cleanup()
 
2861
                sys.exit(1)
 
2862
            # End of Avahi example code
1952
2863
        
1953
2864
        gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
1954
2865
                             lambda *args, **kwargs:
1955
2866
                             (tcp_server.handle_request
1956
2867
                              (*args[2:], **kwargs) or True))
1957
2868
        
1958
 
        logger.debug(u"Starting main loop")
 
2869
        logger.debug("Starting main loop")
1959
2870
        main_loop.run()
1960
 
    except AvahiError, error:
1961
 
        logger.critical(u"AvahiError: %s", error)
 
2871
    except AvahiError as error:
 
2872
        logger.critical("Avahi Error", exc_info=error)
1962
2873
        cleanup()
1963
2874
        sys.exit(1)
1964
2875
    except KeyboardInterrupt:
1965
2876
        if debug:
1966
 
            print >> sys.stderr
1967
 
        logger.debug(u"Server received KeyboardInterrupt")
1968
 
    logger.debug(u"Server exiting")
 
2877
            print("", file=sys.stderr)
 
2878
        logger.debug("Server received KeyboardInterrupt")
 
2879
    logger.debug("Server exiting")
1969
2880
    # Must run before the D-Bus bus name gets deregistered
1970
2881
    cleanup()
1971
2882