/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2014-07-25 22:17:55 UTC
  • mto: (237.7.272 trunk)
  • mto: This revision was merged to the branch mainline in revision 321.
  • Revision ID: teddy@recompile.se-20140725221755-7bak9szduz53wwtq
INSTALL: Add org-mode setting to show all text when opening.

* INSTALL (STARTUP): New org-mode setting; set to "showall".

Show diffs side-by-side

added added

removed removed

Lines of Context:
11
11
# "AvahiService" class, and some lines in "main".
12
12
13
13
# Everything else is
14
 
# Copyright © 2008-2011 Teddy Hogeborn
15
 
# Copyright © 2008-2011 Björn Påhlsson
 
14
# Copyright © 2008-2014 Teddy Hogeborn
 
15
# Copyright © 2008-2014 Björn Påhlsson
16
16
17
17
# This program is free software: you can redistribute it and/or modify
18
18
# it under the terms of the GNU General Public License as published by
28
28
# along with this program.  If not, see
29
29
# <http://www.gnu.org/licenses/>.
30
30
31
 
# Contact the authors at <mandos@fukt.bsnet.se>.
 
31
# Contact the authors at <mandos@recompile.se>.
32
32
33
33
 
34
34
from __future__ import (division, absolute_import, print_function,
35
35
                        unicode_literals)
36
36
 
 
37
from future_builtins import *
 
38
 
37
39
import SocketServer as socketserver
38
40
import socket
39
41
import argparse
63
65
import cPickle as pickle
64
66
import multiprocessing
65
67
import types
 
68
import binascii
 
69
import tempfile
 
70
import itertools
 
71
import collections
66
72
 
67
73
import dbus
68
74
import dbus.service
82
88
    except ImportError:
83
89
        SO_BINDTODEVICE = None
84
90
 
85
 
 
86
 
version = "1.3.1"
87
 
 
88
 
#logger = logging.getLogger('mandos')
89
 
logger = logging.Logger('mandos')
90
 
syslogger = (logging.handlers.SysLogHandler
91
 
             (facility = logging.handlers.SysLogHandler.LOG_DAEMON,
92
 
              address = str("/dev/log")))
93
 
syslogger.setFormatter(logging.Formatter
94
 
                       ('Mandos [%(process)d]: %(levelname)s:'
95
 
                        ' %(message)s'))
96
 
logger.addHandler(syslogger)
97
 
 
98
 
console = logging.StreamHandler()
99
 
console.setFormatter(logging.Formatter('%(name)s [%(process)d]:'
100
 
                                       ' %(levelname)s:'
101
 
                                       ' %(message)s'))
102
 
logger.addHandler(console)
 
91
version = "1.6.7"
 
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
 
103
223
 
104
224
class AvahiError(Exception):
105
225
    def __init__(self, value, *args, **kwargs):
123
243
               Used to optionally bind to the specified interface.
124
244
    name: string; Example: 'Mandos'
125
245
    type: string; Example: '_mandos._tcp'.
126
 
                  See <http://www.dns-sd.org/ServiceTypes.html>
 
246
     See <https://www.iana.org/assignments/service-names-port-numbers>
127
247
    port: integer; what port to announce
128
248
    TXT: list of strings; TXT record for the service
129
249
    domain: string; Domain to publish on, default to .local if empty.
135
255
    server: D-Bus Server
136
256
    bus: dbus.SystemBus()
137
257
    """
 
258
    
138
259
    def __init__(self, interface = avahi.IF_UNSPEC, name = None,
139
260
                 servicetype = None, port = None, TXT = None,
140
261
                 domain = "", host = "", max_renames = 32768,
153
274
        self.server = None
154
275
        self.bus = bus
155
276
        self.entry_group_state_changed_match = None
 
277
    
156
278
    def rename(self):
157
279
        """Derived from the Avahi example code"""
158
280
        if self.rename_count >= self.max_renames:
160
282
                            " after %i retries, exiting.",
161
283
                            self.rename_count)
162
284
            raise AvahiServiceError("Too many renames")
163
 
        self.name = unicode(self.server.GetAlternativeServiceName(self.name))
 
285
        self.name = unicode(self.server
 
286
                            .GetAlternativeServiceName(self.name))
164
287
        logger.info("Changing Zeroconf service name to %r ...",
165
288
                    self.name)
166
 
        syslogger.setFormatter(logging.Formatter
167
 
                               ('Mandos (%s) [%%(process)d]:'
168
 
                                ' %%(levelname)s: %%(message)s'
169
 
                                % self.name))
170
289
        self.remove()
171
290
        try:
172
291
            self.add()
173
292
        except dbus.exceptions.DBusException as error:
174
 
            logger.critical("DBusException: %s", error)
 
293
            logger.critical("D-Bus Exception", exc_info=error)
175
294
            self.cleanup()
176
295
            os._exit(1)
177
296
        self.rename_count += 1
 
297
    
178
298
    def remove(self):
179
299
        """Derived from the Avahi example code"""
180
300
        if self.entry_group_state_changed_match is not None:
182
302
            self.entry_group_state_changed_match = None
183
303
        if self.group is not None:
184
304
            self.group.Reset()
 
305
    
185
306
    def add(self):
186
307
        """Derived from the Avahi example code"""
187
308
        self.remove()
192
313
                avahi.DBUS_INTERFACE_ENTRY_GROUP)
193
314
        self.entry_group_state_changed_match = (
194
315
            self.group.connect_to_signal(
195
 
                'StateChanged', self .entry_group_state_changed))
 
316
                'StateChanged', self.entry_group_state_changed))
196
317
        logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
197
318
                     self.name, self.type)
198
319
        self.group.AddService(
204
325
            dbus.UInt16(self.port),
205
326
            avahi.string_array_to_txt_array(self.TXT))
206
327
        self.group.Commit()
 
328
    
207
329
    def entry_group_state_changed(self, state, error):
208
330
        """Derived from the Avahi example code"""
209
331
        logger.debug("Avahi entry group state change: %i", state)
216
338
        elif state == avahi.ENTRY_GROUP_FAILURE:
217
339
            logger.critical("Avahi: Error in group state changed %s",
218
340
                            unicode(error))
219
 
            raise AvahiGroupError("State changed: %s"
220
 
                                  % unicode(error))
 
341
            raise AvahiGroupError("State changed: {0!s}"
 
342
                                  .format(error))
 
343
    
221
344
    def cleanup(self):
222
345
        """Derived from the Avahi example code"""
223
346
        if self.group is not None:
224
347
            try:
225
348
                self.group.Free()
226
349
            except (dbus.exceptions.UnknownMethodException,
227
 
                    dbus.exceptions.DBusException) as e:
 
350
                    dbus.exceptions.DBusException):
228
351
                pass
229
352
            self.group = None
230
353
        self.remove()
 
354
    
231
355
    def server_state_changed(self, state, error=None):
232
356
        """Derived from the Avahi example code"""
233
357
        logger.debug("Avahi server state change: %i", state)
252
376
                logger.debug("Unknown state: %r", state)
253
377
            else:
254
378
                logger.debug("Unknown state: %r: %r", state, error)
 
379
    
255
380
    def activate(self):
256
381
        """Derived from the Avahi example code"""
257
382
        if self.server is None:
265
390
        self.server_state_changed(self.server.GetState())
266
391
 
267
392
 
268
 
def _timedelta_to_milliseconds(td):
 
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):
269
405
    "Convert a datetime.timedelta() to milliseconds"
270
406
    return ((td.days * 24 * 60 * 60 * 1000)
271
407
            + (td.seconds * 1000)
272
408
            + (td.microseconds // 1000))
273
 
        
 
409
 
 
410
 
274
411
class Client(object):
275
412
    """A representation of a client host served by this server.
276
413
    
277
414
    Attributes:
278
 
    _approved:   bool(); 'None' if not yet approved/disapproved
 
415
    approved:   bool(); 'None' if not yet approved/disapproved
279
416
    approval_delay: datetime.timedelta(); Time to wait for approval
280
417
    approval_duration: datetime.timedelta(); Duration of one approval
281
418
    checker:    subprocess.Popen(); a running checker process used
288
425
                     instance %(name)s can be used in the command.
289
426
    checker_initiator_tag: a gobject event source tag, or None
290
427
    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
291
430
    current_checker_command: string; current running checker_command
292
 
    disable_hook:  If set, called by disable() as disable_hook(self)
293
431
    disable_initiator_tag: a gobject event source tag, or None
294
432
    enabled:    bool()
295
433
    fingerprint: string (40 or 32 hexadecimal digits); used to
298
436
    interval:   datetime.timedelta(); How often to start a new checker
299
437
    last_approval_request: datetime.datetime(); (UTC) or None
300
438
    last_checked_ok: datetime.datetime(); (UTC) or None
301
 
    last_enabled: datetime.datetime(); (UTC)
 
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
302
443
    name:       string; from the config file, used in log messages and
303
444
                        D-Bus identifiers
304
445
    secret:     bytestring; sent verbatim (over TLS) to client
305
446
    timeout:    datetime.timedelta(); How long from last_checked_ok
306
447
                                      until this client is disabled
307
 
    extended_timeout:   extra long timeout when password has been sent
 
448
    extended_timeout:   extra long timeout when secret has been sent
308
449
    runtime_expansions: Allowed attributes for runtime expansion.
309
450
    expires:    datetime.datetime(); time (UTC) when a client will be
310
451
                disabled, or None
 
452
    server_settings: The server_settings dict from main()
311
453
    """
312
454
    
313
455
    runtime_expansions = ("approval_delay", "approval_duration",
314
 
                          "created", "enabled", "fingerprint",
315
 
                          "host", "interval", "last_checked_ok",
 
456
                          "created", "enabled", "expires",
 
457
                          "fingerprint", "host", "interval",
 
458
                          "last_approval_request", "last_checked_ok",
316
459
                          "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
                        }
317
470
    
318
471
    def timeout_milliseconds(self):
319
472
        "Return the 'timeout' attribute in milliseconds"
320
 
        return _timedelta_to_milliseconds(self.timeout)
 
473
        return timedelta_to_milliseconds(self.timeout)
321
474
    
322
475
    def extended_timeout_milliseconds(self):
323
476
        "Return the 'extended_timeout' attribute in milliseconds"
324
 
        return _timedelta_to_milliseconds(self.extended_timeout)    
 
477
        return timedelta_to_milliseconds(self.extended_timeout)
325
478
    
326
479
    def interval_milliseconds(self):
327
480
        "Return the 'interval' attribute in milliseconds"
328
 
        return _timedelta_to_milliseconds(self.interval)
 
481
        return timedelta_to_milliseconds(self.interval)
329
482
    
330
483
    def approval_delay_milliseconds(self):
331
 
        return _timedelta_to_milliseconds(self.approval_delay)
332
 
    
333
 
    def __init__(self, name = None, disable_hook=None, config=None):
334
 
        """Note: the 'checker' key in 'config' sets the
