/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2014-02-16 02:42:42 UTC
  • Revision ID: teddy@recompile.se-20140216024242-9wiw1nkxgt7ohovj
Fix running of self-tests.

* debian/control (Build-Depends): Add Python dependencies to
                                  successfully run self-tests.
* debian/copyright: GPLv3 now has its own license file - use it.
* debian/watch: Set PGP signature URL.
* mandos (main): Bug fix: When running self-tests, set exit code.
* mandos-ctl (main): Cosmetic fix; use os.EX_OK instead of plain 0.

Show diffs side-by-side

added added

removed removed

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