/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2014-06-06 02:24:31 UTC
  • mfrom: (237.7.233 trunk)
  • Revision ID: teddy@recompile.se-20140606022431-kbagp9sf3drdyc6w
Merge from trunk.

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