/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2015-05-31 15:56:58 UTC
  • Revision ID: teddy@recompile.se-20150531155658-l7znu7zlqr2dmuwd
mandos: Generate better messages in exceptions.

mandos (ProxyClient.__init__): Include fingerprint in KeyError().
(rfc3339_duration_to_delta): Include duration in ValueError().

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
#!/usr/bin/python
 
1
#!/usr/bin/python2.7
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-2011 Teddy Hogeborn
15
 
# Copyright © 2008-2011 Björn Påhlsson
 
14
# Copyright © 2008-2015 Teddy Hogeborn
 
15
# Copyright © 2008-2015 Björn Påhlsson
16
16
17
17
# This program is free software: you can redistribute it and/or modify
18
18
# it under the terms of the GNU General Public License as published by
28
28
# along with this program.  If not, see
29
29
# <http://www.gnu.org/licenses/>.
30
30
31
 
# Contact the authors at <mandos@fukt.bsnet.se>.
 
31
# Contact the authors at <mandos@recompile.se>.
32
32
33
33
 
34
34
from __future__ import (division, absolute_import, print_function,
35
35
                        unicode_literals)
36
36
 
37
 
import SocketServer as socketserver
 
37
from future_builtins import *
 
38
 
 
39
try:
 
40
    import SocketServer as socketserver
 
41
except ImportError:
 
42
    import socketserver
38
43
import socket
39
44
import argparse
40
45
import datetime
45
50
import gnutls.library.functions
46
51
import gnutls.library.constants
47
52
import gnutls.library.types
48
 
import ConfigParser as configparser
 
53
try:
 
54
    import ConfigParser as configparser
 
55
except ImportError:
 
56
    import configparser
49
57
import sys
50
58
import re
51
59
import os
60
68
import struct
61
69
import fcntl
62
70
import functools
63
 
import cPickle as pickle
 
71
try:
 
72
    import cPickle as pickle
 
73
except ImportError:
 
74
    import pickle
64
75
import multiprocessing
 
76
import types
 
77
import binascii
 
78
import tempfile
 
79
import itertools
 
80
import collections
 
81
import codecs
65
82
 
66
83
import dbus
67
84
import dbus.service
68
 
import gobject
 
85
try:
 
86
    import gobject
 
87
except ImportError:
 
88
    from gi.repository import GObject as gobject
69
89
import avahi
70
90
from dbus.mainloop.glib import DBusGMainLoop
71
91
import ctypes
81
101
    except ImportError:
82
102
        SO_BINDTODEVICE = None
83
103
 
84
 
 
85
 
version = "1.3.1"
86
 
 
87
 
#logger = logging.getLogger('mandos')
88
 
logger = logging.Logger('mandos')
89
 
syslogger = (logging.handlers.SysLogHandler
90
 
             (facility = logging.handlers.SysLogHandler.LOG_DAEMON,
91
 
              address = str("/dev/log")))
92
 
syslogger.setFormatter(logging.Formatter
93
 
                       ('Mandos [%(process)d]: %(levelname)s:'
94
 
                        ' %(message)s'))
95
 
logger.addHandler(syslogger)
96
 
 
97
 
console = logging.StreamHandler()
98
 
console.setFormatter(logging.Formatter('%(name)s [%(process)d]:'
99
 
                                       ' %(levelname)s:'
100
 
                                       ' %(message)s'))
101
 
logger.addHandler(console)
 
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
 
102
236
 
103
237
class AvahiError(Exception):
104
238
    def __init__(self, value, *args, **kwargs):
105
239
        self.value = value
106
 
        super(AvahiError, self).__init__(value, *args, **kwargs)
107
 
    def __unicode__(self):
108
 
        return unicode(repr(self.value))
 
240
        return super(AvahiError, self).__init__(value, *args,
 
241
                                                **kwargs)
 
242
 
109
243
 
110
244
class AvahiServiceError(AvahiError):
111
245
    pass
112
246
 
 
247
 
113
248
class AvahiGroupError(AvahiError):
114
249
    pass
115
250
 
122
257
               Used to optionally bind to the specified interface.
123
258
    name: string; Example: 'Mandos'
124
259
    type: string; Example: '_mandos._tcp'.
125
 
                  See <http://www.dns-sd.org/ServiceTypes.html>
 
260
     See <https://www.iana.org/assignments/service-names-port-numbers>
126
261
    port: integer; what port to announce
127
262
    TXT: list of strings; TXT record for the service
128
263
    domain: string; Domain to publish on, default to .local if empty.
134
269
    server: D-Bus Server
135
270
    bus: dbus.SystemBus()
136
271
    """
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):
 
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):
141
284
        self.interface = interface
142
285
        self.name = name
143
286
        self.type = servicetype
152
295
        self.server = None
153
296
        self.bus = bus
154
297
        self.entry_group_state_changed_match = None
155
 
    def rename(self):
 
298
    
 
299
    def rename(self, remove=True):
156
300
        """Derived from the Avahi example code"""
157
301
        if self.rename_count >= self.max_renames:
158
302
            logger.critical("No suitable Zeroconf service name found"
159
303
                            " after %i retries, exiting.",
160
304
                            self.rename_count)
161
305
            raise AvahiServiceError("Too many renames")
162
 
        self.name = unicode(self.server.GetAlternativeServiceName(self.name))
 
306
        self.name = str(
 
307
            self.server.GetAlternativeServiceName(self.name))
 
308
        self.rename_count += 1
163
309
        logger.info("Changing Zeroconf service name to %r ...",
164
310
                    self.name)
165
 
        syslogger.setFormatter(logging.Formatter
166
 
                               ('Mandos (%s) [%%(process)d]:'
167
 
                                ' %%(levelname)s: %%(message)s'
168
 
                                % self.name))
169
 
        self.remove()
 
311
        if remove:
 
312
            self.remove()
170
313
        try:
171
314
            self.add()
172
315
        except dbus.exceptions.DBusException as error:
173
 
            logger.critical("DBusException: %s", error)
174
 
            self.cleanup()
175
 
            os._exit(1)
176
 
        self.rename_count += 1
 
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
    
177
325
    def remove(self):
178
326
        """Derived from the Avahi example code"""
179
327
        if self.entry_group_state_changed_match is not None:
181
329
            self.entry_group_state_changed_match = None
182
330
        if self.group is not None:
183
331
            self.group.Reset()
 
332
    
184
333
    def add(self):
185
334
        """Derived from the Avahi example code"""
186
335
        self.remove()
191
340
                avahi.DBUS_INTERFACE_ENTRY_GROUP)
192
341
        self.entry_group_state_changed_match = (
193
342
            self.group.connect_to_signal(
194
 
                'StateChanged', self .entry_group_state_changed))
 
343
                'StateChanged', self.entry_group_state_changed))
195
344
        logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
196
345
                     self.name, self.type)
197
346
        self.group.AddService(
203
352
            dbus.UInt16(self.port),
204
353
            avahi.string_array_to_txt_array(self.TXT))
205
354
        self.group.Commit()
 
355
    
206
356
    def entry_group_state_changed(self, state, error):
207
357
        """Derived from the Avahi example code"""
208
358
        logger.debug("Avahi entry group state change: %i", state)
214
364
            self.rename()
215
365
        elif state == avahi.ENTRY_GROUP_FAILURE:
216
366
            logger.critical("Avahi: Error in group state changed %s",
217
 
                            unicode(error))
218
 
            raise AvahiGroupError("State changed: %s"
219
 
                                  % unicode(error))
 
367
                            str(error))
 
368
            raise AvahiGroupError("State changed: {!s}".format(error))
 
369
    
220
370
    def cleanup(self):
221
371
        """Derived from the Avahi example code"""
222
372
        if self.group is not None:
223
373
            try:
224
374
                self.group.Free()
225
375
            except (dbus.exceptions.UnknownMethodException,
226
 
                    dbus.exceptions.DBusException) as e:
 
376
                    dbus.exceptions.DBusException):
227
377
                pass
228
378
            self.group = None
229
379
        self.remove()
 
380
    
230
381
    def server_state_changed(self, state, error=None):
231
382
        """Derived from the Avahi example code"""
232
383
        logger.debug("Avahi server state change: %i", state)
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" }
 
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
        }
240
390
        if state in bad_states:
241
391
            if bad_states[state] is not None:
242
392
                if error is None:
251
401
                logger.debug("Unknown state: %r", state)
252
402
            else:
253
403
                logger.debug("Unknown state: %r: %r", state, error)
 
404
    
254
405
    def activate(self):
255
406
        """Derived from the Avahi example code"""
256
407
        if self.server is None:
260
411
                                    follow_name_owner_changes=True),
261
412
                avahi.DBUS_INTERFACE_SERVER)
262
413
        self.server.connect_to_signal("StateChanged",
263
 
                                 self.server_state_changed)
 
414
                                      self.server_state_changed)
264
415
        self.server_state_changed(self.server.GetState())
265
416
 
266
417
 
 
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
 
267
428
class Client(object):
268
429
    """A representation of a client host served by this server.
269
430
    
270
431
    Attributes:
271
 
    _approved:   bool(); 'None' if not yet approved/disapproved
 
432
    approved:   bool(); 'None' if not yet approved/disapproved
272
433
    approval_delay: datetime.timedelta(); Time to wait for approval
273
434
    approval_duration: datetime.timedelta(); Duration of one approval
274
435
    checker:    subprocess.Popen(); a running checker process used
281
442
                     instance %(name)s can be used in the command.
282
443
    checker_initiator_tag: a gobject event source tag, or None
283
444
    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
284
447
    current_checker_command: string; current running checker_command
285
 
    disable_hook:  If set, called by disable() as disable_hook(self)
286
448
    disable_initiator_tag: a gobject event source tag, or None
287
449
    enabled:    bool()
288
450
    fingerprint: string (40 or 32 hexadecimal digits); used to
291
453
    interval:   datetime.timedelta(); How often to start a new checker
292
454
    last_approval_request: datetime.datetime(); (UTC) or None
293
455
    last_checked_ok: datetime.datetime(); (UTC) or None
294
 
    last_enabled: datetime.datetime(); (UTC)
 
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
295
460
    name:       string; from the config file, used in log messages and
296
461
                        D-Bus identifiers
297
462
    secret:     bytestring; sent verbatim (over TLS) to client
298
463
    timeout:    datetime.timedelta(); How long from last_checked_ok
299
464
                                      until this client is disabled
 
465
    extended_timeout:   extra long timeout when secret has been sent
300
466
    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()
301
470
    """
302
471
    
303
472
    runtime_expansions = ("approval_delay", "approval_duration",
304
 
                          "created", "enabled", "fingerprint",
305
 
                          "host", "interval", "last_checked_ok",
 
473
                          "created", "enabled", "expires",
 
474
                          "fingerprint", "host", "interval",
 
475
                          "last_approval_request", "last_checked_ok",
306
476
                          "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
    }
307
488
    
308
489
    @staticmethod
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."""
 
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):
330
540
        self.name = name
331
 
        if config is None:
332
 
            config = {}
 
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
        
333
558
        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(" ", ""))
339
559
        logger.debug("  Fingerprint: %s", self.fingerprint)
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
 
560
        self.created = settings.get("created",
 
561
                                    datetime.datetime.utcnow())
 
562
        
 
563
        # attributes specific for this server instance
359
564
        self.checker = None
360
565
        self.checker_initiator_tag = None
361
566
        self.disable_initiator_tag = None
362
567
        self.checker_callback_tag = None
363
 
        self.checker_command = config["checker"]
364
568
        self.current_checker_command = None
365
 
        self.last_connect = None
366
 
        self._approved = None
367
 
        self.approved_by_default = config.get("approved_by_default",
368
 
                                              True)
 
569
        self.approved = None
369
570
        self.approvals_pending = 0
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())
 
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)
375
582
    
 
583
    # Send notice to process children that client state has changed
376
584
    def send_changedstate(self):
377
 
        self.changedstate.acquire()
378
 
        self.changedstate.notify_all()
379
 
        self.changedstate.release()
380
 
        
 
585
        with self.changedstate:
 
586
            self.changedstate.notify_all()
 
587
    
381
588
    def enable(self):
382
589
        """Start this client's checker and timeout hooks"""
383
590
        if getattr(self, "enabled", False):
384
591
            # Already enabled
385
592
            return
386
 
        self.send_changedstate()
 
593
        self.expires = datetime.datetime.utcnow() + self.timeout
 
594
        self.enabled = True
387
595
        self.last_enabled = datetime.datetime.utcnow()
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()
 
596
        self.init_checker()
 
597
        self.send_changedstate()
400
598
    
401
599
    def disable(self, quiet=True):
402
600
        """Disable this client."""
403
601
        if not getattr(self, "enabled", False):
404
602
            return False
405
603
        if not quiet:
406
 
            self.send_changedstate()
407
 
        if not quiet:
408
604
            logger.info("Disabling client %s", self.name)
409
 
        if getattr(self, "disable_initiator_tag", False):
 
605
        if getattr(self, "disable_initiator_tag", None) is not None:
410
606
            gobject.source_remove(self.disable_initiator_tag)
411
607
            self.disable_initiator_tag = None
412
 
        if getattr(self, "checker_initiator_tag", False):
 
608
        self.expires = None
 
609
        if getattr(self, "checker_initiator_tag", None) is not None:
413
610
            gobject.source_remove(self.checker_initiator_tag)
414
611
            self.checker_initiator_tag = None
415
612
        self.stop_checker()
416
 
        if self.disable_hook:
417
 
            self.disable_hook(self)
418
613
        self.enabled = False
 
614
        if not quiet:
 
615
            self.send_changedstate()
419
616
        # Do not run this again if called by a gobject.timeout_add
420
617
        return False
421
618
    
422
619
    def __del__(self):
423
 
        self.disable_hook = None
424
620
        self.disable()
425
621
    
 
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
    
426
638
    def checker_callback(self, pid, condition, command):
427
639
        """The checker has completed, so take appropriate actions."""
428
640
        self.checker_callback_tag = None
429
641
        self.checker = None
430
642
        if os.WIFEXITED(condition):
431
 
            exitstatus = os.WEXITSTATUS(condition)
432
 
            if exitstatus == 0:
 
643
            self.last_checker_status = os.WEXITSTATUS(condition)
 
644
            if self.last_checker_status == 0:
433
645
                logger.info("Checker for %(name)s succeeded",
434
646
                            vars(self))
435
647
                self.checked_ok()
436
648
            else:
437
 
                logger.info("Checker for %(name)s failed",
438
 
                            vars(self))
 
649
                logger.info("Checker for %(name)s failed", vars(self))
439
650
        else:
 
651
            self.last_checker_status = -1
440
652
            logger.warning("Checker for %(name)s crashed?",
441
653
                           vars(self))
442
654
    
443
655
    def checked_ok(self):
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
 
        """
 
656
        """Assert that the client has been seen, alive and well."""
449
657
        self.last_checked_ok = datetime.datetime.utcnow()
450
 
        gobject.source_remove(self.disable_initiator_tag)
451
 
        self.disable_initiator_tag = (gobject.timeout_add
452
 
                                      (self.timeout_milliseconds(),
453
 
                                       self.disable))
 
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
454
672
    
455
673
    def need_approval(self):
456
674
        self.last_approval_request = datetime.datetime.utcnow()
461
679
        If a checker already exists, leave it running and do
462
680
        nothing."""
463
681
        # The reason for not killing a running checker is that if we
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
 
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
468
686
        # checkers alone, the checker would have to take more time
469
687
        # than 'timeout' for the client to be disabled, which is as it
470
688
        # should be.
472
690
        # If a checker exists, make sure it is not a zombie
473
691
        try:
474
692
            pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
475
 
        except (AttributeError, OSError) as error:
476
 
            if (isinstance(error, OSError)
477
 
                and error.errno != errno.ECHILD):
478
 
                raise error
 
693
        except AttributeError:
 
694
            pass
 
695
        except OSError as error:
 
696
            if error.errno != errno.ECHILD:
 
697
                raise
479
698
        else:
480
699
            if pid:
481
700
                logger.warning("Checker was a zombie")
484
703
                                      self.current_checker_command)
485
704
        # Start a new checker if needed
486
705
        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 }
487
710
            try:
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
 
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
506
717
            self.current_checker_command = command
507
718
            try:
508
 
                logger.info("Starting checker %r for %s",
509
 
                            command, self.name)
 
719
                logger.info("Starting checker %r for %s", command,
 
720
                            self.name)
510
721
                # We don't need to redirect stdout and stderr, since
511
722
                # in normal mode, that is already done by daemon(),
512
723
                # and in debug mode we don't want to.  (Stdin is
513
724
                # 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 })
514
733
                self.checker = subprocess.Popen(command,
515
734
                                                close_fds=True,
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.
 
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:
523
747
                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)
527
748
            except OSError as error:
528
 
                logger.error("Failed to start subprocess: %s",
529
 
                             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)
530
758
        # Re-run this periodically if run by gobject.timeout_add
531
759
        return True
532
760
    
539
767
            return
540
768
        logger.debug("Stopping checker for %(name)s", vars(self))
541
769
        try:
542
 
            os.kill(self.checker.pid, signal.SIGTERM)
 
770
            self.checker.terminate()
543
771
            #time.sleep(0.5)
544
772
            #if self.checker.poll() is None:
545
 
            #    os.kill(self.checker.pid, signal.SIGKILL)
 
773
            #    self.checker.kill()
546
774
        except OSError as error:
547
775
            if error.errno != errno.ESRCH: # No such process
548
776
                raise
549
777
        self.checker = None
550
778
 
551
 
def dbus_service_property(dbus_interface, signature="v",
552
 
                          access="readwrite", byte_arrays=False):
 
779
 
 
780
def dbus_service_property(dbus_interface,
 
781
                          signature="v",
 
782
                          access="readwrite",
 
783
                          byte_arrays=False):
553
784
    """Decorators for marking methods of a DBusObjectWithProperties to
554
785
    become properties on the D-Bus.
555
786
    
564
795
    # "Set" method, so we fail early here:
565
796
    if byte_arrays and signature != "ay":
566
797
        raise ValueError("Byte arrays not supported for non-'ay'"
567
 
                         " signature %r" % signature)
 
798
                         " signature {!r}".format(signature))
 
799
    
568
800
    def decorator(func):
569
801
        func._dbus_is_property = True
570
802
        func._dbus_interface = dbus_interface
575
807
            func._dbus_name = func._dbus_name[:-14]
576
808
        func._dbus_get_args_options = {'byte_arrays': byte_arrays }
577
809
        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
    
578
852
    return decorator
579
853
 
580
854
 
581
855
class DBusPropertyException(dbus.exceptions.DBusException):
582
856
    """A base class for D-Bus property-related exceptions
583
857
    """
584
 
    def __unicode__(self):
585
 
        return unicode(str(self))
 
858
    pass
586
859
 
587
860
 
588
861
class DBusPropertyAccessException(DBusPropertyException):
599
872
 
600
873
class DBusObjectWithProperties(dbus.service.Object):
601
874
    """A D-Bus object with properties.
602
 
 
 
875
    
603
876
    Classes inheriting from this can use the dbus_service_property
604
877
    decorator to expose methods as D-Bus properties.  It exposes the
605
878
    standard Get(), Set(), and GetAll() methods on the D-Bus.
606
879
    """
607
880
    
608
881
    @staticmethod
609
 
    def _is_dbus_property(obj):
610
 
        return getattr(obj, "_dbus_is_property", False)
 
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)
611
890
    
612
 
    def _get_all_dbus_properties(self):
 
891
    def _get_all_dbus_things(self, thing):
613
892
        """Returns a generator of (name, attribute) pairs
614
893
        """
615
 
        return ((prop._dbus_name, prop)
616
 
                for name, prop in
617
 
                inspect.getmembers(self, self._is_dbus_property))
 
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)))
618
899
    
619
900
    def _get_dbus_property(self, interface_name, property_name):
620
901
        """Returns a bound method if one exists which is a D-Bus
621
902
        property with the specified name and interface.
622
903
        """
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
 
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
        
633
911
        # No such property
634
 
        raise DBusPropertyNotFound(self.dbus_object_path + ":"
635
 
                                   + interface_name + "."
636
 
                                   + property_name)
 
912
        raise DBusPropertyNotFound("{}:{}.{}".format(
 
913
            self.dbus_object_path, interface_name, property_name))
637
914
    
638
 
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
 
915
    @dbus.service.method(dbus.PROPERTIES_IFACE,
 
916
                         in_signature="ss",
639
917
                         out_signature="v")
640
918
    def Get(self, interface_name, property_name):
641
919
        """Standard D-Bus property Get() method, see D-Bus standard.
659
937
            # The byte_arrays option is not supported yet on
660
938
            # signatures other than "ay".
661
939
            if prop._dbus_signature != "ay":
662
 
                raise ValueError
663
 
            value = dbus.ByteArray(''.join(unichr(byte)
664
 
                                           for byte in value))
 
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))
665
945
        prop(value)
666
946
    
667
 
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
 
947
    @dbus.service.method(dbus.PROPERTIES_IFACE,
 
948
                         in_signature="s",
668
949
                         out_signature="a{sv}")
669
950
    def GetAll(self, interface_name):
670
951
        """Standard D-Bus property GetAll() method, see D-Bus
671
952
        standard.
672
 
 
 
953
        
673
954
        Note: Will not include properties with access="write".
674
955
        """
675
 
        all = {}
676
 
        for name, prop in self._get_all_dbus_properties():
 
956
        properties = {}
 
957
        for name, prop in self._get_all_dbus_things("property"):
677
958
            if (interface_name
678
959
                and interface_name != prop._dbus_interface):
679
960
                # Interface non-empty but did not match
683
964
                continue
684
965
            value = prop()
685
966
            if not hasattr(value, "variant_level"):
