/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Björn Påhlsson
  • Date: 2011-10-02 19:33:45 UTC
  • mfrom: (24.1.186 mandos)
  • Revision ID: belorn@fukt.bsnet.se-20111002193345-83fdvai1j7phep7j
The domain name has changed, so the D-Bus bus and interface names must
change.  This commit adds support for both the old and new names.

The new domain name is "recompile.se", so the new D-Bus bus name will
be "se.recompile.Mandos".

Show diffs side-by-side

added added

removed removed

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