/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 at bsnet
  • Date: 2011-07-31 13:05:34 UTC
  • Revision ID: teddy@fukt.bsnet.se-20110731130534-v4d9hsvek80ms9uo
* plugins.d/mandos-client.c (avahi_loop_with_timeout): Fix warning.
  (main): Disallow "--retry" arguments < 0.  Allow brackets [] around
          IPv6 addresses, as recommended by RFC 5952.  Bug fix: When
          using --connect, really use retry_interval, not 1 second.
* plugins.d/mandos-client.xml (DESCRIPTION): Add retry info.
  (--retry): Remove repeated word.

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.1"
 
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"""
314
179
        if self.entry_group_state_changed_match is not None:
316
181
            self.entry_group_state_changed_match = None
317
182
        if self.group is not None:
318
183
            self.group.Reset()
319
 
    
320
184
    def add(self):
321
185
        """Derived from the Avahi example code"""
322
186
        self.remove()
327
191
                avahi.DBUS_INTERFACE_ENTRY_GROUP)
328
192
        self.entry_group_state_changed_match = (
329
193
            self.group.connect_to_signal(
330
 
                'StateChanged', self.entry_group_state_changed))
 
194
                'StateChanged', self .entry_group_state_changed))
331
195
        logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
332
196
                     self.name, self.type)
333
197
        self.group.AddService(
339
203
            dbus.UInt16(self.port),
340
204
            avahi.string_array_to_txt_array(self.TXT))
341
205
        self.group.Commit()
342
 
    
343
206
    def entry_group_state_changed(self, state, error):
344
207
        """Derived from the Avahi example code"""
345
208
        logger.debug("Avahi entry group state change: %i", state)
351
214
            self.rename()
352
215
        elif state == avahi.ENTRY_GROUP_FAILURE:
353
216
            logger.critical("Avahi: Error in group state changed %s",
354
 
                            str(error))
355
 
            raise AvahiGroupError("State changed: {!s}".format(error))
356
 
    
 
217
                            unicode(error))
 
218
            raise AvahiGroupError("State changed: %s"
 
219
                                  % unicode(error))
357
220
    def cleanup(self):
358
221
        """Derived from the Avahi example code"""
359
222
        if self.group is not None:
360
223
            try:
361
224
                self.group.Free()
362
225
            except (dbus.exceptions.UnknownMethodException,
363
 
                    dbus.exceptions.DBusException):
 
226
                    dbus.exceptions.DBusException) as e:
364
227
                pass
365
228
            self.group = None
366
229
        self.remove()
367
 
    
368
230
    def server_state_changed(self, state, error=None):
369
231
        """Derived from the Avahi example code"""
370
232
        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
 
        }
 
233
        bad_states = { avahi.SERVER_INVALID:
 
234
                           "Zeroconf server invalid",
 
235
                       avahi.SERVER_REGISTERING: None,
 
236
                       avahi.SERVER_COLLISION:
 
237
                           "Zeroconf server name collision",
 
238
                       avahi.SERVER_FAILURE:
 
239
                           "Zeroconf server failure" }
377
240
        if state in bad_states:
378
241
            if bad_states[state] is not None:
379
242
                if error is None:
388
251
                logger.debug("Unknown state: %r", state)
389
252
            else:
390
253
                logger.debug("Unknown state: %r: %r", state, error)
391
 
    
392
254
    def activate(self):
393
255
        """Derived from the Avahi example code"""
394
256
        if self.server is None:
398
260
                                    follow_name_owner_changes=True),
399
261
                avahi.DBUS_INTERFACE_SERVER)
400
262
        self.server.connect_to_signal("StateChanged",
401
 
                                      self.server_state_changed)
 
263
                                 self.server_state_changed)
402
264
        self.server_state_changed(self.server.GetState())
403
265
 
404
266
 
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
267
class Client(object):
416
268
    """A representation of a client host served by this server.
417
269
    
418
270
    Attributes:
419
 
    approved:   bool(); 'None' if not yet approved/disapproved
 
271
    _approved:   bool(); 'None' if not yet approved/disapproved
420
272
    approval_delay: datetime.timedelta(); Time to wait for approval
421
273
    approval_duration: datetime.timedelta(); Duration of one approval
422
274
    checker:    subprocess.Popen(); a running checker process used
429
281
                     instance %(name)s can be used in the command.
430
282
    checker_initiator_tag: a gobject event source tag, or None
431
283
    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
284
    current_checker_command: string; current running checker_command
 
285
    disable_hook:  If set, called by disable() as disable_hook(self)
435
286
    disable_initiator_tag: a gobject event source tag, or None
436
287
    enabled:    bool()
437
288
    fingerprint: string (40 or 32 hexadecimal digits); used to
440
291
    interval:   datetime.timedelta(); How often to start a new checker
441
292
    last_approval_request: datetime.datetime(); (UTC) or None
442
293
    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
 
294
    last_enabled: datetime.datetime(); (UTC)
447
295
    name:       string; from the config file, used in log messages and
448
296
                        D-Bus identifiers
449
297
    secret:     bytestring; sent verbatim (over TLS) to client
450
298
    timeout:    datetime.timedelta(); How long from last_checked_ok
451
299
                                      until this client is disabled
452
 
    extended_timeout:   extra long timeout when secret has been sent
453
300
    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
301
    """
458
302
    
459
303
    runtime_expansions = ("approval_delay", "approval_duration",
460
 
                          "created", "enabled", "expires",
461
 
                          "fingerprint", "host", "interval",
462
 
                          "last_approval_request", "last_checked_ok",
 
304
                          "created", "enabled", "fingerprint",
 
305
                          "host", "interval", "last_checked_ok",
463
306
                          "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
307
    
476
308
    @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):
 
309
    def _timedelta_to_milliseconds(td):
 
310
        "Convert a datetime.timedelta() to milliseconds"
 
311
        return ((td.days * 24 * 60 * 60 * 1000)
 
312
                + (td.seconds * 1000)
 
313
                + (td.microseconds // 1000))
 
314
    
 
315
    def timeout_milliseconds(self):
 
316
        "Return the 'timeout' attribute in milliseconds"
 
317
        return self._timedelta_to_milliseconds(self.timeout)
 
318
    
 
319
    def interval_milliseconds(self):
 
320
        "Return the 'interval' attribute in milliseconds"
 
321
        return self._timedelta_to_milliseconds(self.interval)
 
322
 
 
323
    def approval_delay_milliseconds(self):
 
324
        return self._timedelta_to_milliseconds(self.approval_delay)
 
325
    
 
326
    def __init__(self, name = None, disable_hook=None, config=None):
 
327
        """Note: the 'checker' key in 'config' sets the
 
328
        'checker_command' attribute and *not* the 'checker'
 
329
        attribute."""
527
330
        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
 
        
 
331
        if config is None:
 
332
            config = {}
545
333
        logger.debug("Creating client %r", self.name)
 
334
        # Uppercase and remove spaces from fingerprint for later
 
335
        # comparison purposes with return value from the fingerprint()
 
336
        # function
 
337
        self.fingerprint = (config["fingerprint"].upper()
 
338
                            .replace(" ", ""))
546
339
        logger.debug("  Fingerprint: %s", self.fingerprint)
547
 
        self.created = settings.get("created",
548
 
                                    datetime.datetime.utcnow())
549
 
        
550
 
        # attributes specific for this server instance
 
340
        if "secret" in config:
 
341
            self.secret = config["secret"].decode("base64")
 
342
        elif "secfile" in config:
 
343
            with open(os.path.expanduser(os.path.expandvars
 
344
                                         (config["secfile"])),
 
345
                      "rb") as secfile:
 
346
                self.secret = secfile.read()
 
347
        else:
 
348
            raise TypeError("No secret or secfile for client %s"
 
349
                            % self.name)
 
350
        self.host = config.get("host", "")
 
351
        self.created = datetime.datetime.utcnow()
 
352
        self.enabled = False
 
353
        self.last_approval_request = None
 
354
        self.last_enabled = None
 
355
        self.last_checked_ok = None
 
356
        self.timeout = string_to_delta(config["timeout"])
 
357
        self.interval = string_to_delta(config["interval"])
 
358
        self.disable_hook = disable_hook
551
359
        self.checker = None
552
360
        self.checker_initiator_tag = None
553
361
        self.disable_initiator_tag = None
554
362
        self.checker_callback_tag = None
 
363
        self.checker_command = config["checker"]
555
364
        self.current_checker_command = None
556
 
        self.approved = None
 
365
        self.last_connect = None
 
366
        self._approved = None
 
367
        self.approved_by_default = config.get("approved_by_default",
 
368
                                              True)
557
369
        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)
 
370
        self.approval_delay = string_to_delta(
 
371
            config["approval_delay"])
 
372
        self.approval_duration = string_to_delta(
 
373
            config["approval_duration"])
 
374
        self.changedstate = multiprocessing_manager.Condition(multiprocessing_manager.Lock())
569
375
    
570
 
    # Send notice to process children that client state has changed
571
376
    def send_changedstate(self):
572
 
        with self.changedstate:
573
 
            self.changedstate.notify_all()
574
 
    
 
377
        self.changedstate.acquire()
 
378
        self.changedstate.notify_all()
 
379
        self.changedstate.release()
 
380
        
575
381
    def enable(self):
576
382
        """Start this client's checker and timeout hooks"""
577
383
        if getattr(self, "enabled", False):
578
384
            # Already enabled
579
385
            return
580
 
        self.expires = datetime.datetime.utcnow() + self.timeout
581
 
        self.enabled = True
 
386
        self.send_changedstate()
582
387
        self.last_enabled = datetime.datetime.utcnow()
583
 
        self.init_checker()
584
 
        self.send_changedstate()
 
388
        # Schedule a new checker to be started an 'interval' from now,
 
389
        # and every interval from then on.
 
390
        self.checker_initiator_tag = (gobject.timeout_add
 
391
                                      (self.interval_milliseconds(),
 
392
                                       self.start_checker))
 
393
        # Schedule a disable() when 'timeout' has passed
 
394
        self.disable_initiator_tag = (gobject.timeout_add
 
395
                                   (self.timeout_milliseconds(),
 
396
                                    self.disable))
 