335
 
        'checker_command' attribute and *not* the 'checker'
336
 
        attribute."""
 
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):
337
534
        self.name = name
338
 
        if config is None:
339
 
            config = {}
 
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
        
340
552
        logger.debug("Creating client %r", self.name)
341
553
        # Uppercase and remove spaces from fingerprint for later
342
554
        # comparison purposes with return value from the fingerprint()
343
555
        # function
344
 
        self.fingerprint = (config["fingerprint"].upper()
345
 
                            .replace(" ", ""))
346
556
        logger.debug("  Fingerprint: %s", self.fingerprint)
347
 
        if "secret" in config:
348
 
            self.secret = config["secret"].decode("base64")
349
 
        elif "secfile" in config:
350
 
            with open(os.path.expanduser(os.path.expandvars
351
 
                                         (config["secfile"])),
352
 
                      "rb") as secfile:
353
 
                self.secret = secfile.read()
354
 
        else:
355
 
            raise TypeError("No secret or secfile for client %s"
356
 
                            % self.name)
357
 
        self.host = config.get("host", "")
358
 
        self.created = datetime.datetime.utcnow()
359
 
        self.enabled = False
360
 
        self.last_approval_request = None
361
 
        self.last_enabled = None
362
 
        self.last_checked_ok = None
363
 
        self.timeout = string_to_delta(config["timeout"])
364
 
        self.extended_timeout = string_to_delta(config["extended_timeout"])
365
 
        self.interval = string_to_delta(config["interval"])
366
 
        self.disable_hook = disable_hook
 
557
        self.created = settings.get("created",
 
558
                                    datetime.datetime.utcnow())
 
559
        
 
560
        # attributes specific for this server instance
367
561
        self.checker = None
368
562
        self.checker_initiator_tag = None
369
563
        self.disable_initiator_tag = None
370
 
        self.expires = None
371
564
        self.checker_callback_tag = None
372
 
        self.checker_command = config["checker"]
373
565
        self.current_checker_command = None
374
 
        self.last_connect = None
375
 
        self._approved = None
376
 
        self.approved_by_default = config.get("approved_by_default",
377
 
                                              True)
 
566
        self.approved = None
378
567
        self.approvals_pending = 0
379
 
        self.approval_delay = string_to_delta(
380
 
            config["approval_delay"])
381
 
        self.approval_duration = string_to_delta(
382
 
            config["approval_duration"])
383
 
        self.changedstate = multiprocessing_manager.Condition(multiprocessing_manager.Lock())
 
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)
384
582
    
 
583
    # Send notice to process children that client state has changed
385
584
    def send_changedstate(self):
386
 
        self.changedstate.acquire()
387
 
        self.changedstate.notify_all()
388
 
        self.changedstate.release()
389
 
        
 
585
        with self.changedstate:
 
586
            self.changedstate.notify_all()
 
587
    
390
588
    def enable(self):
391
589
        """Start this client's checker and timeout hooks"""
392
590
        if getattr(self, "enabled", False):
393
591
            # Already enabled
394
592
            return
 
593
        self.expires = datetime.datetime.utcnow() + self.timeout
 
594
        self.enabled = True
 
595
        self.last_enabled = datetime.datetime.utcnow()
 
596
        self.init_checker()
395
597
        self.send_changedstate()
 
598
    
 
599
    def disable(self, quiet=True):
 
600
        """Disable this client."""
 
601
        if not getattr(self, "enabled", False):
 
602
            return False
 
603
        if not quiet:
 
604
            logger.info("Disabling client %s", self.name)
 
605
        if getattr(self, "disable_initiator_tag", None) is not None:
 
606
            gobject.source_remove(self.disable_initiator_tag)
 
607
            self.disable_initiator_tag = None
 
608
        self.expires = None
 
609
        if getattr(self, "checker_initiator_tag", None) is not None:
 
610
            gobject.source_remove(self.checker_initiator_tag)
 
611
            self.checker_initiator_tag = None
 
612
        self.stop_checker()
 
613
        self.enabled = False
 
614
        if not quiet:
 
615
            self.send_changedstate()
 
616
        # Do not run this again if called by a gobject.timeout_add
 
617
        return False
 
618
    
 
619
    def __del__(self):
 
620
        self.disable()
 
621
    
 
622
    def init_checker(self):
396
623
        # Schedule a new checker to be started an 'interval' from now,
397
624
        # and every interval from then on.
 
625
        if self.checker_initiator_tag is not None:
 
626
            gobject.source_remove(self.checker_initiator_tag)
398
627
        self.checker_initiator_tag = (gobject.timeout_add
399
628
                                      (self.interval_milliseconds(),
400
629
                                       self.start_checker))
401
630
        # Schedule a disable() when 'timeout' has passed
402
 
        self.expires = datetime.datetime.utcnow() + self.timeout
 
631
        if self.disable_initiator_tag is not None:
 
632
            gobject.source_remove(self.disable_initiator_tag)
403
633
        self.disable_initiator_tag = (gobject.timeout_add
404
634
                                   (self.timeout_milliseconds(),
405
635
                                    self.disable))
406
 
        self.enabled = True
407
 
        self.last_enabled = datetime.datetime.utcnow()
408
636
        # Also start a new checker *right now*.
409
637
        self.start_checker()
410
638
    
411
 
    def disable(self, quiet=True):
412
 
        """Disable this client."""
413
 
        if not getattr(self, "enabled", False):
414
 
            return False
415
 
        if not quiet:
416
 
            self.send_changedstate()
417
 
        if not quiet:
418
 
            logger.info("Disabling client %s", self.name)
419
 
        if getattr(self, "disable_initiator_tag", False):
420
 
            gobject.source_remove(self.disable_initiator_tag)
421
 
            self.disable_initiator_tag = None
422
 
        self.expires = None
423
 
        if getattr(self, "checker_initiator_tag", False):
424
 
            gobject.source_remove(self.checker_initiator_tag)
425
 
            self.checker_initiator_tag = None
426
 
        self.stop_checker()
427
 
        if self.disable_hook:
428
 
            self.disable_hook(self)
429
 
        self.enabled = False
430
 
        # Do not run this again if called by a gobject.timeout_add
431
 
        return False
432
 
    
433
 
    def __del__(self):
434
 
        self.disable_hook = None
435
 
        self.disable()
436
 
    
437
639
    def checker_callback(self, pid, condition, command):
438
640
        """The checker has completed, so take appropriate actions."""
439
641
        self.checker_callback_tag = None
440
642
        self.checker = None
441
643
        if os.WIFEXITED(condition):
442
 
            exitstatus = os.WEXITSTATUS(condition)
443
 
            if exitstatus == 0:
 
644
            self.last_checker_status = os.WEXITSTATUS(condition)
 
645
            if self.last_checker_status == 0:
444
646
                logger.info("Checker for %(name)s succeeded",
445
647
                            vars(self))
446
648
                self.checked_ok()
448
650
                logger.info("Checker for %(name)s failed",
449
651
                            vars(self))
450
652
        else:
 
653
            self.last_checker_status = -1
451
654
            logger.warning("Checker for %(name)s crashed?",
452
655
                           vars(self))
453
656
    
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
 
        """
 
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."""
460
665
        if timeout is None:
461
666
            timeout = self.timeout
462
 
        self.last_checked_ok = datetime.datetime.utcnow()
463
 
        gobject.source_remove(self.disable_initiator_tag)
464
 
        self.expires = datetime.datetime.utcnow() + timeout
465
 
        self.disable_initiator_tag = (gobject.timeout_add
466
 
                                      (_timedelta_to_milliseconds(timeout),
467
 
                                       self.disable))
 
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
468
675
    
469
676
    def need_approval(self):
470
677
        self.last_approval_request = datetime.datetime.utcnow()
475
682
        If a checker already exists, leave it running and do
476
683
        nothing."""
477
684
        # The reason for not killing a running checker is that if we
478
 
        # did that, then if a checker (for some reason) started
479
 
        # running slowly and taking more than 'interval' time, the
480
 
        # client would inevitably timeout, since no checker would get
481
 
        # a chance to run to completion.  If we instead leave running
 
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
482
689
        # checkers alone, the checker would have to take more time
483
690
        # than 'timeout' for the client to be disabled, which is as it
484
691
        # should be.
486
693
        # If a checker exists, make sure it is not a zombie
487
694
        try:
488
695
            pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
489
 
        except (AttributeError, OSError) as error:
490
 
            if (isinstance(error, OSError)
491
 
                and error.errno != errno.ECHILD):
492
 
                raise error
 
696
        except AttributeError:
 
697
            pass
 
698
        except OSError as error:
 
699
            if error.errno != errno.ECHILD:
 
700
                raise
493
701
        else:
494
702
            if pid:
495
703
                logger.warning("Checker was a zombie")
498
706
                                      self.current_checker_command)
499
707
        # Start a new checker if needed
500
708
        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)
501
714
            try:
502
 
                # In case checker_command has exactly one % operator
503
 
                command = self.checker_command % self.host
504
 
            except TypeError:
505
 
                # Escape attributes for the shell
506
 
                escaped_attrs = dict(
507
 
                    (attr,
508
 
                     re.escape(unicode(str(getattr(self, attr, "")),
509
 
                                       errors=
510
 
                                       'replace')))
511
 
                    for attr in
512
 
                    self.runtime_expansions)
513
 
                
514
 
                try:
515
 
                    command = self.checker_command % escaped_attrs
516
 
                except TypeError as error:
517
 
                    logger.error('Could not format string "%s":'
518
 
                                 ' %s', self.checker_command, error)
519
 
                    return True # Try again later
 
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
520
720
            self.current_checker_command = command
521
721
            try:
522
722
                logger.info("Starting checker %r for %s",
525
725
                # in normal mode, that is already done by daemon(),
526
726
                # and in debug mode we don't want to.  (Stdin is
527
727
                # 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 })
528
736
                self.checker = subprocess.Popen(command,
529
737
                                                close_fds=True,
530
 
                                                shell=True, cwd="/")
531
 
                self.checker_callback_tag = (gobject.child_watch_add
532
 
                                             (self.checker.pid,
533
 
                                              self.checker_callback,
534
 
                                              data=command))
535
 
                # The checker may have completed before the gobject
536
 
                # watch was added.  Check for this.
 
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:
537
751
                pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
538
 
                if pid:
539
 
                    gobject.source_remove(self.checker_callback_tag)
540
 
                    self.checker_callback(pid, status, command)
541
752
            except OSError as error:
542
 
                logger.error("Failed to start subprocess: %s",
543
 
                             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)
544
762
        # Re-run this periodically if run by gobject.timeout_add
545
763
        return True
546
764
    
553
771
            return
554
772
        logger.debug("Stopping checker for %(name)s", vars(self))
555
773
        try:
556
 
            os.kill(self.checker.pid, signal.SIGTERM)
 
774
            self.checker.terminate()
557
775
            #time.sleep(0.5)
558
776
            #if self.checker.poll() is None:
559
 
            #    os.kill(self.checker.pid, signal.SIGKILL)
 
777
            #    self.checker.kill()
560
778
        except OSError as error:
561
779
            if error.errno != errno.ESRCH: # No such process
562
780
                raise
579
797
    # "Set" method, so we fail early here:
580
798
    if byte_arrays and signature != "ay":
581
799
        raise ValueError("Byte arrays not supported for non-'ay'"
582
 
                         " signature %r" % signature)
 
800
                         " signature {0!r}".format(signature))
583
801
    def decorator(func):
584
802
        func._dbus_is_property = True
585
803
        func._dbus_interface = dbus_interface
593
811
    return decorator
594
812
 
595
813
 
 
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
 
596
851
class DBusPropertyException(dbus.exceptions.DBusException):
597
852
    """A base class for D-Bus property-related exceptions
