/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2011-09-26 19:36:18 UTC
  • mfrom: (24.1.184 mandos)
  • Revision ID: teddy@fukt.bsnet.se-20110926193618-vtj5c9hena1maixx
Merge from Björn

Show diffs side-by-side

added added

removed removed

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