686
 
                all[name] = value
 
967
                properties[name] = value
687
968
                continue
688
 
            all[name] = type(value)(value, variant_level=
689
 
                                    value.variant_level+1)
690
 
        return dbus.Dictionary(all, signature="sv")
 
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
691
980
    
692
981
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
693
982
                         out_signature="s",
694
983
                         path_keyword='object_path',
695
984
                         connection_keyword='connection')
696
985
    def Introspect(self, object_path, connection):
697
 
        """Standard D-Bus method, overloaded to insert property tags.
 
986
        """Overloading of standard D-Bus method.
 
987
        
 
988
        Inserts property tags and interface annotation tags.
698
989
        """
699
990
        xmlstring = dbus.service.Object.Introspect(self, object_path,
700
991
                                                   connection)
701
992
        try:
702
993
            document = xml.dom.minidom.parseString(xmlstring)
 
994
            
703
995
            def make_tag(document, name, prop):
704
996
                e = document.createElement("property")
705
997
                e.setAttribute("name", name)
706
998
                e.setAttribute("type", prop._dbus_signature)
707
999
                e.setAttribute("access", prop._dbus_access)
708
1000
                return e
 
1001
            
709
1002
            for if_tag in document.getElementsByTagName("interface"):
 
1003
                # Add property tags
710
1004
                for tag in (make_tag(document, name, prop)
711
1005
                            for name, prop
712
 
                            in self._get_all_dbus_properties()
 
1006
                            in self._get_all_dbus_things("property")
713
1007
                            if prop._dbus_interface
714
1008
                            == if_tag.getAttribute("name")):
715
1009
                    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)
716
1039
                # Add the names to the return values for the
717
1040
                # "org.freedesktop.DBus.Properties" methods
718
1041
                if (if_tag.getAttribute("name")
733
1056
        except (AttributeError, xml.dom.DOMException,
734
1057
                xml.parsers.expat.ExpatError) as error:
735
1058
            logger.error("Failed to override Introspection method",
736
 
                         error)
 
1059
                         exc_info=error)
737
1060
        return xmlstring
738
1061
 
739
1062
 
 
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"})
740
1241
class ClientDBus(Client, DBusObjectWithProperties):
741
1242
    """A Client class using D-Bus
742
1243
    