397
        self.enabled = True
 
398
        # Also start a new checker *right now*.
 
399
        self.start_checker()
585
400
    
586
401
    def disable(self, quiet=True):
587
402
        """Disable this client."""
588
403
        if not getattr(self, "enabled", False):
589
404
            return False
590
405
        if not quiet:
 
406
            self.send_changedstate()
 
407
        if not quiet:
591
408
            logger.info("Disabling client %s", self.name)
592
 
        if getattr(self, "disable_initiator_tag", None) is not None:
 
409
        if getattr(self, "disable_initiator_tag", False):
593
410
            gobject.source_remove(self.disable_initiator_tag)
594
411
            self.disable_initiator_tag = None
595
 
        self.expires = None
596
 
        if getattr(self, "checker_initiator_tag", None) is not None:
 
412
        if getattr(self, "checker_initiator_tag", False):
597
413
            gobject.source_remove(self.checker_initiator_tag)
598
414
            self.checker_initiator_tag = None
599
415
        self.stop_checker()
 
416
        if self.disable_hook:
 
417
            self.disable_hook(self)
600
418
        self.enabled = False
601
 
        if not quiet:
602
 
            self.send_changedstate()
603
419
        # Do not run this again if called by a gobject.timeout_add
604
420
        return False
605
421
    
606
422
    def __del__(self):
 
423
        self.disable_hook = None
607
424
        self.disable()
608
425
    
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
426
    def checker_callback(self, pid, condition, command):
626
427
        """The checker has completed, so take appropriate actions."""
627
428
        self.checker_callback_tag = None
628
429
        self.checker = None
629
430
        if os.WIFEXITED(condition):
630
 
            self.last_checker_status = os.WEXITSTATUS(condition)
631
 
            if self.last_checker_status == 0:
 
431
            exitstatus = os.WEXITSTATUS(condition)
 
432
            if exitstatus == 0:
632
433
                logger.info("Checker for %(name)s succeeded",
633
434
                            vars(self))
634
435
                self.checked_ok()
635
436
            else:
636
 
                logger.info("Checker for %(name)s failed", vars(self))
 
437
                logger.info("Checker for %(name)s failed",
 
438
                            vars(self))
637
439
        else:
638
 
            self.last_checker_status = -1
639
440
            logger.warning("Checker for %(name)s crashed?",
640
441
                           vars(self))
641
442
    
642
443
    def checked_ok(self):
643
 
        """Assert that the client has been seen, alive and well."""
 
444
        """Bump up the timeout for this client.
 
445
        
 
446
        This should only be called when the client has been seen,
 
447
        alive and well.
 
448
        """
644
449
        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
 
450
        gobject.source_remove(self.disable_initiator_tag)
 
451
        self.disable_initiator_tag = (gobject.timeout_add
 
452
                                      (self.timeout_milliseconds(),
 
453
                                       self.disable))
659
454
    
660
455
    def need_approval(self):
661
456
        self.last_approval_request = datetime.datetime.utcnow()
666
461
        If a checker already exists, leave it running and do
667
462
        nothing."""
668
463
        # 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
 
464
        # did that, then if a checker (for some reason) started
 
465
        # running slowly and taking more than 'interval' time, the
 
466
        # client would inevitably timeout, since no checker would get
 
467
        # a chance to run to completion.  If we instead leave running
673
468
        # checkers alone, the checker would have to take more time
674
469
        # than 'timeout' for the client to be disabled, which is as it
675
470
        # should be.
677
472
        # If a checker exists, make sure it is not a zombie
678
473
        try:
679
474
            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
 
475
        except (AttributeError, OSError) as error:
 
476
            if (isinstance(error, OSError)
 
477
                and error.errno != errno.ECHILD):
 
478
                raise error
685
479
        else:
686
480
            if pid:
687
481
                logger.warning("Checker was a zombie")
690
484
                                      self.current_checker_command)
691
485
        # Start a new checker if needed
692
486
        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
487
            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
 
488
                # In case checker_command has exactly one % operator
 
489
                command = self.checker_command % self.host
 
490
            except TypeError:
 
491
                # Escape attributes for the shell
 
492
                escaped_attrs = dict(
 
493
                    (attr,
 
494
                     re.escape(unicode(str(getattr(self, attr, "")),
 
495
                                       errors=
 
496
                                       'replace')))
 
497
                    for attr in
 
498
                    self.runtime_expansions)
 
499
 
 
500
                try:
 
501
                    command = self.checker_command % escaped_attrs
 
502
                except TypeError as error:
 
503
                    logger.error('Could not format string "%s":'
 
504
                                 ' %s', self.checker_command, error)
 
505
                    return True # Try again later
704
506
            self.current_checker_command = command
705
507
            try:
706
 
                logger.info("Starting checker %r for %s", command,
707
 
                            self.name)
 
508
                logger.info("Starting checker %r for %s",
 
509
                            command, self.name)
708
510
                # We don't need to redirect stdout and stderr, since
709
511
                # in normal mode, that is already done by daemon(),
710
512
                # and in debug mode we don't want to.  (Stdin is
711
513
                # 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
514
                self.checker = subprocess.Popen(command,
721
515
                                                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:
 
516
                                                shell=True, cwd="/")
 
517
                self.checker_callback_tag = (gobject.child_watch_add
 
518
                                             (self.checker.pid,
 
519
                                              self.checker_callback,
 
520
                                              data=command))
 
521
                # The checker may have completed before the gobject
 
522
                # watch was added.  Check for this.
734
523
                pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
 
524
                if pid:
 
525
                    gobject.source_remove(self.checker_callback_tag)
 
526
                    self.checker_callback(pid, status, command)
735
527
            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)
 
528
                logger.error("Failed to start subprocess: %s",
 
529
                             error)
745
530
        # Re-run this periodically if run by gobject.timeout_add
746
531
        return True
747
532
    
754
539
            return
755
540
        logger.debug("Stopping checker for %(name)s", vars(self))
756
541
        try:
757
 
            self.checker.terminate()
 
542
            os.kill(self.checker.pid, signal.SIGTERM)
758
543
            #time.sleep(0.5)
759
544
            #if self.checker.poll() is None:
760
 
            #    self.checker.kill()
 
545
            #    os.kill(self.checker.pid, signal.SIGKILL)
761
546
        except OSError as error:
762
547
            if error.errno != errno.ESRCH: # No such process
763
548
                raise
764
549
        self.checker = None
765
550
 
766
 
 
767
 
def dbus_service_property(dbus_interface,
768
 
                          signature="v",
769
 
                          access="readwrite",
770
 
                          byte_arrays=False):
 
551
def dbus_service_property(dbus_interface, signature="v",
 
552
                          access="readwrite", byte_arrays=False):
771
553
    """Decorators for marking methods of a DBusObjectWithProperties to
772
554
    become properties on the D-Bus.
773
555
    
782
564
    # "Set" method, so we fail early here:
783
565
    if byte_arrays and signature != "ay":
784
566
        raise ValueError("Byte arrays not supported for non-'ay'"
785
 
                         " signature {!r}".format(signature))
786
 
    
 
567
                         " signature %r" % signature)
787
568
    def decorator(func):
788
569
        func._dbus_is_property = True
789
570
        func._dbus_interface = dbus_interface
794
575
            func._dbus_name = func._dbus_name[:-14]
795
576
        func._dbus_get_args_options = {'byte_arrays': byte_arrays }
796
577
        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
578
    return decorator
840
579
 
841
580
 
842
581
class DBusPropertyException(dbus.exceptions.DBusException):
843
582
    """A base class for D-Bus property-related exceptions
844
583
    """
845
 
    pass
 
584
    def __unicode__(self):
 
585
        return unicode(str(self))
846
586
 
847
587
 
848
588
class DBusPropertyAccessException(DBusPropertyException):
859
599
 
860
600
class DBusObjectWithProperties(dbus.service.Object):
861
601
    """A D-Bus object with properties.
862
 
    
 
602
 
863
603
    Classes inheriting from this can use the dbus_service_property
864
604
    decorator to expose methods as D-Bus properties.  It exposes the
865
605
    standard Get(), Set(), and GetAll() methods on the D-Bus.
866
606
    """
867
607
    
868
608
    @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)
 
609
    def _is_dbus_property(obj):
 
610
        return getattr(obj, "_dbus_is_property", False)
877
611
    
878
 
    def _get_all_dbus_things(self, thing):
 
612
    def _get_all_dbus_properties(self):
879
613
        """Returns a generator of (name, attribute) pairs
880
614
        """
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)))
 
615
        return ((prop._dbus_name, prop)
 
616
                for name, prop in
 
617
                inspect.getmembers(self, self._is_dbus_property))
886
618
    
887
619
    def _get_dbus_property(self, interface_name, property_name):
888
620
        """Returns a bound method if one exists which is a D-Bus
889
621
        property with the specified name and interface.
890
622
        """
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
 
        
 
623
        for name in (property_name,
 
624
                     property_name + "_dbus_property"):
 
625
            prop = getattr(self, name, None)
 
626
            if (prop is None
 
627
                or not self._is_dbus_property(prop)
 
628
                or prop._dbus_name != property_name
 
629
                or (interface_name and prop._dbus_interface
 
630
                    and interface_name != prop._dbus_interface)):
 
631
                continue
 
632
            return prop
898
633
        # No such property
899
 
        raise DBusPropertyNotFound("{}:{}.{}".format(
900
 
            self.dbus_object_path, interface_name, property_name))
 
634
        raise DBusPropertyNotFound(self.dbus_object_path + ":"
 
635
                                   + interface_name + "."
 
636
                                   + property_name)
901
637
    
902
 
    @dbus.service.method(dbus.PROPERTIES_IFACE,
903
 
                         in_signature="ss",
 
638
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
904
639
                         out_signature="v")
905
640
    def Get(self, interface_name, property_name):
906
641
        """Standard D-Bus property Get() method, see D-Bus standard.
924
659
            # The byte_arrays option is not supported yet on
925
660
            # signatures other than "ay".
926
661
            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))
 
662
                raise ValueError
 
663
            value = dbus.ByteArray(''.join(unichr(byte)
 
664
                                           for byte in value))
932
665
        prop(value)
933
666
    
934
 
    @dbus.service.method(dbus.PROPERTIES_IFACE,
935
 
                         in_signature="s",
 
667
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
936
668
                         out_signature="a{sv}")
937
669
    def GetAll(self, interface_name):
938
670
        """Standard D-Bus property GetAll() method, see D-Bus