598
853
    """
621
876
    """
622
877
    
623
878
    @staticmethod
624
 
    def _is_dbus_property(obj):
625
 
        return getattr(obj, "_dbus_is_property", False)
 
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)
626
887
    
627
 
    def _get_all_dbus_properties(self):
 
888
    def _get_all_dbus_things(self, thing):
628
889
        """Returns a generator of (name, attribute) pairs
629
890
        """
630
 
        return ((prop._dbus_name, prop)
631
 
                for name, prop in
632
 
                inspect.getmembers(self, self._is_dbus_property))
 
891
        return ((getattr(athing.__get__(self), "_dbus_name",
 
892
                         name),
 
893
                 athing.__get__(self))
 
894
                for cls in self.__class__.__mro__
 
895
                for name, athing in
 
896
                inspect.getmembers(cls,
 
897
                                   self._is_dbus_thing(thing)))
633
898
    
634
 
#    def _get_dbus_property(self, interface_name, property_name):
635
 
#        """Returns a bound method if one exists which is a D-Bus
636
 
#        property with the specified name and interface.
637
 
#        """
638
 
#        print("get_property({0!r}, {1!r}".format(interface_name, property_name),file=sys.stderr)
639
 
#        print(dir(self), sys.stderr)
640
 
#        for name in (property_name,
641
 
#                     property_name + "_dbus_property"):
642
 
#            prop = getattr(self, name, None)
643
 
#            if (prop is None
644
 
#                or not self._is_dbus_property(prop)
645
 
#                or prop._dbus_name != property_name
646
 
#                or (interface_name and prop._dbus_interface
647
 
#                    and interface_name != prop._dbus_interface)):
648
 
#                continue
649
 
#            return prop
650
 
#        # No such property
651
 
#        raise DBusPropertyNotFound(self.dbus_object_path + ":"
652
 
#                                   + interface_name + "."
653
 
#                                   + property_name)
654
 
 
655
899
    def _get_dbus_property(self, interface_name, property_name):
656
900
        """Returns a bound method if one exists which is a D-Bus
657
901
        property with the specified name and interface.
658
902
        """
659
 
        for name, value in inspect.getmembers(self, self._is_dbus_property):
660
 
            if value._dbus_name == property_name and value._dbus_interface == interface_name:
661
 
                return value
 
903
        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):
 
909
                    return value.__get__(self)
662
910
        
663
911
        # No such property
664
912
        raise DBusPropertyNotFound(self.dbus_object_path + ":"
665
913
                                   + interface_name + "."
666
914
                                   + property_name)
667
 
 
668
915
    
669
916
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
670
917
                         out_signature="v")
690
937
            # The byte_arrays option is not supported yet on
691
938
            # signatures other than "ay".
692
939
            if prop._dbus_signature != "ay":
693
 
                raise ValueError
694
 
            value = dbus.ByteArray(''.join(unichr(byte)
695
 
                                           for byte in value))
 
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))
696
945
        prop(value)
697
946
    
698
947
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
703
952
        
704
953
        Note: Will not include properties with access="write".
705
954
        """
706
 
        all = {}
707
 
        for name, prop in self._get_all_dbus_properties():
 
955
        properties = {}
 
956
        for name, prop in self._get_all_dbus_things("property"):
708
957
            if (interface_name
709
958
                and interface_name != prop._dbus_interface):
710
959
                # Interface non-empty but did not match
714
963
                continue
715
964
            value = prop()
716
965
            if not hasattr(value, "variant_level"):
717
 
                all[name] = value
 
966
                properties[name] = value
718
967
                continue
719
 
            all[name] = type(value)(value, variant_level=
720
 
                                    value.variant_level+1)
721
 
        return dbus.Dictionary(all, signature="sv")
 
968
            properties[name] = type(value)(value, variant_level=
 
969
                                           value.variant_level+1)
 
970
        return dbus.Dictionary(properties, signature="sv")
722
971
    
723
972
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
724
973
                         out_signature="s",
725
974
                         path_keyword='object_path',
726
975
                         connection_keyword='connection')
727
976
    def Introspect(self, object_path, connection):
728
 
        """Standard D-Bus method, overloaded to insert property tags.
 
977
        """Overloading of standard D-Bus method.
 
978
        
 
979
        Inserts property tags and interface annotation tags.
729
980
        """
730
981
        xmlstring = dbus.service.Object.Introspect(self, object_path,
731
982
                                                   connection)
738
989
                e.setAttribute("access", prop._dbus_access)
739
990
                return e
740
991
            for if_tag in document.getElementsByTagName("interface"):
 
992
                # Add property tags
741
993
                for tag in (make_tag(document, name, prop)
742
994
                            for name, prop
743
 
                            in self._get_all_dbus_properties()
 
995
                            in self._get_all_dbus_things("property")
744
996
                            if prop._dbus_interface
745
997
                            == if_tag.getAttribute("name")):
746
998
                    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)
747
1030
                # Add the names to the return values for the
748
1031
                # "org.freedesktop.DBus.Properties" methods
749
1032
                if (if_tag.getAttribute("name")
764
1047
        except (AttributeError, xml.dom.DOMException,
765
1048
                xml.parsers.expat.ExpatError) as error:
766
1049
            logger.error("Failed to override Introspection method",
767
 
                         error)
 
1050
                         exc_info=error)
768
1051
        return xmlstring
769
1052
 
770
1053
 
771
 
def datetime_to_dbus (dt, variant_level=0):
 
1054
def datetime_to_dbus(dt, variant_level=0):
772
1055
    """Convert a UTC datetime.datetime() to a D-Bus type."""
773
1056
    if dt is None:
774
1057
        return dbus.String("", variant_level = variant_level)
775
1058
    return dbus.String(dt.isoformat(),
776
1059
                       variant_level=variant_level)
777
1060
 
778
 
class transitional_clientdbus(DBusObjectWithProperties.__metaclass__):
779
 
    def __new__(mcs, name, bases, attr):
780
 
        for key, old_dbusobj in attr.items():
781
 
            new_interface = getattr(old_dbusobj, "_dbus_interface", "").replace("se.bsnet.fukt.", "se.recompile.")
782
 
            if getattr(old_dbusobj, "_dbus_is_signal", False):
783
 
                unwrappedfunc = dict(zip(old_dbusobj.func_code.co_freevars,
784
 
                                    old_dbusobj.__closure__))["func"].cell_contents
785
 
                newfunc = types.FunctionType(unwrappedfunc.func_code,
786
 
                                             unwrappedfunc.func_globals,
787
 
                                             unwrappedfunc.func_name,
788
 
                                             unwrappedfunc.func_defaults,
789
 
                                             unwrappedfunc.func_closure)
790
 
                new_dbusfunc = dbus.service.signal(
791
 
                    new_interface, old_dbusobj._dbus_signature)(newfunc)            
792
 
                attr["_transitional_{0}_1".format(key)] = new_dbusfunc
793
 
                attr["_transitional_{0}_0".format(key)] = old_dbusobj                
794
 
                def fixscope(func1, func2):
795
 
                    def newcall(*args, **kwargs):
796
 
                        func1(*args, **kwargs)
797
 
                        func2(*args, **kwargs)
798
 
                    return newcall
799
 
 
800
 
                attr[key] = fixscope(
801
 
                    old_dbusobj, attr["_transitional_{0}_1".format(key)])
802
 
            
803
 
            if getattr(old_dbusobj, "_dbus_is_method", False):
804
 
                new_dbusfunc = (dbus.service.method
805
 
                                (new_interface,
806
 
                                 old_dbusobj._dbus_in_signature,
807
 
                                 old_dbusobj._dbus_out_signature)
808
 
                                (types.FunctionType
809
 
                                 (old_dbusobj.func_code,
810
 
                                  old_dbusobj.func_globals,
811
 
                                  old_dbusobj.func_name,
812
 
                                  old_dbusobj.func_defaults,
813
 
                                  old_dbusobj.func_closure)))
814
 
 
815
 
                attr["_transitional_{0}".format(key)] = new_dbusfunc
816
 
            if getattr(old_dbusobj, "_dbus_is_property", False):
817
 
                new_dbusfunc = (dbus_service_property
818
 
                                (new_interface,
819
 
                                 old_dbusobj._dbus_signature,
820
 
                                 old_dbusobj._dbus_access,
821
 
                                 old_dbusobj._dbus_get_args_options["byte_arrays"])
822
 
                                (types.FunctionType
823
 
                                 (old_dbusobj.func_code,
824
 
                                  old_dbusobj.func_globals,
825
 
                                  old_dbusobj.func_name,
826
 
                                  old_dbusobj.func_defaults,
827
 
                                  old_dbusobj.func_closure)))
828
 
 
829
 
                attr["_transitional_{0}".format(key)] = new_dbusfunc
830
 
        return type.__new__(mcs, name, bases, attr)
831
 
 
 
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"})
832
1233
class ClientDBus(Client, DBusObjectWithProperties):
833
1234
    """A Client class using D-Bus
834
1235
    
839
1240
    
840
1241
    runtime_expansions = (Client.runtime_expansions
841
1242
                          + ("dbus_object_path",))
842
 
 
843
 
    __metaclass__ = transitional_clientdbus
844
1243
    
845
1244
    # dbus.service.Object doesn't use super(), so we can't either.
846
1245
    
847
1246
    def __init__(self, bus = None, *args, **kwargs):
848
 
        self._approvals_pending = 0
849
1247
        self.bus = bus
850
1248
        Client.__init__(self, *args, **kwargs)
851
1249
        # Only now, when this client is initialized, can it show up on
857
1255
                                 ("/clients/" + client_object_name))
858
1256
        DBusObjectWithProperties.__init__(self, self.bus,
859
1257
                                          self.dbus_object_path)
860
 
        
 
1258
    
861
1259
    def notifychangeproperty(transform_func,
862
1260
                             dbus_name, type_func=lambda x: x,
863
1261
                             variant_level=1):
864
 
        """ Modify a variable so that its a property that announce its