746
1247
    """
747
1248
    
748
1249
    runtime_expansions = (Client.runtime_expansions
749
 
                          + ("dbus_object_path",))
 
1250
                          + ("dbus_object_path", ))
 
1251
    
 
1252
    _interface = "se.recompile.Mandos.Client"
750
1253
    
751
1254
    # dbus.service.Object doesn't use super(), so we can't either.
752
1255
    
753
1256
    def __init__(self, bus = None, *args, **kwargs):
754
 
        self._approvals_pending = 0
755
1257
        self.bus = bus
756
1258
        Client.__init__(self, *args, **kwargs)
757
1259
        # Only now, when this client is initialized, can it show up on
758
1260
        # the D-Bus
759
 
        client_object_name = unicode(self.name).translate(
 
1261
        client_object_name = str(self.name).translate(
760
1262
            {ord("."): ord("_"),
761
1263
             ord("-"): ord("_")})
762
 
        self.dbus_object_path = (dbus.ObjectPath
763
 
                                 ("/clients/" + client_object_name))
 
1264
        self.dbus_object_path = dbus.ObjectPath(
 
1265
            "/clients/" + client_object_name)
764
1266
        DBusObjectWithProperties.__init__(self, self.bus,
765
1267
                                          self.dbus_object_path)
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
 
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
810
1349
    
811
1350
    def __del__(self, *args, **kwargs):
812
1351
        try:
821
1360
                         *args, **kwargs):
822
1361
        self.checker_callback_tag = None
823
1362
        self.checker = None
824
 
        # Emit D-Bus signal
825
 
        self.PropertyChanged(dbus.String("CheckerRunning"),
826
 
                             dbus.Boolean(False, variant_level=1))
827
1363
        if os.WIFEXITED(condition):
828
1364
            exitstatus = os.WEXITSTATUS(condition)
829
1365
            # Emit D-Bus signal
839
1375
        return Client.checker_callback(self, pid, condition, command,
840
1376
                                       *args, **kwargs)
841
1377
    
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
 
    
859
1378
    def start_checker(self, *args, **kwargs):
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
 
1379
        old_checker_pid = getattr(self.checker, "pid", None)
865
1380
        r = Client.start_checker(self, *args, **kwargs)
866
1381
        # Only if new checker process was started
867
1382
        if (self.checker is not None
868
1383
            and old_checker_pid != self.checker.pid):
869
1384
            # Emit D-Bus signal
870
1385
            self.CheckerStarted(self.current_checker_command)
871
 
            self.PropertyChanged(
872
 
                dbus.String("CheckerRunning"),
873
 
                dbus.Boolean(True, variant_level=1))
874
1386
        return r
875
1387
    
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
 
 
885
1388
    def _reset_approved(self):
886
 
        self._approved = None
 
1389
        self.approved = None
887
1390
        return False
888
1391
    
889
1392
    def approve(self, value=True):
 
1393
        self.approved = value
 
1394
        gobject.timeout_add(int(self.approval_duration.total_seconds()
 
1395
                                * 1000), self._reset_approved)
890
1396
        self.send_changedstate()
891
 
        self._approved = value
892
 
        gobject.timeout_add(self._timedelta_to_milliseconds
893
 
                            (self.approval_duration),
894
 
                            self._reset_approved)
895
 
    
896
1397
    
897
1398
    ## D-Bus methods, signals & properties
898
 
    _interface = "se.bsnet.fukt.Mandos.Client"
 
1399
    
 
1400
    ## Interfaces
899
1401
    
900
1402
    ## Signals
901
1403
    
912
1414
        pass
913
1415
    
914
1416
    # PropertyChanged - signal
 
1417
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
915
1418
    @dbus.service.signal(_interface, signature="sv")
916
1419
    def PropertyChanged(self, property, value):
917
1420
        "D-Bus signal"
981
1484
        return dbus.Boolean(bool(self.approvals_pending))
982
1485
    
983
1486
    # ApprovedByDefault - property
984
 
    @dbus_service_property(_interface, signature="b",
 
1487
    @dbus_service_property(_interface,
 
1488
                           signature="b",
985
1489
                           access="readwrite")
986
1490
    def ApprovedByDefault_dbus_property(self, value=None):
987
1491
        if value is None:       # get
988
1492
            return dbus.Boolean(self.approved_by_default)
989
1493
        self.approved_by_default = bool(value)
990
 
        # Emit D-Bus signal
991
 
        self.PropertyChanged(dbus.String("ApprovedByDefault"),
992
 
                             dbus.Boolean(value, variant_level=1))
993
1494
    
994
1495
    # ApprovalDelay - property
995
 
    @dbus_service_property(_interface, signature="t",
 
1496
    @dbus_service_property(_interface,
 
1497
                           signature="t",
996
1498
                           access="readwrite")
997
1499
    def ApprovalDelay_dbus_property(self, value=None):
998
1500
        if value is None:       # get
999
 
            return dbus.UInt64(self.approval_delay_milliseconds())
 
1501
            return dbus.UInt64(self.approval_delay.total_seconds()
 
1502
                               * 1000)
1000
1503
        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))
1004
1504
    
1005
1505
    # ApprovalDuration - property
1006
 
    @dbus_service_property(_interface, signature="t",
 
1506
    @dbus_service_property(_interface,
 
1507
                           signature="t",
1007
1508
                           access="readwrite")
1008
1509
    def ApprovalDuration_dbus_property(self, value=None):
1009
1510
        if value is None:       # get
1010
 
            return dbus.UInt64(self._timedelta_to_milliseconds(
1011
 
                    self.approval_duration))
 
1511
            return dbus.UInt64(self.approval_duration.total_seconds()
 
1512
                               * 1000)
1012
1513
        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))
1016
1514
    
1017
1515
    # Name - property
1018
1516
    @dbus_service_property(_interface, signature="s", access="read")
1025
1523
        return dbus.String(self.fingerprint)
1026
1524
    
1027
1525
    # Host - property
1028
 
    @dbus_service_property(_interface, signature="s",
 
1526
    @dbus_service_property(_interface,
 
1527
                           signature="s",
1029
1528
                           access="readwrite")
1030
1529
    def Host_dbus_property(self, value=None):
1031
1530
        if value is None:       # get
1032
1531
            return dbus.String(self.host)
1033
 
        self.host = value
1034
 
        # Emit D-Bus signal
1035
 
        self.PropertyChanged(dbus.String("Host"),
1036
 
                             dbus.String(value, variant_level=1))
 
1532
        self.host = str(value)
1037
1533
    
1038
1534
    # Created - property
1039
1535
    @dbus_service_property(_interface, signature="s", access="read")
1040
1536
    def Created_dbus_property(self):
1041
 
        return dbus.String(self._datetime_to_dbus(self.created))
 
1537
        return datetime_to_dbus(self.created)
1042
1538
    
1043
1539
    # LastEnabled - property
1044
1540
    @dbus_service_property(_interface, signature="s", access="read")
1045
1541
    def LastEnabled_dbus_property(self):
1046
 
        if self.last_enabled is None:
1047
 
            return dbus.String("")
1048
 
        return dbus.String(self._datetime_to_dbus(self.last_enabled))
 
1542
        return datetime_to_dbus(self.last_enabled)
1049
1543
    
1050
1544
    # Enabled - property
1051
 
    @dbus_service_property(_interface, signature="b",
 
1545
    @dbus_service_property(_interface,
 
1546
                           signature="b",
1052
1547
                           access="readwrite")
1053
1548
    def Enabled_dbus_property(self, value=None):
1054
1549
        if value is None:       # get
1059
1554
            self.disable()
1060
1555
    
1061
1556
    # LastCheckedOK - property
1062
 
    @dbus_service_property(_interface, signature="s",
 
1557
    @dbus_service_property(_interface,
 
1558
                           signature="s",
1063
1559
                           access="readwrite")
1064
1560
    def LastCheckedOK_dbus_property(self, value=None):
1065
1561
        if value is not None:
1066
1562
            self.checked_ok()
1067
1563
            return
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))
 
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)
1072
1575
    
1073
1576
    # LastApprovalRequest - property
1074
1577
    @dbus_service_property(_interface, signature="s", access="read")
1075
1578
    def LastApprovalRequest_dbus_property(self):
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))
 
1579
        return datetime_to_dbus(self.last_approval_request)
1081
1580
    
1082
1581
    # Timeout - property
1083
 
    @dbus_service_property(_interface, signature="t",
 
1582
    @dbus_service_property(_interface,
 
1583
                           signature="t",
1084
1584
                           access="readwrite")
1085
1585
    def Timeout_dbus_property(self, value=None):
1086
1586
        if value is None:       # get
1087
 
            return dbus.UInt64(self.timeout_milliseconds())
 
1587
            return dbus.UInt64(self.timeout.total_seconds() * 1000)
 
1588
        old_timeout = self.timeout
1088
1589
        self.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))
 
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)
1109
1615
    
1110
1616
    # Interval - property
1111
 
    @dbus_service_property(_interface, signature="t",
 
1617
    @dbus_service_property(_interface,
 
1618
                           signature="t",
1112
1619
                           access="readwrite")
1113
1620
    def Interval_dbus_property(self, value=None):
1114
1621
        if value is None:       # get
1115
 
            return dbus.UInt64(self.interval_milliseconds())
 
1622
            return dbus.UInt64(self.interval.total_seconds() * 1000)
1116
1623
        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))
1120
1624
        if getattr(self, "checker_initiator_tag", None) is None:
1121
1625
            return
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
 
 
 
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
    
1128
1633
    # Checker - property
1129
 
    @dbus_service_property(_interface, signature="s",
 
1634
    @dbus_service_property(_interface,
 
1635
                           signature="s",
1130
1636
                           access="readwrite")
1131
1637
    def Checker_dbus_property(self, value=None):
1132
1638
        if value is None:       # get
1133
1639
            return dbus.String(self.checker_command)
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))
 
1640
        self.checker_command = str(value)
1139
1641
    
1140
1642
    # CheckerRunning - property
1141
 
    @dbus_service_property(_interface, signature="b",
 
1643
    @dbus_service_property(_interface,
 
1644
                           signature="b",
1142
1645
                           access="readwrite")
1143
1646
    def CheckerRunning_dbus_property(self, value=None):
1144
1647
        if value is None:       # get
1154
1657
        return self.dbus_object_path # is already a dbus.ObjectPath
1155
1658
    
1156
1659
    # Secret = property
1157
 
    @dbus_service_property(_interface, signature="ay",
1158
 
                           access="write", byte_arrays=True)
 
1660
    @dbus_service_property(_interface,
 
1661
                           signature="ay",
 
1662
                           access="write",
 
1663
                           byte_arrays=True)
1159
1664
    def Secret_dbus_property(self, value):
1160
 
        self.secret = str(value)
 
1665
        self.secret = bytes(value)
1161
1666
    
1162
1667
    del _interface
1163
1668
 
1167
1672
        self._pipe = child_pipe
1168
1673
        self._pipe.send(('init', fpr, address))
1169
1674
        if not self._pipe.recv():
1170
 
            raise KeyError()
1171
 
 
 
1675
            raise KeyError(fpr)
 
1676
    
1172
1677
    def __getattribute__(self, name):
1173
 
        if(name == '_pipe'):
 
1678
        if name == '_pipe':
1174
1679
            return super(ProxyClient, self).__getattribute__(name)
1175
1680
        self._pipe.send(('getattr', name))
1176
1681
        data = self._pipe.recv()
1177
1682
        if data[0] == 'data':
1178
1683
            return data[1]
1179
1684
        if data[0] == 'function':
 
1685
            
1180
1686
            def func(*args, **kwargs):
1181
1687
                self._pipe.send(('funcall', name, args, kwargs))
1182
1688
                return self._pipe.recv()[1]
 
1689
            
1183
1690
            return func
1184
 
 
 
1691
    
1185
1692
    def __setattr__(self, name, value):
1186
 
        if(name == '_pipe'):
 
1693
        if name == '_pipe':
1187
1694
            return super(ProxyClient, self).__setattr__(name, value)
1188
1695
        self._pipe.send(('setattr', name, value))
1189
1696
 
1197
1704
    def handle(self):
1198
1705
        with contextlib.closing(self.server.child_pipe) as child_pipe:
1199
1706
            logger.info("TCP connection from: %s",
1200
 
                        unicode(self.client_address))
 
1707
                        str(self.client_address))
1201
1708
            logger.debug("Pipe FD: %d",
1202
1709
                         self.server.child_pipe.fileno())
1203
 
 
1204
 
            session = (gnutls.connection
1205
 
                       .ClientSession(self.request,
1206
 
                                      gnutls.connection
1207
 
                                      .X509Credentials()))
1208
 
 
 
1710
            
 
1711
            session = gnutls.connection.ClientSession(
 
1712
                self.request, gnutls.connection .X509Credentials())
 
1713
            
1209
1714
            # Note: gnutls.connection.X509Credentials is really a
1210
1715
            # generic GnuTLS certificate credentials object so long as
1211
1716
            # no X.509 keys are added to it.  Therefore, we can use it
1212
1717
            # here despite using OpenPGP certificates.
1213
 
 
 
1718
            
1214
1719
            #priority = ':'.join(("NONE", "+VERS-TLS1.1",
1215
1720
            #                      "+AES-256-CBC", "+SHA1",
1216
1721
            #                      "+COMP-NULL", "+CTYPE-OPENPGP",
1219
1724
            priority = self.server.gnutls_priority
1220
1725
            if priority is None:
1221
1726
                priority = "NORMAL"
1222
 
            (gnutls.library.functions
1223
 
             .gnutls_priority_set_direct(session._c_object,
1224
 
                                         priority, None))
1225
 
 
 
1727
            gnutls.library.functions.gnutls_priority_set_direct(
 
1728
                session._c_object, priority, None)
 
1729
            
1226
1730
            # Start communication using the Mandos protocol
1227
1731
            # Get protocol number
1228
1732
            line = self.request.makefile().readline()
1229
1733
            logger.debug("Protocol version: %r", line)
1230
1734
            try:
1231
1735
                if int(line.strip().split()[0]) > 1:
1232
 
                    raise RuntimeError
 
1736
                    raise RuntimeError(line)
1233
1737
            except (ValueError, IndexError, RuntimeError) as error:
1234
1738
                logger.error("Unknown protocol version: %s", error)
1235
1739
                return
1236
 
 
 
1740
            
1237
1741
            # Start GnuTLS connection
1238
1742
            try:
1239
1743
                session.handshake()
1243
1747
                # established.  Just abandon the request.
1244
1748
                return
1245
1749
            logger.debug("Handshake succeeded")
1246
 
 
 
1750
            
1247
1751
            approval_required = False
1248
1752
            try:
1249
1753
                try:
1250
 
                    fpr = self.fingerprint(self.peer_certificate
1251
 
                                           (session))
 
1754
                    fpr = self.fingerprint(
 
1755
                        self.peer_certificate(session))
1252
1756
                except (TypeError,
1253
1757
                        gnutls.errors.GNUTLSError) as error:
1254
1758
                    logger.warning("Bad certificate: %s", error)
1255
1759
                    return
1256
1760
                logger.debug("Fingerprint: %s", fpr)
1257
 
 
 
1761
                
1258
1762
                try:
1259
1763
                    client = ProxyClient(child_pipe, fpr,
1260
1764
                                         self.client_address)
1269
1773
                while True:
1270
1774
                    if not client.enabled:
1271
1775
                        logger.info("Client %s is disabled",
1272
 
                                       client.name)
 
1776
                                    client.name)
1273
1777
                        if self.server.use_dbus:
1274
1778
                            # Emit D-Bus signal
1275
 
                            client.Rejected("Disabled")                    
 
1779
                            client.Rejected("Disabled")
1276
1780
                        return
1277
1781
                    
1278
 
                    if client._approved or not client.approval_delay:
 
1782
                    if client.approved or not client.approval_delay:
1279
1783
                        #We are approved or approval is disabled
1280
1784
                        break
1281
 
                    elif client._approved is None:
 
1785
                    elif client.approved is None:
1282
1786
                        logger.info("Client %s needs approval",
1283
1787
                                    client.name)
1284
1788
                        if self.server.use_dbus:
1285
1789
                            # Emit D-Bus signal
1286
1790
                            client.NeedApproval(
1287
 
                                client.approval_delay_milliseconds(),
1288
 
                                client.approved_by_default)
 
1791
                                client.approval_delay.total_seconds()
 
1792
                                * 1000, client.approved_by_default)
1289
1793
                    else:
1290
1794
                        logger.warning("Client %s was not approved",
1291
1795
                                       client.name)
1295
1799
                        return
1296
1800
                    
1297
1801
                    #wait until timeout or approved
1298
 
                    #x = float(client._timedelta_to_milliseconds(delay))
1299
1802
                    time = datetime.datetime.now()
1300
1803
                    client.changedstate.acquire()
1301
 
                    client.changedstate.wait(float(client._timedelta_to_milliseconds(delay) / 1000))
 
1804
                    client.changedstate.wait(delay.total_seconds())
1302
1805
                    client.changedstate.release()
1303
1806
                    time2 = datetime.datetime.now()
1304
1807
                    if (time2 - time) >= delay:
1320
1823
                    try:
1321
1824
                        sent = session.send(client.secret[sent_size:])
1322
1825
                    except gnutls.errors.GNUTLSError as error:
1323
 
                        logger.warning("gnutls send failed")
 
1826
                        logger.warning("gnutls send failed",
 
1827
                                       exc_info=error)
1324
1828
                        return
1325
 
                    logger.debug("Sent: %d, remaining: %d",
1326
 
                                 sent, len(client.secret)
1327
 
                                 - (sent_size + sent))
 
1829
                    logger.debug("Sent: %d, remaining: %d", sent,
 
1830
                                 len(client.secret) - (sent_size
 
1831
                                                       + sent))
1328
1832
                    sent_size += sent
1329
 
 
 
1833
                
1330
1834
                logger.info("Sending secret to %s", client.name)
1331
 
                # bump the timeout as if seen
1332
 
                client.checked_ok()
 
1835
                # bump the timeout using extended_timeout
 
1836
                client.bump_timeout(client.extended_timeout)
1333
1837
                if self.server.use_dbus:
1334
1838
                    # Emit D-Bus signal
1335
1839
                    client.GotSecret()
1340
1844
                try:
1341
1845
                    session.bye()
1342
1846
                except gnutls.errors.GNUTLSError as error:
1343
 
                    logger.warning("GnuTLS bye failed")
 
1847
                    logger.warning("GnuTLS bye failed",
 
1848
                                   exc_info=error)
1344
1849
    
1345
1850
    @staticmethod
1346
1851
    def peer_certificate(session):
1347
1852
        "Return the peer's OpenPGP certificate as a bytestring"
1348
1853
        # If not an OpenPGP certificate...
1349
 
        if (gnutls.library.functions
1350
 
            .gnutls_certificate_type_get(session._c_object)
 
1854
        if (gnutls.library.functions.gnutls_certificate_type_get(
 
1855
                session._c_object)
1351
1856
            != gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1352
1857
            # ...do the normal thing
1353
1858
            return session.peer_certificate
1367
1872
    def fingerprint(openpgp):
1368
1873
        "Convert an OpenPGP bytestring to a hexdigit fingerprint"
1369
1874
        # New GnuTLS "datum" with the OpenPGP public key
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))))
 
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)))
1375
1879
        # New empty GnuTLS certificate
1376
1880
        crt = gnutls.library.types.gnutls_openpgp_crt_t()
1377
 
        (gnutls.library.functions
1378
 
         .gnutls_openpgp_crt_init(ctypes.byref(crt)))
 
1881
        gnutls.library.functions.gnutls_openpgp_crt_init(
 
1882
            ctypes.byref(crt))
1379
1883
        # Import the OpenPGP public key into the certificate
1380
 
        (gnutls.library.functions
1381
 
         .gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1382
 
                                    gnutls.library.constants
1383
 
                                    .GNUTLS_OPENPGP_FMT_RAW))
 
1884
        gnutls.library.functions.gnutls_openpgp_crt_import(
 
1885
            crt, ctypes.byref(datum),
 
1886
            gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
1384
1887
        # Verify the self signature in the key
1385
1888
        crtverify = ctypes.c_uint()
1386
 
        (gnutls.library.functions
1387
 
         .gnutls_openpgp_crt_verify_self(crt, 0,
1388
 
                                         ctypes.byref(crtverify)))
 
1889
        gnutls.library.functions.gnutls_openpgp_crt_verify_self(
 
1890
            crt, 0, ctypes.byref(crtverify))
1389
1891
        if crtverify.value != 0:
1390
1892
            gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1391
 
            raise (gnutls.errors.CertificateSecurityError
1392
 
                   ("Verify failed"))
 
1893
            raise gnutls.errors.CertificateSecurityError(
 
1894
                "Verify failed")
1393
1895
        # New buffer for the fingerprint
1394
1896
        buf = ctypes.create_string_buffer(20)
1395
1897
        buf_len = ctypes.c_size_t()
1396
1898
        # Get the fingerprint from the certificate into the buffer
1397
 
        (gnutls.library.functions
1398
 
         .gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1399
 
                                             ctypes.byref(buf_len)))
 
1899
        gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint(
 
1900
            crt, ctypes.byref(buf), ctypes.byref(buf_len))
1400
1901
        # Deinit the certificate
1401
1902
        gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1402
1903
        # Convert the buffer to a Python bytestring
1403
1904
        fpr = ctypes.string_at(buf, buf_len.value)
1404
1905
        # Convert the bytestring to hexadecimal notation
1405
 
        hex_fpr = ''.join("%02X" % ord(char) for char in fpr)
 
1906
        hex_fpr = binascii.hexlify(fpr).upper()
1406
1907
        return hex_fpr
1407
1908
 
1408
1909
 
1409
1910
class MultiprocessingMixIn(object):
1410
1911
    """Like socketserver.ThreadingMixIn, but with multiprocessing"""
 
1912
    
1411
1913
    def sub_process_main(self, request, address):
1412
1914
        try:
1413
1915
            self.finish_request(request, address)
1414
 
        except:
 
1916
        except Exception:
1415
1917
            self.handle_error(request, address)
1416
1918
        self.close_request(request)
1417
 
            
 
1919
    
1418
1920
    def process_request(self, request, address):
1419
1921
        """Start a new process to process the request."""
1420
 
        multiprocessing.Process(target = self.sub_process_main,
1421
 
                                args = (request, address)).start()
 
1922
        proc = multiprocessing.Process(target = self.sub_process_main,
 
1923
                                       args = (request, address))
 
1924
        proc.start()
 
1925
        return proc
 
1926
 
1422
1927
 
1423
1928
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1424
1929
    """ adds a pipe to the MixIn """
 
1930
    
1425
1931
    def process_request(self, request, client_address):
1426
1932
        """Overrides and wraps the original process_request().
