/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2013-10-20 15:25:09 UTC
  • mto: (237.7.272 trunk)
  • mto: This revision was merged to the branch mainline in revision 305.
  • Revision ID: teddy@recompile.se-20131020152509-zkhuy2yse76w10hg
* Makefile (CFLAGS, LDFLAGS): Keep default flags from environment.
  (purge-server): PID file changed to "/run/mandos.pid".
* debian/compat: Changed to "9".
* debian/control (Standards-Version): Updated to "3.9.4".
  (DM-Upload-Allowed): Removed.
  (mandos/Depends): Add "initscripts (>= 2.88dsf-13.3)" to be able to
                    use the "/run" directory (for mandos.pid).
* debian/copyright (Copyright): Update year.
* init.d-mandos (PIDFILE): Changed to "/run/mandos.pid".
* mandos: Update copyright year.
  (pidfilename): Changed to "/run/mandos.pid".
* mandos-clients.conf.xml (OPTIONS/approval_delay): Bug fix: default
                                                    is "PT0S" - using
                                                    the new RFC 3339
                                                    duration syntax.
* mandos-keygen: Update copyright year.
* mandos-monitor: - '' -
* mandos.conf.xml: - '' -
* mandos.xml: - '' -
  (FILES): PID file changed to "/run/mandos.pid".
* plugin-runner.c: Update copyright year.
* plugins.d/mandos-client.c: - '' -
* plugins.d/mandos-client.xml: - '' -
* plugins.d/password-prompt.c: - '' -
* plugins.d/plymouth.c: - '' -

Show diffs side-by-side

added added

removed removed

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