939
671
        standard.
940
 
        
 
672
 
941
673
        Note: Will not include properties with access="write".
942
674
        """
943
 
        properties = {}
944
 
        for name, prop in self._get_all_dbus_things("property"):
 
675
        all = {}
 
676
        for name, prop in self._get_all_dbus_properties():
945
677
            if (interface_name
946
678
                and interface_name != prop._dbus_interface):
947
679
                # Interface non-empty but did not match
951
683
                continue
952
684
            value = prop()
953
685
            if not hasattr(value, "variant_level"):
954
 
                properties[name] = value
 
686
                all[name] = value
955
687
                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
 
688
            all[name] = type(value)(value, variant_level=
 
689
                                    value.variant_level+1)
 
690
        return dbus.Dictionary(all, signature="sv")
967
691
    
968
692
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
969
693
                         out_signature="s",
970
694
                         path_keyword='object_path',
971
695
                         connection_keyword='connection')
972
696
    def Introspect(self, object_path, connection):
973
 
        """Overloading of standard D-Bus method.
974
 
        
975
 
        Inserts property tags and interface annotation tags.
 
697
        """Standard D-Bus method, overloaded to insert property tags.
976
698
        """
977
699
        xmlstring = dbus.service.Object.Introspect(self, object_path,
978
700
                                                   connection)
979
701
        try:
980
702
            document = xml.dom.minidom.parseString(xmlstring)
981
 
            
982
703
            def make_tag(document, name, prop):
983
704
                e = document.createElement("property")
984
705
                e.setAttribute("name", name)
985
706
                e.setAttribute("type", prop._dbus_signature)
986
707
                e.setAttribute("access", prop._dbus_access)
987
708
                return e
988
 
            
989
709
            for if_tag in document.getElementsByTagName("interface"):
990
 
                # Add property tags
991
710
                for tag in (make_tag(document, name, prop)
992
711
                            for name, prop
993
 
                            in self._get_all_dbus_things("property")
 
712
                            in self._get_all_dbus_properties()
994
713
                            if prop._dbus_interface
995
714
                            == if_tag.getAttribute("name")):
996
715
                    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
716
                # Add the names to the return values for the
1027
717
                # "org.freedesktop.DBus.Properties" methods
1028
718
                if (if_tag.getAttribute("name")
1043
733
        except (AttributeError, xml.dom.DOMException,
1044
734
                xml.parsers.expat.ExpatError) as error:
1045
735
            logger.error("Failed to override Introspection method",
1046
 
                         exc_info=error)
 
736
                         error)
1047
737
        return xmlstring
1048
738
 
1049
739
 
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
740
class ClientDBus(Client, DBusObjectWithProperties):
1229
741
    """A Client class using D-Bus
1230
742
    
1234
746
    """
1235
747
    
1236
748
    runtime_expansions = (Client.runtime_expansions
1237
 
                          + ("dbus_object_path", ))
1238
 
    
1239
 
    _interface = "se.recompile.Mandos.Client"
 
749
                          + ("dbus_object_path",))
1240
750
    
1241
751
    # dbus.service.Object doesn't use super(), so we can't either.
1242
752
    
1243
753
    def __init__(self, bus = None, *args, **kwargs):
 
754
        self._approvals_pending = 0
1244
755
        self.bus = bus
1245
756
        Client.__init__(self, *args, **kwargs)
1246
757
        # Only now, when this client is initialized, can it show up on
1247
758
        # the D-Bus
