/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-07-14 21:41:08 UTC
  • Revision ID: teddy@recompile.se-20140714214108-awg7u6gaiy7d40dz
mandos-monitor: New "verbose" mode to see less important log messages.

* mandos-monitor (MandosClientWidget.__init__): Log client creation.
  (MandosClientWidget.checker_completed): Log a successful checker.
  (MandosClientWidget.checker_started): Log starting of a checker.
  (UserInterface.__init__): New optional "log_level" argument.
  (UserInterface.log_message, UserInterface.log_message_raw): Take
                                                              optional
                                                              "level"
                                                              arg.
  (UserInterface.toggle_log_display): Log visibility change.
  (UserInterface.change_log_display): Log wrap mode change.
  (UserInterface.process_input): Show new "v" key in help message and
                                 process "v" key if pressed.
* mandos-monitor.xml (KEYS): Document new "v" key.

Show diffs side-by-side

added added

removed removed

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