/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2018-08-15 09:18:22 UTC
  • Revision ID: teddy@recompile.se-20180815091822-tmmqryi0gqnzq6ab
mandos: Better error message if self-signature verification fails

* mandos (ClientHandler.fingerprint): If the verification of the
  self-signature fails, report the actual error message instead of a
  generic message.

Show diffs side-by-side

added added

removed removed

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