865
 
        changes to DBus.
866
 
        transform_fun: Function that takes a value and transform it to
867
 
                       DBus type.
868
 
        dbus_name: DBus name of the variable
 
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
869
1268
        type_func: Function that transform the value before sending it
870
 
                   to DBus
871
 
        variant_level: DBus variant level. default: 1
 
1269
                   to the D-Bus.  Default: no transform
 
1270
        variant_level: D-Bus variant level.  Default: 1
872
1271
        """
873
 
        real_value = [None,]
 
1272
        attrname = "_{0}".format(dbus_name)
874
1273
        def setter(self, value):
875
 
            old_value = real_value[0]
876
 
            real_value[0] = value
877
1274
            if hasattr(self, "dbus_object_path"):
878
 
                if type_func(old_value) != type_func(real_value[0]):
879
 
                    dbus_value = transform_func(type_func(real_value[0]),
880
 
                                                variant_level)
 
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)
881
1281
                    self.PropertyChanged(dbus.String(dbus_name),
882
1282
                                         dbus_value)
 
1283
            setattr(self, attrname, value)
883
1284
        
884
 
        return property(lambda self: real_value[0], setter)
885
 
    
 
1285
        return property(lambda self: getattr(self, attrname), setter)
886
1286
    
887
1287
    expires = notifychangeproperty(datetime_to_dbus, "Expires")
888
1288
    approvals_pending = notifychangeproperty(dbus.Boolean,
892
1292
    last_enabled = notifychangeproperty(datetime_to_dbus,
893
1293
                                        "LastEnabled")
894
1294
    checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
895
 
                                   type_func = lambda checker: checker is not None)
 
1295
                                   type_func = lambda checker:
 
1296
                                       checker is not None)
896
1297
    last_checked_ok = notifychangeproperty(datetime_to_dbus,
897
1298
                                           "LastCheckedOK")
898
 
    last_approval_request = notifychangeproperty(datetime_to_dbus,
899
 
                                                 "LastApprovalRequest")
 
1299
    last_checker_status = notifychangeproperty(dbus.Int16,
 
1300
                                               "LastCheckerStatus")
 
1301
    last_approval_request = notifychangeproperty(
 
1302
        datetime_to_dbus, "LastApprovalRequest")
900
1303
    approved_by_default = notifychangeproperty(dbus.Boolean,
901
1304
                                               "ApprovedByDefault")
902
 
    approval_delay = notifychangeproperty(dbus.UInt16, "ApprovalDelay",
903
 
                                          type_func = _timedelta_to_milliseconds)
904
 
    approval_duration = notifychangeproperty(dbus.UInt16, "ApprovalDuration",
905
 
                                             type_func = _timedelta_to_milliseconds)
 
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)
906
1312
    host = notifychangeproperty(dbus.String, "Host")
907
 
    timeout = notifychangeproperty(dbus.UInt16, "Timeout",
908
 
                                   type_func = _timedelta_to_milliseconds)
909
 
    extended_timeout = notifychangeproperty(dbus.UInt16, "ExtendedTimeout",
910
 
                                            type_func = _timedelta_to_milliseconds)
911
 
    interval = notifychangeproperty(dbus.UInt16, "Interval",
912
 
                                    type_func = _timedelta_to_milliseconds)
 
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)
913
1323
    checker_command = notifychangeproperty(dbus.String, "Checker")
914
1324
    
915
1325
    del notifychangeproperty
943
1353
                                       *args, **kwargs)
944
1354
    
945
1355
    def start_checker(self, *args, **kwargs):
946
 
        old_checker = self.checker
947
 
        if self.checker is not None:
948
 
            old_checker_pid = self.checker.pid
949
 
        else:
950
 
            old_checker_pid = None
 
1356
        old_checker_pid = getattr(self.checker, "pid", None)
951
1357
        r = Client.start_checker(self, *args, **kwargs)
952
1358
        # Only if new checker process was started
953
1359
        if (self.checker is not None
957
1363
        return r
958
1364
    
959
1365
    def _reset_approved(self):
960
 
        self._approved = None
 
1366
        self.approved = None
961
1367
        return False
962
1368
    
963
1369
    def approve(self, value=True):
964
 
        self.send_changedstate()
965
 
        self._approved = value
966
 
        gobject.timeout_add(_timedelta_to_milliseconds
 
1370
        self.approved = value
 
1371
        gobject.timeout_add(timedelta_to_milliseconds
967
1372
                            (self.approval_duration),
968
1373
                            self._reset_approved)
969
 
    
 
1374
        self.send_changedstate()
970
1375
    
971
1376
    ## D-Bus methods, signals & properties
972
 
    _interface = "se.bsnet.fukt.Mandos.Client"
973
 
 
 
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
    
974
1386
    ## Signals
975
1387
    
976
1388
    # CheckerCompleted - signal
1075
1487
                           access="readwrite")
1076
1488
    def ApprovalDuration_dbus_property(self, value=None):
1077
1489
        if value is None:       # get
1078
 
            return dbus.UInt64(_timedelta_to_milliseconds(
 
1490
            return dbus.UInt64(timedelta_to_milliseconds(
1079
1491
                    self.approval_duration))
1080
1492
        self.approval_duration = datetime.timedelta(0, 0, 0, value)
1081
1493
    
1095
1507
    def Host_dbus_property(self, value=None):
1096
1508
        if value is None:       # get
1097
1509
            return dbus.String(self.host)
1098
 
        self.host = value
 
1510
        self.host = unicode(value)
1099
1511
    
1100
1512
    # Created - property
1101
1513
    @dbus_service_property(_interface, signature="s", access="read")
1102
1514
    def Created_dbus_property(self):
1103
 
        return dbus.String(datetime_to_dbus(self.created))
 
1515
        return datetime_to_dbus(self.created)
1104
1516
    
1105
1517
    # LastEnabled - property
1106
1518
    @dbus_service_property(_interface, signature="s", access="read")
1127
1539
            return
1128
1540
        return datetime_to_dbus(self.last_checked_ok)
1129
1541
    
 
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
    
1130
1548
    # Expires - property
1131
1549
    @dbus_service_property(_interface, signature="s", access="read")
1132
1550
    def Expires_dbus_property(self):
1143
1561
    def Timeout_dbus_property(self, value=None):
1144
1562
        if value is None:       # get
1145
1563
            return dbus.UInt64(self.timeout_milliseconds())
 
1564
        old_timeout = self.timeout
1146
1565
        self.timeout = datetime.timedelta(0, 0, 0, value)
1147
 
        if getattr(self, "disable_initiator_tag", None) is None:
1148
 
            return
1149
 
        # Reschedule timeout
1150
 
        gobject.source_remove(self.disable_initiator_tag)
1151
 
        self.disable_initiator_tag = None
1152
 
        self.expires = None
1153
 
        time_to_die = (self.
1154
 
                       _timedelta_to_milliseconds((self
1155
 
                                                   .last_checked_ok
1156
 
                                                   + self.timeout)
1157
 
                                                  - datetime.datetime
1158
 
                                                  .utcnow()))
1159
 
        if time_to_die <= 0:
1160
 
            # The timeout has passed
1161
 
            self.disable()
1162
 
        else:
1163
 
            self.expires = (datetime.datetime.utcnow()
1164
 
                            + datetime.timedelta(milliseconds = time_to_die))
1165
 
            self.disable_initiator_tag = (gobject.timeout_add
1166
 
                                          (time_to_die, self.disable))
 
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))
1167
1582
    
1168
1583
    # ExtendedTimeout - property
1169
1584
    @dbus_service_property(_interface, signature="t",
1182
1597
        self.interval = datetime.timedelta(0, 0, 0, value)
1183
1598
        if getattr(self, "checker_initiator_tag", None) is None:
1184
1599
            return
1185
 
        # Reschedule checker run
1186
 
        gobject.source_remove(self.checker_initiator_tag)
1187
 
        self.checker_initiator_tag = (gobject.timeout_add
1188
 
                                      (value, self.start_checker))
1189
 
        self.start_checker()    # Start one now, too
 
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
1190
1606
    
1191
1607
    # Checker - property
1192
1608
    @dbus_service_property(_interface, signature="s",
1194
1610
    def Checker_dbus_property(self, value=None):
1195
1611
        if value is None:       # get
1196
1612
            return dbus.String(self.checker_command)
1197
 
        self.checker_command = value
 
1613
        self.checker_command = unicode(value)
1198
1614
    
1199
1615
    # CheckerRunning - property
1200
1616
    @dbus_service_property(_interface, signature="b",
1229
1645
            raise KeyError()
1230
1646
    
1231
1647
    def __getattribute__(self, name):
1232
 
        if(name == '_pipe'):
 
1648
        if name == '_pipe':
1233
1649
            return super(ProxyClient, self).__getattribute__(name)
1234
1650
        self._pipe.send(('getattr', name))
1235
1651
        data = self._pipe.recv()
1242
1658
            return func
1243
1659
    
1244
1660
    def __setattr__(self, name, value):
1245
 
        if(name == '_pipe'):
 
1661
        if name == '_pipe':
1246
1662
            return super(ProxyClient, self).__setattr__(name, value)
1247
1663
        self._pipe.send(('setattr', name, value))
1248
1664
 
1288
1704
            logger.debug("Protocol version: %r", line)
1289
1705
            try:
1290
1706
                if int(line.strip().split()[0]) > 1:
1291
 
                    raise RuntimeError
 
1707
                    raise RuntimeError(line)
1292
1708
            except (ValueError, IndexError, RuntimeError) as error:
1293
1709
                logger.error("Unknown protocol version: %s", error)
1294
1710
                return
1331
1747
                                       client.name)
1332
1748
                        if self.server.use_dbus:
1333
1749
                            # Emit D-Bus signal
1334
 
                            client.Rejected("Disabled")                    
 
1750
                            client.Rejected("Disabled")
1335
1751
                        return
1336
1752
                    
1337
 
                    if client._approved or not client.approval_delay:
 
1753
                    if client.approved or not client.approval_delay:
1338
1754
                        #We are approved or approval is disabled
1339
1755
                        break
1340
 
                    elif client._approved is None:
 
1756
                    elif client.approved is None:
1341
1757
                        logger.info("Client %s needs approval",
1342
1758
                                    client.name)
1343
1759
                        if self.server.use_dbus:
1354
1770
                        return
1355
1771
                    
1356
1772
                    #wait until timeout or approved
1357
 
                    #x = float(client._timedelta_to_milliseconds(delay))
1358
1773
                    time = datetime.datetime.now()
1359
1774
                    client.changedstate.acquire()
1360
 
                    client.changedstate.wait(float(client._timedelta_to_milliseconds(delay) / 1000))
 
1775
                    client.changedstate.wait(
 
1776
                        float(timedelta_to_milliseconds(delay)
 
1777
                              / 1000))
1361
1778
                    client.changedstate.release()
1362
1779
                    time2 = datetime.datetime.now()
1363
1780
                    if (time2 - time) >= delay:
1379
1796
                    try:
1380
1797
                        sent = session.send(client.secret[sent_size:])
1381
1798
                    except gnutls.errors.GNUTLSError as error:
1382
 
                        logger.warning("gnutls send failed")
 
1799
                        logger.warning("gnutls send failed",
 
1800
                                       exc_info=error)
1383
1801
                        return
1384
1802
                    logger.debug("Sent: %d, remaining: %d",
1385
1803
                                 sent, len(client.secret)
1387
1805
                    sent_size += sent
1388
1806
                
1389
1807
                logger.info("Sending secret to %s", client.name)
1390
 
                # bump the timeout as if seen
1391
 
                client.checked_ok(client.extended_timeout)
 
1808
                # bump the timeout using extended_timeout
 
1809
                client.bump_timeout(client.extended_timeout)
1392
1810
                if self.server.use_dbus:
1393
1811
                    # Emit D-Bus signal
1394
1812
                    client.GotSecret()
1399
1817
                try:
1400
1818
                    session.bye()
1401
1819
                except gnutls.errors.GNUTLSError as error:
1402
 
                    logger.warning("GnuTLS bye failed")
 
1820
                    logger.warning("GnuTLS bye failed",
 
1821
                                   exc_info=error)
1403
1822
    
1404
1823
    @staticmethod
1405
1824
    def peer_certificate(session):
1461
1880
        # Convert the buffer to a Python bytestring
1462
1881
        fpr = ctypes.string_at(buf, buf_len.value)
1463
1882
        # Convert the bytestring to hexadecimal notation
1464
 
        hex_fpr = ''.join("%02X" % ord(char) for char in fpr)
 
1883
        hex_fpr = binascii.hexlify(fpr).upper()
1465
1884
        return hex_fpr
1466
1885
 
1467
1886
 
1470
1889
    def sub_process_main(self, request, address):
1471
1890
        try:
1472
1891
            self.finish_request(request, address)
1473
 
        except:
 
1892
        except Exception:
1474
1893
            self.handle_error(request, address)
1475
1894
        self.close_request(request)
1476
 
            
 
1895
    
1477
1896
    def process_request(self, request, address):
1478
1897
        """Start a new process to process the request."""
1479
 
        multiprocessing.Process(target = self.sub_process_main,
1480
 
                                args = (request, address)).start()
 
1898
        proc = multiprocessing.Process(target = self.sub_process_main,
 
1899
                                       args = (request, address))
 
1900
        proc.start()
 
1901
        return proc
1481
1902
 
1482
1903
 
1483
1904
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1489
1910
        """
