/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Björn Påhlsson
  • Date: 2011-10-02 19:18:24 UTC
  • mto: This revision was merged to the branch mainline in revision 505.
  • Revision ID: belorn@fukt.bsnet.se-20111002191824-eweh4pvneeg3qzia
transitional stuff actually working
documented change to D-Bus API

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