/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2016-10-29 14:22:26 UTC
  • Revision ID: teddy@recompile.se-20161029142226-n4s9d70tuk615pg1
Makefile: Clarify message when running client.

* Makefile (run-client): Clarify message.

Show diffs side-by-side

added added

removed removed

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