/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: Björn Påhlsson
  • Date: 2011-11-24 19:27:53 UTC
  • mto: (518.2.5 persistent-state-gpgme)
  • mto: This revision was merged to the branch mainline in revision 524.
  • Revision ID: belorn@fukt.bsnet.se-20111124192753-y5jxlc1h3tcxpubc
First run of python-lint. Fixed some *obviously* bad code and turned
them into good code.

Show diffs side-by-side

added added

removed removed

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