/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: 2018-02-08 10:23:55 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 362.
  • Revision ID: teddy@recompile.se-20180208102355-3ent7sf87i9h9kka
Update copyright year to 2018

* DBUS-API: Update copyright year to 2018.
* debian/copyright: - '' -
* initramfs-unpack: - '' -
* intro.xml: - '' -
* mandos: - '' -
* mandos-clients.conf.xml: - '' -
* mandos-ctl: - '' -
* mandos-ctl.xml: - '' -
* mandos-keygen: - '' -
* mandos-keygen.xml: - '' -
* mandos-monitor: - '' -
* mandos-monitor.xml: - '' -
* mandos.conf.xml: - '' -
* mandos.xml: - '' -
* network-hooks.d/bridge: - '' -
* network-hooks.d/openvpn: - '' -
* network-hooks.d/wireless: - '' -
* plugin-helpers/mandos-client-iprouteadddel.c: - '' -
* plugin-runner.c: - '' -
* plugin-runner.xml: - '' -
* plugins.d/askpass-fifo.c: - '' -
* plugins.d/askpass-fifo.xml: - '' -
* plugins.d/mandos-client.c: - '' -
* plugins.d/mandos-client.xml: - '' -
* plugins.d/password-prompt.c: - '' -
* plugins.d/password-prompt.xml: - '' -
* plugins.d/plymouth.c: - '' -
* plugins.d/plymouth.xml: - '' -
* plugins.d/splashy.c: - '' -
* plugins.d/splashy.xml: - '' -
* plugins.d/usplash.c: - '' -
* plugins.d/usplash.xml: - '' -

Show diffs side-by-side

added added

removed removed

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