/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

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

Show diffs side-by-side

added added

removed removed

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