/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2013-10-20 15:25:09 UTC
  • mto: (237.7.272 trunk)
  • mto: This revision was merged to the branch mainline in revision 305.
  • Revision ID: teddy@recompile.se-20131020152509-zkhuy2yse76w10hg
* Makefile (CFLAGS, LDFLAGS): Keep default flags from environment.
  (purge-server): PID file changed to "/run/mandos.pid".
* debian/compat: Changed to "9".
* debian/control (Standards-Version): Updated to "3.9.4".
  (DM-Upload-Allowed): Removed.
  (mandos/Depends): Add "initscripts (>= 2.88dsf-13.3)" to be able to
                    use the "/run" directory (for mandos.pid).
* debian/copyright (Copyright): Update year.
* init.d-mandos (PIDFILE): Changed to "/run/mandos.pid".
* mandos: Update copyright year.
  (pidfilename): Changed to "/run/mandos.pid".
* mandos-clients.conf.xml (OPTIONS/approval_delay): Bug fix: default
                                                    is "PT0S" - using
                                                    the new RFC 3339
                                                    duration syntax.
* mandos-keygen: Update copyright year.
* mandos-monitor: - '' -
* mandos.conf.xml: - '' -
* mandos.xml: - '' -
  (FILES): PID file changed to "/run/mandos.pid".
* plugin-runner.c: Update copyright year.
* plugins.d/mandos-client.c: - '' -
* plugins.d/mandos-client.xml: - '' -
* plugins.d/password-prompt.c: - '' -
* plugins.d/plymouth.c: - '' -

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