1248
 
        client_object_name = str(self.name).translate(
 
759
        client_object_name = unicode(self.name).translate(
1249
760
            {ord("."): ord("_"),
1250
761
             ord("-"): ord("_")})
1251
 
        self.dbus_object_path = dbus.ObjectPath(
1252
 
            "/clients/" + client_object_name)
 
762
        self.dbus_object_path = (dbus.ObjectPath
 
763
                                 ("/clients/" + client_object_name))
1253
764
        DBusObjectWithProperties.__init__(self, self.bus,
1254
765
                                          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
 
766
        
 
767
    def _get_approvals_pending(self):
 
768
        return self._approvals_pending
 
769
    def _set_approvals_pending(self, value):
 
770
        old_value = self._approvals_pending
 
771
        self._approvals_pending = value
 
772
        bval = bool(value)
 
773
        if (hasattr(self, "dbus_object_path")
 
774
            and bval is not bool(old_value)):
 
775
            dbus_bool = dbus.Boolean(bval, variant_level=1)
 
776
            self.PropertyChanged(dbus.String("ApprovalPending"),
 
777
                                 dbus_bool)
 
778
 
 
779
    approvals_pending = property(_get_approvals_pending,
 
780
                                 _set_approvals_pending)
 
781
    del _get_approvals_pending, _set_approvals_pending
 
782
    
 
783
    @staticmethod
 
784
    def _datetime_to_dbus(dt, variant_level=0):
 
785
        """Convert a UTC datetime.datetime() to a D-Bus type."""
 
786
        return dbus.String(dt.isoformat(),
 
787
                           variant_level=variant_level)
 
788
    
 
789
    def enable(self):
 
790
        oldstate = getattr(self, "enabled", False)
 
791
        r = Client.enable(self)
 
792
        if oldstate != self.enabled:
 
793
            # Emit D-Bus signals
 
794
            self.PropertyChanged(dbus.String("Enabled"),
 
795
                                 dbus.Boolean(True, variant_level=1))
 
796
            self.PropertyChanged(
 
797
                dbus.String("LastEnabled"),
 
798
                self._datetime_to_dbus(self.last_enabled,
 
799
                                       variant_level=1))
 
800
        return r
 
801
    
 
802
    def disable(self, quiet = False):
 
803
        oldstate = getattr(self, "enabled", False)
 
804
        r = Client.disable(self, quiet=quiet)
 
805
        if not quiet and oldstate != self.enabled:
 
806
            # Emit D-Bus signal
 
807
            self.PropertyChanged(dbus.String("Enabled"),
 
808
                                 dbus.Boolean(False, variant_level=1))
 
809
        return r
1336
810
    
1337
811
    def __del__(self, *args, **kwargs):
1338
812
        try:
1347
821
                         *args, **kwargs):
1348
822
        self.checker_callback_tag = None
1349
823
        self.checker = None
 
824
        # Emit D-Bus signal
 
825
        self.PropertyChanged(dbus.String("CheckerRunning"),
 
826
                             dbus.Boolean(False, variant_level=1))
1350
827
        if os.WIFEXITED(condition):
1351
828
            exitstatus = os.WEXITSTATUS(condition)
1352
829
            # Emit D-Bus signal
1362
839
        return Client.checker_callback(self, pid, condition, command,
1363
840
                                       *args, **kwargs)
1364
841
    
 
842
    def checked_ok(self, *args, **kwargs):
 
843
        Client.checked_ok(self, *args, **kwargs)
 
844
        # Emit D-Bus signal
 
845
        self.PropertyChanged(
 
846
            dbus.String("LastCheckedOK"),
 
847
            (self._datetime_to_dbus(self.last_checked_ok,
 
848
                                    variant_level=1)))
 
849
    
 
850
    def need_approval(self, *args, **kwargs):
 
851
        r = Client.need_approval(self, *args, **kwargs)
 
852
        # Emit D-Bus signal
 
853
        self.PropertyChanged(
 
854
            dbus.String("LastApprovalRequest"),
 
855
            (self._datetime_to_dbus(self.last_approval_request,
 
856
                                    variant_level=1)))
 
857
        return r
 
858
    
1365
859
    def start_checker(self, *args, **kwargs):
1366
 
        old_checker_pid = getattr(self.checker, "pid", None)
 
860
        old_checker = self.checker
 
861
        if self.checker is not None:
 
862
            old_checker_pid = self.checker.pid
 
863
        else:
 
864
            old_checker_pid = None
1367
865
        r = Client.start_checker(self, *args, **kwargs)
1368
866
        # Only if new checker process was started
1369
867
        if (self.checker is not None
1370
868
            and old_checker_pid != self.checker.pid):
1371
869
            # Emit D-Bus signal
1372
870
            self.CheckerStarted(self.current_checker_command)
 
871
            self.PropertyChanged(
 
872
                dbus.String("CheckerRunning"),
 
873
                dbus.Boolean(True, variant_level=1))
1373
874
        return r
1374
875
    
 
876
    def stop_checker(self, *args, **kwargs):
 
877
        old_checker = getattr(self, "checker", None)
 
878
        r = Client.stop_checker(self, *args, **kwargs)
 
879
        if (old_checker is not None
 
880
            and getattr(self, "checker", None) is None):
 
881
            self.PropertyChanged(dbus.String("CheckerRunning"),
 
882
                                 dbus.Boolean(False, variant_level=1))
 
883
        return r
 
884
 
1375
885
    def _reset_approved(self):
1376
 
        self.approved = None
 
886
        self._approved = None
1377
887
        return False
1378
888
    
1379
889
    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
890
        self.send_changedstate()
 
891
        self._approved = value
 
892
        gobject.timeout_add(self._timedelta_to_milliseconds
 
893
                            (self.approval_duration),
 
894
                            self._reset_approved)
 
895
    
1384
896
    
1385
897
    ## D-Bus methods, signals & properties
1386
 
    
1387
 
    ## Interfaces
 
898
    _interface = "se.bsnet.fukt.Mandos.Client"
1388
899
    
1389
900
    ## Signals
1390
901
    
1401
912
        pass
1402
913
    
1403
914
    # PropertyChanged - signal
1404
 
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1405
915
    @dbus.service.signal(_interface, signature="sv")
1406
916
    def PropertyChanged(self, property, value):
1407
917
        "D-Bus signal"
1471
981
        return dbus.Boolean(bool(self.approvals_pending))
1472
982
    
1473
983
    # ApprovedByDefault - property
1474
 
    @dbus_service_property(_interface,
1475
 
                           signature="b",
 
984
    @dbus_service_property(_interface, signature="b",
1476
985
                           access="readwrite")
1477
986
    def ApprovedByDefault_dbus_property(self, value=None):
1478
987
        if value is None:       # get
1479
988
            return dbus.Boolean(self.approved_by_default)
1480
989
        self.approved_by_default = bool(value)
 
990
        # Emit D-Bus signal
 
991
        self.PropertyChanged(dbus.String("ApprovedByDefault"),
 
992
                             dbus.Boolean(value, variant_level=1))
1481
993
    
1482
994
    # ApprovalDelay - property
1483
 
    @dbus_service_property(_interface,
1484
 
                           signature="t",
 
995
    @dbus_service_property(_interface, signature="t",
1485
996
                           access="readwrite")
1486
997
    def ApprovalDelay_dbus_property(self, value=None):
1487
998
        if value is None:       # get
1488
 
            return dbus.UInt64(self.approval_delay.total_seconds()
1489
 
                               * 1000)
 
999
            return dbus.UInt64(self.approval_delay_milliseconds())
1490
1000
        self.approval_delay = datetime.timedelta(0, 0, 0, value)
 
1001
        # Emit D-Bus signal
 
1002
        self.PropertyChanged(dbus.String("ApprovalDelay"),
 
1003
                             dbus.UInt64(value, variant_level=1))
1491
1004
    
1492
1005
    # ApprovalDuration - property
1493
 
    @dbus_service_property(_interface,
1494
 
                           signature="t",
 
1006
    @dbus_service_property(_interface, signature="t",
1495
1007
                           access="readwrite")
1496
1008
    def ApprovalDuration_dbus_property(self, value=None):
1497
1009
        if value is None:       # get
1498
 
            return dbus.UInt64(self.approval_duration.total_seconds()
1499
 
                               * 1000)
 
1010
            return dbus.UInt64(self._timedelta_to_milliseconds(
 
1011
                    self.approval_duration))
1500
1012
        self.approval_duration = datetime.timedelta(0, 0, 0, value)
 
1013
        # Emit D-Bus signal
 
1014
        self.PropertyChanged(dbus.String("ApprovalDuration"),
 
1015
                             dbus.UInt64(value, variant_level=1))
1501
1016
    
1502
1017
    # Name - property
1503
1018
    @dbus_service_property(_interface, signature="s", access="read")
1510
1025
        return dbus.String(self.fingerprint)
1511
1026
    
1512
1027
    # Host - property
1513
 
    @dbus_service_property(_interface,
1514
 
                           signature="s",
 
1028
    @dbus_service_property(_interface, signature="s",
1515
1029
                           access="readwrite")
1516
1030
    def Host_dbus_property(self, value=None):
1517
1031
        if value is None:       # get
1518
1032
            return dbus.String(self.host)
1519
 
        self.host = str(value)
 
1033
        self.host = value
 
1034
        # Emit D-Bus signal
 
1035
        self.PropertyChanged(dbus.String("Host"),
 
1036
                             dbus.String(value, variant_level=1))
1520
1037
    
1521
1038
    # Created - property
1522
1039
    @dbus_service_property(_interface, signature="s", access="read")
1523
1040
    def Created_dbus_property(self):
1524
 
        return datetime_to_dbus(self.created)
 
1041
        return dbus.String(self._datetime_to_dbus(self.created))
1525
1042
    
1526
1043
    # LastEnabled - property
1527
1044
    @dbus_service_property(_interface, signature="s", access="read")
1528
1045
    def LastEnabled_dbus_property(self):
1529
 
        return datetime_to_dbus(self.last_enabled)
 
1046
        if self.last_enabled is None:
 
1047
            return dbus.String("")
 
1048
        return dbus.String(self._datetime_to_dbus(self.last_enabled))
1530
1049
    
1531
1050
    # Enabled - property
1532
 
    @dbus_service_property(_interface,
1533
 
                           signature="b",
 
1051
    @dbus_service_property(_interface, signature="b",
1534
1052
                           access="readwrite")
1535
1053
    def Enabled_dbus_property(self, value=None):
1536
1054
        if value is None:       # get
1541
1059
            self.disable()
1542
1060
    
1543
1061
    # LastCheckedOK - property
1544
 
    @dbus_service_property(_interface,
1545
 
                           signature="s",
 
1062
    @dbus_service_property(_interface, signature="s",
1546
1063
                           access="readwrite")
1547
1064
    def LastCheckedOK_dbus_property(self, value=None):
1548
1065
        if value is not None:
1549
1066
            self.checked_ok()
1550
1067
            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)
 
1068
        if self.last_checked_ok is None:
 
1069
            return dbus.String("")
 
1070
        return dbus.String(self._datetime_to_dbus(self
 
1071
                                                  .last_checked_ok))
1562
1072
    
1563
1073
    # LastApprovalRequest - property
1564
1074
    @dbus_service_property(_interface, signature="s", access="read")
1565
1075
    def LastApprovalRequest_dbus_property(self):
1566
 
        return datetime_to_dbus(self.last_approval_request)
 
1076
        if self.last_approval_request is None:
 
1077
            return dbus.String("")
 
1078
        return dbus.String(self.
 
1079
                           _datetime_to_dbus(self
 
1080
                                             .last_approval_request))
1567
1081
    
1568
1082
    # Timeout - property
1569
 
    @dbus_service_property(_interface,
1570
 
                           signature="t",
 
1083
    @dbus_service_property(_interface, signature="t",
1571
1084
                           access="readwrite")
1572
1085
    def Timeout_dbus_property(self, value=None):
1573
1086
        if value is None:       # get
1574
 
            return dbus.UInt64(self.timeout.total_seconds() * 1000)
1575
 
        old_timeout = self.timeout
 
1087
            return dbus.UInt64(self.timeout_milliseconds())
1576
1088
        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)
 
1089
        # Emit D-Bus signal
 
1090
        self.PropertyChanged(dbus.String("Timeout"),
 
1091
                             dbus.UInt64(value, variant_level=1))
 
1092
        if getattr(self, "disable_initiator_tag", None) is None:
 
1093
            return
 
1094
        # Reschedule timeout
 
1095
        gobject.source_remove(self.disable_initiator_tag)
 
1096
        self.disable_initiator_tag = None
 
1097
        time_to_die = (self.
 
1098
                       _timedelta_to_milliseconds((self
 
1099
                                                   .last_checked_ok
 
1100
                                                   + self.timeout)
 
1101
                                                  - datetime.datetime
 
1102
                                                  .utcnow()))
 
1103
        if time_to_die <= 0:
 
1104
            # The timeout has passed
 
1105
            self.disable()
 
1106
        else:
 
1107
            self.disable_initiator_tag = (gobject.timeout_add
 
1108
                                          (time_to_die, self.disable))
1602
1109
    
1603
1110
    # Interval - property
1604
 
    @dbus_service_property(_interface,
1605
 
                           signature="t",
 
1111
    @dbus_service_property(_interface, signature="t",
1606
1112
                           access="readwrite")
1607
1113
    def Interval_dbus_property(self, value=None):
1608
1114
        if value is None:       # get
1609
 
            return dbus.UInt64(self.interval.total_seconds() * 1000)
 
1115
            return dbus.UInt64(self.interval_milliseconds())
1610
1116
        self.interval = datetime.timedelta(0, 0, 0, value)
 
1117
        # Emit D-Bus signal
 
1118
        self.PropertyChanged(dbus.String("Interval"),
 
1119
                             dbus.UInt64(value, variant_level=1))
1611
1120
        if getattr(self, "checker_initiator_tag", None) is None:
1612
1121
            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
 
    
 
1122
        # Reschedule checker run
 
1123
        gobject.source_remove(self.checker_initiator_tag)
 
1124
        self.checker_initiator_tag = (gobject.timeout_add
 
1125
                                      (value, self.start_checker))
 
1126
        self.start_checker()    # Start one now, too
 
1127
 
1620
1128
    # Checker - property
1621
 
    @dbus_service_property(_interface,
1622
 
                           signature="s",
 
1129
    @dbus_service_property(_interface, signature="s",
1623
1130
                           access="readwrite")
1624
1131
    def Checker_dbus_property(self, value=None):
1625
1132
        if value is None:       # get
1626
1133
            return dbus.String(self.checker_command)
1627
 
        self.checker_command = str(value)
 
1134
        self.checker_command = value
 
1135
        # Emit D-Bus signal
 
1136
        self.PropertyChanged(dbus.String("Checker"),
 
1137
                             dbus.String(self.checker_command,
 
1138
                                         variant_level=1))
1628
1139
    
1629
1140
    # CheckerRunning - property
1630
 
    @dbus_service_property(_interface,
1631
 
                           signature="b",
 
1141
    @dbus_service_property(_interface, signature="b",
1632
1142
                           access="readwrite")
1633
1143
    def CheckerRunning_dbus_property(self, value=None):
1634
1144
        if value is None:       # get
1644
1154
        return self.dbus_object_path # is already a dbus.ObjectPath
1645
1155
    
1646
1156
    # Secret = property
1647
 
    @dbus_service_property(_interface,
1648
 
                           signature="ay",
1649
 
                           access="write",
1650
 
                           byte_arrays=True)
 
1157
    @dbus_service_property(_interface, signature="ay",
 
1158
                           access="write", byte_arrays=True)
1651
1159
    def Secret_dbus_property(self, value):
1652
 
        self.secret = bytes(value)
 
1160
        self.secret = str(value)
1653
1161
    
1654
1162
    del _interface
1655
1163
 
1660
1168
        self._pipe.send(('init', fpr, address))
1661
1169
        if not self._pipe.recv():
1662
1170
            raise KeyError()
1663
 
    
 
1171
 
1664
1172
    def __getattribute__(self, name):
1665
 
        if name == '_pipe':
 
1173
        if(name == '_pipe'):
1666
1174
            return super(ProxyClient, self).__getattribute__(name)
1667
1175
        self._pipe.send(('getattr', name))
1668
1176
        data = self._pipe.recv()
1669
1177
        if data[0] == 'data':
1670
1178
            return data[1]
1671
1179
        if data[0] == 'function':
1672
 
            
1673
1180
            def func(*args, **kwargs):
1674
1181
                self._pipe.send(('funcall', name, args, kwargs))
1675
1182
                return self._pipe.recv()[1]
1676
 
            
1677
1183
            return func
1678
 
    
 
1184
 
1679
1185
    def __setattr__(self, name, value):
1680
 
        if name == '_pipe':
 
1186
        if(name == '_pipe'):
1681
1187
            return super(ProxyClient, self).__setattr__(name, value)
1682
1188
        self._pipe.send(('setattr', name, value))
1683
1189
 
1691
1197
    def handle(self):
1692
1198
        with contextlib.closing(self.server.child_pipe) as child_pipe:
1693
1199
            logger.info("TCP connection from: %s",
1694
 
                        str(self.client_address))
 
1200
                        unicode(self.client_address))
1695
1201
            logger.debug("Pipe FD: %d",
1696
1202
                         self.server.child_pipe.fileno())
1697
 
            
1698
 
            session = gnutls.connection.ClientSession(
1699
 
                self.request, gnutls.connection .X509Credentials())
1700
 
            
 
1203
 
 
1204
            session = (gnutls.connection
 
1205
                       .ClientSession(self.request,
 
1206
                                      gnutls.connection
 
1207
                                      .X509Credentials()))
 
1208
 
1701
1209
            # Note: gnutls.connection.X509Credentials is really a
1702
1210
            # generic GnuTLS certificate credentials object so long as
1703
1211
            # no X.509 keys are added to it.  Therefore, we can use it
1704
1212
            # here despite using OpenPGP certificates.
1705
 
            
 
1213
 
1706
1214
            #priority = ':'.join(("NONE", "+VERS-TLS1.1",
1707
1215
            #                      "+AES-256-CBC", "+SHA1",
1708
1216
            #                      "+COMP-NULL", "+CTYPE-OPENPGP",
1711
1219
            priority = self.server.gnutls_priority
1712
1220
            if priority is None:
1713
1221
                priority = "NORMAL"
1714
 
            gnutls.library.functions.gnutls_priority_set_direct(
1715
 
                session._c_object, priority, None)
1716
 
            
 
1222
            (gnutls.library.functions
 
1223
             .gnutls_priority_set_direct(session._c_object,
 
1224
                                         priority, None))
 
1225
 
1717
1226
            # Start communication using the Mandos protocol
1718
1227
            # Get protocol number
1719
1228
            line = self.request.makefile().readline()
1720
1229
            logger.debug("Protocol version: %r", line)
1721
1230
            try:
1722
1231
                if int(line.strip().split()[0]) > 1:
1723
 
                    raise RuntimeError(line)
 
1232
                    raise RuntimeError
1724
1233
            except (ValueError, IndexError, RuntimeError) as error:
1725
1234
                logger.error("Unknown protocol version: %s", error)
1726
1235
                return
1727
 
            
 
1236
 
1728
1237
            # Start GnuTLS connection
1729
1238
            try:
1730
1239
                session.handshake()
1734
1243
                # established.  Just abandon the request.
1735
1244
                return
1736
1245
            logger.debug("Handshake succeeded")
1737
 
            
 
1246
 
1738
1247
            approval_required = False
1739
1248
            try:
1740
1249
                try:
1741
 
                    fpr = self.fingerprint(
1742
 
                        self.peer_certificate(session))
 
1250
                    fpr = self.fingerprint(self.peer_certificate
 
1251
                                           (session))
1743
1252
                except (TypeError,
1744
1253
                        gnutls.errors.GNUTLSError) as error:
1745
1254
                    logger.warning("Bad certificate: %s", error)
1746
1255
                    return
1747
1256
                logger.debug("Fingerprint: %s", fpr)
1748
 
                
 
1257
 
1749
1258
                try:
1750
1259
                    client = ProxyClient(child_pipe, fpr,
1751
1260
                                         self.client_address)
1760
1269
                while True:
1761
1270
                    if not client.enabled:
1762
1271
                        logger.info("Client %s is disabled",
1763
 
                                    client.name)
 
1272
                                       client.name)
1764
1273
                        if self.server.use_dbus:
1765
1274
                            # Emit D-Bus signal
1766
 
                            client.Rejected("Disabled")
 
1275
                            client.Rejected("Disabled")                    
1767
1276
                        return
1768
1277
                    
1769
 
                    if client.approved or not client.approval_delay:
 
1278
                    if client._approved or not client.approval_delay:
1770
1279
                        #We are approved or approval is disabled
1771
1280
                        break
1772
 
                    elif client.approved is None:
 
1281
                    elif client._approved is None:
1773
1282
                        logger.info("Client %s needs approval",
1774
1283
                                    client.name)
1775
1284
                        if self.server.use_dbus:
1776
1285
                            # Emit D-Bus signal
1777
1286
                            client.NeedApproval(
1778
 
                                client.approval_delay.total_seconds()
1779
 
                                * 1000, client.approved_by_default)
 
1287
                                client.approval_delay_milliseconds(),
 
1288
                                client.approved_by_default)
1780
1289
                    else:
1781
1290
                        logger.warning("Client %s was not approved",
1782
1291
                                       client.name)
1786
1295
                        return
1787
1296
                    
1788
1297
                    #wait until timeout or approved
 
1298
                    #x = float(client._timedelta_to_milliseconds(delay))
1789
1299
                    time = datetime.datetime.now()
1790
1300
                    client.changedstate.acquire()
1791
 
                    client.changedstate.wait(delay.total_seconds())
 
1301
                    client.changedstate.wait(float(client._timedelta_to_milliseconds(delay) / 1000))
1792
1302
                    client.changedstate.release()
1793
1303
                    time2 = datetime.datetime.now()
1794
1304
                    if (time2 - time) >= delay:
1810
1320
                    try:
1811
1321
                        sent = session.send(client.secret[sent_size:])
1812
1322
                    except gnutls.errors.GNUTLSError as error:
1813
 
                        logger.warning("gnutls send failed",
1814
 
                                       exc_info=error)
 
1323
                        logger.warning("gnutls send failed")
1815
1324
                        return
1816
 
                    logger.debug("Sent: %d, remaining: %d", sent,
1817
 
                                 len(client.secret) - (sent_size
1818
 
                                                       + sent))
 
1325
                    logger.debug("Sent: %d, remaining: %d",
 
1326
                                 sent, len(client.secret)
 
1327
                                 - (sent_size + sent))
1819
1328
                    sent_size += sent
1820
 
                
 
1329
 
1821
1330
                logger.info("Sending secret to %s", client.name)
1822
 
                # bump the timeout using extended_timeout
1823
 
                client.bump_timeout(client.extended_timeout)
 
1331
                # bump the timeout as if seen
 
1332
                client.checked_ok()
1824
1333
                if self.server.use_dbus:
1825
1334
                    # Emit D-Bus signal
1826
1335
                    client.GotSecret()
1831
1340
                try:
1832
1341
                    session.bye()
1833
1342
                except gnutls.errors.GNUTLSError as error:
1834
 
                    logger.warning("GnuTLS bye failed",
1835
 
                                   exc_info=error)
 
1343
                    logger.warning("GnuTLS bye failed")
1836
1344
    
1837
1345
    @staticmethod
1838
1346
    def peer_certificate(session):
1839
1347
        "Return the peer's OpenPGP certificate as a bytestring"
1840
1348
        # If not an OpenPGP certificate...
1841
 
        if (gnutls.library.functions.gnutls_certificate_type_get(
1842
 
                session._c_object)
 
1349
        if (gnutls.library.functions
 
1350
            .gnutls_certificate_type_get(session._c_object)
1843
1351
            != gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1844
1352
            # ...do the normal thing
1845
1353
            return session.peer_certificate
1859
1367
    def fingerprint(openpgp):
1860
1368
        "Convert an OpenPGP bytestring to a hexdigit fingerprint"
1861
1369
        # 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)))
 
1370
        datum = (gnutls.library.types
 
1371
                 .gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
 
1372
                                             ctypes.POINTER
 
1373
                                             (ctypes.c_ubyte)),
 
1374
                                 ctypes.c_uint(len(openpgp))))
1866
1375
        # New empty GnuTLS certificate
1867
1376
        crt = gnutls.library.types.gnutls_openpgp_crt_t()
1868
 
        gnutls.library.functions.gnutls_openpgp_crt_init(
1869
 
            ctypes.byref(crt))
 
1377
        (gnutls.library.functions
 
1378
         .gnutls_openpgp_crt_init(ctypes.byref(crt)))
1870
1379
        # 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)
 
1380
        (gnutls.library.functions
 
1381
         .gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
 
1382
                                    gnutls.library.constants
 
1383
                                    .GNUTLS_OPENPGP_FMT_RAW))
1874
1384
        # Verify the self signature in the key
1875
1385
        crtverify = ctypes.c_uint()
1876
 
        gnutls.library.functions.gnutls_openpgp_crt_verify_self(
1877
 
            crt, 0, ctypes.byref(crtverify))
 
1386
        (gnutls.library.functions
 
1387
         .gnutls_openpgp_crt_verify_self(crt, 0,
 
1388
                                         ctypes.byref(crtverify)))
1878
1389
        if crtverify.value != 0:
1879
1390
            gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1880
 
            raise gnutls.errors.CertificateSecurityError(
1881
 
                "Verify failed")
 
1391
            raise (gnutls.errors.CertificateSecurityError
 
1392
                   ("Verify failed"))
1882
1393
        # New buffer for the fingerprint
1883
1394
        buf = ctypes.create_string_buffer(20)
1884
1395
        buf_len = ctypes.c_size_t()
1885
1396
        # 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))
 
1397
        (gnutls.library.functions
 
1398
         .gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
 
1399
                                             ctypes.byref(buf_len)))
1888
1400
        # Deinit the certificate
1889
1401
        gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1890
1402
        # Convert the buffer to a Python bytestring
1891
1403
        fpr = ctypes.string_at(buf, buf_len.value)
1892
1404
        # Convert the bytestring to hexadecimal notation
1893
 
        hex_fpr = binascii.hexlify(fpr).upper()
 
1405
        hex_fpr = ''.join("%02X" % ord(char) for char in fpr)
1894
1406
        return hex_fpr
1895
1407
 
1896
1408
 
1897
1409
class MultiprocessingMixIn(object):
1898
1410
    """Like socketserver.ThreadingMixIn, but with multiprocessing"""
1899
 
    
1900
1411
    def sub_process_main(self, request, address):
1901
1412
        try:
1902
1413
            self.finish_request(request, address)
1903
 
        except Exception:
 
1414
        except:
1904
1415
            self.handle_error(request, address)
1905
1416
        self.close_request(request)
1906
 
    
 
1417
            
1907
1418
    def process_request(self, request, address):
1908
1419
        """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
 
 
 
1420
        multiprocessing.Process(target = self.sub_process_main,
 
1421
                                args = (request, address)).start()
1914
1422
 
1915
1423
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1916
1424
    """ adds a pipe to the MixIn """
1917
 
    
1918
1425
    def process_request(self, request, client_address):
1919
1426
        """Overrides and wraps the original process_request().
1920
1427
        
1921
1428
        This function creates a new pipe in self.pipe
1922
1429
        """
1923
1430
        parent_pipe, self.child_pipe = multiprocessing.Pipe()
1924
 
        
1925
 
        proc = MultiprocessingMixIn.process_request(self, request,
1926
 
                                                    client_address)
 
1431
 
 
1432
        super(MultiprocessingMixInWithPipe,
 
1433
              self).process_request(request, client_address)
1927
1434
        self.child_pipe.close()
1928
 
        self.add_pipe(parent_pipe, proc)
1929
 
    
1930
 
    def add_pipe(self, parent_pipe, proc):
 
1435
        self.add_pipe(parent_pipe)
 
1436
 
 
1437
    def add_pipe(self, parent_pipe):
1931
1438
        """Dummy function; override as necessary"""
1932
 
        raise NotImplementedError()
1933
 
 
 
1439
        raise NotImplementedError
1934
1440
 
1935
1441
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1936
1442
                     socketserver.TCPServer, object):
1941
1447
        interface:      None or a network interface name (string)
1942
1448
        use_ipv6:       Boolean; to use IPv6 or not
1943
1449
    """
1944
 
    
1945
1450
    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
 
        """
 
1451
                 interface=None, use_ipv6=True):
1952
1452
        self.interface = interface
1953
1453
        if use_ipv6:
1954
1454
            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
1455
        socketserver.TCPServer.__init__(self, server_address,
1982
1456
                                        RequestHandlerClass)
1983
 
    
1984
1457
    def server_bind(self):
1985
1458
        """This overrides the normal server_bind() function
1986
1459
        to bind to an interface if one was specified, and also NOT to
1992
1465
                             self.interface)
1993
1466
            else:
1994
1467
                try:
1995
 
                    self.socket.setsockopt(
1996
 
                        socket.SOL_SOCKET, SO_BINDTODEVICE,
1997
 
                        (self.interface + "\0").encode("utf-8"))
 
1468
                    self.socket.setsockopt(socket.SOL_SOCKET,
 
1469
                                           SO_BINDTODEVICE,
 
1470
                                           str(self.interface
 
1471
                                               + '\0'))
1998
1472
                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:
 
1473
                    if error[0] == errno.EPERM:
 
1474
                        logger.error("No permission to"
 
1475
                                     " bind to interface %s",
 
1476
                                     self.interface)
 
1477
                    elif error[0] == errno.ENOPROTOOPT:
2003
1478
                        logger.error("SO_BINDTODEVICE not available;"
2004
1479
                                     " cannot bind to interface %s",
2005
1480
                                     self.interface)
2006
 
                    elif error.errno == errno.ENODEV:
2007
 
                        logger.error("Interface %s does not exist,"
2008
 
                                     " cannot bind", self.interface)
2009
1481
                    else:
2010
1482
                        raise
2011
1483
        # Only bind(2) the socket if we really need to.
2014
1486
                if self.address_family == socket.AF_INET6:
2015
1487
                    any_address = "::" # in6addr_any
2016
1488
                else:
2017
 
                    any_address = "0.0.0.0" # INADDR_ANY
 
1489
                    any_address = socket.INADDR_ANY
2018
1490
                self.server_address = (any_address,
2019
1491
                                       self.server_address[1])
2020
1492
            elif not self.server_address[1]:
2021
 
                self.server_address = (self.server_address[0], 0)
 
1493
                self.server_address = (self.server_address[0],
 
1494
                                       0)
2022
1495
#                 if self.interface:
2023
1496
#                     self.server_address = (self.server_address[0],
2024
1497
#                                            0, # port
2038
1511
    
2039
1512
    Assumes a gobject.MainLoop event loop.
2040
1513
    """
2041
 
    
2042
1514
    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):
 
1515
                 interface=None, use_ipv6=True, clients=None,
 
1516
                 gnutls_priority=None, use_dbus=True):
2049
1517
        self.enabled = False
2050
1518
        self.clients = clients
2051
1519
        if self.clients is None:
2052
 
            self.clients = {}
 
1520
            self.clients = set()
2053
1521
        self.use_dbus = use_dbus
2054
1522
        self.gnutls_priority = gnutls_priority
2055
1523
        IPv6_TCPServer.__init__(self, server_address,
2056
1524
                                RequestHandlerClass,
2057
1525
                                interface = interface,
2058
 
                                use_ipv6 = use_ipv6,
2059
 
                                socketfd = socketfd)
2060
 
    
 
1526
                                use_ipv6 = use_ipv6)
2061
1527
    def server_activate(self):
2062
1528
        if self.enabled:
2063
1529
            return socketserver.TCPServer.server_activate(self)
2064
 
    
2065
1530
    def enable(self):
2066
1531
        self.enabled = True
2067
 
    
2068
 
    def add_pipe(self, parent_pipe, proc):
 
1532
    def add_pipe(self, parent_pipe):
2069
1533
        # 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,
 
1534
        gobject.io_add_watch(parent_pipe.fileno(),
 
1535
                             gobject.IO_IN | gobject.IO_HUP,
 
1536
                             functools.partial(self.handle_ipc,
 
1537
                                               parent_pipe = parent_pipe))
 
1538
        
 
1539
    def handle_ipc(self, source, condition, parent_pipe=None,
2080
1540
                   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()
 
1541
        condition_names = {
 
1542
            gobject.IO_IN: "IN",   # There is data to read.
 
1543
            gobject.IO_OUT: "OUT", # Data can be written (without
 
1544
                                    # blocking).
 
1545
            gobject.IO_PRI: "PRI", # There is urgent data to read.
 
1546
            gobject.IO_ERR: "ERR", # Error condition.
 
1547
            gobject.IO_HUP: "HUP"  # Hung up (the connection has been
 
1548
                                    # broken, usually for pipes and
 
1549
                                    # sockets).
 
1550
            }
 
1551
        conditions_string = ' | '.join(name
 
1552
                                       for cond, name in
 
1553
                                       condition_names.iteritems()
 
1554
                                       if cond & condition)
 
1555
        # error or the other end of multiprocessing.Pipe has closed
 
1556
        if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
2085
1557
            return False
2086
1558
        
2087
1559
        # Read a request from the child
2092
1564
            fpr = request[1]
2093
1565
            address = request[2]
2094
1566
            
2095
 
            for c in self.clients.itervalues():
 
1567
            for c in self.clients:
2096
1568
                if c.fingerprint == fpr:
2097
1569
                    client = c
2098
1570
                    break
2101
1573
                            "dress: %s", fpr, address)
2102
1574
                if self.use_dbus:
2103
1575
                    # Emit D-Bus signal
2104
 
                    mandos_dbus_service.ClientNotFound(fpr,
2105
 
                                                       address[0])
 
1576
                    mandos_dbus_service.ClientNotFound(fpr, address[0])
2106
1577
                parent_pipe.send(False)
2107
1578
                return False
2108
1579
            
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))
 
1580
            gobject.io_add_watch(parent_pipe.fileno(),
 
1581
                                 gobject.IO_IN | gobject.IO_HUP,
 
1582
                                 functools.partial(self.handle_ipc,
 
1583
                                                   parent_pipe = parent_pipe,
 
1584
                                                   client_object = client))
2116
1585
            parent_pipe.send(True)
2117
 
            # remove the old hook in favor of the new above hook on
2118
 
            # same fileno
 
1586
            # remove the old hook in favor of the new above hook on same fileno
2119
1587
            return False
2120
1588
        if command == 'funcall':
2121
1589
            funcname = request[1]
2122
1590
            args = request[2]
2123
1591
            kwargs = request[3]
2124
1592
            
2125
 
            parent_pipe.send(('data', getattr(client_object,
2126
 
                                              funcname)(*args,
2127
 
                                                        **kwargs)))
2128
 
        
 
1593
            parent_pipe.send(('data', getattr(client_object, funcname)(*args, **kwargs)))
 
1594
 
2129
1595
        if command == 'getattr':
2130
1596
            attrname = request[1]
2131
1597
            if callable(client_object.__getattribute__(attrname)):
2132
 
                parent_pipe.send(('function', ))
 
1598
                parent_pipe.send(('function',))
2133
1599
            else:
2134
 
                parent_pipe.send((
2135
 
                    'data', client_object.__getattribute__(attrname)))
 
1600
                parent_pipe.send(('data', client_object.__getattribute__(attrname)))
2136
1601
        
2137
1602
        if command == 'setattr':
2138
1603
            attrname = request[1]
2139
1604
            value = request[2]
2140
1605
            setattr(client_object, attrname, value)
2141
 
        
 
1606
 
2142
1607
        return True
2143
1608
 
2144
1609
 
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
1610
def string_to_delta(interval):
2250
1611
    """Parse a string and return a datetime.timedelta
2251
1612
    
2262
1623
    >>> string_to_delta('5m 30s')
2263
1624
    datetime.timedelta(0, 330)
2264
1625
    """
2265
 
    
2266
 
    try:
2267
 
        return rfc3339_duration_to_delta(interval)
2268
 
    except ValueError:
2269
 
        pass
2270
 
    
2271
1626
    timevalue = datetime.timedelta(0)
2272
1627
    for s in interval.split():
2273
1628
        try:
2274
 
            suffix = s[-1]
 
1629
            suffix = unicode(s[-1])
2275
1630
            value = int(s[:-1])
2276
1631
            if suffix == "d":
2277
1632
                delta = datetime.timedelta(value)
2284
1639
            elif suffix == "w":
2285
1640
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2286
1641
            else:
2287
 
                raise ValueError("Unknown suffix {!r}".format(suffix))
2288
 
        except IndexError as e:
 
1642
                raise ValueError("Unknown suffix %r" % suffix)
 
1643
        except (ValueError, IndexError) as e:
2289
1644
            raise ValueError(*(e.args))
2290
1645
        timevalue += delta
2291
1646
    return timevalue
2292
1647
 
2293
1648
 
 
1649
def if_nametoindex(interface):
 
1650
    """Call the C function if_nametoindex(), or equivalent
 
1651
    
 
1652
    Note: This function cannot accept a unicode string."""
 
1653
    global if_nametoindex
 
1654
    try:
 
1655
        if_nametoindex = (ctypes.cdll.LoadLibrary
 
1656
                          (ctypes.util.find_library("c"))
 
1657
                          .if_nametoindex)
 
1658
    except (OSError, AttributeError):
 
1659
        logger.warning("Doing if_nametoindex the hard way")
 
1660
        def if_nametoindex(interface):
 
1661
            "Get an interface index the hard way, i.e. using fcntl()"
 
1662
            SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
 
1663
            with contextlib.closing(socket.socket()) as s:
 
1664
                ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
 
1665
                                    struct.pack(str("16s16x"),
 
1666
                                                interface))
 
1667
            interface_index = struct.unpack(str("I"),
 
1668
                                            ifreq[16:20])[0]
 
1669
            return interface_index
 
1670
    return if_nametoindex(interface)
 
1671
 
 
1672
 
2294
1673
def daemon(nochdir = False, noclose = False):
2295
1674
    """See daemon(3).  Standard BSD Unix function.
2296
1675
    
2304
1683
        sys.exit()
2305
1684
    if not noclose:
2306
1685
        # Close all standard open file descriptors
2307
 
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
 
1686
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2308
1687
        if not stat.S_ISCHR(os.fstat(null).st_mode):
2309
1688
            raise OSError(errno.ENODEV,
2310
 
                          "{} not a character device"
2311
 
                          .format(os.devnull))
 
1689
                          "%s not a character device"
 
1690
                          % os.path.devnull)
2312
1691
        os.dup2(null, sys.stdin.fileno())
2313
1692
        os.dup2(null, sys.stdout.fileno())
2314
1693
        os.dup2(null, sys.stderr.fileno())
2323
1702
    
2324
1703
    parser = argparse.ArgumentParser()
2325
1704
    parser.add_argument("-v", "--version", action="version",
2326
 
                        version = "%(prog)s {}".format(version),
 
1705
                        version = "%%(prog)s %s" % version,
2327
1706
                        help="show version number and exit")
2328
1707
    parser.add_argument("-i", "--interface", metavar="IF",
2329
1708
                        help="Bind to interface IF")
2335
1714
                        help="Run self-test")
2336
1715
    parser.add_argument("--debug", action="store_true",
2337
1716
                        help="Debug mode; run in foreground and log"
2338
 
                        " to terminal", default=None)
 
1717
                        " to terminal")