1427
1933
        
1428
1934
        This function creates a new pipe in self.pipe
1429
1935
        """
1430
1936
        parent_pipe, self.child_pipe = multiprocessing.Pipe()
1431
 
 
1432
 
        super(MultiprocessingMixInWithPipe,
1433
 
              self).process_request(request, client_address)
 
1937
        
 
1938
        proc = MultiprocessingMixIn.process_request(self, request,
 
1939
                                                    client_address)
1434
1940
        self.child_pipe.close()
1435
 
        self.add_pipe(parent_pipe)
1436
 
 
1437
 
    def add_pipe(self, parent_pipe):
 
1941
        self.add_pipe(parent_pipe, proc)
 
1942
    
 
1943
    def add_pipe(self, parent_pipe, proc):
1438
1944
        """Dummy function; override as necessary"""
1439
 
        raise NotImplementedError
 
1945
        raise NotImplementedError()
 
1946
 
1440
1947
 
1441
1948
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1442
1949
                     socketserver.TCPServer, object):
1447
1954
        interface:      None or a network interface name (string)
1448
1955
        use_ipv6:       Boolean; to use IPv6 or not
1449
1956
    """
 
1957
    
1450
1958
    def __init__(self, server_address, RequestHandlerClass,
1451
 
                 interface=None, use_ipv6=True):
 
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
        """
1452
1965
        self.interface = interface
1453
1966
        if use_ipv6:
1454
1967
            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.
1455
1994
        socketserver.TCPServer.__init__(self, server_address,
1456
1995
                                        RequestHandlerClass)
 
1996
    
1457
1997
    def server_bind(self):
1458
1998
        """This overrides the normal server_bind() function
1459
1999
        to bind to an interface if one was specified, and also NOT to
1465
2005
                             self.interface)
1466
2006
            else:
1467
2007
                try:
1468
 
                    self.socket.setsockopt(socket.SOL_SOCKET,
1469
 
                                           SO_BINDTODEVICE,
1470
 
                                           str(self.interface
1471
 
                                               + '\0'))
 
2008
                    self.socket.setsockopt(
 
2009
                        socket.SOL_SOCKET, SO_BINDTODEVICE,
 
2010
                        (self.interface + "\0").encode("utf-8"))
1472
2011
                except socket.error as error:
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:
 
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:
1478
2016
                        logger.error("SO_BINDTODEVICE not available;"
1479
2017
                                     " cannot bind to interface %s",
1480
2018
                                     self.interface)
 
2019
                    elif error.errno == errno.ENODEV:
 
2020
                        logger.error("Interface %s does not exist,"
 
2021
                                     " cannot bind", self.interface)
1481
2022
                    else:
1482
2023
                        raise
1483
2024
        # Only bind(2) the socket if we really need to.
1486
2027
                if self.address_family == socket.AF_INET6:
1487
2028
                    any_address = "::" # in6addr_any
1488
2029
                else:
1489
 
                    any_address = socket.INADDR_ANY
 
2030
                    any_address = "0.0.0.0" # INADDR_ANY
1490
2031
                self.server_address = (any_address,
1491
2032
                                       self.server_address[1])
1492
2033
            elif not self.server_address[1]:
1493
 
                self.server_address = (self.server_address[0],
1494
 
                                       0)
 
2034
                self.server_address = (self.server_address[0], 0)
1495
2035
#                 if self.interface:
1496
2036
#                     self.server_address = (self.server_address[0],
1497
2037
#                                            0, # port
1511
2051
    
1512
2052
    Assumes a gobject.MainLoop event loop.
1513
2053
    """
 
2054
    
1514
2055
    def __init__(self, server_address, RequestHandlerClass,
1515
 
                 interface=None, use_ipv6=True, clients=None,
1516
 
                 gnutls_priority=None, use_dbus=True):
 
2056
                 interface=None,
 
2057
                 use_ipv6=True,
 
2058
                 clients=None,
 
2059
                 gnutls_priority=None,
 
2060
                 use_dbus=True,
 
2061
                 socketfd=None):
1517
2062
        self.enabled = False
1518
2063
        self.clients = clients
1519
2064
        if self.clients is None:
1520
 
            self.clients = set()
 
2065
            self.clients = {}
1521
2066
        self.use_dbus = use_dbus
1522
2067
        self.gnutls_priority = gnutls_priority
1523
2068
        IPv6_TCPServer.__init__(self, server_address,
1524
2069
                                RequestHandlerClass,
1525
2070
                                interface = interface,
1526
 
                                use_ipv6 = use_ipv6)
 
2071
                                use_ipv6 = use_ipv6,
 
2072
                                socketfd = socketfd)
 
2073
    
1527
2074
    def server_activate(self):
1528
2075
        if self.enabled:
1529
2076
            return socketserver.TCPServer.server_activate(self)
 
2077
    
1530
2078
    def enable(self):
1531
2079
        self.enabled = True
1532
 
    def add_pipe(self, parent_pipe):
 
2080
    
 
2081
    def add_pipe(self, parent_pipe, proc):
1533
2082
        # Call "handle_ipc" for both data and EOF events
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,
 
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,
1540
2093
                   client_object=None):
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):
 
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()
1557
2098
            return False
1558
2099
        
1559
2100
        # Read a request from the child
1564
2105
            fpr = request[1]
1565
2106
            address = request[2]
1566
2107
            
1567
 
            for c in self.clients:
 
2108
            for c in self.clients.itervalues():
1568
2109
                if c.fingerprint == fpr:
1569
2110
                    client = c
1570
2111
                    break
1573
2114
                            "dress: %s", fpr, address)
1574
2115
                if self.use_dbus:
1575
2116
                    # Emit D-Bus signal
1576
 
                    mandos_dbus_service.ClientNotFound(fpr, address[0])
 
2117
                    mandos_dbus_service.ClientNotFound(fpr,
 
2118
                                                       address[0])
1577
2119
                parent_pipe.send(False)
1578
2120
                return False
1579
2121
            
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))
 
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))
1585
2129
            parent_pipe.send(True)
1586
 
            # remove the old hook in favor of the new above hook on same fileno
 
2130
            # remove the old hook in favor of the new above hook on
 
2131
            # same fileno
1587
2132
            return False
1588
2133
        if command == 'funcall':
1589
2134
            funcname = request[1]
1590
2135
            args = request[2]
1591
2136
            kwargs = request[3]
1592
2137
            
1593
 
            parent_pipe.send(('data', getattr(client_object, funcname)(*args, **kwargs)))
1594
 
 
 
2138
            parent_pipe.send(('data', getattr(client_object,
 
2139
                                              funcname)(*args,
 
2140
                                                        **kwargs)))
 
2141
        
1595
2142
        if command == 'getattr':
1596
2143
            attrname = request[1]
1597
2144
            if callable(client_object.__getattribute__(attrname)):
1598
 
                parent_pipe.send(('function',))
 
2145
                parent_pipe.send(('function', ))
1599
2146
            else:
1600
 
                parent_pipe.send(('data', client_object.__getattribute__(attrname)))
 
2147
                parent_pipe.send((
 
2148
                    'data', client_object.__getattribute__(attrname)))
1601
2149
        
1602
2150
        if command == 'setattr':
1603
2151
            attrname = request[1]
1604
2152
            value = request[2]
1605
2153
            setattr(client_object, attrname, value)
1606
 
 
 
2154
        
1607
2155
        return True
1608
2156
 
1609
2157
 
 
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
 
2187
                                              # "value" is not None,
 
2188
                                              # must have a "group"
 
2189
                                              # containing digits
 
2190
                                    "value",  # datetime.timedelta or
 
2191
                                              # None
 
2192
                                    "followers")) # Tokens valid after
 
2193
                                                  # this token
 
2194
    Token = collections.namedtuple("Token", (
 
2195
        "regexp",  # To match token; if "value" is not None, must have
 
2196
                   # a "group" containing digits
 
2197
        "value",   # datetime.timedelta or None
 
2198
        "followers"))           # Tokens valid after this token
 
2199
    # RFC 3339 "duration" tokens, syntax, and semantics; taken from
 
2200
    # the "duration" ABNF definition in RFC 3339, Appendix A.
 
2201
    token_end = Token(re.compile(r"$"), None, frozenset())
 
2202
    token_second = Token(re.compile(r"(\d+)S"),
 
2203
                         datetime.timedelta(seconds=1),
 
2204
                         frozenset((token_end, )))
 
2205
    token_minute = Token(re.compile(r"(\d+)M"),
 
2206
                         datetime.timedelta(minutes=1),
 
2207
                         frozenset((token_second, token_end)))
 
2208
    token_hour = Token(re.compile(r"(\d+)H"),
 
2209
                       datetime.timedelta(hours=1),
 
2210
                       frozenset((token_minute, token_end)))
 
2211
    token_time = Token(re.compile(r"T"),
 
2212
                       None,
 
2213
                       frozenset((token_hour, token_minute,
 
2214
                                  token_second)))
 
2215
    token_day = Token(re.compile(r"(\d+)D"),
 
2216
                      datetime.timedelta(days=1),
 
2217
                      frozenset((token_time, token_end)))
 
2218
    token_month = Token(re.compile(r"(\d+)M"),
 
2219
                        datetime.timedelta(weeks=4),
 
2220
                        frozenset((token_day, token_end)))
 
2221
    token_year = Token(re.compile(r"(\d+)Y"),
 
2222
                       datetime.timedelta(weeks=52),
 
2223
                       frozenset((token_month, token_end)))
 
2224
    token_week = Token(re.compile(r"(\d+)W"),
 
2225
                       datetime.timedelta(weeks=1),
 
2226
                       frozenset((token_end, )))
 
2227
    token_duration = Token(re.compile(r"P"), None,
 
2228
                           frozenset((token_year, token_month,
 
2229
                                      token_day, token_time,
 
2230
                                      token_week)))
 
2231
    # Define starting values
 
2232
    value = datetime.timedelta() # Value so far
 
2233
    found_token = None
 
2234
    followers = frozenset((token_duration,)) # Following valid tokens
 
2235
    s = duration                # String left to parse
 
2236
    # Loop until end token is found
 
2237
    while found_token is not token_end:
 
2238
        # Search for any currently valid tokens
 
2239
        for token in followers:
 
2240
            match = token.regexp.match(s)
 
2241
            if match is not None:
 
2242
                # Token found
 
2243
                if token.value is not None:
 
2244
                    # Value found, parse digits
 
2245
                    factor = int(match.group(1), 10)
 
2246
                    # Add to value so far
 
2247
                    value += factor * token.value
 
2248
                # Strip token from string
 
2249
                s = token.regexp.sub("", s, 1)
 
2250
                # Go to found token
 
2251
                found_token = token
 
2252
                # Set valid next tokens
 
2253
                followers = found_token.followers
 
2254
                break
 
2255
        else:
 
2256
            # No currently valid tokens were found
 
2257
            raise ValueError("Invalid RFC 3339 duration: {!r}"
 
2258
                             .format(duration))
 
2259
    # End token found
 
2260
    return value
 
2261
 
 
2262
 
1610
2263
def string_to_delta(interval):
1611
2264
    """Parse a string and return a datetime.timedelta
