/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2011-08-08 21:12:37 UTC
  • Revision ID: teddy@fukt.bsnet.se-20110808211237-jejsz5brjytrjot8
* Makefile (DOCS): Added "intro.8mandos".
  (intro.8mandos, intro.8mandos.xhtml): New.
* README: Replaced text with link, reference and short summary.
* intro.xml: New.
* mandos-clients.conf.xml (SEE ALSO): Added "intro(8mandos)".
* mandos-ctl.xml (SEE ALSO): - '' -
* mandos-keygen.xml (SEE ALSO): - '' -
* mandos-monitor.xml (SEE ALSO): - '' -
* mandos.conf.xml (SEE ALSO): - '' -
* mandos.xml (SEE ALSO): - '' -
* plugin-runner.xml (SEE ALSO): - '' -
* plugins.d/askpass-fifo.xml (SEE ALSO): - '' -
* plugins.d/mandos-client.xml (SEE ALSO): - '' -
* plugins.d/password-prompt.xml (SEE ALSO): - '' -
* plugins.d/plymouth.xml (SEE ALSO): - '' -
* plugins.d/splashy.xml (SEE ALSO): - '' -
* plugins.d/usplash.xml (SEE ALSO): - '' -

Show diffs side-by-side

added added

removed removed

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