/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2019-04-22 20:19:28 UTC
  • mto: This revision was merged to the branch mainline in revision 384.
  • Revision ID: teddy@recompile.se-20190422201928-7vmdtipp0ddsr86r
mandos-ctl: Add tests for all examples in the manual page

* mandos-ctl (Test_commands_from_options.assert_command_from_args):
  Add "length" and "clients" arguments; use them.
  (Test_commands_from_options.assert_commands_from_args): New.
  (Test_commands_from_options.test_manual_page_example_1): - '' -
  (Test_commands_from_options.test_manual_page_example_2): - '' -
  (Test_commands_from_options.test_manual_page_example_3): - '' -
  (Test_commands_from_options.test_manual_page_example_4): - '' -
  (Test_commands_from_options.test_manual_page_example_5): - '' -

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