2339
1718
    parser.add_argument("--debuglevel", metavar="LEVEL",
2340
1719
                        help="Debug level for stdout output")
2341
1720
    parser.add_argument("--priority", help="GnuTLS"
2348
1727
                        " files")
2349
1728
    parser.add_argument("--no-dbus", action="store_false",
2350
1729
                        dest="use_dbus", help="Do not provide D-Bus"
2351
 
                        " system bus interface", default=None)
 
1730
                        " system bus interface")
2352
1731
    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
 
    
 
1732
                        dest="use_ipv6", help="Do not use IPv6")
2369
1733
    options = parser.parse_args()
2370
1734
    
2371
1735
    if options.check:
2372
1736
        import doctest
2373
 
        fail_count, test_count = doctest.testmod()
2374
 
        sys.exit(os.EX_OK if fail_count == 0 else 1)
 
1737
        doctest.testmod()
 
1738
        sys.exit()
2375
1739
    
2376
1740
    # Default values for config file for server-global settings
2377
1741
    server_defaults = { "interface": "",
2379
1743
                        "port": "",
2380
1744
                        "debug": "False",
2381
1745
                        "priority":
2382
 
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2383
 
                        ":+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",
 
1746
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
2384
1747
                        "servicename": "Mandos",
2385
1748
                        "use_dbus": "True",
2386
1749
                        "use_ipv6": "True",
2387
1750
                        "debuglevel": "",
2388
 
                        "restore": "True",
2389
 
                        "socket": "",
2390
 
                        "statedir": "/var/lib/mandos",
2391
 
                        "foreground": "False",
2392
 
                        "zeroconf": "True",
2393
 
                    }
 