1490
1911
        parent_pipe, self.child_pipe = multiprocessing.Pipe()
1491
1912
        
1492
 
        super(MultiprocessingMixInWithPipe,
1493
 
              self).process_request(request, client_address)
 
1913
        proc = MultiprocessingMixIn.process_request(self, request,
 
1914
                                                    client_address)
1494
1915
        self.child_pipe.close()
1495
 
        self.add_pipe(parent_pipe)
 
1916
        self.add_pipe(parent_pipe, proc)
1496
1917
    
1497
 
    def add_pipe(self, parent_pipe):
 
1918
    def add_pipe(self, parent_pipe, proc):
1498
1919
        """Dummy function; override as necessary"""
1499
 
        raise NotImplementedError
 
1920
        raise NotImplementedError()
1500
1921
 
1501
1922
 
1502
1923
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1509
1930
        use_ipv6:       Boolean; to use IPv6 or not
1510
1931
    """
1511
1932
    def __init__(self, server_address, RequestHandlerClass,
1512
 
                 interface=None, use_ipv6=True):
 
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
        """
1513
1937
        self.interface = interface
1514
1938
        if use_ipv6:
1515
1939
            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.
1516
1966
        socketserver.TCPServer.__init__(self, server_address,
1517
1967
                                        RequestHandlerClass)
 
1968
    
1518
1969
    def server_bind(self):
1519
1970
        """This overrides the normal server_bind() function
1520
1971
        to bind to an interface if one was specified, and also NOT to
1528
1979
                try:
1529
1980
                    self.socket.setsockopt(socket.SOL_SOCKET,
1530
1981
                                           SO_BINDTODEVICE,
1531
 
                                           str(self.interface
1532
 
                                               + '\0'))
 
1982
                                           str(self.interface + '\0'))
1533
1983
                except socket.error as error:
1534
 
                    if error[0] == errno.EPERM:
1535
 
                        logger.error("No permission to"
1536
 
                                     " bind to interface %s",
1537
 
                                     self.interface)
1538
 
                    elif error[0] == errno.ENOPROTOOPT:
 
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:
1539
1988
                        logger.error("SO_BINDTODEVICE not available;"
1540
1989
                                     " cannot bind to interface %s",
1541
1990
                                     self.interface)
 
1991
                    elif error.errno == errno.ENODEV:
 
1992
                        logger.error("Interface %s does not exist,"
 
1993
                                     " cannot bind", self.interface)
1542
1994
                    else:
1543
1995
                        raise
1544
1996
        # Only bind(2) the socket if we really need to.
1547
1999
                if self.address_family == socket.AF_INET6:
1548
2000
                    any_address = "::" # in6addr_any
1549
2001
                else:
1550
 
                    any_address = socket.INADDR_ANY
 
2002
                    any_address = "0.0.0.0" # INADDR_ANY
1551
2003
                self.server_address = (any_address,
1552
2004
                                       self.server_address[1])
1553
2005
            elif not self.server_address[1]:
1574
2026
    """
1575
2027
    def __init__(self, server_address, RequestHandlerClass,
1576
2028
                 interface=None, use_ipv6=True, clients=None,
1577
 
                 gnutls_priority=None, use_dbus=True):
 
2029
                 gnutls_priority=None, use_dbus=True, socketfd=None):
1578
2030
        self.enabled = False
1579
2031
        self.clients = clients
1580
2032
        if self.clients is None:
1581
 
            self.clients = set()
 
2033
            self.clients = {}
1582
2034
        self.use_dbus = use_dbus
1583
2035
        self.gnutls_priority = gnutls_priority
1584
2036
        IPv6_TCPServer.__init__(self, server_address,
1585
2037
                                RequestHandlerClass,
1586
2038
                                interface = interface,
1587
 
                                use_ipv6 = use_ipv6)
 
2039
                                use_ipv6 = use_ipv6,
 
2040
                                socketfd = socketfd)
1588
2041
    def server_activate(self):
1589
2042
        if self.enabled:
1590
2043
            return socketserver.TCPServer.server_activate(self)
 
2044
    
1591
2045
    def enable(self):
1592
2046
        self.enabled = True
1593
 
    def add_pipe(self, parent_pipe):
 
2047
    
 
2048
    def add_pipe(self, parent_pipe, proc):
1594
2049
        # Call "handle_ipc" for both data and EOF events
1595
2050
        gobject.io_add_watch(parent_pipe.fileno(),
1596
2051
                             gobject.IO_IN | gobject.IO_HUP,
1597
2052
                             functools.partial(self.handle_ipc,
1598
 
                                               parent_pipe = parent_pipe))
1599
 
        
 
2053
                                               parent_pipe =
 
2054
                                               parent_pipe,
 
2055
                                               proc = proc))
 
2056
    
1600
2057
    def handle_ipc(self, source, condition, parent_pipe=None,
1601
 
                   client_object=None):
1602
 
        condition_names = {
1603
 
            gobject.IO_IN: "IN",   # There is data to read.
1604
 
            gobject.IO_OUT: "OUT", # Data can be written (without
1605
 
                                    # blocking).
1606
 
            gobject.IO_PRI: "PRI", # There is urgent data to read.
1607
 
            gobject.IO_ERR: "ERR", # Error condition.
1608
 
            gobject.IO_HUP: "HUP"  # Hung up (the connection has been
1609
 
                                    # broken, usually for pipes and
1610
 
                                    # sockets).
1611
 
            }
1612
 
        conditions_string = ' | '.join(name
1613
 
                                       for cond, name in
1614
 
                                       condition_names.iteritems()
1615
 
                                       if cond & condition)
1616
 
        # error or the other end of multiprocessing.Pipe has closed
1617
 
        if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
 
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()
1618
2063
            return False
1619
2064
        
1620
2065
        # Read a request from the child
1625
2070
            fpr = request[1]
1626
2071
            address = request[2]
1627
2072
            
1628
 
            for c in self.clients:
 
2073
            for c in self.clients.itervalues():
1629
2074
                if c.fingerprint == fpr:
1630
2075
                    client = c
1631
2076
                    break
1634
2079
                            "dress: %s", fpr, address)
1635
2080
                if self.use_dbus:
1636
2081
                    # Emit D-Bus signal
1637
 
                    mandos_dbus_service.ClientNotFound(fpr, address[0])
 
2082
                    mandos_dbus_service.ClientNotFound(fpr,
 
2083
                                                       address[0])
1638
2084
                parent_pipe.send(False)
1639
2085
                return False
1640
2086
            
1641
2087
            gobject.io_add_watch(parent_pipe.fileno(),
1642
2088
                                 gobject.IO_IN | gobject.IO_HUP,
1643
2089
                                 functools.partial(self.handle_ipc,
1644
 
                                                   parent_pipe = parent_pipe,
1645
 
                                                   client_object = client))
 
2090
                                                   parent_pipe =
 
2091
                                                   parent_pipe,
 
2092
                                                   proc = proc,
 
2093
                                                   client_object =
 
2094
                                                   client))
1646
2095
            parent_pipe.send(True)
1647
 
            # remove the old hook in favor of the new above hook on same fileno
 
2096
            # remove the old hook in favor of the new above hook on
 
2097
            # same fileno
1648
2098
            return False
1649
2099
        if command == 'funcall':
1650
2100
            funcname = request[1]
1651
2101
            args = request[2]
1652
2102
            kwargs = request[3]
1653
2103
            
1654
 
            parent_pipe.send(('data', getattr(client_object, funcname)(*args, **kwargs)))
 
2104
            parent_pipe.send(('data', getattr(client_object,
 
2105
                                              funcname)(*args,
 
2106
                                                         **kwargs)))
1655
2107
        
1656
2108
        if command == 'getattr':
1657
2109
            attrname = request[1]
1658
2110
            if callable(client_object.__getattribute__(attrname)):