1612
2265
    
1623
2276
    >>> string_to_delta('5m 30s')
1624
2277
    datetime.timedelta(0, 330)
1625
2278
    """
 
2279
    
 
2280
    try:
 
2281
        return rfc3339_duration_to_delta(interval)
 
2282
    except ValueError:
 
2283
        pass
 
2284
    
1626
2285
    timevalue = datetime.timedelta(0)
1627
2286
    for s in interval.split():
1628
2287
        try:
1629
 
            suffix = unicode(s[-1])
 
2288
            suffix = s[-1]
1630
2289
            value = int(s[:-1])
1631
2290
            if suffix == "d":
1632
2291
                delta = datetime.timedelta(value)
1639
2298
            elif suffix == "w":
1640
2299
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
1641
2300
            else:
1642
 
                raise ValueError("Unknown suffix %r" % suffix)
1643
 
        except (ValueError, IndexError) as e:
 
2301
                raise ValueError("Unknown suffix {!r}".format(suffix))
 
2302
        except IndexError as e:
1644
2303
            raise ValueError(*(e.args))
1645
2304
        timevalue += delta
1646
2305
    return timevalue
1647
2306
 
1648
2307
 
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
 
 
1673
2308
def daemon(nochdir = False, noclose = False):
1674
2309
    """See daemon(3).  Standard BSD Unix function.
1675
2310
    
1683
2318
        sys.exit()
1684
2319
    if not noclose:
1685
2320
        # Close all standard open file descriptors
1686
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
2321
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1687
2322
        if not stat.S_ISCHR(os.fstat(null).st_mode):
1688
2323
            raise OSError(errno.ENODEV,
1689
 
                          "%s not a character device"
1690
 
                          % os.path.devnull)
 
2324
                          "{} not a character device"
 
2325
                          .format(os.devnull))
1691
2326
        os.dup2(null, sys.stdin.fileno())
1692
2327
        os.dup2(null, sys.stdout.fileno())
1693
2328
        os.dup2(null, sys.stderr.fileno())
1702
2337
    
1703
2338
    parser = argparse.ArgumentParser()
1704
2339
    parser.add_argument("-v", "--version", action="version",
1705
 
                        version = "%%(prog)s %s" % version,
 
2340
                        version = "%(prog)s {}".format(version),
1706
2341
                        help="show version number and exit")
1707
2342
    parser.add_argument("-i", "--interface", metavar="IF",
1708
2343
                        help="Bind to interface IF")
1714
2349
                        help="Run self-test")
1715
2350
    parser.add_argument("--debug", action="store_true",
1716
2351
                        help="Debug mode; run in foreground and log"
1717
 
                        " to terminal")
 
2352
                        " to terminal", default=None)
1718
2353
    parser.add_argument("--debuglevel", metavar="LEVEL",
1719
2354
                        help="Debug level for stdout output")
1720
2355
    parser.add_argument("--priority", help="GnuTLS"
1727
2362
                        " files")
1728
2363
    parser.add_argument("--no-dbus", action="store_false",
1729
2364
                        dest="use_dbus", help="Do not provide D-Bus"
1730
 
                        " system bus interface")
 
2365
                        " system bus interface", default=None)
1731
2366
    parser.add_argument("--no-ipv6", action="store_false",
1732
 
                        dest="use_ipv6", help="Do not use IPv6")
 
2367
                        dest="use_ipv6", help="Do not use IPv6",
 
2368
                        default=None)
 
2369
    parser.add_argument("--no-restore", action="store_false",
 
2370
                        dest="restore", help="Do not restore stored"
 
2371
                        " state", default=None)
 
2372
    parser.add_argument("--socket", type=int,
 
2373
                        help="Specify a file descriptor to a network"
 
2374
                        " socket to use instead of creating one")
 
2375
    parser.add_argument("--statedir", metavar="DIR",
 
2376
                        help="Directory to save/restore state in")
 
2377
    parser.add_argument("--foreground", action="store_true",
 
2378
                        help="Run in foreground", default=None)
 
2379
    parser.add_argument("--no-zeroconf", action="store_false",
 
2380
                        dest="zeroconf", help="Do not use Zeroconf",
 
2381
                        default=None)
 
2382
    
1733
2383
    options = parser.parse_args()
1734
2384
    
1735
2385
    if options.check:
1736
2386
        import doctest
1737
 
        doctest.testmod()
1738
 
        sys.exit()
 
2387
        fail_count, test_count = doctest.testmod()
 
2388
        sys.exit(os.EX_OK if fail_count == 0 else 1)
1739
2389
    
1740
2390
    # Default values for config file for server-global settings
1741
2391
    server_defaults = { "interface": "",
1743
2393
                        "port": "",
1744
2394
                        "debug": "False",
1745
2395
                        "priority":
1746
 
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
 
2396
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
 
2397
                        ":+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",
1747
2398
                        "servicename": "Mandos",
1748
2399
                        "use_dbus": "True",
1749
2400
                        "use_ipv6": "True",
1750
2401
                        "debuglevel": "",
1751
 
                        }
 
2402
                        "restore": "True",
 
2403
                        "socket": "",
 
2404
                        "statedir": "/var/lib/mandos",
 
2405
                        "foreground": "False",
 
2406
                        "zeroconf": "True",
 
2407
                    }
1752
2408
    
1753
2409
    # Parse config file for server-global settings
1754
2410
    server_config = configparser.SafeConfigParser(server_defaults)
1755
2411
    del server_defaults
1756
 
    server_config.read(os.path.join(options.configdir,
1757
 
                                    "mandos.conf"))
 
2412
    server_config.read(os.path.join(options.configdir, "mandos.conf"))
1758
2413
    # Convert the SafeConfigParser object to a dict
1759
2414
    server_settings = server_config.defaults()
1760
2415
    # Use the appropriate methods on the non-string config options
1761
 
    for option in ("debug", "use_dbus", "use_ipv6"):
 
2416
    for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
1762
2417
        server_settings[option] = server_config.getboolean("DEFAULT",
1763
2418
                                                           option)
1764
2419
    if server_settings["port"]:
1765
2420
        server_settings["port"] = server_config.getint("DEFAULT",
1766
2421
                                                       "port")
 
2422
    if server_settings["socket"]:
 
2423
        server_settings["socket"] = server_config.getint("DEFAULT",
 
2424
                                                         "socket")
 
2425
        # Later, stdin will, and stdout and stderr might, be dup'ed
 
2426
        # over with an opened os.devnull.  But we don't want this to
 
2427
        # happen with a supplied network socket.
 
2428
        if 0 <= server_settings["socket"] <= 2:
 
2429
            server_settings["socket"] = os.dup(server_settings
 
2430
                                               ["socket"])
1767
2431
    del server_config
1768
2432
    
1769
2433
    # Override the settings from the config file with command line
1770
2434
    # options, if set.
1771
2435
    for option in ("interface", "address", "port", "debug",
1772
 
                   "priority", "servicename", "configdir",
1773
 
                   "use_dbus", "use_ipv6", "debuglevel"):
 
2436
                   "priority", "servicename", "configdir", "use_dbus",
 
2437
                   "use_ipv6", "debuglevel", "restore", "statedir",
 
2438
                   "socket", "foreground", "zeroconf"):
1774
2439
        value = getattr(options, option)
1775
2440
        if value is not None:
1776
2441
            server_settings[option] = value
1777
2442
    del options
1778
2443
    # Force all strings to be unicode
1779
2444
    for option in server_settings.keys():
1780
 
        if type(server_settings[option]) is str:
1781
 
            server_settings[option] = unicode(server_settings[option])
 