1751
                        }
2394
1752
    
2395
1753
    # Parse config file for server-global settings
2396
1754
    server_config = configparser.SafeConfigParser(server_defaults)
2397
1755
    del server_defaults
2398
 
    server_config.read(os.path.join(options.configdir, "mandos.conf"))
 
1756
    server_config.read(os.path.join(options.configdir,
 
1757
                                    "mandos.conf"))
2399
1758
    # Convert the SafeConfigParser object to a dict
2400
1759
    server_settings = server_config.defaults()
2401
1760
    # Use the appropriate methods on the non-string config options
2402
 
    for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
 
1761
    for option in ("debug", "use_dbus", "use_ipv6"):
2403
1762
        server_settings[option] = server_config.getboolean("DEFAULT",
2404
1763
                                                           option)
2405
1764
    if server_settings["port"]:
2406
1765
        server_settings["port"] = server_config.getint("DEFAULT",
2407
1766
                                                       "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
1767
    del server_config
2418
1768
    
2419
1769
    # Override the settings from the config file with command line
2420
1770
    # options, if set.
2421
1771
    for option in ("interface", "address", "port", "debug",
2422
 
                   "priority", "servicename", "configdir", "use_dbus",
2423
 
                   "use_ipv6", "debuglevel", "restore", "statedir",
2424
 
                   "socket", "foreground", "zeroconf"):
 
1772
                   "priority", "servicename", "configdir",
 
1773
                   "use_dbus", "use_ipv6", "debuglevel"):
