/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos

* clients.conf ([DEFAULT]/timeout): Changed default value to "5m".
  ([DEFAULT]/interval): Changed default value to "2m".
  ([DEFAULT]/extenden_timeout): New.
  ([bar]/interval): Changed to "1m".

Show diffs side-by-side

added added

removed removed

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