1659
2111
                parent_pipe.send(('function',))
1660
2112
            else:
1661
 
                parent_pipe.send(('data', client_object.__getattribute__(attrname)))
 
2113
                parent_pipe.send(('data', client_object
 
2114
                                  .__getattribute__(attrname)))
1662
2115
        
1663
2116
        if command == 'setattr':
1664
2117
            attrname = request[1]
1668
2121
        return True
1669
2122
 
1670
2123
 
 
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
 
1671
2223
def string_to_delta(interval):
1672
2224
    """Parse a string and return a datetime.timedelta
1673
2225
    
1684
2236
    >>> string_to_delta('5m 30s')
1685
2237
    datetime.timedelta(0, 330)
1686
2238
    """
 
2239
    
 
2240
    try:
 
2241
        return rfc3339_duration_to_delta(interval)
 
2242
    except ValueError:
 
2243
        pass
 
2244
    
1687
2245
    timevalue = datetime.timedelta(0)
1688
2246
    for s in interval.split():
1689
2247
        try:
1700
2258
            elif suffix == "w":
1701
2259
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
1702
2260
            else:
1703
 
                raise ValueError("Unknown suffix %r" % suffix)
1704
 
        except (ValueError, IndexError) as e:
 
2261
                raise ValueError("Unknown suffix {0!r}"
 
2262
                                 .format(suffix))
 
2263
        except IndexError as e:
1705
2264
            raise ValueError(*(e.args))
1706
2265
        timevalue += delta
1707
2266
    return timevalue
1708
2267
 
1709
2268
 
1710
 
def if_nametoindex(interface):
1711
 
    """Call the C function if_nametoindex(), or equivalent
1712
 
    
1713
 
    Note: This function cannot accept a unicode string."""
1714
 
    global if_nametoindex
1715
 
    try:
1716
 
        if_nametoindex = (ctypes.cdll.LoadLibrary
1717
 
                          (ctypes.util.find_library("c"))
1718
 
                          .if_nametoindex)
1719
 
    except (OSError, AttributeError):
1720
 
        logger.warning("Doing if_nametoindex the hard way")
1721
 
        def if_nametoindex(interface):
1722
 
            "Get an interface index the hard way, i.e. using fcntl()"
1723
 
            SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
1724
 
            with contextlib.closing(socket.socket()) as s:
1725
 
                ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1726
 
                                    struct.pack(str("16s16x"),
1727
 
                                                interface))
1728
 
            interface_index = struct.unpack(str("I"),
1729
 
                                            ifreq[16:20])[0]
1730
 
            return interface_index
1731
 
    return if_nametoindex(interface)
