/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2018-02-10 13:23:58 UTC
  • Revision ID: teddy@recompile.se-20180210132358-8pfvo9vshq9l32y5
Remove unnecessary text left from old example init.d file

* init.d-mandos: Remove unnecessary text left from old example init.d
  file.

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