2445
        if isinstance(server_settings[option], bytes):
 
2446
            server_settings[option] = (server_settings[option]
 
2447
                                       .decode("utf-8"))
 
2448
    # Force all boolean options to be boolean
 
2449
    for option in ("debug", "use_dbus", "use_ipv6", "restore",
 
2450
                   "foreground", "zeroconf"):
 
2451
        server_settings[option] = bool(server_settings[option])
 
2452
    # Debug implies foreground
 
2453
    if server_settings["debug"]:
 
2454
        server_settings["foreground"] = True
1782
2455
    # Now we have our good server settings in "server_settings"
1783
2456
    
1784
2457
    ##################################################################
1785
2458
    
 
2459
    if (not server_settings["zeroconf"]
 
2460
        and not (server_settings["port"]
 
2461
                 or server_settings["socket"] != "")):
 
2462
        parser.error("Needs port or socket to work without Zeroconf")
 
2463
    
1786
2464
    # For convenience
1787
2465
    debug = server_settings["debug"]
1788
2466
    debuglevel = server_settings["debuglevel"]
1789
2467
    use_dbus = server_settings["use_dbus"]
1790
2468
    use_ipv6 = server_settings["use_ipv6"]
1791
 
 
 
2469
    stored_state_path = os.path.join(server_settings["statedir"],
 
2470
                                     stored_state_file)
 
2471
    foreground = server_settings["foreground"]
 
2472
    zeroconf = server_settings["zeroconf"]
 
2473
    
 
2474
    if debug:
 
2475
        initlogger(debug, logging.DEBUG)
 
2476
    else:
 
2477
        if not debuglevel:
 
2478
            initlogger(debug)
 
2479
        else:
 
2480
            level = getattr(logging, debuglevel.upper())
 
2481
            initlogger(debug, level)
 
2482
    
1792
2483
    if server_settings["servicename"] != "Mandos":
1793
 
        syslogger.setFormatter(logging.Formatter
1794
 
                               ('Mandos (%s) [%%(process)d]:'
1795
 
                                ' %%(levelname)s: %%(message)s'
1796
 
                                % server_settings["servicename"]))
 
2484
        syslogger.setFormatter(
 
2485
            logging.Formatter('Mandos ({}) [%(process)d]:'
 
2486
                              ' %(levelname)s: %(message)s'.format(
 
2487
                                  server_settings["servicename"])))
1797
2488
    
1798
2489
    # Parse config file with clients
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)
 
2490
    client_config = configparser.SafeConfigParser(Client
 
2491
                                                  .client_defaults)
1807
2492
    client_config.read(os.path.join(server_settings["configdir"],
1808
2493
                                    "clients.conf"))
1809
2494
    
1810
2495
    global mandos_dbus_service
1811
2496
    mandos_dbus_service = None
1812
2497
    
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"
 
2498
    socketfd = None
 
2499
    if server_settings["socket"] != "":
 
2500
        socketfd = server_settings["socket"]
 
2501
    tcp_server = MandosServer(
 
2502
        (server_settings["address"], server_settings["port"]),
 
2503
        ClientHandler,
 
2504
        interface=(server_settings["interface"] or None),
 
2505
        use_ipv6=use_ipv6,
 
2506
        gnutls_priority=server_settings["priority"],
 
2507
        use_dbus=use_dbus,
 
2508
        socketfd=socketfd)
 
2509
    if not foreground:
 
2510
        pidfilename = "/run/mandos.pid"
 
2511
        if not os.path.isdir("/run/."):
 
2512
            pidfilename = "/var/run/mandos.pid"
 
2513
        pidfile = None
1824
2514
        try:
1825
 
            pidfile = open(pidfilename, "w")
1826
 
        except IOError:
1827
 
            logger.error("Could not open file %r", pidfilename)
 
2515
            pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
 
2516
        except IOError as e:
 
2517
            logger.error("Could not open file %r", pidfilename,
 
2518
                         exc_info=e)
1828
2519
    
1829
 
    try:
1830
 
        uid = pwd.getpwnam("_mandos").pw_uid
1831
 
        gid = pwd.getpwnam("_mandos").pw_gid
1832
 
    except KeyError:
 
2520
    for name in ("_mandos", "mandos", "nobody"):
1833
2521
        try:
1834
 
            uid = pwd.getpwnam("mandos").pw_uid
1835
 
            gid = pwd.getpwnam("mandos").pw_gid
 
2522
            uid = pwd.getpwnam(name).pw_uid
 
2523
            gid = pwd.getpwnam(name).pw_gid
 
2524
            break
1836
2525
        except KeyError:
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
 
2526
            continue
 
2527
    else:
 
2528
        uid = 65534
 
2529
        gid = 65534
1843
2530
    try:
1844
2531
        os.setgid(gid)
1845
2532
        os.setuid(uid)
1846
2533
    except OSError as error:
1847
 
        if error[0] != errno.EPERM:
1848
 
            raise error
 
2534
        if error.errno != errno.EPERM:
 
2535
            raise
1849
2536
    
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
 
 
1858
2537
    if debug:
1859
2538
        # Enable all possible GnuTLS debugging
1860
2539
        
1866
2545
        def debug_gnutls(level, string):
1867
2546
            logger.debug("GnuTLS: %s", string[:-1])
1868
2547
        
1869
 
        (gnutls.library.functions
1870
 
         .gnutls_global_set_log_function(debug_gnutls))
 
2548
        gnutls.library.functions.gnutls_global_set_log_function(
 
2549
            debug_gnutls)
1871
2550
        
1872
2551
        # Redirect stdin so all checkers get /dev/null
1873
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
2552
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1874
2553
        os.dup2(null, sys.stdin.fileno())
1875
2554
        if null > 2:
1876
2555
            os.close(null)
1877
 
    else:
1878
 
        # No console logging
1879
 
        logger.removeHandler(console)
1880
2556
    
1881
2557
    # Need to fork before connecting to D-Bus
1882
 
    if not debug:
 
2558
    if not foreground:
1883
2559
        # Close all input and output, do double fork, etc.
1884
2560
        daemon()
1885
2561
    
 
2562
    # multiprocessing will use threads, so before we use gobject we
 
2563
    # need to inform gobject that threads will be used.
 
2564
    gobject.threads_init()
 
2565
    
1886
2566
    global main_loop
1887
2567
    # From the Avahi example code
1888
 
    DBusGMainLoop(set_as_default=True )
 
2568
    DBusGMainLoop(set_as_default=True)
1889
2569
    main_loop = gobject.MainLoop()
1890
2570
    bus = dbus.SystemBus()
1891
2571
    # End of Avahi example code
1892
2572
    if use_dbus:
1893
2573
        try:
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")
 
2574
            bus_name = dbus.service.BusName("se.recompile.Mandos",
 
2575
                                            bus,
 
2576
                                            do_not_queue=True)
 
2577
            old_bus_name = dbus.service.BusName(
 
2578
                "se.bsnet.fukt.Mandos", bus,
 
2579
                do_not_queue=True)
 
2580
        except dbus.exceptions.DBusException as e:
 
2581
            logger.error("Disabling D-Bus:", exc_info=e)
1898
2582
            use_dbus = False
1899
2583
            server_settings["use_dbus"] = False
1900
2584
            tcp_server.use_dbus = False
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"])))
 
2585
    if zeroconf:
 
2586
        protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
 
2587
        service = AvahiServiceToSyslog(
 
2588
            name = server_settings["servicename"],
 
2589
            servicetype = "_mandos._tcp",
 
2590
            protocol = protocol,
 
2591
            bus = bus)
 
2592
        if server_settings["interface"]:
 
2593
            service.interface = if_nametoindex(
 
2594
                server_settings["interface"].encode("utf-8"))
1908
2595
    
1909
2596
    global multiprocessing_manager
1910
2597
    multiprocessing_manager = multiprocessing.Manager()
1912
2599
    client_class = Client
1913
2600
    if use_dbus:
1914
2601
        client_class = functools.partial(ClientDBus, bus = bus)
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):
 
2602
    
 
2603
    client_settings = Client.config_parser(client_config)
 
2604
    old_client_settings = {}
 
2605
    clients_data = {}
 
2606
    
 
2607
    # This is used to redirect stdout and stderr for checker processes
 
2608
    global wnull
 
2609
    wnull = open(os.devnull, "w") # A writable /dev/null
 
2610
    # Only used if server is running in foreground but not in debug
 
2611
    # mode
 
2612
    if debug or not foreground:
 
2613
        wnull.close()
 
2614
    
 
2615
    # Get client data and settings from last running state.
 
2616
    if server_settings["restore"]:
 
2617
        try:
 
2618
            with open(stored_state_path, "rb") as stored_state:
 
2619
                clients_data, old_client_settings = pickle.load(
 
2620
                    stored_state)
 
2621
            os.remove(stored_state_path)
 
2622
        except IOError as e:
 
2623
            if e.errno == errno.ENOENT:
 
2624
                logger.warning("Could not load persistent state:"
 
2625
                               " {}".format(os.strerror(e.errno)))
 
2626
            else:
 
2627
                logger.critical("Could not load persistent state:",
 
2628
                                exc_info=e)
 
2629
                raise
 
2630
        except EOFError as e:
 
2631
            logger.warning("Could not load persistent state: "
 
2632
                           "EOFError:",
 
2633
                           exc_info=e)
 
2634
    
 
2635
    with PGPEngine() as pgp:
 
2636
        for client_name, client in clients_data.items():
 
2637
            # Skip removed clients
 
2638
            if client_name not in client_settings:
 
2639
                continue
 
2640
            
 
2641
            # Decide which value to use after restoring saved state.
 
2642
            # We have three different values: Old config file,
 
2643
            # new config file, and saved state.
 
2644
            # New config value takes precedence if it differs from old
 
2645
            # config value, otherwise use saved state.
 
2646
            for name, value in client_settings[client_name].items():
 
2647
                try:
 
2648
                    # For each value in new config, check if it
 
2649
                    # differs from the old config value (Except for
 
2650
                    # the "secret" attribute)
 
2651
                    if (name != "secret"
 
2652
                        and (value !=
 
2653
                             old_client_settings[client_name][name])):
 
2654
                        client[name] = value
 
2655
                except KeyError:
 
2656
                    pass
 
2657
            
 
2658
            # Clients who has passed its expire date can still be
 
2659
            # enabled if its last checker was successful.  Clients
 
2660
            # whose checker succeeded before we stored its state is
 
2661
            # assumed to have successfully run all checkers during
 
2662
            # downtime.
 
2663
            if client["enabled"]:
 
2664
                if datetime.datetime.utcnow() >= client["expires"]:
 
2665
                    if not client["last_checked_ok"]:
 
2666
                        logger.warning(
 
2667
                            "disabling client {} - Client never "
 
2668
                            "performed a successful checker".format(
 
2669
                                client_name))
 
2670
                        client["enabled"] = False
 
2671
                    elif client["last_checker_status"] != 0:
 
