/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2018-08-19 14:06:55 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 368.
  • Revision ID: teddy@recompile.se-20180819140655-ghsl0d4jsx8xwg44
Move UMASK setting to more proper place

* Makefile (install-client-nokey): Also install new conf files
  "initramfs-tools-conf".
* debian/mandos-client.dirs: Add "usr/share/initramfs-tools/conf.d".
* initramfs-tools-conf: New file which sets UMASK.
* initramfs-tools-hook: Change comment to correctly state new location
  of UMASK setting.
* initramfs-tools-hook-conf: Remove UMASK setting.

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