/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2017-08-20 14:41:20 UTC
  • Revision ID: teddy@recompile.se-20170820144120-ee0hsyhvo1geg8ms
Handle multiple lines better in cryptroot file.

* initramfs-tools-script: Avoid running plugin-runner more than once
  if the root file system device is specially marked in the cryptroot
  file.  Also never run plugin-runner for a resume (usually swap)
  device.

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