/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2015-06-02 17:43:53 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 325.
  • Revision ID: teddy@recompile.se-20150602174353-tvqw31mgxfapl985
mandos.service ([Service]/KillMode): Changed to "mixed".

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