2425
1774
        value = getattr(options, option)
2426
1775
        if value is not None:
2427
1776
            server_settings[option] = value
2428
1777
    del options
2429
1778
    # Force all strings to be unicode
2430
1779
    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
 
1780
        if type(server_settings[option]) is str:
 
1781
            server_settings[option] = unicode(server_settings[option])
2441
1782
    # Now we have our good server settings in "server_settings"
2442
1783
    
2443
1784
    ##################################################################
2444
1785
    
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
1786
    # For convenience
2451
1787
    debug = server_settings["debug"]
2452
1788
    debuglevel = server_settings["debuglevel"]
2453
1789
    use_dbus = server_settings["use_dbus"]
2454
1790
    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
 
    
 
1791
 
2469
1792
    if server_settings["servicename"] != "Mandos":
2470
 
        syslogger.setFormatter(
2471
 
            logging.Formatter('Mandos ({}) [%(process)d]:'
2472
 
                              ' %(levelname)s: %(message)s'.format(
2473
 
                                  server_settings["servicename"])))
 
1793
        syslogger.setFormatter(logging.Formatter
 
1794
                               ('Mandos (%s) [%%(process)d]:'
 
1795
                                ' %%(levelname)s: %%(message)s'
 
1796
                                % server_settings["servicename"]))
2474
1797
    
2475
1798
    # Parse config file with clients
2476
 
    client_config = configparser.SafeConfigParser(Client
2477
 
                                                  .client_defaults)
 
1799
    client_defaults = { "timeout": "1h",
 
1800
                        "interval": "5m",
 
1801
                        "checker": "fping -q -- %%(host)s",
 
1802
                        "host": "",
 
1803
                        "approval_delay": "0s",
 
1804
                        "approval_duration": "1s",
 
1805
                        }
 
1806
    client_config = configparser.SafeConfigParser(client_defaults)
2478
1807
    client_config.read(os.path.join(server_settings["configdir"],
2479
1808
                                    "clients.conf"))
2480
1809
    
2481
1810
    global mandos_dbus_service
2482
1811
    mandos_dbus_service = None
2483
1812
    
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
 
1813
    tcp_server = MandosServer((server_settings["address"],
 
1814
                               server_settings["port"]),
 
1815
                              ClientHandler,
 
1816
                              interface=(server_settings["interface"]
 
1817
                                         or None),
 
1818
                              use_ipv6=use_ipv6,
 
1819
                              gnutls_priority=
 
1820
                              server_settings["priority"],
 
1821
                              use_dbus=use_dbus)
 
1822
    if not debug:
 
1823
        pidfilename = "/var/run/mandos.pid"
2500
1824
        try:
2501
1825
            pidfile = open(pidfilename, "w")
2502
 
        except IOError as e:
2503
 
            logger.error("Could not open file %r", pidfilename,
2504
 
                         exc_info=e)
 
1826
        except IOError:
 
1827
            logger.error("Could not open file %r", pidfilename)
2505
1828
    
2506
 
    for name in ("_mandos", "mandos", "nobody"):
 
1829
    try:
 
1830
        uid = pwd.getpwnam("_mandos").pw_uid
 
1831
        gid = pwd.getpwnam("_mandos").pw_gid
 
1832
    except KeyError:
2507
1833
        try:
2508
 
            uid = pwd.getpwnam(name).pw_uid
2509
 
            gid = pwd.getpwnam(name).pw_gid
2510
 
            break
 
1834
            uid = pwd.getpwnam("mandos").pw_uid
 
1835
            gid = pwd.getpwnam("mandos").pw_gid
2511
1836
        except KeyError:
2512
 
            continue
2513
 
    else:
2514
 
        uid = 65534
2515
 
        gid = 65534
 
1837
            try:
 
1838
                uid = pwd.getpwnam("nobody").pw_uid
 
1839
                gid = pwd.getpwnam("nobody").pw_gid
 
1840
            except KeyError:
 
1841
                uid = 65534
 
1842
                gid = 65534
2516
1843
    try:
2517
1844
        os.setgid(gid)
2518
1845
        os.setuid(uid)