1732
 
 
1733
 
 
1734
2269
def daemon(nochdir = False, noclose = False):
1735
2270
    """See daemon(3).  Standard BSD Unix function.
1736
2271
    
1744
2279
        sys.exit()
1745
2280
    if not noclose:
1746
2281
        # Close all standard open file descriptors
1747
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
2282
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1748
2283
        if not stat.S_ISCHR(os.fstat(null).st_mode):
1749
2284
            raise OSError(errno.ENODEV,
1750
 
                          "%s not a character device"
1751
 
                          % os.path.devnull)
 
2285
                          "{0} not a character device"
 
2286
                          .format(os.devnull))
1752
2287
        os.dup2(null, sys.stdin.fileno())
1753
2288
        os.dup2(null, sys.stdout.fileno())
1754
2289
        os.dup2(null, sys.stderr.fileno())
1763
2298
    
1764
2299
    parser = argparse.ArgumentParser()
1765
2300
    parser.add_argument("-v", "--version", action="version",
1766
 
                        version = "%%(prog)s %s" % version,
 
2301
                        version = "%(prog)s {0}".format(version),
1767
2302
                        help="show version number and exit")
1768
2303
    parser.add_argument("-i", "--interface", metavar="IF",
1769
2304
                        help="Bind to interface IF")
1775
2310
                        help="Run self-test")
1776
2311
    parser.add_argument("--debug", action="store_true",
1777
2312
                        help="Debug mode; run in foreground and log"
1778
 
                        " to terminal")
 
2313
                        " to terminal", default=None)
1779
2314
    parser.add_argument("--debuglevel", metavar="LEVEL",
1780
2315
                        help="Debug level for stdout output")
1781
2316
    parser.add_argument("--priority", help="GnuTLS"
1788
2323
                        " files")
1789
2324
    parser.add_argument("--no-dbus", action="store_false",
1790
2325
                        dest="use_dbus", help="Do not provide D-Bus"
1791
 
                        " system bus interface")
 
2326
                        " system bus interface", default=None)
1792
2327
    parser.add_argument("--no-ipv6", action="store_false",
1793
 
                        dest="use_ipv6", help="Do not use IPv6")
 
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
    parser.add_argument("--no-zeroconf", action="store_false",
 
2341
                        dest="zeroconf", help="Do not use Zeroconf",
 
2342
                        default=None)
 
2343
    
1794
2344
    options = parser.parse_args()
1795
2345
    
1796
2346
    if options.check:
1797
2347
        import doctest
1798
 
        doctest.testmod()
1799
 
        sys.exit()
 
2348
        fail_count, test_count = doctest.testmod()
 
2349
        sys.exit(os.EX_OK if fail_count == 0 else 1)
1800
2350
    
1801
2351
    # Default values for config file for server-global settings
1802
2352
    server_defaults = { "interface": "",
1804
2354
                        "port": "",
1805
2355
                        "debug": "False",
1806
2356
                        "priority":
1807
 
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
 
2357
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",
1808
2358
                        "servicename": "Mandos",
1809
2359
                        "use_dbus": "True",
1810
2360
                        "use_ipv6": "True",
1811
2361
                        "debuglevel": "",
 
2362
                        "restore": "True",
 
2363
                        "socket": "",
 
2364
                        "statedir": "/var/lib/mandos",
 
2365
                        "foreground": "False",
 
2366
                        "zeroconf": "True",
1812
2367
                        }
1813
2368
    
1814
2369
    # Parse config file for server-global settings
1819
2374
    # Convert the SafeConfigParser object to a dict
1820
2375
    server_settings = server_config.defaults()
1821
2376
    # Use the appropriate methods on the non-string config options
1822
 
    for option in ("debug", "use_dbus", "use_ipv6"):
 
2377
    for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
1823
2378
        server_settings[option] = server_config.getboolean("DEFAULT",
1824
2379
                                                           option)
1825
2380
    if server_settings["port"]:
1826
2381
        server_settings["port"] = server_config.getint("DEFAULT",
1827
2382
                                                       "port")
 
2383
    if server_settings["socket"]:
 
2384
        server_settings["socket"] = server_config.getint("DEFAULT",
 
2385
                                                         "socket")
 
2386
        # Later, stdin will, and stdout and stderr might, be dup'ed
 
2387
        # over with an opened os.devnull.  But we don't want this to
 
2388
        # happen with a supplied network socket.
 
2389
        if 0 <= server_settings["socket"] <= 2:
 
2390
            server_settings["socket"] = os.dup(server_settings
 
2391
                                               ["socket"])
1828
2392
    del server_config
1829
2393
    
1830
2394
    # Override the settings from the config file with command line
1831
2395
    # options, if set.
1832
2396
    for option in ("interface", "address", "port", "debug",
1833
2397
                   "priority", "servicename", "configdir",
1834
 
                   "use_dbus", "use_ipv6", "debuglevel"):
 
2398
                   "use_dbus", "use_ipv6", "debuglevel", "restore",
 
2399
                   "statedir", "socket", "foreground", "zeroconf"):
1835
2400
        value = getattr(options, option)
1836
2401
        if value is not None:
1837
2402
            server_settings[option] = value
1840
2405
    for option in server_settings.keys():
1841
2406
        if type(server_settings[option]) is str:
1842
2407
            server_settings[option] = unicode(server_settings[option])
 
2408
    # Force all boolean options to be boolean
 
2409
    for option in ("debug", "use_dbus", "use_ipv6", "restore",
 
2410
                   "foreground", "zeroconf"):
 
2411
        server_settings[option] = bool(server_settings[option])
 
2412
    # Debug implies foreground
 
2413
    if server_settings["debug"]:
 
2414
        server_settings["foreground"] = True
1843
2415
    # Now we have our good server settings in "server_settings"
1844
2416
    
1845
2417
    ##################################################################
1846
2418
    
 
2419
    if (not server_settings["zeroconf"] and
 
2420
        not (server_settings["port"]
 
2421
             or server_settings["socket"] != "")):
 
2422
            parser.error("Needs port or socket to work without"
 
2423
                         " Zeroconf")
 
2424
    
1847
2425
    # For convenience
1848
2426
    debug = server_settings["debug"]
1849
2427
    debuglevel = server_settings["debuglevel"]
1850
2428
    use_dbus = server_settings["use_dbus"]
1851
2429
    use_ipv6 = server_settings["use_ipv6"]
 
2430
    stored_state_path = os.path.join(server_settings["statedir"],
 
2431
                                     stored_state_file)
 
2432
    foreground = server_settings["foreground"]
 
2433
    zeroconf = server_settings["zeroconf"]
 
2434
    
 
2435
    if debug:
 
2436
        initlogger(debug, logging.DEBUG)
 
2437
    else:
 
2438
        if not debuglevel:
 
2439
            initlogger(debug)
 
2440
        else:
 
2441
            level = getattr(logging, debuglevel.upper())
 
2442
            initlogger(debug, level)
1852
2443
    
1853
2444
    if server_settings["servicename"] != "Mandos":
1854
2445
        syslogger.setFormatter(logging.Formatter
1855
 
                               ('Mandos (%s) [%%(process)d]:'
1856
 
                                ' %%(levelname)s: %%(message)s'
1857
 
                                % server_settings["servicename"]))
 
2446
                               ('Mandos ({0}) [%(process)d]:'
 
2447
                                ' %(levelname)s: %(message)s'
 
2448
                                .format(server_settings
 
2449
                                        ["servicename"])))
1858
2450
    
1859
2451
    # Parse config file with clients
1860
 
    client_defaults = { "timeout": "5m",
1861
 
                        "extended_timeout": "15m",
1862
 
                        "interval": "2m",
1863
 
                        "checker": "fping -q -- %%(host)s",
1864
 
                        "host": "",
1865
 
                        "approval_delay": "0s",
1866
 
                        "approval_duration": "1s",
1867
 
                        }
1868
 
    client_config = configparser.SafeConfigParser(client_defaults)
 
2452
    client_config = configparser.SafeConfigParser(Client
 
2453
                                                  .client_defaults)
1869
2454
    client_config.read(os.path.join(server_settings["configdir"],
1870
2455
                                    "clients.conf"))
1871
2456
    
1872
2457
    global mandos_dbus_service
1873
2458
    mandos_dbus_service = None
1874
2459
    
 
2460
    socketfd = None
 
2461
    if server_settings["socket"] != "":
 
2462
        socketfd = server_settings["socket"]
1875
2463
    tcp_server = MandosServer((server_settings["address"],
1876
2464
                               server_settings["port"]),
1877
2465
                              ClientHandler,
1880
2468
                              use_ipv6=use_ipv6,
1881
2469
                              gnutls_priority=
1882
2470
                              server_settings["priority"],
1883
 
                              use_dbus=use_dbus)
1884
 
    if not debug:
1885
 
        pidfilename = "/var/run/mandos.pid"
 
2471
                              use_dbus=use_dbus,
 
2472
                              socketfd=socketfd)
 
2473
    if not foreground:
 
2474
        pidfilename = "/run/mandos.pid"
 
2475
        if not os.path.isdir("/run/."):
 
2476
            pidfilename = "/var/run/mandos.pid"
 
2477
        pidfile = None
1886
2478
        try:
1887
2479
            pidfile = open(pidfilename, "w")
1888
 
        except IOError:
1889
 
            logger.error("Could not open file %r", pidfilename)
 
2480
        except IOError as e:
 
2481
            logger.error("Could not open file %r", pidfilename,
 
2482
                         exc_info=e)
1890
2483
    
1891
 
    try:
1892
 
        uid = pwd.getpwnam("_mandos").pw_uid
1893
 
        gid = pwd.getpwnam("_mandos").pw_gid
1894
 
    except KeyError:
 
2484
    for name in ("_mandos", "mandos", "nobody"):
1895
2485
        try:
1896
 
            uid = pwd.getpwnam("mandos").pw_uid
1897
 
            gid = pwd.getpwnam("mandos").pw_gid
 
2486
            uid = pwd.getpwnam(name).pw_uid
 
2487
            gid = pwd.getpwnam(name).pw_gid
 
2488
            break
1898
2489
        except KeyError:
1899
 
            try:
1900
 
                uid = pwd.getpwnam("nobody").pw_uid
1901
 
                gid = pwd.getpwnam("nobody").pw_gid
1902
 
            except KeyError:
1903
 
                uid = 65534
1904
 
                gid = 65534
 
2490
            continue
 
2491
    else:
 
2492
        uid = 65534
 
2493
        gid = 65534
1905
2494
    try:
1906
2495
        os.setgid(gid)
1907
2496
        os.setuid(uid)
1908
2497
    except OSError as error:
1909
 
        if error[0] != errno.EPERM:
1910
 
            raise error
1911
 
    
1912
 
    if not debug and not debuglevel:
1913
 
        syslogger.setLevel(logging.WARNING)
1914
 
        console.setLevel(logging.WARNING)
1915
 
    if debuglevel:
1916
 
        level = getattr(logging, debuglevel.upper())
1917
 
        syslogger.setLevel(level)
1918
 
        console.setLevel(level)
 
2498
        if error.errno != errno.EPERM:
 
2499
            raise
1919
2500
    
1920
2501
    if debug:
1921
2502
        # Enable all possible GnuTLS debugging
1932
2513
         .gnutls_global_set_log_function(debug_gnutls))
1933
2514
        
1934
2515
        # Redirect stdin so all checkers get /dev/null
1935
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
2516
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1936
2517
        os.dup2(null, sys.stdin.fileno())
1937
2518
        if null > 2:
1938
2519
            os.close(null)
1939
 
    else:
1940
 
        # No console logging
1941
 
        logger.removeHandler(console)
1942
2520
    
1943
2521
    # Need to fork before connecting to D-Bus
1944
 
    if not debug:
 
2522
    if not foreground:
1945
2523
        # Close all input and output, do double fork, etc.
1946
2524
        daemon()
1947
2525
    
 
2526
    # multiprocessing will use threads, so before we use gobject we
 
2527
    # need to inform gobject that threads will be used.
 
2528
    gobject.threads_init()
 
2529
    
1948
2530
    global main_loop
1949
2531
    # From the Avahi example code
1950
 
    DBusGMainLoop(set_as_default=True )
 
2532
    DBusGMainLoop(set_as_default=True)
1951
2533
    main_loop = gobject.MainLoop()
1952
2534
    bus = dbus.SystemBus()
1953
2535
    # End of Avahi example code
1954
2536
    if use_dbus:
1955
2537
        try:
1956
 
            bus_name = dbus.service.BusName("se.bsnet.fukt.Mandos",
1957
 
                                            bus, do_not_queue=True)
1958
 
            bus_name2 = dbus.service.BusName("se.recompile.Mandos",
1959
 
                                            bus, do_not_queue=True)
 
2538
            bus_name = dbus.service.BusName("se.recompile.Mandos",
 
2539
                                            bus, do_not_queue=True)
 
2540
            old_bus_name = (dbus.service.BusName
 
2541
                            ("se.bsnet.fukt.Mandos", bus,
 
2542
                             do_not_queue=True))
1960
2543
        except dbus.exceptions.NameExistsException as e:
1961
 
            logger.error(unicode(e) + ", disabling D-Bus")
 
2544
            logger.error("Disabling D-Bus:", exc_info=e)
1962
2545
            use_dbus = False
1963
2546
            server_settings["use_dbus"] = False
1964
2547
            tcp_server.use_dbus = False
1965
 
    protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1966
 
    service = AvahiService(name = server_settings["servicename"],
1967
 
                           servicetype = "_mandos._tcp",
1968
 
                           protocol = protocol, bus = bus)
1969
 
    if server_settings["interface"]:
1970
 
        service.interface = (if_nametoindex
1971
 
                             (str(server_settings["interface"])))
 
2548
    if zeroconf:
 
2549
        protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
 
2550
        service = AvahiServiceToSyslog(name =
 
2551
                                       server_settings["servicename"],
 
2552
                                       servicetype = "_mandos._tcp",
 
2553
                                       protocol = protocol, bus = bus)
 
2554
        if server_settings["interface"]:
 
2555
            service.interface = (if_nametoindex
 
2556
                                 (str(server_settings["interface"])))
1972
2557
    
1973
2558
    global multiprocessing_manager
1974
2559
    multiprocessing_manager = multiprocessing.Manager()
1976
2561
    client_class = Client
1977
2562
    if use_dbus:
1978
2563
        client_class = functools.partial(ClientDBus, bus = bus)
1979
 
    def client_config_items(config, section):
1980
 
        special_settings = {
1981
 
            "approved_by_default":
1982
 
                lambda: config.getboolean(section,
1983
 
                                          "approved_by_default"),
1984
 
            }
1985
 
        for name, value in config.items(section):
 
2564
    
 
2565
    client_settings = Client.config_parser(client_config)
 
2566
    old_client_settings = {}
 
2567
    clients_data = {}
 
2568
    
 
2569
    # This is used to redirect stdout and stderr for checker processes
 
2570
    global wnull
 
2571
    wnull = open(os.devnull, "w") # A writable /dev/null
 
2572
    # Only used if server is running in foreground but not in debug
 
2573
    # mode
 
2574
    if debug or not foreground:
 
2575
        wnull.close()
 
2576
    
 
2577
    # Get client data and settings from last running state.
 
2578
    if server_settings["restore"]:
 
2579
        try:
 
2580
            with open(stored_state_path, "rb") as stored_state:
 
2581
                clients_data, old_client_settings = (pickle.load
 
2582
                                                     (stored_state))
 
2583
            os.remove(stored_state_path)
 
2584
        except IOError as e:
 
2585
            if e.errno == errno.ENOENT:
 
2586
                logger.warning("Could not load persistent state: {0}"
 
2587
                                .format(os.strerror(e.errno)))
 
2588
            else:
 
2589
                logger.critical("Could not load persistent state:",
 
2590
                                exc_info=e)
 
2591
                raise
 
2592
        except EOFError as e:
 
2593
            logger.warning("Could not load persistent state: "
 
2594
                           "EOFError:", exc_info=e)
 
2595
    
 
2596
    with PGPEngine() as pgp:
 
2597
        for client_name, client in clients_data.iteritems():
 
2598
            # Skip removed clients
 
2599
            if client_name not in client_settings:
 
2600
                continue
 
2601
            
 
2602
            # Decide which value to use after restoring saved state.
 
2603
            # We have three different values: Old config file,
 
2604
            # new config file, and saved state.
 
2605
            # New config value takes precedence if it differs from old
 
2606
            # config value, otherwise use saved state.
 
2607
            for name, value in client_settings[client_name].items():
 
2608
                try:
 
2609
                    # For each value in new config, check if it
 
2610
                    # differs from the old config value (Except for
 
2611
                    # the "secret" attribute)
 
2612
                    if (name != "secret" and
 
2613
                        value != old_client_settings[client_name]
 
2614
                        [name]):
 
2615
                        client[name] = value
 
2616
                except KeyError:
 
2617
                    pass
 
2618
            
 
2619
            # Clients who has passed its expire date can still be
 
2620
            # enabled if its last checker was successful.  Clients
 
2621
            # whose checker succeeded before we stored its state is
 
2622
            # assumed to have successfully run all checkers during
 
2623
            # downtime.
 
2624
            if client["enabled"]:
 
2625
                if datetime.datetime.utcnow() >= client["expires"]:
 
2626
                    if not client["last_checked_ok"]:
 
2627
                        logger.warning(
 
2628
                            "disabling client {0} - Client never "
 
2629
                            "performed a successful checker"
 
2630
                            .format(client_name))
 
2631
                        client["enabled"] = False
 
2632
                    elif client["last_checker_status"] != 0:
 
2633
                        logger.warning(
 
2634
                            "disabling client {0} - Client "
 
2635
                            "last checker failed with error code {1}"
 
2636
                            .format(client_name,
 
2637
                                    client["last_checker_status"]))
 
2638
                        client["enabled"] = False
 
2639
                    else:
 
2640
                        client["expires"] = (datetime.datetime
 
2641
                                             .utcnow()
 
2642
                                             + client["timeout"])
 
2643
                        logger.debug("Last checker succeeded,"
 
2644
                                     " keeping {0} enabled"
 
2645
                                     .format(client_name))
1986
2646
            try:
1987
 
                yield (name, special_settings[name]())
1988
 
            except KeyError:
1989
 
                yield (name, value)
1990
 
    
1991
 
    tcp_server.clients.update(set(
1992
 
            client_class(name = section,
1993
 
                         config= dict(client_config_items(
1994
 
                        client_config, section)))
1995
 
            for section in client_config.sections()))
 
2647
                client["secret"] = (
 
2648
                    pgp.decrypt(client["encrypted_secret"],
 
2649
                                client_settings[client_name]
 
2650
                                ["secret"]))
 
2651
            except PGPError:
 
2652
                # If decryption fails, we use secret from new settings
 
2653
                logger.debug("Failed to decrypt {0} old secret"
 
2654
                             .format(client_name))
 
2655
                client["secret"] = (
 
2656
                    client_settings[client_name]["secret"])
 
2657
    
 
2658
    # Add/remove clients based on new changes made to config
 
2659
    for client_name in (set(old_client_settings)
 
2660
                        - set(client_settings)):
 
2661
        del clients_data[client_name]
 
2662
    for client_name in (set(client_settings)
 
2663
                        - set(old_client_settings)):
 
2664
        clients_data[client_name] = client_settings[client_name]
 
2665
    
 
2666
    # Create all client objects
 
2667
    for client_name, client in clients_data.iteritems():
 
2668
        tcp_server.clients[client_name] = client_class(
 
2669
            name = client_name, settings = client,
 
2670
            server_settings = server_settings)
 
2671
    
1996
2672
    if not tcp_server.clients:
1997
2673
        logger.warning("No clients defined")
1998
 
        
1999
 
    if not debug:
2000
 
        try:
2001
 
            with pidfile:
2002
 
                pid = os.getpid()
2003
 
                pidfile.write(str(pid) + "\n".encode("utf-8"))
2004
 
            del pidfile
2005
 
        except IOError:
2006
 
            logger.error("Could not write to file %r with PID %d",
2007
 
                         pidfilename, pid)
2008
 
        except NameError:
2009
 
            # "pidfile" was never created
2010
 
            pass
 
2674
    
 
2675
    if not foreground:
 
2676
        if pidfile is not None:
 
2677
            try:
 
2678
                with pidfile:
 
2679
                    pid = os.getpid()
 
2680
                    pidfile.write(str(pid) + "\n".encode("utf-8"))
 
2681
            except IOError:
 
2682
                logger.error("Could not write to file %r with PID %d",
 
2683
                             pidfilename, pid)
 
2684
        del pidfile
2011
2685
        del pidfilename
2012
 
        
2013
 
        signal.signal(signal.SIGINT, signal.SIG_IGN)
2014
2686
    
2015
2687
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2016
2688
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2017
2689
    
2018
2690
    if use_dbus:
2019
 
        class MandosDBusService(dbus.service.Object):
 
2691
        @alternate_dbus_interfaces({"se.recompile.Mandos":
 
2692
                                        "se.bsnet.fukt.Mandos"})
 
2693
        class MandosDBusService(DBusObjectWithProperties):
2020
2694
            """A D-Bus proxy object"""
2021
2695
            def __init__(self):
2022
2696
                dbus.service.Object.__init__(self, bus, "/")
2023
 
            _interface = "se.bsnet.fukt.Mandos"
 
2697
            _interface = "se.recompile.Mandos"
 
2698
            
 
2699
            @dbus_interface_annotations(_interface)
 
2700
            def _foo(self):
 
2701
                return { "org.freedesktop.DBus.Property"
 
2702
                         ".EmitsChangedSignal":
 
2703
                             "false"}
2024
2704
            
2025
2705
            @dbus.service.signal(_interface, signature="o")
2026
2706
            def ClientAdded(self, objpath):
2041
2721
            def GetAllClients(self):
2042
2722
                "D-Bus method"
2043
2723
                return dbus.Array(c.dbus_object_path
2044
 
                                  for c in tcp_server.clients)
 
2724
                                  for c in
 
2725
                                  tcp_server.clients.itervalues())
2045
2726
            
2046
2727
            @dbus.service.method(_interface,
2047
2728
                                 out_signature="a{oa{sv}}")
2049
2730
                "D-Bus method"
2050
2731
                return dbus.Dictionary(
2051
2732
                    ((c.dbus_object_path, c.GetAll(""))
2052
 
                     for c in tcp_server.clients),
 
2733
                     for c in tcp_server.clients.itervalues()),
2053
2734
                    signature="oa{sv}")
2054
2735
            
2055
2736
            @dbus.service.method(_interface, in_signature="o")
2056
2737
            def RemoveClient(self, object_path):
2057
2738
                "D-Bus method"
2058
 
                for c in tcp_server.clients:
 
2739
                for c in tcp_server.clients.itervalues():
2059
2740
                    if c.dbus_object_path == object_path:
2060
 
                        tcp_server.clients.remove(c)
 
2741
                        del tcp_server.clients[c.name]
2061
2742
                        c.remove_from_connection()
2062
2743
                        # Don't signal anything except ClientRemoved
2063
2744
                        c.disable(quiet=True)
2072
2753
    
2073
2754
    def cleanup():
2074
2755
        "Cleanup function; run on exit"
2075
 
        service.cleanup()
2076
 
        
 
2756
        if zeroconf:
 
2757
            service.cleanup()
 
2758
        
 
2759
        multiprocessing.active_children()
 
2760
        wnull.close()
 
2761
        if not (tcp_server.clients or client_settings):
 
2762
            return
 
2763
        
 
2764
        # Store client before exiting. Secrets are encrypted with key
 
2765
        # based on what config file has. If config file is
 
2766
        # removed/edited, old secret will thus be unrecovable.
 
2767
        clients = {}
 
2768
        with PGPEngine() as pgp:
 
2769
            for client in tcp_server.clients.itervalues():
 
2770
                key = client_settings[client.name]["secret"]
 
2771
                client.encrypted_secret = pgp.encrypt(client.secret,
 
2772
                                                      key)
 
2773
                client_dict = {}
 
2774
                
 
2775
                # A list of attributes that can not be pickled
 
2776
                # + secret.
 
2777
                exclude = set(("bus", "changedstate", "secret",
 
2778
                               "checker", "server_settings"))
 
2779
                for name, typ in (inspect.getmembers
 
2780
                                  (dbus.service.Object)):
 
2781
                    exclude.add(name)
 
2782
                
 
2783
                client_dict["encrypted_secret"] = (client
 
2784
                                                   .encrypted_secret)
 
2785
                for attr in client.client_structure:
 
2786
                    if attr not in exclude:
 
2787
                        client_dict[attr] = getattr(client, attr)
 
2788
                
 
2789
                clients[client.name] = client_dict
 
2790
                del client_settings[client.name]["secret"]
 
2791
        
 
2792
        try:
 
2793
            with (tempfile.NamedTemporaryFile
 
2794
                  (mode='wb', suffix=".pickle", prefix='clients-',
 
2795
                   dir=os.path.dirname(stored_state_path),
 
2796
                   delete=False)) as stored_state:
 
2797
                pickle.dump((clients, client_settings), stored_state)
 
2798
                tempname=stored_state.name
 
2799
            os.rename(tempname, stored_state_path)
 
2800
        except (IOError, OSError) as e:
 
2801
            if not debug:
 
2802
                try:
 
2803
                    os.remove(tempname)
 
2804
                except NameError:
 
2805
                    pass
 
2806
            if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
 
2807
                logger.warning("Could not save persistent state: {0}"
 
2808
                               .format(os.strerror(e.errno)))
 
2809
            else:
 
2810
                logger.warning("Could not save persistent state:",
 
2811
                               exc_info=e)
 
2812
                raise
 
2813
        
 
2814
        # Delete all clients, and settings from config
2077
2815
        while tcp_server.clients:
2078
 
            client = tcp_server.clients.pop()
 
2816
            name, client = tcp_server.clients.popitem()
2079
2817
            if use_dbus:
2080
2818
                client.remove_from_connection()
2081
 
            client.disable_hook = None
2082
2819
            # Don't signal anything except ClientRemoved
2083
2820
            client.disable(quiet=True)
2084
2821
            if use_dbus:
2085
2822
                # Emit D-Bus signal
2086
 
                mandos_dbus_service.ClientRemoved(client.dbus_object_path,
 
2823
                mandos_dbus_service.ClientRemoved(client
 
2824
                                                  .dbus_object_path,
2087
2825
                                                  client.name)
 
2826
        client_settings.clear()
2088
2827
    
2089
2828
    atexit.register(cleanup)
2090
2829
    
2091
 
    for client in tcp_server.clients:
 
2830
    for client in tcp_server.clients.itervalues():
2092
2831
        if use_dbus:
2093
2832
            # Emit D-Bus signal
2094
2833
            mandos_dbus_service.ClientAdded(client.dbus_object_path)
2095
 
        client.enable()
 
2834
        # Need to initiate checking of clients
 
2835
        if client.enabled:
 
2836
            client.init_checker()
2096
2837
    
2097
2838
    tcp_server.enable()
2098
2839
    tcp_server.server_activate()
2099
2840
    
2100
2841
    # Find out what port we got
2101
 
    service.port = tcp_server.socket.getsockname()[1]
 
2842
    if zeroconf:
 
2843
        service.port = tcp_server.socket.getsockname()[1]
2102
2844
    if use_ipv6:
2103
2845
        logger.info("Now listening on address %r, port %d,"
2104
 
                    " flowinfo %d, scope_id %d"
2105
 
                    % tcp_server.socket.getsockname())
 
2846
                    " flowinfo %d, scope_id %d",
 
2847
                    *tcp_server.socket.getsockname())
2106
2848
    else:                       # IPv4
2107
 
        logger.info("Now listening on address %r, port %d"
2108
 
                    % tcp_server.socket.getsockname())
 
2849
        logger.info("Now listening on address %r, port %d",
 
2850
                    *tcp_server.socket.getsockname())
2109
2851
    
2110
2852
    #service.interface = tcp_server.socket.getsockname()[3]
2111
2853
    
2112
2854
    try:
2113
 
        # From the Avahi example code
2114
 
        try:
2115
 
            service.activate()
2116
 
        except dbus.exceptions.DBusException as error:
2117
 
            logger.critical("DBusException: %s", error)
2118
 
            cleanup()
2119
 
            sys.exit(1)
2120
 
        # End of Avahi example code
 
2855
        if zeroconf:
 
2856
            # From the Avahi example code
 
2857
            try:
 
2858
                service.activate()
 
2859
            except dbus.exceptions.DBusException as error:
 
2860
                logger.critical("D-Bus Exception", exc_info=error)
 
2861
                cleanup()
 
2862
                sys.exit(1)
 
2863
            # End of Avahi example code
2121
2864
        
2122
2865
        gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2123
2866
                             lambda *args, **kwargs:
2127
2870
        logger.debug("Starting main loop")
2128
2871
        main_loop.run()
2129
2872
    except AvahiError as error:
2130
 
        logger.critical("AvahiError: %s", error)
 
2873
        logger.critical("Avahi Error", exc_info=error)
2131
2874
        cleanup()
2132
2875
        sys.exit(1)
2133
2876
    except KeyboardInterrupt:
2138
2881
    # Must run before the D-Bus bus name gets deregistered
2139
2882
    cleanup()
2140
2883
 
2141
 
 
2142
2884
if __name__ == '__main__':
2143
2885
    main()