/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: 2011-04-02 06:37:18 UTC
  • Revision ID: teddy@fukt.bsnet.se-20110402063718-13ldrcuu0t33sdc4
* mandos: Tolerate restarting Avahi servers.  Also Changed to new
          "except x as y" exception syntax.
  (AvahiService.entry_group_state_changed_match): New; contains the
                                                  SignalMatch object.
  (AvahiService.remove): Really remove the group and the signal
                         connection, if any.
  (AvahiService.add): Always create a new group and signal connection.
  (AvahiService.cleanup): Changed to simply call remove().
  (AvahiService.server_state_changed): Handle and log more bad states.
  (AvahiService.activate): Set "follow_name_owner_changes=True" on the
                           Avahi Server proxy object.
  (ClientDBus.checked_ok): Do not return anything.
  (ClientDBus.CheckedOK): Do not return anything, as documented.
* mandos-monitor: Call D-Bus methods asynchronously.

Show diffs side-by-side

added added

removed removed

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