/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

Merge from Björn.

Show diffs side-by-side

added added

removed removed

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