/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:18:24 UTC
  • mto: This revision was merged to the branch mainline in revision 505.
  • Revision ID: belorn@fukt.bsnet.se-20111002191824-eweh4pvneeg3qzia
transitional stuff actually working
documented change to D-Bus API

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