/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2014-02-16 02:42:42 UTC
  • Revision ID: teddy@recompile.se-20140216024242-9wiw1nkxgt7ohovj
Fix running of self-tests.

* debian/control (Build-Depends): Add Python dependencies to
                                  successfully run self-tests.
* debian/copyright: GPLv3 now has its own license file - use it.
* debian/watch: Set PGP signature URL.
* mandos (main): Bug fix: When running self-tests, set exit code.
* mandos-ctl (main): Cosmetic fix; use os.EX_OK instead of plain 0.

Show diffs side-by-side

added added

removed removed

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