2672
                        logger.warning(
 
2673
                            "disabling client {} - Client last"
 
2674
                            " checker failed with error code"
 
2675
                            " {}".format(
 
2676
                                client_name,
 
2677
                                client["last_checker_status"]))
 
2678
                        client["enabled"] = False
 
2679
                    else:
 
2680
                        client["expires"] = (
 
2681
                            datetime.datetime.utcnow()
 
2682
                            + client["timeout"])
 
2683
                        logger.debug("Last checker succeeded,"
 
2684
                                     " keeping {} enabled".format(
 
2685
                                         client_name))
1922
2686
            try:
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()))
 
2687
                client["secret"] = pgp.decrypt(
 
2688
                    client["encrypted_secret"],
 
2689
                    client_settings[client_name]["secret"])
 
2690
            except PGPError:
 
2691
                # If decryption fails, we use secret from new settings
 
2692
                logger.debug("Failed to decrypt {} old secret".format(
 
2693
                    client_name))
 
2694
                client["secret"] = (client_settings[client_name]
 
2695
                                    ["secret"])
 
2696
    
 
2697
    # Add/remove clients based on new changes made to config
 
2698
    for client_name in (set(old_client_settings)
 
2699
                        - set(client_settings)):
 
2700
        del clients_data[client_name]
 
2701
    for client_name in (set(client_settings)
 
2702
                        - set(old_client_settings)):
 
2703
        clients_data[client_name] = client_settings[client_name]
 
2704
    
 
2705
    # Create all client objects
 
2706
    for client_name, client in clients_data.items():
 
2707
        tcp_server.clients[client_name] = client_class(
 
2708
            name = client_name,
 
2709
            settings = client,
 
2710
            server_settings = server_settings)
 
2711
    
1932
2712
    if not tcp_server.clients:
1933
2713
        logger.warning("No clients defined")
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
 
2714
    
 
2715
    if not foreground:
 
2716
        if pidfile is not None:
 
2717
            pid = os.getpid()
 
2718
            try:
 
2719
                with pidfile:
 
2720
                    print(pid, file=pidfile)
 
2721
            except IOError:
 
2722
                logger.error("Could not write to file %r with PID %d",
 
2723
                             pidfilename, pid)
 
2724
        del pidfile
1947
2725
        del pidfilename
1948
 
        
1949
 
        signal.signal(signal.SIGINT, signal.SIG_IGN)
1950
 
 
 
2726
    
1951
2727
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1952
2728
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
1953
2729
    
1954
2730
    if use_dbus:
1955
 
        class MandosDBusService(dbus.service.Object):
 
2731
        
 
2732
        @alternate_dbus_interfaces(
 
2733
            { "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
 
2734
        class MandosDBusService(DBusObjectWithProperties):
1956
2735
            """A D-Bus proxy object"""
 
2736
            
1957
2737
            def __init__(self):
1958
2738
                dbus.service.Object.__init__(self, bus, "/")
1959
 
            _interface = "se.bsnet.fukt.Mandos"
 
2739
            
 
2740
            _interface = "se.recompile.Mandos"
 
2741
            
 
2742
            @dbus_interface_annotations(_interface)
 
2743
            def _foo(self):
 
2744
                return {
 
2745
                    "org.freedesktop.DBus.Property.EmitsChangedSignal":
 
2746
                    "false" }
1960
2747
            
1961
2748
            @dbus.service.signal(_interface, signature="o")
1962
2749
            def ClientAdded(self, objpath):
1976
2763
            @dbus.service.method(_interface, out_signature="ao")
1977
2764
            def GetAllClients(self):
1978
2765
                "D-Bus method"
1979
 
                return dbus.Array(c.dbus_object_path
1980
 
                                  for c in tcp_server.clients)
 
2766
                return dbus.Array(c.dbus_object_path for c in
 
2767
                                  tcp_server.clients.itervalues())
1981
2768
            
1982
2769
            @dbus.service.method(_interface,
1983
2770
                                 out_signature="a{oa{sv}}")
1984
2771
            def GetAllClientsWithProperties(self):
1985
2772
                "D-Bus method"
1986
2773
                return dbus.Dictionary(
1987
 
                    ((c.dbus_object_path, c.GetAll(""))
1988
 
                     for c in tcp_server.clients),
 
2774
                    { c.dbus_object_path: c.GetAll("")
 
2775
                      for c in tcp_server.clients.itervalues() },
1989
2776
                    signature="oa{sv}")
1990
2777
            
1991
2778
            @dbus.service.method(_interface, in_signature="o")
1992
2779
            def RemoveClient(self, object_path):
1993
2780
                "D-Bus method"
1994
 
                for c in tcp_server.clients:
 
2781
                for c in tcp_server.clients.itervalues():
1995
2782
                    if c.dbus_object_path == object_path:
1996
 
                        tcp_server.clients.remove(c)
 
2783
                        del tcp_server.clients[c.name]
1997
2784
                        c.remove_from_connection()
1998
2785
                        # Don't signal anything except ClientRemoved
1999
2786
                        c.disable(quiet=True)
2008
2795
    
2009
2796
    def cleanup():
2010
2797
        "Cleanup function; run on exit"
2011
 
        service.cleanup()
2012
 
        
 
2798
        if zeroconf:
 
2799
            service.cleanup()
 
2800
        
 
2801
        multiprocessing.active_children()
 
2802
        wnull.close()
 
2803
        if not (tcp_server.clients or client_settings):
 
2804
            return
 
2805
        
 
2806
        # Store client before exiting. Secrets are encrypted with key
 
2807
        # based on what config file has. If config file is
 
2808
        # removed/edited, old secret will thus be unrecovable.
 
2809
        clients = {}
 
2810
        with PGPEngine() as pgp:
 
2811
            for client in tcp_server.clients.itervalues():
 
2812
                key = client_settings[client.name]["secret"]
 
2813
                client.encrypted_secret = pgp.encrypt(client.secret,
 
2814
                                                      key)
 
2815
                client_dict = {}
 
2816
                
 
2817
                # A list of attributes that can not be pickled
 
2818
                # + secret.
 
2819
                exclude = { "bus", "changedstate", "secret",
 
2820
                            "checker", "server_settings" }
 
2821
                for name, typ in inspect.getmembers(dbus.service
 
2822
                                                    .Object):
 
2823
                    exclude.add(name)
 
2824
                
 
2825
                client_dict["encrypted_secret"] = (client
 
2826
                                                   .encrypted_secret)
 
2827
                for attr in client.client_structure:
 
2828
                    if attr not in exclude:
 
2829
                        client_dict[attr] = getattr(client, attr)
 
2830
                
 
2831
                clients[client.name] = client_dict
 
2832
                del client_settings[client.name]["secret"]
 
2833
        
 
2834
        try:
 
2835
            with tempfile.NamedTemporaryFile(
 
2836
                    mode='wb',
 
2837
                    suffix=".pickle",
 
2838
                    prefix='clients-',
 
2839
                    dir=os.path.dirname(stored_state_path),
 
2840
                    delete=False) as stored_state:
 
2841
                pickle.dump((clients, client_settings), stored_state)
 
2842
                tempname = stored_state.name
 
2843
            os.rename(tempname, stored_state_path)
 
2844
        except (IOError, OSError) as e:
 
2845
            if not debug:
 
2846
                try:
 
2847
                    os.remove(tempname)
 
2848
                except NameError:
 
2849
                    pass
 
2850
            if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
 
2851
                logger.warning("Could not save persistent state: {}"
 
2852
                               .format(os.strerror(e.errno)))
 
2853
            else:
 
2854
                logger.warning("Could not save persistent state:",
 
2855
                               exc_info=e)
 
2856
                raise
 
2857
        
 
2858
        # Delete all clients, and settings from config
2013
2859
        while tcp_server.clients:
2014
 
            client = tcp_server.clients.pop()
 
2860
            name, client = tcp_server.clients.popitem()
2015
2861
            if use_dbus:
2016
2862
                client.remove_from_connection()
2017
 
            client.disable_hook = None
2018
2863
            # Don't signal anything except ClientRemoved
2019
2864
            client.disable(quiet=True)
2020
2865
            if use_dbus:
2021
2866
                # Emit D-Bus signal
2022
 
                mandos_dbus_service.ClientRemoved(client.dbus_object_path,
2023
 
                                                  client.name)
 
2867
                mandos_dbus_service.ClientRemoved(
 
2868
                    client.dbus_object_path, client.name)
 
2869
        client_settings.clear()
2024
2870
    
2025
2871
    atexit.register(cleanup)
2026
2872
    
2027
 
    for client in tcp_server.clients:
 
2873
    for client in tcp_server.clients.itervalues():
2028
2874
        if use_dbus:
2029
2875
            # Emit D-Bus signal
2030
2876
            mandos_dbus_service.ClientAdded(client.dbus_object_path)
2031
 
        client.enable()
 
2877
        # Need to initiate checking of clients
 
2878
        if client.enabled:
 
2879
            client.init_checker()
2032
2880
    
2033
2881
    tcp_server.enable()
2034
2882
    tcp_server.server_activate()
2035
2883
    
2036
2884
    # Find out what port we got
2037
 
    service.port = tcp_server.socket.getsockname()[1]
 
2885
    if zeroconf:
 
2886
        service.port = tcp_server.socket.getsockname()[1]
2038
2887
    if use_ipv6:
2039
2888
        logger.info("Now listening on address %r, port %d,"
2040
 
                    " flowinfo %d, scope_id %d"
2041
 
                    % tcp_server.socket.getsockname())
 
2889
                    " flowinfo %d, scope_id %d",
 
2890
                    *tcp_server.socket.getsockname())
2042
2891
    else:                       # IPv4
2043
 
        logger.info("Now listening on address %r, port %d"
2044
 
                    % tcp_server.socket.getsockname())
 
2892
        logger.info("Now listening on address %r, port %d",
 
2893
                    *tcp_server.socket.getsockname())
2045
2894
    
2046
2895
    #service.interface = tcp_server.socket.getsockname()[3]
2047
2896
    
2048
2897
    try:
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
        if zeroconf:
 
2899
            # From the Avahi example code
 
2900
            try:
 
2901
                service.activate()
 
2902
            except dbus.exceptions.DBusException as error:
 
2903
                logger.critical("D-Bus Exception", exc_info=error)
 
2904
                cleanup()
 
2905
                sys.exit(1)
 
2906
            # End of Avahi example code
2057
2907
        
2058
2908
        gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2059
2909
                             lambda *args, **kwargs:
2063
2913
        logger.debug("Starting main loop")
2064
2914
        main_loop.run()
2065
2915
    except AvahiError as error:
2066
 
        logger.critical("AvahiError: %s", error)
 
2916
        logger.critical("Avahi Error", exc_info=error)
2067
2917
        cleanup()
2068
2918
        sys.exit(1)
2069
2919
    except KeyboardInterrupt:
2074
2924
    # Must run before the D-Bus bus name gets deregistered
2075
2925
    cleanup()
2076
2926
 
 
2927
 
2077
2928
if __name__ == '__main__':
2078
2929
    main()