2519
1846
    except OSError as error:
2520
 
        if error.errno != errno.EPERM:
2521
 
            raise
 
1847
        if error[0] != errno.EPERM:
 
1848
            raise error
2522
1849
    
 
1850
    if not debug and not debuglevel:
 
1851
        syslogger.setLevel(logging.WARNING)
 
1852
        console.setLevel(logging.WARNING)
 
1853
    if debuglevel:
 
1854
        level = getattr(logging, debuglevel.upper())
 
1855
        syslogger.setLevel(level)
 
1856
        console.setLevel(level)
 
1857
 
2523
1858
    if debug:
2524
1859
        # Enable all possible GnuTLS debugging
2525
1860
        
2531
1866
        def debug_gnutls(level, string):
2532
1867
            logger.debug("GnuTLS: %s", string[:-1])
2533
1868
        
2534
 
        gnutls.library.functions.gnutls_global_set_log_function(
2535
 
            debug_gnutls)
 
1869
        (gnutls.library.functions
 
1870
         .gnutls_global_set_log_function(debug_gnutls))
2536
1871
        
2537
1872
        # Redirect stdin so all checkers get /dev/null
2538
 
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
 
1873
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2539
1874
        os.dup2(null, sys.stdin.fileno())
2540
1875
        if null > 2:
2541
1876
            os.close(null)
 
1877
    else:
 
1878
        # No console logging
 
1879
        logger.removeHandler(console)
2542
1880
    
2543
1881
    # Need to fork before connecting to D-Bus
2544
 
    if not foreground:
 
1882
    if not debug:
2545
1883
        # Close all input and output, do double fork, etc.
2546
1884
        daemon()
2547
1885
    
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
1886
    global main_loop
2553
1887
    # From the Avahi example code
2554
 
    DBusGMainLoop(set_as_default=True)
 
1888
    DBusGMainLoop(set_as_default=True )
2555
1889
    main_loop = gobject.MainLoop()
2556
1890
    bus = dbus.SystemBus()
2557
1891
    # End of Avahi example code
2558
1892
    if use_dbus:
2559
1893
        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)
 
1894
            bus_name = dbus.service.BusName("se.bsnet.fukt.Mandos",
 
1895
                                            bus, do_not_queue=True)
2566
1896
        except dbus.exceptions.NameExistsException as e:
2567
 
            logger.error("Disabling D-Bus:", exc_info=e)
 
1897
            logger.error(unicode(e) + ", disabling D-Bus")
2568
1898
            use_dbus = False
2569
1899
            server_settings["use_dbus"] = False
2570
1900
            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"))
 
1901
    protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
 
1902
    service = AvahiService(name = server_settings["servicename"],
 
1903
                           servicetype = "_mandos._tcp",
 
1904
                           protocol = protocol, bus = bus)
 
1905
    if server_settings["interface"]:
 
1906
        service.interface = (if_nametoindex
 
1907
                             (str(server_settings["interface"])))
2581
1908
    
2582
1909
    global multiprocessing_manager
2583
1910
    multiprocessing_manager = multiprocessing.Manager()
2585
1912
    client_class = Client
2586
1913
    if use_dbus:
2587
1914
        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))
 
1915
    def client_config_items(config, section):
 
1916
        special_settings = {
 
1917
            "approved_by_default":
 
1918
                lambda: config.getboolean(section,
 
1919
                                          "approved_by_default"),
 
1920
            }
 
1921
        for name, value in config.items(section):
2672
1922
            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
 
    
 
1923
                yield (name, special_settings[name]())
 
1924
            except KeyError:
 
1925
                yield (name, value)
 
1926
    
 
1927
    tcp_server.clients.update(set(
 
1928
            client_class(name = section,
 
1929
                         config= dict(client_config_items(
 
1930
                        client_config, section)))
 
1931
            for section in client_config.sections()))
2698
1932
    if not tcp_server.clients:
2699
1933
        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
 
1934
        
 
1935
    if not debug:
 
1936
        try:
 
1937
            with pidfile:
 
1938
                pid = os.getpid()
 
1939
                pidfile.write(str(pid) + "\n".encode("utf-8"))
 
1940
            del pidfile
 
1941
        except IOError:
 
1942
            logger.error("Could not write to file %r with PID %d",
 
1943
                         pidfilename, pid)
 
1944
        except NameError:
 
1945
            # "pidfile" was never created
 
1946
            pass
2711
1947
        del pidfilename
2712
 
    
 
1948
        
 
1949
        signal.signal(signal.SIGINT, signal.SIG_IGN)
 
1950
 
2713
1951
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2714
1952
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2715
1953
    
2716
1954
    if use_dbus:
2717
 
        
2718
 
        @alternate_dbus_interfaces(
2719
 
            { "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
2720
 
        class MandosDBusService(DBusObjectWithProperties):
 
1955
        class MandosDBusService(dbus.service.Object):
2721
1956
            """A D-Bus proxy object"""
2722
 
            
2723
1957
            def __init__(self):
2724
1958
                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" }
 
1959
            _interface = "se.bsnet.fukt.Mandos"
2733
1960
            
2734
1961
            @dbus.service.signal(_interface, signature="o")
2735
1962
            def ClientAdded(self, objpath):
2749
1976
            @dbus.service.method(_interface, out_signature="ao")
2750
1977
            def GetAllClients(self):
2751
1978
                "D-Bus method"
2752
 
                return dbus.Array(c.dbus_object_path for c in
2753
 
                                  tcp_server.clients.itervalues())
 
1979
                return dbus.Array(c.dbus_object_path
 
1980
                                  for c in tcp_server.clients)
2754
1981
            
2755
1982
            @dbus.service.method(_interface,
2756
1983
                                 out_signature="a{oa{sv}}")
2757
1984
            def GetAllClientsWithProperties(self):
2758
1985
                "D-Bus method"
2759
1986
                return dbus.Dictionary(
2760
 
                    { c.dbus_object_path: c.GetAll("")
2761
 
                      for c in tcp_server.clients.itervalues() },
 
1987
                    ((c.dbus_object_path, c.GetAll(""))
 
1988
                     for c in tcp_server.clients),
2762
1989
                    signature="oa{sv}")
2763
1990
            
2764
1991
            @dbus.service.method(_interface, in_signature="o")
2765
1992
            def RemoveClient(self, object_path):
2766
1993
                "D-Bus method"
2767
 
                for c in tcp_server.clients.itervalues():
 
1994
                for c in tcp_server.clients:
2768
1995
                    if c.dbus_object_path == object_path:
2769
 
                        del tcp_server.clients[c.name]
 
1996
                        tcp_server.clients.remove(c)
2770
1997
                        c.remove_from_connection()
2771
1998
                        # Don't signal anything except ClientRemoved
2772
1999
                        c.disable(quiet=True)
2781
2008
    
2782
2009
    def cleanup():
2783
2010
        "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
 
2011
        service.cleanup()
 
2012
        
2845
2013
        while tcp_server.clients:
2846
 
            name, client = tcp_server.clients.popitem()
 
2014
            client = tcp_server.clients.pop()
2847
2015
            if use_dbus:
2848
2016
                client.remove_from_connection()
 
2017
            client.disable_hook = None
2849
2018
            # Don't signal anything except ClientRemoved
2850
2019
            client.disable(quiet=True)
2851
2020
            if use_dbus:
2852
2021
                # Emit D-Bus signal
2853
 
                mandos_dbus_service.ClientRemoved(
2854
 
                    client.dbus_object_path, client.name)
2855
 
        client_settings.clear()
 
2022
                mandos_dbus_service.ClientRemoved(client.dbus_object_path,
 
2023
                                                  client.name)
2856
2024
    
2857
2025
    atexit.register(cleanup)
2858
2026
    
2859
 
    for client in tcp_server.clients.itervalues():
 
2027
    for client in tcp_server.clients:
2860
2028
        if use_dbus:
2861
2029
            # Emit D-Bus signal
2862
2030
            mandos_dbus_service.ClientAdded(client.dbus_object_path)
2863
 
        # Need to initiate checking of clients
2864
 
        if client.enabled:
2865
 
            client.init_checker()
 
2031
        client.enable()
2866
2032
    
2867
2033
    tcp_server.enable()
2868
2034
    tcp_server.server_activate()
2869
2035
    
2870
2036
    # Find out what port we got
2871
 
    if zeroconf:
2872
 
        service.port = tcp_server.socket.getsockname()[1]
 
2037
    service.port = tcp_server.socket.getsockname()[1]
2873
2038
    if use_ipv6:
2874
2039
        logger.info("Now listening on address %r, port %d,"
2875
 
                    " flowinfo %d, scope_id %d",
2876
 
                    *tcp_server.socket.getsockname())
 
2040
                    " flowinfo %d, scope_id %d"
 
2041
                    % tcp_server.socket.getsockname())
2877
2042
    else:                       # IPv4
2878
 
        logger.info("Now listening on address %r, port %d",
2879
 
                    *tcp_server.socket.getsockname())
 
2043
        logger.info("Now listening on address %r, port %d"
 
2044
                    % tcp_server.socket.getsockname())
2880
2045
    
2881
2046
    #service.interface = tcp_server.socket.getsockname()[3]
2882
2047
    
2883
2048
    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
 
2049
        # From the Avahi example code
 
2050
        try:
 
2051
            service.activate()
 
2052
        except dbus.exceptions.DBusException as error:
 
2053
            logger.critical("DBusException: %s", error)
 
2054
            cleanup()
 
2055
            sys.exit(1)
 
2056
        # End of Avahi example code
2893
2057
        
2894
2058
        gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2895
2059
                             lambda *args, **kwargs:
2899
2063
        logger.debug("Starting main loop")
2900
2064
        main_loop.run()
2901
2065
    except AvahiError as error:
2902
 
        logger.critical("Avahi Error", exc_info=error)
 
2066
        logger.critical("AvahiError: %s", error)
2903
2067
        cleanup()
2904
2068
        sys.exit(1)
2905
2069
    except KeyboardInterrupt:
2910
2074
    # Must run before the D-Bus bus name gets deregistered
2911
2075
    cleanup()
2912
2076
 
2913
 
 
2914
2077
if __name__ == '__main__':
2915
2078
    main()